pdk 2.7.0 → 3.0.0

data/lib/pdk/cli/util/option_validator.rb

@@ -5,7 +5,7 @@ module PDK
     module Util
       class OptionValidator
         def self.comma_separated_list?(list, _options = {})
-          (list =~ %r{^[\w\-]+(?:,[\w\-]+)+$}) ? true : false
+          /^[\w-]+(?:,[\w-]+)+$/.match?(list)
         end
 
         # @return [Boolean] true if the fact name is valid
@@ -17,9 +17,7 @@ module PDK
           vals = val.is_a?(Array) ? val : [val]
           invalid_entries = vals.reject { |e| valid_entries.include?(e) }
 
-          unless invalid_entries.empty?
-            raise ArgumentError, 'Error: the following values are invalid: %{invalid_entries}' % { invalid_entries: invalid_entries }
-          end
+          raise ArgumentError, format('Error: the following values are invalid: %{invalid_entries}', invalid_entries: invalid_entries) unless invalid_entries.empty?
 
           val
         end
@@ -27,7 +25,7 @@ module PDK
         # Validate the module name against the regular expression in the
         # documentation: https://docs.puppet.com/puppet/4.10/modules_fundamentals.html#allowed-module-names
         def self.valid_module_name?(string)
-          !(string =~ %r{\A[a-z][a-z0-9_]*\Z}).nil?
+          !(string =~ /\A[a-z][a-z0-9_]*\Z/).nil?
         end
         singleton_class.send(:alias_method, :valid_task_name?, :valid_module_name?)
 
@@ -44,7 +42,7 @@ module PDK
         def self.valid_namespace?(string)
           return false if (string || '').split('::').last == 'init'
 
-          !(string =~ %r{\A([a-z][a-z0-9_]*)(::[a-z][a-z0-9_]*)*\Z}).nil?
+          !(string =~ /\A([a-z][a-z0-9_]*)(::[a-z][a-z0-9_]*)*\Z/).nil?
         end
         singleton_class.send(:alias_method, :valid_function_name?, :valid_namespace?)
 
@@ -56,11 +54,11 @@ module PDK
         # The parameter should also not be a reserved word or overload
         # a metaparameter.
         def self.valid_param_name?(string)
-          reserved_words = %w[trusted facts server_facts title name].freeze
-          metaparams = %w[alias audit before loglevel noop notify require schedule stage subscribe tag].freeze
+          reserved_words = ['trusted', 'facts', 'server_facts', 'title', 'name'].freeze
+          metaparams = ['alias', 'audit', 'before', 'loglevel', 'noop', 'notify', 'require', 'schedule', 'stage', 'subscribe', 'tag'].freeze
           return false if reserved_words.include?(string) || metaparams.include?(string)
 
-          !(string =~ %r{\A[a-z][a-zA-Z0-9_]*\Z}).nil?
+          !(string =~ /\A[a-z][a-zA-Z0-9_]*\Z/).nil?
         end
       end
     end

data/lib/pdk/cli/util/update_manager_printer.rb

@@ -14,7 +14,7 @@ module PDK
           require 'pdk/report'
 
           options = {
-            tense: :future,
+            tense: :future
           }.merge(options)
 
           footer = false
@@ -23,7 +23,7 @@ module PDK
             next if files.empty?
 
             PDK::Report.default_target.puts('')
-            PDK::Report.default_target.puts(generate_banner("Files #{(options[:tense] == :future) ? 'to be ' : ''}#{category}", 40))
+            PDK::Report.default_target.puts(generate_banner("Files #{options[:tense] == :future ? 'to be ' : ''}#{category}", 40))
             PDK::Report.default_target.puts(files.map(&:to_s).join("\n"))
             footer = true
           end
@@ -34,7 +34,7 @@ module PDK
           end
         end
 
-        #:nocov: Tested as part of the public methods
+        # :nocov: Tested as part of the public methods
         # Returns a hash, summarizing the contents of the Update Manager object
         # @param update_manager [PDK::Module::UpdateManager] The object to create a summary of
         #
