r10k 2.0.3 → 2.1.0

data/lib/r10k/action/deploy/module.rb

@@ -1,31 +1,22 @@
-require 'r10k/util/setopts'
 require 'r10k/deployment'
 require 'r10k/action/visitor'
-require 'r10k/logging'
+require 'r10k/action/base'
+require 'r10k/action/deploy/deploy_helpers'
 
 module R10K
   module Action
     module Deploy
-      class Module
+      class Module < R10K::Action::Base
 
-        include R10K::Logging
-        include R10K::Util::Setopts
-
-        def initialize(opts, argv)
-          @opts = opts
-          @argv = argv
-          setopts(opts, {
-            :config      => :self,
-            :environment => nil,
-            :trace       => :self
-          })
-
-          @purge = true
-        end
+        include R10K::Action::Deploy::DeployHelpers
 
         def call
           @visit_ok = true
-          deployment = R10K::Deployment.load_config(@config)
+
+          expect_config!
+          deployment = R10K::Deployment.new(@settings)
+          check_write_lock!(@settings)
+
           deployment.accept(self)
           @visit_ok
         end
@@ -64,6 +55,10 @@ module R10K
             logger.debug1("Only updating modules #{@argv.inspect}, skipping module #{mod.name}")
           end
         end
+
+        def allowed_initialize_opts
+          super.merge(environment: true)
+        end
       end
     end
   end

data/lib/r10k/action/puppetfile/check.rb

@@ -1,30 +1,14 @@
 require 'r10k/puppetfile'
-require 'r10k/util/setopts'
+require 'r10k/action/base'
 require 'r10k/errors/formatting'
-require 'r10k/logging'
 
 module R10K
   module Action
     module Puppetfile
-      class Check
-        include R10K::Logging
-        include R10K::Util::Setopts
-
-        def initialize(opts, argv)
-          @opts = opts
-          @argv = argv
-
-          setopts(opts, {
-            :root       => :self,
-            :moduledir  => :self,
-            :puppetfile => :path,
-            :trace      => :self,
-          })
-        end
+      class Check < R10K::Action::Base
 
         def call
           pf = R10K::Puppetfile.new(@root, @moduledir, @path)
-
           begin
             pf.load!
             $stderr.puts "Syntax OK"
@@ -34,6 +18,12 @@ module R10K
             false
           end
         end
+
+        private
+
+        def allowed_initialize_opts
+          super.merge(root: :self, puppetfile: :self, moduledir: :self)
+        end
       end
     end
   end

data/lib/r10k/action/puppetfile/install.rb

@@ -1,41 +1,23 @@
 require 'r10k/puppetfile'
-require 'r10k/util/setopts'
 require 'r10k/errors/formatting'
-require 'r10k/logging'
+require 'r10k/action/visitor'
+require 'r10k/action/base'
 
 module R10K
   module Action
     module Puppetfile
-      class Install
-        include R10K::Logging
-        include R10K::Util::Setopts
-
-        def initialize(opts, argv)
-          @opts = opts
-          @argv = argv
-
-          @ok = true
-
-          setopts(opts, {
-            :root       => :self,
-            :moduledir  => :self,
-            :puppetfile => :path,
-            :trace      => :self,
-          })
-        end
+      class Install < R10K::Action::Base
 
         def call
-          pf = R10K::Puppetfile.new(@root, @moduledir, @path)
+          @visit_ok = true
+          pf = R10K::Puppetfile.new(@root, @moduledir, @puppetfile)
           pf.accept(self)
-          @ok
+          @visit_ok
         end
 
-        def visit(type, other, &block)
-          send("visit_#{type}", other, &block)
-        rescue => e
-          logger.error R10K::Errors::Formatting.format_exception(e, @trace)
-          @ok = false
-        end
+        private
+
+        include R10K::Action::Visitor
 
         def visit_puppetfile(pf)
           pf.load!
@@ -47,6 +29,10 @@ module R10K
           logger.info "Updating module #{mod.path}"
           mod.sync
         end
+
+        def allowed_initialize_opts
+          super.merge(root: :self, puppetfile: :self, moduledir: :self)
+        end
       end
     end
   end

data/lib/r10k/action/puppetfile/purge.rb

@@ -1,26 +1,11 @@
 require 'r10k/puppetfile'
-require 'r10k/util/setopts'
+require 'r10k/action/base'
 require 'r10k/errors/formatting'
-require 'r10k/logging'
 
 module R10K
   module Action
     module Puppetfile
