r10k 1.3.5 → 1.4.0

data/lib/r10k/util/setopts.rb

@@ -0,0 +1,53 @@
+module R10K
+  module Util
+
+    # Allow for easy setting of instance options based on a hash
+    #
+    # This emulates the behavior of Ruby 2.0 named arguments, but since r10k
+    # supports Ruby 1.8.7+ we cannot use that functionality.
+    module Setopts
+
+      private
+
+      # @param opts [Hash]
+      # @param allowed [Hash<Symbol, Symbol>]
+      #
+      # @example
+      #   opts = {:one => "one value"}
+      #   allowed => {:one => :self}
+      #   setopts(opts, allowed)
+      #   @one # => "one value"
+      #
+      # @example
+      #   opts = {:uno => "one value"}
+      #   allowed => {:one => :one, :uno => :one}
+      #   setopts(opts, allowed)
+      #   @one # => "one value"
+      #
+      # @example
+      #
+      #   opts = {:trace => "something"}
+      #   allowed = {:trace => nil}
+      #   setopts(opts, allowed)
+      #   @trace # => nil
+      #
+      def setopts(opts, allowed)
+        opts.each_pair do |key, value|
+          if allowed.key?(key)
+            rhs = allowed[key]
+            case rhs
+            when NilClass, FalseClass
+              # Ignore nil options
+            when :self, TrueClass
+              instance_variable_set("@#{key}".to_sym, value)
+            else
+              instance_variable_set("@#{rhs}".to_sym, value)
+            end
+          else
+            raise ArgumentError, "#{self.class.name} cannot handle option '#{key}'"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/r10k/util/subprocess.rb

@@ -1,4 +1,3 @@
-require 'r10k/errors'
 require 'r10k/util/platform'
 
 module R10K
@@ -14,6 +13,7 @@ module R10K
       require 'r10k/util/subprocess/runner'
       require 'r10k/util/subprocess/io'
       require 'r10k/util/subprocess/result'
+      require 'r10k/util/subprocess/subprocess_error'
 
       require 'r10k/util/subprocess/posix'
       require 'r10k/util/subprocess/windows'
@@ -68,43 +68,19 @@ module R10K
         subprocess = self.class.runner.new(@argv)
         subprocess.cwd = @cwd if @cwd
 
-        logmsg = "Execute: #{@argv.join(' ')}"
+        logmsg = "Starting process: #{@argv.inspect}"
         logmsg << "(cwd: #{@cwd})" if @cwd
-        logger.debug1 logmsg
+        logger.debug2(logmsg)
 
-        subprocess.run
-
-        result = subprocess.result
-
-        logger.debug2 "[#{result.cmd}] STDOUT: #{result.stdout.chomp}" unless result.stdout.empty?
-        logger.debug2 "[#{result.cmd}] STDERR: #{result.stderr.chomp}" unless result.stderr.empty?
+        result = subprocess.run
+        logger.debug2("Finished process:\n#{result.format}")
 
         if @raise_on_fail and subprocess.crashed?
-          raise SubprocessError.new(:result => result)
+          raise SubprocessError.new("Command exited with non-zero exit code", :result => result)
         end
 
         result
       end
-
-      class SubprocessError < R10KError
-
-        # !@attribute [r] result
-        #   @return [R10K::Util::Subprocess::Result]
-        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/util/subprocess/posix/runner.rb

@@ -39,8 +39,14 @@ class R10K::Util::Subprocess::POSIX::Runner < R10K::Util::Subprocess::Runner
     end
 
     stdout = @stdout_r.read
-    stderr = @stderr_r.read
-
+    # Use non-blocking read for stderr_r to work around an issue with OpenSSH
+    # ControlPersist: https://bugzilla.mindrot.org/show_bug.cgi?id=1988
+    # Blocking should not occur in any other case since the process that was
+    # attached to the pipe has already terminated.
+    stderr = read_nonblock(@stderr_r)
+
+    @stdout_r.close
+    @stderr_r.close
     @result = R10K::Util::Subprocess::Result.new(@argv, stdout, stderr, @status.exitstatus)
   end
 
@@ -88,6 +94,7 @@ class R10K::Util::Subprocess::POSIX::Runner < R10K::Util::Subprocess::Runner
       msg = exec_r.read || "exec() failed"
       raise "Could not execute #{@argv.join(' ')}: #{msg}"
     end
+    exec_r.close
   end
 
   # Create a pipe so that the parent can verify that the child process
@@ -107,7 +114,27 @@ class R10K::Util::Subprocess::POSIX::Runner < R10K::Util::Subprocess::Runner
     @stdout_r, @stdout_w = ::IO.pipe
     @stderr_r, @stderr_w = ::IO.pipe
 
+    @stdout_r.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
+    @stdout_w.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
+    @stderr_r.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
+    @stderr_w.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
+
     @io.stdout = @stdout_w
     @io.stderr = @stderr_w
   end