@@ -75,7 +75,7 @@ module PDK
           banner
         end
         private_class_method :generate_banner
-        #:nocov:
+        # :nocov:
       end
     end
   end

data/lib/pdk/cli/util.rb

@@ -31,10 +31,11 @@ module PDK
       def spinner_opts_for_platform
         windows_opts = {
           success_mark: '*',
-          error_mark: 'X',
+          error_mark: 'X'
         }
 
         return windows_opts if Gem.win_platform?
+
         {}
       end
       module_function :spinner_opts_for_platform
@@ -43,7 +44,7 @@ module PDK
         require 'tty/prompt'
 
         prompt = opts[:prompt] || TTY::Prompt.new(help_color: :cyan)
-        validator = proc { |value| [true, false].include?(value) || value =~ %r{\A(?:yes|y|no|n)\Z}i }
+        validator = proc { |value| [true, false].include?(value) || value =~ /\A(?:yes|y|no|n)\Z/i }
         response = nil
 
         begin
@@ -74,7 +75,7 @@ module PDK
           'BAMBOO_BUILDKEY',        # Bamboo
           'GOCD_SERVER_URL',        # Go CD
           'TRAVIS',                 # Travis CI
-          'GITHUB_WORKFLOW',        # GitHub Actions
+          'GITHUB_WORKFLOW' # GitHub Actions
         ].any? { |name| PDK::Util::Env.key?(name) }
       end
       module_function :ci_environment?
@@ -111,7 +112,10 @@ module PDK
         # This checks if the version listed in the module's metadata is older
         # than the installed PDK, and advises the user to run pdk update.
         elsif Gem::Version.new(PDK::VERSION) > Gem::Version.new(module_pdk_ver)
-          PDK.logger.warn 'This module is compatible with an older version of PDK. Run `pdk update` to update it to your version of PDK.'
+          message = 'This module is compatible with an older version of PDK.'
+          message = 'Module templates older than 3.0.0 may experience issues.' if Gem::Version.new(module_pdk_ver) < Gem::Version.new('3.0.0')
+
+          PDK.logger.warn "#{message} Run `pdk update` to update it to the latest version."
         end
       end
       module_function :module_version_check
@@ -119,13 +123,10 @@ module PDK
       def check_for_deprecated_puppet(version)
         return unless version.is_a?(Gem::Version)
 
-        deprecated_below = Gem::Version.new('5.0.0')
+        deprecated_below = Gem::Version.new('7.0.0')
         return unless version < deprecated_below
 
-        deprecated_msg =
-          'Support for Puppet versions older than %{version} is ' \
-          'deprecated and will be removed in a future version of PDK.' % { version: deprecated_below.to_s }
-        PDK.logger.warn(deprecated_msg)
+        raise PDK::CLI::ExitWithError, "Support for Puppet versions older than #{deprecated_below} has been removed from PDK."
       end
       module_function :check_for_deprecated_puppet
 
@@ -161,11 +162,7 @@ module PDK
         end
 
         # Notify user of what Ruby version will be used.
-        unless logging_disabled
-          PDK.logger.info('Using Ruby %{version}' % {
-            version: puppet_env[:ruby_version],
-          })
-        end
+        PDK.logger.info(format('Using Ruby %{version}', version: puppet_env[:ruby_version])) unless logging_disabled
 
         check_for_deprecated_puppet(puppet_env[:gem_version])
 
@@ -176,16 +173,13 @@ module PDK
           gemset.each do |gem, version|
             next if version.nil?
 
-            PDK.logger.info('Using %{gem} %{version}' % {
-              gem: gem.to_s.capitalize,
-              version: version,
-            })
+            PDK.logger.info(format('Using %{gem} %{version}', gem: gem.to_s.capitalize, version: version))
           end
         end
 
         {
           gemset: gemset,
-          ruby_version: puppet_env[:ruby_version],
+          ruby_version: puppet_env[:ruby_version]
         }
       end
       module_function :puppet_from_opts_or_env
