r10k 3.15.0 → 4.1.0

data/lib/r10k/module/git.rb

@@ -46,6 +46,11 @@ class R10K::Module::Git < R10K::Module::Base
   #   @return [String]
   attr_reader :default_override_ref
 
+  # @!attribute[r] remote
+  #   @api private
+  #   @return [String]
+  attr_reader :remote
+
   include R10K::Util::Setopts
 
   def initialize(title, dirname, opts, environment=nil)
@@ -63,15 +68,14 @@ class R10K::Module::Git < R10K::Module::Base
       :commit                  => :desired_ref,
       :ref                     => :desired_ref,
       :git                     => :remote,
-      :default_branch          => :default_ref,
+      :default_branch          => :default_branch,
       :default_branch_override => :default_override_ref,
     }, :raise_on_unhandled => false)
 
+    @default_ref = @default_branch.nil? ? @overrides.dig(:modules, :default_ref) : @default_branch
     force = @overrides[:force]
     @force = force == false ? false : true
 
-    @desired_ref ||= 'master'
-
     if @desired_ref == :control_branch
       if @environment && @environment.respond_to?(:ref)
         @desired_ref = @environment.ref
@@ -116,6 +120,14 @@ class R10K::Module::Git < R10K::Module::Base
     @repo.cache.sanitized_dirname
   end
 
+  def validate_ref_defined
+    if @desired_ref.nil? && @default_ref.nil? && @default_override_ref.nil?
+      msg = "No ref defined for module #{@name}. Add a ref to the module definition "
+      msg << "or set git:default_ref in the r10k.yaml config to configure a global default ref."
+      raise ArgumentError, msg
+    end
+  end
+
   private
 
   def validate_ref(desired, default, default_override)
@@ -147,7 +159,9 @@ class R10K::Module::Git < R10K::Module::Base
         msg << "or resolve default ref '%{default}'"
         vars[:default] = default
       else
-        msg << "and no default provided"
+        msg << "and no default provided. r10k no longer hardcodes 'master' as the default ref."
+        msg << "Consider setting a ref per module in the Puppetfile or setting git:default_ref"
+        msg << "in your r10k config."
       end
 
       raise ArgumentError, _(msg.join(' ')) % vars

data/lib/r10k/module_loader/puppetfile.rb

@@ -30,17 +30,21 @@ module R10K
       # @param overrides [Hash] Configuration for loaded modules' behavior
       # @param environment [R10K::Environment] When provided, the environment
       #     in which loading takes place
+      # @param module_exclude_regex [Regex] A regex to exclude modules from
+      #     installation. Helpful in CI environments.
       def initialize(basedir:,
                      moduledir: DEFAULT_MODULEDIR,
                      puppetfile: DEFAULT_PUPPETFILE_NAME,
                      overrides: {},
-                     environment: nil)
+                     environment: nil,
+                     module_exclude_regex: nil)
 
         @basedir     = cleanpath(basedir)
         @moduledir   = resolve_path(@basedir, moduledir)
         @puppetfile_path  = resolve_path(@basedir, puppetfile)
         @overrides   = overrides
         @environment = environment
+        @module_exclude_regex = module_exclude_regex
         @environment_name = @environment&.name
         @default_branch_override = @overrides.dig(:environments, :default_branch_override)
         @allow_puppetfile_forge = @overrides.dig(:forge, :allow_puppetfile_override)
@@ -68,6 +72,7 @@ module R10K
         dsl.instance_eval(puppetfile_content(@puppetfile_path), @puppetfile_path)
 
         validate_no_duplicate_names(@modules)
+        @modules = filter_modules(@modules, @module_exclude_regex) if @module_exclude_regex
 
         managed_content = @modules.group_by(&:dirname)
 
@@ -99,8 +104,11 @@ module R10K
         @existing_module_versions_by_name = @existing_module_metadata.map {|mod| [ mod.name, mod.version ] }.to_h
         empty_load_output.merge(modules: @existing_module_metadata)
 
-      rescue SyntaxError, LoadError, ArgumentError, NameError => e
+      rescue ScriptError, StandardError => e
         logger.warn _("Unable to preload Puppetfile because of %{msg}" % { msg: e.message })
+
+        @existing_module_metadata = []
+        @existing_module_versions_by_name = {}
       end
 
       def add_module_metadata(name, info)
@@ -170,13 +178,6 @@ module R10K
         @modules << mod
       end
 
-      # @deprecated
-      # @return [String] The base directory that contains the Puppetfile
-      def basedir
-        logger.warn _('"basedir" is deprecated. Please use "environment_name" instead. "basedir" will be removed in a future version.')
-        @basedir
-      end
-
      private
 
       def empty_load_output
@@ -223,6 +224,10 @@ module R10K
         return [ install_path, info, spec_deletable ]
       end
 
