r10k 1.1.4 → 1.2.0rc1

data/lib/r10k/util/subprocess/io.rb

@@ -0,0 +1,12 @@
+class R10K::Util::Subprocess::IO
+
+  attr_reader :stdin
+
+  attr_accessor :stdout
+  attr_accessor :stderr
+
+  def initialize
+    @stdout = '/dev/null'
+    @stderr = '/dev/null'
+  end
+end

data/lib/r10k/util/subprocess/result.rb

@@ -0,0 +1,36 @@
+# @api private
+class R10K::Util::Subprocess::Result
+
+  # @!attribute [r] argv
+  #   @return [Array<String>]
+  attr_reader :argv
+
+  # @!attribute [r] cmd
+  #   @return [String]
+  attr_reader :cmd
+
+  # @!attribute [r] stdout
+  #   @return [String]
+  attr_reader :stdout
+
+  # @!attribute [r] stderr
+  #   @return [String]
+  attr_reader :stderr
+
+  # @!attribute [r] exit_code
+  #   @return [Integer]
+  attr_reader :exit_code
+
+
+  def initialize(argv, stdout, stderr, exit_code)
+    @argv = argv
+    @cmd = argv.join(' ')
+    @stdout = stdout
+    @stderr = stderr
+    @exit_code = exit_code
+  end
+
+  def [](field)
+    send(field)
+  end
+end

data/lib/r10k/util/subprocess/runner.rb

@@ -0,0 +1,88 @@
+require 'fcntl'
+
+# @api private
+class R10K::Util::Subprocess::Runner
+
+  attr_accessor :cwd
+
+  attr_reader :io
+
+  attr_reader :pid
+
+  attr_reader :status
+
+  def initialize(argv)
+    @argv = argv
+
+    @io = R10K::Util::Subprocess::IO.new
+  end
+
+  def start
+    exec_r, exec_w = status_pipe()
+
+    @pid = fork do
+      exec_r.close
+      execute_child(exec_w)
+    end
+
+    exec_w.close
+    execute_parent(exec_r)
+  end
+
+  def wait
+    if @pid
+      _, @status = Process.waitpid2(@pid)
+    end
+  end
+
+  def crashed?
+    exit_code != 0
+  end
+
+  def exit_code
+    @status.exitstatus
+  end
+
+  private
+
+  def execute_child(exec_w)
+    if @cwd
+      Dir.chdir @cwd
+    end
+
+    # Create a new session for the forked child. This prevents children from
+    # ever being the foreground process on a TTY, which is almost always what
+    # we want in r10k.
+    Process.setsid
+
+    # Reopen file descriptors
+    STDOUT.reopen(io.stdout)
+    STDERR.reopen(io.stderr)
+
+    executable = @argv.shift
+    exec([executable, executable], *@argv)
+  rescue SystemCallError => e
+    exec_w.write(e.message)
+  end
+
+  def execute_parent(exec_r)
+
+    if not exec_r.eof?
+      msg = exec_r.read || "exec() failed"
+      raise "Could not execute #{@argv.join(' ')}: #{msg}"
+    end
+  end
+
+  # Create a pipe so that the parent can verify that the child process
+  # successfully executed. The pipe will be closed on a successful exec(),
+  # and will contain an error message on failure.
+  #
+  # @return [IO, IO] The reader and writer for this pipe
+  def status_pipe
+    r_pipe, w_pipe = ::IO.pipe
+
+    w_pipe.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
+
+    [r_pipe, w_pipe]
+  end
+end

data/lib/r10k/util/subprocess.rb