-      class Purge
-        include R10K::Logging
-        include R10K::Util::Setopts
-
-        def initialize(opts, argv)
-          @opts = opts
-          @argv = argv
-
-          setopts(opts, {
-            :root       => :self,
-            :moduledir  => :self,
-            :puppetfile => :path,
-            :trace      => :self,
-          })
-        end
+      class Purge < R10K::Action::Base
 
         def call
           pf = R10K::Puppetfile.new(@root, @moduledir, @path)
@@ -31,6 +16,12 @@ module R10K
           logger.error R10K::Errors::Formatting.format_exception(e, @trace)
           false
         end
+
+        private
+
+        def allowed_initialize_opts
+          super.merge(root: :self, puppetfile: :self, moduledir: :self)
+        end
       end
     end
   end

data/lib/r10k/action/runner.rb

@@ -1,7 +1,7 @@
 require 'r10k/logging'
 require 'r10k/errors'
 require 'r10k/util/license'
-require 'shared/puppet_forge/connection'
+require 'puppet_forge/connection'
 
 module R10K
   module Action
@@ -12,13 +12,15 @@ module R10K
         @opts = opts
         @argv = argv
         @klass = klass
+
+        @settings = {}
       end
 
       def instance
         if @_instance.nil?
           iopts = @opts.dup
           iopts.delete(:loglevel)
-          @_instance = @klass.new(iopts, @argv)
+          @_instance = @klass.new(iopts, @argv, @settings)
         end
         @_instance
       end
@@ -27,6 +29,7 @@ module R10K
         setup_logging
         setup_settings
         # @todo check arguments
+        setup_authorization
         instance.call
       end
 
@@ -37,7 +40,22 @@ module R10K
       end
 
       def setup_settings
-        setup_authorization
+        config_settings = settings_from_config(@opts[:config])
+
+        overrides = {:cachedir => @opts[:cachedir]}
+        overrides.delete_if { |_, val| val.nil? }
+
+        with_overrides = config_settings.merge(overrides) do |key, oldval, newval|
+          logger.debug2 "Overriding config file setting '#{key}': '#{oldval}' -> '#{newval}'"
+          newval
+        end
+
+        @settings = R10K::Settings.global_settings.evaluate(with_overrides)
+
+        R10K::Initializers::GlobalInitializer.new(@settings).call
+      rescue R10K::Settings::Collection::ValidationError => e
+        logger.error e.format
+        exit(8)
       end
 
       def setup_authorization
@@ -51,6 +69,24 @@ module R10K
           logger.warn e.message
         end
       end
+
+      private
+
+      def settings_from_config(override_path)
+        loader = R10K::Settings::Loader.new
+        path = loader.search(override_path)
+        results = {}
+
+        if path
+          @opts[:config] = path
+          logger.debug2 "Reading configuration from #{path.inspect}"
+          results = loader.read(path)
+        else
+          logger.debug2 "No config file explicitly given and no default config file could be found, default settings will be used."
+        end
+
+        results
+      end
     end
   end
 end

data/lib/r10k/cli.rb

@@ -35,9 +35,7 @@ module R10K::CLI
 
       flag nil, :color, 'Enable colored log messages'
 
-      required :c, :config, 'Specify a global configuration file (deprecated, use `r10k deploy -c`)' do |value, cmd|
-        logger.warn "Calling `r10k --config <action>` as a global option is deprecated; use r10k <action> --config"
-      end
+      required :c, :config, 'Specify a global configuration file'
 
       run do |opts, args, cmd|
         puts cmd.help(:verbose => opts[:verbose])

data/lib/r10k/cli/deploy.rb

