pdk 2.7.0 → 3.0.0

data/lib/pdk/config/task_schema.json

@@ -0,0 +1,116 @@
+{
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "title": "Puppet Task Metadata",
+  "description": "The metadata format for Puppet Tasks",
+  "type": "object",
+  "properties": {
+    "description": {
+      "type": "string",
+      "description": "A longer description(one paragraph) of how to use the task"
+    },
+    "puppet_task_version": {
+      "type": "integer",
+      "description": "The version of this spec used",
+      "default": 1
+    },
+    "supports_noop": {
+      "type": "boolean",
+      "default": false,
+      "description": "This task respects the '_noop' metaparam. If this false or absent the task runner will refuse to run this task if noop is specified."
+    },
+    "remote": {
+      "type": "boolean",
+      "default": false,
+      "description": "This task is capable of operating on a remote target using connection information in the '_target' metaparam."
+    },
+    "input_method": {
+      "type": "string",
+      "enum": ["stdin", "environment", "both", "powershell"],
+      "description": "What input method should be used to pass params to the task"
+    },
+    "parameters": {
+      "$ref": "#/definitions/paramsObject",
+      "description": "An object mapping valid parameter names to corresponding json-schemas"
+    },
+    "implementations": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["name"],
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "Name of task executable file"
+          },
+          "requirements": {
+            "type": "array",
+            "additionalItems": {
+              "type": "string"
+            },
+            "description": "Features required on target to execute task"
+          },
+          "files": {
+            "type": "array",
+            "additionalItems": {
+              "type": "string"
+            },
+            "description": "File resources required by task"
+          }
+        }
+      },
+      "description": "Rules for selecting implementation resources based on features available on target"
+    },
+    "files": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "Path to file resources saved in valid module directory to be provided to task"
+    },
+    "private": {
+      "type": "boolean",
+      "description": "Should this task appear by default in UI lists of tasks"
+    },
+    "extensions": {
+      "type": "object",
+      "description": "Task Runner specific metadata extensions",
+      "items": {
+        "type": "object"
+      }
+    }
+  },
+  "definitions": {
+    "parameterName": {
+      "description": "Valid names for parameter keys",
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9_]*$"
+    },
+    "paramsObject": {
+      "type": "object",
+      "description": "An object with restricted keys and enumData support",
+      "propertyNames": {"$ref": "#/definitions/parameterName"},
+      "additionalProperties": {
+        "type": "object",
+        "description": "Extend Normal JSON schema to require an object and describe 'enumData' to map enum values to descriptions",
+        "properties": {
+          "description": {
+            "description": "A description of the parameter",
+            "type": "string"
+          },
+          "type": {
+            "description": "A puppet type string that describes a data type that will match the parameter value",
+            "type": "string"
+          },
+          "sensitive": {
+            "description": "Whether the task runner should treat the parameter value as sensitive",
+            "type": "boolean",
+            "default": false
+          },
+          "default": {
+            "description": "The default value to pass to the task implementation if the parameter isn't provided"
+          }
+        }
+      }
+    }
+  }
+}

data/lib/pdk/config/validator.rb

@@ -12,8 +12,8 @@ module PDK
       #   FalseClass.
       def self.boolean
         {
-          proc:    ->(value) { [true, false].include?(value) },
-          message: 'must be a boolean: true or false',
+          proc: ->(value) { [true, false].include?(value) },
+          message: 'must be a boolean: true or false'
         }
       end
 
@@ -22,8 +22,8 @@ module PDK
       #   regex for a version 4 UUID.
       def self.uuid
         {
-          proc:    ->(value) { value.match(%r{\A\h{8}(?:-\h{4}){3}-\h{12}\z}) },
-          message: 'must be a version 4 UUID',
+          proc: ->(value) { value.match(/\A\h{8}(?:-\h{4}){3}-\h{12}\z/) },
+          message: 'must be a version 4 UUID'
         }
       end
     end

data/lib/pdk/config/yaml.rb

@@ -8,6 +8,7 @@ module PDK
     class YAML < Namespace
       def parse_file(filename)
         raise unless block_given?
