r10k 3.5.1 → 3.9.0

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

@@ -18,7 +18,8 @@ module R10K
         def initialize(opts, argv, settings = nil)
           settings ||= {}
           @purge_levels = settings.fetch(:deploy, {}).fetch(:purge_levels, [])
-          @user_purge_whitelist = settings.fetch(:deploy, {}).fetch(:purge_whitelist, [])
+          @user_purge_allowlist = read_purge_allowlist(settings.fetch(:deploy, {}).fetch(:purge_whitelist, []),
+                                                       settings.fetch(:deploy, {}).fetch(:purge_allowlist, []))
           @generate_types = settings.fetch(:deploy, {}).fetch(:generate_types, false)
 
           super
@@ -43,6 +44,23 @@ module R10K
 
         private
 
+        def read_purge_allowlist (whitelist, allowlist)
+          whitelist_has_content = !whitelist.empty?
+          allowlist_has_content = !allowlist.empty?
+          case
+          when whitelist_has_content == false && allowlist_has_content == false
+            []
+          when whitelist_has_content && allowlist_has_content
+            raise R10K::Error.new "Values found for both purge_whitelist and purge_allowlist. Setting " <<
+                                  "purge_whitelist is deprecated, please only use purge_allowlist."
+          when allowlist_has_content
+            allowlist
+          else
+            logger.warn "Setting purge_whitelist is deprecated; please use purge_allowlist instead."
+            whitelist
+          end
+        end
+
         def visit_deployment(deployment)
           # Ensure that everything can be preloaded. If we cannot preload all
           # sources then we can't fully enumerate all environments which
@@ -95,7 +113,7 @@ module R10K
           environment.sync
           logger.info _("Environment %{env_dir} is now at %{env_signature}") % {env_dir: environment.dirname, env_signature: environment.signature}
 
-          if status == :absent || @puppetfile
+          if status == :absent || @modules
             if status == :absent
               logger.debug(_("Environment %{env_dir} is new, updating all modules") % {env_dir: environment.dirname})
             end
@@ -110,7 +128,7 @@ module R10K
           if @purge_levels.include?(:environment)
             if @visit_ok
               logger.debug("Purging unmanaged content for environment '#{environment.dirname}'...")
-              environment.purge!(:recurse => true, :whitelist => environment.whitelist(@user_purge_whitelist))
+              environment.purge!(:recurse => true, :whitelist => environment.whitelist(@user_purge_allowlist))
             else
               logger.debug("Not purging unmanaged content for environment '#{environment.dirname}' due to prior deploy failures.")
             end
@@ -145,17 +163,20 @@ module R10K
         end
 
         def write_environment_info!(environment, started_at, success)
-          module_deploys = []
-          begin
-            environment.modules.each do |mod|
-              name = mod.name
-              version = mod.version
-              sha = mod.repo.head rescue nil
-              module_deploys.push({:name => name, :version => version, :sha => sha})
+          module_deploys =
+            begin
+              environment.modules.map do |mod|
+                props = mod.properties
+                {
+                  name: mod.name,
+                  version: props[:expected],
+                  sha: props[:type] == :git ? props[:actual] : nil
+                }
+              end
+            rescue
+              logger.debug("Unable to get environment module deploy data for .r10k-deploy.json at #{environment.path}")
+              []
             end
-          rescue
-            logger.debug("Unable to get environment module deploy data for .r10k-deploy.json at #{environment.path}")
-          end
 
           # make this file write as atomic as possible in pure ruby
           final   = "#{environment.path}/.r10k-deploy.json"
@@ -183,11 +204,15 @@ module R10K
         end
 
         def allowed_initialize_opts
