r10k 3.10.0 → 3.13.0

data/locales/r10k.pot

@@ -6,11 +6,11 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: r10k 3.9.3-10-gfedc81a\n"
+"Project-Id-Version: r10k 3.9.3-134-g9f93336f\n"
 "\n"
 "Report-Msgid-Bugs-To: docs@puppetlabs.com\n"
-"POT-Creation-Date: 2021-07-07 21:13+0000\n"
-"PO-Revision-Date: 2021-07-07 21:13+0000\n"
+"POT-Creation-Date: 2021-10-25 18:18+0000\n"
+"PO-Revision-Date: 2021-10-25 18:18+0000\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
 "Language: \n"
@@ -19,71 +19,83 @@ msgstr ""
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\n"
 
-#: ../lib/r10k/action/deploy/deploy_helpers.rb:12 ../lib/r10k/settings/loader.rb:63
+#: ../lib/r10k/action/deploy/deploy_helpers.rb:16 ../lib/r10k/settings/loader.rb:63
 msgid "No configuration file given, no config file found in current directory, and no global config present"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/deploy_helpers.rb:26
+#: ../lib/r10k/action/deploy/deploy_helpers.rb:30
 msgid "Making changes to deployed environments has been administratively disabled."
 msgstr ""
 
-#: ../lib/r10k/action/deploy/deploy_helpers.rb:27
+#: ../lib/r10k/action/deploy/deploy_helpers.rb:31
 msgid "Reason: %{write_lock}"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/environment.rb:112
+#: ../lib/r10k/action/deploy/environment.rb:116
 msgid "Environment(s) \\'%{environments}\\' cannot be found in any source and will not be deployed."
 msgstr ""
 
-#: ../lib/r10k/action/deploy/environment.rb:145
+#: ../lib/r10k/action/deploy/environment.rb:136
+msgid "Executing postrun command."
+msgstr ""
+
+#: ../lib/r10k/action/deploy/environment.rb:150
 msgid "Environment %{env_dir} does not match environment name filter, skipping"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/environment.rb:153
+#: ../lib/r10k/action/deploy/environment.rb:158
 msgid "Deploying environment %{env_path}"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/environment.rb:156
+#: ../lib/r10k/action/deploy/environment.rb:161
 msgid "Environment %{env_dir} is now at %{env_signature}"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/environment.rb:160
+#: ../lib/r10k/action/deploy/environment.rb:165
 msgid "Environment %{env_dir} is new, updating all modules"
 msgstr ""
 
 #: ../lib/r10k/action/deploy/module.rb:81
+msgid "Running postrun command for environments: %{envs_to_run}."
+msgstr ""
+
+#: ../lib/r10k/action/deploy/module.rb:91
+msgid "No environments were modified, not executing postrun command."
+msgstr ""
+
+#: ../lib/r10k/action/deploy/module.rb:103
 msgid "Only updating modules in environment(s) %{opt_env} skipping environment %{env_path}"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/module.rb:83
+#: ../lib/r10k/action/deploy/module.rb:105
 msgid "Updating modules %{modules} in environment %{env_path}"
 msgstr ""
 
-#: ../lib/r10k/action/puppetfile/check.rb:16
+#: ../lib/r10k/action/puppetfile/check.rb:18
 msgid "Syntax OK"
 msgstr ""
 
-#: ../lib/r10k/action/runner.rb:54 ../lib/r10k/deployment/config.rb:42
+#: ../lib/r10k/action/runner.rb:57 ../lib/r10k/deployment/config.rb:42
 msgid "Overriding config file setting '%{key}': '%{old_val}' -> '%{new_val}'"
 msgstr ""
 
-#: ../lib/r10k/action/runner.rb:91
+#: ../lib/r10k/action/runner.rb:99
 msgid "Reading configuration from %{config_path}"
 msgstr ""
 
-#: ../lib/r10k/action/runner.rb:94
+#: ../lib/r10k/action/runner.rb:102
 msgid "No config file explicitly given and no default config file could be found, default settings will be used."
 msgstr ""
 
-#: ../lib/r10k/content_synchronizer.rb:27
+#: ../lib/r10k/content_synchronizer.rb:33
 msgid "Updating modules with %{pool_size} threads"
 msgstr ""
 
-#: ../lib/r10k/content_synchronizer.rb:37
+#: ../lib/r10k/content_synchronizer.rb:46
 msgid "Error during concurrent deploy of a module: %{message}"
 msgstr ""
 