+
         data = load_data(filename)
         return if data.nil? || data.empty?
 
@@ -22,15 +23,9 @@ module PDK
 
         data.each { |k, v| yield k, PDK::Config::Setting.new(k, self, v) }
       rescue Psych::SyntaxError => e
-        raise PDK::Config::LoadError, 'Syntax error when loading %{file}: %{error}' % {
-          file:  filename,
-          error: "#{e.problem} #{e.context}",
-        }
+        raise PDK::Config::LoadError, format('Syntax error when loading %{file}: %{error}', file: filename, error: "#{e.problem} #{e.context}")
       rescue Psych::DisallowedClass => e
-        raise PDK::Config::LoadError, 'Unsupported class in %{file}: %{error}' % {
-          file:  filename,
-          error: e.message,
-        }
+        raise PDK::Config::LoadError, format('Unsupported class in %{file}: %{error}', file: filename, error: e.message)
       end
 
       # Serializes object data into a YAML string.

data/lib/pdk/config/yaml_with_schema.rb

@@ -8,6 +8,7 @@ module PDK
     class YAMLWithSchema < JSONSchemaNamespace
       def parse_file(filename)
         raise unless block_given?
+
         data = load_data(filename)
         data = '' if data.nil?
         require 'yaml'
@@ -20,10 +21,7 @@ module PDK
           # Ensure the parsed document is actually valid
           validate_document!(@raw_data)
         rescue ::JSON::Schema::ValidationError => e
-          raise PDK::Config::LoadError, 'The configuration file %{filename} is not valid: %{message}' % {
-            filename: filename,
-            message:  e.message,
-          }
+          raise PDK::Config::LoadError, format('The configuration file %{filename} is not valid: %{message}', filename: filename, message: e.message)
         end
 
         require 'pdk/config/json_schema_setting'
@@ -36,15 +34,9 @@ module PDK
         # we're left with the settings that we don't manage.
         self.unmanaged_settings = @raw_data.reject { |k, _| schema_property_names.include?(k) }
       rescue Psych::SyntaxError => e
-        raise PDK::Config::LoadError, 'Syntax error when loading %{file}: %{error}' % {
-          file:  filename,
-          error: "#{e.problem} #{e.context}",
-        }
+        raise PDK::Config::LoadError, format('Syntax error when loading %{file}: %{error}', file: filename, error: "#{e.problem} #{e.context}")
       rescue Psych::DisallowedClass => e
-        raise PDK::Config::LoadError, 'Unsupported class in %{file}: %{error}' % {
-          file:  filename,
-          error: e.message,
-        }
+        raise PDK::Config::LoadError, format('Unsupported class in %{file}: %{error}', file: filename, error: e.message)
       end
 
       # Serializes object data into a YAML string.

data/lib/pdk/config.rb

@@ -24,12 +24,12 @@ module PDK
     def initialize(options = nil)
       options = {} if options.nil?
       @config_options = {
-        'system.path'                 => PDK::Config.system_config_path,
+        'system.path' => PDK::Config.system_config_path,
         'system.module_defaults.path' => PDK::Config.system_answers_path,
-        'user.path'                   => PDK::Config.user_config_path,
-        'user.module_defaults.path'   => PDK::AnswerFile.default_answer_file_path,
-        'user.analytics.path'         => PDK::Config.analytics_config_path,
-        'context'                     => PDK.context,
+        'user.path' => PDK::Config.user_config_path,
+        'user.module_defaults.path' => PDK::AnswerFile.default_answer_file_path,
+        'user.analytics.path' => PDK::Config.analytics_config_path,
+        'context' => PDK.context
       }.merge(options)
     end
 
@@ -91,9 +91,7 @@ module PDK
     def project_config
       context = @config_options['context']
       @project ||= PDK::Config::Namespace.new('project') do
-        if context.is_a?(PDK::Context::ControlRepo)
-          mount :environment, PDK::ControlRepo.environment_conf_as_config(File.join(context.root_path, 'environment.conf'))
-        end
+        mount :environment, PDK::ControlRepo.environment_conf_as_config(File.join(context.root_path, 'environment.conf')) if context.is_a?(PDK::Context::ControlRepo)
 
         mount :validate, PDK::Config::YAML.new('validate', file: File.join(context.root_path, 'pdk.yaml'), persistent_defaults: true) do
           setting 'ignore' do
