r10k 3.9.2 → 3.12.0

data/lib/r10k/source/git.rb

@@ -93,6 +93,11 @@ class R10K::Source::Git < R10K::Source::Base
     end
   end
 
+  def reload!
+    @cache.sync!
+    @environments = generate_environments()
+  end
+
   def generate_environments
     envs = []
     branch_names.each do |bn|

data/lib/r10k/source/svn.rb

@@ -65,6 +65,10 @@ class R10K::Source::SVN < R10K::Source::Base
     @ignore_branch_prefixes = options[:ignore_branch_prefixes]
   end
 
+  def reload!
+    @environments = generate_environments()
+  end
+
   # Enumerate the environments associated with this SVN source.
   #
   # @return [Array<R10K::Environment::SVN>] An array of environments created

data/lib/r10k/util/purgeable.rb

@@ -9,6 +9,12 @@ module R10K
     #   {#desired_contents}
     module Purgeable
 
+      HIDDEN_FILE = /\.[^.]+/
+
+      FN_MATCH_OPTS = File::FNM_PATHNAME | File::FNM_DOTMATCH
+
+      # @deprecated
+      #
       # @!method logger
       #   @abstract Including classes must provide a logger method
       #   @return [Log4r::Logger]
@@ -38,23 +44,79 @@ module R10K
         end
       end
 
+      # @deprecated Unused helper function
+      #
       # @return [Array<String>] Directory contents that are expected but not present
       def pending_contents(recurse)
         desired_contents - current_contents(recurse)
       end
 
+      def matches?(test, path)
+        if test == path
+          true
+        elsif File.fnmatch?(test, path, FN_MATCH_OPTS)
+          true
+        else
+          false
+        end
+      end
+
+      # A method to collect potentially purgeable content without searching into
+      # ignored directories when recursively searching.
+      #
+      # @param dir [String, Pathname] The directory to search for purgeable content
+      # @param exclusion_gobs [Array<String>] A list of file paths or File globs
+      #     to exclude from recursion (These are generated by the classes that
+      #     mix this module into them and are typically programatically generated)
+      # @param allowed_gobs [Array<String>] A list of file paths or File globs to exclude
+      #     from recursion (These are passed in by the caller of purge! and typically
+      #     are user supplied configuration values)
+      # @param desireds_not_to_recurse_into [Array<String>] A list of file paths not to
+      #     recurse into. These are programatically generated, these exist to maintain
+      #     backwards compatibility with previous implementations that used File.globs
+      #     for "recursion", ie "**/{*,.[^.]*}" which would not recurse into dot directories.
+      # @param recurse [Boolean] Whether or not to recurse into child directories that do
+      #     not match other filters.
+      #
+      # @return [Array<String>] Contents which may be purged.
+      def potentially_purgeable(dir, exclusion_globs, allowed_globs, desireds_not_to_recurse_into, recurse)
+        children = Pathname.new(dir).children.reject do |path|
+          path = path.to_s
+
+          if exclusion_match = exclusion_globs.find { |exclusion| matches?(exclusion, path) }
+            logger.debug2 _("Not purging %{path} due to internal exclusion match: %{exclusion_match}") % {path: path, exclusion_match: exclusion_match}
+          elsif allowlist_match = allowed_globs.find { |allowed| matches?(allowed, path) }
+            logger.debug _("Not purging %{path} due to whitelist match: %{allowlist_match}") % {path: path, allowlist_match: allowlist_match}
+          else
+            desired_match = desireds_not_to_recurse_into.grep(path).first
+          end
+
+          !!exclusion_match || !!allowlist_match || !!desired_match
+        end
+
+        children.flat_map do |child|
+          if File.directory?(child) && recurse
+            potentially_purgeable(child, exclusion_globs, allowed_globs, desireds_not_to_recurse_into, recurse)
+          else
+            child.to_s
+          end
+        end
+      end
+
       # @return [Array<String>] Directory contents that are present but not expected
       def stale_contents(recurse, exclusions, whitelist)
-        fn_match_opts = File::FNM_PATHNAME | File::FNM_DOTMATCH
+        dirs = self.managed_directories
+        desireds = self.desired_contents
+        hidden_desireds, regular_desireds = desireds.partition do |desired|
+          HIDDEN_FILE.match(File.basename(desired))
+        end
 
