pdk 2.3.0 → 2.4.0

data/lib/pdk/validate/validator_group.rb

@@ -1,104 +1,104 @@
-require 'pdk'
-
-module PDK
-  module Validate
-    # The base class which should be used by meta-validators, that is, this group executes other validators
-    #
-    # At a minimum, the `name` and `validators` methods should be overridden in the child class
-    #
-    # An example concrete implementation could look like:
-    #
-    # module PDK
-    #   module Validate
-    #     module Tasks
-    #       class TasksValidatorGroup < ValidatorGroup
-    #         def name
-    #           'tasks'
-    #         end
-    #
-    #         def validators
-    #           [
-    #             TasksNameValidator,
-    #             TasksMetadataLintValidator,
-    #           ].freeze
-    #         end
-    #       end
-    #     end
-    #   end
-    # end
-    #
-    # @see PDK::Validate::Validator
-    # @abstract
-    class ValidatorGroup < Validator
-      # @see PDK::Validate::Validator.spinner_text
-      def spinner_text
-        _('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)
-
-        # Register the child spinners
-        validator_instances.each do |instance|
-          next if instance.spinner.nil?
-          @spinner.register(instance.spinner)
-        end
-
-        @spinner
-      end
-
-      # Can be overridden by child classes to do their own preparation tasks.
-      # Typically this is not required by a meta-validator though.
-      #
-      # @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! }
-        nil
-      end
-
-      # A list of Validator classes that this group will run
-      # @return Array[Class] An array of Validator classes (or objects that subclass to it) that this group will execute
-      # @abstract
-      def validators
-        []
-      end
-
-      # @see PDK::Validate::Validator.invoke
-      def invoke(report)
-        exit_code = 0
-
-        prepare_invoke!
-        start_spinner
-
-        validator_instances.each do |instance|
-          exit_code = instance.invoke(report)
-          break if exit_code != 0
-        end
-
-        stop_spinner(exit_code.zero?)
-
-        exit_code
-      end
-
-      # The instanitated PDK::Validator::Validator classes from the `validators` array
-      # @return Array[PDK::Validator::Validator]
-      # @api private
-      def validator_instances
-        @validator_instances ||= validators.map { |klass| klass.new(context, options.merge(parent_validator: self)) }
-                                           .select { |instance| instance.valid_in_context? }
-      end
-    end
-  end
-end
+require 'pdk'
+
+module PDK
+  module Validate
+    # The base class which should be used by meta-validators, that is, this group executes other validators
+    #
+    # At a minimum, the `name` and `validators` methods should be overridden in the child class
+    #
+    # An example concrete implementation could look like:
+    #
+    # module PDK
+    #   module Validate
+    #     module Tasks
+    #       class TasksValidatorGroup < ValidatorGroup
+    #         def name
+    #           'tasks'
+    #         end
+    #
+    #         def validators
+    #           [
+    #             TasksNameValidator,
+    #             TasksMetadataLintValidator,
+    #           ].freeze
+    #         end
+    #       end
+    #     end
+    #   end
+    # end
+    #
+    # @see PDK::Validate::Validator
+    # @abstract
+    class ValidatorGroup < Validator
+      # @see PDK::Validate::Validator.spinner_text
+      def spinner_text
+        _('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)
+
+        # Register the child spinners
+        validator_instances.each do |instance|
+          next if instance.spinner.nil?
+          @spinner.register(instance.spinner)
+        end
+
+        @spinner
+      end
+
+      # Can be overridden by child classes to do their own preparation tasks.
+      # Typically this is not required by a meta-validator though.
+      #
+      # @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! }
+        nil
+      end
+
+      # A list of Validator classes that this group will run
+      # @return Array[Class] An array of Validator classes (or objects that subclass to it) that this group will execute
+      # @abstract
+      def validators
+        []
+      end
+
+      # @see PDK::Validate::Validator.invoke
+      def invoke(report)
+        exit_code = 0
+
+        prepare_invoke!
+        start_spinner
+
+        validator_instances.each do |instance|
+          exit_code = instance.invoke(report)
+          break if exit_code != 0
+        end
+
+        stop_spinner(exit_code.zero?)
+
+        exit_code
+      end
+
+      # The instanitated PDK::Validator::Validator classes from the `validators` array
+      # @return Array[PDK::Validator::Validator]
+      # @api private
+      def validator_instances
+        @validator_instances ||= validators.map { |klass| klass.new(context, options.merge(parent_validator: self)) }
+                                           .select { |instance| instance.valid_in_context? }
+      end
+    end
+  end
+end

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

@@ -1,95 +1,95 @@
-require 'pdk'
-
-module PDK
-  module Validate
-    module YAML
-      class YAMLSyntaxValidator < InternalRubyValidator
-        YAML_ALLOWLISTED_CLASSES = [Symbol].freeze
-
-        def ignore_dotfiles
-          false
-        end
-
-        def name
-          'yaml-syntax'
-        end
-
-        def pattern
-          [
-            '**/*.yaml',
-            '**/*.yml',
-          ].tap do |pat|
-            if context.is_a?(PDK::Context::ControlRepo)
-              pat.concat(
-                [
-                  '**/*.eyaml',
-                  '**/*.eyml',
-                ],
-              )
-            else
-              pat
-            end
-          end
-        end
-
-        def spinner_text
-          _('Checking YAML syntax (%{patterns}).') % {
-            patterns: pattern.join(' '),
-          }
-        end
-
-        def validate_target(report, target)
-          return 0 unless PDK::Util::Filesystem.file?(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
-
-          begin
-            ::YAML.safe_load(PDK::Util::Filesystem.read_file(target), YAML_ALLOWLISTED_CLASSES, [], true)
-
-            report.add_event(
-              file:     target,
-              source:   name,
-              state:    :passed,
-              severity: 'ok',
-            )
-            return 0
-          rescue Psych::SyntaxError => e
-            report.add_event(
-              file:     target,
-              source:   name,
-              state:    :failure,
-              severity: 'error',
-              line:     e.line,
-              column:   e.column,
-              message:  _('%{problem} %{context}') % {
-                problem: e.problem,
-                context: e.context,
-              },
-            )
-            return 1
-          rescue Psych::DisallowedClass => e
-            report.add_event(
-              file:     target,
-              source:   name,
-              state:    :failure,
-              severity: 'error',
-              message:  _('Unsupported class: %{message}') % {
-                message: e.message,
-              },
-            )
-            return 1
-          end
-        end
-      end
-    end
-  end
-end
+require 'pdk'
+
+module PDK
+  module Validate
+    module YAML
+      class YAMLSyntaxValidator < InternalRubyValidator
+        YAML_ALLOWLISTED_CLASSES = [Symbol].freeze
+
+        def ignore_dotfiles
+          false
+        end
+
+        def name
+          'yaml-syntax'
+        end
+
+        def pattern
+          [
+            '**/*.yaml',
+            '**/*.yml',
+          ].tap do |pat|
+            if context.is_a?(PDK::Context::ControlRepo)
+              pat.concat(
+                [
+                  '**/*.eyaml',
+                  '**/*.eyml',
+                ],
+              )
+            else
+              pat
+            end
+          end
+        end
+
+        def spinner_text
+          _('Checking YAML syntax (%{patterns}).') % {
+            patterns: pattern.join(' '),
+          }
+        end
+
+        def validate_target(report, target)
+          return 0 unless PDK::Util::Filesystem.file?(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
+
+          begin
+            ::YAML.safe_load(PDK::Util::Filesystem.read_file(target), YAML_ALLOWLISTED_CLASSES, [], true)
+
+            report.add_event(
+              file:     target,
+              source:   name,
+              state:    :passed,
+              severity: 'ok',
+            )
+            return 0
+          rescue Psych::SyntaxError => e
+            report.add_event(
+              file:     target,
+              source:   name,
+              state:    :failure,
+              severity: 'error',
+              line:     e.line,
+              column:   e.column,
+              message:  _('%{problem} %{context}') % {
+                problem: e.problem,
+                context: e.context,
+              },
+            )
+            return 1
+          rescue Psych::DisallowedClass => e
+            report.add_event(
+              file:     target,
+              source:   name,
+              state:    :failure,
+              severity: 'error',
+              message:  _('Unsupported class: %{message}') % {
+                message: e.message,
+              },
+            )
+            return 1
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,19 +1,19 @@
-require 'pdk'
-
-module PDK
-  module Validate
-    module YAML
-      class YAMLValidatorGroup < ValidatorGroup
-        def name
-          'yaml'
-        end
-
-        def validators
-          [
-            YAMLSyntaxValidator,
-          ].freeze
-        end
-      end
-    end
-  end
-end
+require 'pdk'
+
+module PDK
+  module Validate
+    module YAML
+      class YAMLValidatorGroup < ValidatorGroup
+        def name
+          'yaml'
+        end
+
+        def validators
+          [
+            YAMLSyntaxValidator,
+          ].freeze
+        end
+      end
+    end
+  end
+end

data/lib/pdk/validate.rb

@@ -1,94 +1,94 @@
-require 'pdk'
-
-module PDK
-  module Validate
-    autoload :ExternalCommandValidator, 'pdk/validate/external_command_validator'
-    autoload :InternalRubyValidator, 'pdk/validate/internal_ruby_validator'
-    autoload :InvokableValidator, 'pdk/validate/invokable_validator'
-    autoload :Validator, 'pdk/validate/validator'
-    autoload :ValidatorGroup, 'pdk/validate/validator_group'
-
-    module ControlRepo
-      autoload :ControlRepoValidatorGroup, 'pdk/validate/control_repo/control_repo_validator_group'
-      autoload :EnvironmentConfValidator, 'pdk/validate/control_repo/environment_conf_validator'
-    end
-
-    module Metadata
-      autoload :MetadataJSONLintValidator, 'pdk/validate/metadata/metadata_json_lint_validator'
-      autoload :MetadataSyntaxValidator, 'pdk/validate/metadata/metadata_syntax_validator'
-      autoload :MetadataValidatorGroup, 'pdk/validate/metadata/metadata_validator_group'
-    end
-
-    module Puppet
-      autoload :PuppetEPPValidator, 'pdk/validate/puppet/puppet_epp_validator'
-      autoload :PuppetLintValidator, 'pdk/validate/puppet/puppet_lint_validator'
-      autoload :PuppetSyntaxValidator, 'pdk/validate/puppet/puppet_syntax_validator'
-      autoload :PuppetValidatorGroup, 'pdk/validate/puppet/puppet_validator_group'
-    end
-
-    module Ruby
-      autoload :RubyRubocopValidator, 'pdk/validate/ruby/ruby_rubocop_validator'
-      autoload :RubyValidatorGroup, 'pdk/validate/ruby/ruby_validator_group'
-    end
-
-    module Tasks
-      autoload :TasksMetadataLintValidator, 'pdk/validate/tasks/tasks_metadata_lint_validator'
-      autoload :TasksNameValidator, 'pdk/validate/tasks/tasks_name_validator'
-      autoload :TasksValidatorGroup, 'pdk/validate/tasks/tasks_validator_group'
-    end
-
-    module YAML
-      autoload :YAMLSyntaxValidator, 'pdk/validate/yaml/yaml_syntax_validator'
-      autoload :YAMLValidatorGroup, 'pdk/validate/yaml/yaml_validator_group'
-    end
-
-    def self.validators
-      validator_hash.values
-    end
-
-    def self.validator_names
-      validator_hash.keys
-    end
-
-    # @api private
-    def self.validator_hash
-      # TODO: This isn't the most performant... But with only 6 items, it's fine
-      @validator_hash ||= [
-        ControlRepo::ControlRepoValidatorGroup,
-        Metadata::MetadataValidatorGroup,
-        Puppet::PuppetValidatorGroup,
-        Ruby::RubyValidatorGroup,
-        Tasks::TasksValidatorGroup,
-        YAML::YAMLValidatorGroup,
-      ].map { |klass| [klass.new.name, klass] }.to_h.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! }
-      report = PDK::Report.new
-
-      # Nothing to validate then nothing to do.
-      return [0, report] if instances.empty?
-
-      require 'pdk/cli/exec_group'
-      exec_group = PDK::CLI::ExecGroup.create(
-        _('Validating module using %{num_of_threads} threads' % { num_of_threads: instances.count }),
-        { parallel: parallel },
-        options,
-      )
-
-      instances.each do |validator|
-        exec_group.register do
-          validator.invoke(report)
-        end
-      end
-
-      [exec_group.exit_code, report]
-    end
-
-    class ParseOutputError < StandardError; end
-  end
-end
+require 'pdk'
+
+module PDK
+  module Validate
+    autoload :ExternalCommandValidator, 'pdk/validate/external_command_validator'
+    autoload :InternalRubyValidator, 'pdk/validate/internal_ruby_validator'
+    autoload :InvokableValidator, 'pdk/validate/invokable_validator'
+    autoload :Validator, 'pdk/validate/validator'
+    autoload :ValidatorGroup, 'pdk/validate/validator_group'
+
+    module ControlRepo
+      autoload :ControlRepoValidatorGroup, 'pdk/validate/control_repo/control_repo_validator_group'
+      autoload :EnvironmentConfValidator, 'pdk/validate/control_repo/environment_conf_validator'
+    end
+
+    module Metadata
+      autoload :MetadataJSONLintValidator, 'pdk/validate/metadata/metadata_json_lint_validator'
+      autoload :MetadataSyntaxValidator, 'pdk/validate/metadata/metadata_syntax_validator'
+      autoload :MetadataValidatorGroup, 'pdk/validate/metadata/metadata_validator_group'
+    end
+
+    module Puppet
+      autoload :PuppetEPPValidator, 'pdk/validate/puppet/puppet_epp_validator'
+      autoload :PuppetLintValidator, 'pdk/validate/puppet/puppet_lint_validator'
+      autoload :PuppetSyntaxValidator, 'pdk/validate/puppet/puppet_syntax_validator'
+      autoload :PuppetValidatorGroup, 'pdk/validate/puppet/puppet_validator_group'
+    end
+
+    module Ruby
+      autoload :RubyRubocopValidator, 'pdk/validate/ruby/ruby_rubocop_validator'
+      autoload :RubyValidatorGroup, 'pdk/validate/ruby/ruby_validator_group'
+    end
+
+    module Tasks
+      autoload :TasksMetadataLintValidator, 'pdk/validate/tasks/tasks_metadata_lint_validator'
+      autoload :TasksNameValidator, 'pdk/validate/tasks/tasks_name_validator'
+      autoload :TasksValidatorGroup, 'pdk/validate/tasks/tasks_validator_group'
+    end
+
+    module YAML
+      autoload :YAMLSyntaxValidator, 'pdk/validate/yaml/yaml_syntax_validator'
+      autoload :YAMLValidatorGroup, 'pdk/validate/yaml/yaml_validator_group'
+    end
+
+    def self.validators
+      validator_hash.values
+    end
+
+    def self.validator_names
+      validator_hash.keys
+    end
+
+    # @api private
+    def self.validator_hash
+      # TODO: This isn't the most performant... But with only 6 items, it's fine
+      @validator_hash ||= [
+        ControlRepo::ControlRepoValidatorGroup,
+        Metadata::MetadataValidatorGroup,
+        Puppet::PuppetValidatorGroup,
+        Ruby::RubyValidatorGroup,
+        Tasks::TasksValidatorGroup,
+        YAML::YAMLValidatorGroup,
+      ].map { |klass| [klass.new.name, klass] }.to_h.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! }
+      report = PDK::Report.new
+
+      # Nothing to validate then nothing to do.
+      return [0, report] if instances.empty?
+
+      require 'pdk/cli/exec_group'
+      exec_group = PDK::CLI::ExecGroup.create(
+        _('Validating module using %{num_of_threads} threads' % { num_of_threads: instances.count }),
+        { parallel: parallel },
+        options,
+      )
+
+      instances.each do |validator|
+        exec_group.register do
+          validator.invoke(report)
+        end
+      end
+
+      [exec_group.exit_code, report]
+    end
+
+    class ParseOutputError < StandardError; end
+  end
+end

data/lib/pdk/version.rb

@@ -1,4 +1,4 @@
-module PDK
-  VERSION = '2.3.0'.freeze
-  TEMPLATE_REF = '2.3.0'.freeze
-end
+module PDK
+  VERSION = '2.4.0'.freeze
+  TEMPLATE_REF = '2.4.0'.freeze
+end