@@ -207,10 +201,7 @@ module PDK
           [puppet_ver_specs, pe_ver_specs].each do |offending|
             next if offending.empty?
 
-            raise PDK::CLI::ExitWithError, 'You cannot specify a %{first} and %{second} at the same time.' % {
-              first: pup_dev_spec,
-              second: offending.first,
-            }
+            raise PDK::CLI::ExitWithError, format('You cannot specify a %{first} and %{second} at the same time.', first: pup_dev_spec, second: offending.first)
           end
         end
 
@@ -219,46 +210,38 @@ module PDK
 
           offending = [pup_ver_spec, pe_ver_specs[0]].sort
 
-          raise PDK::CLI::ExitWithError, 'You cannot specify a %{first} and %{second} at the same time.' % {
-            first: offending[0],
-            second: offending[1],
-          }
+          raise PDK::CLI::ExitWithError, format('You cannot specify a %{first} and %{second} at the same time.', first: offending[0], second: offending[1])
+        end
+
+        # We want to mark setting the PE as deprecated.
+        if opts[:'pe-version'] || PDK::Util::Env['PDK_PE_VERSION']
+          PDK.logger.warn('Specifying a Puppet Enterprise version is now deprecated and will be removed in a future version. Please use --puppet-version or PDK_PUPPET_VERSION instead.')
         end
 
         if puppet_dev_specs.size == 2
           warning_str = 'Puppet dev flag from command line: "--puppet-dev" '
           warning_str += 'overrides value from environment: "PDK_PUPPET_DEV=true". You should not specify both.'
 
-          PDK.logger.warn(warning_str % {
-            pup_ver_opt: opts[:'puppet-dev'],
-            pup_ver_env: PDK::Util::Env['PDK_PUPPET_DEV'],
-          })
+          PDK.logger.warn(format(warning_str, pup_ver_opt: opts[:'puppet-dev'], pup_ver_env: PDK::Util::Env['PDK_PUPPET_DEV']))
         elsif puppet_ver_specs.size == 2
           warning_str = 'Puppet version option from command line: "--puppet-version=%{pup_ver_opt}" '
           warning_str += 'overrides value from environment: "PDK_PUPPET_VERSION=%{pup_ver_env}". You should not specify both.'
 
-          PDK.logger.warn(warning_str % {
-            pup_ver_opt: opts[:'puppet-version'],
-            pup_ver_env: PDK::Util::Env['PDK_PUPPET_VERSION'],
-          })
+          PDK.logger.warn(format(warning_str, pup_ver_opt: opts[:'puppet-version'], pup_ver_env: PDK::Util::Env['PDK_PUPPET_VERSION']))
         elsif pe_ver_specs.size == 2
           warning_str = 'Puppet Enterprise version option from command line: "--pe-version=%{pe_ver_opt}" '
           warning_str += 'overrides value from environment: "PDK_PE_VERSION=%{pe_ver_env}". You should not specify both.'
 
-          PDK.logger.warn(warning_str % {
-            pe_ver_opt: opts[:'pe-version'],
-            pe_ver_env: PDK::Util::Env['PDK_PE_VERSION'],
-          })
+          PDK.logger.warn(format(warning_str, pe_ver_opt: opts[:'pe-version'], pe_ver_env: PDK::Util::Env['PDK_PE_VERSION']))
         end
       end
       module_function :validate_puppet_version_opts
 
       def validate_template_opts(opts)
-        if opts[:'template-ref'] && opts[:'template-url'].nil?
-          raise PDK::CLI::ExitWithError, '--template-ref requires --template-url to also be specified.'
-        end
+        raise PDK::CLI::ExitWithError, '--template-ref requires --template-url to also be specified.' if opts[:'template-ref'] && opts[:'template-url'].nil?
+
+        return unless opts[:'template-url']&.include?('#')
 
-        return unless opts[:'template-url'] && opts[:'template-url'].include?('#')
         raise PDK::CLI::ExitWithError, '--template-url may not be used to specify paths containing #\'s.'
       end
       module_function :validate_template_opts