@@ -124,9 +122,10 @@ module PDK
       return nil if root.nil? || root.empty?
 
       if keys.empty?
-        if root.is_a?(Array)
+        case root
+        when Array
           name = root
-        elsif root.is_a?(String)
+        when String
           name = split_key_string(root)
         else
           return nil
@@ -135,7 +134,7 @@ module PDK
         name = [root].concat(keys)
       end
 
-      get_within_scopes(name[1..-1], [name[0]])
+      get_within_scopes(name[1..], [name[0]])
     end
 
     # Returns a configuration setting by name, using scope precedence rules. If no scopes are passed, then all scopes are queried using the default precedence rules
@@ -143,8 +142,8 @@ module PDK
     # @scopes [Nil, Array[String]] The list of scopes, in order, to query in turn for the setting_name. Invalid or missing scopes are ignored.
     # @return [PDK::Config::Namespace, Object, nil] The value of the configuration setting. Returns nil if it does no exist
     def get_within_scopes(setting_name, scopes = nil)
-      raise ArgumentError, 'Expected an Array but got \'%{klass}\' for scopes' % { klass: scopes.class } unless scopes.nil? || scopes.is_a?(Array)
-      raise ArgumentError, 'Expected an Array or String but got \'%{klass}\' for setting_name' % { klass: setting_name.class } unless setting_name.is_a?(Array) || setting_name.is_a?(String)
+      raise ArgumentError, format('Expected an Array but got \'%{klass}\' for scopes', klass: scopes.class) unless scopes.nil? || scopes.is_a?(Array)
+      raise ArgumentError, format('Expected an Array or String but got \'%{klass}\' for setting_name', klass: setting_name.class) unless setting_name.is_a?(Array) || setting_name.is_a?(String)
 
       setting_arr = setting_name.is_a?(String) ? split_key_string(setting_name) : setting_name
       all_scope_names = all_scopes.keys
@@ -165,6 +164,7 @@ module PDK
     # @yield [PDK::Config::Namespace, Object] The value of the configuration setting. Does not yield if the setting does not exist or is nil
     def with_scoped_value(setting_name, scopes = nil)
       raise ArgumentError, 'must be passed a block' unless block_given?
+
       value = get_within_scopes(setting_name, scopes)
       yield value unless value.nil?
     end
@@ -179,24 +179,23 @@ module PDK
     # @return [Object] The new value of the configuration setting
     def set(key, value, options = {})
       options = {
-        force: false,
+        force: false
       }.merge(options)
 
       names = key.is_a?(String) ? split_key_string(key) : key
       raise ArgumentError, 'Invalid configuration names' if names.nil? || !names.is_a?(Array) || names.empty?
+
       scope_name = names[0]
-      raise ArgumentError, "Unknown configuration root '%{name}'" % { name: scope_name } if all_scopes[scope_name].nil?
-      deep_set_object(value, options[:force], send(all_scopes[scope_name]), *names[1..-1])
+      raise ArgumentError, format("Unknown configuration root '%{name}'", name: scope_name) if all_scopes[scope_name].nil?
+
+      deep_set_object(value, options[:force], send(all_scopes[scope_name]), *names[1..])
     end
 
     def self.bolt_analytics_config
       file = PDK::Util::Filesystem.expand_path('~/.puppetlabs/bolt/analytics.yaml')
       PDK::Config::YAML.new(file: file)
     rescue PDK::Config::LoadError => e
-      PDK.logger.debug 'Unable to load %{file}: %{message}' % {
-        file:    file,
-        message: e.message,
-      }
+      PDK.logger.debug format('Unable to load %{file}: %{message}', file: file, message: e.message)
       PDK::Config::YAML.new
     end
 
@@ -222,7 +221,7 @@ module PDK
 
     # return nil if not exist
     def self.json_schema(name)
-      File.join(json_schemas_path, name + '_schema.json')
+      File.join(json_schemas_path, "#{name}_schema.json")
     end
 
     def self.analytics_config_exist?