-#: ../lib/r10k/content_synchronizer.rb:75
+#: ../lib/r10k/content_synchronizer.rb:87
 msgid "Module thread %{id} exiting: %{message}"
 msgstr ""
 
@@ -95,7 +107,11 @@ msgstr ""
 msgid "Unable to load sources; the supplied configuration does not define the 'sources' key"
 msgstr ""
 
-#: ../lib/r10k/environment/base.rb:68 ../lib/r10k/environment/base.rb:84 ../lib/r10k/environment/base.rb:93 ../lib/r10k/source/base.rb:83
+#: ../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 ""
 
@@ -103,15 +119,15 @@ msgstr ""
 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:57
+#: ../lib/r10k/environment/with_modules.rb:60
 msgid "Environment and %{src} both define the \"%{name}\" module"
 msgstr ""
 
-#: ../lib/r10k/environment/with_modules.rb:58
+#: ../lib/r10k/environment/with_modules.rb:61
 msgid "#{msg_error}. The %{src} definition will be ignored"
 msgstr ""
 
-#: ../lib/r10k/environment/with_modules.rb:68
+#: ../lib/r10k/environment/with_modules.rb:71
 msgid "Unexpected value for `module_conflicts` setting in %{env} environment: %{val}"
 msgstr ""
 
@@ -207,54 +223,106 @@ msgstr ""
 msgid "Rugged versions prior to 0.24.0 do not support pruning stale branches during fetch, please upgrade your \\'rugged\\' gem. (Current version is: %{version})"
 msgstr ""
 
-#: ../lib/r10k/git/rugged/credentials.rb:24
+#: ../lib/r10k/git/rugged/credentials.rb:28
 msgid "Authentication failed for Git remote %{url}."
 msgstr ""
 
-#: ../lib/r10k/git/rugged/credentials.rb:48
+#: ../lib/r10k/git/rugged/credentials.rb:52
 msgid "Using per-repository private key %{key} for URL %{url}"
 msgstr ""
 
-#: ../lib/r10k/git/rugged/credentials.rb:51
+#: ../lib/r10k/git/rugged/credentials.rb:55
 msgid "URL %{url} has no per-repository private key using '%{key}'."
 msgstr ""
 
-#: ../lib/r10k/git/rugged/credentials.rb:53
+#: ../lib/r10k/git/rugged/credentials.rb:57
 msgid "Git remote %{url} uses the SSH protocol but no private key was given"
 msgstr ""
 
-#: ../lib/r10k/git/rugged/credentials.rb:57
+#: ../lib/r10k/git/rugged/credentials.rb:61
 msgid "Unable to use SSH key auth for %{url}: private key %{private_key} is missing or unreadable"
 msgstr ""
 
-#: ../lib/r10k/git/rugged/credentials.rb:84
+#: ../lib/r10k/git/rugged/credentials.rb:102
 msgid "Using OAuth token from stdin for URL %{url}"
 msgstr ""
 
-#: ../lib/r10k/git/rugged/credentials.rb:87
+#: ../lib/r10k/git/rugged/credentials.rb:105
 msgid "Using OAuth token from %{token_path} for URL %{url}"
 msgstr ""
 
-#: ../lib/r10k/git/rugged/credentials.rb:89
+#: ../lib/r10k/git/rugged/credentials.rb:107
 msgid "%{path} is missing or unreadable, cannot load OAuth token"
 msgstr ""
 
-#: ../lib/r10k/git/rugged/credentials.rb:93
+#: ../lib/r10k/git/rugged/credentials.rb:111
 msgid "Supplied OAuth token contains invalid characters."
 msgstr ""
 
-#: ../lib/r10k/git/rugged/credentials.rb:117
+#: ../lib/r10k/git/rugged/credentials.rb:135
 msgid "URL %{url} includes the username %{username}, using that user for authentication."
 msgstr ""
 
-#: ../lib/r10k/git/rugged/credentials.rb:120
+#: ../lib/r10k/git/rugged/credentials.rb:138
 msgid "URL %{url} did not specify a user, using %{user} from configuration"
 msgstr ""
 
-#: ../lib/r10k/git/rugged/credentials.rb:123
+#: ../lib/r10k/git/rugged/credentials.rb:141
 msgid "URL %{url} did not specify a user, using current user %{user}"
 msgstr ""
 