-        (current_contents(recurse) - desired_contents).reject do |item|
-          if exclusion_match = exclusions.find { |ex_item| (ex_item == item) || File.fnmatch?(ex_item, item, fn_match_opts) }
-            logger.debug2 _("Not purging %{item} due to internal exclusion match: %{exclusion_match}") % {item: item, exclusion_match: exclusion_match}
-          elsif whitelist_match = whitelist.find { |wl_item| (wl_item == item) || File.fnmatch?(wl_item, item, fn_match_opts) }
-            logger.debug _("Not purging %{item} due to whitelist match: %{whitelist_match}") % {item: item, whitelist_match: whitelist_match}
-          end
+        initial_purgelist = dirs.flat_map do |dir|
+          potentially_purgeable(dir, exclusions, whitelist, hidden_desireds, recurse)
+        end
 
-          !!exclusion_match || !!whitelist_match
+        initial_purgelist.reject do |path|
+          regular_desireds.any? { |desired| matches?(desired, path) }
         end
       end
 

data/lib/r10k/version.rb

@@ -2,5 +2,5 @@ module R10K
   # When updating to a new major (X) or minor (Y) version, include `#major` or
   # `#minor` (respectively) in your commit message to trigger the appropriate
   # release. Otherwise, a new patch (Z) version will be released.
-  VERSION = '3.9.2'
+  VERSION = '3.12.0'
 end

data/locales/r10k.pot

@@ -6,11 +6,11 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: r10k 3.4.1-231-g5574915\n"
+"Project-Id-Version: r10k 3.9.3-110-gfe65c736\n"
 "\n"
 "Report-Msgid-Bugs-To: docs@puppetlabs.com\n"
-"POT-Creation-Date: 2021-05-10 23:18+0000\n"
-"PO-Revision-Date: 2021-05-10 23:18+0000\n"
+"POT-Creation-Date: 2021-09-15 21:23+0000\n"
+"PO-Revision-Date: 2021-09-15 21:23+0000\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
 "Language: \n"
@@ -31,59 +31,71 @@ msgstr ""
 msgid "Reason: %{write_lock}"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/environment.rb:109
+#: ../lib/r10k/action/deploy/environment.rb:118
 msgid "Environment(s) \\'%{environments}\\' cannot be found in any source and will not be deployed."
 msgstr ""
 
-#: ../lib/r10k/action/deploy/environment.rb:139
+#: ../lib/r10k/action/deploy/environment.rb:138
+msgid "Executing postrun command."
+msgstr ""
+
+#: ../lib/r10k/action/deploy/environment.rb:152
 msgid "Environment %{env_dir} does not match environment name filter, skipping"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/environment.rb:147
+#: ../lib/r10k/action/deploy/environment.rb:160
 msgid "Deploying environment %{env_path}"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/environment.rb:150
+#: ../lib/r10k/action/deploy/environment.rb:163
 msgid "Environment %{env_dir} is now at %{env_signature}"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/environment.rb:154
+#: ../lib/r10k/action/deploy/environment.rb:167
 msgid "Environment %{env_dir} is new, updating all modules"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/module.rb:78
+#: ../lib/r10k/action/deploy/module.rb:82
+msgid "Running postrun command for environments: %{envs_to_run}."
+msgstr ""
+
+#: ../lib/r10k/action/deploy/module.rb:92
+msgid "No environments were modified, not executing postrun command."
+msgstr ""
+
+#: ../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:80
+#: ../lib/r10k/action/deploy/module.rb:106
 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:13
+#: ../lib/r10k/content_synchronizer.rb:33
 msgid "Updating modules with %{pool_size} threads"
 msgstr ""
 
-#: ../lib/r10k/content_synchronizer.rb:24
+#: ../lib/r10k/content_synchronizer.rb:46
 msgid "Error during concurrent deploy of a module: %{message}"
 msgstr ""
 
-#: ../lib/r10k/content_synchronizer.rb:52
+#: ../lib/r10k/content_synchronizer.rb:87
 msgid "Module thread %{id} exiting: %{message}"
 msgstr ""
 
@@ -95,7 +107,7 @@ msgstr ""
 msgid "Unable to load sources; the supplied configuration does not define the 'sources' key"
 msgstr ""
 
-#: ../lib/r10k/environment/base.rb:65 ../lib/r10k/environment/base.rb:81 ../lib/r10k/environment/base.rb:90 ../lib/r10k/source/base.rb:69
+#: ../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 ""
 
@@ -207,54 +219,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 +335,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,35 +379,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:88 ../lib/r10k/module/forge.rb:117
+#: ../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:101 ../lib/r10k/module/forge.rb:130
 msgid "The module %{title} does not exist on %{url}."
 msgstr ""
 
-#: ../lib/r10k/module/forge.rb:192
+#: ../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:33
 msgid "Module %{title} is a local module, always indicating synced."
 msgstr ""
 
@@ -351,27 +435,43 @@ msgstr ""
 msgid "Could not read metadata.json"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:73
