pdk 1.14.0 → 1.14.1

data/lib/pdk/cli/util.rb

@@ -1,6 +1,14 @@
+require 'pdk'
+
 module PDK
   module CLI
     module Util
+      autoload :CommandRedirector, 'pdk/cli/util/command_redirector'
+      autoload :OptionNormalizer, 'pdk/cli/util/option_normalizer'
+      autoload :OptionValidator, 'pdk/cli/util/option_validator'
+      autoload :Interview, 'pdk/cli/util/interview'
+      autoload :Spinner, 'pdk/cli/util/spinner'
+
       # Ensures the calling code is being run from inside a module directory.
       #
       # @param opts [Hash] options to change the behavior of the check logic.
@@ -31,6 +39,8 @@ module PDK
       module_function :spinner_opts_for_platform
 
       def prompt_for_yes(question_text, opts = {})
+        require 'tty/prompt'
+
         prompt = opts[:prompt] || TTY::Prompt.new(help_color: :cyan)
         validator = proc { |value| [true, false].include?(value) || value =~ %r{\A(?:yes|y|no|n)\Z}i }
         response = nil
@@ -40,7 +50,7 @@ module PDK
             q.default opts[:default] unless opts[:default].nil?
             q.validate(validator, _('Answer "Y" to continue or "n" to cancel.'))
           end
-        rescue TTY::Prompt::Reader::InputInterrupt
+        rescue PDK::CLI::Util::Interview::READER::InputInterrupt
           PDK.logger.info opts[:cancel_message] if opts[:cancel_message]
         end
 
@@ -64,7 +74,7 @@ module PDK
           'GOCD_SERVER_URL',        # Go CD
           'TRAVIS',                 # Travis CI
           'GITHUB_WORKFLOW',        # GitHub Actions
-        ].any? { |name| ENV.key?(name) }
+        ].any? { |name| PDK::Util::Env.key?(name) }
       end
       module_function :ci_environment?
 
@@ -72,7 +82,7 @@ module PDK
         require 'pdk/logger'
 
         return false if PDK.logger.debug?
-        return !ENV['PDK_FRONTEND'].casecmp('noninteractive').zero? if ENV['PDK_FRONTEND']
+        return !PDK::Util::Env['PDK_FRONTEND'].casecmp('noninteractive').zero? if PDK::Util::Env['PDK_FRONTEND']
         return false if ci_environment?
         return false unless $stderr.isatty
 
@@ -127,13 +137,14 @@ module PDK
       # @return [Hash] - return hash of { gemset: <>, ruby_version: 2.x.x }
       def puppet_from_opts_or_env(opts, logging_disabled = false)
         opts ||= {}
-        use_puppet_dev = opts.fetch(:'puppet-dev', ENV['PDK_PUPPET_DEV'])
-        desired_puppet_version = opts.fetch(:'puppet-version', ENV['PDK_PUPPET_VERSION'])
-        desired_pe_version = opts.fetch(:'pe-version', ENV['PDK_PE_VERSION'])
+        use_puppet_dev = opts.fetch(:'puppet-dev', PDK::Util::Env['PDK_PUPPET_DEV'])
+        desired_puppet_version = opts.fetch(:'puppet-version', PDK::Util::Env['PDK_PUPPET_VERSION'])
+        desired_pe_version = opts.fetch(:'pe-version', PDK::Util::Env['PDK_PE_VERSION'])
 
         begin
           puppet_env =
             if use_puppet_dev
+              PDK::Util::PuppetVersion.fetch_puppet_dev(run: :once)
               PDK::Util::PuppetVersion.puppet_dev_env
             elsif desired_puppet_version
               PDK::Util::PuppetVersion.find_gem_for(desired_puppet_version)
@@ -179,15 +190,15 @@ module PDK
       def validate_puppet_version_opts(opts)
         puppet_ver_specs = []
         puppet_ver_specs << '--puppet-version option' if opts[:'puppet-version']
