mixlib-shellout 1.0.0.rc.0-x86-mingw32

Sign up to get free protection for your applications and to get access to all the features.
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,40 @@
1
+ # Mixlib::ShellOut
2
+ Provides a simplified interface to shelling out yet still collecting both
3
+ standard out and standard error and providing full control over environment,
4
+ working directory, uid, gid, etc.
5
+
6
+ No means for passing input to the subprocess is provided.
7
+
8
+ ## Example
9
+ Invoke find(1) to search for .rb files:
10
+
11
+ find = Mixlib::ShellOut.new("find . -name '*.rb'")
12
+ find.run_command
13
+
14
+ If all went well, the results are on `stdout`
15
+
16
+ puts find.stdout
17
+
18
+ `find(1)` prints diagnostic info to STDERR:
19
+
20
+ puts "error messages" + find.stderr
21
+
22
+ Raise an exception if it didn't exit with 0
23
+
24
+ find.error!
25
+
26
+ Run a command as the `www` user with no extra ENV settings from `/tmp`
27
+
28
+ cmd = Mixlib::ShellOut.new("apachectl", "start", :user => 'www', :env => nil, :cwd => '/tmp')
29
+ cmd.run_command # etc.
30
+
31
+ ## Platform Support
32
+ Mixlib::ShellOut does a standard fork/exec on Unix, and uses the Win32
33
+ API on Windows. There is not currently support for JRuby.
34
+
35
+ ## License
36
+ Apache 2 Licensed. See LICENSE for full details.
37
+
38
+ ## See Also
39
+ * `Process.spawn` in Ruby 1.9
40
+ * [https://github.com/rtomayko/posix-spawn](posix-spawn)
@@ -0,0 +1,287 @@
1
+ #--
2
+ # Author:: Daniel DeLeo (<dan@opscode.com>)
3
+ # Copyright:: Copyright (c) 2010, 2011 Opscode, Inc.
4
+ # License:: Apache License, Version 2.0
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #
18
+
19
+ require 'etc'
20
+ require 'tmpdir'
21
+ require 'fcntl'
22
+ require 'mixlib/shellout/exceptions'
23
+
24
+ module Mixlib
25
+
26
+ class ShellOut
27
+ READ_WAIT_TIME = 0.01
28
+ READ_SIZE = 4096
29
+ DEFAULT_READ_TIMEOUT = 600
30
+ DEFAULT_ENVIRONMENT = {'LC_ALL' => 'C'}
31
+
32
+ if RUBY_PLATFORM =~ /mswin|mingw32|windows/
33
+ require 'mixlib/shellout/windows'
34
+ include ShellOut::Windows
35
+ else
36
+ require 'mixlib/shellout/unix'
37
+ include ShellOut::Unix
38
+ end
39
+
40
+ # User the command will run as. Normally set via options passed to new
41
+ attr_accessor :user
42
+
43
+ # Group the command will run as. Normally set via options passed to new
44
+ attr_accessor :group
45
+
46
+ # Working directory for the subprocess. Normally set via options to new
47
+ attr_accessor :cwd
48
+
49
+ # An Array of acceptable exit codes. #error! uses this list to determine if
50
+ # the command was successful. Normally set via options to new
51
+ attr_accessor :valid_exit_codes
52
+
53
+ # When live_stream is set, stdout of the subprocess will be copied to it as
54
+ # the subprocess is running. For example, if live_stream is set to STDOUT,
55
+ # the command's output will be echoed to STDOUT.
56
+ attr_accessor :live_stream
57
+
58
+ # If a logger is set, ShellOut will log a message before it executes the
59
+ # command.
60
+ attr_accessor :logger
61
+
62
+ # The log level at which ShellOut should log.
63
+ attr_accessor :log_level
64
+
65
+ # A string which will be prepended to the log message.
66
+ attr_accessor :log_tag
67
+
68
+ # The command to be executed.
69
+ attr_reader :command
70
+
71
+ # The umask that will be set for the subcommand.
72
+ attr_reader :umask
73
+
74
+ # Environment variables that will be set for the subcommand. Refer to the
75
+ # documentation of new to understand how ShellOut interprets this.
76
+ attr_reader :environment
77
+
78
+ # The maximum time this command is allowed to run. Usually set via options
79
+ # to new
80
+ attr_writer :timeout
81
+
82
+ # The amount of time the subcommand took to execute
83
+ attr_reader :execution_time
84
+
85
+ # Data written to stdout by the subprocess
86
+ attr_reader :stdout
87
+
88
+ # Data written to stderr by the subprocess
89
+ attr_reader :stderr
90
+
91
+ # A Process::Status (or ducktype) object collected when the subprocess is
92
+ # reaped.
93
+ attr_reader :status
94
+
95
+ attr_reader :stdin_pipe, :stdout_pipe, :stderr_pipe, :process_status_pipe
96
+
97
+ # === Arguments:
98
+ # Takes a single command, or a list of command fragments. These are used
99
+ # as arguments to Kernel.exec. See the Kernel.exec documentation for more
100
+ # explanation of how arguments are evaluated. The last argument can be an
101
+ # options Hash.
102
+ # === Options:
103
+ # If the last argument is a Hash, it is removed from the list of args passed
104
+ # to exec and used as an options hash. The following options are available:
105
+ # * +user+: the user the commmand should run as. if an integer is given, it is
106
+ # used as a uid. A string is treated as a username and resolved to a uid
107
+ # with Etc.getpwnam
108
+ # * +group+: the group the command should run as. works similarly to +user+
109
+ # * +cwd+: the directory to chdir to before running the command
110
+ # * +umask+: a umask to set before running the command. If given as an Integer,
111
+ # be sure to use two leading zeros so it's parsed as Octal. A string will
112
+ # be treated as an octal integer
113
+ # * +returns+: one or more Integer values to use as valid exit codes for the
114
+ # subprocess. This only has an effect if you call +error!+ after
115
+ # +run_command+.
116
+ # * +environment+: a Hash of environment variables to set before the command
117
+ # is run. By default, the environment will *always* be set to 'LC_ALL' => 'C'
118
+ # to prevent issues with multibyte characters in Ruby 1.8. To avoid this,
119
+ # use :environment => nil for *no* extra environment settings, or
120
+ # :environment => {'LC_ALL'=>nil, ...} to set other environment settings
121
+ # without changing the locale.
122
+ # * +timeout+: a Numeric value for the number of seconds to wait on the
123
+ # child process before raising an Exception. This is calculated as the
124
+ # total amount of time that ShellOut waited on the child process without
125
+ # receiving any output (i.e., IO.select returned nil). Default is 60
126
+ # seconds. Note: the stdlib Timeout library is not used.
127
+ # === Examples:
128
+ # Invoke find(1) to search for .rb files:
129
+ # find = Mixlib::ShellOut.new("find . -name '*.rb'")
130
+ # find.run_command
131
+ # # If all went well, the results are on +stdout+
132
+ # puts find.stdout
133
+ # # find(1) prints diagnostic info to STDERR:
134
+ # puts "error messages" + find.stderr
135
+ # # Raise an exception if it didn't exit with 0
136
+ # find.error!
137
+ # Run a command as the +www+ user with no extra ENV settings from +/tmp+
138
+ # cmd = Mixlib::ShellOut.new("apachectl", "start", :user => 'www', :env => nil, :cwd => '/tmp')
139
+ # cmd.run_command # etc.
140
+ def initialize(*command_args)
141
+ @stdout, @stderr = '', ''
142
+ @live_stream = nil
143
+ @log_level = :debug
144
+ @log_tag = nil
145
+ @environment = DEFAULT_ENVIRONMENT
146
+ @cwd = nil
147
+ @valid_exit_codes = [0]
148
+
149
+ if command_args.last.is_a?(Hash)
150
+ parse_options(command_args.pop)
151
+ end
152
+
153
+ @command = command_args.size == 1 ? command_args.first : command_args
154
+ end
155
+
156
+ # Set the umask that the subprocess will have. If given as a string, it
157
+ # will be converted to an integer by String#oct.
158
+ def umask=(new_umask)
159
+ @umask = (new_umask.respond_to?(:oct) ? new_umask.oct : new_umask.to_i) & 007777
160
+ end
161
+
162
+ # The uid that the subprocess will switch to. If the user attribute was
163
+ # given as a username, it is converted to a uid by Etc.getpwnam
164
+ def uid
165
+ return nil unless user
166
+ user.kind_of?(Integer) ? user : Etc.getpwnam(user.to_s).uid
167
+ end
168
+
169
+ # The gid that the subprocess will switch to. If the group attribute is
170
+ # given as a group name, it is converted to a gid by Etc.getgrnam
171
+ def gid
172
+ return nil unless group
173
+ group.kind_of?(Integer) ? group : Etc.getgrnam(group.to_s).gid
174
+ end
175
+
176
+ def timeout
177
+ @timeout || DEFAULT_READ_TIMEOUT
178
+ end
179
+
180
+ # Creates a String showing the output of the command, including a banner
181
+ # showing the exact command executed. Used by +invalid!+ to show command
182
+ # results when the command exited with an unexpected status.
183
+ def format_for_exception
184
+ msg = ""
185
+ msg << "---- Begin output of #{command} ----\n"
186
+ msg << "STDOUT: #{stdout.strip}\n"
187
+ msg << "STDERR: #{stderr.strip}\n"
188
+ msg << "---- End output of #{command} ----\n"
189
+ msg << "Ran #{command} returned #{status.exitstatus}" if status
190
+ msg
191
+ end
192
+
193
+ # The exit status of the subprocess. Will be nil if the command is still
194
+ # running or died without setting an exit status (e.g., terminated by
195
+ # `kill -9`).
196
+ def exitstatus
197
+ @status && @status.exitstatus
198
+ end
199
+
200
+ # Run the command, writing the command's standard out and standard error
201
+ # to +stdout+ and +stderr+, and saving its exit status object to +status+
202
+ # === Returns
203
+ # returns +self+; +stdout+, +stderr+, +status+, and +exitstatus+ will be
204
+ # populated with results of the command
205
+ # === Raises
206
+ # * Errno::EACCES when you are not privileged to execute the command
207
+ # * Errno::ENOENT when the command is not available on the system (or not
208
+ # in the current $PATH)
209
+ # * CommandTimeout when the command does not complete
210
+ # within +timeout+ seconds (default: 60s)
211
+ def run_command
212
+ if logger
213
+ log_message = (log_tag.nil? ? "" : "#@log_tag ") << "sh(#@command)"
214
+ logger.send(log_level, log_message)
215
+ end
216
+ super
217
+ end
218
+
219
+ # Checks the +exitstatus+ against the set of +valid_exit_codes+. If
220
+ # +exitstatus+ is not in the list of +valid_exit_codes+, calls +invalid!+,
221
+ # which raises an Exception.
222
+ # === Returns
223
+ # nil::: always returns nil when it does not raise
224
+ # === Raises
225
+ # ::ShellCommandFailed::: via +invalid!+
226
+ def error!
227
+ unless Array(valid_exit_codes).include?(exitstatus)
228
+ invalid!("Expected process to exit with #{valid_exit_codes.inspect}, but received '#{exitstatus}'")
229
+ end
230
+ end
231
+
232
+ # Raises a ShellCommandFailed exception, appending the
233
+ # command's stdout, stderr, and exitstatus to the exception message.
234
+ # === Arguments
235
+ # +msg+: A String to use as the basis of the exception message. The
236
+ # default explanation is very generic, providing a more informative message
237
+ # is highly encouraged.
238
+ # === Raises
239
+ # ShellCommandFailed always
240
+ def invalid!(msg=nil)
241
+ msg ||= "Command produced unexpected results"
242
+ raise ShellCommandFailed, msg + "\n" + format_for_exception
243
+ end
244
+
245
+ def inspect
246
+ "<#{self.class.name}##{object_id}: command: '#@command' process_status: #{@status.inspect} " +
247
+ "stdout: '#{stdout.strip}' stderr: '#{stderr.strip}' child_pid: #{@child_pid.inspect} " +
248
+ "environment: #{@environment.inspect} timeout: #{timeout} user: #@user group: #@group working_dir: #@cwd >"
249
+ end
250
+
251
+ private
252
+
253
+ def parse_options(opts)
254
+ opts.each do |option, setting|
255
+ case option.to_s
256
+ when 'cwd'
257
+ self.cwd = setting
258
+ when 'user'
259
+ self.user = setting
260
+ when 'group'
261
+ self.group = setting
262
+ when 'umask'
263
+ self.umask = setting
264
+ when 'timeout'
265
+ self.timeout = setting
266
+ when 'returns'
267
+ self.valid_exit_codes = Array(setting)
268
+ when 'live_stream'
269
+ self.live_stream = setting
270
+ when 'logger'
271
+ self.logger = setting
272
+ when 'log_level'
273
+ self.log_level = setting
274
+ when 'log_tag'
275
+ self.log_tag = setting
276
+ when 'environment', 'env'
277
+ # passing :environment => nil means don't set any new ENV vars
278
+ @environment = setting.nil? ? {} : @environment.dup.merge!(setting)
279
+ else
280
+ raise InvalidCommandOption, "option '#{option.inspect}' is not a valid option for #{self.class.name}"
281
+ end
282
+ end
283
+ end
284
+
285
+
286
+ end
287
+ end