pdk 1.14.1 → 1.18.1

data/lib/pdk/template_file.rb

@@ -1,96 +0,0 @@
-require 'ostruct'
-require 'pdk'
-
-module PDK
-  class TemplateFile < OpenStruct
-    # Initialises the TemplateFile object with the path to the template file
-    # and the data to be used when rendering the template.
-    #
-    # @param template_file [String] The path on disk to the template file.
-    # @param data [Hash{Symbol => Object}] The data that should be provided to
-    # the template when rendering.
-    # @option data [Object] :configs The value of this key will be provided to
-    # the template as an instance variable `@configs` in order to maintain
-    # compatibility with modulesync.
-    #
-    # @api public
-    def initialize(template_file, data = {})
-      @template_file = template_file
-
-      if data.key?(:configs)
-        @configs = data[:configs]
-      end
-
-      super(data)
-    end
-
-    # Renders the template by calling the appropriate engine based on the file
-    # extension.
-    #
-    # If the template has an `.erb` extension, the content of the template
-    # file will be treated as an ERB template. All other extensions are treated
-    # as plain text.
-    #
-    # @return [String] The rendered template
-    #
-    # @raise (see #template_content)
-    #
-    # @api public
-    def render
-      case File.extname(@template_file)
-      when '.erb'
-        render_erb
-      else
-        render_plain
-      end
-    end
-
-    def config_for(path)
-      return unless respond_to?(:template_dir)
-
-      template_dir.config_for(path)
-    end
-
-    private
-
-    # Reads the content of the template file into memory.
-    #
-    # @return [String] The content of the template file.
-    #
-    # @raise [ArgumentError] If the template file does not exist or can not be
-    # read.
-    #
-    # @api private
-    def template_content
-      if File.file?(@template_file) && File.readable?(@template_file)
-        return File.read(@template_file)
-      end
-
-      raise ArgumentError, _("'%{template}' is not a readable file") % { template: @template_file }
-    end
-
-    # Renders the content of the template file as an ERB template.
-    #
-    # @return [String] The rendered template.
-    #
-    # @raise (see #template_content)
-    #
-    # @api private
-    def render_erb
-      renderer = ERB.new(template_content, nil, '-')
-      renderer.filename = @template_file
-      renderer.result(binding)
-    end
-
-    # Renders the content of the template file as plain text.
-    #
-    # @return [String] The rendered template.
-    #
-    # @raise (see #template_content)
-    #
-    # @api private
-    def render_plain
-      template_content
-    end
-  end
-end

data/lib/pdk/validate/base_validator.rb

@@ -1,215 +0,0 @@
-require 'pdk'
-
-module PDK
-  module Validate
-    class BaseValidator
-      # 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.
-      INVOKE_STYLE = :once
-
-      # 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.
-      ALLOW_EMPTY_TARGETS = false
-
-      IGNORE_DOTFILES = true
-
-      def self.cmd_path
-        File.join(PDK::Util.module_root, 'bin', cmd)
-      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 self.parse_targets(options)
-        # If no targets are specified, then we will run validations from the
-        # base module directory.
-
-        targets = options.fetch(:targets, []).empty? ? [PDK::Util.module_root] : options[:targets]
-
-        targets.map! { |r| r.gsub(File::ALT_SEPARATOR, File::SEPARATOR) } if File::ALT_SEPARATOR
-        skipped = []
-        invalid = []
-        matched = targets.map { |target|
-          if respond_to?(:pattern)
-            if PDK::Util::Filesystem.directory?(target)
-              target_root = PDK::Util.module_root
-              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(PDK::Util.module_root)).to_s }
-
-              ignore_list = ignore_pathspec
-              target_list = target_list.reject { |file| ignore_list.match(file) }
-
-              skipped << target if target_list.flatten.empty?
-              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
-          else
-            target
-          end
-        }.compact.flatten
-        [matched, skipped, invalid]
-      end
-
-      def self.ignore_pathspec
-        require 'pdk/module'
-
-        ignore_pathspec = PDK::Module.default_ignored_pathspec(ignore_dotfiles?)
-
-        if respond_to?(:pattern_ignore)
-          Array(pattern_ignore).each do |pattern|
-            ignore_pathspec.add(pattern)
-          end
-        end
-
-        ignore_pathspec
-      end
-
-      def self.ignore_dotfiles?
-        self::IGNORE_DOTFILES
-      end
-
-      def self.parse_options(_options, targets)
-        targets
-      end
-
-      def self.spinner_text(_targets = nil)
-        _('Invoking %{cmd}') % { cmd: cmd }
-      end
-
-      def self.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
-
-      def self.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
-
-      def self.allow_empty_targets?
-        self::ALLOW_EMPTY_TARGETS == true
-      end
-
-      def self.invoke(report, options = {})
-        require 'pdk/cli/exec/command'
-
-        targets, skipped, invalid = parse_targets(options)
-
-        process_skipped(report, skipped)
-        process_invalid(report, invalid)
-
-        return 0 if targets.empty?
-
-        PDK::Util::Bundler.ensure_binstubs!(cmd)
-
-        # If invoking :per_target, split the targets array into an array of
-        # single element arrays (one per target). If 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.
-        #
-        if self::INVOKE_STYLE == :per_target
-          targets = targets.combination(1).to_a
-        else
-          require 'pdk/cli/exec_group'
-          targets = targets.each_slice(1000).to_a
-          options[:split_exec] = PDK::CLI::ExecGroup.new(spinner_text(targets), parallel: false)
-        end
-
-        if options.fetch(:targets, []).empty? && allow_empty_targets?
-          targets = [[]]
-        end
-
-        exit_codes = []
-
-        targets.each do |invokation_targets|
-          cmd_argv = parse_options(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]
-            unless options[:split_exec]
-              exec_group = options[:exec_group]
-              if exec_group
-                sub_spinner = exec_group.add_spinner(spinner_text(invokation_targets))
-                c.register_spinner(sub_spinner)
-              else
-                c.add_spinner(spinner_text(invokation_targets))
-              end
-            end
-          end
-
-          if options[:split_exec]
-            options[:split_exec].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
-          else
-            result = command.execute!
-            exit_codes << result[:exit_code]
-
-            begin
-              parse_output(report, result, invokation_targets.compact)
-            rescue PDK::Validate::ParseOutputError => e
-              $stderr.puts e.message
-            end
-          end
-        end
-
-        options.key?(:split_exec) ? options[:split_exec].exit_code : exit_codes.max
-      end
-    end
-  end
-end