+#: ../lib/r10k/git/rugged/credentials.rb:148
+msgid "Github App id contains invalid characters."
+msgstr ""
+
+#: ../lib/r10k/git/rugged/credentials.rb:149
+msgid "Github App token ttl contains invalid characters."
+msgstr ""
+
+#: ../lib/r10k/git/rugged/credentials.rb:150
+msgid "Github App key is missing or unreadable"
+msgstr ""
+
+#: ../lib/r10k/git/rugged/credentials.rb:155
+msgid "Github App key is not a valid SSL private key"
+msgstr ""
+
+#: ../lib/r10k/git/rugged/credentials.rb:158
+msgid "Github App key is not a valid SSL key"
+msgstr ""
+
+#: ../lib/r10k/git/rugged/credentials.rb:161
+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 ""
+
+#: ../lib/r10k/git/rugged/credentials.rb:202
+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
 msgid "Updated repo %{path} to include alternate object db path %{objects_dir}"
 msgstr ""
@@ -271,31 +339,31 @@ msgstr ""
 msgid "Found local modifications in %{file_path}"
 msgstr ""
 
-#: ../lib/r10k/git/stateful_repository.rb:44
+#: ../lib/r10k/git/stateful_repository.rb:45
 msgid "Unable to sync repo to unresolvable ref '%{ref}'"
 msgstr ""
 
-#: ../lib/r10k/git/stateful_repository.rb:51
+#: ../lib/r10k/git/stateful_repository.rb:53
 msgid "Cloning %{repo_path} and checking out %{ref}"
 msgstr ""
 
-#: ../lib/r10k/git/stateful_repository.rb:54
+#: ../lib/r10k/git/stateful_repository.rb:56
 msgid "Replacing %{repo_path} and checking out %{ref}"
 msgstr ""
 
-#: ../lib/r10k/git/stateful_repository.rb:58 ../lib/r10k/git/stateful_repository.rb:63
+#: ../lib/r10k/git/stateful_repository.rb:60 ../lib/r10k/git/stateful_repository.rb:65
 msgid "Updating %{repo_path} to %{ref}"
 msgstr ""
 
-#: ../lib/r10k/git/stateful_repository.rb:62
+#: ../lib/r10k/git/stateful_repository.rb:64
 msgid "Overwriting local modifications to %{repo_path}"
 msgstr ""
 
-#: ../lib/r10k/git/stateful_repository.rb:66
+#: ../lib/r10k/git/stateful_repository.rb:68
 msgid "Skipping %{repo_path} due to local modifications"
 msgstr ""
 
-#: ../lib/r10k/git/stateful_repository.rb:69
+#: ../lib/r10k/git/stateful_repository.rb:72
 msgid "%{repo_path} is already at Git ref %{ref}"
 msgstr ""
 
@@ -315,39 +383,55 @@ msgstr ""
 msgid "Invalid log level '%{val}'. Valid levels are %{log_levels}"
 msgstr ""
 
-#: ../lib/r10k/module.rb:29
+#: ../lib/r10k/module.rb:45
 msgid "Module %{name} with args %{args} doesn't have an implementation. (Are you using the right arguments?)"
 msgstr ""
 
-#: ../lib/r10k/module/base.rb:75
+#: ../lib/r10k/module/base.rb:83
+msgid "Spec dir for #{@title} will not be deleted because it is not in the moduledir"
+msgstr ""
+
+#: ../lib/r10k/module/base.rb:95
+msgid "Deleting spec data at #{spec_path}"
+msgstr ""
+
+#: ../lib/r10k/module/base.rb:103
+msgid "No spec dir detected at #{spec_path}, skipping deletion"
+msgstr ""
+
+#: ../lib/r10k/module/base.rb:116
 msgid "Deploying module to %{path}"
 msgstr ""
 
-#: ../lib/r10k/module/base.rb:78
+#: ../lib/r10k/module/base.rb:119
 msgid "Only updating modules %{modules}, skipping module %{name}"
 msgstr ""
 
-#: ../lib/r10k/module/base.rb:134
+#: ../lib/r10k/module/base.rb:175
 msgid "Module name (%{title}) must match either 'modulename' or 'owner/modulename'"
 msgstr ""
 
-#: ../lib/r10k/module/forge.rb:89
+#: ../lib/r10k/module/definition.rb:28
+msgid "Not updating module %{name}, assuming content unchanged"
+msgstr ""
+
+#: ../lib/r10k/module/forge.rb:98
 msgid "The module %{title} does not appear to have any published releases, cannot determine latest version."
 msgstr ""
 