-          super.merge(puppetfile: :self,
+          super.merge(puppetfile: :modules,
+                      modules: :self,
                       cachedir: :self,
                       'no-force': :self,
                       'generate-types': :self,
                       'puppet-path': :self,
+                      'puppet-conf': :self,
+                      'private-key': :self,
+                      'oauth-token': :self,
                       'default-branch-override': :self)
         end
       end

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

@@ -76,7 +76,10 @@ module R10K
                       cachedir: :self,
                       'no-force': :self,
                       'generate-types': :self,
-                      'puppet-path': :self)
+                      'puppet-path': :self,
+                      'puppet-conf': :self,
+                      'private-key': :self,
+                      'oauth-token': :self)
         end
       end
     end

data/lib/r10k/action/runner.rb

@@ -46,6 +46,7 @@ module R10K
         overrides[:cachedir] = @opts[:cachedir] if @opts.key?(:cachedir)
         overrides[:deploy] = {} if @opts.key?(:'puppet-path') || @opts.key?(:'generate-types')
         overrides[:deploy][:puppet_path] = @opts[:'puppet-path'] if @opts.key?(:'puppet-path')
+        overrides[:deploy][:puppet_conf] = @opts[:'puppet-conf'] unless @opts[:'puppet-conf'].nil?
         overrides[:deploy][:generate_types] = @opts[:'generate-types'] if @opts.key?(:'generate-types')
 
         with_overrides = config_settings.merge(overrides) do |key, oldval, newval|
@@ -54,6 +55,10 @@ module R10K
           newval
         end
 
+        # Credentials from the CLI override both the global and per-repo
+        # credentials from the config, and so need to be handled specially
+        with_overrides = add_credential_overrides(with_overrides)
+
         @settings = R10K::Settings.global_settings.evaluate(with_overrides)
 
         R10K::Initializers::GlobalInitializer.new(@settings).call
@@ -91,6 +96,35 @@ module R10K
 
         results
       end
+
+      def add_credential_overrides(overrides)
+        sshkey_path = @opts[:'private-key']
+        token_path = @opts[:'oauth-token']
+
+        if sshkey_path && token_path
+          raise R10K::Error, "Cannot specify both an SSH key and a token to use with this deploy."
+        end
+
+        if sshkey_path
+          overrides[:git] ||= {}
+          overrides[:git][:private_key] = sshkey_path
+          if repo_settings = overrides[:git][:repositories]
+            repo_settings.each do |repo|
+              repo[:private_key] = sshkey_path
+            end
+          end
+        elsif token_path
+          overrides[:git] ||= {}
+          overrides[:git][:oauth_token] = token_path
+          if repo_settings = overrides[:git][:repositories]
+            repo_settings.each do |repo|
+              repo[:oauth_token] = token_path
+            end
+          end
+        end
+
+        overrides
+      end
     end
   end
 end

data/lib/r10k/cli/deploy.rb

