pdk 2.3.0 → 2.4.0

data/lib/pdk/cli/validate.rb

@@ -1,116 +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
-
-      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
-
-      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]
-          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
-      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
-
-      # Subsequent arguments are targets.
-      targets.concat(args.to_a[1..-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
-
-      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])
-
-      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
-
-      exit exit_code
-    end
-  end
-end
+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
+
+      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
+
+      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]
+          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
+      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
+
+      # Subsequent arguments are targets.
+      targets.concat(args.to_a[1..-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
+
+      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])
+
+      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
+
+      exit exit_code
+    end
+  end
+end

data/lib/pdk/cli.rb

@@ -1,175 +1,175 @@
-require 'cri'
-
-require 'pdk'
-require 'pdk/cli/errors'
-
-module TTY
-  autoload :Prompt, 'tty/prompt'
-
-  class Prompt
-    autoload :Test, 'tty/prompt/test'
-  end
-end
-
-class Cri::Command::CriExitException
-  def initialize(is_error:)
-    @is_error = is_error
-    PDK.analytics.event('CLI', 'invalid command', label: PDK::CLI.anonymised_args.join(' ')) if error?
-  end
-end
-
-module PDK::CLI
-  autoload :Util, 'pdk/cli/util'
-
-  # Attempt to anonymise the raw ARGV array if the command parsing failed.
-  #
-  # If an item does not start with '-' but is preceeded by an item that does
-  # start with '-', assume that these items are an option/value pair and redact
-  # the value. Any additional values that do not start with '-' that follow an
-  # option/value pair are assumed to be arguments (rather than subcommand
-  # names) and are also redacted.
-  #
-  # @example
-  #   # Where PDK::CLI.args => ['new', 'plan', '--some', 'value', 'plan_name']
-  #
-  #   PDK::CLI.anonymised_args
-  #     => ['new', 'plan', '--some', 'redacted', 'redacted']
-  #
-  # @return Array[String] the command arguments with any identifying values
-  #   redacted.
-  def self.anonymised_args
-    in_args = false
-    @args.map do |arg|
-      if arg.start_with?('-')
-        in_args = true
-        arg
-      else
-        in_args ? 'redacted' : arg
-      end
-    end
-  end
-
-  def self.deprecated_runtime?
-    Gem::Version.new(RbConfig::CONFIG['ruby_version']) < Gem::Version.new('2.4.0')
-  end
-
-  def self.run(args)
-    if deprecated_runtime?
-      PDK.logger.info(
-        text: _(
-          'Support for Ruby versions older than 2.4 will be dropped in the ' \
-          'future PDK 2.0.0 release. We recommend updating your Ruby ' \
-          'installation to ensure that you can continue using the latest ' \
-          'version of PDK.',
-        ),
-        wrap: true,
-      )
-    end
-
-    @args = args
-    PDK::Config.analytics_config_interview! unless PDK::Util::Env['PDK_DISABLE_ANALYTICS'] || PDK::Config.analytics_config_exist?
-    @base_cmd.run(args)
-  rescue PDK::CLI::ExitWithError => e
-    PDK.logger.send(e.log_level, e.message)
-
-    exit e.exit_code
-  rescue PDK::CLI::FatalError => e
-    PDK.logger.fatal(e.message) if e.message
-
-    # If FatalError was raised as the result of another exception, send the
-    # details of that exception to the debug log. If there was no cause
-    # (FatalError raised on its own outside a rescue block), send the details
-    # of the FatalError exception to the debug log.
-    cause = e.cause
-    if cause.nil?
-      e.backtrace.each { |line| PDK.logger.debug(line) }
-    else
-      PDK.logger.debug("#{cause.class}: #{cause.message}")
-      cause.backtrace.each { |line| PDK.logger.debug(line) }
-    end
-
-    exit e.exit_code
-  end
-
-  def self.template_url_option(dsl)
-    require 'pdk/util/template_uri'
-
-    desc = _('Specifies the URL to the template to use when creating new modules or classes. (default: %{default_url})') % { default_url: PDK::Util::TemplateURI.default_template_uri }
-
-    dsl.option nil, 'template-url', desc, argument: :required
-  end
-
-  def self.template_ref_option(dsl)
-    dsl.option nil, 'template-ref', _('Specifies the template git branch or tag to use when creating new modules or classes.'), argument: :required
-  end
-
-  def self.skip_interview_option(dsl)
-    dsl.option nil, 'skip-interview', _('When specified, skips interactive querying of metadata.')
-  end
-
-  def self.full_interview_option(dsl)
-    dsl.option nil, 'full-interview', _('When specified, interactive querying of metadata will include all optional questions.')
-  end
-
-  def self.puppet_version_options(dsl)
-    dsl.option nil, 'puppet-version', _('Puppet version to run tests or validations against.'), argument: :required
-    dsl.option nil, 'pe-version', _('Puppet Enterprise version to run tests or validations against.'), argument: :required
-  end
-
-  def self.puppet_dev_option(dsl)
-    dsl.option nil,
-               'puppet-dev',
-               _('When specified, PDK will validate or test against the current Puppet source from github.com. To use this option, you must have network access to https://github.com.')
-  end
-
-  @base_cmd = Cri::Command.define do
-    name 'pdk'
-    usage _('pdk command [options]')
-    summary _('Puppet Development Kit')
-    description _('The shortest path to better modules.')
-    default_subcommand 'help'
-
-    flag nil, :version, _('Show version of pdk.') do |_, _|
-      puts PDK::Util::Version.version_string
-      exit 0
-    end
-
-    flag :h, :help, _('Show help for this command.') do |_, c|
-      puts c.help
-      exit 0
-    end
-
-    format_desc = _(
-      "Specify desired output format. Valid formats are '%{available_formats}'. " \
-      'You may also specify a file to which the formatted output is sent, ' \
-      "for example: '--format=junit:report.xml'. This option may be specified " \
-      'multiple times if each option specifies a distinct target file.',
-    ) % { available_formats: PDK::Report.formats.join("', '") }
-
-    option :f, :format, format_desc, argument: :required, multiple: true do |values|
-      PDK::CLI::Util::OptionNormalizer.report_formats(values.compact)
-    end
-
-    flag :d, :debug, _('Enable debug output.') do |_, _|
-      PDK.logger.enable_debug_output
-    end
-  end
-
-  require 'pdk/cli/bundle'
-  require 'pdk/cli/build'
-  require 'pdk/cli/config'
-  require 'pdk/cli/convert'
-  require 'pdk/cli/env'
-  require 'pdk/cli/get'
-  require 'pdk/cli/new'
-  require 'pdk/cli/set'
-  require 'pdk/cli/test'
-  require 'pdk/cli/update'
-  require 'pdk/cli/validate'
-  require 'pdk/cli/module'
-  require 'pdk/cli/console'
-  require 'pdk/cli/release'
-  require 'pdk/cli/remove'
-
-  @base_cmd.add_command Cri::Command.new_basic_help
-end
+require 'cri'
+
+require 'pdk'
+require 'pdk/cli/errors'
+
+module TTY
+  autoload :Prompt, 'tty/prompt'
+
+  class Prompt
+    autoload :Test, 'tty/prompt/test'
+  end
+end
+
+class Cri::Command::CriExitException
+  def initialize(is_error:)
+    @is_error = is_error
+    PDK.analytics.event('CLI', 'invalid command', label: PDK::CLI.anonymised_args.join(' ')) if error?
+  end
+end
+
+module PDK::CLI
+  autoload :Util, 'pdk/cli/util'
+
+  # Attempt to anonymise the raw ARGV array if the command parsing failed.
+  #
+  # If an item does not start with '-' but is preceeded by an item that does
+  # start with '-', assume that these items are an option/value pair and redact
+  # the value. Any additional values that do not start with '-' that follow an
+  # option/value pair are assumed to be arguments (rather than subcommand
+  # names) and are also redacted.
+  #
+  # @example
+  #   # Where PDK::CLI.args => ['new', 'plan', '--some', 'value', 'plan_name']
+  #
+  #   PDK::CLI.anonymised_args
+  #     => ['new', 'plan', '--some', 'redacted', 'redacted']
+  #
+  # @return Array[String] the command arguments with any identifying values
+  #   redacted.
+  def self.anonymised_args
+    in_args = false
+    @args.map do |arg|
+      if arg.start_with?('-')
+        in_args = true
+        arg
+      else
+        in_args ? 'redacted' : arg
+      end
+    end
+  end
+
+  def self.deprecated_runtime?
+    Gem::Version.new(RbConfig::CONFIG['ruby_version']) < Gem::Version.new('2.4.0')
+  end
+
+  def self.run(args)
+    if deprecated_runtime?
+      PDK.logger.info(
+        text: _(
+          'Support for Ruby versions older than 2.4 will be dropped in the ' \
+          'future PDK 2.0.0 release. We recommend updating your Ruby ' \
+          'installation to ensure that you can continue using the latest ' \
+          'version of PDK.',
+        ),
+        wrap: true,
+      )
+    end
+
+    @args = args
+    PDK::Config.analytics_config_interview! unless PDK::Util::Env['PDK_DISABLE_ANALYTICS'] || PDK::Config.analytics_config_exist?
+    @base_cmd.run(args)
+  rescue PDK::CLI::ExitWithError => e
+    PDK.logger.send(e.log_level, e.message)
+
+    exit e.exit_code
+  rescue PDK::CLI::FatalError => e
+    PDK.logger.fatal(e.message) if e.message
+
+    # If FatalError was raised as the result of another exception, send the
+    # details of that exception to the debug log. If there was no cause
+    # (FatalError raised on its own outside a rescue block), send the details
+    # of the FatalError exception to the debug log.
+    cause = e.cause
+    if cause.nil?
+      e.backtrace.each { |line| PDK.logger.debug(line) }
+    else
+      PDK.logger.debug("#{cause.class}: #{cause.message}")
+      cause.backtrace.each { |line| PDK.logger.debug(line) }
+    end
+
+    exit e.exit_code
+  end
+
+  def self.template_url_option(dsl)
+    require 'pdk/util/template_uri'
+
+    desc = _('Specifies the URL to the template to use when creating new modules or classes. (default: %{default_url})') % { default_url: PDK::Util::TemplateURI.default_template_uri }
+
+    dsl.option nil, 'template-url', desc, argument: :required
+  end
+
+  def self.template_ref_option(dsl)
+    dsl.option nil, 'template-ref', _('Specifies the template git branch or tag to use when creating new modules or classes.'), argument: :required
+  end
+
+  def self.skip_interview_option(dsl)
+    dsl.option nil, 'skip-interview', _('When specified, skips interactive querying of metadata.')
+  end
+
+  def self.full_interview_option(dsl)
+    dsl.option nil, 'full-interview', _('When specified, interactive querying of metadata will include all optional questions.')
+  end
+
+  def self.puppet_version_options(dsl)
+    dsl.option nil, 'puppet-version', _('Puppet version to run tests or validations against.'), argument: :required
+    dsl.option nil, 'pe-version', _('Puppet Enterprise version to run tests or validations against.'), argument: :required
+  end
+
+  def self.puppet_dev_option(dsl)
+    dsl.option nil,
+               'puppet-dev',
+               _('When specified, PDK will validate or test against the current Puppet source from github.com. To use this option, you must have network access to https://github.com.')
+  end
+
+  @base_cmd = Cri::Command.define do
+    name 'pdk'
+    usage _('pdk command [options]')
+    summary _('Puppet Development Kit')
+    description _('The shortest path to better modules.')
+    default_subcommand 'help'
+
+    flag nil, :version, _('Show version of pdk.') do |_, _|
+      puts PDK::Util::Version.version_string
+      exit 0
+    end
+
+    flag :h, :help, _('Show help for this command.') do |_, c|
+      puts c.help
+      exit 0
+    end
+
+    format_desc = _(
+      "Specify desired output format. Valid formats are '%{available_formats}'. " \
+      'You may also specify a file to which the formatted output is sent, ' \
+      "for example: '--format=junit:report.xml'. This option may be specified " \
+      'multiple times if each option specifies a distinct target file.',
+    ) % { available_formats: PDK::Report.formats.join("', '") }
+
+    option :f, :format, format_desc, argument: :required, multiple: true do |values|
+      PDK::CLI::Util::OptionNormalizer.report_formats(values.compact)
+    end
+
+    flag :d, :debug, _('Enable debug output.') do |_, _|
+      PDK.logger.enable_debug_output
+    end
+  end
+
+  require 'pdk/cli/bundle'
+  require 'pdk/cli/build'
+  require 'pdk/cli/config'
+  require 'pdk/cli/convert'
+  require 'pdk/cli/env'
+  require 'pdk/cli/get'
+  require 'pdk/cli/new'
+  require 'pdk/cli/set'
+  require 'pdk/cli/test'
+  require 'pdk/cli/update'
+  require 'pdk/cli/validate'
+  require 'pdk/cli/module'
+  require 'pdk/cli/console'
+  require 'pdk/cli/release'
+  require 'pdk/cli/remove'
+
+  @base_cmd.add_command Cri::Command.new_basic_help
+end

