r10k 2.0.3 → 2.1.0

data/lib/r10k/settings/definition.rb

@@ -0,0 +1,112 @@
+require 'r10k/util/setopts'
+
+module R10K
+  module Settings
+
+    # Define a single setting and additional attributes like descriptions,
+    # default values, and validation.
+    class Definition
+
+      require 'r10k/settings/uri_definition'
+      require 'r10k/settings/enum_definition'
+
+      include R10K::Util::Setopts
+
+      # @!attribute [r] name
+      #   @return [String] The name of this setting
+      attr_reader :name
+
+      # @!attribute [r] value
+      #   @return [Object] An explicitly set value. This should only be used if
+      #     an optional default value should not be used; otherwise use {#resolve}.
+      attr_reader :value
+
+      # @!attribute [r] desc
+      #   @return [String] An optional documentation string for this setting.
+      attr_reader :desc
+
+      # @param name [Symbol] The name of the setting for this definition.
+      # @param opts [Hash] Additional options for this definition to control
+      #   validation, normalization, and the like.
+      #
+      # @option opts [Proc, Object] :default An optional proc or object for
+      #   this setting. If no value has been set and the default is a Proc then
+      #   it will be called and the result will be returned, otherwise if the
+      #   value is not set the default value itself is returned.
+      #
+      # @options opts [Proc] :validate An optional proc that can be used to
+      #   validate an assigned value. Default values are not assigned.
+      #
+      # @options opts [Proc] :normalize An optional proc that can be used to
+      #   normalize an explicitly assigned value.
+      def initialize(name, opts = {})
+        @name = name
+        setopts(opts, allowed_initialize_opts)
+      end
+
+      # Assign new values, perform validation checks, and return the final
+      # values for this collection
+      def evaluate(newvalue)
+        assign(newvalue)
+        validate
+        resolve
+      end
+
+      # Store an explicit value for this definition
+      #
+      # If a :normalize hook has been given then it will be called with the
+      # new value and the returned value will be stored.
+      #
+      # @param newvalue [Object] The value to store for this setting
+      # @return [void]
+      def assign(newvalue)
+        if @normalize
+          @value = @normalize.call(newvalue)
+        else
+          @value = newvalue
+        end
+      end
+
+      # Call any validation hooks for this definition.
+      #
+      # The :validate hook will be called if the hook has been set and an
+      # explicit value has been assigned to this definition. Validation
+      # failures should be indicated by the :validate hook raising an exception.
+      #
+      # @raise [Exception] An exception class indicating that validation failed.
+      # @return [nil]
+      def validate
+        if @value && @validate
+          @validate.call(@value)
+        end
+        nil
+      end
+
+      # Compute the final value of this setting. If a value has not been
+      # assigned the default value will be used.
+      #
+      # @return [Object] The final value of this definition.
+      def resolve
+        if !@value.nil?
+          @value
+        elsif @default
+          @default.is_a?(Proc) ? @default.call : @default
+        end
+      end
+
+      private
+
+      # Subclasses may define additional params that are accepted at
+      # initialization; they should override this method to add any
+      # additional fields that should be respected.
+      def allowed_initialize_opts
+        {
+          :desc      => true,
+          :default   => true,
+          :validate  => true,
+          :normalize => true,
+        }
+      end
+    end
+  end
+end

data/lib/r10k/settings/enum_definition.rb

@@ -0,0 +1,22 @@
+require 'r10k/settings/definition'
+
+module R10K
+  module Settings
+    class EnumDefinition < R10K::Settings::Definition
+
+      def validate
+        if @value
+          if !@enum.include?(@value)
+            raise ArgumentError, "Setting #{@name} should be one of #{@enum.inspect}, not '#{@value}'"
+          end
+        end
+      end
+
+      private
+
+      def allowed_initialize_opts
+        super.merge({:enum => true})
+      end
+    end
+  end
+end

data/lib/r10k/settings/loader.rb