-        puppet_ver_specs << 'PDK_PUPPET_VERSION environment variable' if ENV['PDK_PUPPET_VERSION'] && !ENV['PDK_PUPPET_VERSION'].empty?
+        puppet_ver_specs << 'PDK_PUPPET_VERSION environment variable' if PDK::Util::Env['PDK_PUPPET_VERSION'] && !PDK::Util::Env['PDK_PUPPET_VERSION'].empty?
 
         pe_ver_specs = []
         pe_ver_specs << '--pe-version option' if opts[:'pe-version']
-        pe_ver_specs << 'PDK_PE_VERSION environment variable' if ENV['PDK_PE_VERSION'] && !ENV['PDK_PE_VERSION'].empty?
+        pe_ver_specs << 'PDK_PE_VERSION environment variable' if PDK::Util::Env['PDK_PE_VERSION'] && !PDK::Util::Env['PDK_PE_VERSION'].empty?
 
         puppet_dev_specs = []
         puppet_dev_specs << '--puppet-dev flag' if opts[:'puppet-dev']
-        puppet_dev_specs << 'PDK_PUPPET_DEV environment variable' if ENV['PDK_PUPPET_DEV'] && !ENV['PDK_PUPPET_DEV'].empty?
+        puppet_dev_specs << 'PDK_PUPPET_DEV environment variable' if PDK::Util::Env['PDK_PUPPET_DEV'] && !PDK::Util::Env['PDK_PUPPET_DEV'].empty?
 
         puppet_dev_specs.each do |pup_dev_spec|
           [puppet_ver_specs, pe_ver_specs].each do |offending|
@@ -217,7 +228,7 @@ module PDK
 
           PDK.logger.warn(_(warning_str) % {
             pup_ver_opt: opts[:'puppet-dev'],
-            pup_ver_env: ENV['PDK_PUPPET_DEV'],
+            pup_ver_env: PDK::Util::Env['PDK_PUPPET_DEV'],
           })
         elsif puppet_ver_specs.size == 2
           warning_str = 'Puppet version option from command line: "--puppet-version=%{pup_ver_opt}" '
@@ -225,7 +236,7 @@ module PDK
 
           PDK.logger.warn(_(warning_str) % {
             pup_ver_opt: opts[:'puppet-version'],
-            pup_ver_env: ENV['PDK_PUPPET_VERSION'],
+            pup_ver_env: PDK::Util::Env['PDK_PUPPET_VERSION'],
           })
         elsif pe_ver_specs.size == 2
           warning_str = 'Puppet Enterprise version option from command line: "--pe-version=%{pe_ver_opt}" '
@@ -233,7 +244,7 @@ module PDK
 
           PDK.logger.warn(_(warning_str) % {
             pup_ver_opt: opts[:'pe-version'],
-            pup_ver_env: ENV['PDK_PE_VERSION'],
+            pup_ver_env: PDK::Util::Env['PDK_PE_VERSION'],
           })
         end
       end
@@ -279,7 +290,7 @@ module PDK
         dimensions[:cli_options] = redacted_opts.join(',') unless redacted_opts.empty?
 
         ignored_env_vars = %w[PDK_ANALYTICS_CONFIG PDK_DISABLE_ANALYTICS]
-        env_vars = ENV.select { |k, _| k.start_with?('PDK_') && !ignored_env_vars.include?(k) }.map { |k, v| "#{k}=#{v}" }
+        env_vars = PDK::Util::Env.select { |k, _| k.start_with?('PDK_') && !ignored_env_vars.include?(k) }.map { |k, v| "#{k}=#{v}" }
         dimensions[:env_vars] = env_vars.join(',') unless env_vars.empty?
 
         PDK.analytics.screen_view(screen_name, dimensions)

data/lib/pdk/cli/util/command_redirector.rb