@@ -267,7 +250,7 @@ module PDK
         require 'pdk/analytics'
 
         dimensions = {
-          ruby_version: RUBY_VERSION,
+          ruby_version: RUBY_VERSION
         }
 
         cmd_opts = opts.dup.reject do |_, v|
@@ -276,14 +259,15 @@ module PDK
 
         if (format_args = cmd_opts.delete(:format))
           formats = PDK::CLI::Util::OptionNormalizer.report_formats(format_args)
-          dimensions[:output_format] = formats.map { |r| r[:method].to_s.gsub(%r{\Awrite_}, '') }.sort.uniq.join(',')
+          dimensions[:output_format] = formats.map { |r| r[:method].to_s.delete_prefix('write_') }.sort.uniq.join(',')
         else
           dimensions[:output_format] = 'default'
         end
 
         safe_opts = [:'puppet-version', :'pe-version']
+        safe_bools = [true, false]
         redacted_opts = cmd_opts.map do |k, v|
-          value = if [true, false].include?(v) || safe_opts.include?(k)
+          value = if safe_bools.include?(v) || safe_opts.include?(k)
                     v
                   else
                     'redacted'
@@ -292,11 +276,11 @@ module PDK
         end
         dimensions[:cli_options] = redacted_opts.join(',') unless redacted_opts.empty?
 
-        ignored_env_vars = %w[PDK_ANALYTICS_CONFIG PDK_DISABLE_ANALYTICS]
+        ignored_env_vars = ['PDK_ANALYTICS_CONFIG', 'PDK_DISABLE_ANALYTICS']
         env_vars = PDK::Util::Env.select { |k, _| k.start_with?('PDK_') && !ignored_env_vars.include?(k) }.map { |k, v| "#{k}=#{v}" }
         dimensions[:env_vars] = env_vars.join(',') unless env_vars.empty?
 
-        PDK.analytics.screen_view(screen_name, dimensions)
+        PDK.analytics.screen_view(screen_name, **dimensions)
       end
       module_function :analytics_screen_view
     end

data/lib/pdk/cli/validate.rb

@@ -1,114 +1,116 @@
-module PDK::CLI
-  @validate_cmd = @base_cmd.define_command do
-    name 'validate'
-    usage 'validate [validators] [options] [targets]'
-    summary 'Run static analysis tests.'
-    description "Run metadata, YAML, Puppet, Ruby, or Tasks validation.\n\n" \
-                '[validators] is an optional comma-separated list of validators to use. ' \
-                'If not specified, all validators are used. ' \
-                "Note that when using PowerShell, the list of validators must be enclosed in single quotes.\n\n" \
-                '[targets] is an optional space-separated list of files or directories to be validated. ' \
-                'If not specified, validators are run against all applicable files in the module.'
-
-    PDK::CLI.puppet_version_options(self)
-    PDK::CLI.puppet_dev_option(self)
-    flag nil, :list, 'List all available validators.'
-    flag :a, 'auto-correct', 'Automatically correct problems where possible.'
-    flag nil, :parallel, 'Run validations in parallel.'
-
-    run do |opts, args, _cmd|
-      # Write the context information to the debug log
-      PDK.context.to_debug_log
-
-      if args == ['help']
-        PDK::CLI.run(['validate', '--help'])
-        exit 0
-      end
+module PDK
+  module CLI
+    @validate_cmd = @base_cmd.define_command do
+      name 'validate'
+      usage 'validate [validators] [options] [targets]'
+      summary 'Run static analysis tests.'
+      description "Run metadata, YAML, Puppet, Ruby, or Tasks validation.\n\n" \
+                  '[validators] is an optional comma-separated list of validators to use. ' \
+                  'If not specified, all validators are used. ' \
+                  "Note that when using PowerShell, the list of validators must be enclosed in single quotes.\n\n" \
+                  '[targets] is an optional space-separated list of files or directories to be validated. ' \
+                  'If not specified, validators are run against all applicable files in the module.'
+
+      PDK::CLI.puppet_version_options(self)
+      PDK::CLI.puppet_dev_option(self)
+      flag nil, :list, 'List all available validators.'
+      flag :a, 'auto-correct', 'Automatically correct problems where possible.'
+      flag nil, :parallel, 'Run validations in parallel.'
+
+      run do |opts, args, _cmd|
+        # Write the context information to the debug log
+        PDK.context.to_debug_log
+
+        if args == ['help']
+          PDK::CLI.run(['validate', '--help'])
+          exit 0
+        end
 