@@ -0,0 +1,96 @@
+require 'r10k/logging'
+require 'r10k/errors'
+require 'yaml'
+
+module R10K
+  module Settings
+    # Look for the r10k configuration file in standard locations.
+    #
+    # r10k.yaml is checked for in the following locations:
+    #   - $PWD/r10k.yaml
+    #   - /etc/puppetlabs/r10k/r10k.yaml
+    #   - /etc/r10k.yaml
+    class Loader
+
+      def self.search(override = nil)
+        new.search(override)
+      end
+
+      include R10K::Logging
+
+      attr_reader :loadpath
+
+      CONFIG_FILE = 'r10k.yaml'
+      DEFAULT_LOCATION = File.join('/etc/puppetlabs/r10k', CONFIG_FILE)
+      OLD_DEFAULT_LOCATION = File.join('/etc', CONFIG_FILE)
+
+      def initialize
+        @loadpath = []
+        populate_loadpath
+      end
+
+      # Find the first valid config file.
+      #
+      # @param override [String, nil] An optional path that when is truthy
+      #   will be preferred over all other files, to make it easy to
+      #   optionally supply an explicit configuration file that will always
+      #   be used when set.
+      # @return [String, nil] The path to the first valid configfile, or nil
+      #   if no file was found.
+      def search(override = nil)
+        return override if override
+
+        # If both default files are present, issue a warning.
+        if (File.file? DEFAULT_LOCATION) && (File.file? OLD_DEFAULT_LOCATION)
+          logger.warn "Both #{DEFAULT_LOCATION} and #{OLD_DEFAULT_LOCATION} configuration files exist."
+          logger.warn "#{DEFAULT_LOCATION} will be used."
+        end
+
+        path = @loadpath.find {|filename| File.file? filename}
+
+        if path == OLD_DEFAULT_LOCATION
+          logger.warn "The r10k configuration file at #{OLD_DEFAULT_LOCATION} is deprecated."
+          logger.warn "Please move your r10k configuration to #{DEFAULT_LOCATION}."
+        end
+
+        path
+      end
+
+      def read(override = nil)
+        path = search(override)
+
+        if path.nil?
+          raise ConfigError, "No configuration file given, no config file found in current directory, and no global config present"
+        end
+
+        begin
+          contents = ::YAML.load_file(path)
+        rescue => e
+          raise ConfigError, "Couldn't load config file: #{e.message}"
+        end
+
+        R10K::Util::SymbolizeKeys.symbolize_keys!(contents, true)
+        contents
+      end
+
+      private
+
+      def populate_loadpath
+
+        # Add the current directory for r10k.yaml
+        @loadpath << File.join(Dir.getwd, CONFIG_FILE)
+
+        # Add the AIO location for of r10k.yaml
+        @loadpath << DEFAULT_LOCATION
+
+        # Add the old default location last.
+        @loadpath << OLD_DEFAULT_LOCATION
+
+        @loadpath
+      end
+
+      class ConfigError < R10K::Error
+      end
+    end
+  end
+end

data/lib/r10k/settings/uri_definition.rb

@@ -0,0 +1,19 @@
+require 'r10k/settings/definition'
+require 'uri'
+
+module R10K
+  module Settings
+    class URIDefinition < R10K::Settings::Definition
+      def validate
+        if @value
+          begin
+            URI.parse(@value)
+          rescue URI::Error
+            raise ArgumentError, "Setting #{@name} requires a URL but '#{@value}' could not be parsed as a URL"
+          end
+        end
+        super
+      end
+    end
+  end
+end

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

@@ -14,10 +14,10 @@ class R10K::Util::Subprocess::Runner::Windows < R10K::Util::Subprocess::Runner
   end
 
   def run
-    cmd = @argv.join(' ')
-
-    stdout, stderr, status = Open3.capture3(cmd)
-
+    spawn_opts = @cwd ? {:chdir => @cwd} : {}
+    stdout, stderr, status = Open3.capture3(*@argv, spawn_opts)
     @result = R10K::Util::Subprocess::Result.new(@argv, stdout, stderr, status.exitstatus)
+  rescue Errno::ENOENT, Errno::EACCES => e
+    @result = R10K::Util::Subprocess::Result.new(@argv, '', e.message, 255)
   end
 end

data/lib/r10k/version.rb

@@ -1,3 +1,3 @@
 module R10K
-  VERSION = '2.0.3'
+  VERSION = '2.1.0'
 end

data/r10k.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
 
   s.authors     = "Adrien Thebo"
   s.email       = "adrien@somethingsinistral.net"
-  s.homepage    = "http://github.com/adrienthebo/r10k"
+  s.homepage    = "https://github.com/puppetlabs/r10k"
   s.summary     = "Puppet environment and module deployment"
   s.description = <<-DESCRIPTION
     R10K provides a general purpose toolset for deploying Puppet environments and modules.
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'log4r',     '1.1.10'
   s.add_dependency 'multi_json', '~> 1.10'
 
+  s.add_dependency 'puppet_forge',                  '~> 2.1.1'
   s.add_dependency 'faraday',                       '~> 0.9.0'
   s.add_dependency 'faraday_middleware',            '~> 0.9.0'
   s.add_dependency 'faraday_middleware-multi_json', '~> 0.0.6'
@@ -44,6 +45,4 @@ Gem::Specification.new do |s|
   s.require_path = 'lib'
   s.bindir       = 'bin'
   s.executables  = 'r10k'
-
-  s.test_files   = Dir.glob("spec/**/*_spec.rb")
 end

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

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

data/spec/integration/git/rugged/thin_repository_spec.rb

