mixlib-shellout 1.0.0.rc.0

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,40 @@
+# Mixlib::ShellOut
+Provides a simplified interface to shelling out yet still collecting both
+standard out and standard error and providing full control over environment,
+working directory, uid, gid, etc.
+
+No means for passing input to the subprocess is provided.
+
+## Example
+Invoke find(1) to search for .rb files:
+
+      find = Mixlib::ShellOut.new("find . -name '*.rb'")
+      find.run_command
+
+If all went well, the results are on `stdout`
+
+      puts find.stdout
+
+`find(1)` prints diagnostic info to STDERR:
+
+      puts "error messages" + find.stderr
+
+Raise an exception if it didn't exit with 0
+
+      find.error!
+
+Run a command as the `www` user with no extra ENV settings from `/tmp`
+
+      cmd = Mixlib::ShellOut.new("apachectl", "start", :user => 'www', :env => nil, :cwd => '/tmp')
+      cmd.run_command # etc.
+
+## Platform Support
+Mixlib::ShellOut does a standard fork/exec on Unix, and uses the Win32
+API on Windows. There is not currently support for JRuby.
+
+## License
+Apache 2 Licensed. See LICENSE for full details.
+
+## See Also
+* `Process.spawn` in Ruby 1.9
+* [https://github.com/rtomayko/posix-spawn](posix-spawn)

data/lib/mixlib/shellout.rb

@@ -0,0 +1,287 @@
+#--
+# Author:: Daniel DeLeo (<dan@opscode.com>)
+# Copyright:: Copyright (c) 2010, 2011 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'etc'
+require 'tmpdir'
+require 'fcntl'
+require 'mixlib/shellout/exceptions'
+
+module Mixlib
+
+  class ShellOut
+    READ_WAIT_TIME = 0.01
+    READ_SIZE = 4096
+    DEFAULT_READ_TIMEOUT = 600
+    DEFAULT_ENVIRONMENT = {'LC_ALL' => 'C'}
+
+    if RUBY_PLATFORM =~ /mswin|mingw32|windows/
+      require 'mixlib/shellout/windows'
+      include ShellOut::Windows
+    else
+      require 'mixlib/shellout/unix'
+      include ShellOut::Unix
+    end
+
+    # User the command will run as. Normally set via options passed to new
+    attr_accessor :user
+
+    # Group the command will run as. Normally set via options passed to new
+    attr_accessor :group
+
+    # Working directory for the subprocess. Normally set via options to new
+    attr_accessor :cwd
+
+    # An Array of acceptable exit codes. #error! uses this list to determine if
+    # the command was successful. Normally set via options to new
+    attr_accessor :valid_exit_codes
+
+    # When live_stream is set, stdout of the subprocess will be copied to it as
+    # the subprocess is running. For example, if live_stream is set to STDOUT,
+    # the command's output will be echoed to STDOUT.
+    attr_accessor :live_stream
+
+    # If a logger is set, ShellOut will log a message before it executes the
+    # command.
+    attr_accessor :logger
+
+    # The log level at which ShellOut should log.
+    attr_accessor :log_level
+
+    # A string which will be prepended to the log message.
+    attr_accessor :log_tag
+
+    # The command to be executed.
+    attr_reader :command
+
+    # The umask that will be set for the subcommand.
+    attr_reader :umask
+
+    # Environment variables that will be set for the subcommand. Refer to the
+    # documentation of new to understand how ShellOut interprets this.
+    attr_reader :environment
+
+    # The maximum time this command is allowed to run. Usually set via options
+    # to new
+    attr_writer :timeout
+
+    # The amount of time the subcommand took to execute
+    attr_reader :execution_time
+
+    # Data written to stdout by the subprocess
+    attr_reader :stdout
+
+    # Data written to stderr by the subprocess
+    attr_reader :stderr
+
+    # A Process::Status (or ducktype) object collected when the subprocess is
+    # reaped.
+    attr_reader :status
+
+    attr_reader :stdin_pipe, :stdout_pipe, :stderr_pipe, :process_status_pipe
+
+    # === Arguments:
+    # Takes a single command, or a list of command fragments. These are used
+    # as arguments to Kernel.exec. See the Kernel.exec documentation for more
+    # explanation of how arguments are evaluated. The last argument can be an
+    # options Hash.
+    # === Options:
+    # If the last argument is a Hash, it is removed from the list of args passed
+    # to exec and used as an options hash. The following options are available:
+    # * +user+: the user the commmand should run as. if an integer is given, it is
+    #   used as a uid. A string is treated as a username and resolved to a uid
+    #   with Etc.getpwnam
+    # * +group+: the group the command should run as. works similarly to +user+
+    # * +cwd+: the directory to chdir to before running the command
+    # * +umask+: a umask to set before running the command. If given as an Integer,
+    #   be sure to use two leading zeros so it's parsed as Octal. A string will
+    #   be treated as an octal integer
+    # * +returns+:  one or more Integer values to use as valid exit codes for the
+    #   subprocess. This only has an effect if you call +error!+ after
+    #   +run_command+.
+    # * +environment+: a Hash of environment variables to set before the command
+    #   is run. By default, the environment will *always* be set to 'LC_ALL' => 'C'
+    #   to prevent issues with multibyte characters in Ruby 1.8. To avoid this,
+    #   use :environment => nil for *no* extra environment settings, or
+    #   :environment => {'LC_ALL'=>nil, ...} to set other environment settings
+    #   without changing the locale.
+    # * +timeout+: a Numeric value for the number of seconds to wait on the
+    #   child process before raising an Exception. This is calculated as the
+    #   total amount of time that ShellOut waited on the child process without
+    #   receiving any output (i.e., IO.select returned nil). Default is 60
+    #   seconds. Note: the stdlib Timeout library is not used.
+    # === Examples:
+    # Invoke find(1) to search for .rb files:
+    #   find = Mixlib::ShellOut.new("find . -name '*.rb'")
+    #   find.run_command
+    #   # If all went well, the results are on +stdout+
+    #   puts find.stdout
+    #   # find(1) prints diagnostic info to STDERR:
+    #   puts "error messages" + find.stderr
+    #   # Raise an exception if it didn't exit with 0
+    #   find.error!
+    # Run a command as the +www+ user with no extra ENV settings from +/tmp+
+    #   cmd = Mixlib::ShellOut.new("apachectl", "start", :user => 'www', :env => nil, :cwd => '/tmp')
+    #   cmd.run_command # etc.
+    def initialize(*command_args)
+      @stdout, @stderr = '', ''
+      @live_stream = nil
+      @log_level = :debug
+      @log_tag = nil
+      @environment = DEFAULT_ENVIRONMENT
+      @cwd = nil
+      @valid_exit_codes = [0]
+
+      if command_args.last.is_a?(Hash)
+        parse_options(command_args.pop)
+      end
+
+      @command = command_args.size == 1 ? command_args.first : command_args
+    end
+
+    # Set the umask that the subprocess will have. If given as a string, it
+    # will be converted to an integer by String#oct.
+    def umask=(new_umask)
+      @umask = (new_umask.respond_to?(:oct) ? new_umask.oct : new_umask.to_i) & 007777
+    end
+
+    # The uid that the subprocess will switch to. If the user attribute was
+    # given as a username, it is converted to a uid by Etc.getpwnam
+    def uid
+      return nil unless user
+      user.kind_of?(Integer) ? user : Etc.getpwnam(user.to_s).uid
+    end
+
+    # The gid that the subprocess will switch to. If the group attribute is
+    # given as a group name, it is converted to a gid by Etc.getgrnam
+    def gid
+      return nil unless group
+      group.kind_of?(Integer) ? group : Etc.getgrnam(group.to_s).gid
+    end
+
+    def timeout
+      @timeout || DEFAULT_READ_TIMEOUT
+    end
+
+    # Creates a String showing the output of the command, including a banner
+    # showing the exact command executed. Used by +invalid!+ to show command
+    # results when the command exited with an unexpected status.
+    def format_for_exception
+      msg = ""
+      msg << "---- Begin output of #{command} ----\n"
+      msg << "STDOUT: #{stdout.strip}\n"
+      msg << "STDERR: #{stderr.strip}\n"
+      msg << "---- End output of #{command} ----\n"
+      msg << "Ran #{command} returned #{status.exitstatus}" if status
+      msg
+    end
+
+    # The exit status of the subprocess. Will be nil if the command is still
+    # running or died without setting an exit status (e.g., terminated by
+    # `kill -9`).
+    def exitstatus
+      @status && @status.exitstatus
+    end
+
+    # Run the command, writing the command's standard out and standard error
+    # to +stdout+ and +stderr+, and saving its exit status object to +status+
+    # === Returns
+    # returns   +self+; +stdout+, +stderr+, +status+, and +exitstatus+ will be
+    # populated with results of the command
+    # === Raises
+    # * Errno::EACCES  when you are not privileged to execute the command
+    # * Errno::ENOENT  when the command is not available on the system (or not
+    #   in the current $PATH)
+    # * CommandTimeout  when the command does not complete
+    #   within +timeout+ seconds (default: 60s)
+    def run_command
+      if logger
+        log_message = (log_tag.nil? ? "" : "#@log_tag ") << "sh(#@command)"
+        logger.send(log_level, log_message)
+      end
+      super
+    end
+
+    # Checks the +exitstatus+ against the set of +valid_exit_codes+. If
+    # +exitstatus+ is not in the list of +valid_exit_codes+, calls +invalid!+,
+    # which raises an Exception.
+    # === Returns
+    # nil::: always returns nil when it does not raise
+    # === Raises
+    # ::ShellCommandFailed::: via +invalid!+
+    def error!
+      unless Array(valid_exit_codes).include?(exitstatus)
+        invalid!("Expected process to exit with #{valid_exit_codes.inspect}, but received '#{exitstatus}'")
+      end
+    end
+
+    # Raises a ShellCommandFailed exception, appending the
+    # command's stdout, stderr, and exitstatus to the exception message.
+    # === Arguments
+    # +msg+:  A String to use as the basis of the exception message. The
+    # default explanation is very generic, providing a more informative message
+    # is highly encouraged.
+    # === Raises
+    # ShellCommandFailed  always
+    def invalid!(msg=nil)
+      msg ||= "Command produced unexpected results"
+      raise ShellCommandFailed, msg + "\n" + format_for_exception
+    end
+
+    def inspect
+      "<#{self.class.name}##{object_id}: command: '#@command' process_status: #{@status.inspect} " +
+      "stdout: '#{stdout.strip}' stderr: '#{stderr.strip}' child_pid: #{@child_pid.inspect} " +
+      "environment: #{@environment.inspect} timeout: #{timeout} user: #@user group: #@group working_dir: #@cwd >"
+    end
+
+    private
+
+    def parse_options(opts)
+      opts.each do |option, setting|
+        case option.to_s
+        when 'cwd'
+          self.cwd = setting
+        when 'user'
+          self.user = setting
+        when 'group'
+          self.group = setting
+        when 'umask'
+          self.umask = setting
+        when 'timeout'
+          self.timeout = setting
+        when 'returns'
+          self.valid_exit_codes = Array(setting)
+        when 'live_stream'
+          self.live_stream = setting
+        when 'logger'
+          self.logger = setting
+        when 'log_level'
+          self.log_level = setting
+        when 'log_tag'
+          self.log_tag = setting
+        when 'environment', 'env'
+          # passing :environment => nil means don't set any new ENV vars
+          @environment = setting.nil? ? {} : @environment.dup.merge!(setting)
+        else
+          raise InvalidCommandOption, "option '#{option.inspect}' is not a valid option for #{self.class.name}"
+        end
+      end
+    end
+
+
+  end
+end