@@ -1,4 +1,5 @@
-require 'tty-prompt'
+require 'pdk'
+require 'tty/prompt'
 
 module PDK
   module CLI
@@ -17,7 +18,7 @@ module PDK
         def run
           @prompt.puts _('Did you mean \'%{command}\'?') % { command: pastel.bold(@command) }
           @prompt.yes?('-->')
-        rescue TTY::Prompt::Reader::InputInterrupt
+        rescue PDK::CLI::Util::Interview::READER::InputInterrupt
           nil
         end
       end

data/lib/pdk/cli/util/interview.rb

@@ -1,4 +1,5 @@
-require 'tty-prompt'
+require 'tty/prompt'
+require 'pdk'
 
 module PDK
   module CLI

data/lib/pdk/cli/util/option_normalizer.rb

@@ -1,3 +1,5 @@
+require 'pdk'
+
 module PDK
   module CLI
     module Util

data/lib/pdk/cli/util/option_validator.rb

@@ -1,3 +1,5 @@
+require 'pdk'
+
 module PDK
   module CLI
     module Util

data/lib/pdk/cli/validate.rb

@@ -96,7 +96,6 @@ module PDK::CLI
 
       # Ensure that the bundled gems are up to date and correct Ruby is activated before running any validations.
       puppet_env = PDK::CLI::Util.puppet_from_opts_or_env(opts)
-      PDK::Util::PuppetVersion.fetch_puppet_dev if opts[:'puppet-dev']
       PDK::Util::RubyVersion.use(puppet_env[:ruby_version])
 
       options.merge!(puppet_env[:gemset])

data/lib/pdk/config.rb

@@ -1,27 +1,33 @@
-require 'pdk/config/errors'
-require 'pdk/config/namespace'
-require 'pdk/config/setting'
-require 'pdk/config/yaml'
-require 'pdk/config/yaml_with_schema'
-require 'pdk/config/json'
+require 'pdk'
 
 module PDK
-  def self.config
-    @config ||= PDK::Config.new
-  end
-
   class Config
+    autoload :JSON, 'pdk/config/json'
+    autoload :JSONSchemaNamespace, 'pdk/config/json_schema_namespace'
+    autoload :JSONSchemaSetting, 'pdk/config/json_schema_setting'
+    autoload :LoadError, 'pdk/config/errors'
+    autoload :Namespace, 'pdk/config/namespace'
+    autoload :Setting, 'pdk/config/setting'
+    autoload :Validator, 'pdk/config/validator'
+    autoload :YAML, 'pdk/config/yaml'
+
     def user
-      require 'pdk/answer_file'
       @user ||= PDK::Config::JSON.new('user', file: PDK::Config.user_config_path) do
         mount :module_defaults, PDK::Config::JSON.new(file: PDK.answers.answer_file_path)
 
-        mount :analytics, PDK::Config::YAMLWithSchema.new(file: PDK::Config.analytics_config_path, persistent_defaults: true, schema_file: PDK::Config.json_schema('analytics')) do
+        # Due to the json-schema gem having issues with Windows based paths, and only supporting Draft 05 (or less) do
+        # not use JSON validation yet.  Once PDK drops support for EOL rubies, we will be able to use the json_schemer gem
+        # Which has much more modern support
+        # Reference - https://github.com/puppetlabs/pdk/pull/777
+        # Reference - https://tickets.puppetlabs.com/browse/PDK-1526
+        mount :analytics, PDK::Config::YAML.new(file: PDK::Config.analytics_config_path, persistent_defaults: true) do
           setting :disabled do
+            validate PDK::Config::Validator.boolean
             default_to { PDK::Config.bolt_analytics_config.fetch('disabled', true) }
           end
 
           setting 'user-id' do
+            validate PDK::Config::Validator.uuid
             default_to do
               require 'securerandom'
 
@@ -52,7 +58,7 @@ module PDK
     end
 
     def self.analytics_config_path