-      require 'pdk/validate'
+        require 'pdk/validate'
 
-      if opts[:list]
-        PDK::CLI::Util.analytics_screen_view('validate', opts)
-        PDK.logger.info('Available validators: %{validator_names}' % { validator_names: PDK::Validate.validator_names.join(', ') })
-        exit 0
-      end
+        if opts[:list]
+          PDK::CLI::Util.analytics_screen_view('validate', opts)
+          PDK.logger.info(format('Available validators: %{validator_names}', validator_names: PDK::Validate.validator_names.join(', ')))
+          exit 0
+        end
 
-      PDK::CLI::Util.validate_puppet_version_opts(opts)
-      unless PDK.feature_flag?('controlrepo') || PDK.context.is_a?(PDK::Context::Module)
-        raise PDK::CLI::ExitWithError.new('Code validation can only be run from inside a valid module directory', log_level: :error)
-      end
+        PDK::CLI::Util.validate_puppet_version_opts(opts)
+        unless PDK.feature_flag?('controlrepo') || PDK.context.is_a?(PDK::Context::Module)
+          raise PDK::CLI::ExitWithError.new('Code validation can only be run from inside a valid module directory', log_level: :error)
+        end
 
-      PDK::CLI::Util.module_version_check if PDK.context.is_a?(PDK::Context::Module)
-
-      # Set the ruby version we're going to use early. Must be set before the validators are created.
-      # Note that this is a bit of code-smell and should be fixed
-      puppet_env = PDK::CLI::Util.puppet_from_opts_or_env(opts)
-      PDK::Util::RubyVersion.use(puppet_env[:ruby_version])
-
-      targets = []
-      validators_to_run = nil
-      if args[0]
-        # This may be a single validator, a list of validators, or a target.
-        if Util::OptionValidator.comma_separated_list?(args[0])
-          # This is a comma separated list. Treat each item as a validator.
-          vals = Util::OptionNormalizer.comma_separated_list_to_array(args[0])
-          validators_to_run = PDK::Validate.validator_names.select { |name| vals.include?(name) }
-
-          vals.reject { |v| PDK::Validate.validator_names.include?(v) }
-              .each do |v|
-            PDK.logger.warn("Unknown validator '%{v}'. Available validators: %{validators}." % { v: v, validators: PDK::Validate.validator_names.join(', ') })
-          end
-        else
-          # This is a single item. Check if it's a known validator, or otherwise treat it as a target.
-          val = PDK::Validate.validator_names.find { |name| args[0] == name }
-          if val
-            validators_to_run = [val]
+        PDK::CLI::Util.module_version_check if PDK.context.is_a?(PDK::Context::Module)
+
+        # Set the ruby version we're going to use early. Must be set before the validators are created.
+        # Note that this is a bit of code-smell and should be fixed
+        puppet_env = PDK::CLI::Util.puppet_from_opts_or_env(opts)
+        PDK::Util::RubyVersion.use(puppet_env[:ruby_version])
+
+        targets = []
+        validators_to_run = nil
+        if args[0]
+          # This may be a single validator, a list of validators, or a target.
+          if Util::OptionValidator.comma_separated_list?(args[0])
+            # This is a comma separated list. Treat each item as a validator.
+            vals = Util::OptionNormalizer.comma_separated_list_to_array(args[0])
+            validators_to_run = PDK::Validate.validator_names.select { |name| vals.include?(name) }
+
+            vals.reject { |v| PDK::Validate.validator_names.include?(v) }
+                .each do |v|
+              PDK.logger.warn(format("Unknown validator '%{v}'. Available validators: %{validators}.", v: v, validators: PDK::Validate.validator_names.join(', ')))
+            end
           else
