pdk 1.16.0 → 2.1.0

data/lib/pdk/validate/external_command_validator.rb

@@ -0,0 +1,208 @@
+require 'pdk'
+
+module PDK
+  module Validate
+    # An abstract validator that runs external commands within a Ruby Bundled environment
+    # e.g. `puppet-lint`, or `puppet validate`
+    #
+    # At a a minimum child classes should implment the `name`, `cmd`, `pattern` and `parse_output` methods
+    #
+    # An example concrete implementation could look like:
+    #
+    # module PDK
+    #   module Validate
+    #     module Ruby
+    #       class RubyRubocopValidator < ExternalCommandValidator
+    #         def name
+    #           'rubocop'
+    #         end
+    #
+    #         def cmd
+    #           'rubocop'
+    #         end
+    #
+    #         def pattern
+    #           '**/**.rb'
+    #         end
+    #
+    #         def parse_options(targets)
+    #           ['--format', 'json']
+    #         end
+    #
+    #         def parse_output(report, result, _targets)
+    #    ... ruby code ...
+    #           report.add_event(
+    #             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
+    #
+    # @see PDK::Validate::InvokableValidator
+    class ExternalCommandValidator < InvokableValidator
+      # @return Array[PDK::CLI::Exec::Command] This is a private implementation attribute used for unit testing
+      # @api private
+      attr_reader :commands
+
+      # @see PDK::Validate::Validator.spinner
+      def spinner
+        # The validator has sub-commands with their own spinners.
+        nil
+      end
+
+      # Calculates the text of the spinner based on the target list
+      # @return [String]
+      # @abstract
+      def spinner_text_for_targets(targets); end
+
+      # The name of the command to be run for validation
+      # @return [String]
+      # @abstract
+      def cmd; end
+
+      # Alternate paths which the command (cmd) may exist in. Typically other ruby gem caches,
+      # or packaged installation bin directories.
+      # @return [Array[String]]
+      # @api private
+      def alternate_bin_paths
+        [
+          PDK::Util::RubyVersion.bin_path,
+          File.join(PDK::Util::RubyVersion.gem_home, 'bin'),
+          PDK::Util::RubyVersion.gem_paths_raw.map { |gem_path_raw| File.join(gem_path_raw, 'bin') },
+          PDK::Util.package_install? ? File.join(PDK::Util.pdk_package_basedir, 'bin') : nil,
+        ].flatten.compact
+      end
+
+      # The full path to the command (cmd)
+      # Can be overridden in child classes to a non-default path
+      # @return [String]
+      # @api private
+      def cmd_path
+        return @cmd_path unless @cmd_path.nil?
+        @cmd_path = File.join(context.root_path, 'bin', cmd)
+        # Return the path to the command if it exists on disk, or we have a gemfile (i.e. Bundled install)
+        # The Bundle may be created after the prepare_invoke so if the file doesn't exist, it may not be an error
+        return @cmd_path if PDK::Util::Filesystem.exist?(@cmd_path) || !PDK::Util::Bundler::BundleHelper.new.gemfile.nil?
+        # But if there is no Gemfile AND cmd doesn't exist in the default path, we need to go searching...
+        @cmd_path = alternate_bin_paths.map { |alternate_path| File.join(alternate_path, cmd) }
+                                       .find { |path| PDK::Util::Filesystem.exist?(path) }
+        return @cmd_path unless @cmd_path.nil?
+        # If we can't find it anywhere, just let the OS find it
+        @cmd_path = cmd
+      end
+
+      # An array of command line arguments to pass to the command for validation
+      # @return Array[String]
+      # @abstract
+      def parse_options(_targets)
+        []
+      end
+
+      # Parses the output from the command and appends formatted events to the report.
+      # This is called for each command, which is a group of targets
+      #
+      # @param report [PDK::Report] The report to add events to
+      # @param result [Hash[Symbol => Object]] The result of validation command process
+      # @param targets [Array[String]] The targets for this command result
+      # @api private
+      # @see PDK::CLI::Exec::Command.execute!
+      # @abstract
+      def parse_output(_report, _result, _targets); end
+
+      # Prepares for invokation by parsing targets and creating the needed commands.
+      # @api private
+      # @see PDK::Validate::Validator.prepare_invoke!
+      def prepare_invoke!
+        return if @prepared
+        super
+
+        @targets, @skipped, @invalid = parse_targets
+        @targets = [] if @targets.nil?
+
+        target_groups = if @targets.empty? && allow_empty_targets?
+                          # If we have no targets and we allow empty targets, create an empty target group list
+                          [[]]
+                        elsif invoke_style == :per_target
+                          # If invoking :per_target, split the targets array into an array of
+                          # single element arrays (one per target).
+                          @targets.combination(1).to_a.compact
+                        else
+                          # Else we're invoking :once, wrap the targets array in another array. This is so we
+                          # can loop through the invokes with the same logic, regardless of which invoke style
+                          # is needed.
+                          @targets.each_slice(1000).to_a.compact
+                        end
+
+        # Register all of the commands for all of the targets
+        @commands = []
+        target_groups.each do |invokation_targets|
+          next if invokation_targets.empty? && !allow_empty_targets?
+          cmd_argv = parse_options(invokation_targets).unshift(cmd_path).compact
+          cmd_argv.unshift(File.join(PDK::Util::RubyVersion.bin_path, 'ruby.exe'), '-W0') if Gem.win_platform?
+
+          command = PDK::CLI::Exec::Command.new(*cmd_argv).tap do |c|
+            c.context = :module
+            c.environment = { 'PUPPET_GEM_VERSION' => options[:puppet] } if options[:puppet]
+
+            if spinners_enabled?
+              parent_validator = options[:parent_validator]
+              if parent_validator.nil? || parent_validator.spinner.nil? || !parent_validator.spinner.is_a?(TTY::Spinner::Multi)
+                c.add_spinner(spinner_text_for_targets(invokation_targets))
+              else
+                spinner = TTY::Spinner.new("[:spinner] #{spinner_text_for_targets(invokation_targets)}", PDK::CLI::Util.spinner_opts_for_platform)
+                parent_validator.spinner.register(spinner)
+                c.register_spinner(spinner, PDK::CLI::Util.spinner_opts_for_platform)
+              end
+            end
+          end
+
+          @commands << { command: command, invokation_targets: invokation_targets }
+        end
+        nil
+      end
+
+      # Invokes the prepared commands as an ExecGroup
+      # @see PDK::Validate::Validator.invoke
+      def invoke(report)
+        prepare_invoke!
+
+        process_skipped(report, @skipped)
+        process_invalid(report, @invalid)
+
+        # Nothing to execute so return success
+        return 0 if @commands.empty?
+
+        # If there's no Gemfile, then we can't ensure the binstubs are correct
+        PDK::Util::Bundler.ensure_binstubs!(cmd) unless PDK::Util::Bundler::BundleHelper.new.gemfile.nil?
+
+        exec_group = PDK::CLI::ExecGroup.create(name, { parallel: false }, options)
+
+        # Register all of the commands for all of the targets
+        @commands.each do |item|
+          command = item[:command]
+          invokation_targets = item[:invokation_targets]
+
+          exec_group.register do
+            result = command.execute!
+            begin
+              parse_output(report, result, invokation_targets.compact)
+            rescue PDK::Validate::ParseOutputError => e
+              $stderr.puts e.message
+            end
+            result[:exit_code]
+          end
+        end
+
+        # Now execute and get the return code
+        exec_group.exit_code
+      end
+    end
+  end
+end