-      ENV['PDK_ANALYTICS_CONFIG'] || File.join(File.dirname(PDK::Util.configdir), 'puppet', 'analytics.yml')
+      PDK::Util::Env['PDK_ANALYTICS_CONFIG'] || File.join(File.dirname(PDK::Util.configdir), 'puppet', 'analytics.yml')
     end
 
     def self.user_config_path

data/lib/pdk/config/json.rb

@@ -1,4 +1,4 @@
-require 'pdk/config/namespace'
+require 'pdk'
 
 module PDK
   class Config

data/lib/pdk/config/json_schema_namespace.rb

@@ -1,4 +1,4 @@
-require 'pdk/config/namespace'
+require 'pdk'
 
 # Due to https://github.com/ruby-json-schema/json-schema/issues/439
 # Windows file paths "appear" as uri's with no host and a schema of drive letter
@@ -23,6 +23,8 @@ module JSON
   end
 end
 
+require 'json-schema'
+
 module PDK
   class Config
     class JSONSchemaNamespace < Namespace
@@ -104,7 +106,6 @@ module PDK
       #
       # @return [JSON::Schema]
       def create_empty_schema
-        require 'json-schema'
         ::JSON::Schema.new({}, 'http://json-schema.org/draft-06/schema#')
       end
 
@@ -117,8 +118,6 @@ module PDK
         # Create an empty schema by default.
         @document_schema = create_empty_schema
 
-        require 'json-schema'
-
         return @document_schema if @schema_file.nil?
         unless PDK::Util::Filesystem.file?(@schema_file)
           raise PDK::Config::LoadError, _('Unable to open %{file} for reading. File does not exist') % {

data/lib/pdk/config/json_schema_setting.rb

@@ -1,4 +1,4 @@
-require 'pdk/config/json_schema_namespace'
+require 'pdk'
 
 module PDK
   class Config

data/lib/pdk/config/json_with_schema.rb

@@ -1,5 +1,4 @@
-require 'pdk/config/json_schema_namespace'
-require 'pdk/config/json_schema_setting'
+require 'pdk'
 
 module PDK
   class Config

data/lib/pdk/config/namespace.rb

@@ -1,3 +1,5 @@
+require 'pdk'
+
 module PDK
   class Config
     class Namespace

data/lib/pdk/config/setting.rb

@@ -1,3 +1,5 @@
+require 'pdk'
+
 module PDK
   class Config
     # A class for describing the setting of a {PDK::Config} setting.

data/lib/pdk/config/validator.rb

@@ -0,0 +1,31 @@
+module PDK
+  class Config
+    # A collection of predefined validators for use with {PDK::Config::Value}.
+    #
+    # @example
+    #   value :enabled do
+    #     validate PDK::Config::Validator.boolean
+    #   end
+    module Validator
+      # @return [Hash{Symbol => [Proc,String]}] a {PDK::Config::Value}
+      #   validator that ensures that the value is either a TrueClass or
+      #   FalseClass.
+      def self.boolean
+        {
+          proc:    ->(value) { [true, false].include?(value) },
+          message: _('must be a boolean: true or false'),
+        }
+      end
+
+      # @return [Hash{Symbol => [Proc,String]}] a {PDK::Config::Value}
+      #   validator that ensures that the value is a String that matches the
+      #   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'),
+        }
+      end
+    end
+  end
+end

data/lib/pdk/config/yaml.rb

@@ -1,5 +1,4 @@
-require 'pdk/config/namespace'
-require 'pdk/config/setting'
+require 'pdk'
 
 module PDK
   class Config

data/lib/pdk/config/yaml_with_schema.rb

@@ -1,4 +1,4 @@
-require 'pdk/config/json_schema_namespace'
+require 'pdk'
 
 module PDK
   class Config

data/lib/pdk/generate.rb

