pdk 2.7.0 → 3.0.0

data/lib/pdk/validate/tasks/tasks_metadata_lint_validator.rb

@@ -4,8 +4,6 @@ module PDK
   module Validate
     module Tasks
       class TasksMetadataLintValidator < InternalRubyValidator
-        FORGE_SCHEMA_URL = 'https://forgeapi.puppet.com/schemas/task.json'.freeze
-
         def name
           'task-metadata-lint'
         end
@@ -15,19 +13,16 @@ module PDK
         end
 
         def spinner_text
-          'Checking task metadata style (%{pattern}).' % {
-            pattern: pattern.join(' '),
-          }
+          format('Checking task metadata style (%{pattern}).', pattern: pattern.join(' '))
         end
 
         def schema_file
-          require 'pdk/util/vendored_file'
+          require 'pdk/config'
 
-          schema = PDK::Util::VendoredFile.new('task.json', FORGE_SCHEMA_URL).read
+          path = PDK::Config.json_schema('task')
+          schema = PDK::Util::Filesystem.read_file(path)
 
           JSON.parse(schema)
-        rescue PDK::Util::VendoredFile::DownloadError => e
-          raise PDK::CLI::FatalError, e.message
         rescue JSON::ParserError
           raise PDK::CLI::FatalError, 'Failed to parse Task Metadata Schema file.'
         end
@@ -35,11 +30,11 @@ module PDK
         def validate_target(report, target)
           unless PDK::Util::Filesystem.readable?(target)
             report.add_event(
-              file:     target,
-              source:   name,
-              state:    :failure,
+              file: target,
+              source: name,
+              state: :failure,
               severity: 'error',
-              message: 'Could not be read.',
+              message: 'Could not be read.'
             )
             return 1
           end
@@ -54,31 +49,31 @@ module PDK
             begin
               errors = JSON::Validator.fully_validate(schema_file, PDK::Util::Filesystem.read_file(target)) || []
             rescue JSON::Schema::SchemaError => e
-              raise PDK::CLI::FatalError, 'Unable to validate Task Metadata. %{error}.' % { error: e.message }
+              raise PDK::CLI::FatalError, format('Unable to validate Task Metadata. %{error}.', error: e.message)
             end
 
             if errors.empty?
               report.add_event(
-                file:     target,
-                source:   name,
-                state:    :passed,
-                severity: 'ok',
+                file: target,
+                source: name,
+                state: :passed,
+                severity: 'ok'
               )
-              return 0
+              0
             else
               errors.each do |error|
                 # strip off the trailing parts that aren't relevant
                 error = error.split('in schema').first if error.include? 'in schema'
 
                 report.add_event(
-                  file:     target,
-                  source:   name,
-                  state:    :failure,
+                  file: target,
+                  source: name,
+                  state: :failure,
                   severity: 'error',
-                  message:  error,
+                  message: error
                 )
               end
-              return 1
+              1
             end
           end
         end

data/lib/pdk/validate/tasks/tasks_name_validator.rb

@@ -15,30 +15,28 @@ module PDK
         end
 
         def spinner_text
-          'Checking task names (%{pattern}).' % {
-            pattern: pattern.join(' '),
-          }
+          format('Checking task names (%{pattern}).', pattern: pattern.join(' '))
         end
 
         def validate_target(report, target)
           task_name = File.basename(target, File.extname(target))
           if PDK::CLI::Util::OptionValidator.valid_task_name?(task_name)
             report.add_event(
-              file:     target,
-              source:   name,
-              state:    :passed,
-              severity: 'ok',
+              file: target,
+              source: name,
+              state: :passed,
+              severity: 'ok'
             )
-            return 0
+            0
           else
             report.add_event(
-              file:     target,
-              source:   name,
-              state:    :failure,
+              file: target,
+              source: name,
+              state: :failure,
               severity: 'error',
-              message:  INVALID_TASK_MSG,
+              message: INVALID_TASK_MSG
             )
-            return 1
+            1
           end
         end
       end

data/lib/pdk/validate/tasks/tasks_validator_group.rb

@@ -11,7 +11,7 @@ module PDK
         def validators
           [
             TasksNameValidator,
-            TasksMetadataLintValidator,
+            TasksMetadataLintValidator
           ].freeze
         end
       end

data/lib/pdk/validate/validator.rb

@@ -33,7 +33,8 @@ module PDK
         if context.nil?
           @context = PDK::Context::None.new(nil)
         else