@@ -21,7 +21,7 @@ module R10K::CLI
 (https://puppet.com/docs/puppet/latest/environments_about.html).
         DESCRIPTION
 
-        required nil, :cachedir, 'Specify a cachedir, overriding the value in config'
+        option nil, :cachedir, 'Specify a cachedir, overriding the value in config', argument: :required
         flag nil, :'no-force', 'Prevent the overwriting of local module modifications'
         flag nil, :'generate-types', 'Run `puppet generate types` after updating an environment'
         option nil, :'puppet-path', 'Path to puppet executable', argument: :required do |value, cmd|
@@ -31,6 +31,9 @@ module R10K::CLI
             exit 1
           end
         end
+        option nil, :'puppet-conf', 'Path to puppet.conf', argument: :required
+        option nil, :'private-key', 'Path to SSH key to use when cloning. Only valid with rugged provider', argument: :required
+        option nil, :'oauth-token', 'Path to OAuth token to use when cloning. Only valid with rugged provider', argument: :required
 
         run do |opts, args, cmd|
           puts cmd.help(:verbose => opts[:verbose])
@@ -52,7 +55,7 @@ branches.
 
 Environments can provide a Puppetfile at the root of the directory to deploy
 independent Puppet modules. To recursively deploy an environment, pass the
-`--puppetfile` flag to the command.
+`--modules` flag to the command.
 
 **NOTE**: If an environment has a Puppetfile when it is instantiated a
 recursive update will be forced. It is assumed that environments are dependent
@@ -60,8 +63,10 @@ on modules specified in the Puppetfile and an update will be automatically
 scheduled. On subsequent deployments, Puppetfile deployment will default to off.
           DESCRIPTION
 
-          flag :p, :puppetfile, 'Deploy modules from a puppetfile'
-          required nil, :'default-branch-override', 'Specify a branchname to override the default branch in the puppetfile'
+          flag :p, :puppetfile, 'Deploy modules (deprecated, use -m)'
+          flag :m, :modules, 'Deploy modules'
+          option nil, :'default-branch-override', 'Specify a branchname to override the default branch in the puppetfile',
+                 argument: :required
 
           runner R10K::Action::CriRunner.wrap(R10K::Action::Deploy::Environment)
         end
@@ -81,7 +86,7 @@ It will load the Puppetfile configurations out of all environments, and will
 try to deploy the given module names in all environments.
           DESCRIPTION
 
-          required :e, :environment, 'Update the modules in the given environment'
+          option :e, :environment, 'Update the modules in the given environment', argument: :required
 
           runner R10K::Action::CriRunner.wrap(R10K::Action::Deploy::Module)
         end
@@ -96,10 +101,12 @@ try to deploy the given module names in all environments.
           usage 'display'
           summary 'Display environments and modules in the deployment'
 
-          flag :p, :puppetfile, 'Display Puppetfile modules'
+          flag :p, :puppetfile, 'Display modules (deprecated, use -m)'
+          flag :m, :modules, 'Display 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'
+          option nil, :format, 'Display output in a specific format. Valid values: json, yaml. Default: yaml',
+                 argument: :required
 
           runner R10K::Action::CriRunner.wrap(R10K::Action::Deploy::Display)
         end

data/lib/r10k/cli/puppetfile.rb

@@ -30,8 +30,8 @@ Puppetfile (http://bombasticmonkey.com/librarian-puppet/).
           name    'install'
           usage   'install'
           summary 'Install all modules from a Puppetfile'
-          required nil, :moduledir, 'Path to install modules to'
-          required nil, :puppetfile, 'Path to puppetfile'
+          option nil, :moduledir, 'Path to install modules to', argument: :required
+          option nil, :puppetfile, 'Path to puppetfile', argument: :required
           flag     nil, :force, 'Force locally changed files to be overwritten'
           runner R10K::Action::Puppetfile::CriRunner.wrap(R10K::Action::Puppetfile::Install)
         end
@@ -45,7 +45,7 @@ Puppetfile (http://bombasticmonkey.com/librarian-puppet/).
           usage 'check'
           summary 'Try and load the Puppetfile to verify the syntax is correct.'
 
-          required nil, :puppetfile, 'Path to Puppetfile'
+          option nil, :puppetfile, 'Path to Puppetfile', argument: :required
           runner R10K::Action::Puppetfile::CriRunner.wrap(R10K::Action::Puppetfile::Check)
         end
       end
@@ -58,8 +58,8 @@ Puppetfile (http://bombasticmonkey.com/librarian-puppet/).
           usage 'purge'
           summary 'Purge unmanaged modules from a Puppetfile managed directory'
 
-          required nil, :moduledir, 'Path to install modules to'
-          required nil, :puppetfile, 'Path to Puppetfile'
+          option nil, :moduledir, 'Path to install modules to', argument: :required
+          option nil, :puppetfile, 'Path to Puppetfile', argument: :required
           runner R10K::Action::Puppetfile::CriRunner.wrap(R10K::Action::Puppetfile::Purge)
         end
       end

data/lib/r10k/environment/base.rb

@@ -43,7 +43,7 @@ class R10K::Environment::Base
     @basedir = basedir
     @dirname = dirname
     @options = options
-    @puppetfile_name = options[:puppetfile_name]
+    @puppetfile_name = options.delete(:puppetfile_name)
 
     @full_path = File.join(@basedir, @dirname)
     @path = Pathname.new(File.join(@basedir, @dirname))
@@ -103,6 +103,13 @@ class R10K::Environment::Base
     @puppetfile.modules
   end
 
+  # @return [Array<R10K::Module::Base>] Whether or not the given module
+  #   conflicts with any modules already defined in the r10k environment
+  #   object.
+  def module_conflicts?(mod)
+    false
+  end
+
   def accept(visitor)
     visitor.visit(:environment, self) do
       puppetfile.accept(visitor)
@@ -137,7 +144,7 @@ class R10K::Environment::Base
   end
 
   def generate_types!
-    argv = [R10K::Settings.puppet_path, 'generate', 'types', '--environment', dirname, '--environmentpath', basedir]
+    argv = [R10K::Settings.puppet_path, 'generate', 'types', '--environment', dirname, '--environmentpath', basedir, '--config', R10K::Settings.puppet_conf]
     subproc = R10K::Util::Subprocess.new(argv)
     subproc.raise_on_fail = true
     subproc.logger = logger

data/lib/r10k/environment/git.rb

@@ -27,6 +27,8 @@ class R10K::Environment::Git < R10K::Environment::WithModules
   #   @return [R10K::Git::StatefulRepository] The git repo backing this environment
   attr_reader :repo
 
+  include R10K::Util::Setopts
+
   # Initialize the given Git environment.
   #
   # @param name [String] The unique name describing this environment.
@@ -38,8 +40,21 @@ class R10K::Environment::Git < R10K::Environment::WithModules
   # @param options [String] :ref The git reference to use for this environment
   def initialize(name, basedir, dirname, options = {})
     super
-    @remote = options[:remote]
-    @ref    = options[:ref]
+    setopts(options, {
+      # Standard option interface
+      :version => :ref,
+      :source  => :remote,
+      :type    => ::R10K::Util::Setopts::Ignore,
+
+      # Type-specific options
+      :ref     => :self,
+      :remote  => :self,
+
+    }, raise_on_unhandled: false)
+    # TODO: in r10k 4.0.0, a major version bump, stop allowing garbage options.
+    # We only allow them now, here, on this object, because prior to adopting
+    # setopts in the constructor, this object type didn't do any validation
+    # checking of options passed, and would permit garbage parameters.
 
     @repo = R10K::Git::StatefulRepository.new(@remote, @basedir, @dirname)
   end

data/lib/r10k/environment/name.rb

@@ -12,13 +12,13 @@ module R10K
       INVALID_CHARACTERS = %r[\W]
 
       def initialize(name, opts)
-        @name   = name
-        @opts   = opts
-
         @source  = opts[:source]
         @prefix  = opts[:prefix]
         @invalid = opts[:invalid]
 
+        @name = derive_name(name, opts[:strip_component])
+        @opts = opts
+
         case @invalid
         when 'correct_and_warn'
           @validate = true
@@ -71,8 +71,26 @@ module R10K
 
       private
 
-      def derive_prefix(source,prefix)
+      def derive_name(name, strip_component)
+        return name unless strip_component
+
+        unless strip_component.is_a?(String)
+          raise _('Improper configuration value given for strip_component setting in %{src} source. ' \
+                  'Value must be a string, a /regex/, false, or omitted. Got "%{val}" (%{type})' \
+                  % {src: @source, val: strip_component, type: strip_component.class})
+        end
 
+        if %r{^/.*/$}.match(strip_component)
+          regex = Regexp.new(strip_component[1..-2])
+          name.gsub(regex, '')
+        elsif name.start_with?(strip_component)
+          name[strip_component.size..-1]
+        else
+          name
+        end
+      end
+
+      def derive_prefix(source,prefix)
         if prefix == true
           "#{source}_"
         elsif prefix.is_a? String

data/lib/r10k/environment/svn.rb

@@ -44,8 +44,17 @@ class R10K::Environment::SVN < R10K::Environment::Base
   # @option options [String] :password The SVN password
   def initialize(name, basedir, dirname, options = {})
     super
+    setopts(options, {
+      # Standard option interface
+      :source  => :remote,
+      :version => :expected_revision,
+      :type    => ::R10K::Util::Setopts::Ignore,
 
-    setopts(options, {:remote => :self, :username => :self, :password => :self, :puppetfile_name => :self })
+      # Type-specific options
+      :remote => :self,
+      :username => :self,
+      :password => :self,
+    })
 
     @working_dir = R10K::SVN::WorkingDir.new(Pathname.new(@full_path), :username => @username, :password => @password)
   end
@@ -61,7 +70,7 @@ class R10K::Environment::SVN < R10K::Environment::Base
     if @working_dir.is_svn?
       @working_dir.update
     else
-      @working_dir.checkout(@remote)
+      @working_dir.checkout(@remote, @expected_revision)
     end
     @synced = true
   end

data/lib/r10k/environment/with_modules.rb

@@ -24,7 +24,7 @@ class R10K::Environment::WithModules < R10K::Environment::Base
   # @param options [String] :moduledir The path to install modules to
   # @param options [Hash] :modules Modules to add to the environment
   def initialize(name, basedir, dirname, options = {})
-    super(name, basedir, dirname, options)
+    super
 
     @managed_content = {}
     @modules = []
@@ -46,10 +46,33 @@ class R10K::Environment::WithModules < R10K::Environment::Base
   #     - The r10k environment object
   #     - A Puppetfile in the environment's content
   def modules
-    return @modules if @puppetfile.nil?
+    return @modules if puppetfile.nil?
 
-    @puppetfile.load unless @puppetfile.loaded?
-    @modules + @puppetfile.modules
+    puppetfile.load unless puppetfile.loaded?
+    @modules + puppetfile.modules
+  end
+
+  def module_conflicts?(mod_b)
+    conflict = @modules.any? { |mod_a| mod_a.name == mod_b.name }
+    return false unless conflict
+
+    msg_vars = {src: mod_b.origin, name: mod_b.name}
+    msg_error = _('Environment and %{src} both define the "%{name}" module' % msg_vars)
+    msg_continue = _("#{msg_error}. The %{src} definition will be ignored" % msg_vars)
+
+    case conflict_opt = @options[:module_conflicts]
+    when 'override_and_warn', nil
+      logger.warn msg_continue
+    when 'override'
+      logger.debug msg_continue
+    when 'error'
+      raise R10K::Error, msg_error
+    else
+      raise R10K::Error, _('Unexpected value for `module_conflicts` setting in %{env} ' \
+                           'environment: %{val}' % {env: self.name, val: conflict_opt})
+    end
+
+    true
   end
 
   def accept(visitor)
@@ -59,7 +82,6 @@ class R10K::Environment::WithModules < R10K::Environment::Base
       end
 
       puppetfile.accept(visitor)
-      validate_no_module_conflicts
     end
   end
 
@@ -88,26 +110,12 @@ class R10K::Environment::WithModules < R10K::Environment::Base
     @managed_content[install_path] = Array.new unless @managed_content.has_key?(install_path)
 
     mod = R10K::Module.new(name, install_path, args, self.name)
-    mod.origin = 'Environment'
+    mod.origin = :environment
 
     @managed_content[install_path] << mod.name
     @modules << mod
   end
 
-  def validate_no_module_conflicts
-    @puppetfile.load unless @puppetfile.loaded?
-    conflicts = (@modules + @puppetfile.modules)
-                .group_by { |mod| mod.name }
-                .select { |_, v| v.size > 1 }
-                .map(&:first)
-    unless conflicts.empty?
-      msg = _('Puppetfile cannot contain module names defined by environment %{name}') % {name: self.name}
-      msg += ' '
-      msg += _("Remove the conflicting definitions of the following modules: %{conflicts}" % { conflicts: conflicts.join(' ') })
-      raise R10K::Error.new(msg)
-    end
-  end
-
   include R10K::Util::Purgeable
 
   # Returns an array of the full paths that can be purged.