@@ -21,7 +21,7 @@ module R10K::CLI
 (https://puppetlabs.com/blog/git-workflow-and-puppet-environments/).
         DESCRIPTION
 
-        required :c, :config, 'Specify a configuration file'
+        required nil, :cachedir, 'Specify a cachedir, overriding the value in config'
 
         run do |opts, args, cmd|
           puts cmd.help(:verbose => opts[:verbose])
@@ -88,6 +88,8 @@ try to deploy the given module names in all environments.
 
           flag :p, :puppetfile, 'Display Puppetfile modules'
           flag nil, :detail, 'Display detailed information'
+          flag nil, :fetch, 'Update available environment lists from all remote sources'
+          required nil, :format, 'Display output in a specific format. Valid values: json, yaml. Default: yaml'
 
           runner R10K::Action::CriRunner.wrap(R10K::Action::Deploy::Display)
         end

data/lib/r10k/cli/puppetfile.rb

@@ -31,8 +31,8 @@ Puppetfile (http://bombasticmonkey.com/librarian-puppet/).
           usage   'install'
           summary 'Install all modules from a Puppetfile'
 
-          # @todo add --moduledir option
-          # @todo add --puppetfile option
+          required nil, :moduledir, 'Path to install modules to'
+          required nil, :puppetfile, 'Path to puppetfile'
           # @todo add --no-purge option
           runner R10K::Action::Puppetfile::CriRunner.wrap(R10K::Action::Puppetfile::Install)
         end

data/lib/r10k/deployment.rb

@@ -15,10 +15,12 @@ module R10K
 
     # Generate a deployment object based on a config
     #
+    # @deprecated
+    #
     # @param path [String] The path to the deployment config
     # @return [R10K::Deployment] The deployment loaded with the given config
-    def self.load_config(path)
-      config = R10K::Deployment::Config.new(path)
+    def self.load_config(path, overrides={})
+      config = R10K::Deployment::Config.new(path, overrides)
       new(config)
     end
 
@@ -98,8 +100,8 @@ module R10K
 
     def accept(visitor)
       visitor.visit(:deployment, self) do
-        sources.each do |env|
-          env.accept(visitor)
+        sources.each do |source|
+          source.accept(visitor)
         end
       end
     end
@@ -107,9 +109,9 @@ module R10K
     private
 
     def load_sources
-      sources = @config.setting(:sources)
+      sources = @config[:sources]
       if sources.nil? || sources.empty?
-        raise R10K::Error, "'sources' key in #{@config.configfile} missing or empty."
+        raise R10K::Error, "Unable to load sources; the supplied configuration does not define the 'sources' key"
       end
       @_sources = sources.map do |(name, hash)|
         R10K::Source.from_hash(name, hash)

data/lib/r10k/deployment/config.rb

@@ -1,7 +1,8 @@
 require 'r10k/deployment'
-require 'r10k/deployment/config/loader'
+require 'r10k/settings/loader'
 require 'r10k/util/symbolize_keys'
 require 'r10k/errors'
+require 'r10k/initializers'
 require 'yaml'
 
 module R10K
@@ -12,88 +13,40 @@ class Config
 
   attr_accessor :configfile
 
-  def initialize(configfile)
+  def initialize(configfile, overrides={})
     @configfile = configfile
+    @overrides = overrides
 
     load_config
   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
+    @config[key]
+  end
 
-    # Scan all possible keys to see if the config has a matching value
-    keys.inject(nil) do |rv, k|
-      v = @config[k]
-      break v unless v.nil?
-    end
+  alias [] setting
+
+  def settings
+    @config
   end
 
   # Load and store a config file, and set relevant options
   #
   # @param [String] configfile The path to the YAML config file
   def load_config
-    if @configfile.nil?
-      loader = R10K::Deployment::Config::Loader.new
-      @configfile = loader.search
-      if @configfile.nil?
-        raise ConfigError, "No configuration file given, no config file found in current directory, and no global config present"
-      end
-    end
-    begin
-      @config = ::YAML.load_file(@configfile)
-      apply_config_settings
-    rescue => e
-      raise ConfigError, "Couldn't load config file: #{e.message}"
-    end
-  end
-
-  private
+    loader = R10K::Settings::Loader.new
+    hash = loader.read(@configfile)
 
-  def with_setting(key, &block)
-    value = setting(key)
-    block.call(value) unless value.nil?
-  end
-
-  # Apply global configuration settings.
-  def apply_config_settings
-    with_setting(:purgedirs) do |purgedirs|
-      logger.warn("The purgedirs key in r10k.yaml is deprecated. It is currently ignored.")
-    end
-
-    with_setting(:cachedir) do |cachedir|
-      R10K::Git::Cache.settings[:cache_root] = cachedir
+    with_overrides = hash.merge(@overrides) do |key, oldval, newval|
+      logger.debug2 "Overriding config file setting '#{key}': '#{oldval}' -> '#{newval}'"
+      newval
     end
 
-    with_setting(:forge) do |forge_settings|
-      R10K::Util::SymbolizeKeys.symbolize_keys!(forge_settings)
-      proxy = forge_settings[:proxy]
-      if proxy
-        R10K::Forge::ModuleRelease.settings[:proxy] = proxy
-      end
-    end
-
-    with_setting(:git) do |git_settings|
-      R10K::Util::SymbolizeKeys.symbolize_keys!(git_settings)
-      provider = git_settings[:provider]
-      if provider
-        R10K::Git.provider = provider.to_sym
-      end
+    @config = R10K::Settings.global_settings.evaluate(with_overrides)
 
-      if git_settings[:private_key]
-        R10K::Git.settings[:private_key] = git_settings[:private_key]
-      end
-
-      if git_settings[:username]
-        R10K::Git.settings[:username] = git_settings[:username]
-      end
-    end
+    initializer = R10K::Initializers::GlobalInitializer.new(@config)
+    initializer.call
   end
 
   class ConfigError < R10K::Error