data/lib/pdk/validate/internal_ruby_validator.rb

@@ -0,0 +1,100 @@
+require 'pdk'
+
+module PDK
+  module Validate
+    # An abstract validator that runs ruby code internal to the PDK e.g. JSON and YAML validation, on a single file.
+    # The validator code must run within the PDK Ruby environment as opposed to the bundled Ruby environment for a module.
+    #
+    # At a a minimum child classes should implment the `name`, `pattern` and `validate_target` methods
+    #
+    # An example concrete implementation could look like:
+    #
+    # module PDK
+    #   module Validate
+    #     module Tasks
+    #       class TasksNameValidator < InternalRubyValidator
+    #         def name
+    #           'task-name'
+    #         end
+    #
+    #         def pattern
+    #           'tasks/**/*'
+    #         end
+    #
+    #         def validate_target(report, target)
+    #           task_name = File.basename(target, File.extname(target))
+    #     ... ruby code ...
+    #           success ? 0 : 1
+    #         end
+    #       end
+    #     end
+    #   end
+    # end
+    #
+    #
+    # @abstract
+    # @see PDK::Validate::InvokableValidator
+    class InternalRubyValidator < InvokableValidator
+      # @see PDK::Validate::Validator.prepare_invoke!
+      def prepare_invoke!
+        return if @prepared
+        super
+
+        # Parse the targets
+        @targets, @skipped, @invalid = parse_targets
+
+        nil
+      end
+
+      # Invokes the validator to call `validate_target` on each target
+      # @see PDK::Validate::Validator.invoke
+      def invoke(report)
+        prepare_invoke!
+
+        process_skipped(report, @skipped)
+        process_invalid(report, @invalid)
+
+        return 0 if @targets.empty?
+
+        return_val = 0
+
+        before_validation
+
+        start_spinner
+        @targets.each do |target|
+          validation_result = validate_target(report, target)
+          if validation_result.nil?
+            report.add_event(
+              file:     target,
+              source:   name,
+              state:    :failure,
+              severity: 'error',
+              message:  "Validation did not return an exit code for #{target}",
+            )
+            validation_result = 1
+          end
+          return_val = validation_result if validation_result > return_val
+        end
+
+        stop_spinner(return_val.zero?)
+        return_val
+      end
+
+      # Validates a single target
+      # It is the responsibility of this method to populate the report with validation messages
+      #
+      # @param report [PDK::Report] The report to add the events to
+      # @param target [String] The target to validate
+      #
+      # @return [Integer] The exitcode of the validation. Zero indicates success.  A non-zero code indicates failure
+      # @api private
+      # @abstract
+      def validate_target(report, target); end
+
+      # Tasks to run before validation occurs. This is run once every time `.invoke` is called
+      # @api private
+      # @abstract
+      def before_validation; end
+    end
+  end
+end