-          raise ArgumentError, 'Expected PDK::Context::AbstractContext but got \'%{klass}\' for context' % { klass: context.class } unless context.is_a?(PDK::Context::AbstractContext)
+          raise ArgumentError, format('Expected PDK::Context::AbstractContext but got \'%{klass}\' for context', klass: context.class) unless context.is_a?(PDK::Context::AbstractContext)
+
           @context = context
         end
         @options = options.dup.freeze
@@ -76,7 +77,7 @@ module PDK
       # Start the spinner if it exists
       # @api private
       def start_spinner
-        spinner.auto_spin unless spinner.nil?
+        spinner&.auto_spin
         nil
       end
 
@@ -84,6 +85,7 @@ module PDK
       # @api private
       def stop_spinner(success)
         return if spinner.nil?
+
         success ? spinner.success : spinner.error
         nil
       end

data/lib/pdk/validate/validator_group.rb

@@ -32,13 +32,14 @@ module PDK
     class ValidatorGroup < Validator
       # @see PDK::Validate::Validator.spinner_text
       def spinner_text
-        'Running %{name} validators ...' % { name: name }
+        format('Running %{name} validators ...', name: name)
       end
 
       # @see PDK::Validate::Validator.spinner
       def spinner
         return nil unless spinners_enabled?
         return @spinner unless @spinner.nil?
+
         require 'pdk/cli/util/spinner'
 
         @spinner = TTY::Spinner::Multi.new("[:spinner] #{spinner_text}", PDK::CLI::Util.spinner_opts_for_platform)
@@ -46,6 +47,7 @@ module PDK
         # Register the child spinners
         validator_instances.each do |instance|
           next if instance.spinner.nil?
+
           @spinner.register(instance.spinner)
         end
 
@@ -58,13 +60,14 @@ module PDK
       # @see PDK::Validate::Validator.prepare_invoke!
       def prepare_invoke!
         return if @prepared
+
         super
 
         # Force the spinner to be registered etc.
         spinner
 
         # Prepare child validators
-        validator_instances.each { |instance| instance.prepare_invoke! }
+        validator_instances.each(&:prepare_invoke!)
         nil
       end
 
@@ -97,7 +100,7 @@ module PDK
       # @api private
       def validator_instances
         @validator_instances ||= validators.map { |klass| klass.new(context, options.merge(parent_validator: self)) }
-                                           .select { |instance| instance.valid_in_context? }
+                                           .select(&:valid_in_context?)
       end
     end
   end

data/lib/pdk/validate/yaml/yaml_syntax_validator.rb

@@ -17,14 +17,12 @@ module PDK
         def pattern
           [
             '**/*.yaml',
-            '**/*.yml',
+            '**/*.yml'
           ].tap do |pat|
             if context.is_a?(PDK::Context::ControlRepo)
-              pat.concat(
-                [
-                  '**/*.eyaml',
-                  '**/*.eyml',
-                ],
+              pat.push(
+                '**/*.eyaml',
+                '**/*.eyml'
               )
             else
               pat
@@ -33,9 +31,7 @@ module PDK
         end
 
         def spinner_text
-          'Checking YAML syntax (%{patterns}).' % {
-            patterns: pattern.join(' '),
-          }
+          format('Checking YAML syntax (%{patterns}).', patterns: pattern.join(' '))
         end
 
         def validate_target(report, target)
@@ -43,50 +39,45 @@ module PDK
 
           unless PDK::Util::Filesystem.readable?(target)
             report.add_event(
-              file:     target,
-              source:   name,
-              state:    :failure,
+              file: target,
+              source: name,
+              state: :failure,
               severity: 'error',
-              message:  'Could not be read.',
+              message: 'Could not be read.'
             )
             return 1
           end
 
           begin
-            ::YAML.safe_load(PDK::Util::Filesystem.read_file(target), YAML_ALLOWLISTED_CLASSES, [], true)
+            ::YAML.safe_load(PDK::Util::Filesystem.read_file(target), permitted_classes: YAML_ALLOWLISTED_CLASSES, permitted_symbols: [], aliases: true)
 
             report.add_event(
-              file:     target,
-              source:   name,
-              state:    :passed,
-              severity: 'ok',
+              file: target,
+              source: name,
+              state: :passed,
+              severity: 'ok'
             )
-            return 0
+            0
           rescue Psych::SyntaxError => e
             report.add_event(
-              file:     target,
-              source:   name,
-              state:    :failure,
+              file: target,
+              source: name,
+              state: :failure,
               severity: 'error',
-              line:     e.line,
-              column:   e.column,
-              message:  '%{problem} %{context}' % {
-                problem: e.problem,
-                context: e.context,
-              },
+              line: e.line,
+              column: e.column,
+              message: format('%{problem} %{context}', problem: e.problem, context: e.context)
             )
-            return 1
+            1
           rescue Psych::DisallowedClass => e
             report.add_event(
-              file:     target,
-              source:   name,
-              state:    :failure,
+              file: target,
+              source: name,
+              state: :failure,
               severity: 'error',
-              message:  'Unsupported class: %{message}' % {
-                message: e.message,
-              },
+              message: format('Unsupported class: %{message}', message: e.message)
             )
-            return 1
+            1
           end
         end
       end

data/lib/pdk/validate/yaml/yaml_validator_group.rb

@@ -10,7 +10,7 @@ module PDK
 
         def validators
           [
-            YAMLSyntaxValidator,
+            YAMLSyntaxValidator
           ].freeze
         end
       end

data/lib/pdk/validate.rb

@@ -60,15 +60,15 @@ module PDK
         Puppet::PuppetValidatorGroup,
         Ruby::RubyValidatorGroup,
         Tasks::TasksValidatorGroup,
-        YAML::YAMLValidatorGroup,
-      ].map { |klass| [klass.new.name, klass] }.to_h.freeze
+        YAML::YAMLValidatorGroup
+      ].to_h { |klass| [klass.new.name, klass] }.freeze
     end
 
     def self.invoke_validators_by_name(context, names, parallel = false, options = {})
       instances = names.select { |name| validator_names.include?(name) }
                        .map { |name| validator_hash[name].new(context, options) }
