pdk 2.3.0 → 2.4.0

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

@@ -1,88 +1,88 @@
-require 'pdk'
-
-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
-
-        def pattern
-          contextual_pattern('tasks/*.json')
-        end
-
-        def spinner_text
-          _('Checking task metadata style (%{pattern}).') % {
-            pattern: pattern.join(' '),
-          }
-        end
-
-        def schema_file
-          require 'pdk/util/vendored_file'
-
-          schema = PDK::Util::VendoredFile.new('task.json', FORGE_SCHEMA_URL).read
-
-          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
-
-        def validate_target(report, target)
-          unless PDK::Util::Filesystem.readable?(target)
-            report.add_event(
-              file:     target,
-              source:   name,
-              state:    :failure,
-              severity: 'error',
-              message:  _('Could not be read.'),
-            )
-            return 1
-          end
-
-          require 'json-schema'
-          begin
-            # Need to set the JSON Parser and State Generator to the Native one to be
-            # compatible with the multi_json adapter.
-            JSON.parser = JSON::Ext::Parser if defined?(JSON::Ext::Parser)
-            JSON.generator = JSON::Ext::Generator if defined?(JSON::Ext::Generator)
-
-            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 }
-            end
-
-            if errors.empty?
-              report.add_event(
-                file:     target,
-                source:   name,
-                state:    :passed,
-                severity: 'ok',
-              )
-              return 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,
-                  severity: 'error',
-                  message:  error,
-                )
-              end
-              return 1
-            end
-          end
-        end
-      end
-    end
-  end
-end
+require 'pdk'
+
+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
+
+        def pattern
+          contextual_pattern('tasks/*.json')
+        end
+
+        def spinner_text
+          _('Checking task metadata style (%{pattern}).') % {
+            pattern: pattern.join(' '),
+          }
+        end
+
+        def schema_file
+          require 'pdk/util/vendored_file'
+
+          schema = PDK::Util::VendoredFile.new('task.json', FORGE_SCHEMA_URL).read
+
+          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
+
+        def validate_target(report, target)
+          unless PDK::Util::Filesystem.readable?(target)
+            report.add_event(
+              file:     target,
+              source:   name,
+              state:    :failure,
+              severity: 'error',
+              message:  _('Could not be read.'),
+            )
+            return 1
+          end
+
+          require 'json-schema'
+          begin
+            # Need to set the JSON Parser and State Generator to the Native one to be
+            # compatible with the multi_json adapter.
+            JSON.parser = JSON::Ext::Parser if defined?(JSON::Ext::Parser)
+            JSON.generator = JSON::Ext::Generator if defined?(JSON::Ext::Generator)
+
+            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 }
+            end
+
+            if errors.empty?
+              report.add_event(
+                file:     target,
+                source:   name,
+                state:    :passed,
+                severity: 'ok',
+              )
+              return 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,
+                  severity: 'error',
+                  message:  error,
+                )
+              end
+              return 1
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,50 +1,50 @@
-require 'pdk'
-
-module PDK
-  module Validate
-    module Tasks
-      class TasksNameValidator < InternalRubyValidator
-        INVALID_TASK_MSG = _(
-          'Invalid task name. Task names must start with a lowercase letter ' \
-          'and can only contain lowercase letters, numbers, and underscores.',
-        )
-
-        def name
-          'task-name'
-        end
-
-        def pattern
-          contextual_pattern('tasks/**/*')
-        end
-
-        def spinner_text
-          _('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',
-            )
-            return 0
-          else
-            report.add_event(
-              file:     target,
-              source:   name,
-              state:    :failure,
-              severity: 'error',
-              message:  INVALID_TASK_MSG,
-            )
-            return 1
-          end
-        end
-      end
-    end
-  end
-end
+require 'pdk'
+
+module PDK
+  module Validate
+    module Tasks
+      class TasksNameValidator < InternalRubyValidator
+        INVALID_TASK_MSG = _(
+          'Invalid task name. Task names must start with a lowercase letter ' \
+          'and can only contain lowercase letters, numbers, and underscores.',
+        )
+
+        def name
+          'task-name'
+        end
+
+        def pattern
+          contextual_pattern('tasks/**/*')
+        end
+
+        def spinner_text
+          _('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',
+            )
+            return 0
+          else
+            report.add_event(
+              file:     target,
+              source:   name,
+              state:    :failure,
+              severity: 'error',
+              message:  INVALID_TASK_MSG,
+            )
+            return 1
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,20 +1,20 @@
-require 'pdk'
-
-module PDK
-  module Validate
-    module Tasks
-      class TasksValidatorGroup < ValidatorGroup
-        def name
-          'tasks'
-        end
-
-        def validators
-          [
-            TasksNameValidator,
-            TasksMetadataLintValidator,
-          ].freeze
-        end
-      end
-    end
-  end
-end
+require 'pdk'
+
+module PDK
+  module Validate
+    module Tasks
+      class TasksValidatorGroup < ValidatorGroup
+        def name
+          'tasks'
+        end
+
+        def validators
+          [
+            TasksNameValidator,
+            TasksMetadataLintValidator,
+          ].freeze
+        end
+      end
+    end
+  end
+end

data/lib/pdk/validate/validator.rb