+#: ../lib/r10k/module_loader/puppetfile.rb:58
 msgid "Using Puppetfile '%{puppetfile}'"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:87
-msgid "Puppetfile %{path} missing or unreadable"
+#: ../lib/r10k/module_loader/puppetfile.rb:59
+msgid "Using moduledir '%{moduledir}'"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:100
+#: ../lib/r10k/module_loader/puppetfile.rb:80
 msgid "Failed to evaluate %{path}"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:114
+#: ../lib/r10k/module_loader/puppetfile.rb:97
+msgid "Unable to preload Puppetfile because of %{msg}"
+msgstr ""
+
+#: ../lib/r10k/module_loader/puppetfile.rb:115
+msgid "Using Forge from Puppetfile: %{forge}"
+msgstr ""
+
+#: ../lib/r10k/module_loader/puppetfile.rb:118
+msgid "Ignoring Forge declaration in Puppetfile, using value from settings: %{forge}."
+msgstr ""
+
+#: ../lib/r10k/module_loader/puppetfile.rb:179 ../lib/r10k/puppetfile.rb:104
+msgid "Puppetfile %{path} missing or unreadable"
+msgstr ""
+
+#: ../lib/r10k/module_loader/puppetfile.rb:215
 msgid "Puppetfiles cannot contain duplicate module names."
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:116
+#: ../lib/r10k/module_loader/puppetfile.rb:217
 msgid "Remove the duplicates of the following modules: %{dupes}"
 msgstr ""
 
-#: ../lib/r10k/puppetfile.rb:276
+#: ../lib/r10k/module_loader/puppetfile/dsl.rb:37
 msgid "unrecognized declaration '%{method}'"
 msgstr ""
 
@@ -454,27 +554,27 @@ msgid ""
 "Returned: %{data}"
 msgstr ""
 
-#: ../lib/r10k/source/git.rb:77
+#: ../lib/r10k/source/git.rb:75
 msgid "Fetching '%{remote}' to determine current branches."
 msgstr ""
 
-#: ../lib/r10k/source/git.rb:80
+#: ../lib/r10k/source/git.rb:78
 msgid "Unable to determine current branches for Git source '%{name}' (%{basedir})"
 msgstr ""
 
-#: ../lib/r10k/source/git.rb:110
+#: ../lib/r10k/source/git.rb:113
 msgid "Environment %{env_name} contained non-word characters, correcting name to %{corrected_env_name}"
 msgstr ""
 
-#: ../lib/r10k/source/git.rb:119
+#: ../lib/r10k/source/git.rb:122
 msgid "Environment %{env_name} contained non-word characters, ignoring it."
 msgstr ""
 
-#: ../lib/r10k/source/git.rb:138 ../lib/r10k/source/svn.rb:113
+#: ../lib/r10k/source/git.rb:141 ../lib/r10k/source/svn.rb:115
 msgid "Branch %{branch} filtered out by ignore_branch_prefixes %{ibp}"
 msgstr ""
 
-#: ../lib/r10k/source/git.rb:149
+#: ../lib/r10k/source/git.rb:152
 msgid "Branch `%{name}:%{branch}` filtered out by filter_command %{cmd}"
 msgstr ""
 
@@ -518,23 +618,23 @@ msgstr ""
 msgid "pe_license feature is not available, PE only Puppet modules will not be downloadable."
 msgstr ""
 
-#: ../lib/r10k/util/purgeable.rb:52
-msgid "Not purging %{item} due to internal exclusion match: %{exclusion_match}"
+#: ../lib/r10k/util/purgeable.rb:87
+msgid "Not purging %{path} due to internal exclusion match: %{exclusion_match}"
 msgstr ""
 
-#: ../lib/r10k/util/purgeable.rb:54
-msgid "Not purging %{item} due to whitelist match: %{whitelist_match}"
+#: ../lib/r10k/util/purgeable.rb:89
+msgid "Not purging %{path} due to whitelist match: %{allowlist_match}"
 msgstr ""
 
-#: ../lib/r10k/util/purgeable.rb:71
+#: ../lib/r10k/util/purgeable.rb:133
 msgid "No unmanaged contents in %{managed_dirs}, nothing to purge"
 msgstr ""
 
-#: ../lib/r10k/util/purgeable.rb:76
+#: ../lib/r10k/util/purgeable.rb:138
 msgid "Removing unmanaged path %{path}"
 msgstr ""
 
-#: ../lib/r10k/util/purgeable.rb:81
+#: ../lib/r10k/util/purgeable.rb:143
 msgid "Unable to remove unmanaged path: %{path}"
 msgstr ""