pdk-akerl 1.9.1.1 → 1.14.0.1

data/lib/pdk/util/version.rb

@@ -1,12 +1,9 @@
-require 'pdk/version'
-require 'pdk/cli/exec'
-require 'pdk/util/git'
-require 'pdk/logger'
-
 module PDK
   module Util
     module Version
       def self.version_string
+        require 'pdk/version'
+
         "#{PDK::VERSION} #{pdk_ref}".strip.freeze
       end
 
@@ -25,15 +22,17 @@ module PDK
       end
 
       def self.git_ref
+        require 'pdk/util/git'
         source_git_dir = File.join(File.expand_path('../../..', File.dirname(__FILE__)), '.git')
 
-        return nil unless File.directory?(source_git_dir)
+        return unless File.directory?(source_git_dir)
 
-        ref_result = PDK::Util::Git.git('--git-dir', source_git_dir, 'describe', '--all', '--long')
-        return ref_result[:stdout].strip if ref_result[:exit_code].zero?
+        PDK::Util::Git.describe(source_git_dir)
       end
 
       def self.version_file
+        require 'pdk/util'
+
         # FIXME: this gets called a LOT and doesn't currently get cached
         PDK::Util.find_upwards('PDK_VERSION', File.dirname(__FILE__))
       end

data/lib/pdk/util/windows.rb

@@ -1,6 +1,7 @@
 module PDK
   module Util
     module Windows
+      WIN32_FALSE = 0
       module File; end
 
       if Gem.win_platform?

data/lib/pdk/util/windows/api_types.rb

@@ -2,13 +2,6 @@ require 'ffi'
 require 'pdk/util/windows/string'
 
 module PDK::Util::Windows::APITypes
-  module ::FFI
-    WIN32_FALSE = 0
-
-    # standard Win32 error codes
-    ERROR_SUCCESS = 0
-  end
-
   class ::FFI::Pointer
     def self.from_string_to_wide_string(str, &_block)
       str = PDK::Util::Windows::String.wide_string(str)

data/lib/pdk/util/windows/file.rb

@@ -11,7 +11,7 @@ module PDK::Util::Windows::File
       # includes terminating NULL
       buffer_size = GetLongPathNameW(path_ptr, FFI::Pointer::NULL, 0)
       FFI::MemoryPointer.new(:wchar, buffer_size) do |converted_ptr|
-        if GetLongPathNameW(path_ptr, converted_ptr, buffer_size) == FFI::WIN32_FALSE
+        if GetLongPathNameW(path_ptr, converted_ptr, buffer_size) == PDK::Util::Windows::WIN32_FALSE
           raise _('Failed to call GetLongPathName')
         end
 

data/lib/pdk/util/windows/string.rb

@@ -3,7 +3,7 @@ require 'pdk/util/windows'
 module PDK::Util::Windows::String
   def wide_string(str)
     # if given a nil string, assume caller wants to pass a nil pointer to win32
-    return nil if str.nil?
+    return if str.nil?
     # ruby (< 2.1) does not respect multibyte terminators, so it is possible
     # for a string to contain a single trailing null byte, followed by garbage
     # causing buffer overruns.

data/lib/pdk/validate/base_validator.rb

@@ -1,7 +1,3 @@
-require 'pdk'
-require 'pdk/cli/exec'
-require 'pdk/module'
-
 module PDK
   module Validate
     class BaseValidator
