r10k 3.16.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13267460bb0dfdd1adb733c146be3b61db8505fdf33f35eab7f6ab4e719b9643
-  data.tar.gz: 2fffbce0bc5b07fe8dfe3809c4e7d57ff0c3acafcaa7ad8fdec74bcf03634744
+  metadata.gz: 05d094f24e1da891308bda6d4589351f1c2e1ba16b1efd8c97c5611414df0ee8
+  data.tar.gz: eaa7e2f7843cbb445a4619fdd30c923a289838a5884c07a19c4da4f2f5912293
 SHA512:
-  metadata.gz: 36d4032b4fce66c180bbe1ae4ccf2cc323aa7236337e869b8bcb23fe557202948a91c8a8a4dcd40fd7cb8c67002ca4b2a01c1dd5d742a41f0470b5574489dd7f
-  data.tar.gz: 297399b426133749fec9b4b2e89c5bde44c9c507af47ed52c083e890eae5880edd7619ba324c031342f7ecc0f31b5052a2ed8f00ee1b497550953f0910e0cec4
+  metadata.gz: afa0f4daefb75c0b8c954b27b94a53f634616d7339e18d55f96ad19b26b3e486feee0b8bf41ee2801b516451412b0d5ea8d7a81444adb03909b364b243cca121
+  data.tar.gz: b49551e056b22522ffc8c7778559059830aec6278cec7b37e7f4fc990be57f547a2922306e79a3b24f9bf5d8b887d8cb6c75bafcd357bb632a04ca6d8683ea14

data/.github/workflows/docker.yml

@@ -29,7 +29,7 @@ jobs:
       - run: gem install bundler
       - uses: actions/checkout@v3
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
       - name: Build container

data/.github/workflows/rspec_tests.yml

@@ -4,6 +4,7 @@ on:
   pull_request:
     branches:
       - main
+      - 3.x
 
 jobs:
   rspec_tests:
@@ -11,15 +12,14 @@ jobs:
     strategy:
       matrix:
         cfg:
-          - {os: ubuntu-latest, ruby: 2.4}
-          - {os: ubuntu-latest, ruby: 2.5}
           - {os: ubuntu-latest, ruby: 2.6}
           - {os: ubuntu-latest, ruby: 2.7}
+          - {os: ubuntu-latest, ruby: 3.1}
           - {os: ubuntu-latest, ruby: 3.2}
-          - {os: ubuntu-latest, ruby: jruby-9.2.10.0}
-          - {os: windows-2019, ruby: 2.5}
-          - {os: windows-2019, ruby: 2.6}
-          - {os: windows-2019, ruby: 2.7}
+          - {os: ubuntu-latest, ruby: jruby-9.3}
+          - {os: ubuntu-latest, ruby: jruby-9.4}
+          - {os: windows-latest, ruby: 2.6}
+          - {os: windows-latest, ruby: 3.2}
 
     runs-on: ${{ matrix.cfg.os }}
     steps:
@@ -33,8 +33,6 @@ jobs:
 
       - name: Install bundler and gems
         run: |
-          # Pin bundler to maintain support for Ruby 2.4 and 2.5
-          gem install bundler -v 2.3.26
           bundle config set without packaging documentation
           bundle install --jobs 4 --retry 3
 

data/CHANGELOG.mkd

@@ -4,6 +4,21 @@ CHANGELOG
 Unreleased
 ----------
 