@@ -235,24 +234,21 @@ module PDK
       return unless PDK::CLI::Util.interactive?
 
       pre_message =
-        'PDK collects anonymous usage information to help us understand how ' \
-        'it is being used and make decisions on how to improve it. You can ' \
-        'find out more about what data we collect and how it is used in the ' \
-        "PDK documentation at %{url}.\n" % { url: 'https://puppet.com/docs/pdk/latest/pdk_install.html' }
+        format('PDK collects anonymous usage information to help us understand how ' \
+               'it is being used and make decisions on how to improve it. You can ' \
+               'find out more about what data we collect and how it is used in the ' \
+               "PDK documentation at %{url}.\n", url: 'https://puppet.com/docs/pdk/latest/pdk_install.html')
       post_message =
-        'You can opt in or out of the usage data collection at any time by ' \
-        'editing the analytics configuration file at %{path} and changing ' \
-        "the '%{key}' value." % {
-          path: PDK::Config.analytics_config_path,
-        key:  'disabled',
-        }
+        format('You can opt in or out of the usage data collection at any time by ' \
+               'editing the analytics configuration file at %{path} and changing ' \
+               "the '%{key}' value.", path: PDK::Config.analytics_config_path, key: 'disabled')
 
       questions = [
         {
-          name:     'enabled',
+          name: 'enabled',
           question: 'Do you consent to the collection of anonymous PDK usage information?',
-          type:     :yes,
-        },
+          type: :yes
+        }
       ]
 
       require 'pdk/cli/util/interview'
@@ -265,9 +261,9 @@ module PDK
 
       if answers.nil?
         PDK.logger.info 'No answer given, opting out of analytics collection.'
-        PDK.config.set(%w[user analytics disabled], true)
+        PDK.config.set(['user', 'analytics', 'disabled'], true)
       else
-        PDK.config.set(%w[user analytics disabled], !answers['enabled'])
+        PDK.config.set(['user', 'analytics', 'disabled'], !answers['enabled'])
       end
 
       PDK.logger.info(text: post_message, wrap: true)
@@ -275,7 +271,7 @@ module PDK
 
     private
 
-    #:nocov: This is a private method and is tested elsewhere
+    # :nocov: This is a private method and is tested elsewhere
     def traverse_object(object, *names)
       return nil if object.nil? || !object.respond_to?(:[])
       return nil if names.nil?
@@ -289,25 +285,27 @@ module PDK
       value = object[name]
       if names.empty?
         return value if value.is_a?(PDK::Config::Namespace)
+
         # Duplicate arrays and hashes so that they are isolated from changes being made
-        (value.is_a?(Hash) || value.is_a?(Array)) ? value.dup : value
+        value.is_a?(Hash) || value.is_a?(Array) ? value.dup : value
       else
         traverse_object(value, *names)
       end
     end
-    #:nocov:
+    # :nocov:
 
-    #:nocov: This is a private method and is tested elsewhere
+    # :nocov: This is a private method and is tested elsewhere
     # Takes a string representation of a setting and splits into its constituent setting parts e.g.
     # 'user.a.b.c' becomes ['user', 'a', 'b', 'c']
     # @return [Array[String]] The string split into each setting name as an array
     def split_key_string(key)
-      raise ArgumentError, 'Expected a String but got \'%{klass}\'' % { klass: key.class } unless key.is_a?(String)
+      raise ArgumentError, format('Expected a String but got \'%{klass}\'', klass: key.class) unless key.is_a?(String)
+
       key.split('.')
     end
-    #:nocov:
+    # :nocov:
 
-    #:nocov:
+    # :nocov:
     # Returns all known scope names and their associated method name to call, to query the scope
     # Note - Order is important. This dictates the resolution precedence order (topmost is processed first)
     # @return [Hash[String, Symbol]] A hash of the scope name then method name to call to query the scope (as a Symbol)
@@ -315,12 +313,12 @@ module PDK
       # Note - Order is important. This dictates the resolution precedence order (topmost is processed first)
       {
         'project' => :project_config,
-        'user'    => :user_config,
-        'system'  => :system_config,
+        'user' => :user_config,
+        'system' => :system_config
       }.freeze
     end
 
