r10k 3.8.0 → 3.9.0

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 = []

data/lib/r10k/git/rugged/credentials.rb

@@ -67,22 +67,10 @@ class R10K::Git::Rugged::Credentials
     end
 
     if token_path = per_repo_oauth_token || R10K::Git.settings[:oauth_token]
-      if token_path == '-'
-        token = $stdin.read.strip
-        logger.debug2 _("Using OAuth token from stdin for URL %{url}") % { url: url }
-      elsif File.readable?(token_path)
-        token = File.read(token_path).strip
-        logger.debug2 _("Using OAuth token from %{token_path} for URL %{url}") % { token_path: token_path, url: url }
-      else
-        raise R10K::Git::GitError, _("%{path} is missing or unreadable, cannot load OAuth token") % { path: token_path }
-      end
-
-      unless valid_token?(token)
-        raise R10K::Git::GitError, _("Supplied OAuth token contains invalid characters.")
-      end
+      @oauth_token ||= extract_token(token_path, url)
 
       user = 'x-oauth-token'
-      password = token
+      password = @oauth_token
     else
       user = get_git_username(url, username_from_url)
       password = URI.parse(url).password || ''
@@ -90,10 +78,29 @@ class R10K::Git::Rugged::Credentials
     Rugged::Credentials::UserPassword.new(username: user, password: password)
   end
 
+  def extract_token(token_path, url)
+    if token_path == '-'
+      token = $stdin.read.strip
+      logger.debug2 _("Using OAuth token from stdin for URL %{url}") % { url: url }
+    elsif File.readable?(token_path)
+      token = File.read(token_path).strip
+      logger.debug2 _("Using OAuth token from %{token_path} for URL %{url}") % { token_path: token_path, url: url }
+    else
+      raise R10K::Git::GitError, _("%{path} is missing or unreadable, cannot load OAuth token") % { path: token_path }
+    end
+
+    unless valid_token?(token)
+      raise R10K::Git::GitError, _("Supplied OAuth token contains invalid characters.")
+    end
+
+    token
+  end
+
   # This regex is the only real requirement for OAuth token format,
   # per https://www.oauth.com/oauth2-servers/access-tokens/access-token-response/
+  # Bitbucket's tokens also can include an underscore, so that is added here.
   def valid_token?(token)
-    return token =~ /^[\w\-\.~\+\/]+$/
+    return token =~ /^[\w\-\.~_\+\/]+$/
   end
 
   def get_default_credentials(url, username_from_url)

data/lib/r10k/module/forge.rb

@@ -13,7 +13,7 @@ class R10K::Module::Forge < R10K::Module::Base
   R10K::Module.register(self)
 
   def self.implement?(name, args)
-    !!(name.match %r[\w+[/-]\w+]) && valid_version?(args)
+    (args.is_a?(Hash) && args[:type].to_s == 'forge') || (!!(name.match %r[\w+[/-]\w+]) && valid_version?(args))
   end
 
   def self.valid_version?(expected_version)
@@ -32,13 +32,25 @@ class R10K::Module::Forge < R10K::Module::Base
 
   include R10K::Logging
 
-  def initialize(title, dirname, expected_version, environment=nil)
+  include R10K::Util::Setopts
+
+  def initialize(title, dirname, opts, environment=nil)
     super
 
     @metadata_file = R10K::Module::MetadataFile.new(path + 'metadata.json')
     @metadata = @metadata_file.read
 
-    @expected_version = expected_version || current_version || :latest
+    if opts.is_a?(Hash)
+      setopts(opts, {
+        # Standard option interface
+        :version => :expected_version,
+        :source  => ::R10K::Util::Setopts::Ignore,
+        :type    => ::R10K::Util::Setopts::Ignore,
+      })
+    else
+      @expected_version = opts || current_version || :latest
+    end
+
     @v3_module = PuppetForge::V3::Module.new(:slug => @title)
   end
 

data/lib/r10k/module/git.rb

@@ -8,7 +8,7 @@ class R10K::Module::Git < R10K::Module::Base
   R10K::Module.register(self)
 
   def self.implement?(name, args)
-    args.is_a? Hash and args.has_key?(:git)
+    args.is_a?(Hash) && (args.has_key?(:git) || args[:type].to_s == 'git')
   rescue
     false
   end
@@ -33,10 +33,31 @@ class R10K::Module::Git < R10K::Module::Base
   #   @return [String]
   attr_reader :default_override_ref
 
-  def initialize(title, dirname, args, environment=nil)
+  include R10K::Util::Setopts
+
+  def initialize(title, dirname, opts, environment=nil)
     super
+    setopts(opts, {
+      # Standard option interface
+      :version => :desired_ref,
+      :source  => :remote,
+      :type    => ::R10K::Util::Setopts::Ignore,
+
+      # Type-specific options
+      :branch  => :desired_ref,
+      :tag     => :desired_ref,
+      :commit  => :desired_ref,
+      :ref     => :desired_ref,
+      :git     => :remote,
+      :default_branch          => :default_ref,
+      :default_branch_override => :default_override_ref,
+    })
+
+    @desired_ref ||= 'master'
 
-    parse_options(@args)
+    if @desired_ref == :control_branch && @environment && @environment.respond_to?(:ref)
+      @desired_ref = @environment.ref
+    end
 
     @repo = R10K::Git::StatefulRepository.new(@remote, @dirname, @name)
   end
