pdk 2.7.1 → 3.0.1

data/lib/pdk/cli.rb

@@ -11,148 +11,152 @@ module TTY
   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?
+module Cri
+  class Command
+    class 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
   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
+module PDK
+  module 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
-  end
 
-  def self.run(args)
-    @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) }
+    def self.run(args)
+      @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
 
-    exit e.exit_code
-  end
+    def self.template_url_option(dsl)
+      require 'pdk/util/template_uri'
 
-  def self.template_url_option(dsl)
-    require 'pdk/util/template_uri'
+      desc = format('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)
 
-    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
 
-    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.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.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.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', '(Deprecated) Puppet Enterprise version to run tests or validations against.', argument: :required
+    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
 
-  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'
 
-  @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 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
 
-    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 '#{PDK::Report.formats.join("', '")}'. " \
+        '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.'
 
-    format_desc =
-      "Specify desired output format. Valid formats are '#{PDK::Report.formats.join("', '")}'. " \
-      '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.'
+      option :f, :format, format_desc, argument: :required, multiple: true do |values|
+        PDK::CLI::Util::OptionNormalizer.report_formats(values.compact)
+      end
 
-    option :f, :format, format_desc, argument: :required, multiple: true do |values|
-      PDK::CLI::Util::OptionNormalizer.report_formats(values.compact)
+      flag :d, :debug, 'Enable debug output.' do |_, _|
+        PDK.logger.enable_debug_output
+      end
     end
 
-    flag :d, :debug, 'Enable debug output.' do |_, _|
-      PDK.logger.enable_debug_output
-    end
+    require 'pdk/cli/bundle'
+    require 'pdk/cli/build'
+    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/console' Temporarily disabled while we work on the puppet-debugger gem. It will be back soon! (CONT-1154)
+    require 'pdk/cli/release'
+    require 'pdk/cli/remove'
+
+    @base_cmd.add_command Cri::Command.new_basic_help
   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/ini_file.rb

@@ -15,6 +15,7 @@ module PDK
       # @see PDK::Config::Namespace.parse_file
       def parse_file(filename)
         raise unless block_given?
+
         data = load_data(filename)
         return if data.nil? || data.empty?
 
@@ -39,11 +40,13 @@ module PDK
         lines = ''
         data.each do |name, value|
           next if value.nil?
+
           if value.is_a?(Hash)
             # Hashes are an INI section
             lines += "\n[#{name}]\n"
             value.each do |child_name, child_value|
               next if child_value.nil?
+
               lines += "#{child_name} = #{munge_serialized_value(child_value)}\n"
             end
           else
@@ -59,12 +62,11 @@ module PDK
       def munge_serialized_value(value)
         value = value.to_s unless value.is_a?(String)
         # Add enclosing quotes if there's a space in the value
-        value = '"' + value + '"' if value.include?(' ')
+        value = "\"#{value}\"" if value.include?(' ')
         value
       end
 
       # Adapted from https://raw.githubusercontent.com/puppetlabs/puppet/6c257fc7827989c2af2901f974666f0f23611153/lib/puppet/settings/ini_file.rb
-      # rubocop:disable Style/RegexpLiteral
       # rubocop:disable Style/PerlBackrefs
       # rubocop:disable Style/RedundantSelf
       # rubocop:disable Style/StringLiterals
@@ -177,7 +179,6 @@ module PDK
       # rubocop:enable Style/StringLiterals
       # rubocop:enable Style/RedundantSelf
       # rubocop:enable Style/PerlBackrefs
-      # rubocop:enable Style/RegexpLiteral
     end
   end
 end

data/lib/pdk/config/ini_file_setting.rb

@@ -8,6 +8,7 @@ module PDK
       # @see PDK::Config::Setting.initialize
       def initialize(_name, namespace, initial_value = nil)
         raise 'The IniFileSetting object can only be created within the IniFile Namespace' unless namespace.is_a?(PDK::Config::IniFile)
+
         super
         validate!(initial_value) unless initial_value.nil?
       end
@@ -18,20 +19,15 @@ module PDK
       def validate!(value)
         # We're very restrictive here. Realistically Ini files only have string types
         return if value.nil? || value.is_a?(String) || value.is_a?(Integer)
+
         # The only other valid-ish type is a Hash
-        unless value.is_a?(Hash)
-          raise ArgumentError, 'The setting %{key} may only be a String or Integer, not %{class}' % {
-            key:  qualified_name,
-            class: value.class,
-          }
-        end
+        raise ArgumentError, format('The setting %{key} may only be a String or Integer, not %{class}', key: qualified_name, class: value.class) unless value.is_a?(Hash)
+
         # Any hashes can only have a single String/Integer value
         value.each do |child_name, child_value|
           next if child_value.nil? || child_value.is_a?(String) || child_value.is_a?(Integer)
-          raise ArgumentError, 'The setting %{key} may only be a String or Integer, not %{class}' % {
-            key:   qualified_name + '.' + child_name,
-            class: child_value.class,
-          }
+
+          raise ArgumentError, format('The setting %{key} may only be a String or Integer, not %{class}', key: "#{qualified_name}.#{child_name}", class: child_value.class)
         end
       end
     end

data/lib/pdk/config/json.rb

@@ -8,6 +8,7 @@ module PDK
       # @see PDK::Config::Namespace.parse_file
       def parse_file(filename)
         raise unless block_given?
+
         data = load_data(filename)
         return if data.nil? || data.empty?
 

data/lib/pdk/config/json_schema_namespace.rb

@@ -58,6 +58,7 @@ module PDK
       # @return [String[]]
       def schema_property_names
         return [] if schema['properties'].nil?
+
         schema['properties'].keys
       end
 
@@ -119,23 +120,17 @@ module PDK
         @document_schema = create_empty_schema
 
         return @document_schema if @schema_file.nil?
-        unless PDK::Util::Filesystem.file?(@schema_file)
-          raise PDK::Config::LoadError, 'Unable to open %{file} for reading. File does not exist' % {
-            file: @schema_file,
-          }
-        end
+
+        raise PDK::Config::LoadError, format('Unable to open %{file} for reading. File does not exist', file: @schema_file) unless PDK::Util::Filesystem.file?(@schema_file)
 
         # The schema should not query external URI references, except for the meta-schema. Local files are allowed
         schema_reader = ::JSON::Schema::Reader.new(
           accept_file: true,
-          accept_uri:  proc { |uri| uri.host.nil? || ['json-schema.org'].include?(uri.host) },
+          accept_uri: proc { |uri| uri.host.nil? || ['json-schema.org'].include?(uri.host) }
         )
         @document_schema = schema_reader.read(Addressable::URI.convert_path(@schema_file))
       rescue ::JSON::Schema::JsonParseError => e
-        raise PDK::Config::LoadError, 'Unable to open %{file} for reading. JSON Error: %{msg}' % {
-          file: @schema_file,
-          msg: e.message,
-        }
+        raise PDK::Config::LoadError, format('Unable to open %{file} for reading. JSON Error: %{msg}', file: @schema_file, msg: e.message)
       end
     end
   end

data/lib/pdk/config/json_schema_setting.rb

@@ -8,6 +8,7 @@ module PDK
       # @see PDK::Config::Setting.initialize
       def initialize(_name, namespace, _initial_value)
         raise 'The JSONSchemaSetting object can only be created within the JSONSchemaNamespace' unless namespace.is_a?(PDK::Config::JSONSchemaNamespace)
+
         super
       end
 
@@ -24,10 +25,7 @@ module PDK
           # ... add validate it
           namespace.validate_document!(new_document)
         rescue ::JSON::Schema::ValidationError => e
-          raise ArgumentError, '%{key} %{message}' % {
-            key:     qualified_name,
-            message: e.message,
-          }
+          raise ArgumentError, format('%{key} %{message}', key: qualified_name, message: e.message)
         end
       end
 
@@ -46,7 +44,7 @@ module PDK
         end
         # ... otherwise call the settings chain default
         # and if that doesn't exist, just return nil
-        @previous_setting.nil? ? nil : @previous_setting.default
+        @previous_setting&.default
       end
     end
   end

data/lib/pdk/config/json_with_schema.rb

@@ -8,6 +8,7 @@ module PDK
       # @see PDK::Config::Namespace.parse_file
       def parse_file(filename)
         raise unless block_given?
+
         data = load_data(filename)
         data = '{}' if data.nil? || data.empty?
         require 'json'
@@ -19,10 +20,7 @@ module PDK
           # Ensure the parsed document is actually valid
           validate_document!(@raw_data)
         rescue ::JSON::Schema::ValidationError => e
-          raise PDK::Config::LoadError, 'The configuration file %{filename} is not valid: %{message}' % {
-            filename: filename,
-            message:  e.message,
-          }
+          raise PDK::Config::LoadError, format('The configuration file %{filename} is not valid: %{message}', filename: filename, message: e.message)
         end
 
         schema_property_names.each do |key|

data/lib/pdk/config/namespace.rb

@@ -36,7 +36,7 @@ module PDK
         @loaded_from_file = false
         @read_only = false
 
-        instance_eval(&block) if block_given?
+        instance_eval(&block) if block
       end
 
       # Pre-configure a value in the namespace.
@@ -50,7 +50,7 @@ module PDK
       # @return [nil]
       def setting(key, &block)
         @settings[key.to_s] ||= default_setting_class.new(key.to_s, self)
-        @settings[key.to_s].instance_eval(&block) if block_given?
+        @settings[key.to_s].instance_eval(&block) if block
       end
 
       # Mount a provided [self] (or subclass) into the namespace.
@@ -66,9 +66,10 @@ module PDK
       # @return [self] the mounted namespace.
       def mount(key, obj, &block)
         raise ArgumentError, 'Only PDK::Config::Namespace objects can be mounted into a namespace' unless obj.is_a?(PDK::Config::Namespace)
+
         obj.parent = self
         obj.name = key.to_s
-        obj.instance_eval(&block) if block_given?
+        obj.instance_eval(&block) if block
         @mounts[key.to_s] = obj
       end
 
@@ -98,9 +99,11 @@ module PDK
         # Check if it's a setting, otherwise nil
         return nil if settings[key.to_s].nil?
         return settings[key.to_s].value unless settings[key.to_s].value.nil?
+
         # Duplicate arrays and hashes so that they are isolated from changes being made
         default_value = PDK::Util.deep_duplicate(settings[key.to_s].default)
         return default_value if default_value.nil? || !@persistent_defaults
+
         # Persist the default value
         settings[key.to_s].value = default_value
         save_data
@@ -125,6 +128,7 @@ module PDK
         return @mounts[key.to_s] unless @mounts[key.to_s].nil?
         # Check if it's a setting, otherwise default_value
         return default_value if settings[key.to_s].nil?
+
         # Check if has a value, otherwise default_value
         settings[key.to_s].value.nil? ? default_value : settings[key.to_s].value
       end
@@ -139,6 +143,7 @@ module PDK
       def []=(key, value)
         # You can't set the value of a mount
         raise ArgumentError, 'Namespace mounts can not be set a value' unless @mounts[key.to_s].nil?
+
         set_volatile_value(key, value)
         # Persist the change
         save_data
@@ -157,7 +162,7 @@ module PDK
         new_hash = {}
         settings.each_pair { |k, v| new_hash[k] = v.value }
         @mounts.each_pair { |k, mount_point| new_hash[k] = mount_point.to_h if mount_point.include_in_parent? }
-        new_hash.delete_if { |_, v| v.nil? }
+        new_hash.delete_if { |_k, v| v.nil? } # rubocop :disable Style/CollectionCompact
         new_hash
       end
 
@@ -168,14 +173,14 @@ module PDK
       def resolve(filter = nil)
         resolved = {}
         # Resolve the settings
-        settings.values.each do |setting|
+        settings.each_value do |setting|
           setting_name = setting.qualified_name
           if be_resolved?(setting_name, filter)
             resolved[setting_name] = setting.value.nil? ? setting.default : setting.value
           end
         end
         # Resolve the mounts
-        @mounts.values.each { |mount| resolved.merge!(mount.resolve(filter)) }
+        @mounts.each_value { |mount| resolved.merge!(mount.resolve(filter)) }
         resolved
       end
 
@@ -212,7 +217,9 @@ module PDK
       # @api private
       def read_only!
         @read_only = true
-        @mounts.each { |_, child| child.read_only! }
+        # pass the read_only! method as a block to the each_value method. This means that
+        # for each value in the @mounts hash, the read_only! method will be called on that value.
+        @mounts.each_value(&:read_only!)
       end
 
       private
@@ -239,7 +246,8 @@ module PDK
       def be_resolved?(name, filter = nil)
         return true if filter.nil? # If we're not filtering, this value should always be resolved
         return true if name == filter # If it's exactly the same name then it should be resolved
-        name.start_with?(filter + '.') # If name is a subkey of the filter then it should be resolved
+
+        name.start_with?("#{filter}.") # If name is a subkey of the filter then it should be resolved
       end
 
       # @abstract Subclass and override {#parse_file} to implement parsing logic
@@ -273,6 +281,7 @@ module PDK
         # Need to use `@settings` and `@mounts` here to stop recursive calls
         return unless @mounts[key.to_s].nil?
         return unless @settings[key.to_s].nil?
+
         @settings[key.to_s] = default_setting_class.new(key.to_s, self, initial_value)
       end
 
@@ -286,6 +295,7 @@ module PDK
       def set_volatile_value(key, value)
         # Need to use `settings` here to force the backing file to be loaded
         return create_missing_setting(key, value) if settings[key.to_s].nil?
+
         # Need to use `@settings` here to stop recursive calls from []=
         @settings[key.to_s].value = value
       end
@@ -305,9 +315,7 @@ module PDK
       rescue Errno::ENOENT => e
         raise PDK::Config::LoadError, e.message
       rescue Errno::EACCES
-        raise PDK::Config::LoadError, 'Unable to open %{file} for reading' % {
-          file: filename,
-        }
+        raise PDK::Config::LoadError, format('Unable to open %{file} for reading', file: filename)
       end
 
       # Persist the contents of the namespace to disk.
@@ -328,9 +336,7 @@ module PDK
 
         PDK::Util::Filesystem.write_file(file, serialize_data(to_h))
       rescue Errno::EACCES
-        raise PDK::Config::LoadError, 'Unable to open %{file} for writing' % {
-          file: file,
-        }
+        raise PDK::Config::LoadError, format('Unable to open %{file} for writing', file: file)
       rescue SystemCallError => e
         raise PDK::Config::LoadError, e.message
       end
@@ -340,8 +346,10 @@ module PDK
       # @return [Hash<String => PDK::Config::Setting>] the contents of the namespace.
       def settings
         return @settings if @loaded_from_file
+
         @loaded_from_file = true
         return @settings if file.nil?
+
         parse_file(file) do |key, parsed_setting|
           # Create a settings chain if a setting already exists
           parsed_setting.previous_setting = @settings[key] unless @settings[key].nil?

data/lib/pdk/config/setting.rb

@@ -96,10 +96,7 @@ module PDK
         @validators.each do |validator|
           next if validator[:proc].call(value)
 
-          raise ArgumentError, '%{key} %{message}' % {
-            key:     qualified_name,
-            message: validator[:message],
-          }
+          raise ArgumentError, format('%{key} %{message}', key: qualified_name, message: validator[:message])
         end
       end
 
@@ -110,7 +107,8 @@ module PDK
       #
       # @return [nil]
       def default_to(&block)
-        raise ArgumentError, 'must be passed a block' unless block_given?
+        raise ArgumentError, 'must be passed a block' unless block
+
         @default_to = block
       end
 
@@ -120,8 +118,9 @@ module PDK
       #   {#default_to}, or `nil` if the setting has no default.
       def default
         return @default_to.call if default_block?
+
         # If there is a previous setting in the chain, use its default
-        @previous_setting.nil? ? nil : @previous_setting.default
+        @previous_setting&.default
       end
 
       private