data/lib/pdk/config/analytics_schema.json

@@ -1,26 +1,26 @@
-{
-  "definitions": {},
-  "$schema": "http://json-schema.org/draft-06/schema#",
-  "$id": "http://puppet.com/schema/does_not_exist.json",
-  "type": "object",
-  "title": "The PDK Analytics YAML Schema",
-  "properties": {
-    "disabled": {
-      "$id": "#/properties/disabled",
-      "type": "boolean",
-      "title": "Disabled property",
-      "examples": [
-        false
-      ]
-    },
-    "user-id": {
-      "$id": "#/properties/user-id",
-      "type": "string",
-      "title": "The User-id for analytics",
-      "examples": [
-        "cb9ed65f-37dc-48d8-9863-8bd09cbb61c7"
-      ],
-      "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$"
-    }
-  }
-}
+{
+  "definitions": {},
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "$id": "http://puppet.com/schema/does_not_exist.json",
+  "type": "object",
+  "title": "The PDK Analytics YAML Schema",
+  "properties": {
+    "disabled": {
+      "$id": "#/properties/disabled",
+      "type": "boolean",
+      "title": "Disabled property",
+      "examples": [
+        false
+      ]
+    },
+    "user-id": {
+      "$id": "#/properties/user-id",
+      "type": "string",
+      "title": "The User-id for analytics",
+      "examples": [
+        "cb9ed65f-37dc-48d8-9863-8bd09cbb61c7"
+      ],
+      "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$"
+    }
+  }
+}

data/lib/pdk/config/errors.rb

@@ -1,5 +1,5 @@
-module PDK
-  class Config
-    class LoadError < StandardError; end
-  end
-end
+module PDK
+  class Config
+    class LoadError < StandardError; end
+  end
+end