data/lib/pdk/validate/invokable_validator.rb

@@ -0,0 +1,220 @@
+require 'pdk'
+
+module PDK
+  module Validate
+    # A base class for file based validators.
+    # This class provides base methods and helpers to help determine the file targets to validate against.
+    # Acutal validator implementation should inherit from other child abstract classes e.g. ExternalCommandValdiator
+    # @see PDK::Validate::Validator
+    # @abstract
+    class InvokableValidator < Validator
+      # Controls how many times the validator is invoked.
+      #
+      #   :once -       The validator will be invoked once and passed all the
+      #                 targets.
+      #   :per_target - The validator will be invoked for each target
+      #                 separately.
+      # @abstract
+      def invoke_style
+        :once
+      end
+
+      # Whether this Validator can be invoked in this context. By default any InvokableValidator can work in any Context, except ::None
+      # @see PDK::Validate::Validator
+      def valid_in_context?
+        !context.is_a?(PDK::Context::None)
+      end
+
+      # An array, or a string, of glob patterns to use to find targets
+      # @return [Array[String], String]
+      # @abstract
+      def pattern; end
+
+      # An array, or a string, of glob patterns to use to ignore targets
+      # @return [Array[String], String, Nil]
+      # @abstract
+      def pattern_ignore; end
+
+      # @see PDK::Validate::Validator.prepare_invoke!
+      def prepare_invoke!
+        return if @prepared
+        super
+
+        # Register the spinner
+        spinner
+        nil
+      end
+
+      # Parses the target strings provided from the CLI
+      #
+      # @param options [Hash] A Hash containing the input options from the CLI.
+      #
+      # @return targets [Array] An Array of Strings containing target file paths
+      #                         for the validator to validate.
+      # @return skipped [Array] An Array of Strings containing targets
+      #                         that are skipped due to target not containing
+      #                         any files that can be validated by the validator.
+      # @return invalid [Array] An Array of Strings containing targets that do
+      #                         not exist, and will not be run by validator.
+      def parse_targets
+        requested_targets = options.fetch(:targets, [])
+        # If no targets are specified and empty targets are allowed return with an empty list.
+        # It will be up to the validator (and whatever validation tool it uses) to determine the
+        # targets. For example, using rubocop with no targets, will allow rubocop to determine the
+        # target list using it's .rubocop.yml file
+        return [[], [], []] if requested_targets.empty? && allow_empty_targets?
+        # If no targets are specified, then we will run validations from the base context directory.
+        targets = requested_targets.empty? ? [context.root_path] : requested_targets
+        targets.map! { |r| r.gsub(File::ALT_SEPARATOR, File::SEPARATOR) } if File::ALT_SEPARATOR
+
+        # If this validator is not valid in this context then skip all of the targets
+        return [[], targets, []] unless valid_in_context?
+
+        skipped = []
+        invalid = []
+        matched = targets.map { |target|
+          if pattern.nil?
+            target
+          else
+            if PDK::Util::Filesystem.directory?(target) # rubocop:disable Style/IfInsideElse
+              target_root = context.root_path
+              pattern_glob = Array(pattern).map { |p| PDK::Util::Filesystem.glob(File.join(target_root, p), File::FNM_DOTMATCH) }
+              target_list = pattern_glob.flatten
+                                        .select { |glob| PDK::Util::Filesystem.fnmatch(File.join(PDK::Util::Filesystem.expand_path(PDK::Util.canonical_path(target)), '*'), glob, File::FNM_DOTMATCH) }
+                                        .map { |glob| Pathname.new(glob).relative_path_from(Pathname.new(context.root_path)).to_s }
+
+              ignore_list = ignore_pathspec
+              target_list = target_list.reject { |file| ignore_list.match(file) }
+
+              if target_list.flatten.empty?
+                PDK.logger.info(_('Validator \'%{validator}\' skipped for \'%{target}\'. No files matching \'%{pattern}\' found to validate.') % { validator: name, target: target, pattern: pattern })
+
+                skipped << target
+              end
+
+              target_list
+            elsif PDK::Util::Filesystem.file?(target)
+              if Array(pattern).include? target
+                target
+              elsif Array(pattern).any? { |p| PDK::Util::Filesystem.fnmatch(PDK::Util::Filesystem.expand_path(p), PDK::Util::Filesystem.expand_path(target), File::FNM_DOTMATCH) }
+                target
+              else
+                skipped << target
+                next
+              end
+            else
+              invalid << target
+              next
+            end
+          end
+        }.compact.flatten.uniq
+        [matched, skipped, invalid]
+      end
+
+      # Whether the target parsing ignores "dotfiles" (e.g. .gitignore or .pdkignore) which are considered hidden files in POSIX
+      # @return [Boolean]
+      # @abstract
+      def ignore_dotfiles?
+        true
+      end
+
+      # @see PDK::Validate::Validator.spinner_text
+      # @abstract
+      def spinner_text
+        _('Running %{name} validator ...') % { 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.new("[:spinner] #{spinner_text}", PDK::CLI::Util.spinner_opts_for_platform)
+      end
+
+      # Process any targets that were skipped by the validator and add the events to the validation report
+      # @param report [PDK::Report] The report to add the events to
+      # @param skipped [Array[String]] The list of skipped targets
+      def process_skipped(report, skipped = [])
+        skipped.each do |skipped_target|
+          PDK.logger.debug(_('%{validator}: Skipped \'%{target}\'. Target does not contain any files to validate (%{pattern}).') % { validator: name, target: skipped_target, pattern: pattern })
+          report.add_event(
+            file:     skipped_target,
+            source:   name,
+            message:  _('Target does not contain any files to validate (%{pattern}).') % { pattern: pattern },
+            severity: :info,
+            state:    :skipped,
+          )
+        end
+      end
+
+      # Process any targets that were invalid by the validator and add the events to the validation report
+      # @param report [PDK::Report] The report to add the events to
+      # @param invalid [Array[String]] The list of invalid targets
+      def process_invalid(report, invalid = [])
+        invalid.each do |invalid_target|
+          PDK.logger.debug(_('%{validator}: Skipped \'%{target}\'. Target file not found.') % { validator: name, target: invalid_target })
+          report.add_event(
+            file:     invalid_target,
+            source:   name,
+            message:  _('File does not exist.'),
+            severity: :error,
+            state:    :error,
+          )
+        end
+      end
+
+      # Controls how the validator behaves if not passed any targets.
+      #
+      #   true  - PDK will not pass the globbed targets to the validator command
+      #           and it will instead rely on the underlying tool to find its
+      #           own default targets.
+      #   false - PDK will pass the globbed targets to the validator command.
+      # @abstract
+      def allow_empty_targets?
+        false
+      end
+
+      protected
+
+      # Takes the pattern used in a module context and transforms it depending on the
+      # context e.g. A Control Repo will use the module pattern in each module path
+      #
+      # @param [Array, String] The pattern when used in the module root. Does not start with '/'
+      #
+      # @return [Array[String]]
+      def contextual_pattern(module_pattern)
+        module_pattern = [module_pattern] unless module_pattern.is_a?(Array)
+        return module_pattern unless context.is_a?(PDK::Context::ControlRepo)
+        context.actualized_module_paths.map { |mod_path| module_pattern.map { |pat_path| mod_path + '/*/' + pat_path } }.flatten
+      end
+
+      private
+
+      # Helper method to collate the default ignored paths
+      # @return [PathSpec] Paths to ignore
+      def ignore_pathspec
+        ignore_pathspec = if context.is_a?(PDK::Context::Module)
+                            require 'pdk/module'
+                            PDK::Module.default_ignored_pathspec(ignore_dotfiles?)
+                          elsif context.is_a?(PDK::Context::ControlRepo)
+                            require 'pdk/control_repo'
+                            PDK::ControlRepo.default_ignored_pathspec(ignore_dotfiles?)
+                          else
+                            PathSpec.new.tap do |ps|
+                              ps.add('.*') if ignore_dotfiles?
+                            end
+                          end
+
+        unless pattern_ignore.nil?
+          Array(pattern_ignore).each do |pattern|
+            ignore_pathspec.add(pattern)
+          end
+        end
+
+        ignore_pathspec
+      end
+    end
+  end
+end