-#: ../lib/r10k/module/forge.rb:92 ../lib/r10k/module/forge.rb:121
+#: ../lib/r10k/module/forge.rb:101 ../lib/r10k/module/forge.rb:130
 msgid "The module %{title} does not exist on %{url}."
 msgstr ""
 
-#: ../lib/r10k/module/forge.rb:196
+#: ../lib/r10k/module/forge.rb:205
 msgid "Forge module names must match 'owner/modulename', instead got #{title}"
 msgstr ""
 
-#: ../lib/r10k/module/git.rb:66
+#: ../lib/r10k/module/git.rb:81
 msgid "Cannot track control repo branch for content '%{name}' when not part of a git-backed environment, will use default if available."
 msgstr ""
 
-#: ../lib/r10k/module/local.rb:35
+#: ../lib/r10k/module/local.rb:37
 msgid "Module %{title} is a local module, always indicating synced."
 msgstr ""
 
@@ -355,27 +439,43 @@ msgstr ""
 msgid "Could not read metadata.json"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:73
+#: ../lib/r10k/module_loader/puppetfile.rb:62
 msgid "Using Puppetfile '%{puppetfile}'"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:87
-msgid "Puppetfile %{path} missing or unreadable"
+#: ../lib/r10k/module_loader/puppetfile.rb:63
+msgid "Using moduledir '%{moduledir}'"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:100
+#: ../lib/r10k/module_loader/puppetfile.rb:84
 msgid "Failed to evaluate %{path}"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:114
+#: ../lib/r10k/module_loader/puppetfile.rb:101
+msgid "Unable to preload Puppetfile because of %{msg}"
+msgstr ""
+
+#: ../lib/r10k/module_loader/puppetfile.rb:119
+msgid "Using Forge from Puppetfile: %{forge}"
+msgstr ""
+
+#: ../lib/r10k/module_loader/puppetfile.rb:122
+msgid "Ignoring Forge declaration in Puppetfile, using value from settings: %{forge}."
+msgstr ""
+
+#: ../lib/r10k/module_loader/puppetfile.rb:183 ../lib/r10k/puppetfile.rb:104
+msgid "Puppetfile %{path} missing or unreadable"
+msgstr ""
+
+#: ../lib/r10k/module_loader/puppetfile.rb:219
 msgid "Puppetfiles cannot contain duplicate module names."
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:116
+#: ../lib/r10k/module_loader/puppetfile.rb:221
 msgid "Remove the duplicates of the following modules: %{dupes}"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:285
+#: ../lib/r10k/module_loader/puppetfile/dsl.rb:37
 msgid "unrecognized declaration '%{method}'"
 msgstr ""
 
@@ -522,45 +622,45 @@ msgstr ""
 msgid "pe_license feature is not available, PE only Puppet modules will not be downloadable."
 msgstr ""
 
-#: ../lib/r10k/util/purgeable.rb:87
+#: ../lib/r10k/util/purgeable.rb:91
 msgid "Not purging %{path} due to internal exclusion match: %{exclusion_match}"
 msgstr ""
 
-#: ../lib/r10k/util/purgeable.rb:89
+#: ../lib/r10k/util/purgeable.rb:93
 msgid "Not purging %{path} due to whitelist match: %{allowlist_match}"
 msgstr ""
 
-#: ../lib/r10k/util/purgeable.rb:133
+#: ../lib/r10k/util/purgeable.rb:137
 msgid "No unmanaged contents in %{managed_dirs}, nothing to purge"
 msgstr ""
 
-#: ../lib/r10k/util/purgeable.rb:138
+#: ../lib/r10k/util/purgeable.rb:142
 msgid "Removing unmanaged path %{path}"
 msgstr ""
 
-#: ../lib/r10k/util/purgeable.rb:143
+#: ../lib/r10k/util/purgeable.rb:147
 msgid "Unable to remove unmanaged path: %{path}"
 msgstr ""
 
-#: ../lib/r10k/util/setopts.rb:58
+#: ../lib/r10k/util/setopts.rb:60
 msgid "%{class_name} parameters '%{a}' and '%{b}' conflict. Specify one or the other, but not both"
 msgstr ""
 