-    #:nocov: This is a private method and is tested elsewhere
+    # :nocov: This is a private method and is tested elsewhere
     # Deeply traverses an object tree via `[]` and sets the last
     # element to the value specified.
     #
@@ -333,9 +331,7 @@ module PDK
       current_value = namespace[name]
 
       # If the next thing in the traversal chain is another namespace, set the value using that child namespace.
-      if current_value.is_a?(PDK::Config::Namespace)
-        return deep_set_object(value, force, current_value, *names)
-      end
+      return deep_set_object(value, force, current_value, *names) if current_value.is_a?(PDK::Config::Namespace)
 
       # We're at the end of the name traversal
       if names.empty?
@@ -378,11 +374,11 @@ module PDK
         return value
       end
 
-      raise ArgumentError, "Unable to set '%{key}' to '%{value}' as it is not a Hash" % { key: namespace.name + '.' + name, value: hash_value } unless current_value.is_a?(Hash)
+      raise ArgumentError, format("Unable to set '%{key}' to '%{value}' as it is not a Hash", key: "#{namespace.name}.#{name}", value: hash_value) unless current_value.is_a?(Hash)
 
       namespace[name] = current_value.merge(hash_value)
       value
     end
-    #:nocov:
+    # :nocov:
   end
 end

data/lib/pdk/context/control_repo.rb

@@ -26,6 +26,7 @@ module PDK
       # @return [Array[String]] The modulepath setting for this control repository
       def module_paths
         return @module_paths unless @module_paths.nil?
+
         value = environment_conf['modulepath'] || ''
         # We have to use a hardcoded value here because File::PATH_SEPARATOR is ';' on Windows.
         # As the environment.conf is only used on Puppet Server, it's always ':'
@@ -41,12 +42,12 @@ module PDK
                                                  .select { |path| PDK::Util::Filesystem.directory?(PDK::Util::Filesystem.expand_path(File.join(root_path, path))) }
       end
 
-      #:nocov:
+      # :nocov:
       # @see PDK::Context::AbstractContext.display_name
       def display_name
         'a Control Repository context'
       end
-      #:nocov:
+      # :nocov:
 
       private
 

data/lib/pdk/context/module.rb

@@ -17,12 +17,12 @@ module PDK
         PDK::Util.module_pdk_compatible?(root_path)
       end
 
-      #:nocov:
+      # :nocov:
       # @see PDK::Context::AbstractContext.display_name
       def display_name
         'a Puppet Module context'
       end
-      #:nocov:
+      # :nocov:
     end
   end
 end

data/lib/pdk/context/none.rb

@@ -5,12 +5,12 @@ module PDK
     # Represents a context which the PDK does not know. For example
     # an empty directory
     class None < PDK::Context::AbstractContext
-      #:nocov:
+      # :nocov:
       # @see PDK::Context::AbstractContext.display_name
       def display_name
         'an unknown context'
       end
-      #:nocov:
+      # :nocov:
 
       # @see PDK::Context::AbstractContext.parent_context
       def parent_context

data/lib/pdk/context.rb

@@ -20,9 +20,7 @@ module PDK
 
         # Puppet Module detection
         metadata_file = File.join(current, 'metadata.json')
-        if PDK::Util::Filesystem.file?(metadata_file) || PDK::Util.in_module_root?(context_path)
-          return PDK::Context::Module.new(current, context_path)
-        end
+        return PDK::Context::Module.new(current, context_path) if PDK::Util::Filesystem.file?(metadata_file) || PDK::Util.in_module_root?(context_path)
 
         previous = current
         current = PDK::Util::Filesystem.expand_path('..', current)
@@ -82,6 +80,7 @@ module PDK
           PDK.logger.debug("Detected #{current.display_name} at #{current.root_path.nil? ? current.context_path : current.root_path}")
           current = current.parent_context
           break if current.nil?
+
           depth += 1
           # Circuit breaker in case there are circular references
           break if depth > 20
@@ -89,11 +88,11 @@ module PDK
         nil
       end
 
