r10k 3.12.1 → 3.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5500f864c81a0b1ff5f48461bca9de375450f452028a93d381ec65eac3b35865
-  data.tar.gz: 1d675799b9bf1df2ee328780bc90ed4e79c02bf7706a166dd40f5af952e9610a
+  metadata.gz: 13a5d7be1f8e4f5794ad944ef12cfbe32d6a7e704371e8f8137227507857600a
+  data.tar.gz: a9060539b639c566371a1c23c28d19910d63649dedeca67ab4b9237d0a43bfab
 SHA512:
-  metadata.gz: cc75dcceceb3b368c6ee9dd1773a92530e67a59b1e35b52e3d8205d3dffb6b1b7d4b927edbe58bc828d9a1782d1052254464ca7c0556ea6099c5975811ddad1a
-  data.tar.gz: 12ecfa266d5c7cafc1a6656bb54d5429ecb030c2b89af8d61a2dcd6587f8bc1ff6f94221a4f185d9e463a96df652d2434adec0c59a78288bc44dda087c67ca12
+  metadata.gz: aa2a7a28f9d30468bd17d6e54b4e6202a3290779391efe95409a16648f2eb81a5dd7483964b9c7d3bad8fafbb808fa99a86b6a7c2c0cdac5a5f1d5140e20efd0
+  data.tar.gz: 1ee18ff19d30c76a6f00a9650eff77ccf0cae1f60c789a5ae8c90fd725a8c4197f587d4bc1d6a6288b8452ba1c3db07cdfa30030d7fad7e130639283b5f56722

data/CHANGELOG.mkd

@@ -4,6 +4,15 @@ CHANGELOG
 Unreleased
 ----------
 
