r10k 3.5.1 → 3.9.0

data/lib/r10k/settings.rb

@@ -12,6 +12,8 @@ module R10K
     class << self
       # Path to puppet executable
       attr_accessor :puppet_path
+      # Path to puppet.conf
+      attr_accessor :puppet_conf
     end
 
     def self.git_settings
@@ -35,6 +37,11 @@ module R10K
                     Only used by the 'rugged' Git provider.",
         }),
 
+        Definition.new(:oauth_token, {
+          :desc => "The path to a token file for Git OAuth remotes.
+                    Only used by the 'rugged' Git provider."
+        }),
+
         URIDefinition.new(:proxy, {
           :desc => "An optional proxy server to use when interacting with Git sources via HTTP(S).",
           :default => :inherit,
@@ -52,11 +59,17 @@ module R10K
               :default => :inherit,
             }),
 
+            Definition.new(:oauth_token, {
+              :desc => "The path to a token file for Git OAuth remotes.
+                        Only used by the 'rugged' Git provider.",
+              :default => :inherit
+            }),
+
             URIDefinition.new(:proxy, {
               :desc => "An optional proxy server to use when interacting with Git sources via HTTP(S).",
               :default => :inherit,
             }),
-            
+
             Definition.new(:ignore_branch_prefixes, {
               :desc => "Array of strings used to prefix branch names that will not be deployed as environments.",
             }),
@@ -109,11 +122,16 @@ module R10K
           end,
         }),
 
-        Definition.new(:purge_whitelist, {
+        Definition.new(:purge_allowlist, {
           :desc => "A list of filename patterns to be excluded from any purge operations. Patterns are matched relative to the root of each deployed environment, if you want a pattern to match recursively you need to use the '**' glob in your pattern. Basic shell style globs are supported.",
           :default => [],
         }),
 
+        Definition.new(:purge_whitelist, {
+          :desc => "Deprecated; please use purge_allowlist instead. This setting will be removed in a future version.",
+          :default => [],
+        }),
+
         Definition.new(:generate_types, {
           :desc => "Controls whether to generate puppet types after deploying an environment. Defaults to false.",
           :default => false,
@@ -131,6 +149,15 @@ module R10K
             end
           end
         }),
+        Definition.new(:puppet_conf, {
+          :desc => "Path to puppet.conf. Defaults to /etc/puppetlabs/puppet/puppet.conf.",
+          :default => '/etc/puppetlabs/puppet/puppet.conf',
+          :validate => lambda do |value|
+            unless File.readable? value
+              raise ArgumentError, "The specified puppet.conf #{value} is not readable"
+            end
+          end
+        }),
       ])
     end
 