data/lib/pdk/validate/metadata/metadata_json_lint.rb

@@ -1,82 +0,0 @@
-require 'pdk'
-
-module PDK
-  module Validate
-    class MetadataJSONLint < BaseValidator
-      # Validate each metadata file separately, as metadata-json-lint does not
-      # support multiple targets.
-      INVOKE_STYLE = :per_target
-
-      def self.name
-        'metadata-json-lint'
-      end
-
-      def self.cmd
-        'metadata-json-lint'
-      end
-
-      def self.spinner_text(targets = [])
-        _('Checking module metadata style (%{targets}).') % {
-          targets: PDK::Util.targets_relative_to_pwd(targets).join(' '),
-        }
-      end
-
-      def self.pattern
-        'metadata.json'
-      end
-
-      def self.parse_options(_options, targets)
-        cmd_options = ['--format', 'json']
-        cmd_options << '--strict-dependencies'
-
-        cmd_options.concat(targets)
-      end
-
-      def self.parse_output(report, result, targets)
-        raise ArgumentError, _('More than 1 target provided to PDK::Validate::MetadataJSONLint.') if targets.count > 1
-
-        if result[:stdout].strip.empty?
-          # metadata-json-lint will print nothing if there are no problems with
-          # the file being linted. This should be handled separately to
-          # metadata-json-lint generating output that can not be parsed as JSON
-          # (unhandled exception in metadata-json-lint).
-          json_data = {}
-        else
-          begin
-            json_data = JSON.parse(result[:stdout])
-          rescue JSON::ParserError
-            raise PDK::Validate::ParseOutputError, result[:stdout]
-          end
-        end
-
-        if json_data.empty?
-          report.add_event(
-            file:     targets.first,
-            source:   name,
-            state:    :passed,
-            severity: :ok,
-          )
-        else
-          json_data.delete('result')
-          json_data.keys.each do |type|
-            json_data[type].each do |offense|
-              # metadata-json-lint groups the offenses by type, so the type ends
-              # up being `warnings` or `errors`. We want to convert that to the
-              # singular noun for the event.
-              event_type = type[%r{\A(.+?)s?\Z}, 1]
-
-              report.add_event(
-                file:     targets.first,
-                source:   name,
-                message:  offense['msg'],
-                test:     offense['check'],
-                severity: event_type,
-                state:    :failure,
-              )
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/pdk/validate/metadata/metadata_syntax.rb

@@ -1,111 +0,0 @@
-require 'pdk'
-
-module PDK
-  module Validate
-    class MetadataSyntax < BaseValidator
-      def self.name
-        'metadata-syntax'
-      end
-
-      def self.pattern
-        ['metadata.json', 'tasks/*.json']
-      end
-
-      def self.spinner_text(_targets = [])
-        _('Checking metadata syntax (%{targets}).') % {
-          targets: pattern.join(' '),
-        }
-      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)
-
-        # The pure ruby JSON parser gives much nicer parse error messages than
-        # the C extension at the cost of slightly slower parsing. We require it
-        # here and restore the C extension at the end of the method (if it was
-        # being used).
-        require 'json/pure'
-        JSON.parser = JSON::Pure::Parser
-
-        targets.each do |target|
-          unless File.readable?(target)
-            report.add_event(
-              file: target,
-              source: name,
-              state: :failure,
-              severity: 'error',
-              message: _('Could not be read.'),
-            )
-            return_val = 1
-            next
-          end
-
-          begin
-            JSON.parse(File.read(target))
-
-            report.add_event(
-              file:     target,
-              source:   name,
-              state:    :passed,
-              severity: 'ok',
-            )
-          rescue JSON::ParserError => e
-            # Because the message contains a raw segment of the file, we use
-            # String#dump here to unescape any escape characters like newlines.
-            # We then strip out the surrounding quotes and the exclaimation
-            # point that json_pure likes to put in exception messages.
-            sane_message = e.message.dump[%r{\A"(.+?)!?"\Z}, 1]
-
-            report.add_event(
-              file:     target,
-              source:   name,
-              state:    :failure,
-              severity: 'error',
-              message:  sane_message,
-            )
-            return_val = 1
-          end
-        end
-
-        stop_spinner(return_val)
-        return_val
-      ensure
-        JSON.parser = JSON::Ext::Parser if defined?(JSON::Ext::Parser)
-      end
-    end
-  end
-end