r10k 3.9.1 → 3.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b0d4cbdba06f37b9a34638e82ba32b424db49e8047fabff52a9e661e5970e68
-  data.tar.gz: f5ac5bd9da0ef5de33780482d89732cab382c01e3f636839224bb02b7e636b7f
+  metadata.gz: 34dc5753178d4777a6d36e6806515345b8b0e133807d46b21a9468de0325a1ed
+  data.tar.gz: 830085cca185bb00292af40f5cc13e8a46d00645a7bdc7f16e0d48b98ca4df23
 SHA512:
-  metadata.gz: 64e28d25bc71114d3b598376c2c5ee32d13d8ed998d50106fa1814defc8f463fac5dff1c57e5bafa1ef8b57d9f48d1e90b6460ee24a69de65759ff9b9a8c4722
-  data.tar.gz: 18caf3d9fff928ab9a3620daad375fabcb2a4ec5fbbf15f16a680d4ea4b724ce8cf3cb1cd2297d36bb81ca4384bfbbb85f1da71b219809a7f1ca1aa6aafb9f32
+  metadata.gz: 26e01c3ae5cdd4b4c873aa04d233dbe8fbe1f1f9fa193add5fe03aba50d1db09604fc117fd26190b7a1c350a7a64df9bdeba1b33ee0697d90420813075fe7811
+  data.tar.gz: 84c8c37b4daa9f11a864c54df12834d7bc920207f5f1219516d49583ff88537b7a13772a0c812d2bc9ebb4ebd636da4124dd35fbc105681e36db1aee4f540961

data/.github/workflows/rspec_tests.yml

@@ -15,7 +15,7 @@ jobs:
           - {os: ubuntu-18.04, ruby: 2.5}
           - {os: ubuntu-18.04, ruby: 2.6}
           - {os: ubuntu-18.04, ruby: 2.7}
-          - {os: ubuntu-18.04, ruby: jruby-9.2.9.0}
+          - {os: ubuntu-18.04, ruby: jruby-9.2.10.0}
           - {os: windows-2016, ruby: 2.5}
           - {os: windows-2016, ruby: 2.6}
           - {os: windows-2016, ruby: 2.7}

data/.travis.yml

@@ -10,18 +10,8 @@ jdk:
 before_install: gem install bundler -v '< 2' --no-document
 matrix:
   include:
-    - stage: r10k tests
-      rvm: 2.7.0
-    - stage: r10k tests
-      rvm: 2.6.5
-    - stage: r10k tests
-      rvm: 2.5.0
-    - stage: r10k tests
-      rvm: 2.4.0
     - stage: r10k tests
       rvm: 2.3.0
-    - stage: r10k tests
-      rvm: jruby
     - stage: r10k container tests
       dist: focal
       language: ruby

data/CHANGELOG.mkd

@@ -4,6 +4,34 @@ CHANGELOG
 Unreleased
 ----------
 