-      #:nocov: There's nothing to test here
+      # :nocov: There's nothing to test here
       def to_s
         "#<#{self.class}:#{object_id}>#{context_path}"
       end
-      #:nocov:
+      # :nocov:
     end
   end
 end

data/lib/pdk/control_repo.rb

@@ -2,7 +2,7 @@ require 'pdk'
 
 module PDK
   module ControlRepo
-    CONTROL_REPO_FILES = %w[environment.conf Puppetfile].freeze
+    CONTROL_REPO_FILES = ['environment.conf', 'Puppetfile'].freeze
 
     DEFAULT_IGNORED = [
       '/pkg/',
@@ -11,7 +11,7 @@ module PDK
       # Strictly speaking this isn't default but if people have tricked older PDK into thinking that a
       # Control Repo is a module, they may have recursive symlinks in spec/fixtures/modules
       '/spec/fixtures/modules/',
-      '/vendor/',
+      '/vendor/'
     ].freeze
 
     # Returns path to the root of the Control Repo being worked on.
@@ -38,10 +38,9 @@ module PDK
                File.dirname(environment_conf_path)
              elsif control_repo_root?(Dir.pwd)
                Dir.pwd
-             else
-               nil
              end
       return path if path.nil? || !strict_check
+
       PDK::Bolt.bolt_project_root?(path) ? nil : path
     end
     module_function :find_control_repo_root

data/lib/pdk/generate/defined_type.rb

@@ -25,12 +25,12 @@ module PDK
         define_name_parts = object_name.split('::')
         # drop the module name if the object name contains multiple parts
         define_name_parts.delete_at(0) if define_name_parts.length > 1
-        files = { 'defined_type_spec.erb' => File.join('spec', 'defines', *define_name_parts) + '_spec.rb' }
+        files = { 'defined_type_spec.erb' => "#{File.join('spec', 'defines', *define_name_parts)}_spec.rb" }
         return files if spec_only?
 
-        define_name_parts = object_name.split('::')[1..-1]
+        define_name_parts = object_name.split('::')[1..]
         define_name_parts << 'init' if define_name_parts.empty?
-        files['defined_type.erb'] = File.join('manifests', *define_name_parts) + '.pp'
+        files['defined_type.erb'] = "#{File.join('manifests', *define_name_parts)}.pp"
 
         files
       end

data/lib/pdk/generate/fact.rb

@@ -9,11 +9,12 @@ module PDK
 
       def template_files
         files = {
-          'fact_spec.erb' => File.join('spec', 'unit', 'facter', object_name) + '_spec.rb',
+          'fact_spec.erb' => "#{File.join('spec', 'unit', 'facter', object_name)}_spec.rb"
         }
         return files if spec_only?
+
         files.merge(
-          'fact.erb' => File.join('lib', 'facter', object_name) + '.rb',
+          'fact.erb' => "#{File.join('lib', 'facter', object_name)}.rb"
         )
       end
 

data/lib/pdk/generate/function.rb

@@ -24,16 +24,17 @@ module PDK
         # Drop the module name if the object name contains multiple parts
         func_name_parts.delete_at(0) if func_name_parts.length > 1
         files = {
-          File.join('functions', 'function_spec.erb') => File.join('spec', 'functions', *func_name_parts) + '_spec.rb',
+          File.join('functions', 'function_spec.erb') => "#{File.join('spec', 'functions', *func_name_parts)}_spec.rb"
         }
         return files if spec_only?
-        func_name_parts = object_name.split('::')[1..-1]
+
+        func_name_parts = object_name.split('::')[1..]
         template_file = File.join('functions', "#{options[:type]}_function.erb")
 
         files[template_file] = if options[:type].eql?('v4')
-                                 File.join('lib', 'puppet', 'functions', module_name, *func_name_parts) + '.rb'
+                                 "#{File.join('lib', 'puppet', 'functions', module_name, *func_name_parts)}.rb"
                                else
-                                 File.join('functions', *func_name_parts) + '.pp'
+                                 "#{File.join('functions', *func_name_parts)}.pp"
                                end
         files
       end