+      def filter_modules(modules, exclude_regex)
+        modules.reject { |mod| mod.name =~ /#{exclude_regex}/ }
+      end
+
       # @param [Array<R10K::Module>] modules
       def validate_no_duplicate_names(modules)
         dupes = modules

data/lib/r10k/puppetfile.rb

@@ -72,7 +72,7 @@ class Puppetfile
     @overrides       = options.delete(:overrides) || {}
     @default_branch_override = @overrides.dig(:environments, :default_branch_override)
 
-    @forge   = 'forgeapi.puppetlabs.com'
+    @forge   = 'forgeapi.puppet.com'
 
     @loader = ::R10K::ModuleLoader::Puppetfile.new(
       basedir: @basedir,

data/lib/r10k/settings.rb

@@ -19,6 +19,10 @@ module R10K
     def self.git_settings
       R10K::Settings::Collection.new(:git, [
 
+        Definition.new(:default_ref, {
+          :desc => "User-defined default ref from which to deploy modules when not otherwise specified; nil unless configured via the r10k.yaml config.",
+          :default => nil}),
+
         EnumDefinition.new(:provider, {
           :desc => "The Git provider to use. Valid values: 'shellgit', 'rugged'",
           :normalize => lambda { |input| input.to_sym },
@@ -175,11 +179,6 @@ module R10K
           :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,
@@ -207,8 +206,8 @@ module R10K
           end
         }),
         Definition.new(:exclude_spec, {
-          :desc => "Whether or not to deploy the spec dir of a module. Defaults to false.",
-          :default => false,
+          :desc => "Whether or not to deploy the spec dir of a module. Defaults to true.",
+          :default => true,
           :validate => lambda do |value|
             unless !!value == value
               raise ArgumentError, "`exclude_spec` can only be a boolean value, not '#{value}'"

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.15.0'
+  VERSION = '4.1.0'
 end

data/locales/r10k.pot

@@ -1,16 +1,16 @@
 # SOME DESCRIPTIVE TITLE.
-# Copyright (C) 2022 Puppet, Inc.
+# Copyright (C) 2023 Puppet, Inc.
 # This file is distributed under the same license as the r10k package.
-# FIRST AUTHOR <EMAIL@ADDRESS>, 2022.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2023.
 #
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: r10k 3.9.3-208-gb88bb368\n"
+"Project-Id-Version: r10k 3.9.3-373-g117587fb\n"
 "\n"
 "Report-Msgid-Bugs-To: docs@puppetlabs.com\n"
-"POT-Creation-Date: 2022-02-07 21:13+0000\n"
-"PO-Revision-Date: 2022-02-07 21:13+0000\n"
+"POT-Creation-Date: 2023-07-26 22:34+0000\n"
+"PO-Revision-Date: 2023-07-26 22:34+0000\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
 "Language: \n"
@@ -31,47 +31,47 @@ msgstr ""
 msgid "Reason: %{write_lock}"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/environment.rb:116
+#: ../lib/r10k/action/deploy/environment.rb:99
 msgid "Environment(s) \\'%{environments}\\' cannot be found in any source and will not be deployed."
 msgstr ""
 
-#: ../lib/r10k/action/deploy/environment.rb:136
+#: ../lib/r10k/action/deploy/environment.rb:119
 msgid "Executing postrun command."
 msgstr ""
 
-#: ../lib/r10k/action/deploy/environment.rb:150
+#: ../lib/r10k/action/deploy/environment.rb:133
 msgid "Environment %{env_dir} does not match environment name filter, skipping"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/environment.rb:158
+#: ../lib/r10k/action/deploy/environment.rb:141
 msgid "Deploying environment %{env_path}"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/environment.rb:161
+#: ../lib/r10k/action/deploy/environment.rb:144
 msgid "Environment %{env_dir} is now at %{env_signature}"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/environment.rb:165
+#: ../lib/r10k/action/deploy/environment.rb:148
 msgid "Environment %{env_dir} is new, updating all modules"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/module.rb:81
+#: ../lib/r10k/action/deploy/module.rb:82
 msgid "Running postrun command for environments: %{envs_to_run}."
 msgstr ""
 
-#: ../lib/r10k/action/deploy/module.rb:91
+#: ../lib/r10k/action/deploy/module.rb:92
 msgid "No environments were modified, not executing postrun command."
 msgstr ""
 
-#: ../lib/r10k/action/deploy/module.rb:103
+#: ../lib/r10k/action/deploy/module.rb:104
 msgid "Only updating modules in environment(s) %{opt_env} skipping environment %{env_path}"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/module.rb:105
+#: ../lib/r10k/action/deploy/module.rb:106
 msgid "Updating modules %{modules} in environment %{env_path}"
 msgstr ""
 
-#: ../lib/r10k/action/puppetfile/check.rb:18
+#: ../lib/r10k/action/puppetfile/check.rb:25
 msgid "Syntax OK"
 msgstr ""
 
@@ -95,7 +95,11 @@ msgstr ""
 msgid "Error during concurrent deploy of a module: %{message}"
 msgstr ""
 
-#: ../lib/r10k/content_synchronizer.rb:87
+#: ../lib/r10k/content_synchronizer.rb:86
+msgid "Module %{mod_name} failed to synchronize due to %{message}"
+msgstr ""
+
+#: ../lib/r10k/content_synchronizer.rb:92
 msgid "Module thread %{id} exiting: %{message}"
 msgstr ""
 
@@ -107,10 +111,6 @@ msgstr ""
 msgid "Unable to load sources; the supplied configuration does not define the 'sources' key"
 msgstr ""
 
-#: ../lib/r10k/environment/bare.rb:6
-msgid "\"bare\" environment type is deprecated; please use \"plain\" instead (environment: %{name})"
-msgstr ""
-
 #: ../lib/r10k/environment/base.rb:89 ../lib/r10k/environment/base.rb:105 ../lib/r10k/environment/base.rb:114 ../lib/r10k/source/base.rb:83
 msgid "%{class} has not implemented method %{method}"
 msgstr ""
@@ -123,10 +123,6 @@ msgstr ""
 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 ""
@@ -303,26 +299,10 @@ msgstr ""
 msgid "Using Github App id %{app_id} with SSL key from %{key_path}"
 msgstr ""
 
-#: ../lib/r10k/git/rugged/credentials.rb:178
-msgid ""
-"Unexpected response code: #{get_response.code}\n"
-"Response body: #{get_response.body}"
-msgstr ""
-
 #: ../lib/r10k/git/rugged/credentials.rb:179
 msgid "Error using private key to get Github App access token from url"
 msgstr ""
 
-#: ../lib/r10k/git/rugged/credentials.rb:194
-msgid ""
-"Unexpected response code: #{post_response.code}\n"
-"Response body: #{post_response.body}"
-msgstr ""
-
-#: ../lib/r10k/git/rugged/credentials.rb:195
-msgid "Error using private key to generate access token from #{access_token_url}"
-msgstr ""
-
 #: ../lib/r10k/git/rugged/credentials.rb:200
 msgid "Github App token contains invalid characters."
 msgstr ""
@@ -331,7 +311,7 @@ msgstr ""
 msgid "Github App token generated, expires at: %{expire}"
 msgstr ""
 
-#: ../lib/r10k/git/rugged/thin_repository.rb:85 ../lib/r10k/git/shellgit/thin_repository.rb:65
+#: ../lib/r10k/git/rugged/thin_repository.rb:92 ../lib/r10k/git/shellgit/thin_repository.rb:69
 msgid "Updated repo %{path} to include alternate object db path %{objects_dir}"
 msgstr ""
 
@@ -343,7 +323,7 @@ msgstr ""
 msgid "Fetching remote '%{remote}' at %{path}"
 msgstr ""
 
-#: ../lib/r10k/git/rugged/working_repository.rb:125 ../lib/r10k/git/shellgit/working_repository.rb:100
+#: ../lib/r10k/git/rugged/working_repository.rb:131 ../lib/r10k/git/shellgit/working_repository.rb:101
 msgid "Found local modifications in %{file_path}"
 msgstr ""
 
@@ -395,22 +375,6 @@ msgstr ""
 msgid "Module %{name} with args %{args} doesn't have an implementation. (Are you using the right arguments?)"
 msgstr ""
 
-#: ../lib/r10k/module/base.rb:66
-msgid "Overriding :exclude_spec setting with per module setting for #{@title}"
-msgstr ""
-
-#: ../lib/r10k/module/base.rb:87
-msgid "Spec dir for #{@title} will not be deleted because it is not in the moduledir"
-msgstr ""
-
-#: ../lib/r10k/module/base.rb:99
-msgid "Deleting spec data at #{spec_path}"
-msgstr ""
-
-#: ../lib/r10k/module/base.rb:107
-msgid "No spec dir detected at #{spec_path}, skipping deletion"
-msgstr ""
-
 #: ../lib/r10k/module/base.rb:120
 msgid "Deploying module to %{path}"
 msgstr ""
@@ -439,11 +403,7 @@ msgstr ""
 msgid "The module %{title} does not exist on %{url}."
 msgstr ""
 
-#: ../lib/r10k/module/forge.rb:205
-msgid "Forge module names must match 'owner/modulename', instead got #{title}"
-msgstr ""
-
-#: ../lib/r10k/module/git.rb:79
+#: ../lib/r10k/module/git.rb:78
 msgid "Cannot track control repo branch for content '%{name}' when not part of a git-backed environment, will use default if available."
 msgstr ""
 
@@ -455,43 +415,39 @@ msgstr ""
 msgid "Could not read metadata.json"
 msgstr ""
 
-#: ../lib/r10k/module_loader/puppetfile.rb:64
+#: ../lib/r10k/module_loader/puppetfile.rb:68
 msgid "Using Puppetfile '%{puppetfile}'"
 msgstr ""
 
-#: ../lib/r10k/module_loader/puppetfile.rb:65
+#: ../lib/r10k/module_loader/puppetfile.rb:69
 msgid "Using moduledir '%{moduledir}'"
 msgstr ""
 
-#: ../lib/r10k/module_loader/puppetfile.rb:86
+#: ../lib/r10k/module_loader/puppetfile.rb:91
 msgid "Failed to evaluate %{path}"
 msgstr ""
 
-#: ../lib/r10k/module_loader/puppetfile.rb:103
+#: ../lib/r10k/module_loader/puppetfile.rb:108
 msgid "Unable to preload Puppetfile because of %{msg}"
 msgstr ""
 
-#: ../lib/r10k/module_loader/puppetfile.rb:121
+#: ../lib/r10k/module_loader/puppetfile.rb:126
 msgid "Using Forge from Puppetfile: %{forge}"
 msgstr ""
 
-#: ../lib/r10k/module_loader/puppetfile.rb:124
+#: ../lib/r10k/module_loader/puppetfile.rb:129
 msgid "Ignoring Forge declaration in Puppetfile, using value from settings: %{forge}."
 msgstr ""
 
-#: ../lib/r10k/module_loader/puppetfile.rb:173
-msgid "\"basedir\" is deprecated. Please use \"environment_name\" instead. \"basedir\" will be removed in a future version."
-msgstr ""
-
-#: ../lib/r10k/module_loader/puppetfile.rb:192 ../lib/r10k/puppetfile.rb:104
+#: ../lib/r10k/module_loader/puppetfile.rb:193 ../lib/r10k/puppetfile.rb:104
 msgid "Puppetfile %{path} missing or unreadable"
 msgstr ""
 
-#: ../lib/r10k/module_loader/puppetfile.rb:230
+#: ../lib/r10k/module_loader/puppetfile.rb:235
 msgid "Puppetfiles cannot contain duplicate module names."
 msgstr ""
 
-#: ../lib/r10k/module_loader/puppetfile.rb:232
+#: ../lib/r10k/module_loader/puppetfile.rb:237
 msgid "Remove the duplicates of the following modules: %{dupes}"
 msgstr ""
 
@@ -507,7 +463,7 @@ msgstr ""
 msgid "Validation failed for settings group"
 msgstr ""
 
-#: ../lib/r10k/settings/container.rb:91
+#: ../lib/r10k/settings/container.rb:92
 msgid "Key %{key} is not a valid key"
 msgstr ""
 
@@ -551,10 +507,6 @@ msgstr ""
 msgid "Couldn't load config file: %{error_msg}"
 msgstr ""
 
-#: ../lib/r10k/settings/loader.rb:73
-msgid "File exists at #{path} but doesn't contain any YAML"
-msgstr ""
-
 #: ../lib/r10k/settings/uri_definition.rb:12
 msgid "Setting %{name} requires a URL but '%{value}' could not be parsed as a URL"
 msgstr ""

data/r10k.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
     dynamic environments.
   DESCRIPTION
 
-  s.required_ruby_version = '>= 2.3.0'
+  s.required_ruby_version = '>= 2.6.0'
 
   s.license  = 'Apache-2.0'
 
@@ -28,13 +28,11 @@ 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.3.0'
+  s.add_dependency 'puppet_forge', '>= 4.1', '< 6'
 
-  s.add_dependency 'gettext-setup', '~>0.24'
-  s.add_dependency 'fast_gettext', ['>= 1.1.0', '< 3.0.0']
-  s.add_dependency 'gettext', ['>= 3.0.2', '< 4.0.0']
+  s.add_dependency 'gettext-setup', '>=0.24', '<2.0'
 
-  s.add_dependency 'jwt', '~> 2.2.3'
+  s.add_dependency 'jwt', '>= 2.2.3', '< 3'
   s.add_dependency 'minitar', '~> 0.9'
 
   s.add_development_dependency 'rspec', '~> 3.1'
@@ -43,7 +41,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'yard', '~> 0.9.11'
 
-  s.files        = %x[git ls-files].split($/)
+  s.files        = %x[git ls-files].split($/).reject { |f| f.match(%r{^spec}) }
   s.require_path = 'lib'
   s.bindir       = 'bin'
   s.executables  = 'r10k'