+3.11.0
+------
+
+- Always sync git cache on `ref: 'HEAD'` [#1182](https://github.com/puppetlabs/r10k/pull/1182)
+- (CODEMGMT-1421, CODEMGMT-1422, CODEMGMT-1457) Add setting `exclude_spec` to remove the spec dir from module deployment[#1189](https://github.com/puppetlabs/r10k/pull/1189)[#1198](https://github.com/puppetlabs/r10k/pull/1198)[#1204](https://github.com/puppetlabs/r10k/pull/1204)
+- (RK-369) Make module deploys run the postrun command if any environments were updated. [#982](https://github.com/puppetlabs/r10k/issues/982)
+- Add support for Github App auth token. This allows r10k to authenticate under strict SSO/2FA guidelines that cannot utilize machine users for code deployment. [#1180](https://github.com/puppetlabs/r10k/pull/1180)
+- Restore the ability to load a Puppetfile from a relative `basedir`. [#1202](https://github.com/puppetlabs/r10k/pull/1202), [#1203](https://github.com/puppetlabs/r10k/pull/1203)
+
+3.10.0
+------
+
+- Add `authorization_token` setting to allow authentication to a custom Forge server. [#1181](https://github.com/puppetlabs/r10k/pull/1181)
+- (RK-135) Attempting to download the latest version for a module that has no Forge releases will now issue a meaningful error. [#1177](https://github.com/puppetlabs/r10k/pull/1177)
+- Added an interface to R10K::Source::Base named `reload!` for updating the environments list for a given deployment; `reload!` is called before deployment purges to make r10k deploy pools more threadsafe. [#1172](https://github.com/puppetlabs/r10k/pull/1172)
+- Remove username and password from remote url in cache directory name [#1186](https://github.com/puppetlabs/r10k/pull/1186)
+- Purging efficiency is greatly improved. R10K will no longer recurse into directories that match recursive purge exclusions. This should significantly improve the deploy times for those users who enable the "environment" purge level. [#1178](https://github.com/puppetlabs/r10k/pull/1178)
+
+3.9.3
+-----
+
+- Fixes a regression when using `--default_branch_override` with Puppetfiles containing Forge modules. [#1173](https://github.com/puppetlabs/r10k/issues/1173)
+
+3.9.2
+-----
+
+- Makes the third parameter to R10K::Actions optional, restoring backwards compatability broken in 3.9.1.
+
 3.9.1
 -----
 

data/README.mkd

@@ -66,6 +66,12 @@ a git repository using Bundler for dependencies:
     bundle install
     bundle exec r10k help
 
+### Arch Linux
+
+Arch Linux provides a [system package](https://archlinux.org/packages/community/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).
+
 Usage
 -----
 

data/doc/dynamic-environments/configuration.mkd

@@ -165,9 +165,16 @@ interactions. See the global proxy setting documentation for more information an
 The 'baseurl' setting indicates where Forge modules should be installed from.
 This defaults to 'https://forgeapi.puppetlabs.com'
 
+#### authorization_token
+
+The 'authorization_token' setting allows you to provide a token for authenticating to a
+custom Forge server. When set, 'baseurl' must also be set.
+You will need to prepend your token with 'Bearer ' if using Artifactory as your Forge server.
+
 ```yaml
 forge:
   baseurl: 'https://private-forge.mysite'
+  authorization_token: 'Bearer mysupersecretauthtoken'
 ```
 
 Deployment options
@@ -336,6 +343,20 @@ deploy:
   puppet_conf: '/opt/puppet/conf/puppet.conf'
 ```
 
+#### exclude_spec
+
+During module deployment, r10k's default behavior is to deploy the spec directory.
+This behavior can be configured for all modules using the `exclude_spec` setting in the r10k config.
+This config setting can be overridden in each module definition in the Puppetfile
+or more globally via the CLI for deploys. The following example sets all modules to
+not deploy the spec dir.
+
+
+```yaml
+deploy:
+  exclude_spec: true
+```
+
 Source options
 --------------
 

data/doc/puppetfile.mkd

@@ -130,7 +130,8 @@ with a git commit, branch reference, or a tag.
 When a module is installed using `:tag` or `:commit`, r10k assumes that the
 given object is a tag or commit and can do some optimizations around fetching
 the object. If the tag or commit is already available r10k will skip network
-operations when updating the repo, which can speed up install times.
+operations when updating the repo, which can speed up install times. When
+`:ref` is set to track `HEAD`, it will synchronize the module on each run.
 
 Module versions can also be specified using `:branch` to track a specific
 branch reference.
@@ -312,6 +313,19 @@ module.
 For more information see the [FAQ entry](faq.mkd#how-do-i-prevent-r10k-from-removing-modules-in-the-modules-directory-of-my-git-repository)
 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
+Puppetfile can modify this per module, overriding settings from the default
+r10k config. The following example sets the module to not deploy the spec
+directory.
+
+```
+mod 'apache',
+  :git => 'git@github.com:puppetlabs/puppetlabs-apache.git',
+  :exclude_spec => true
+```
+
 ### Per-Item Install Path
 
 Git and SVN content types support installing into an alternate path without changing

data/integration/Rakefile

@@ -1,4 +1,5 @@
 require 'rototiller'
+require 'fileutils'
 
 namespace :ci do
   namespace :test do
@@ -59,13 +60,14 @@ end
 desc 'Generate a host configuration used by Beaker'
 rototiller_task :beaker_hostgenerator do |t|
   if ENV['BEAKER_HOST'].nil?
+    FileUtils.mkdir_p 'configs'
     t.add_command do |c|
       c.name = 'beaker-hostgenerator'
       c.argument = '> configs/generated'
     end
 
     # This is a hack :(
-    t.add_flag(:name => '', :default => 'centos6-64mdca-64.fa', :override_env => 'TEST_TARGET')
+    t.add_flag(:name => '', :default => 'centos7-64mdca-64.fa', :override_env => 'TEST_TARGET')
 
     t.add_flag(:name => '--global-config', :default => '{forge_host=forge-aio01-petest.puppetlabs.com}', :override_env => 'BHG_GLOBAL_CONFIG')
   end

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

@@ -10,7 +10,7 @@ last_commit = git_last_commit(master, git_environments_path)
 r10k_fqp = get_r10k_fqp(master)
 
 #Verification
-error_notification_regex = /Does 'puppetlabs-regret' have at least one published release?/
+error_notification_regex = /The module puppetlabs-regret does not appear to have any published releases/
 
 #File
 puppet_file = <<-PUPPETFILE
@@ -40,12 +40,6 @@ git_add_commit_push(master, 'production', 'Add module.', git_environments_path)
 
 #Tests
 step "Deploy production environment via r10k with specified module deleted"
-on(master, "#{r10k_fqp} deploy environment -p -v", :acceptable_exit_codes => 1) do |result|
-  if get_puppet_version(master) < 4.0
-    assert_match(error_notification_regex, result.stderr, 'Unexpected error was detected!')
-  else
-    expect_failure('expected to fail due to RK-135') do
-      assert_match(error_notification_regex, result.stderr, 'Unexpected error was detected!')
-    end
-  end
+on(master, "#{r10k_fqp} deploy environment -p -v --trace", :acceptable_exit_codes => 1) do |result|
+  assert_match(error_notification_regex, result.stderr, 'Unexpected error was detected!')
 end

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

@@ -1,12 +1,15 @@
 require 'git_utils'
 require 'r10k_utils'
 require 'master_manipulator'
-test_name 'CODEMGMT-73 - C63184 - Single Environment Purge Unmanaged Modules'
+test_name 'CODEMGMT-78 - Puppetfile Purge --puppetfile & --moduledir flag usage'
 
 #Init
 master_certname = on(master, puppet('config', 'print', 'certname')).stdout.rstrip
-git_environments_path = '/root/environments'
-last_commit = git_last_commit(master, git_environments_path)
+environments_path = on(master, puppet('config', 'print', 'environmentpath')).stdout.strip
+moduledir = File.join(environments_path, 'production', 'modules')
+puppetfile_path = File.join(environments_path, 'production', 'Puppetfile')
+git_remote_environments_path = '/root/environments'
+last_commit = git_last_commit(master, git_remote_environments_path)
 r10k_fqp = get_r10k_fqp(master)
 
 #Verification
@@ -14,14 +17,12 @@ motd_path = '/etc/motd'
 motd_contents = 'Hello!'
 motd_contents_regex = /\A#{motd_contents}\z/
 
-error_message_regex = /Blah/
-
 #File
-puppet_file = <<-PUPPETFILE
+puppetfile = <<-PUPPETFILE
 mod "puppetlabs/xinetd"
 PUPPETFILE
 
-puppet_file_path = File.join(git_environments_path, 'Puppetfile')
+remote_puppetfile_path = File.join(git_remote_environments_path, 'Puppetfile')
 
 #Manifest
 manifest = <<-MANIFEST
@@ -30,12 +31,12 @@ manifest = <<-MANIFEST
   }
 MANIFEST
 
-site_pp_path = File.join(git_environments_path, 'manifests', 'site.pp')
+remote_site_pp_path = File.join(git_remote_environments_path, 'manifests', 'site.pp')
 site_pp = create_site_pp(master_certname, manifest)
 
 #Teardown
 teardown do
-  clean_up_r10k(master, last_commit, git_environments_path)
+  clean_up_r10k(master, last_commit, git_remote_environments_path)
 
   step 'Remove "/etc/motd" File'
   on(agents, "rm -rf #{motd_path}")
@@ -46,27 +47,24 @@ step 'Stub Forge on Master'
 stub_forge_on(master)
 
 step 'Checkout "production" Branch'
-git_on(master, 'checkout production', git_environments_path)
-
-step 'Manually Install the "motd" Module from the Forge'
-on(master, puppet('module install puppetlabs-motd'))
+git_on(master, 'checkout production', git_remote_environments_path)
 
 step 'Create "Puppetfile" for the "production" Environment'
-create_remote_file(master, puppet_file_path, puppet_file)
+create_remote_file(master, remote_puppetfile_path, puppetfile)
 
 step 'Inject New "site.pp" to the "production" Environment'
-inject_site_pp(master, site_pp_path, site_pp)
+inject_site_pp(master, remote_site_pp_path, site_pp)
 
 step 'Push Changes'
-git_add_commit_push(master, 'production', 'Update site.pp and add module.', git_environments_path)
+git_add_commit_push(master, 'production', 'Update site.pp and add module.', git_remote_environments_path)
 
-#Tests
 step 'Deploy Environments via r10k'
-on(master, "#{r10k_fqp} deploy environment -v -p")
+on(master, "#{r10k_fqp} deploy environment --modules --verbose debug --trace")
 
-step 'Plug-in Sync Agents'
-on(agents, puppet("plugin download --server #{master}"))
+step 'Manually Install the "motd" Module from the Forge'
+on(master, puppet("module install puppetlabs-motd --modulepath #{moduledir}"))
 
+#Tests
 agents.each do |agent|
   step 'Run Puppet Agent Against "production" Environment'
   on(agent, puppet('agent', '--test', '--environment production'), :acceptable_exit_codes => 2) do |result|
@@ -80,14 +78,12 @@ agents.each do |agent|
 end
 
 step 'Use r10k to Purge Unmanaged Modules'
-on(master, "#{r10k_fqp} puppetfile purge -v", :acceptable_exit_codes => 1)
+on(master, "#{r10k_fqp} puppetfile purge --puppetfile #{puppetfile_path} --moduledir #{moduledir} --verbose debug --trace")
 
 #Agent will fail because r10k will purge the "motd" module
 agents.each do |agent|
   step 'Attempt to Run Puppet Agent'
-  on(agent, puppet('agent', '--test', '--environment production'), :acceptable_exit_codes => 0) do |result|
-    expect_failure('Expected to fail due to CODEMGMT-78') do
-      assert_match(error_message_regex, result.stderr, 'Expected error was not detected!')
-    end
+  on(agent, puppet('agent', '--test', '--environment production'), :acceptable_exit_codes => 1) do |result|
+    assert_match(/Could not find declared class motd/, result.stderr, 'Module was not purged')
   end
 end

data/integration/tests/user_scenario/complex_workflow/multi_env_add_change_remove.rb

@@ -24,7 +24,7 @@ stage_env_notify_message = 'This is a different message'
 stage_env_notify_message_regex = /#{stage_env_notify_message}/
 
 #Verification for "test" Environment
-test_env_error_message_regex = /Error:.*Could not.*environment '?test'?/
+test_env_message_regex = /Environment 'test' not found on server/
 
 #Verification for "temp" Environment
 test_env_notify_message_regex = /I am in the temp environment/
@@ -157,7 +157,7 @@ agents.each do |agent|
   end
 
   step 'Attempt to Run Puppet Agent Against "test" Environment'
-  on(agent, puppet('agent', '--test', '--environment test'), :acceptable_exit_codes => 1) do |result|
-    assert_match(test_env_error_message_regex, result.stderr, 'Expected error was not detected!')
+  on(agent, puppet('agent', '--test', '--environment test'), :acceptable_exit_codes => 2) do |result|
+    assert_match(test_env_message_regex, result.stdout, 'Expected message not found!')
   end
 end

data/integration/tests/user_scenario/complex_workflow/multi_env_remove_re-add.rb

@@ -15,7 +15,7 @@ initial_env_names = ['production', 'stage']
 
 #Verification
 notify_message_regex = /I am in the production environment/
-stage_env_error_message_regex = /Error:.*Could not.*environment '?stage'?/
+stage_env_message_regex = /Environment 'stage' not found on server/
 
 #Manifest
 site_pp_path = File.join(git_environments_path, 'manifests', 'site.pp')
@@ -83,8 +83,8 @@ agents.each do |agent|
   end
 
   step 'Attempt to Run Puppet Agent Against "stage" Environment'
-  on(agent, puppet('agent', '--test', '--environment stage'), :acceptable_exit_codes => 1) do |result|
-    assert_match(stage_env_error_message_regex, result.stderr, 'Expected error was not detected!')
+  on(agent, puppet('agent', '--test', '--environment stage'), :acceptable_exit_codes => 2) do |result|
+    assert_match(stage_env_message_regex, result.stdout, 'Expected message not found!')
   end
 end
 

data/integration/tests/user_scenario/complex_workflow/multi_env_unamanaged.rb

@@ -22,7 +22,7 @@ site_pp = create_site_pp(master_certname, '  include helloworld')
 notify_message_prod_env_regex = /I am in the production environment/
 notify_message_test_env_regex = /I am in the test environment/
 removal_message_test_env_regex = /Removing unmanaged path.*test/
-error_message_regex = /Could not retrieve (catalog from remote server|information from environment test)/
+missing_message_regex = /Environment 'test' not found on server/
 
 #Teardown
 teardown do
@@ -72,7 +72,7 @@ end
 
 agents.each do |agent|
   step 'Run Puppet Agent Against "test" Environment'
-  on(agent, puppet('agent', '--test', '--environment test'), :acceptable_exit_codes => 1) do |result|
-    assert_match(error_message_regex, result.stderr, 'Expected message not found!')
+  on(agent, puppet('agent', '--test', '--environment test'), :acceptable_exit_codes => 2) do |result|
+    assert_match(missing_message_regex, result.stdout, 'Expected message not found!')
   end
 end

data/lib/r10k/action/base.rb

@@ -13,11 +13,14 @@ module R10K
       # @param opts [Hash] A hash of options defined in #allowed_initialized_opts
       #   and managed by the SetOps mixin within the Action::Base class.
       #   Corresponds to the CLI flags and options.
-      # @param argv [CRI::ArgumentList] A list-like collection of the remaining
-      #   arguments to the CLI invocation (after removing flags and options).
+      # @param argv [Enumerable] Typically CRI::ArgumentList or Array. A list-like
+      #   collection of the remaining arguments to the CLI invocation (after
+      #   removing flags and options).
       # @param settings [Hash] A hash of configuration loaded from the relevant
       #   config (r10k.yaml).
-      def initialize(opts, argv, settings)
+      #
+      # @note All arguments will be required in the next major version
+      def initialize(opts, argv, settings = {})
         @opts = opts
         @argv = argv
         @settings = settings

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

@@ -12,11 +12,14 @@ module R10K
         # @param opts [Hash] A hash of options defined in #allowed_initialized_opts
         #   and managed by the SetOps mixin within the Action::Base class.
         #   Corresponds to the CLI flags and options.
-        # @param argv [CRI::ArgumentList] A list-like collection of the remaining
-        #   arguments to the CLI invocation (after removing flags and options).
+        # @param argv [Enumerable] Typically CRI::ArgumentList or Array. A list-like
+        #   collection of the remaining arguments to the CLI invocation (after
+        #   removing flags and options).
         # @param settings [Hash] A hash of configuration loaded from the relevant
         #   config (r10k.yaml).
-        def initialize(opts, argv, settings)
+        #
+        # @note All arguments will be required in the next major version
+        def initialize(opts, argv, settings = {})
           super
 
           @settings = @settings.merge({

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

@@ -22,11 +22,14 @@ module R10K
         # @param opts [Hash] A hash of options defined in #allowed_initialized_opts
         #   and managed by the SetOps mixin within the Action::Base class.
         #   Corresponds to the CLI flags and options.
-        # @param argv [CRI::ArgumentList] A list-like collection of the remaining
-        #   arguments to the CLI invocation (after removing flags and options).
+        # @param argv [Enumerable] Typically CRI::ArgumentList or Array. A list-like
+        #   collection of the remaining arguments to the CLI invocation (after
+        #   removing flags and options).
         # @param settings [Hash] A hash of configuration loaded from the relevant
         #   config (r10k.yaml).
-        def initialize(opts, argv, settings)
+        #
+        # @note All arguments will be required in the next major version
+        def initialize(opts, argv, settings = {})
           super
 
           # instance variables below are set by the super class based on the
@@ -41,6 +44,7 @@ module R10K
                 preload_environments: true
               },
               modules: {
+                exclude_spec: settings.dig(:deploy, :exclude_spec),
                 requested_modules: [],
                 deploy_modules: @modules,
                 force: !@no_force, # force here is used to make it easier to reason about
@@ -113,6 +117,9 @@ module R10K
 
           if @settings.dig(:overrides, :purging, :purge_levels).include?(:deployment)
             logger.debug("Purging unmanaged environments for deployment...")
+            deployment.sources.each do |source|
+              source.reload!
+            end
             deployment.purge!
           end
         ensure
@@ -231,12 +238,16 @@ module R10K
                       modules: :self,
                       cachedir: :self,
                       'no-force': :self,
+                      'exclude-spec': :self,
                       'generate-types': :self,
                       'puppet-path': :self,
                       'puppet-conf': :self,
                       'private-key': :self,
                       'oauth-token': :self,
-                      'default-branch-override': :self)
+                      'default-branch-override': :self,
+                      'github-app-id': :self,
+                      'github-app-key': :self,
+                      'github-app-ttl': :self)
         end
       end
     end