@@ -103,24 +124,4 @@ class R10K::Module::Git < R10K::Module::Base
       raise ArgumentError, _(msg.join(' ')) % vars
     end
   end
-
-  def parse_options(options)
-    ref_opts = [:branch, :tag, :commit, :ref]
-    known_opts = [:git, :default_branch, :default_branch_override] + ref_opts
-
-    unhandled = options.keys - known_opts
-    unless unhandled.empty?
-      raise ArgumentError, _("Unhandled options %{unhandled} specified for %{class}") % {unhandled: unhandled, class: self.class}
-    end
-
-    @remote = options[:git]
-
-    @desired_ref = ref_opts.find { |key| break options[key] if options.has_key?(key) } || 'master'
-    @default_ref = options[:default_branch]
-    @default_override_ref = options[:default_branch_override]
-
-    if @desired_ref == :control_branch && @environment && @environment.respond_to?(:ref)
-      @desired_ref = @environment.ref
-    end
-  end
 end

data/lib/r10k/module/local.rb

@@ -9,7 +9,7 @@ class R10K::Module::Local < R10K::Module::Base
   R10K::Module.register(self)
 
   def self.implement?(name, args)
-    args.is_a?(Hash) && args[:local]
+    args.is_a?(Hash) && (args[:local] || args[:type].to_s == 'local')
   end
 
   include R10K::Logging

data/lib/r10k/module/svn.rb

@@ -7,7 +7,7 @@ class R10K::Module::SVN < R10K::Module::Base
   R10K::Module.register(self)
 
   def self.implement?(name, args)
-    args.is_a? Hash and args.has_key? :svn
+    args.is_a?(Hash) && (args.has_key?(:svn) || args[:type].to_s == 'svn')
   end
 
   # @!attribute [r] expected_revision
@@ -36,18 +36,21 @@ class R10K::Module::SVN < R10K::Module::Base
 
   include R10K::Util::Setopts
 
-  INITIALIZE_OPTS = {
-    :svn => :url,
-    :rev => :expected_revision,
-    :revision => :expected_revision,
-    :username => :self,
-    :password => :self
-  }
-
   def initialize(name, dirname, opts, environment=nil)
     super
-
-    setopts(opts, INITIALIZE_OPTS)
+    setopts(opts, {
+      # Standard option interface
+      :source   => :url,
+      :version  => :expected_revision,
+      :type     => ::R10K::Util::Setopts::Ignore,
+
+      # Type-specific options
+      :svn      => :url,
+      :rev      => :expected_revision,
+      :revision => :expected_revision,
+      :username => :self,
+      :password => :self
+    })
 
     @working_dir = R10K::SVN::WorkingDir.new(@path, :username => @username, :password => @password)
   end

data/lib/r10k/settings.rb

@@ -122,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,

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

@@ -145,7 +145,10 @@ class R10K::Source::Git < R10K::Source::Base
   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_by_regexp(branches, @ignore_branch_prefixes)

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.8.0'
+  VERSION = '3.9.0'
 end

data/locales/r10k.pot

@@ -6,11 +6,11 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: r10k 3.4.1-133-g2007a86\n"
+"Project-Id-Version: r10k 3.4.1-151-g93d38cb\n"
 "\n"
 "Report-Msgid-Bugs-To: docs@puppetlabs.com\n"
-"POT-Creation-Date: 2021-02-12 02:00+0000\n"
-"PO-Revision-Date: 2021-02-12 02:00+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"
@@ -103,10 +103,14 @@ 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/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:60
 msgid "Environment and %{src} both define the \"%{name}\" module"
 msgstr ""
@@ -231,31 +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:72
+#: ../lib/r10k/git/rugged/credentials.rb:84
 msgid "Using OAuth token from stdin for URL %{url}"
 msgstr ""
 
-#: ../lib/r10k/git/rugged/credentials.rb:75
+#: ../lib/r10k/git/rugged/credentials.rb:87
 msgid "Using OAuth token from %{token_path} for URL %{url}"
 msgstr ""
 
-#: ../lib/r10k/git/rugged/credentials.rb:77
+#: ../lib/r10k/git/rugged/credentials.rb:89
 msgid "%{path} is missing or unreadable, cannot load OAuth token"
 msgstr ""
 
-#: ../lib/r10k/git/rugged/credentials.rb:81
+#: ../lib/r10k/git/rugged/credentials.rb:93
 msgid "Supplied OAuth token contains invalid characters."
 msgstr ""
 
-#: ../lib/r10k/git/rugged/credentials.rb:110
+#: ../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:113
+#: ../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:116
+#: ../lib/r10k/git/rugged/credentials.rb:123
 msgid "URL %{url} did not specify a user, using current user %{user}"
 msgstr ""
 
@@ -327,18 +331,14 @@ msgstr ""
 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
+#: ../lib/r10k/module/forge.rb:185
 msgid "Forge module names must match 'owner/modulename', instead got #{title}"
 msgstr ""
 
-#: ../lib/r10k/module/git.rb:113
-msgid "Unhandled options %{unhandled} specified for %{class}"
-msgstr ""
-
 #: ../lib/r10k/module/local.rb:34
 msgid "Module %{title} is a local module, always indicating synced."
 msgstr ""
@@ -546,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 ""