@@ -0,0 +1,107 @@
+require 'r10k/logging'
+require 'r10k/errors'
+
+module R10K
+  module Util
+
+    # The subprocess namespace implements a subset of childprocess. It has
+    # three # main differences.
+    #
+    #   1. child processes invoke setsid()
+    #   2. there are no dependencies on C extensions (ffi)
+    #   3. it only support unixy systems.
+    class Subprocess
+
+      require 'r10k/util/subprocess/runner'
+      require 'r10k/util/subprocess/io'
+      require 'r10k/util/subprocess/result'
+
+      include R10K::Logging
+
+      attr_accessor :raise_on_fail
+      attr_accessor :cwd
+
+      attr_writer :logger
+
+      def initialize(argv)
+        @argv = argv
+
+        @raise_on_fail = false
+      end
+
+      def execute
+        subprocess = R10K::Util::Subprocess::Runner.new(@argv)
+        subprocess.cwd = @cwd
+
+        stdout_r, stdout_w = attach_pipe(subprocess.io, :stdout, :reader)
+        stderr_r, stderr_w = attach_pipe(subprocess.io, :stderr, :reader)
+
+        logmsg = "Execute: #{@argv.join(' ')}"
+        logmsg << "(cwd: #{@cwd})" if @cwd
+        logger.debug1 logmsg
+
+        subprocess.start
+        stdout_w.close
+        stderr_w.close
+        subprocess.wait
+
+        stdout = stdout_r.read
+        stderr = stderr_r.read
+
+        result = Result.new(@argv, stdout, stderr, subprocess.exit_code)
+
+        logger.debug2 "[#{result.cmd}] STDOUT: #{result.stdout.chomp}" unless result.stdout.empty?
+        logger.debug2 "[#{result.cmd}] STDERR: #{result.stderr.chomp}" unless result.stderr.empty?
+
+        if @raise_on_fail and subprocess.crashed?
+          raise SubprocessError.new(:result => result)
+        end
+
+        result
+      end
+
+      private
+
+      # Attach a pipe to the given process, and return the requested end of the
+      # pipe.
+      #
+      # @param subproc [Runner]
+      # @param name [Symbol] The name of the setter method on the subproc
+      # @param type [Symbol] One of (:reader, :writer) denoting the type to return
+      #
+      # @return [Array<IO>] The reader and writer endpoints of the pipe
+      def attach_pipe(subproc, name, type)
+        rd, wr = ::IO.pipe
+
+        case type
+        when :reader
+          other = wr
+        when :writer
+          other = rd
+        end
+
+        subproc.send("#{name}=", other)
+
+        [rd, wr]
+      end
+
+      class SubprocessError < R10KError
+
+        attr_reader :result
+
+        def initialize(mesg = nil, options = {})
+          super
+          @result = @options[:result]
+        end
+
+        def to_s
+          if @mesg
+            @mesg
+          else
+            "Command #{@result.cmd} exited with #{@result.exit_code}: #{@result.stderr}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/r10k/version.rb

@@ -1,3 +1,3 @@
 module R10K
-  VERSION = '1.1.4'
+  VERSION = '1.2.0rc1'
 end

data/r10k.gemspec

@@ -22,11 +22,21 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'colored',   '>= 1.2'
   s.add_dependency 'cri',       '~> 2.4.0'
+
   s.add_dependency 'systemu',   '~> 2.5.2'
+
   s.add_dependency 'log4r',     '>= 1.1.10'
-  s.add_dependency 'json_pure'
+  s.add_dependency 'multi_json', '~> 1.8.2'
+  s.add_dependency 'json_pure',  '~> 1.8.1'
+
+  s.add_dependency 'faraday',                       '~> 0.8.8'
+  s.add_dependency 'faraday_middleware',            '~> 0.9.0'
+  s.add_dependency 'faraday_middleware-multi_json', '~> 0.0.5'
 
   s.add_development_dependency 'rspec', '~> 2.14.0'
+  s.add_development_dependency 'vcr',   '~> 2.8.0'
+
+  s.add_development_dependency 'yard', '~> 0.8.7.3'
 
   s.files        = %x[git ls-files].split($/)
   s.require_path = 'lib'

data/spec/fixtures/vcr/cassettes/R10K_ModuleRepository_Forge/and_the_expected_version_is_latest/can_fetch_all_versions_of_a_given_module.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://forge.puppetlabs.com/api/v1/releases.json?module=adrien%2Fboolean
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.8
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      server:
+      - nginx
+      date:
+      - Tue, 31 Dec 2013 02:53:38 GMT
+      content-type:
+      - application/json
+      content-length:
+      - '432'
+      connection:
+      - close
+      status:
+      - 200 OK
+      x-frame-options:
+      - sameorigin
+      x-xss-protection:
+      - 1; mode=block
+      x-node:
+      - forgeweb04
+      x-revision:
+      - b288c1e7e86f82eef7692085670c78693062c84d
+    body:
+      encoding: US-ASCII
+      string: ! '{"adrien/boolean":[{"file":"/system/releases/a/adrien/adrien-boolean-0.9.0-rc1.tar.gz","version":"0.9.0-rc1","dependencies":[]},{"file":"/system/releases/a/adrien/adrien-boolean-0.9.0.tar.gz","version":"0.9.0","dependencies":[]},{"file":"/system/releases/a/adrien/adrien-boolean-1.0.0.tar.gz","version":"1.0.0","dependencies":[]},{"file":"/system/releases/a/adrien/adrien-boolean-1.0.1.tar.gz","version":"1.0.1","dependencies":[]}]}'
+    http_version: 
+  recorded_at: Tue, 31 Dec 2013 02:54:56 GMT
+recorded_with: VCR 2.8.0