+3.13.0
+------
+
+- Restore Ruby 3 compatibility [#1234](https://github.com/puppetlabs/r10k/pull/1234)
+- (RK-381) Do not recurse into symlinked dirs when finding files to purge. [#1233](https://github.com/puppetlabs/r10k/pull/1233)
+- Purge should remove unmanaged directories, in addition to unmanaged files. [#1222](https://github.com/puppetlabs/r10k/pull/1222)
+- Rename experimental environment type "bare" to "plain". [#1228](https://github.com/puppetlabs/r10k/pull/1228)
+- Add support for specifying additional logging ouputs. [#1230](https://github.com/puppetlabs/r10k/issues/1230)
+
 3.12.1
 ------
 

data/doc/dynamic-environments/configuration.mkd

@@ -760,16 +760,16 @@ modules:
     version: 62d07f2
 ```
 
-### Bare Environment Type
+### Plain Environment Type
 
 A "control repository" typically contains a hiera.yaml, an environment.conf, a manifests/site.pp file, and a few other things. However, none of these are strictly necessary for an environment to be functional if modules can be deployed to it.
 
-The bare environment type allows sources that support environment modules to operate without a control repo being required. Modules can be deployed directly.
+The plain environment type allows sources that support environment modules to operate without a control repo being required. Modules can be deployed directly.
 
 ```yaml
 ---
 production:
-  type: bare
+  type: plain
   modules:
     puppetlabs-stdlib:
       type: forge
@@ -783,7 +783,7 @@ production:
       version: 62d07f2
 
 development:
-  type: bare
+  type: plain
   modules:
     puppetlabs-stdlib:
       type: forge

data/lib/r10k/action/runner.rb

@@ -51,6 +51,12 @@ module R10K
           overrides[:deploy][:generate_types] = @opts[:'generate-types'] if @opts.key?(:'generate-types')
           overrides[:deploy][:exclude_spec] = @opts[:'exclude-spec'] if @opts.key?(:'exclude-spec')
         end
+        # If the log level has been given as an argument, ensure that output happens on stderr
+        if @opts.key?(:loglevel)
+          overrides[:logging] = {}
+          overrides[:logging][:level] = @opts[:loglevel]
+          overrides[:logging][:disable_default_stderr] = false
+        end
 
         with_overrides = config_settings.merge(overrides) do |key, oldval, newval|
           newval = oldval.merge(newval) if oldval.is_a? Hash

data/lib/r10k/environment/bare.rb

@@ -1,13 +1,10 @@
-class R10K::Environment::Bare < R10K::Environment::WithModules
+class R10K::Environment::Bare < R10K::Environment::Plain
 
   R10K::Environment.register(:bare, self)
 
-  def sync
-    path.mkpath
-  end
-
-  def status
-    :not_applicable
+  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

data/lib/r10k/environment/plain.rb

@@ -0,0 +1,16 @@
+class R10K::Environment::Plain < R10K::Environment::WithModules
+
+  R10K::Environment.register(:plain, self)
+
+  def sync
+    path.mkpath
+  end
+
+  def status
+    :not_applicable
+  end
+
+  def signature
+    'plain-default'
+  end
+end

data/lib/r10k/environment.rb

@@ -30,6 +30,7 @@ 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'

data/lib/r10k/errors.rb

@@ -58,4 +58,9 @@ module R10K
       str.gsub(/^/, prefix)
     end
   end
+
+  # An error class for configuration errors
+  #
+  class ConfigError < Error
+  end
 end

data/lib/r10k/initializers.rb

@@ -30,6 +30,8 @@ module R10K
           logger.warn(_("the purgedirs key in r10k.yaml is deprecated. it is currently ignored."))
         end
 
+        with_setting(:logging) { |value| LoggingInitializer.new(value).call }
+
         with_setting(:deploy) { |value| DeployInitializer.new(value).call }
 
         with_setting(:cachedir) { |value| R10K::Git::Cache.settings[:cache_root] = value }
@@ -41,6 +43,14 @@ module R10K
       end
     end
 
+    class LoggingInitializer < BaseInitializer
+      def call
+        with_setting(:level) { |value| R10K::Logging.level = value }
+        with_setting(:disable_default_stderr) { |value| R10K::Logging.disable_default_stderr = value }
+        with_setting(:outputs) { |value| R10K::Logging.add_outputters(value) }
+      end
+    end
+
     class DeployInitializer < BaseInitializer
       def call
         with_setting(:puppet_path) { |value| R10K::Settings.puppet_path = value }

data/lib/r10k/logging.rb

@@ -8,6 +8,16 @@ require 'r10k/logging/terminaloutputter'
 module R10K::Logging
 
   LOG_LEVELS = %w{DEBUG2 DEBUG1 DEBUG INFO NOTICE WARN ERROR FATAL}
+  SYSLOG_LEVELS_MAP = {
+    'DEBUG2' => 'DEBUG',
+    'DEBUG1' => 'DEBUG',
+    'DEBUG' => 'DEBUG',
+    'INFO' => 'INFO',
+    'NOTICE' => 'INFO',
+    'WARN' => 'WARN',
+    'ERROR' => 'ERROR',
+    'FATAL' => 'FATAL',
+  }.freeze
 
   def logger_name
     self.class.to_s
@@ -21,6 +31,9 @@ module R10K::Logging
       else
         @logger = Log4r::Logger.new(name)
         @logger.add(R10K::Logging.outputter)
+        R10K::Logging.outputters.each do |output|
+          @logger.add(output)
+        end
       end
     end
     @logger
@@ -59,7 +72,7 @@ module R10K::Logging
       if level.nil?
         raise ArgumentError, _("Invalid log level '%{val}'. Valid levels are %{log_levels}") % {val: val, log_levels: LOG_LEVELS.map(&:downcase).inspect}
       end
-      outputter.level = level
+      outputter.level = level unless @disable_default_stderr
       @level = level
 
       if level < Log4r::INFO
@@ -69,6 +82,58 @@ module R10K::Logging
       end
     end
 
+    def disable_default_stderr=(val)
+      @disable_default_stderr = val
+      outputter.level = val ? Log4r::OFF : @level
+    end
+
+    def add_outputters(outputs)
+      outputs.each do |output|
+        type = output.fetch(:type)
+        # Support specifying both short as well as full names
+        type = type.to_s[0..-10] if type.to_s.downcase.end_with? 'outputter'
+
+        name = output.fetch(:name, 'r10k')
+        if output[:level]
+          level = parse_level(output[:level])
+          if level.nil?
+            raise ArgumentError, _("Invalid log level '%{val}'. Valid levels are %{log_levels}") % { val: output[:level], log_levels: LOG_LEVELS.map(&:downcase).inspect }
+          end
+        else
+          level = self.level
+        end
+        only_at = output[:only_at]
+        only_at&.map! do |val|
+          lv = parse_level(val)
+          if lv.nil?
+            raise ArgumentError, _("Invalid log level '%{val}'. Valid levels are %{log_levels}") % { val: val, log_levels: LOG_LEVELS.map(&:downcase).inspect }
+          end
+
+          lv
+        end
+        parameters = output.fetch(:parameters, {}).merge({ level: level })
+
+        begin
+          # Try to load the outputter file if possible
+          require "log4r/outputter/#{type.to_s.downcase}outputter"
+        rescue LoadError
+          false
+        end
+        outputtertype = Log4r.constants
+                             .select { |klass| klass.to_s.end_with? 'Outputter' }
+                             .find { |klass| klass.to_s.downcase == "#{type.to_s.downcase}outputter" }
+        raise ArgumentError, "Unable to find a #{output[:type]} outputter." unless outputtertype
+
+        outputter = Log4r.const_get(outputtertype).new(name, parameters)
+        outputter.only_at(*only_at) if only_at
+        # Handle log4r's syslog mapping correctly
+        outputter.map_levels_by_name_to_syslog(SYSLOG_LEVELS_MAP) if outputter.respond_to? :map_levels_by_name_to_syslog
+
+        @outputters << outputter
+        Log4r::Logger.global.add outputter
+      end
+    end
+
     extend Forwardable
     def_delegators :@outputter, :use_color, :use_color=
 
@@ -87,6 +152,16 @@ module R10K::Logging
     #   @return [Log4r::Outputter]
     attr_reader :outputter
 
+    # @!attribute [r] outputters
+    #   @api private
+    #   @return [Array[Log4r::Outputter]]
+    attr_reader :outputters
+
+    # @!attribute [r] disable_default_stderr
+    #   @api private
+    #   @return [Boolean]
+    attr_reader :disable_default_stderr
+
     def default_formatter
       Log4r::PatternFormatter.new(:pattern => '%l\t -> %m')
     end
@@ -106,4 +181,6 @@ module R10K::Logging
   @level     = Log4r::WARN
   @formatter = default_formatter
   @outputter = default_outputter
+  @outputters = []
+  @disable_default_stderr = false
 end

data/lib/r10k/settings.rb

@@ -217,6 +217,39 @@ module R10K
         })])
     end
 
+    def self.logging_settings
+      R10K::Settings::Collection.new(:logging, [
+        Definition.new(:level, {
+          desc: 'What logging level should R10k run on if not specified at runtime.',
+          validate: lambda do |value|
+            if R10K::Logging.parse_level(value).nil?
+              raise ArgumentError, "`level` must be a valid log level.
+                                    Valid levels are #{R10K::Logging::LOG_LEVELS.map(&:downcase).inspect}"
+            end
+          end
+        }),
+
+        Definition.new(:outputs, {
+          desc: 'Additional log outputs to use.',
+          validate: lambda do |value|
+            unless value.is_a?(Array)
+              raise ArgumentError, "The `outputs` setting should be an array of outputs, not a #{value.class}"
+            end
+          end
+        }),
+
+        Definition.new(:disable_default_stderr, {
+          desc: 'Disable the default stderr logging output',
+          default: false,
+          validate: lambda do |value|
+            unless !!value == value
+              raise ArgumentError, "`disable_default_stderr` can only be a boolean value, not '#{value}'"
+            end
+          end
+        })
+      ])
+    end
+
     def self.global_settings
       R10K::Settings::Collection.new(:global, [
         Definition.new(:sources, {
@@ -271,6 +304,8 @@ module R10K
         R10K::Settings.git_settings,
 
         R10K::Settings.deploy_settings,
+
+        R10K::Settings.logging_settings
       ])
     end
   end

data/lib/r10k/source/yaml.rb

@@ -7,7 +7,7 @@ class R10K::Source::Yaml < R10K::Source::Hash
     begin
       contents = ::YAML.load_file(config)
     rescue => e
-      raise ConfigError, _("Couldn't open environments file %{file}: %{err}") % {file: config, err: e.message}
+      raise R10K::ConfigError, _("Couldn't open environments file %{file}: %{err}") % {file: config, err: e.message}
     end
 
     # Set the environments key for the parent class to consume

data/lib/r10k/util/purgeable.rb

@@ -99,8 +99,8 @@ module R10K
         end
 
         children.flat_map do |child|
-          if File.directory?(child) && recurse
-            potentially_purgeable(child, exclusion_globs, allowed_globs, desireds_not_to_recurse_into, recurse)
+          if File.directory?(child) && !File.symlink?(child) && recurse
+            potentially_purgeable(child, exclusion_globs, allowed_globs, desireds_not_to_recurse_into, recurse) << child.to_s
           else
             child.to_s
           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.12.1'
+  VERSION = '3.13.0'
 end

data/locales/r10k.pot

@@ -6,11 +6,11 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: r10k 3.9.3-110-gfe65c736\n"
+"Project-Id-Version: r10k 3.9.3-134-g9f93336f\n"
 "\n"
 "Report-Msgid-Bugs-To: docs@puppetlabs.com\n"
-"POT-Creation-Date: 2021-09-15 21:23+0000\n"
-"PO-Revision-Date: 2021-09-15 21:23+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,55 +19,55 @@ 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:118
+#: ../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:138
+#: ../lib/r10k/action/deploy/environment.rb:136
 msgid "Executing postrun command."
 msgstr ""
 
-#: ../lib/r10k/action/deploy/environment.rb:152
+#: ../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:160
+#: ../lib/r10k/action/deploy/environment.rb:158
 msgid "Deploying environment %{env_path}"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/environment.rb:163
+#: ../lib/r10k/action/deploy/environment.rb:161
 msgid "Environment %{env_dir} is now at %{env_signature}"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/environment.rb:167
+#: ../lib/r10k/action/deploy/environment.rb:165
 msgid "Environment %{env_dir} is new, updating all modules"
 msgstr ""
 
-#: ../lib/r10k/action/deploy/module.rb:82
+#: ../lib/r10k/action/deploy/module.rb:81
 msgid "Running postrun command for environments: %{envs_to_run}."
 msgstr ""
 
-#: ../lib/r10k/action/deploy/module.rb:92
+#: ../lib/r10k/action/deploy/module.rb:91
 msgid "No environments were modified, not executing postrun command."
 msgstr ""
 
-#: ../lib/r10k/action/deploy/module.rb:104
+#: ../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:106
+#: ../lib/r10k/action/deploy/module.rb:105
 msgid "Updating modules %{modules} in environment %{env_path}"
 msgstr ""
 
@@ -107,6 +107,10 @@ 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 ""
@@ -427,7 +431,7 @@ msgstr ""
 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:33
+#: ../lib/r10k/module/local.rb:37
 msgid "Module %{title} is a local module, always indicating synced."
 msgstr ""
 
@@ -435,39 +439,39 @@ msgstr ""
 msgid "Could not read metadata.json"
 msgstr ""
 
-#: ../lib/r10k/module_loader/puppetfile.rb:58
+#: ../lib/r10k/module_loader/puppetfile.rb:62
 msgid "Using Puppetfile '%{puppetfile}'"
 msgstr ""
 
-#: ../lib/r10k/module_loader/puppetfile.rb:59
+#: ../lib/r10k/module_loader/puppetfile.rb:63
 msgid "Using moduledir '%{moduledir}'"
 msgstr ""
 
-#: ../lib/r10k/module_loader/puppetfile.rb:80
+#: ../lib/r10k/module_loader/puppetfile.rb:84
 msgid "Failed to evaluate %{path}"
 msgstr ""
 
-#: ../lib/r10k/module_loader/puppetfile.rb:97
+#: ../lib/r10k/module_loader/puppetfile.rb:101
 msgid "Unable to preload Puppetfile because of %{msg}"
 msgstr ""
 
-#: ../lib/r10k/module_loader/puppetfile.rb:115
+#: ../lib/r10k/module_loader/puppetfile.rb:119
 msgid "Using Forge from Puppetfile: %{forge}"
 msgstr ""
 
-#: ../lib/r10k/module_loader/puppetfile.rb:118
+#: ../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:179 ../lib/r10k/puppetfile.rb:104
+#: ../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:215
+#: ../lib/r10k/module_loader/puppetfile.rb:219
 msgid "Puppetfiles cannot contain duplicate module names."
 msgstr ""
 
-#: ../lib/r10k/module_loader/puppetfile.rb:217
+#: ../lib/r10k/module_loader/puppetfile.rb:221
 msgid "Remove the duplicates of the following modules: %{dupes}"
 msgstr ""
 
@@ -618,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.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/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/unit/action/puppetfile/install_spec.rb

@@ -4,9 +4,9 @@ require 'r10k/action/puppetfile/install'
 describe R10K::Action::Puppetfile::Install do
   let(:default_opts) { { root: "/some/nonexistent/path" } }
   let(:loader) {
-    R10K::ModuleLoader::Puppetfile.new({
+    R10K::ModuleLoader::Puppetfile.new(
       basedir: '/some/nonexistent/path',
-      overrides: {force: false}})
+      overrides: {force: false})
   }
 
   def installer(opts = {}, argv = [], settings = {})

data/spec/unit/action/runner_spec.rb

@@ -159,10 +159,61 @@ describe R10K::Action::Runner do
   end
 
   describe "configuring logging" do
+    before(:each) do
+      R10K::Logging.outputters.clear
+    end
+
     it "sets the log level if :loglevel is provided" do
       runner = described_class.new({:opts => :yep, :loglevel => 'FATAL'}, %w[args yes], action_class)
-      expect(R10K::Logging).to receive(:level=).with('FATAL')
+      # The settings/overrides system causes the level to be set twice
+      expect(R10K::Logging).to receive(:level=).with('FATAL').twice
+      runner.call
+    end
+
+    # The logging fixture tests require a platform with syslog
+    if !R10K::Util::Platform.windows?
+      it "sets the log level if the logging.level setting is provided" do
+        runner = described_class.new({ opts: :yep, config: 'spec/fixtures/unit/action/r10k_logging.yaml'}, %w[args yes], action_class)
+        expect(R10K::Logging).to receive(:level=).with('FATAL')
+        runner.call
+      end
+
+      it "sets the outputters if logging.outputs is provided" do
+        runner = described_class.new({ opts: :yep, config: 'spec/fixtures/unit/action/r10k_logging.yaml' }, %w[args yes], action_class)
+        expect(R10K::Logging).to receive(:add_outputters).with([
+          { type: 'file', parameters: { filename: 'r10k.log' } },
+          { type: 'syslog' }
+        ])
+        runner.call
+      end
+
+      it "disables the default outputter if the logging.disable_default_stderr setting is provided" do
+        runner = described_class.new({ opts: :yep, config: 'spec/fixtures/unit/action/r10k_logging.yaml'}, %w[args yes], action_class)
+        expect(R10K::Logging).to receive(:disable_default_stderr=).with(true)
+        runner.call
+      end
+
+      it "adds additional log outputs if the logging.outputs setting is provided" do
+        runner = described_class.new({ opts: :yep, config: 'spec/fixtures/unit/action/r10k_logging.yaml'}, %w[args yes], action_class)
+        runner.call
+        expect(R10K::Logging.outputters).to_not be_empty
+      end
+
+      it "disables the default output if the logging.disable_default_stderr setting is provided" do
+        runner = described_class.new({ opts: :yep, config: 'spec/fixtures/unit/action/r10k_logging.yaml'}, %w[args yes], action_class)
+        runner.call
+        expect(runner.logger.outputters).to satisfy { |outputs| outputs.any? { |output| output.is_a?(R10K::Logging::TerminalOutputter) && output.level == Log4r::OFF } }
+      end
+    end
+
+    it "doesn't add additional log outputs if the logging.outputs setting is not provided" do
+      runner.call
+      expect(R10K::Logging.outputters).to be_empty
+    end
+
+    it "includes the default stderr outputter" do
       runner.call
+      expect(runner.logger.outputters).to satisfy { |outputs| outputs.any? { |output| output.is_a? R10K::Logging::TerminalOutputter } }
     end
 
     it "does not modify the loglevel if :loglevel is not provided" do

data/spec/unit/environment/bare_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'r10k/environment'
+
+describe R10K::Environment::Bare do
+  it "warns on initialization" do
+    logger_spy = spy('logger')
+    allow_any_instance_of(described_class).to receive(:logger).and_return(logger_spy)
+
+    described_class.new('envname', '/basedir', 'dirname', {})
+
+    expect(logger_spy).to have_received(:warn).with(%r{deprecated.*envname})
+  end
+end

data/spec/unit/environment/plain_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'r10k/environment'
+
+describe R10K::Environment::Plain do
+  it "initializes successfully" do
+    expect(described_class.new('envname', '/basedir', 'dirname', {})).to be_a_kind_of(described_class)
+  end
+end

data/spec/unit/environment/with_modules_spec.rb

@@ -8,7 +8,7 @@ describe R10K::Environment::WithModules do
       '/some/nonexistent/environmentdir',
       'prefix_release42',
       {
-        :type             => 'bare',
+        :type             => 'plain',
         :modules          => {
           'puppetlabs-stdlib' => { local: true },
           'puppetlabs-concat' => { local: true },

data/spec/unit/util/purgeable_spec.rb

@@ -15,8 +15,10 @@ RSpec.describe R10K::Util::Purgeable do
       'spec/fixtures/unit/util/purgeable/managed_one/expected_1',
       'spec/fixtures/unit/util/purgeable/managed_one/new_1',
       'spec/fixtures/unit/util/purgeable/managed_one/managed_subdir_1',
+      'spec/fixtures/unit/util/purgeable/managed_one/managed_symlink_dir',
       'spec/fixtures/unit/util/purgeable/managed_one/managed_subdir_1/subdir_expected_1',
       'spec/fixtures/unit/util/purgeable/managed_one/managed_subdir_1/subdir_new_1',
+      'spec/fixtures/unit/util/purgeable/managed_one/managed_subdir_1/managed_symlink_file',
       'spec/fixtures/unit/util/purgeable/managed_two/expected_2',
       'spec/fixtures/unit/util/purgeable/managed_two/new_2',
       'spec/fixtures/unit/util/purgeable/managed_two/.hidden',
@@ -30,7 +32,8 @@ RSpec.describe R10K::Util::Purgeable do
 
     describe '#current_contents' do
       it 'collects direct contents of all managed directories' do
-        expect(subject.current_contents(recurse)).to contain_exactly(/\/expected_1/, /\/expected_2/, /\/unmanaged_1/, /\/unmanaged_2/, /\/managed_subdir_1/)
+        expect(subject.current_contents(recurse)).to contain_exactly(/\/expected_1/, /\/expected_2/, /\/unmanaged_1/, /\/unmanaged_2/,
+                                                                     /\/managed_subdir_1/, /\/managed_symlink_dir/, /\/unmanaged_symlink_file/)
       end
     end
 
@@ -46,7 +49,7 @@ RSpec.describe R10K::Util::Purgeable do
         let(:whitelist) { [] }
 
         it 'collects current_contents that should not exist' do
-          expect(subject.stale_contents(recurse, exclusions, whitelist)).to contain_exactly(/\/unmanaged_1/, /\/unmanaged_2/)
+          expect(subject.stale_contents(recurse, exclusions, whitelist)).to contain_exactly(/\/unmanaged_1/, /\/unmanaged_2/, /\/unmanaged_symlink_file/)
         end
       end
 
@@ -56,7 +59,7 @@ RSpec.describe R10K::Util::Purgeable do
 
         it 'collects current_contents that should not exist except whitelisted items' do
           expect(subject.logger).to receive(:debug).with(/unmanaged_1.*whitelist match/i)
-          expect(subject.stale_contents(recurse, exclusions, whitelist)).to contain_exactly(/\/unmanaged_2/)
+          expect(subject.stale_contents(recurse, exclusions, whitelist)).to contain_exactly(/\/unmanaged_2/, /\/unmanaged_symlink_file/)
         end
       end
 
@@ -66,7 +69,7 @@ RSpec.describe R10K::Util::Purgeable do
 
         it 'collects current_contents that should not exist except excluded items' do
           expect(subject.logger).to receive(:debug2).with(/unmanaged_2.*internal exclusion match/i)
-          expect(subject.stale_contents(recurse, exclusions, whitelist)).to contain_exactly(/\/unmanaged_1/)
+          expect(subject.stale_contents(recurse, exclusions, whitelist)).to contain_exactly(/\/unmanaged_1/, /\/unmanaged_symlink_file/)
         end
       end
     end
@@ -102,9 +105,13 @@ RSpec.describe R10K::Util::Purgeable do
         expect(subject.current_contents(recurse)).
           to contain_exactly(/\/expected_1/, /\/expected_2/,
                              /\/unmanaged_1/, /\/unmanaged_2/,
+                             /\/managed_symlink_dir/,
+                             /\/unmanaged_symlink_file/,
                              /\/managed_subdir_1/,
                              /\/subdir_expected_1/, /\/subdir_unmanaged_1/,
-                             /\/managed_subdir_2/, /\/ignored_1/,
+                             /\/managed_symlink_file/,
+                             /\/unmanaged_symlink_dir/,
+                             /\/subdir_allowlisted_2/, /\/ignored_1/,
                              /\/\.hidden/)
       end
     end
@@ -122,7 +129,8 @@ RSpec.describe R10K::Util::Purgeable do
 
         it 'collects current_contents that should not exist recursively' do
           expect(subject.stale_contents(recurse, exclusions, whitelist)).
-            to contain_exactly(/\/unmanaged_1/, /\/unmanaged_2/, /\/subdir_unmanaged_1/, /\/ignored_1/)
+            to contain_exactly(/\/unmanaged_1/, /\/unmanaged_2/, /\/unmanaged_symlink_file/, /\/subdir_unmanaged_1/,
+                               /\/ignored_1/, /\/subdir_allowlisted_2/, /\/unmanaged_symlink_dir/)
         end
       end
 
@@ -134,7 +142,8 @@ RSpec.describe R10K::Util::Purgeable do
           expect(subject.logger).to receive(:debug).with(/unmanaged_1.*whitelist match/i)
 
           expect(subject.stale_contents(recurse, exclusions, whitelist)).
-            to contain_exactly(/\/unmanaged_2/, /\/subdir_unmanaged_1/, /\/ignored_1/)
+            to contain_exactly(/\/unmanaged_2/, /\/subdir_unmanaged_1/, /\/unmanaged_symlink_file/, /\/ignored_1/,
+                               /\/subdir_allowlisted_2/, /\/unmanaged_symlink_dir/)
         end
 
         it 'does not collect contents that match recursive globbed whitelist items as intermediate values' do
@@ -142,7 +151,7 @@ RSpec.describe R10K::Util::Purgeable do
           expect(subject.logger).not_to receive(:debug).with(/ignored_1/)
 
           expect(subject.stale_contents(recurse, exclusions, recursive_whitelist)).
-            to contain_exactly(/\/unmanaged_2/, /\/managed_one\/unmanaged_1/)
+            to contain_exactly(/\/unmanaged_2/, /\/managed_one\/unmanaged_1/, /\/managed_one\/unmanaged_symlink_file/)
         end
       end
 
@@ -154,7 +163,8 @@ RSpec.describe R10K::Util::Purgeable do
           expect(subject.logger).to receive(:debug2).with(/unmanaged_2.*internal exclusion match/i)
 
           expect(subject.stale_contents(recurse, exclusions, whitelist)).
-            to contain_exactly(/\/unmanaged_1/, /\/subdir_unmanaged_1/, /\/ignored_1/)
+            to contain_exactly(/\/unmanaged_1/, /\/unmanaged_symlink_file/, /\/subdir_unmanaged_1/, /\/ignored_1/,
+                               /\/subdir_allowlisted_2/, /\/unmanaged_symlink_dir/)
         end
 
         it 'does not collect contents that match recursive globbed exclusion items as intermediate values' do
@@ -162,7 +172,7 @@ RSpec.describe R10K::Util::Purgeable do
           expect(subject.logger).not_to receive(:debug).with(/ignored_1/)
 
           expect(subject.stale_contents(recurse, recursive_exclusions, whitelist)).
-            to contain_exactly(/\/unmanaged_2/, /\/managed_one\/unmanaged_1/)
+            to contain_exactly(/\/unmanaged_2/, /\/unmanaged_symlink_file/, /\/managed_one\/unmanaged_1/)
         end
       end
     end
@@ -199,6 +209,7 @@ RSpec.describe R10K::Util::Purgeable do
         it 'does not purge items matching glob at root level' do
           allow(FileUtils).to receive(:rm_r)
           expect(FileUtils).to_not receive(:rm_r).with(/\/unmanaged_[12]/, anything)
+          expect(FileUtils).to_not receive(:rm_r).with(/\/unmanaged_symlink_file/, anything)
           expect(subject.logger).to receive(:debug).with(/whitelist match/i).at_least(:once)
 
           subject.purge!(purge_opts)
@@ -209,7 +220,7 @@ RSpec.describe R10K::Util::Purgeable do
     context "recursive whitelist glob" do
       let(:whitelist) do
         managed_directories.flat_map do |dir|
-          [File.join(dir, "**", "*unmanaged*"), File.join(dir, "**", "managed_subdir_2")]
+          [File.join(dir, "**", "*unmanaged*"), File.join(dir, "**", "subdir_allowlisted_2")]
         end
       end
       let(:purge_opts) { { recurse: true, whitelist: whitelist } }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r10k
 version: !ruby/object:Gem::Version
-  version: 3.12.1
+  version: 3.13.0
 platform: ruby
 authors:
 - Adrien Thebo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-17 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored2
@@ -370,6 +370,7 @@ files:
 - lib/r10k/environment/base.rb
 - lib/r10k/environment/git.rb
 - lib/r10k/environment/name.rb
+- lib/r10k/environment/plain.rb
 - lib/r10k/environment/svn.rb
 - lib/r10k/environment/with_modules.rb
 - lib/r10k/errors.rb
@@ -467,6 +468,7 @@ files:
 - spec/fixtures/unit/action/r10k_forge_auth.yaml
 - spec/fixtures/unit/action/r10k_forge_auth_no_url.yaml
 - spec/fixtures/unit/action/r10k_generate_types.yaml
+- spec/fixtures/unit/action/r10k_logging.yaml
 - spec/fixtures/unit/action/r10k_puppet_path.yaml
 - spec/fixtures/unit/puppetfile/argument-error/Puppetfile
 - spec/fixtures/unit/puppetfile/default-branch-override/Puppetfile
@@ -480,10 +482,14 @@ files:
 - spec/fixtures/unit/puppetfile/various-modules/Puppetfile
 - spec/fixtures/unit/puppetfile/various-modules/Puppetfile.new
 - spec/fixtures/unit/util/purgeable/managed_one/expected_1
-- spec/fixtures/unit/util/purgeable/managed_one/managed_subdir_1/managed_subdir_2/ignored_1
+- spec/fixtures/unit/util/purgeable/managed_one/managed_subdir_1/managed_symlink_file
+- spec/fixtures/unit/util/purgeable/managed_one/managed_subdir_1/subdir_allowlisted_2/ignored_1
 - spec/fixtures/unit/util/purgeable/managed_one/managed_subdir_1/subdir_expected_1
 - spec/fixtures/unit/util/purgeable/managed_one/managed_subdir_1/subdir_unmanaged_1
+- spec/fixtures/unit/util/purgeable/managed_one/managed_subdir_1/unmanaged_symlink_dir
+- spec/fixtures/unit/util/purgeable/managed_one/managed_symlink_dir
 - spec/fixtures/unit/util/purgeable/managed_one/unmanaged_1
+- spec/fixtures/unit/util/purgeable/managed_one/unmanaged_symlink_file
 - spec/fixtures/unit/util/purgeable/managed_two/.hidden/unmanaged_3
 - spec/fixtures/unit/util/purgeable/managed_two/expected_2
 - spec/fixtures/unit/util/purgeable/managed_two/unmanaged_2
@@ -495,6 +501,7 @@ files:
 - spec/integration/git/shellgit/thin_repository_spec.rb
 - spec/integration/git/shellgit/working_repository_spec.rb
 - spec/integration/git/stateful_repository_spec.rb
+- spec/integration/util/purageable_spec.rb
 - spec/matchers/exit_with.rb
 - spec/matchers/match_realpath.rb
 - spec/r10k-mocks.rb
@@ -525,9 +532,11 @@ files:
 - spec/unit/cli_spec.rb
 - spec/unit/deployment/config_spec.rb
 - spec/unit/deployment_spec.rb
+- spec/unit/environment/bare_spec.rb
 - spec/unit/environment/base_spec.rb
 - spec/unit/environment/git_spec.rb
 - spec/unit/environment/name_spec.rb
+- spec/unit/environment/plain_spec.rb
 - spec/unit/environment/svn_spec.rb
 - spec/unit/environment/with_modules_spec.rb
 - spec/unit/errors/formatting_spec.rb