@@ -49,25 +45,22 @@ module PDK
         invalid = []
         matched = targets.map { |target|
           if respond_to?(:pattern)
-            if File.directory?(target)
+            if PDK::Util::Filesystem.directory?(target)
               target_root = PDK::Util.module_root
-              pattern_glob = Array(pattern).map { |p| Dir.glob(File.join(target_root, p), File::FNM_DOTMATCH) }
-
-              target_list = pattern_glob.flatten.map do |file|
-                if File.fnmatch(File.join(File.expand_path(target), '*'), file, File::FNM_DOTMATCH)
-                  Pathname.new(file).relative_path_from(Pathname.new(PDK::Util.module_root)).to_s
-                end
-              end
+              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 File.file?(target)
+            elsif PDK::Util::Filesystem.file?(target)
               if Array(pattern).include? target
                 target
-              elsif Array(pattern).any? { |p| File.fnmatch(File.expand_path(p), File.expand_path(target), File::FNM_DOTMATCH) }
+              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
@@ -85,6 +78,8 @@ module PDK
       end
 
       def self.ignore_pathspec
+        require 'pdk/module'
+
         ignore_pathspec = PDK::Module.default_ignored_pathspec(ignore_dotfiles?)
 
         if respond_to?(:pattern_ignore)
@@ -139,6 +134,8 @@ module PDK
       end
 
       def self.invoke(report, options = {})
+        require 'pdk/cli/exec/command'
+
         targets, skipped, invalid = parse_targets(options)
 
         process_skipped(report, skipped)
@@ -157,6 +154,7 @@ module PDK
         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

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

@@ -1,8 +1,4 @@
-require 'pdk'
-require 'pdk/cli/exec'
 require 'pdk/validate/base_validator'
-require 'pdk/util/bundler'
-require 'pathname'
 
 module PDK
   module Validate

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

@@ -1,7 +1,4 @@
-require 'pdk'
-require 'pdk/cli/exec'
 require 'pdk/validate/base_validator'
-require 'pathname'
 
 module PDK
   module Validate
@@ -21,13 +18,18 @@ module PDK
       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

data/lib/pdk/validate/metadata_validator.rb

@@ -1,5 +1,3 @@
-require 'pdk'
-require 'pdk/cli/exec'
 require 'pdk/validate/base_validator'
 require 'pdk/validate/metadata/metadata_json_lint'
 require 'pdk/validate/metadata/metadata_syntax'

data/lib/pdk/validate/puppet/puppet_epp.rb

@@ -0,0 +1,137 @@
+require 'pdk/validate/base_validator'
+
+module PDK
+  module Validate
+    class PuppetEPP < BaseValidator
+      # In Puppet >= 5.3.4, the error context formatting was changed to facilitate localization
+      ERROR_CONTEXT = %r{(?:file:\s(?<file>.+?)|line:\s(?<line>.+?)|column:\s(?<column>.+?))}
+      # In Puppet < 5.3.3, the error context was formatted in these variations:
+      #   - "at file_path:line_num:col_num"
+      #   - "at file_path:line_num"
+      #   - "at line line_num"
+      #   - "in file_path"
+      ERROR_CONTEXT_LEGACY = %r{(?:at\sline\s(?<line>\d+)|at\s(?<file>.+?):(?<line>\d+):(?<column>\d+)|at\s(?<file>.+?):(?<line>\d+)|in\s(?<file>.+?))}
+
+      PUPPET_LOGGER_PREFIX = %r{^(debug|info|notice|warning|error|alert|critical):\s.+?$}i
+      PUPPET_SYNTAX_PATTERN = %r{^
+        (?<severity>.+?):\s
+        (?<message>.+?)
+        (?:
+          \s\(#{ERROR_CONTEXT}(,\s#{ERROR_CONTEXT})*\)| # attempt to match the new localisation friendly location
+          \s#{ERROR_CONTEXT_LEGACY}| # attempt to match the old " at file:line:column" location
+          $                                               # handle cases where the output has no location
+        )
+      $}x
+
+      def self.name
+        'puppet-epp'
+      end
+
+      def self.cmd
+        'puppet'
+      end
+
+      def self.pattern
+        '**/*.epp'
+      end
+
+      def self.pattern_ignore
+        ''
+      end
+
+      def self.spinner_text(_targets = nil)
+        _('Checking Puppet EPP syntax (%{pattern}).') % { pattern: pattern }
+      end
+
+      def self.parse_options(_options, targets)
+        # Due to PDK-1266 we need to run `puppet parser validate` with an empty
+        # modulepath. On *nix, Ruby treats `/dev/null` as an empty directory
+        # however it doesn't do so with `NUL` on Windows. The workaround for
+        # this to ensure consistent behaviour is to create an empty temporary
+        # directory and use that as the modulepath.
+        ['epp', 'validate', '--config', null_file, '--modulepath', validate_tmpdir].concat(targets)
+      end
+
+      def self.invoke(report, options)
+        super
+      ensure
+        remove_validate_tmpdir
+      end
+
+      def self.validate_tmpdir
+        require 'tmpdir'
+
+        @validate_tmpdir ||= Dir.mktmpdir('puppet-epp-validate')
+      end
+
+      def self.remove_validate_tmpdir
+        return unless @validate_tmpdir
+        return unless File.directory?(@validate_tmpdir)
+
+        require 'fileutils'
+
+        FileUtils.remove_entry_secure(@validate_tmpdir)
+        @validate_tmpdir = nil
+      end
+
+      def self.null_file
+        Gem.win_platform? ? 'NUL' : '/dev/null'
+      end
+
+      def self.parse_output(report, result, targets)
+        # Due to PUP-7504, we will have to programmatically construct the json
+        # object from the text output for now.
+        output = result[:stderr].split("\n").reject { |entry| entry.empty? }
+
+        results_data = []
+        output.each do |offense|
+          offense_data = parse_offense(offense)
+          results_data << offense_data
+        end
+
+        # puppet parser validate does not include files without problems in its
+        # output, so we need to go through the list of targets and add passing
+        # events to the report for any target not listed in the output.
+        targets.reject { |target| results_data.any? { |j| j[:file] =~ %r{#{target}} } }.each do |target|
+          report.add_event(
+            file:     target,
+            source:   name,
+            severity: :ok,
+            state:    :passed,
+          )
+        end
+
+        results_data.each do |offense|
+          report.add_event(offense)
+        end
+      end
+
+      def self.parse_offense(offense)
+        sanitize_console_output(offense)
+
+        offense_data = {
+          source:  name,
+          state:  :failure,
+        }
+
+        if offense.match(PUPPET_LOGGER_PREFIX)
+          attributes = offense.match(PUPPET_SYNTAX_PATTERN)
+
+          unless attributes.nil?
+            attributes.names.each do |name|
+              offense_data[name.to_sym] = attributes[name] unless attributes[name].nil?
+            end
+          end
+        else
+          offense_data[:message] = offense
+        end
+
+        offense_data
+      end
+
+      def self.sanitize_console_output(line)
+        line.gsub!(%r{\e\[([;\d]+)?m}, '')
+      end
+    end
+  end
+end

data/lib/pdk/validate/puppet/puppet_lint.rb

@@ -1,6 +1,3 @@
-require 'pdk'
-require 'pdk/util'
-require 'pdk/cli/exec'
 require 'pdk/validate/base_validator'
 
 module PDK

data/lib/pdk/validate/puppet/puppet_syntax.rb

@@ -1,8 +1,4 @@
-require 'pdk'
-require 'pdk/cli/exec'
 require 'pdk/validate/base_validator'
-require 'fileutils'
-require 'tmpdir'
 
 module PDK
   module Validate
@@ -36,7 +32,7 @@ module PDK
       end
 
       def self.pattern
-        '**/**.pp'
+        '**/*.pp'
       end
 
       def self.pattern_ignore
@@ -63,6 +59,8 @@ module PDK
       end
 
       def self.validate_tmpdir
+        require 'tmpdir'
+
         @validate_tmpdir ||= Dir.mktmpdir('puppet-parser-validate')
       end
 
@@ -70,6 +68,8 @@ module PDK
         return unless @validate_tmpdir
         return unless File.directory?(@validate_tmpdir)
 
+        require 'fileutils'
+
         FileUtils.remove_entry_secure(@validate_tmpdir)
         @validate_tmpdir = nil
       end

data/lib/pdk/validate/puppet_validator.rb

@@ -1,8 +1,7 @@
-require 'pdk'
-require 'pdk/cli/exec'
 require 'pdk/validate/base_validator'
 require 'pdk/validate/puppet/puppet_lint'
 require 'pdk/validate/puppet/puppet_syntax'
+require 'pdk/validate/puppet/puppet_epp'
 
 module PDK
   module Validate
@@ -12,7 +11,7 @@ module PDK
       end
 
       def self.puppet_validators
-        [PuppetSyntax, PuppetLint]
+        [PuppetSyntax, PuppetLint, PuppetEPP]
       end
 
       def self.invoke(report, options = {})

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

@@ -1,9 +1,4 @@
-require 'pdk'
-require 'pdk/cli/exec'
-require 'pdk/util'
-require 'pdk/util/bundler'
 require 'pdk/validate/base_validator'
-require 'pdk/validate/ruby_validator'
 
 module PDK
   module Validate
@@ -63,7 +58,7 @@ module PDK
                   line:     offense['location']['line'],
                   column:   offense['location']['column'],
                   message:  offense['message'],
-                  severity: (offense['corrected']) ? 'corrected' : offense['severity'],
+                  severity: offense['corrected'] ? 'corrected' : offense['severity'],
                   test:     offense['cop_name'],
                   state:    :failure,
                 ),

data/lib/pdk/validate/ruby_validator.rb

@@ -1,5 +1,3 @@
-require 'pdk'
-require 'pdk/cli/exec'
 require 'pdk/validate/base_validator'
 require 'pdk/validate/ruby/rubocop'
 

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

@@ -1,9 +1,4 @@
-require 'pdk'
-require 'pdk/cli/exec'
 require 'pdk/validate/base_validator'
-require 'pdk/util'
-require 'pathname'
-require 'json-schema'
 
 module PDK
   module Validate
@@ -26,13 +21,18 @@ module PDK
         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
@@ -47,6 +47,8 @@ module PDK
         end
 
         def self.schema_file
+          require 'pdk/util/vendored_file'
+
           schema = PDK::Util::VendoredFile.new('task.json', FORGE_SCHEMA_URL).read
 
           JSON.parse(schema)
@@ -67,6 +69,8 @@ module PDK
           return_val = 0
           create_spinner(targets, options)
 
+          require 'json-schema'
+
           targets.each do |target|
             unless File.readable?(target)
               report.add_event(