data/spec/fixtures/vcr/cassettes/R10K_ModuleRepository_Forge/and_the_expected_version_is_latest/can_fetch_the_latest_version_of_a_given_module.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://forge.puppetlabs.com/api/v1/releases.json?module=adrien%2Fboolean
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.8
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      server:
+      - nginx
+      date:
+      - Tue, 31 Dec 2013 02:53:38 GMT
+      content-type:
+      - application/json
+      content-length:
+      - '432'
+      connection:
+      - close
+      status:
+      - 200 OK
+      x-frame-options:
+      - sameorigin
+      x-xss-protection:
+      - 1; mode=block
+      x-node:
+      - forgeweb02
+      x-revision:
+      - b288c1e7e86f82eef7692085670c78693062c84d
+    body:
+      encoding: US-ASCII
+      string: ! '{"adrien/boolean":[{"file":"/system/releases/a/adrien/adrien-boolean-0.9.0-rc1.tar.gz","version":"0.9.0-rc1","dependencies":[]},{"file":"/system/releases/a/adrien/adrien-boolean-0.9.0.tar.gz","version":"0.9.0","dependencies":[]},{"file":"/system/releases/a/adrien/adrien-boolean-1.0.0.tar.gz","version":"1.0.0","dependencies":[]},{"file":"/system/releases/a/adrien/adrien-boolean-1.0.1.tar.gz","version":"1.0.1","dependencies":[]}]}'
+    http_version: 
+  recorded_at: Tue, 31 Dec 2013 02:54:57 GMT
+recorded_with: VCR 2.8.0

data/spec/fixtures/vcr/cassettes/R10K_ModuleRepository_Forge/looking_up_versions/can_fetch_all_versions_of_a_given_module.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://forge.puppetlabs.com/api/v1/releases.json?module=adrien%2Fboolean
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.8
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      server:
+      - nginx
+      date:
+      - Wed, 25 Dec 2013 23:48:29 GMT
+      content-type:
+      - application/json
+      content-length:
+      - '432'
+      connection:
+      - close
+      status:
+      - 200 OK
+      x-frame-options:
+      - sameorigin
+      x-xss-protection:
+      - 1; mode=block
+      x-node:
+      - forgeweb03
+      x-revision:
+      - b288c1e7e86f82eef7692085670c78693062c84d
+    body:
+      encoding: US-ASCII
+      string: ! '{"adrien/boolean":[{"file":"/system/releases/a/adrien/adrien-boolean-0.9.0-rc1.tar.gz","version":"0.9.0-rc1","dependencies":[]},{"file":"/system/releases/a/adrien/adrien-boolean-0.9.0.tar.gz","version":"0.9.0","dependencies":[]},{"file":"/system/releases/a/adrien/adrien-boolean-1.0.0.tar.gz","version":"1.0.0","dependencies":[]},{"file":"/system/releases/a/adrien/adrien-boolean-1.0.1.tar.gz","version":"1.0.1","dependencies":[]}]}'
+    http_version: 
+  recorded_at: Wed, 25 Dec 2013 23:49:42 GMT
+recorded_with: VCR 2.8.0

data/spec/fixtures/vcr/cassettes/R10K_ModuleRepository_Forge/looking_up_versions/can_fetch_the_latest_version_of_a_given_module.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://forge.puppetlabs.com/api/v1/releases.json?module=adrien%2Fboolean
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.8
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      server:
+      - nginx
+      date:
+      - Wed, 25 Dec 2013 23:48:29 GMT
+      content-type:
+      - application/json
+      content-length:
+      - '432'
+      connection:
+      - close
+      status:
+      - 200 OK
+      x-frame-options:
+      - sameorigin
+      x-xss-protection:
+      - 1; mode=block
+      x-node:
+      - forgeweb01
+      x-revision:
+      - b288c1e7e86f82eef7692085670c78693062c84d
+    body:
+      encoding: US-ASCII
+      string: ! '{"adrien/boolean":[{"file":"/system/releases/a/adrien/adrien-boolean-0.9.0-rc1.tar.gz","version":"0.9.0-rc1","dependencies":[]},{"file":"/system/releases/a/adrien/adrien-boolean-0.9.0.tar.gz","version":"0.9.0","dependencies":[]},{"file":"/system/releases/a/adrien/adrien-boolean-1.0.0.tar.gz","version":"1.0.0","dependencies":[]},{"file":"/system/releases/a/adrien/adrien-boolean-1.0.1.tar.gz","version":"1.0.1","dependencies":[]}]}'
+    http_version: 
+  recorded_at: Wed, 25 Dec 2013 23:49:43 GMT
+recorded_with: VCR 2.8.0