+
+  # Perform non-blocking reads on a pipe that could still be open
+  # Give up on reaching EOF or blocking and return what was read
+  def read_nonblock(rd_io)
+    data = ''
+    begin
+      # Loop until EOF or blocking
+      loop do
+          # do an 8k non-blocking read and append the result
+          data << rd_io.read_nonblock(8192)
+      end
+    rescue EOFError, Errno::EAGAIN, Errno::EWOULDBLOCK
+    end
+    data
+  end
 end

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

@@ -24,13 +24,26 @@ class R10K::Util::Subprocess::Result
   def initialize(argv, stdout, stderr, exit_code)
     @argv = argv
     @cmd = argv.join(' ')
-    @stdout = stdout
-    @stderr = stderr
+    @stdout = stdout.chomp
+    @stderr = stderr.chomp
     @exit_code = exit_code
   end
 
-  def [](field)
-    send(field)
+  def format(with_cmd = true)
+    msg = []
+    if with_cmd
+      msg << "Command: #{@cmd}"
+    end
+    if !@stdout.empty?
+      msg << "Stdout:"
+      msg << @stdout
+    end
+    if !@stderr.empty?
+      msg << "Stderr:"
+      msg << @stderr
+    end
+    msg << "Exit code: #{@exit_code}"
+    msg.join("\n")
   end
 
   def failed?

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

@@ -0,0 +1,24 @@
+require 'r10k/errors'
+require 'r10k/util/subprocess'
+require 'r10k/util/setopts'
+
+class R10K::Util::Subprocess::SubprocessError < R10K::Error
+
+  # !@attribute [r] result
+  #   @return [R10K::Util::Subprocess::Result]
+  attr_reader :result
+
+  include R10K::Util::Setopts
+
+  def initialize(mesg, options = {})
+    super
+    setopts(options, {:result => true})
+  end
+
+  def message
+    msg = []
+    msg << "#{super}:"
+    msg << @result.format
+    msg.join("\n")
+  end
+end

data/lib/r10k/version.rb

@@ -1,3 +1,3 @@
 module R10K
-  VERSION = '1.3.5'
+  VERSION = '1.4.0'
 end

data/r10k.gemspec

@@ -18,23 +18,23 @@ Gem::Specification.new do |s|
     dynamic environments.
   DESCRIPTION
 
-  s.license  = 'Apache 2.0'
+  s.license  = 'Apache-2.0'
 
-  s.add_dependency 'colored',   '>= 1.2'
-  s.add_dependency 'cri',       '~> 2.5.0'
+  s.add_dependency 'colored',   '1.2'
+  s.add_dependency 'cri',       '~> 2.6.1'
 
   s.add_dependency 'systemu',   '~> 2.5.2'
 
-  s.add_dependency 'log4r',     '>= 1.1.10'
+  s.add_dependency 'log4r',     '1.1.10'
   s.add_dependency 'multi_json', '~> 1.8.2'
-  s.add_dependency 'json_pure',  '~> 1.8.1'
+  s.add_dependency 'json_pure',  '~> 1.8'
 
   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 'rspec', '~> 3.1'
+  s.add_development_dependency 'vcr',   '~> 2.9'
 
   s.add_development_dependency 'yard', '~> 0.8.7.3'
 
@@ -44,26 +44,4 @@ Gem::Specification.new do |s|
   s.executables  = 'r10k'
 
   s.test_files   = Dir.glob("spec/**/*_spec.rb")