+4.0.1
+-----
+
+- shellgit: Ensure the passed filepath to diff-index is interpreted as filepath [#1367](https://github.com/puppetlabs/r10k/pull/1367)
+
+4.0.0
+-----
+- Drop Ruby 2.3/2.4/2.5 support; use puppet_forge 4.1 or newer [#1336](https://github.com/puppetlabs/r10k/pull/1336)
+- (maint) Add Ruby 3.0 to rspec CI matrix [#1261](https://github.com/puppetlabs/r10k/pull/1261)
+- (RK-368) remove `purge_whitelist` setting [#1277](https://github.com/puppetlabs/r10k/pull/1277)
+- (RK-390) Remove default ref for deploying git modules [#1275](http://github.com/puppetlabs/r10k/pull/1275)
+- (RK-391) Change `exclude_spec` default to true for module spec dir deletion [#1264](https://github.com/puppetlabs/r10k/pull/1261)
+- (RK-383) Remove deprecated `basedir` method from Puppetfile DSL. Users should use `environment_name` instead. [#1254](https://github.com/puppetlabs/r10k/pull/1254)
+- (RK-386) Remove deprecated `bare` environment type. [#1235](https://github.com/puppetlabs/r10k/issues/1235)
+
 
 3.16.0
 ------

data/Gemfile

@@ -6,7 +6,7 @@ group :extra do
 end
 
 group :development do
-  gem 'simplecov', '~> 0.17.1'
+  gem 'simplecov', '~> 0.22.0'
   gem 'ruby-prof', :platforms => :ruby
 end
 

data/README.mkd

@@ -27,14 +27,14 @@ based alternative.
 Requirements
 ------------
 
-R10k supports the Ruby versions `>= 2.4.0`. It's tested on Ruby 2.4.0 up to
+R10k supports the Ruby versions `>= 2.6.0`. It's tested on Ruby 2.6.0 up to
 Ruby 3.1.0 + Jruby.
 
 R10k requires additional components, depending on how you plan on managing
 environments and modules.
 
-  - Installing modules from the Puppet Forge requires Puppet 5.0.0+ or later.
-  Puppet 3 or 4 may work, but is generally not recommended.
+  - Installing modules from the Puppet Forge requires Puppet 7.0.0+ or later.
+  Puppet 5 and 6 may work, but is generally not recommended.
   - Git is required for creating environments and modules from Git
   - SVN is required for creating environments and modules from SVN
 
@@ -78,7 +78,7 @@ a git repository using Bundler for dependencies:
 
 ### Arch Linux
 
-Arch Linux provides a [system package](https://archlinux.org/packages/community/any/r10k/) for r10k.
+Arch Linux provides a [system package](https://archlinux.org/packages/extra/any/r10k/) for r10k.
 This is built against the [system Ruby](https://archlinux.org/packages/extra/x86_64/ruby/) (which is Ruby 3.0.2 as of 2021-08-03).
 This package is maintained by [Tim Meusel](https://github.com/bastelfreak).
 

data/doc/common-patterns.mkd

@@ -12,8 +12,7 @@ Use a [Control Repo](https://docs.puppet.com/pe/latest/cmgmt_control_repo.html)
 to store your `Puppetfile`.
 
 Hiera data should be in the Control repo OR as a separate source in
-`r10k.yaml`. Any `hiera.yaml` in the Control repo will be ignored on a per
-environment basis, locating it at `/etc/puppetlabs/puppet/hiera.yaml` is prefered.
+`r10k.yaml`.
 
 Each puppet module should be contained in its own independent forge module or
 repository.

data/doc/dynamic-environments/configuration.mkd

@@ -160,6 +160,18 @@ git:
 See the [git provider documentation](../git/providers.mkd) for more information
 regarding Git providers.
 
+#### default_ref
+
+r10k is unable to deploy a git module if no `ref` is specified. A `default_ref` can be
+set in the r10k config that will become the ref a module uses if not otherwise specified. This
+is the lowest priority setting for a module's `ref`. Read the [Puppetfile documentation](../puppetfile.mkd#git)
+for higher priority settings to determine a module's ref.
+
+```yaml
+git:
+  default_ref: main
+```
+
 #### proxy
 
 The 'proxy' setting allows you to set or override the global proxy setting specifically
@@ -437,7 +449,7 @@ deploy:
 
 #### exclude_spec
 
-During module deployment, r10k's default behavior is to deploy the spec directory. Setting
+During module deployment, r10k's default behavior is to delete the spec directory. Setting
 `exclude_spec` to true will deploy modules without their spec directory. This behavior
 can be configured for all modules using the `exclude_spec` setting in the r10k config.
 It can also be passed as a CLI argument for `deploy environment/module`, overriding the

data/doc/puppetfile.mkd

@@ -135,6 +135,12 @@ operations when updating the repo, which can speed up install times. When
 Module versions can also be specified using `:branch` to track a specific
 branch reference.
 
+In r10k 3.x the default branch was hardcoded to `master`; in 4.x that was
+removed. A `default_ref` can be specified in the r10k config to
+to mimic that old behavior, but it is recommended to set the ref on a
+per-module basis in the Puppetfile. Read [here](dynamic-environments/configuration.mkd#default_ref) for more info
+on the `default_ref` setting.
+
 #### Examples
 
 ```ruby
@@ -327,15 +333,15 @@ on managing internal and external modules in the same directory.
 
 ### Per-Item spec dir deployment
 
-During deployment, r10k's default behavior is to deploy the spec directory. The
+During deployment, r10k's default behavior is to delete the spec directory. The
 Puppetfile can modify this per module, overriding settings from the default
-r10k config. The following example sets the module to not deploy the spec
+r10k config. The following example sets the module to deploy the spec
 directory.
 
 ```
 mod 'apache',
   :git => 'git@github.com:puppetlabs/puppetlabs-apache.git',
-  :exclude_spec => true
+  :exclude_spec => false
 ```
 
 ### Per-Item Install Path

data/integration/tests/basic_functionality/negative/negative_bad_proxy.rb

@@ -6,7 +6,7 @@ test_name 'RK-110 - C88671 - Specify a bad proxy to r10k'
 confine(:to, :platform => ['el', 'sles'])
 
 #Init
-master_platform = fact_on(master, 'osfamily')
+master_platform = fact_on(master, 'os.family')
 r10k_fqp = get_r10k_fqp(master)
 
 #Verification

data/integration/tests/basic_functionality/proxy_specified_in_configuration.rb

@@ -6,7 +6,7 @@ test_name 'RK-110 - C87652 - Specify the proxy in the r10k.yaml'
 confine(:to, :platform => ['el', 'sles'])
 
 #Init
-master_platform = fact_on(master, 'osfamily')
+master_platform = fact_on(master, 'os.family')
 env_path = on(master, puppet('config print environmentpath')).stdout.rstrip
 r10k_fqp = get_r10k_fqp(master)
 

data/integration/tests/basic_functionality/proxy_with_puppetfile.rb

@@ -6,7 +6,7 @@ test_name 'RK-110 - C87651 - Specify a proxy in an environment variable'
 confine(:to, :platform => ['el', 'sles'])
 
 #Init
-master_platform = fact_on(master, 'osfamily')
+master_platform = fact_on(master, 'os.family')
 r10k_fqp = get_r10k_fqp(master)
 
 case master_platform

data/integration/tests/basic_functionality/rugged_git_provider_with_ssh.rb

@@ -10,12 +10,12 @@ confine(:to, :platform => ['el', 'ubuntu', 'sles'])
 
 if ENV['GIT_PROVIDER'] == 'shellgit'
   skip_test('Skipping test because removing Git from the system affects other "shellgit" tests.')
-elsif fact_on(master, 'osfamily') == 'RedHat' and fact_on(master, "operatingsystemmajrelease").to_i < 6
+elsif fact_on(master, 'os.family') == 'RedHat' and fact_on(master, "os.release.major").to_i < 6
   skip_test('This version of EL is not supported by this test case!')
 end
 
 #Init
-master_platform = fact_on(master, 'osfamily')
+master_platform = fact_on(master, 'os.family')
 master_certname = on(master, puppet('config', 'print', 'certname')).stdout.rstrip
 env_path = on(master, puppet('config print environmentpath')).stdout.rstrip
 r10k_fqp = get_r10k_fqp(master)
@@ -87,7 +87,7 @@ step 'Remove "git" Package from System'
 if master_platform == 'RedHat'
   on(master, 'yum remove -y git')
 elsif master_platform == 'Debian'
-  if fact_on(master, "operatingsystemmajrelease") == '10.04'
+  if fact_on(master, "os.release.major") == '10.04'
     on(master, 'apt-get remove -y git-core')
   else
     on(master, 'apt-get remove -y git')

data/integration/tests/basic_functionality/rugged_git_provider_without_ssh.rb

@@ -8,12 +8,12 @@ confine(:to, :platform => ['el', 'ubuntu', 'sles'])
 
 if ENV['GIT_PROVIDER'] == 'shellgit'
   skip_test('Skipping test because removing Git from the system affects other "shellgit" tests.')
-elsif fact_on(master, 'osfamily') == 'RedHat' and fact_on(master, "operatingsystemmajrelease").to_i < 6
+elsif fact_on(master, 'os.family') == 'RedHat' and fact_on(master, "os.release.major").to_i < 6
   skip_test('This version of EL is not supported by this test case!')
 end
 
 #Init
-master_platform = fact_on(master, 'osfamily')
+master_platform = fact_on(master, 'os.family')
 master_certname = on(master, puppet('config', 'print', 'certname')).stdout.rstrip
 env_path = on(master, puppet('config print environmentpath')).stdout.rstrip
 r10k_fqp = get_r10k_fqp(master)
@@ -86,7 +86,7 @@ step 'Remove "git" Package from System'
 if master_platform == 'RedHat'
   on(master, 'yum remove -y git')
 elsif master_platform == 'Debian'
-  if fact_on(master, "operatingsystemmajrelease") == '10.04'
+  if fact_on(master, "os.release.major") == '10.04'
     on(master, 'apt-get remove -y git-core')
   else
     on(master, 'apt-get remove -y git')

data/integration/tests/git_source/git_source_git.rb

@@ -5,7 +5,7 @@ test_name 'CODEMGMT-92 - C59235 - Single Git Source Using "GIT" Transport Protoc
 
 confine(:to, :platform => 'el')
 
-if fact_on(master, "operatingsystemmajrelease").to_i < 6
+if fact_on(master, "os.release.major").to_i < 6 || fact_on(master, "os.release.major").to_i > 8
   skip_test('This version of EL is not supported by this test case!')
 end
 

data/integration/tests/purging/{does_not_purge_files_on_white_list.rb → does_not_purge_files_on_allowlist.rb}

@@ -1,7 +1,7 @@
 require 'git_utils'
 require 'r10k_utils'
 require 'master_manipulator'
-test_name 'RK-257 - C98046 - r10k does not purge files on whitelist'
+test_name 'RK-257 - C98046 - r10k does not purge files on allowlist'
 
 #Init
 env_path = on(master, puppet('config print environmentpath')).stdout.rstrip
@@ -39,7 +39,7 @@ sources:
     remote: "#{git_control_remote}"
 deploy:
   purge_levels: ['deployment', 'environment', 'puppetfile']
-  purge_whitelist: ['**/*.pp']
+  purge_allowlist: ['**/*.pp']
 CONF
 
 step 'Update the "r10k" Config'

data/integration/tests/user_scenario/basic_workflow/negative/neg_disk_full.rb

@@ -2,7 +2,7 @@ require 'git_utils'
 require 'r10k_utils'
 test_name 'CODEMGMT-86 - C59265 - Attempt to Deploy Environment to Disk with Insufficient Free Space'
 
-if fact_on(master, 'osfamily') == 'RedHat' and fact_on(master, "operatingsystemmajrelease").to_i < 6
+if fact_on(master, 'os.family') == 'RedHat' and fact_on(master, "os.release.major").to_i < 6
   skip_test('This version of EL is not supported by this test case!')
 end
 

data/integration/tests/user_scenario/basic_workflow/single_env_10000_files.rb

@@ -3,7 +3,7 @@ require 'r10k_utils'
 require 'master_manipulator'
 test_name 'CODEMGMT-62 - C59239 - Single Environment with 10,000 Files'
 
-if fact_on(master, 'osfamily') == 'RedHat' and fact_on(master, "operatingsystemmajrelease").to_i < 6
+if fact_on(master, 'os.family') == 'RedHat' and fact_on(master, "os.release.major").to_i < 6
   skip_test('This version of EL is not supported by this test case!')
 end
 

data/integration/tests/user_scenario/basic_workflow/single_env_large_files.rb

@@ -3,7 +3,7 @@ require 'r10k_utils'
 require 'master_manipulator'
 test_name 'CODEMGMT-62 - C59242 - Single Environment with Large Binary Files'
 
-if fact_on(master, 'osfamily') == 'RedHat' and fact_on(master, "operatingsystemmajrelease").to_i < 6
+if fact_on(master, 'os.family') == 'RedHat' and fact_on(master, "os.release.major").to_i < 6
   skip_test('This version of EL is not supported by this test case!')
 end
 

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

@@ -45,6 +45,7 @@ module R10K
                 incremental: @incremental
               },
               modules: {
+                default_ref: settings.dig(:git, :default_ref),
                 exclude_spec: settings.dig(:deploy, :exclude_spec),
                 requested_modules: [],
                 deploy_modules: @modules,
@@ -53,8 +54,7 @@ module R10K
               },
               purging: {
                 purge_levels: settings.dig(:deploy, :purge_levels) || [],
-                purge_allowlist: read_purge_allowlist(settings.dig(:deploy, :purge_whitelist) || [],
-                                                      settings.dig(:deploy, :purge_allowlist) || [])
+                purge_allowlist: settings.dig(:deploy, :purge_allowlist) || []
               },
               forge: {
                 allow_puppetfile_override: settings.dig(:forge, :allow_puppetfile_override) || false
@@ -83,23 +83,6 @@ 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

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

@@ -39,6 +39,7 @@ module R10K
                 generate_types: @generate_types
               },
               modules: {
+                default_ref: settings.dig(:git, :default_ref),
                 exclude_spec: settings.dig(:deploy, :exclude_spec),
                 pool_size: @settings[:pool_size] || 4,
                 requested_modules: @argv.map.to_a,

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

@@ -9,12 +9,19 @@ module R10K
 
         def call
           options = { basedir: @root }
+          options[:overrides] = {}
+          options[:overrides][:modules] = { default_ref: @settings.dig(:git, :default_ref) }
           options[:moduledir] = @moduledir if @moduledir
           options[:puppetfile] = @puppetfile if @puppetfile
 
           loader = R10K::ModuleLoader::Puppetfile.new(**options)
           begin
             loader.load!
+            loader.modules.each do |mod|
+              if mod.instance_of?(R10K::Module::Git)
+                mod.validate_ref_defined
+              end
+            end
             $stderr.puts _("Syntax OK")
             true
           rescue => e

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

@@ -12,6 +12,7 @@ module R10K
         def call
           begin
             options = { basedir: @root, overrides: { force: @force || false } }
+            options[:overrides][:modules] = { default_ref: @settings.dig(:git, :default_ref) }
             options[:moduledir]  = @moduledir  if @moduledir
             options[:puppetfile] = @puppetfile if @puppetfile
             options[:module_exclude_regex] = @module_exclude_regex if @module_exclude_regex

data/lib/r10k/cli/deploy.rb

@@ -10,6 +10,19 @@ require 'cri'
 
 module R10K::CLI
   module Deploy
+
+    class TransformExcludeSpec
+      def call(input)
+        # To be backward compatible with the 3.x flag version of this setting,
+        # r10k allows this flag to have an optional argument. When no argument
+        # is supplied, cri defaults to setting the class to true, so we check
+        # for TrueClass here as well as "true".
+        return true if input == true || input == 'true'
+        return false if input == 'false'
+        raise ArgumentError
+      end
+    end
+
     def self.command
       @cmd ||= Cri::Command.define do
         name    'deploy'
@@ -24,7 +37,8 @@ module R10K::CLI
         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'
-        flag nil, :'exclude-spec', 'Exclude the module\'s spec dir from deployment'
+        option nil, :'exclude-spec', 'Exclude the module\'s spec dir for deployment', argument: :optional,
+                                                                                      transform: TransformExcludeSpec.new
         option nil, :'puppet-path', 'Path to puppet executable', argument: :required do |value, cmd|
           unless File.executable? value
             $stderr.puts "The specified puppet executable #{value} is not executable."

data/lib/r10k/environment.rb

@@ -31,7 +31,6 @@ module R10K
     require 'r10k/environment/base'
     require 'r10k/environment/with_modules'
     require 'r10k/environment/plain'
-    require 'r10k/environment/bare'
     require 'r10k/environment/git'
     require 'r10k/environment/svn'
     require 'r10k/environment/tarball'

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

@@ -119,7 +119,7 @@ class R10K::Git::Rugged::WorkingRepository < R10K::Git::Rugged::BaseRepository
     with_repo { |repo| repo.config['remote.origin.url'] }
   end
 
-  def dirty?(exclude_spec=false)
+  def dirty?(exclude_spec=true)
     with_repo do |repo|
       if exclude_spec
         diff = repo.diff_workdir('HEAD').select { |d| ! d.delta.old_file[:path].start_with?('spec/') }

data/lib/r10k/git/shellgit/working_repository.rb

@@ -90,7 +90,7 @@ class R10K::Git::ShellGit::WorkingRepository < R10K::Git::ShellGit::BaseReposito
   end
 
   # does the working tree have local modifications to tracked files?
-  def dirty?(exclude_spec=false)
+  def dirty?(exclude_spec=true)
     result = git(['diff-index', '--exit-code', '--name-only', 'HEAD'], :path => @path.to_s, :raise_on_fail => false)
 
     if result.exit_code != 0
@@ -101,7 +101,7 @@ class R10K::Git::ShellGit::WorkingRepository < R10K::Git::ShellGit::BaseReposito
         logger.debug(_("Found local modifications in %{file_path}" % {file_path: File.join(@path, file)}))
 
         # Do this in a block so that the extra subprocess only gets invoked when needed.
-        logger.debug1 { git(['diff-index', '-p', 'HEAD', file], :path => @path.to_s, :raise_on_fail => false).stdout }
+        logger.debug1 { git(['diff-index', '-p', 'HEAD', '--', file], :path => @path.to_s, :raise_on_fail => false).stdout }
       end
 
       return dirty_files.size > 0

data/lib/r10k/git/stateful_repository.rb

@@ -36,7 +36,7 @@ class R10K::Git::StatefulRepository
   end
 
   # Returns true if the sync actually updated the repo, false otherwise
-  def sync(ref, force=true, exclude_spec=false)
+  def sync(ref, force=true, exclude_spec=true)
     @cache.sync if sync_cache?(ref)
 
     sha = @cache.resolve(ref)
@@ -75,7 +75,7 @@ class R10K::Git::StatefulRepository
     updated
   end
 
-  def status(ref, exclude_spec=false)
+  def status(ref, exclude_spec=true)
     if !@repo.exist?
       :absent
     elsif !@cache.exist?

data/lib/r10k/module/base.rb

@@ -60,8 +60,8 @@ class R10K::Module::Base
     @environment = environment
     @overrides = args.delete(:overrides) || {}
     @spec_deletable = true
-    @exclude_spec = false
-    @exclude_spec = @overrides.dig(:modules, :exclude_spec) if @overrides.dig(:modules, :exclude_spec)
+    @exclude_spec = true
+    @exclude_spec = @overrides.dig(:modules, :exclude_spec) unless @overrides.dig(:modules, :exclude_spec).nil?
     if args.has_key?(:exclude_spec)
       logger.debug2 _("Overriding :exclude_spec setting with per module setting for #{@title}")
       @exclude_spec = args.delete(:exclude_spec)
@@ -78,7 +78,7 @@ class R10K::Module::Base
     path.to_s
   end
 
-  # Delete the spec dir if @exclude_spec has been set to true and @spec_deletable is also true
+  # Delete the spec dir if @exclude_spec is true and @spec_deletable is also true
   def maybe_delete_spec_dir
     if @exclude_spec
       if @spec_deletable

data/lib/r10k/module/git.rb

@@ -63,15 +63,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 +115,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 +154,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

@@ -175,13 +175,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

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.16.0'
+  VERSION = '4.0.1'
 end

data/locales/r10k.pot

@@ -6,11 +6,11 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: r10k 3.9.3-289-g2f5deb72\n"
+"Project-Id-Version: r10k 3.9.3-373-g117587fb\n"
 "\n"
 "Report-Msgid-Bugs-To: docs@puppetlabs.com\n"
-"POT-Creation-Date: 2023-06-27 17:39+0000\n"
-"PO-Revision-Date: 2023-06-27 17:39+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 ""
 
@@ -111,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 ""
@@ -327,7 +323,7 @@ msgstr ""
 msgid "Fetching remote '%{remote}' at %{path}"
 msgstr ""
 
-#: ../lib/r10k/git/rugged/working_repository.rb:129 ../lib/r10k/git/shellgit/working_repository.rb:101
+#: ../lib/r10k/git/rugged/working_repository.rb:131 ../lib/r10k/git/shellgit/working_repository.rb:101
 msgid "Found local modifications in %{file_path}"
 msgstr ""
 
@@ -407,7 +403,7 @@ msgstr ""
 msgid "The module %{title} does not exist on %{url}."
 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 ""
 
@@ -443,19 +439,15 @@ msgstr ""
 msgid "Ignoring Forge declaration in Puppetfile, using value from settings: %{forge}."
 msgstr ""
 
-#: ../lib/r10k/module_loader/puppetfile.rb:181
-msgid "\"basedir\" is deprecated. Please use \"environment_name\" instead. \"basedir\" will be removed in a future version."
-msgstr ""
-
-#: ../lib/r10k/module_loader/puppetfile.rb:200 ../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:242
+#: ../lib/r10k/module_loader/puppetfile.rb:235
 msgid "Puppetfiles cannot contain duplicate module names."
 msgstr ""
 
-#: ../lib/r10k/module_loader/puppetfile.rb:244
+#: ../lib/r10k/module_loader/puppetfile.rb:237
 msgid "Remove the duplicates of the following modules: %{dupes}"
 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,11 +28,9 @@ 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', '< 4.0.0']
+  s.add_dependency 'puppet_forge', '>= 4.1', '< 6'
 
-  s.add_dependency 'gettext-setup', ['>=0.24', '< 2.0.0']
-  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', '< 2.8.0'
   s.add_dependency 'minitar', '~> 0.9'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r10k
 version: !ruby/object:Gem::Version
-  version: 3.16.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Adrien Thebo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-26 00:00:00.000000000 Z
+date: 2023-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored2
@@ -72,20 +72,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '4.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '4.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: gettext-setup
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +95,7 @@ dependencies:
         version: '0.24'
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -105,47 +105,7 @@ dependencies:
         version: '0.24'
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
-- !ruby/object:Gem::Dependency
-  name: fast_gettext
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-- !ruby/object:Gem::Dependency
-  name: gettext
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.2
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 4.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.2
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
@@ -312,7 +272,7 @@ files:
 - integration/tests/i18n/deploy_module_with_unicode_in_file_name.rb
 - integration/tests/purging/content_not_purged_at_root.rb
 - integration/tests/purging/default_purging.rb
-- integration/tests/purging/does_not_purge_files_on_white_list.rb
+- integration/tests/purging/does_not_purge_files_on_allowlist.rb
 - integration/tests/user_scenario/basic_workflow/multi_env_1000_branches.rb
 - integration/tests/user_scenario/basic_workflow/multi_env_custom_forge_git_module.rb
 - integration/tests/user_scenario/basic_workflow/multi_env_custom_forge_git_module_static.rb
@@ -372,7 +332,6 @@ files:
 - lib/r10k/deployment.rb
 - lib/r10k/deployment/config.rb
 - lib/r10k/environment.rb
-- lib/r10k/environment/bare.rb
 - lib/r10k/environment/base.rb
 - lib/r10k/environment/git.rb
 - lib/r10k/environment/name.rb
@@ -480,7 +439,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/r10k/environment/bare.rb

@@ -1,13 +0,0 @@
-class R10K::Environment::Bare < R10K::Environment::Plain
-
-  R10K::Environment.register(:bare, self)
-
-  def initialize(name, basedir, dirname, options = {})
-    logger.warn _('"bare" environment type is deprecated; please use "plain" instead (environment: %{name})') % {name: name}
-    super
-  end
-
-  def signature
-    'bare-default'
-  end
-end