pdk 1.15.0 → 2.0.0

data/lib/pdk/validate/puppet_validator.rb

@@ -1,26 +0,0 @@
-require 'pdk'
-
-module PDK
-  module Validate
-    class PuppetValidator < BaseValidator
-      def self.name
-        'puppet'
-      end
-
-      def self.puppet_validators
-        [PuppetSyntax, PuppetLint, PuppetEPP]
-      end
-
-      def self.invoke(report, options = {})
-        exit_code = 0
-
-        puppet_validators.each do |validator|
-          exit_code = validator.invoke(report, options)
-          break if exit_code != 0
-        end
-
-        exit_code
-      end
-    end
-  end
-end

data/lib/pdk/validate/ruby/rubocop.rb

@@ -1,72 +0,0 @@
-require 'pdk'
-
-module PDK
-  module Validate
-    class Rubocop < BaseValidator
-      ALLOW_EMPTY_TARGETS = true
-
-      def self.name
-        'rubocop'
-      end
-
-      def self.cmd
-        'rubocop'
-      end
-
-      def self.pattern
-        '**/**.rb'
-      end
-
-      def self.spinner_text(_targets = nil)
-        _('Checking Ruby code style (%{pattern}).') % { pattern: pattern }
-      end
-
-      def self.parse_options(options, targets)
-        cmd_options = ['--format', 'json']
-
-        if options[:auto_correct]
-          cmd_options << '--auto-correct'
-        end
-
-        cmd_options.concat(targets)
-      end
-
-      def self.parse_output(report, result, _targets)
-        return if result[:stdout].empty?
-
-        begin
-          json_data = JSON.parse(result[:stdout])
-        rescue JSON::ParserError
-          raise PDK::Validate::ParseOutputError, result[:stdout]
-        end
-
-        return unless json_data.key?('files')
-
-        json_data['files'].each do |file_info|
-          next unless file_info.key?('offenses')
-          result = {
-            file: file_info['path'],
-            source: 'rubocop',
-          }
-
-          if file_info['offenses'].empty?
-            report.add_event(result.merge(state: :passed, severity: :ok))
-          else
-            file_info['offenses'].each do |offense|
-              report.add_event(
-                result.merge(
-                  line:     offense['location']['line'],
-                  column:   offense['location']['column'],
-                  message:  offense['message'],
-                  severity: offense['corrected'] ? 'corrected' : offense['severity'],
-                  test:     offense['cop_name'],
-                  state:    :failure,
-                ),
-              )
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/pdk/validate/ruby_validator.rb

@@ -1,26 +0,0 @@
-require 'pdk'
-
-module PDK
-  module Validate
-    class RubyValidator < BaseValidator
-      def self.name
-        'ruby'
-      end
-
-      def self.ruby_validators
-        [Rubocop]
-      end
-
-      def self.invoke(report, options = {})
-        exit_code = 0
-
-        ruby_validators.each do |validator|
-          exit_code = validator.invoke(report, options)
-          break if exit_code != 0
-        end
-
-        exit_code
-      end
-    end
-  end
-end

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

@@ -1,130 +0,0 @@
-require 'pdk'
-
-module PDK
-  module Validate
-    class Tasks
-      class MetadataLint < BaseValidator
-        FORGE_SCHEMA_URL = 'https://forgeapi.puppet.com/schemas/task.json'.freeze
-
-        def self.name
-          'task-metadata-lint'
-        end
-
-        def self.pattern
-          'tasks/*.json'
-        end
-
-        def self.spinner_text(_targets = [])
-          _('Checking task metadata style (%{targets}).') % {
-            targets: pattern,
-          }
-        end
-
-        def self.create_spinner(targets = [], options = {})
-          require 'pdk/cli/util'
-
-          return unless PDK::CLI::Util.interactive?
-
-          options = options.merge(PDK::CLI::Util.spinner_opts_for_platform)
-
-          exec_group = options[:exec_group]
-          @spinner = if exec_group
-                       exec_group.add_spinner(spinner_text(targets), options)
-                     else
-                       require 'pdk/cli/util/spinner'
-
-                       TTY::Spinner.new("[:spinner] #{spinner_text(targets)}", options)
-                     end
-          @spinner.auto_spin
-        end
-
-        def self.stop_spinner(exit_code)
-          if exit_code.zero? && @spinner
-            @spinner.success
-          elsif @spinner
-            @spinner.error
-          end
-        end
-
-        def self.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 self.invoke(report, options = {})
-          targets, skipped, invalid = parse_targets(options)
-
-          process_skipped(report, skipped)
-          process_invalid(report, invalid)
-
-          return 0 if targets.empty?
-
-          return_val = 0
-          create_spinner(targets, options)
-
-          require 'json-schema'
-
-          targets.each do |target|
-            unless PDK::Util::Filesystem.readable?(target)
-              report.add_event(
-                file:     target,
-                source:   name,
-                state:    :failure,
-                severity: 'error',
-                message:  _('Could not be read.'),
-              )
-              return_val = 1
-              next
-            end
-
-            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
-
-              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',
-                )
-              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_val = 1
-              end
-            end
-          end
-
-          stop_spinner(return_val)
-          return_val
-        end
-      end
-    end
-  end
-end

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