@@ -6,9 +6,9 @@ describe R10K::Git::Rugged::ThinRepository, :if => R10K::Features.available?(:ru
 
   let(:dirname) { 'working-repo' }
 
-  subject { described_class.new(basedir, dirname) }
-
   let(:cacherepo) { R10K::Git::Rugged::Cache.generate(remote) }
 
+  subject { described_class.new(basedir, dirname, cacherepo) }
+
   it_behaves_like "a git thin repository"
 end

data/spec/integration/git/rugged/working_repository_spec.rb

@@ -10,4 +10,13 @@ describe R10K::Git::Rugged::WorkingRepository, :if => R10K::Features.available?(
 
   it_behaves_like 'a git repository'
   it_behaves_like 'a git working repository'
+
+  describe "checking out an unresolvable ref" do
+    it "raises an error indicating that the ref was unresolvable" do
+      expect(subject).to receive(:resolve).with("unresolvable")
+      expect {
+        subject.checkout("unresolvable")
+      }.to raise_error(R10K::Git::GitError, /Unable to check out unresolvable ref 'unresolvable'/)
+    end
+  end
 end

data/spec/integration/git/shellgit/thin_repository_spec.rb

@@ -6,9 +6,9 @@ describe R10K::Git::ShellGit::ThinRepository do
 
   let(:dirname) { 'working-repo' }
 
-  subject { described_class.new(basedir, dirname) }
-
   let(:cacherepo) { R10K::Git::ShellGit::Cache.generate(remote) }
 
+  subject { described_class.new(basedir, dirname, cacherepo) }
+
   it_behaves_like "a git thin repository"
 end

data/spec/integration/git/stateful_repository_spec.rb

@@ -7,8 +7,8 @@ describe R10K::Git::StatefulRepository do
 
   let(:dirname) { 'working-repo' }
 
-  let(:thinrepo) { R10K::Git.thin_repository.new(basedir, dirname) }
   let(:cacherepo) { R10K::Git.cache.generate(remote) }
+  let(:thinrepo) { R10K::Git.thin_repository.new(basedir, dirname, cacherepo) }
 
   subject { described_class.new('0.9.x', remote, basedir, dirname) }
 

data/spec/r10k-mocks/mock_config.rb

@@ -3,8 +3,11 @@ require 'r10k/deployment/config'
 module R10K
   class Deployment
     class MockConfig
+
+      attr_accessor :hash
+
       def initialize(hash)
-        @hash = hash
+        @hash = hash.merge(deploy: {})
       end
 
       def configfile
@@ -13,19 +16,13 @@ module R10K
 
       # 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
+        @hash[key]
+      end
+
+      alias [] setting
 
-        # 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
+      def settings
+        @hash
       end
     end
   end

data/spec/r10k-mocks/mock_env.rb

@@ -4,4 +4,12 @@ class R10K::Environment::Mock < R10K::Environment::Base
   def sync
     "synced"
   end
+
+  def status
+    :insync
+  end
+
+  def signature
+    "mock"
+  end
 end

data/spec/shared-examples/deploy-actions.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+require 'r10k/deployment'
+
+shared_examples_for "a deploy action that requires a config file" do
+  let(:config) do
+    R10K::Deployment::MockConfig.new(
+      :sources => {
+        :control => {
+          :type => :mock,
+          :basedir => '/some/nonexistent/path/control',
+          :environments => %w[first second third],
+        },
+        :hiera => {
+          :type => :mock,
+          :basedir => '/some/nonexistent/path/hiera',
+          :environments => %w[fourth fifth sixth],
+        }
+      }
+    )
+  end
+
+  let(:deployment) { R10K::Deployment.new(config) }
+
+  before do
+    allow(R10K::Deployment).to receive(:new).and_return(deployment)
+  end
+
+  it "exits when no config file was provided or found" do
+    subject.instance_variable_set(:@config, nil)
+    expect {
+      subject.call
+    }.to exit_with(8)
+  end
+end
+
+shared_examples_for "a deploy action that can be write locked" do
+
+  let(:config) do
+    R10K::Deployment::MockConfig.new(
+      :sources => {
+        :control => {
+          :type => :mock,
+          :basedir => '/some/nonexistent/path/control',
+          :environments => %w[first second third],
+        },
+        :hiera => {
+          :type => :mock,
+          :basedir => '/some/nonexistent/path/hiera',
+          :environments => %w[fourth fifth sixth],
+        }
+      }
+    )
+  end
+
+  let(:deployment) { R10K::Deployment.new(config) }
+
+  before do
+    allow(R10K::Deployment).to receive(:new).and_return(deployment)
+    subject.settings = {deploy: {write_lock: "Disabled, yo"}}
+  end
+
+  it "exits without running when the write lock is set" do
+    expect(subject).to_not receive(:visit_deployment)
+    expect {
+      subject.call
+    }.to exit_with(16)
+  end
+end