-            targets = [args[0]]
-            # We now know that no validators were passed, so let the user know we're using all of them by default.
-            PDK.logger.info('Running all available validators...')
+            # This is a single item. Check if it's a known validator, or otherwise treat it as a target.
+            val = PDK::Validate.validator_names.find { |name| args[0] == name }
+            if val
+              validators_to_run = [val]
+            else
+              targets = [args[0]]
+              # We now know that no validators were passed, so let the user know we're using all of them by default.
+              PDK.logger.info('Running all available validators...')
+            end
           end
+        else
+          PDK.logger.info('Running all available validators...')
         end
-      else
-        PDK.logger.info('Running all available validators...')
-      end
-      validators_to_run = PDK::Validate.validator_names if validators_to_run.nil?
+        validators_to_run = PDK::Validate.validator_names if validators_to_run.nil?
 
-      if validators_to_run.sort == PDK::Validate.validator_names.sort
-        PDK::CLI::Util.analytics_screen_view('validate', opts)
-      else
-        PDK::CLI::Util.analytics_screen_view(['validate', validators_to_run.sort].flatten.join('_'), opts)
-      end
+        if validators_to_run.sort == PDK::Validate.validator_names.sort
+          PDK::CLI::Util.analytics_screen_view('validate', opts)
+        else
+          PDK::CLI::Util.analytics_screen_view(['validate', validators_to_run.sort].flatten.join('_'), opts)
+        end
 
-      # Subsequent arguments are targets.
-      targets.concat(args.to_a[1..-1]) if args.length > 1
+        # Subsequent arguments are targets.
+        targets.concat(args.to_a[1..]) if args.length > 1
 
-      report = PDK::Report.new
-      report_formats = if opts[:format]
-                         PDK::CLI::Util::OptionNormalizer.report_formats(opts[:format])
-                       else
-                         [{
-                           method: PDK::Report.default_format,
-                           target: PDK::Report.default_target,
-                         }]
-                       end
+        report = PDK::Report.new
+        report_formats = if opts[:format]
+                           PDK::CLI::Util::OptionNormalizer.report_formats(opts[:format])
+                         else
+                           [{
+                             method: PDK::Report.default_format,
+                             target: PDK::Report.default_target
+                           }]
+                         end
 
-      options = targets.empty? ? {} : { targets: targets }
-      options[:auto_correct] = true if opts[:'auto-correct']
-      options.merge!(puppet_env[:gemset])
+        options = targets.empty? ? {} : { targets: targets }
+        options[:auto_correct] = true if opts[:'auto-correct']
+        options.merge!(puppet_env[:gemset])
 
-      # Ensure that the bundled gems are up to date and correct Ruby is activated before running any validations.
-      # Note that if no Gemfile exists, then ensure_bundle! will log a debug message and exit gracefully
-      require 'pdk/util/bundler'
-      PDK::Util::Bundler.ensure_bundle!(puppet_env[:gemset])
+        # Ensure that the bundled gems are up to date and correct Ruby is activated before running any validations.
+        # Note that if no Gemfile exists, then ensure_bundle! will log a debug message and exit gracefully
+        require 'pdk/util/bundler'
+        PDK::Util::Bundler.ensure_bundle!(puppet_env[:gemset])
 
-      exit_code, report = PDK::Validate.invoke_validators_by_name(PDK.context, validators_to_run, opts.fetch(:parallel, false), options)
+        exit_code, report = PDK::Validate.invoke_validators_by_name(PDK.context, validators_to_run, opts.fetch(:parallel, false), options)
 
-      report_formats.each do |format|
-        report.send(format[:method], format[:target])
-      end
+        report_formats.each do |format|
+          report.send(format[:method], format[:target])
+        end
 
-      exit exit_code
+        exit exit_code
+      end
     end
   end
 end