@@ -1,18 +1,24 @@
-require 'pdk/generate/defined_type'
-require 'pdk/generate/module'
-require 'pdk/generate/provider'
-require 'pdk/generate/puppet_class'
-require 'pdk/generate/task'
-require 'pdk/generate/transport'
+require 'pdk'
 
 module PDK
   module Generate
-    GENERATORS = [
-      PDK::Generate::DefinedType,
-      PDK::Generate::Provider,
-      PDK::Generate::PuppetClass,
-      PDK::Generate::Task,
-      PDK::Generate::Transport,
-    ].freeze
+    autoload :DefinedType, 'pdk/generate/defined_type'
+    autoload :Module, 'pdk/generate/module'
+    autoload :Provider, 'pdk/generate/provider'
+    autoload :PuppetClass, 'pdk/generate/puppet_class'
+    autoload :PuppetObject, 'pdk/generate/puppet_object'
+    autoload :Task, 'pdk/generate/task'
+    autoload :Transport, 'pdk/generate/transport'
+
+    def generators
+      @generators ||= [
+        PDK::Generate::DefinedType,
+        PDK::Generate::Provider,
+        PDK::Generate::PuppetClass,
+        PDK::Generate::Task,
+        PDK::Generate::Transport,
+      ].freeze
+    end
+    module_function :generators
   end
 end

data/lib/pdk/generate/defined_type.rb

@@ -1,4 +1,4 @@
-require 'pdk/generate/puppet_object'
+require 'pdk'
 
 module PDK
   module Generate

data/lib/pdk/generate/module.rb

@@ -1,4 +1,4 @@
-require 'pdk/util/filesystem'
+require 'pdk'
 
 module PDK
   module Generate

data/lib/pdk/generate/provider.rb

@@ -1,4 +1,4 @@
-require 'pdk/generate/puppet_object'
+require 'pdk'
 
 module PDK
   module Generate
@@ -21,7 +21,7 @@ module PDK
 
       def raise_precondition_error(error)
         raise PDK::CLI::ExitWithError, _('%{error}: Creating a provider needs some local configuration in your module.' \
-          ' Please follow the docs at https://github.com/puppetlabs/puppet-resource_api#getting-started.') % { error: error }
+          ' Please follow the docs at https://puppet.com/docs/puppet/latest/create_types_and_providers_resource_api.html.') % { error: error }
       end
 
       def check_preconditions

data/lib/pdk/generate/puppet_class.rb

@@ -1,4 +1,4 @@
-require 'pdk/generate/puppet_object'
+require 'pdk'
 
 module PDK
   module Generate

data/lib/pdk/generate/puppet_object.rb

@@ -1,3 +1,5 @@
+require 'pdk'
+
 module PDK
   module Generate
     class PuppetObject

data/lib/pdk/generate/task.rb

@@ -1,4 +1,4 @@
-require 'pdk/generate/puppet_object'
+require 'pdk'
 
 module PDK
   module Generate

data/lib/pdk/generate/transport.rb

@@ -1,4 +1,4 @@
-require 'pdk/generate/puppet_object'
+require 'pdk'
 
 module PDK
   module Generate

data/lib/pdk/logger.rb

@@ -1,10 +1,7 @@
 require 'logger'
+require 'pdk'
 
 module PDK
-  def self.logger
-    @logger ||= PDK::Logger.new
-  end
-
   class Logger < ::Logger
     WRAP_COLUMN_LIMIT = 78
 

data/lib/pdk/module.rb

@@ -1,5 +1,12 @@
 module PDK
   module Module
+    autoload :Build, 'pdk/module/build'
+    autoload :Convert, 'pdk/module/convert'
+    autoload :Metadata, 'pdk/module/metadata'
+    autoload :TemplateDir, 'pdk/module/templatedir'
+    autoload :UpdateManager, 'pdk/module/update_manager'
+    autoload :Update, 'pdk/module/update'
+
     DEFAULT_IGNORED = [
       '/pkg/',
       '~*',