@@ -1,118 +1,118 @@
-require 'pdk'
-
-module PDK
-  module Validate
-    # The base Validator class which all other validators should inherit from.
-    # Acutal validator implementation should inherit from other child abstract classes e.g. ValidatorGroup or ExternalCommandValdiator
-    # @abstract
-    class Validator
-      # A hash of options set when the Validator was instantiated
-      # @return Hash[Object => Object]
-      attr_reader :options
-
-      # The PDK context which the validator will be within.
-      # @return [PDK::Context::AbstractContext] or a subclass PDK::Context::AbstractContext
-      attr_reader :context
-
-      # Whether the validator is prepared to be invoked.
-      # This should only be used for testing
-      #
-      # @return [Boolean]
-      #
-      # @api private
-      attr_reader :prepared
-
-      # Creates a new Validator
-      #
-      # @param context [PDK::Context::AbstractContext] Optional context which specifies where the validation will take place.
-      #                Passing nil will use a None context (PDK::Context::None)
-      # @param options [Hash] Optional configuration for the Validator
-      # @option options :parent_validator [PDK::Validate::Validator] The parent validator for this validator.
-      #   Typically used by ValidatorGroup to create trees of Validators for invocation.
-      def initialize(context = nil, options = {})
-        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)
-          @context = context
-        end
-        @options = options.dup.freeze
-        @prepared = false
-      end
-
-      # Whether this Validator can be invoked in this context. By default any Validator can work in any Context
-      # @return [Boolean]
-      # @abstract
-      def valid_in_context?
-        true
-      end
-
-      # Returns the text used for the spinner to display to the user while invoking
-      #
-      # @return [String]
-      #
-      # @abstract
-      def spinner_text; end
-
-      # Whether Spinners should be enabled for this validator
-      #
-      # @return [Boolean]
-      #
-      # @api private
-      # :nocov: .interactive? is tested elsewhere
-      def spinners_enabled?
-        PDK::CLI::Util.interactive?
-      end
-      # :nocov:
-
-      # The TTY Spinner for this Validator. Returns nil if spinners are disabled for this validator
-      #
-      # @return [TTY::Spinner, nil]
-      #
-      # @api private
-      # @abstract
-      def spinner; end
-
-      # Start the spinner if it exists
-      # @api private
-      def start_spinner
-        spinner.auto_spin unless spinner.nil?
-        nil
-      end
-
-      # Stop the spinner if it exists
-      # @api private
-      def stop_spinner(success)
-        return if spinner.nil?
-        success ? spinner.success : spinner.error
-        nil
-      end
-
-      # Name of the Validator
-      #
-      # @return [String]
-      #
-      # @abstract
-      def name; end
-
-      # Once off tasks to run prior to invoking
-      #
-      # @api private
-      #
-      # @abstract
-      def prepare_invoke!
-        @prepared = true
-      end
-
-      # Invokes the validator and returns the exit code
-      #
-      # @param report [PDK::Report] Accumulator of events during the invokation of this validator
-      #   and potential child validators
-      # @abstract
-      def invoke(_report)
-        prepare_invoke!
-        0
-      end
-    end
-  end
-end
+require 'pdk'
+
+module PDK
+  module Validate
+    # The base Validator class which all other validators should inherit from.
+    # Acutal validator implementation should inherit from other child abstract classes e.g. ValidatorGroup or ExternalCommandValdiator
+    # @abstract
+    class Validator
+      # A hash of options set when the Validator was instantiated
+      # @return Hash[Object => Object]
+      attr_reader :options
+
+      # The PDK context which the validator will be within.
+      # @return [PDK::Context::AbstractContext] or a subclass PDK::Context::AbstractContext
+      attr_reader :context
+
+      # Whether the validator is prepared to be invoked.
+      # This should only be used for testing
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      attr_reader :prepared
+
+      # Creates a new Validator
+      #
+      # @param context [PDK::Context::AbstractContext] Optional context which specifies where the validation will take place.
+      #                Passing nil will use a None context (PDK::Context::None)
+      # @param options [Hash] Optional configuration for the Validator
+      # @option options :parent_validator [PDK::Validate::Validator] The parent validator for this validator.
+      #   Typically used by ValidatorGroup to create trees of Validators for invocation.
+      def initialize(context = nil, options = {})
+        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)
+          @context = context
+        end
+        @options = options.dup.freeze
+        @prepared = false
+      end
+
+      # Whether this Validator can be invoked in this context. By default any Validator can work in any Context
+      # @return [Boolean]
+      # @abstract
+      def valid_in_context?
+        true
+      end
+
+      # Returns the text used for the spinner to display to the user while invoking
+      #
+      # @return [String]
+      #
+      # @abstract
+      def spinner_text; end
+
+      # Whether Spinners should be enabled for this validator
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      # :nocov: .interactive? is tested elsewhere
+      def spinners_enabled?
+        PDK::CLI::Util.interactive?
+      end
+      # :nocov:
+
+      # The TTY Spinner for this Validator. Returns nil if spinners are disabled for this validator
+      #
+      # @return [TTY::Spinner, nil]
+      #
+      # @api private
+      # @abstract
+      def spinner; end
+
+      # Start the spinner if it exists
+      # @api private
+      def start_spinner
+        spinner.auto_spin unless spinner.nil?
+        nil
+      end
+
+      # Stop the spinner if it exists
+      # @api private
+      def stop_spinner(success)
+        return if spinner.nil?
+        success ? spinner.success : spinner.error
+        nil
+      end
+
+      # Name of the Validator
+      #
+      # @return [String]
+      #
+      # @abstract
+      def name; end
+
+      # Once off tasks to run prior to invoking
+      #
+      # @api private
+      #
+      # @abstract
+      def prepare_invoke!
+        @prepared = true
+      end
+
+      # Invokes the validator and returns the exit code
+      #
+      # @param report [PDK::Report] Accumulator of events during the invokation of this validator
+      #   and potential child validators
+      # @abstract
+      def invoke(_report)
+        prepare_invoke!
+        0
+      end
+    end
+  end
+end