@@ -1,90 +0,0 @@
-require 'pdk'
-
-module PDK
-  module Validate
-    class Tasks
-      class Name < BaseValidator
-        INVALID_TASK_MSG = _(
-          'Invalid task name. Task names must start with a lowercase letter ' \
-          'and can only contain lowercase letters, numbers, and underscores.',
-        )
-
-        def self.name
-          'task-name'
-        end
-
-        def self.pattern
-          'tasks/**/*'
-        end
-
-        def self.spinner_text(_targets = [])
-          _('Checking task names (%{targets}).') % {
-            targets: pattern,
-          }
-        end
-
-        def self.create_spinner(targets = [], options = {})
-          require 'pdk/cli/util'
-
-          return unless PDK::CLI::Util.interactive?
-          options = options.merge(PDK::CLI::Util.spinner_opts_for_platform)
-
-          exec_group = options[:exec_group]
-          @spinner = if exec_group
-                       exec_group.add_spinner(spinner_text(targets), options)
-                     else
-                       require 'pdk/cli/util/spinner'
-
-                       TTY::Spinner.new("[:spinner] #{spinner_text(targets)}", options)
-                     end
-          @spinner.auto_spin
-        end
-
-        def self.stop_spinner(exit_code)
-          if exit_code.zero? && @spinner
-            @spinner.success
-          elsif @spinner
-            @spinner.error
-          end
-        end
-
-        def self.invoke(report, options = {})
-          targets, skipped, invalid = parse_targets(options)
-
-          process_skipped(report, skipped)
-          process_invalid(report, invalid)
-
-          return 0 if targets.empty?
-
-          return_val = 0
-          create_spinner(targets, options)
-
-          targets.each do |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',
-              )
-            else
-              report.add_event(
-                file:     target,
-                source:   name,
-                state:    :failure,
-                severity: 'error',
-                message:  INVALID_TASK_MSG,
-              )
-
-              return_val = 1
-            end
-          end
-
-          stop_spinner(return_val)
-          return_val
-        end
-      end
-    end
-  end
-end

data/lib/pdk/validate/tasks_validator.rb

@@ -1,29 +0,0 @@
-require 'pdk'
-
-module PDK
-  module Validate
-    class TasksValidator < BaseValidator
-      def self.name
-        'tasks'
-      end
-
-      def self.metadata_validators
-        [
-          Tasks::Name,
-          Tasks::MetadataLint,
-        ]
-      end
-
-      def self.invoke(report, options = {})
-        exit_code = 0
-
-        metadata_validators.each do |validator|
-          exit_code = validator.invoke(report, options)
-          break if exit_code != 0
-        end
-
-        exit_code
-      end
-    end
-  end
-end

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

@@ -1,125 +0,0 @@
-require 'pdk'
-
-module PDK
-  module Validate
-    class YAML
-      class Syntax < BaseValidator
-        IGNORE_DOTFILES = false
-        YAML_WHITELISTED_CLASSES = [Symbol].freeze
-
-        def self.name
-          'yaml-syntax'
-        end
-
-        def self.pattern
-          [
-            '**/*.yaml',
-            '*.yaml',
-            '**/*.yml',
-            '*.yml',
-          ]
-        end
-
-        def self.spinner_text(_targets = [])
-          _('Checking YAML syntax (%{targets}).') % {
-            targets: pattern,
-          }
-        end
-
-        def self.create_spinner(targets = [], options = {})
-          require 'pdk/cli/util'
-
-          return unless PDK::CLI::Util.interactive?
-          options = options.merge(PDK::CLI::Util.spinner_opts_for_platform)
-
-          exec_group = options[:exec_group]
-          @spinner = if exec_group
-                       exec_group.add_spinner(spinner_text(targets), options)
-                     else
-                       require 'pdk/cli/util/spinner'
-
-                       TTY::Spinner.new("[:spinner] #{spinner_text(targets)}", options)
-                     end
-          @spinner.auto_spin
-        end
-
-        def self.stop_spinner(exit_code)
-          if exit_code.zero? && @spinner
-            @spinner.success
-          elsif @spinner
-            @spinner.error
-          end
-        end
-
-        def self.invoke(report, options = {})
-          targets, skipped, invalid = parse_targets(options)
-
-          process_skipped(report, skipped)
-          process_invalid(report, invalid)
-
-          return 0 if targets.empty?
-
-          return_val = 0
-          create_spinner(targets, options)
-
-          PDK.logger.debug(_('Validating yaml content of %{parsed_targets}') % { parsed_targets: targets.to_s })
-
-          targets.each do |target|
-            next 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_val = 1
-              next
-            end
-
-            begin
-              ::YAML.safe_load(PDK::Util::Filesystem.read_file(target), YAML_WHITELISTED_CLASSES, [], true)
-
-              report.add_event(
-                file:     target,
-                source:   name,
-                state:    :passed,
-                severity: 'ok',
-              )
-            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_val = 1
-            rescue Psych::DisallowedClass => e
-              report.add_event(
-                file:     target,
-                source:   name,
-                state:    :failure,
-                severity: 'error',
-                message:  _('Unsupported class: %{message}') % {
-                  message: e.message,
-                },
-              )
-              return_val = 1
-            end
-          end
-
-          stop_spinner(return_val)
-          return_val
-        end
-      end
-    end
-  end
-end