-#: ../lib/r10k/util/setopts.rb:65
+#: ../lib/r10k/util/setopts.rb:67
 msgid "%{class_name} cannot handle option '%{key}'"
 msgstr ""
 
-#: ../lib/r10k/util/subprocess.rb:69
+#: ../lib/r10k/util/subprocess.rb:70
 msgid "Starting process: %{args}"
 msgstr ""
 
-#: ../lib/r10k/util/subprocess.rb:74
+#: ../lib/r10k/util/subprocess.rb:75
 msgid ""
 "Finished process:\n"
 "%{result}"
 msgstr ""
 
-#: ../lib/r10k/util/subprocess.rb:77
+#: ../lib/r10k/util/subprocess.rb:78
 msgid "Command exited with non-zero exit code"
 msgstr ""
 

data/r10k.gemspec

@@ -36,6 +36,8 @@ Gem::Specification.new do |s|
   s.add_dependency 'fast_gettext', '~> 1.1.0'
   s.add_dependency 'gettext', ['>= 3.0.2', '< 3.3.0']
 
+  s.add_dependency 'jwt', '~> 2.2.3'
+
   s.add_development_dependency 'rspec', '~> 3.1'
 
   s.add_development_dependency 'rake'

data/r10k.yaml.example

@@ -110,3 +110,31 @@ forge:
   # The 'baseurl' setting indicates where Forge modules should be installed
   # from. This defaults to 'https://forgeapi.puppetlabs.com'
   #baseurl: 'https://forgemirror.example.com'
+
+# Configuration options on how R10k should log its actions
+logging:
+  # The 'level' setting sets the default log level to run R10k actions at.
+  # This value will be overridden by any value set through the command line.
+  #level: warn
+
+  # Specify additional log outputs here, any log4r outputter can be used.
+  # If no log level is specified then the output will use the global level.
+  #outputs:
+  # - type: file
+  #   level: debug
+  #   parameters:
+  #     filename: /var/log/r10k.log
+  #     trunc: true
+  # - type: syslog
+  # - type: email
+  #   only_at: [fatal]
+  #   parameters:
+  #     from: r10k@example.com
+  #     to: sysadmins@example.com
+  #     server: smtp.example.com
+  #     subject: Fatal R10k error occurred
+
+  # The 'disable_default_stderr' setting specifies if the default output on
+  # stderr should be active or not, in case R10k is to be run entirely
+  # through scripts or cronjobs where console output is unwelcome.
+  #disable_default_stderr: false

data/spec/fixtures/unit/action/r10k_logging.yaml

@@ -0,0 +1,12 @@
+---
+  logging:
+    level: FATAL
+
+    outputs:
+      - type: file
+        parameters:
+          filename: r10k.log
+
+      - type: syslog
+
+    disable_default_stderr: true

data/spec/fixtures/unit/puppetfile/forge-override/Puppetfile

@@ -0,0 +1,8 @@
+forge "my.custom.forge.com"
+
+mod "puppetlabs/stdlib", '4.12.0'
+mod "puppetlabs/concat", '2.1.0'
+
+mod 'apache',
+  :git    => 'https://github.com/puppetlabs/puppetlabs-apache',
+  :branch => 'docs_experiment'

data/spec/fixtures/unit/puppetfile/various-modules/Puppetfile

@@ -0,0 +1,10 @@
+mod 'puppetlabs/apt', '2.1.1'
+mod 'puppetlabs/stdlib', :latest
+mod 'puppetlabs/concat'
+mod 'puppetlabs/rpm', '2.1.1-pre1'
+mod 'foo', git: 'this/remote', branch: 'main'
+mod 'bar', git: 'this/remote', tag: 'v1.2.3'
+mod 'baz', git: 'this/remote', commit: '123abc456'
+mod 'fizz', git: 'this/remote', ref: '1234567890abcdef1234567890abcdef12345678'
+mod 'buzz', git: 'this/remote', ref: 'refs/heads/main'
+mod 'canary', local: true

data/spec/fixtures/unit/puppetfile/various-modules/Puppetfile.new

@@ -0,0 +1,10 @@
+mod 'puppetlabs/apt', '3.0.0'
+mod 'puppetlabs/stdlib', :latest
+mod 'puppetlabs/concat'
+mod 'puppetlabs/rpm', '2.1.1-pre1'
+mod 'foo', git: 'this/remote', branch: 'main'
+mod 'bar', git: 'this/remote', tag: 'v1.2.3'
+mod 'baz', git: 'this/remote', commit: '123abc456'
+mod 'fizz', git: 'this/remote', ref: '1234567890abcdef1234567890abcdef12345678'
+mod 'buzz', git: 'this/remote', ref: 'refs/heads/main'
+mod 'canary', local: true