-                       .select { |instance| instance.valid_in_context? }
-                       .each { |instance| instance.prepare_invoke! }
+                       .select(&:valid_in_context?)
+                       .each(&:prepare_invoke!)
       report = PDK::Report.new
 
       # Nothing to validate then nothing to do.
@@ -76,9 +76,9 @@ module PDK
 
       require 'pdk/cli/exec_group'
       exec_group = PDK::CLI::ExecGroup.create(
-        'Validating module using %{num_of_threads} threads' % { num_of_threads: instances.count },
+        format('Validating module using %{num_of_threads} threads', num_of_threads: instances.count),
         { parallel: parallel },
-        options,
+        options
       )
 
       instances.each do |validator|

data/lib/pdk/version.rb

@@ -1,4 +1,4 @@
 module PDK
-  VERSION = '2.7.0'.freeze
-  TEMPLATE_REF = '2.7.2'.freeze
+  VERSION = '3.0.0'.freeze
+  TEMPLATE_REF = '3.0.0'.freeze
 end

data/lib/pdk.rb

@@ -35,6 +35,7 @@ module PDK
 
   def self.config
     return @config unless @config.nil?
+
     options = {}
     options['user.module_defaults.path'] = PDK::Util::Env['PDK_ANSWER_FILE'] unless PDK::Util::Env['PDK_ANSWER_FILE'].nil?
     @config = PDK::Config.new(options)
@@ -45,30 +46,29 @@ module PDK
   end
 
   def self.available_feature_flags
-    @available_feature_flags ||= %w[
-      controlrepo
-    ].freeze
+    @available_feature_flags ||= ['controlrepo'].freeze
   end
 
   def self.requested_feature_flags
-    @requested_feature_flags ||= (PDK::Util::Env['PDK_FEATURE_FLAGS'] || '').split(',').map { |flag| flag.strip }
+    @requested_feature_flags ||= (PDK::Util::Env['PDK_FEATURE_FLAGS'] || '').split(',').map(&:strip)
   end
 
   def self.feature_flag?(flagname)
     return false unless available_feature_flags.include?(flagname)
+
     requested_feature_flags.include?(flagname)
   end
 
   def self.analytics
     @analytics ||= PDK::Analytics.build_client(
-      logger:        PDK.logger,
-      disabled:      PDK::Util::Env['PDK_DISABLE_ANALYTICS'] || PDK.config.get_within_scopes('analytics.disabled', %w[user system]),
-      user_id:       PDK.config.get_within_scopes('analytics.user-id', %w[user system]),
-      app_id:        "UA-139917834-#{PDK::Util.development_mode? ? '2' : '1'}",
-      client:        :google_analytics,
-      app_name:      'pdk',
-      app_version:   PDK::VERSION,
-      app_installer: PDK::Util.package_install? ? 'package' : 'gem',
+      logger: PDK.logger,
+      disabled: PDK::Util::Env['PDK_DISABLE_ANALYTICS'] || PDK.config.get_within_scopes('analytics.disabled', ['user', 'system']),
+      user_id: PDK.config.get_within_scopes('analytics.user-id', ['user', 'system']),
+      app_id: "UA-139917834-#{PDK::Util.development_mode? ? '2' : '1'}",
+      client: :google_analytics,
+      app_name: 'pdk',
+      app_version: PDK::VERSION,
+      app_installer: PDK::Util.package_install? ? 'package' : 'gem'
     )
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdk
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-14 00:00:00.000000000 Z
+date: 2023-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.1.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.1.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -107,61 +107,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.0.0
 - !ruby/object:Gem::Dependency
