pdk 1.17.0 → 1.18.0

data/lib/pdk/util/json_finder.rb

@@ -0,0 +1,84 @@
+module PDK
+  module Util
+    # Processes a given string, looking for JSON objects and parsing them.
+    #
+    # @example A string with a JSON object and some junk characters
+    #   PDK::Util::JSONFinder.new('foo{"bar":1}').objects
+    #   => [{ 'bar' => 1 }]
+    #
+    # @example A string with mulitple JSON objects
+    #   PDK::Util::JSONFinder.new('foo{"bar":1}baz{"gronk":2}').objects
+    #   => [{ 'bar' => 1 }, { 'gronk' => 2 }]
+    class JSONFinder
+      # Creates a new instance of PDK::Util::JSONFinder.
+      #
+      # @param string [String] the string to find JSON objects inside of.
+      #
+      # @return [PDK::Util::JSONFinder] a new PDK::Util::JSONFinder object.
+      def initialize(string)
+        require 'strscan'
+
+        @scanner = StringScanner.new(string)
+      end
+
+      # Returns the parsed JSON objects from the string.
+      #
+      # @return [Array[Hash]] the parsed JSON objects present in the string.
+      def objects
+        return @objects unless @objects.nil?
+
+        require 'json'
+
+        until @scanner.eos?
+          @scanner.getch until @scanner.peek(1) == '{' || @scanner.eos?
+
+          (@objects ||= []) << begin
+                                 JSON.parse(read_object(true) || '')
+                               rescue JSON::ParserError
+                                 nil
+                               end
+        end
+
+        @objects = @objects.compact
+      end
+
+      private
+
+      # Recursively process the string to extract a complete JSON object.
+      #
+      # @param new_object [Boolean] Set to true if processing a new object to
+      #   capture the opening brace. Set to false if being called recursively
+      #   where the opening brace has already been captured.
+      #
+      # @return [String] The matched substring containing a JSON object.
+      def read_object(new_object = false)
+        matched_text = new_object ? @scanner.getch : ''
+
+        until @scanner.eos?
+          text = @scanner.scan_until(%r{(?:(?<!\\)"|\{|\})})
+          unless text
+            @scanner.terminate
+            return nil
+          end
+          matched_text += text
+
+          case @scanner.matched
+          when '}'
+            break
+          when '"'
+            text = @scanner.scan_until(%r{(?<!\\)"})
+            unless text
+              @scanner.terminate
+              return nil
+            end
+            matched_text += text
+          else
+            matched_text += read_object
+          end
+        end
+
+        matched_text
+      end
+    end
+  end
+end

data/lib/pdk/util/puppet_strings.rb

@@ -92,12 +92,12 @@ module PDK
         require 'pdk/generate'
 
         generators = PDK::Generate.generators.select do |gen|
-          gen.respond_to?(:puppet_strings_type) && !gen.puppet_strings_type.nil?
+          gen.const_defined?(:PUPPET_STRINGS_TYPE) && !gen::PUPPET_STRINGS_TYPE.nil?
         end
 
         known_objects = generate_hash
 
-        generators.map { |gen| [gen, known_objects[gen.puppet_strings_type]] }.reject do |_, obj|
+        generators.map { |gen| [gen, known_objects[gen::PUPPET_STRINGS_TYPE]] }.reject do |_, obj|
           obj.nil? || obj.empty?
         end
       end
@@ -117,7 +117,7 @@ module PDK
         require 'pdk/generate'
 
         PDK::Generate.generators.find do |gen|
-          gen.respond_to?(:puppet_strings_type) && gen.puppet_strings_type == type
+          gen.const_defined?(:PUPPET_STRINGS_TYPE) && gen::PUPPET_STRINGS_TYPE == type
         end
       end
     end

data/lib/pdk/util/template_uri.rb

@@ -192,7 +192,6 @@ module PDK
       #   directory, and :allow_fallback contains a Boolean that specifies if
       #   the lookup process should proceed to the next template directory if
       #   the template file is not in this template directory.
-      #
       def self.templates(opts)
         require 'pdk/answer_file'
         require 'pdk/util'
@@ -261,21 +260,20 @@ module PDK
         found_template[:uri]
       end
 
-      def self.valid_template?(template)
+      def self.valid_template?(template, context = PDK.context)
         require 'addressable'
 
         return false if template.nil? || !template.is_a?(Hash)
         return false if template[:uri].nil? || !template[:uri].is_a?(Addressable::URI)
 
         return true if PDK::Util::Git.repo?(bare_uri(template[:uri]))
-
         path = human_readable(template[:uri].path)
         if PDK::Util::Filesystem.directory?(path)
           # We know that it's not a git repository, but it's a valid path on disk
           begin
-            PDK::Module::TemplateDir.validate_module_template!(path)
-            return true
-          rescue ArgumentError
+            renderer = PDK::Template::Renderer.instance(path, template[:uri], context)
+            return !renderer.nil?
+          rescue StandardError
             nil
           end
         end

data/lib/pdk/util.rb

@@ -14,6 +14,7 @@ module PDK
     autoload :Env, 'pdk/util/env'
     autoload :Filesystem, 'pdk/util/filesystem'
     autoload :Git, 'pdk/util/git'
+    autoload :JSONFinder, 'pdk/util/json_finder'
     autoload :PuppetStrings, 'pdk/util/puppet_strings'
     autoload :PuppetVersion, 'pdk/util/puppet_version'
     autoload :RubyVersion, 'pdk/util/ruby_version'
@@ -148,7 +149,7 @@ module PDK
 
     def system_configdir
       return @system_configdir unless @system_configdir.nil?
-      return @system_configdir = File.join('opt', 'puppetlabs', 'pdk', 'config') unless Gem.win_platform?
+      return @system_configdir = File.join(File::SEPARATOR, 'opt', 'puppetlabs', 'pdk', 'config') unless Gem.win_platform?
 
       return @system_configdir = File.join(PDK::Util::Env['ProgramData'], 'PuppetLabs', 'PDK') unless PDK::Util::Env['ProgramData'].nil?
       @system_configdir = File.join(PDK::Util::Env['AllUsersProfile'], 'PuppetLabs', 'PDK')
@@ -196,7 +197,7 @@ module PDK
     # @return [Hash, nil] subset of text as Hash of first valid JSON found, or nil if no valid
     #   JSON found in the text
     def find_first_json_in(text)
-      find_valid_json_in(text)
+      find_all_json_in(text).first
     end
     module_function :find_first_json_in
 
@@ -206,42 +207,10 @@ module PDK
     # @return [Array<Hash>] subset of text as Array of all JSON object found, empty Array if none are found
     #   JSON found in the text
     def find_all_json_in(text)
-      find_valid_json_in(text, break_on_first: false)
+      PDK::Util::JSONFinder.new(text).objects
     end
     module_function :find_all_json_in
 
-    # Iterate through possible JSON documents until we find one that is valid.
-    #
-    # @param [String] text the text in which to find a JSON document
-    # @param [Hash] opts options
-    # @option opts [Boolean] :break_on_first Whether or not to break after valid JSON is found, defaults to true
-    #
-    # @return [Hash, Array<Hash>, nil] subset of text as Hash of first valid JSON found, array of all valid JSON found, or nil if no valid
-    #   JSON found in the text
-    #
-    # @private
-    def find_valid_json_in(text, opts = {})
-      break_on_first = opts.key?(:break_on_first) ? opts[:break_on_first] : true
-
-      json_result = break_on_first ? nil : []
-
-      text.scan(%r{\{(?:[^{}]|(?:\g<0>))*\}}x) do |str|
-        begin
-          if break_on_first
-            json_result = JSON.parse(str)
-            break
-          else
-            json_result.push(JSON.parse(str))
-          end
-        rescue JSON::ParserError
-          next
-        end
-      end
-
-      json_result
-    end
-    module_function :find_valid_json_in
-
     # Returns the targets' paths relative to the working directory
     #
     # @return [Array<String>] The absolute or path to the target

data/lib/pdk/validate/control_repo/control_repo_validator_group.rb

@@ -0,0 +1,23 @@
+require 'pdk'
+
+module PDK
+  module Validate
+    module ControlRepo
+      class ControlRepoValidatorGroup < ValidatorGroup
+        def name
+          'control-repo'
+        end
+
+        def valid_in_context?
+          context.is_a?(PDK::Context::ControlRepo)
+        end
+
+        def validators
+          [
+            EnvironmentConfValidator,
+          ].freeze
+        end
+      end
+    end
+  end
+end

data/lib/pdk/validate/control_repo/environment_conf_validator.rb

@@ -0,0 +1,98 @@
+require 'pdk'
+
+module PDK
+  module Validate
+    module ControlRepo
+      class EnvironmentConfValidator < InternalRubyValidator
+        ALLOWED_SETTINGS = %w[modulepath manifest config_version environment_timeout].freeze
+
+        def name
+          'environment-conf'
+        end
+
+        def valid_in_context?
+          context.is_a?(PDK::Context::ControlRepo)
+        end
+
+        def pattern
+          ['environment.conf']
+        end
+
+        def spinner_text
+          _('Checking Puppet Environment settings (%{patterns}).') % {
+            patterns: pattern.join(' '),
+          }
+        end
+
+        def validate_target(report, 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
+
+          is_valid = true
+          begin
+            env_conf = PDK::ControlRepo.environment_conf_as_config(target)
+
+            env_conf.resolve.each do |setting_name, setting_value|
+              # Remove the 'environment.' setting_name prefix
+              setting_name = setting_name.slice(12..-1)
+              next if ALLOWED_SETTINGS.include?(setting_name)
+              # A hash indicates that the ini file has a section in it.
+              message = if setting_value.is_a?(Hash)
+                          _("Invalid section '%{name}'") % { name: setting_name }
+                        else
+                          _("Invalid setting '%{name}'") % { name: setting_name }
+                        end
+
+              report.add_event(
+                file:     target,
+                source:   name,
+                state:    :failure,
+                severity: 'error',
+                message:  message,
+              )
+              is_valid = false
+            end
+
+            timeout = env_conf.fetch('environment_timeout', nil)
+            unless timeout.nil? || timeout == '0' || timeout == 'unlimited'
+              report.add_event(
+                file:     target,
+                source:   name,
+                state:    :failure,
+                severity: 'error',
+                message:  _("environment_timeout is set to '%{timeout}' but should be 0, 'unlimited' or not set.") % { timeout: timeout },
+              )
+              is_valid = false
+            end
+
+            return 1 unless is_valid
+            report.add_event(
+              file:     target,
+              source:   name,
+              state:    :passed,
+              severity: 'ok',
+            )
+            return 0
+          rescue StandardError => e
+            report.add_event(
+              file:     target,
+              source:   name,
+              state:    :failure,
+              severity: 'error',
+              message:  e.message,
+            )
+            return 1
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pdk/validate/invokable_validator.rb

@@ -19,9 +19,8 @@ module PDK
         :once
       end
 
-      # Whether this Validator can be invoked in this context. By default any Validator can work in any Context, except ::None
-      # @return [Boolean]
-      # @abstract
+      # 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

data/lib/pdk/validate/validator.rb

@@ -40,6 +40,13 @@ module PDK
         @prepared = false
       end
 
+      # Whether this Validator can be invoked in this context. By default any Validator can work in any Context
+      # @return [Boolean]
+      # @abstract
+      def valid_in_context?
+        true
+      end
+
       # Returns the text used for the spinner to display to the user while invoking
       #
       # @return [String]

data/lib/pdk/validate/validator_group.rb

@@ -97,6 +97,7 @@ module PDK
       # @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

data/lib/pdk/validate.rb

@@ -8,15 +8,22 @@ module PDK
     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 YAML
-      autoload :YAMLSyntaxValidator, 'pdk/validate/yaml/yaml_syntax_validator'
-      autoload :YAMLValidatorGroup, 'pdk/validate/yaml/yaml_validator_group'
+    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
@@ -25,16 +32,14 @@ module PDK
     end
 
     module Tasks
-      autoload :TasksNameValidator, 'pdk/validate/tasks/tasks_name_validator'
       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 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'
+    module YAML
+      autoload :YAMLSyntaxValidator, 'pdk/validate/yaml/yaml_syntax_validator'
+      autoload :YAMLValidatorGroup, 'pdk/validate/yaml/yaml_validator_group'
     end
 
     def self.validators
@@ -47,8 +52,9 @@ module PDK
 
     # @api private
     def self.validator_hash
-      # TODO: This isn't the most performant... But with only 5 items, it's fine
+      # 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,
@@ -60,6 +66,7 @@ module PDK
     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
 

data/lib/pdk/version.rb

@@ -1,4 +1,4 @@
 module PDK
-  VERSION = '1.17.0'.freeze
+  VERSION = '1.18.0'.freeze
   TEMPLATE_REF = VERSION
 end

data/lib/pdk.rb

@@ -11,7 +11,7 @@ module PDK
   autoload :Logger, 'pdk/logger'
   autoload :Module, 'pdk/module'
   autoload :Report, 'pdk/report'
-  autoload :TemplateFile, 'pdk/template_file'
+  autoload :Template, 'pdk/template'
   autoload :TEMPLATE_REF, 'pdk/version'
   autoload :Util, 'pdk/util'
   autoload :Validate, 'pdk/validate'