data/spec/fixtures/unit/util/purgeable/managed_one/managed_subdir_1/managed_symlink_file

@@ -0,0 +1 @@
+../expected_1

data/spec/fixtures/unit/util/purgeable/managed_one/managed_subdir_1/unmanaged_symlink_dir

@@ -0,0 +1 @@
+../../managed_two

data/spec/fixtures/unit/util/purgeable/managed_one/managed_symlink_dir

@@ -0,0 +1 @@
+spec/fixtures/unit/util/purgeable/managed_one/managed_subdir_1

data/spec/fixtures/unit/util/purgeable/managed_one/unmanaged_symlink_file

@@ -0,0 +1 @@
+spec/fixtures/unit/util/purgeable/managed_one/expected_1

data/spec/integration/util/purageable_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'r10k/util/purgeable'
+require 'r10k/util/cleaner'
+
+require 'tmpdir'
+
+RSpec.describe R10K::Util::Purgeable do
+  it 'purges only unmanaged files' do
+    Dir.mktmpdir do |envdir|
+      managed_directory = "#{envdir}/managed_one"
+      desired_contents = [
+        "#{managed_directory}/expected_1",
+        "#{managed_directory}/managed_subdir_1",
+        "#{managed_directory}/managed_symlink_dir",
+        "#{managed_directory}/managed_subdir_1/subdir_expected_1",
+        "#{managed_directory}/managed_subdir_1/managed_symlink_file",
+      ]
+
+      FileUtils.cp_r('spec/fixtures/unit/util/purgeable/managed_one/',
+                     managed_directory)
+
+      cleaner = R10K::Util::Cleaner.new([managed_directory], desired_contents)
+
+      cleaner.purge!({ recurse: true, whitelist: ["**/subdir_allowlisted_2"] })
+
+      # Files present after purge
+      expect(File.exist?("#{managed_directory}/expected_1")).to be true
+      expect(File.exist?("#{managed_directory}/managed_subdir_1")).to be true
+      expect(File.exist?("#{managed_directory}/managed_symlink_dir")).to be true
+      expect(File.exist?("#{managed_directory}/managed_subdir_1/subdir_expected_1")).to be true
+      expect(File.exist?("#{managed_directory}/managed_subdir_1/managed_symlink_file")).to be true
+      expect(File.exist?("#{managed_directory}/managed_subdir_1/subdir_allowlisted_2")).to be true
+
+      # Purged files
+      expect(File.exist?("#{managed_directory}/unmanaged_1")).to be false
+      expect(File.exist?("#{managed_directory}/managed_subdir_1/unmanaged_symlink_dir")).to be false
+      expect(File.exist?("#{managed_directory}/unmanaged_symlink_file")).to be false
+      expect(File.exist?("#{managed_directory}/managed_subdir_1/subdir_unmanaged_1")).to be false
+    end
+  end
+end

data/spec/r10k-mocks/mock_env.rb

@@ -1,6 +1,9 @@
 require 'r10k/environment'
+require 'r10k/util/purgeable'
 
 class R10K::Environment::Mock < R10K::Environment::Base
+  include R10K::Util::Purgeable
+
   def sync
     "synced"
   end

data/spec/r10k-mocks/mock_source.rb

@@ -5,9 +5,13 @@ class R10K::Source::Mock < R10K::Source::Base
   R10K::Source.register(:mock, self)
 
   def environments
-    corrected_environment_names = @options[:environments].map do |env|
-      R10K::Environment::Name.new(env, :prefix => @prefix, :invalid => 'correct_and_warn')
+    if @_environments.nil?
+      corrected_environment_names = @options[:environments].map do |env|
+        R10K::Environment::Name.new(env, :prefix => @prefix, :invalid => 'correct_and_warn')
+      end
+      @_environments = corrected_environment_names.map { |env| R10K::Environment::Mock.new(env.name, @basedir, env.dirname, { overrides: @options[:overrides] }) }
     end
-    corrected_environment_names.map { |env| R10K::Environment::Mock.new(env.name, @basedir, env.dirname, { overrides: @options[:overrides] }) }
+
+    @_environments
   end
 end