-  name: json-schema
+  name: json_pure
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.6.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.6.3
 - !ruby/object:Gem::Dependency
-  name: json_pure
+  name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.2
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.2
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: minitar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: pathspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: tty-prompt
   requirement: !ruby/object:Gem::Requirement
@@ -208,36 +208,30 @@ dependencies:
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.1.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.1.10
 - !ruby/object:Gem::Dependency
   name: facter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.0.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.0.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
@@ -288,8 +282,6 @@ files:
 - lib/pdk/cli.rb
 - lib/pdk/cli/build.rb
 - lib/pdk/cli/bundle.rb
-- lib/pdk/cli/config.rb
-- lib/pdk/cli/config/get.rb
 - lib/pdk/cli/console.rb
 - lib/pdk/cli/convert.rb
 - lib/pdk/cli/env.rb
@@ -300,9 +292,6 @@ files:
 - lib/pdk/cli/exec_group.rb
 - lib/pdk/cli/get.rb
 - lib/pdk/cli/get/config.rb
-- lib/pdk/cli/module.rb
-- lib/pdk/cli/module/build.rb
-- lib/pdk/cli/module/generate.rb
 - lib/pdk/cli/new.rb
 - lib/pdk/cli/new/class.rb
 - lib/pdk/cli/new/defined_type.rb
@@ -342,6 +331,7 @@ files:
 - lib/pdk/config/json_with_schema.rb
 - lib/pdk/config/namespace.rb
 - lib/pdk/config/setting.rb
+- lib/pdk/config/task_schema.json
 - lib/pdk/config/validator.rb
 - lib/pdk/config/yaml.rb
 - lib/pdk/config/yaml_with_schema.rb
@@ -368,6 +358,7 @@ files:
 - lib/pdk/module/release.rb
 - lib/pdk/module/update.rb
 - lib/pdk/module/update_manager.rb
+- lib/pdk/monkey_patches.rb
 - lib/pdk/report.rb
 - lib/pdk/report/event.rb
 - lib/pdk/template.rb
@@ -425,7 +416,8 @@ files:
 - lib/pdk/version.rb
 homepage: https://github.com/puppetlabs/pdk
 licenses: []
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -434,7 +426,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.9
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/pdk/cli/config/get.rb

@@ -1,26 +0,0 @@
-module PDK::CLI
-  @config_get_cmd = @config_cmd.define_command do
-    name 'get'
-    usage 'config get [name]'
-    summary '(Deprecated) Retrieve the configuration for <name>. If not specified, retrieve all configuration settings'
-
-    run do |_opts, args, _cmd|
-      PDK.logger.warn 'The \'pdk config get\' command is deprecated, please use \'pdk get config\' instead.'
-
-      item_name = args[0]
-      resolved_config = PDK.config.resolve(item_name)
-      # If the user wanted to know a setting but it doesn't exist, raise an error
-      if resolved_config.empty? && !item_name.nil?
-        PDK.logger.error("Configuration item '%{name}' does not exist" % { name: item_name })
-        exit 1
-      end
-      # If the user requested a setting and it's the only one resolved, then just output the value
-      if resolved_config.count == 1 && resolved_config.keys[0] == item_name
-        puts '%{value}' % { value: resolved_config.values[0] }
-        exit 0
-      end
-      # Otherwise just output everything
-      resolved_config.keys.sort.each { |key| puts '%{name}=%{value}' % { name: key, value: resolved_config[key] } }
-    end
-  end
-end

data/lib/pdk/cli/config.rb

@@ -1,22 +0,0 @@
-module PDK::CLI
-  @config_cmd = @base_cmd.define_command do
-    name 'config'
-    usage 'config [subcommand] [options]'
-    summary '(Deprecated) Configure the Puppet Development Kit.'
-    default_subcommand 'help'
-
-    run do |_opts, args, _cmd|
-      PDK.logger.warn 'The \'pdk config\' command is deprecated, please use \'pdk get config\' and \'pdk set config\' instead.'
-
-      if args == ['help']
-        PDK::CLI.run(%w[config --help])
-        exit 0
-      end
-
-      PDK::CLI.run(%w[config help]) if args.empty?
-    end
-  end
-  @config_cmd.add_command Cri::Command.new_basic_help
-end
-
-require 'pdk/cli/config/get'