@@ -160,7 +187,7 @@ module R10K
 
         Definition.new(:pool_size, {
           :desc => "The amount of threads used to concurrently install modules. The default value is 1: install one module at a time.",
-          :default => 1,
+          :default => 4,
           :validate => lambda do |value|
             if !value.is_a?(Integer)
               raise ArgumentError, "The pool_size setting should be an integer, not a #{value.class}"

data/lib/r10k/source/base.rb

@@ -31,10 +31,15 @@ class R10K::Source::Base
   # @option options [Boolean, String] :prefix If a String this becomes the prefix.
   #   If true, will use the source name as the prefix. All sources should respect this option.
   #   Defaults to false for no environment prefix.
+  # @option options [String] :strip_component If a string, this value will be
+  #   removed from the beginning of each generated environment's name, if
+  #   present. If the string is contained within two "/" characters, it will
+  #   be treated as a regular expression.
   def initialize(name, basedir, options = {})
     @name    = name
     @basedir = Pathname.new(basedir).cleanpath.to_s
     @prefix  = options.delete(:prefix)
+    @strip_component = options.delete(:strip_component)
     @puppetfile_name = options.delete(:puppetfile_name)
     @options = options
   end

data/lib/r10k/source/git.rb

@@ -41,6 +41,10 @@ class R10K::Source::Git < R10K::Source::Base
   #     that will be deployed as environments.
   attr_reader :ignore_branch_prefixes
 
+  # @!attribute [r] filter_command
+  #   @return [String] Command to run to filter branches
+  attr_reader :filter_command
+
   # Initialize the given source.
   #
   # @param name [String] The identifier for this source.
@@ -61,6 +65,7 @@ class R10K::Source::Git < R10K::Source::Base
     @remote = options[:remote]
     @invalid_branches = (options[:invalid_branches] || 'correct_and_warn')
     @ignore_branch_prefixes = options[:ignore_branch_prefixes]
+    @filter_command = options[:filter_command]
 
     @cache  = R10K::Git.cache.generate(@remote)
   end
@@ -115,7 +120,7 @@ class R10K::Source::Git < R10K::Source::Base
     environments.map {|env| env.dirname }
   end
 
-  def filter_branches(branches, ignore_prefixes)
+  def filter_branches_by_regexp(branches, ignore_prefixes)
     filter = Regexp.new("^#{Regexp.union(ignore_prefixes)}")
     branches = branches.reject do |branch|
       result = filter.match(branch)
@@ -127,14 +132,32 @@ class R10K::Source::Git < R10K::Source::Base
     branches
   end
 
+  def filter_branches_by_command(branches, command)
+    branches.select do |branch|
+      result = system({'GIT_DIR' => @cache.git_dir.to_s, 'R10K_BRANCH' => branch, 'R10K_NAME' => @name.to_s}, command)
+      unless result
+        logger.warn _("Branch `%{name}:%{branch}` filtered out by filter_command %{cmd}") % {name: @name, branch: branch, cmd: command}
+      end
+      result
+    end
+  end
+
   private
 
   def branch_names
-    opts = {:prefix => @prefix, :invalid => @invalid_branches, :source => @name}
+    opts = {prefix: @prefix,
+            invalid: @invalid_branches,
+            source: @name,
+            strip_component: @strip_component}
     branches = @cache.branches
     if @ignore_branch_prefixes && !@ignore_branch_prefixes.empty?
-      branches = filter_branches(branches, @ignore_branch_prefixes)
+      branches = filter_branches_by_regexp(branches, @ignore_branch_prefixes)
+    end
+
+    if @filter_command && !@filter_command.empty?
+      branches = filter_branches_by_command(branches, @filter_command)
     end
+
     branches.map do |branch|
       R10K::Environment::Name.new(branch, opts)
     end

data/lib/r10k/source/hash.rb

@@ -152,8 +152,10 @@ class R10K::Source::Hash < R10K::Source::Base
       R10K::Util::SymbolizeKeys.symbolize_keys!(opts)
       memo.merge({ 
         name => opts.merge({
-          :basedir => @basedir,
-          :dirname => R10K::Environment::Name.new(name, {prefix: @prefix, source: @name}).dirname
+          basedir: @basedir,
+          dirname: R10K::Environment::Name.new(name, {prefix: @prefix,
+                                                      source: @name,
+                                                      strip_component: @strip_component}).dirname
         })
       })
     end

data/lib/r10k/source/svn.rb

@@ -121,7 +121,11 @@ class R10K::Source::SVN < R10K::Source::Base
 
   def names_and_paths
     branches = []
-    opts = {:prefix => @prefix, :correct => false, :validate => false, :source => @name}
+    opts = {prefix: @prefix,
+            correct: false,
+            validate: false,
+            source: @name,
+            strip_component: @strip_component}
     branches << [R10K::Environment::Name.new('production', opts), "#{@remote}/trunk"]
     additional_branch_names = @svn_remote.branches
     if @ignore_branch_prefixes && !@ignore_branch_prefixes.empty?

data/lib/r10k/util/setopts.rb

@@ -7,6 +7,10 @@ module R10K
     # supports Ruby 1.8.7+ we cannot use that functionality.
     module Setopts
 
+      class Ignore; end
+
+      include R10K::Logging
+
       private
 
       # @param opts [Hash]
@@ -31,22 +35,39 @@ module R10K
       #   setopts(opts, allowed)
       #   @trace # => nil
       #
-      def setopts(opts, allowed)
+      def setopts(opts, allowed, raise_on_unhandled: true)
+        processed_vars = {}
         opts.each_pair do |key, value|
           if allowed.key?(key)
-            rhs = allowed[key]
-            case rhs
-            when NilClass, FalseClass
-              # Ignore nil options
-            when :self, TrueClass
-              # tr here is because instance variables cannot have hyphens in their names.
-              instance_variable_set("@#{key}".tr('-','_').to_sym, value)
-            else
-              # tr here same as previous
-              instance_variable_set("@#{rhs}".tr('-','_').to_sym, value)
+            # Ignore nil options and explicit ignore param
+            next unless rhs = allowed[key]
+            next if rhs == ::R10K::Util::Setopts::Ignore
+
+            var = case rhs
+                  when :self, TrueClass
+                    # tr here is because instance variables cannot have hyphens in their names.
+                    "@#{key}".tr('-','_').to_sym
+                  else
+                    # tr here same as previous
+                    "@#{rhs}".tr('-','_').to_sym
+                  end
+
+            if processed_vars.include?(var)
+              # This should be a raise, but that would be a behavior change and
+              # should happen on a SemVer boundry.
+              logger.warn _("%{class_name} parameters '%{a}' and '%{b}' conflict. Specify one or the other, but not both" \
+                            % {class_name: self.class.name, a: processed_vars[var], b: key})
             end
+
+            instance_variable_set(var, value)
+            processed_vars[var] = key
           else
-            raise ArgumentError, _("%{class_name} cannot handle option '%{key}'") % {class_name: self.class.name, key: key}
+            err_str = _("%{class_name} cannot handle option '%{key}'") % {class_name: self.class.name, key: key}
+            if raise_on_unhandled
+              raise ArgumentError, err_str
+            else
+              logger.warn(err_str)
+            end
           end
         end
       end

data/lib/r10k/version.rb

@@ -2,5 +2,5 @@ module R10K
   # When updating to a new major (X) or minor (Y) version, include `#major` or
   # `#minor` (respectively) in your commit message to trigger the appropriate
   # release. Otherwise, a new patch (Z) version will be released.
-  VERSION = '3.5.1'
+  VERSION = '3.9.0'
 end

data/locales/r10k.pot

@@ -1,16 +1,16 @@
 # SOME DESCRIPTIVE TITLE.
-# Copyright (C) 2020 Puppet, Inc.
+# Copyright (C) 2021 Puppet, Inc.
 # This file is distributed under the same license as the r10k package.
-# FIRST AUTHOR <EMAIL@ADDRESS>, 2020.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2021.
 #
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: r10k 3.4.1-20-g8fe925b\n"
+"Project-Id-Version: r10k 3.4.1-151-g93d38cb\n"
 "\n"
 "Report-Msgid-Bugs-To: docs@puppetlabs.com\n"
-"POT-Creation-Date: 2020-04-28 18:41+0000\n"
-"PO-Revision-Date: 2020-04-28 18:41+0000\n"
+"POT-Creation-Date: 2021-03-15 17:00+0000\n"
+"PO-Revision-Date: 2021-03-15 17:00+0000\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
 "Language: \n"
@@ -83,15 +83,15 @@ msgstr ""
 msgid "Cannot track control repo branch for content '%{name}' when not part of a 'deploy' action, will use default if available."
 msgstr ""
 
-#: ../lib/r10k/action/runner.rb:53 ../lib/r10k/deployment/config.rb:42
+#: ../lib/r10k/action/runner.rb:54 ../lib/r10k/deployment/config.rb:42
 msgid "Overriding config file setting '%{key}': '%{old_val}' -> '%{new_val}'"
 msgstr ""
 
-#: ../lib/r10k/action/runner.rb:86
+#: ../lib/r10k/action/runner.rb:91
 msgid "Reading configuration from %{config_path}"
 msgstr ""
 
-#: ../lib/r10k/action/runner.rb:89
+#: ../lib/r10k/action/runner.rb:94
 msgid "No config file explicitly given and no default config file could be found, default settings will be used."
 msgstr ""
 
@@ -103,16 +103,24 @@ msgstr ""
 msgid "Unable to load sources; the supplied configuration does not define the 'sources' key"
 msgstr ""
 
-#: ../lib/r10k/environment/base.rb:61 ../lib/r10k/environment/base.rb:77 ../lib/r10k/environment/base.rb:86 ../lib/r10k/source/base.rb:64
+#: ../lib/r10k/environment/base.rb:61 ../lib/r10k/environment/base.rb:77 ../lib/r10k/environment/base.rb:86 ../lib/r10k/source/base.rb:69
 msgid "%{class} has not implemented method %{method}"
 msgstr ""
 
-#: ../lib/r10k/environment/with_modules.rb:104
-msgid "Puppetfile cannot contain module names defined by environment %{name}"
+#: ../lib/r10k/environment/name.rb:78
+msgid "Improper configuration value given for strip_component setting in %{src} source. Value must be a string, a /regex/, false, or omitted. Got \"%{val}\" (%{type})"
 msgstr ""
 
-#: ../lib/r10k/environment/with_modules.rb:106
-msgid "Remove the conflicting definitions of the following modules: %{conflicts}"
+#: ../lib/r10k/environment/with_modules.rb:60
+msgid "Environment and %{src} both define the \"%{name}\" module"
+msgstr ""
+
+#: ../lib/r10k/environment/with_modules.rb:61
+msgid "#{msg_error}. The %{src} definition will be ignored"
+msgstr ""
+
+#: ../lib/r10k/environment/with_modules.rb:71
+msgid "Unexpected value for `module_conflicts` setting in %{env} environment: %{val}"
 msgstr ""
 
 #: ../lib/r10k/feature.rb:27
@@ -187,11 +195,11 @@ msgstr ""
 msgid "Cannot write %{file}; parent directory does not exist"
 msgstr ""
 
-#: ../lib/r10k/git/cache.rb:55
+#: ../lib/r10k/git/cache.rb:65
 msgid "%{class}#path is deprecated; use #git_dir"
 msgstr ""
 
-#: ../lib/r10k/git/cache.rb:84
+#: ../lib/r10k/git/cache.rb:94
 msgid "Creating new git cache for %{remote}"
 msgstr ""
 
@@ -227,15 +235,31 @@ msgstr ""
 msgid "Unable to use SSH key auth for %{url}: private key %{private_key} is missing or unreadable"
 msgstr ""
 
-#: ../lib/r10k/git/rugged/credentials.rb:80
+#: ../lib/r10k/git/rugged/credentials.rb:84
+msgid "Using OAuth token from stdin for URL %{url}"
+msgstr ""
+
+#: ../lib/r10k/git/rugged/credentials.rb:87
+msgid "Using OAuth token from %{token_path} for URL %{url}"
+msgstr ""
+
+#: ../lib/r10k/git/rugged/credentials.rb:89
+msgid "%{path} is missing or unreadable, cannot load OAuth token"
+msgstr ""
+
+#: ../lib/r10k/git/rugged/credentials.rb:93
+msgid "Supplied OAuth token contains invalid characters."
+msgstr ""
+
+#: ../lib/r10k/git/rugged/credentials.rb:117
 msgid "URL %{url} includes the username %{username}, using that user for authentication."
 msgstr ""
 
-#: ../lib/r10k/git/rugged/credentials.rb:83
+#: ../lib/r10k/git/rugged/credentials.rb:120
 msgid "URL %{url} did not specify a user, using %{user} from configuration"
 msgstr ""
 
-#: ../lib/r10k/git/rugged/credentials.rb:86
+#: ../lib/r10k/git/rugged/credentials.rb:123
 msgid "URL %{url} did not specify a user, using current user %{user}"
 msgstr ""
 
@@ -255,31 +279,31 @@ msgstr ""
 msgid "Found local modifications in %{file_path}"
 msgstr ""
 
-#: ../lib/r10k/git/stateful_repository.rb:40
+#: ../lib/r10k/git/stateful_repository.rb:44
 msgid "Unable to sync repo to unresolvable ref '%{ref}'"
 msgstr ""
 
-#: ../lib/r10k/git/stateful_repository.rb:47
+#: ../lib/r10k/git/stateful_repository.rb:51
 msgid "Cloning %{repo_path} and checking out %{ref}"
 msgstr ""
 
-#: ../lib/r10k/git/stateful_repository.rb:50
+#: ../lib/r10k/git/stateful_repository.rb:54
 msgid "Replacing %{repo_path} and checking out %{ref}"
 msgstr ""
 
-#: ../lib/r10k/git/stateful_repository.rb:54 ../lib/r10k/git/stateful_repository.rb:59
+#: ../lib/r10k/git/stateful_repository.rb:58 ../lib/r10k/git/stateful_repository.rb:63
 msgid "Updating %{repo_path} to %{ref}"
 msgstr ""
 
-#: ../lib/r10k/git/stateful_repository.rb:58
+#: ../lib/r10k/git/stateful_repository.rb:62
 msgid "Overwriting local modifications to %{repo_path}"
 msgstr ""
 
-#: ../lib/r10k/git/stateful_repository.rb:62
+#: ../lib/r10k/git/stateful_repository.rb:66
 msgid "Skipping %{repo_path} due to local modifications"
 msgstr ""
 
-#: ../lib/r10k/git/stateful_repository.rb:65
+#: ../lib/r10k/git/stateful_repository.rb:69
 msgid "%{repo_path} is already at Git ref %{ref}"
 msgstr ""
 
@@ -303,20 +327,16 @@ msgstr ""
 msgid "Module %{name} with args %{args} doesn't have an implementation. (Are you using the right arguments?)"
 msgstr ""
 
-#: ../lib/r10k/module/base.rb:110
+#: ../lib/r10k/module/base.rb:118
 msgid "Module name (%{title}) must match either 'modulename' or 'owner/modulename'"
 msgstr ""
 
-#: ../lib/r10k/module/forge.rb:70 ../lib/r10k/module/forge.rb:99
+#: ../lib/r10k/module/forge.rb:81 ../lib/r10k/module/forge.rb:110
 msgid "The module %{title} does not exist on %{url}."
 msgstr ""
 
-#: ../lib/r10k/module/forge.rb:174
-msgid "Forge module names must match 'owner/modulename'"
-msgstr ""
-
-#: ../lib/r10k/module/git.rb:97
-msgid "Unhandled options %{unhandled} specified for %{class}"
+#: ../lib/r10k/module/forge.rb:185
+msgid "Forge module names must match 'owner/modulename', instead got #{title}"
 msgstr ""
 
 #: ../lib/r10k/module/local.rb:34
@@ -347,19 +367,19 @@ msgstr ""
 msgid "Remove the duplicates of the following modules: %{dupes}"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:192
+#: ../lib/r10k/puppetfile.rb:201
 msgid "Updating modules with %{pool_size} threads"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:203
+#: ../lib/r10k/puppetfile.rb:212
 msgid "Error during concurrent deploy of a module: %{message}"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:225
+#: ../lib/r10k/puppetfile.rb:241
 msgid "Module thread %{id} exiting: %{message}"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:282
+#: ../lib/r10k/puppetfile.rb:300
 msgid "unrecognized declaration '%{method}'"
 msgstr ""
 
@@ -442,26 +462,30 @@ msgid ""
 "Returned: %{data}"
 msgstr ""
 
-#: ../lib/r10k/source/git.rb:72
+#: ../lib/r10k/source/git.rb:77
 msgid "Fetching '%{remote}' to determine current branches."
 msgstr ""
 
-#: ../lib/r10k/source/git.rb:75
+#: ../lib/r10k/source/git.rb:80
 msgid "Unable to determine current branches for Git source '%{name}' (%{basedir})"
 msgstr ""
 
-#: ../lib/r10k/source/git.rb:100
+#: ../lib/r10k/source/git.rb:105
 msgid "Environment %{env_name} contained non-word characters, correcting name to %{corrected_env_name}"
 msgstr ""
 
-#: ../lib/r10k/source/git.rb:104
+#: ../lib/r10k/source/git.rb:109
 msgid "Environment %{env_name} contained non-word characters, ignoring it."
 msgstr ""
 
-#: ../lib/r10k/source/git.rb:123 ../lib/r10k/source/svn.rb:113
+#: ../lib/r10k/source/git.rb:128 ../lib/r10k/source/svn.rb:113
 msgid "Branch %{branch} filtered out by ignore_branch_prefixes %{ibp}"
 msgstr ""
 
+#: ../lib/r10k/source/git.rb:139
+msgid "Branch `%{name}:%{branch}` filtered out by filter_command %{cmd}"
+msgstr ""
+
 #: ../lib/r10k/source/yaml.rb:10
 msgid "Couldn't open environments file %{file}: %{err}"
 msgstr ""
@@ -522,7 +546,11 @@ msgstr ""
 msgid "Unable to remove unmanaged path: %{path}"
 msgstr ""
 
-#: ../lib/r10k/util/setopts.rb:49
+#: ../lib/r10k/util/setopts.rb:58
+msgid "%{class_name} parameters '%{a}' and '%{b}' conflict. Specify one or the other, but not both"
+msgstr ""
+
+#: ../lib/r10k/util/setopts.rb:65
 msgid "%{class_name} cannot handle option '%{key}'"
 msgstr ""