-
-  s.post_install_message = <<-EOD.gsub(/^ {4}/, '')
-    NOTICE
-    ======
-
-    If you are upgrading from 1.1.0 and are using multiple sources, please read
-    this. (If not, feel free to continue with your regularly scheduled day.)
-
-    GH-48 (https://github.com/adrienthebo/r10k/issues/48) introduced the ability
-    for environments to be prefixed with the source name so that multiple sources
-    installed into the same directory would not overwrite each other. However
-    prefixing was automatically enabled and would break existing setups where
-    multiple sources were cloned into different directories.
-
-    Because this introduced a breaking change, SemVer dictates that the automatic
-    prefixing has to be rolled back. Prefixing can be enabled but always defaults
-    to off. If you are relying on this behavior you will need to update your r10k.yaml
-    to enable prefixing on a per-source basis.
-
-    Please see the issue (https://github.com/adrienthebo/r10k/issues/48) for more
-    information.
-  EOD
 end

data/spec/fixtures/unit/puppetfile/invalid-syntax/Puppetfile

@@ -0,0 +1 @@
+mod 'branan/eight_hundred' :git => 'https://github.com/branan/eight_hundred'

data/spec/fixtures/unit/puppetfile/load-error/Puppetfile

@@ -0,0 +1 @@
+require 'a-shrubbery!'

data/spec/matchers/exit_with.rb

@@ -0,0 +1,28 @@
+RSpec::Matchers.define :exit_with do |expected|
+
+  supports_block_expectations
+
+  match do |block|
+    actual = nil
+    begin
+      block.call
+    rescue SystemExit => e
+      actual = e.status
+    end
+    actual and actual == expected
+  end
+
+  failure_message do |actual|
+    "expected exit with code #{expected} but " +
+      (actual.nil? ? " exit was not called" : "we exited with #{actual} instead")
+  end
+
+  failure_message_when_negated do |actual|
+    "expected that exit would not be called with #{expected}"
+  end
+
+  description do
+    "expect exit with #{expected}"
+  end
+end
+

data/spec/r10k-mocks.rb

@@ -0,0 +1,3 @@
+require 'r10k-mocks/mock_env'
+require 'r10k-mocks/mock_source'
+require 'r10k-mocks/mock_config'

data/spec/r10k-mocks/mock_config.rb

@@ -0,0 +1,28 @@
+require 'r10k/deployment/config'
+
+module R10K
+  class Deployment
+    class MockConfig
+      def initialize(hash)
+        @hash = hash
+      end
+
+      # Perform a scan for key and check for both string and symbol keys
+      def setting(key)
+        keys = [key]
+        case key
+        when String
+          keys << key.to_sym
+        when Symbol
+          keys << key.to_s
+        end
+
+        # Scan all possible keys to see if the config has a matching value
+        keys.inject(nil) do |rv, k|
+          v = @hash[k]
+          break v unless v.nil?
+        end
+      end
+    end
+  end
+end

data/spec/r10k-mocks/mock_env.rb

@@ -0,0 +1,7 @@
+require 'r10k/environment'
+
+class R10K::Environment::Mock < R10K::Environment::Base
+  def sync
+    "synced"
+  end
+end

data/spec/r10k-mocks/mock_source.rb

@@ -0,0 +1,10 @@
+require 'r10k/source'
+require 'r10k-mocks/mock_env'
+
+class R10K::Source::Mock < R10K::Source::Base
+  R10K::Source.register(:mock, self)
+
+  def environments
+    @options[:environments].map { |n| R10K::Environment::Mock.new(n, @basedir, n) }
+  end
+end

data/spec/shared-examples/git-ref.rb

@@ -6,30 +6,30 @@ shared_examples_for "a git ref" do
   end
 
   describe "comparing to another object" do
-    let(:other) { double('equal') }
+    let(:other) { R10K::Git::Ref.new('double') }
 
     it "is true if the resolved SHA1s match" do
       expect(other).to receive(:sha1).and_return 'fcf6140cf3e0b3738583167702176867833ec2a7'
       expect(subject).to receive(:sha1).and_return 'fcf6140cf3e0b3738583167702176867833ec2a7'
-      expect(subject == other).to be_true
+      expect(subject == other).to be_truthy
     end
 
     it "is false if the resolved SHA1s don't match" do
       expect(other).to receive(:sha1).and_return '57d31c788610d7d6a1c139b4ffff0d60888ca742'
       expect(subject).to receive(:sha1).and_return 'fcf6140cf3e0b3738583167702176867833ec2a7'
-      expect(subject == other).to be_false
+      expect(subject == other).to be_falsey
     end
 
     it "is false if an argumenterror is raised while comparing the SHA1s" do
       expect(other).to receive(:sha1).and_return 'fcf6140cf3e0b3738583167702176867833ec2a7'
       expect(subject).to receive(:sha1).and_raise(ArgumentError, "Cannot resolve")
-      expect(subject == other).to be_false
+      expect(subject == other).to be_falsey
     end
 
     it "is false if a nonexistenthasherror is raised while comparing the SHA1s" do
       expect(other).to receive(:sha1).and_return 'fcf6140cf3e0b3738583167702176867833ec2a7'
       expect(subject).to receive(:sha1).and_raise(R10K::Git::UnresolvableRefError, :ref => "hash")
-      expect(subject == other).to be_false
+      expect(subject == other).to be_falsey
     end
   end
 end
@@ -38,12 +38,12 @@ shared_examples_for "an immutable git ref" do
   describe "determining if the ref needs to be fetched" do
     it "is false when the ref can be resolved" do
       expect(subject).to receive(:resolvable?).and_return true
-      expect(subject.fetch?).to be_false
+      expect(subject.fetch?).to be_falsey
     end
 
     it "is true when the ref cannot be resolved" do
       expect(subject).to receive(:resolvable?).and_return false
-      expect(subject.fetch?).to be_true
+      expect(subject.fetch?).to be_truthy
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,21 @@
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter do |src|
+      !src.filename.match(%r[lib/r10k])
+    end
+
+    %w[Deployment Source Environment Module Git SVN Action Util].each do |group|
+      add_group group, "lib/r10k/#{group.downcase}"
+    end
+  end
+end
+
 require 'r10k'
 
 require 'shared-examples/git-ref'
+require 'matchers/exit_with'
+require 'r10k-mocks'
 
 PROJECT_ROOT = File.expand_path('..', File.dirname(__FILE__))
 
@@ -16,12 +31,9 @@ RSpec.configure do |config|
   #
   # To run integration tests, run `rspec --tag integration`
   config.filter_run_excluding :integration => true
-end
 
-shared_context 'stub logging' do
-  before do
-    log = double('stub logger').as_null_object
-    allow_any_instance_of(described_class).to receive(:logger).and_return log
+  config.before(:all) do
+    Log4r::Logger.global.level = 10
   end
 end