pdk 1.13.0 → 1.14.0

data/lib/pdk/cli/exec/command.rb

@@ -1,14 +1,3 @@
-require 'bundler'
-require 'childprocess'
-require 'English'
-require 'tempfile'
-require 'tty-which'
-
-require 'pdk/util'
-require 'pdk/util/git'
-require 'pdk/util/ruby_version'
-require 'pdk/cli/util/spinner'
-
 module PDK
   module CLI
     module Exec
@@ -20,6 +9,9 @@ module PDK
         attr_writer :exec_group
 
         def initialize(*argv)
+          require 'childprocess'
+          require 'tempfile'
+
           @argv = argv
 
           @process = ChildProcess.build(*@argv)
@@ -50,6 +42,8 @@ module PDK
         end
 
         def register_spinner(spinner, opts = {})
+          require 'pdk/cli/util'
+
           return unless PDK::CLI::Util.interactive?
           @success_message = opts.delete(:success)
           @failure_message = opts.delete(:failure)
@@ -58,10 +52,14 @@ module PDK
         end
 
         def add_spinner(message, opts = {})
+          require 'pdk/cli/util'
+
           return unless PDK::CLI::Util.interactive?
           @success_message = opts.delete(:success)
           @failure_message = opts.delete(:failure)
 
+          require 'pdk/cli/util/spinner'
+
           @spinner = TTY::Spinner.new("[:spinner] #{message}", opts.merge(PDK::CLI::Util.spinner_opts_for_platform))
         end
 
@@ -77,6 +75,7 @@ module PDK
           resolved_env_for_command.each { |k, v| @process.environment[k] = v }
 
           if [:module, :pwd].include?(context)
+            require 'pdk/util'
             mod_root = PDK::Util.module_root
 
             unless mod_root
@@ -155,6 +154,10 @@ module PDK
           resolved_env['BUNDLE_IGNORE_CONFIG'] = '1'
 
           if [:module, :pwd].include?(context)
+            require 'pdk/util'
+            require 'pdk/util/git'
+            require 'pdk/util/ruby_version'
+
             resolved_env['GEM_HOME'] = PDK::Util::RubyVersion.gem_home
             resolved_env['GEM_PATH'] = PDK::Util::RubyVersion.gem_path
 
@@ -186,6 +189,8 @@ module PDK
         end
 
         def run_process_in_clean_env!
+          require 'bundler'
+
           ::Bundler.with_clean_env do
             run_process!
           end

data/lib/pdk/cli/exec/interactive_command.rb

@@ -35,6 +35,8 @@ module PDK
         end
 
         def execute!
+          require 'pdk/util'
+
           @resolved_env = resolved_env_for_command
 
           if [:module, :pwd].include?(context)
@@ -98,6 +100,8 @@ module PDK
         end
 
         def child_status
+          require 'English'
+
           $CHILD_STATUS
         end
 

data/lib/pdk/cli/exec_group.rb

@@ -1,15 +1,13 @@
-require 'tty-which'
-
-require 'pdk/util'
-require 'pdk/cli/util/spinner'
-
 module PDK
   module CLI
     class ExecGroup
       def initialize(message, opts = {})
+        require 'pdk/cli/util'
         @options = opts.merge(PDK::CLI::Util.spinner_opts_for_platform)
 
         if PDK::CLI::Util.interactive?
+          require 'pdk/cli/util/spinner'
+
           @spinner = if parallel?
                        TTY::Spinner::Multi.new("[:spinner] #{message}", @options)
                      else
@@ -41,6 +39,8 @@ module PDK
       end
 
       def add_spinner(message, opts = {})
+        require 'pdk/cli/util'
+
         return unless PDK::CLI::Util.interactive?
         @spinner.register("[:spinner] #{message}", @options.merge(opts).merge(PDK::CLI::Util.spinner_opts_for_platform))
       end

data/lib/pdk/cli/module/build.rb

@@ -1,5 +1,3 @@
-require 'tty-prompt'
-
 module PDK::CLI
   @module_build_cmd = @module_cmd.define_command do
     name 'build'

data/lib/pdk/cli/module/generate.rb

@@ -1,5 +1,3 @@
-require 'tty-prompt'
-
 module PDK::CLI
   @module_generate_cmd = @module_cmd.define_command do
     name 'generate'
@@ -12,6 +10,7 @@ module PDK::CLI
 
     run do |opts, args, _cmd|
       require 'pdk/generate/module'
+      require 'tty-prompt'
 
       module_name = args[0]
 

data/lib/pdk/cli/new.rb

@@ -15,5 +15,5 @@ require 'pdk/cli/new/defined_type'
 require 'pdk/cli/new/module'
 require 'pdk/cli/new/provider'
 require 'pdk/cli/new/task'
+require 'pdk/cli/new/test'
 require 'pdk/cli/new/transport'
-require 'pdk/cli/new/unit_test'

data/lib/pdk/cli/new/defined_type.rb

@@ -24,6 +24,8 @@ module PDK::CLI
 
       PDK::CLI::Util.analytics_screen_view('new_defined_type', opts)
 
+      require 'pdk/generate/defined_type'
+
       PDK::Generate::DefinedType.new(module_dir, defined_type_name, opts).run
     end
   end

data/lib/pdk/cli/new/provider.rb

@@ -21,6 +21,8 @@ module PDK::CLI
 
       PDK::CLI::Util.analytics_screen_view('new_provider', opts)
 
+      require 'pdk/generate/provider'
+
       PDK::Generate::Provider.new(module_dir, provider_name, opts).run
     end
   end

data/lib/pdk/cli/new/task.rb

@@ -7,6 +7,8 @@ module PDK::CLI
     option nil, :description, _('A short description of the purpose of the task'), argument: :required
 
     run do |opts, args, _cmd|
+      require 'pdk/generate/task'
+
       PDK::CLI::Util.ensure_in_module!(
         message:   _('Tasks can only be created from inside a valid module directory.'),
         log_level: :info,

data/lib/pdk/cli/new/{unit_test.rb → test.rb}

@@ -1,22 +1,19 @@
 module PDK::CLI
   @new_define_cmd = @new_cmd.define_command do
-    name 'unit_test'
-    usage _('unit_test [options] <name>')
-    summary _('(Experimental) Create a new unit test for the object named <name>')
-    description _(<<-EOF
-Generate a new rspec-puppet unit test for an existing class or defined type.
-
-Please note, this is an experimental feature; the functionality and UX is
-subject to change in future releases.
-EOF
-                 )
+    name 'test'
+    usage _('test [options] <name>')
+    summary _('Create a new test for the object named <name>')
+    flag :u, :unit, _('Create a new unit test.')
     PDK::CLI.puppet_version_options(self)
     PDK::CLI.puppet_dev_option(self)
 
     run do |opts, args, _cmd|
+      require 'pdk/util/puppet_strings'
+      require 'pdk/util/bundler'
+
       PDK::CLI::Util.validate_puppet_version_opts(opts)
       PDK::CLI::Util.ensure_in_module!(
-        message: _('Unit tests can only be created from inside a valid module directory.'),
+        message: _('Tests can only be created from inside a valid module directory.'),
         log_level: :info,
       )
 
@@ -28,6 +25,13 @@ EOF
         exit 1
       end
 
+      unless opts[:unit]
+        # At a future time, we'll replace this conditional with an interactive
+        # question to choose the test type.
+        PDK.logger.info _('Test type not specified, assuming unit.')
+        opts[:unit] = true
+      end
+
       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])
@@ -36,7 +40,7 @@ EOF
       begin
         generator, obj = PDK::Util::PuppetStrings.find_object(object_name)
 
-        PDK::CLI::Util.analytics_screen_view('new_unit_test', opts)
+        PDK::CLI::Util.analytics_screen_view('new_test', opts)
 
         generator.new(module_dir, obj['name'], opts.merge(spec_only: true)).run
       rescue PDK::Util::PuppetStrings::NoObjectError

data/lib/pdk/cli/new/transport.rb

@@ -19,6 +19,8 @@ module PDK::CLI
         raise PDK::CLI::ExitWithError, _("'%{name}' is not a valid transport name") % { name: transport_name }
       end
 
+      require 'pdk/generate/transport'
+
       PDK::Generate::Transport.new(module_dir, transport_name, opts).run
     end
   end

data/lib/pdk/cli/test/unit.rb

@@ -1,6 +1,3 @@
-require 'pdk/cli/util/option_validator'
-require 'pdk/report'
-
 module PDK::CLI
   @test_unit_cmd = @test_cmd.define_command do
     name 'unit'
@@ -15,6 +12,7 @@ module PDK::CLI
     flag :c, 'clean-fixtures', _('Clean up downloaded fixtures after the test run.')
 
     option nil, :tests, _('Specify a comma-separated list of unit test files to run.'), argument: :required, default: '' do |values|
+      require 'pdk/cli/util/option_validator'
       PDK::CLI::Util::OptionValidator.comma_separated_list?(values)
     end
 
@@ -23,6 +21,8 @@ module PDK::CLI
 
     run do |opts, _args, _cmd|
       require 'pdk/tests/unit'
+      require 'pdk/report'
+      require 'pdk/util/bundler'
 
       PDK::CLI::Util.validate_puppet_version_opts(opts)
 
@@ -70,8 +70,10 @@ module PDK::CLI
 
         report = PDK::Report.new
         report_formats = if opts[:format]
+                           opts[:interactive] = false
                            PDK::CLI::Util::OptionNormalizer.report_formats(opts[:format])
                          else
+                           opts[:interactive] = true
                            [{
                              method: PDK::Report.default_format,
                              target: PDK::Report.default_target,

data/lib/pdk/cli/update.rb

@@ -1,6 +1,3 @@
-require 'pdk/cli/util'
-require 'pdk/util'
-
 module PDK::CLI
   @update_cmd = @base_cmd.define_command do
     name 'update'
@@ -13,6 +10,8 @@ module PDK::CLI
     PDK::CLI.template_ref_option(self)
 
     run do |opts, _args, _cmd|
+      require 'pdk/cli/util'
+      require 'pdk/util'
       require 'pdk/module/update'
 
       PDK::CLI::Util.ensure_in_module!(

data/lib/pdk/cli/util.rb

@@ -69,6 +69,8 @@ module PDK
       module_function :ci_environment?
 
       def interactive?
+        require 'pdk/logger'
+
         return false if PDK.logger.debug?
         return !ENV['PDK_FRONTEND'].casecmp('noninteractive').zero? if ENV['PDK_FRONTEND']
         return false if ci_environment?
@@ -103,10 +105,31 @@ module PDK
       end
       module_function :module_version_check
 
-      def puppet_from_opts_or_env(opts)
-        use_puppet_dev = (opts || {})[:'puppet-dev'] || ENV['PDK_PUPPET_DEV']
-        desired_puppet_version = (opts || {})[:'puppet-version'] || ENV['PDK_PUPPET_VERSION']
-        desired_pe_version = (opts || {})[:'pe-version'] || ENV['PDK_PE_VERSION']
+      def check_for_deprecated_puppet(version)
+        return unless version.is_a?(Gem::Version)
+
+        deprecated_below = Gem::Version.new('5.0.0')
+        return unless version < deprecated_below
+
+        deprecated_msg = _(
+          'Support for Puppet versions older than %{version} is ' \
+          'deprecated and will be removed in a future version of PDK.',
+        ) % { version: deprecated_below.to_s }
+        PDK.logger.warn(deprecated_msg)
+      end
+      module_function :check_for_deprecated_puppet
+
+      # @param opts [Hash] - the pdk options ot use, defaults to empty hash
+      # @option opts [String] :'puppet-dev' Use the puppet development version, default to PDK_PUPPET_DEV env
+      # @option opts [String] :'puppet-version' Puppet version to use, default to PDK_PUPPET_VERSION env
+      # @option opts [String] :'pe-version' PE Puppet version to use, default to PDK_PE_VERSION env
+      # @param logging_disabled [Boolean] - disable logging of PDK info
+      # @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'])
 
         begin
           puppet_env =
@@ -124,20 +147,26 @@ module PDK
         end
 
         # Notify user of what Ruby version will be used.
-        PDK.logger.info(_('Using Ruby %{version}') % {
-          version: puppet_env[:ruby_version],
-        })
+        unless logging_disabled
+          PDK.logger.info(_('Using Ruby %{version}') % {
+            version: puppet_env[:ruby_version],
+          })
+        end
+
+        check_for_deprecated_puppet(puppet_env[:gem_version])
 
         gemset = { puppet: puppet_env[:gem_version].to_s }
 
         # Notify user of what gems are being activated.
-        gemset.each do |gem, version|
-          next if version.nil?
-
-          PDK.logger.info(_('Using %{gem} %{version}') % {
-            gem: gem.to_s.capitalize,
-            version: version,
-          })
+        unless logging_disabled
+          gemset.each do |gem, version|
+            next if version.nil?
+
+            PDK.logger.info(_('Using %{gem} %{version}') % {
+              gem: gem.to_s.capitalize,
+              version: version,
+            })
+          end
         end
 
         {
@@ -221,6 +250,8 @@ module PDK
       module_function :validate_template_opts
 
       def analytics_screen_view(screen_name, opts = {})
+        require 'pdk/analytics'
+
         dimensions = {
           ruby_version: RUBY_VERSION,
         }

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

@@ -1,12 +1,12 @@
 require 'tty-spinner'
 
-require 'pdk/cli/util'
-
 # Replace the built-in tty check in tty-spinner with our own implementation
 # that allows us to mock the behaviour during acceptance tests.
 module TTY
   class Spinner
     def tty?
+      require 'pdk/cli/util'
+
       PDK::CLI::Util.interactive?
     end
   end

data/lib/pdk/cli/validate.rb

@@ -1,5 +1,3 @@
-require 'pdk/util/bundler'
-
 module PDK::CLI
   @validate_cmd = @base_cmd.define_command do
     name 'validate'
@@ -26,6 +24,8 @@ module PDK::CLI
         exit 0
       end
 
+      require 'pdk/validate'
+
       validator_names = PDK::Validate.validators.map { |v| v.name }
       validators = PDK::Validate.validators
       targets = []
@@ -101,10 +101,14 @@ module PDK::CLI
 
       options.merge!(puppet_env[:gemset])
 
+      require 'pdk/util/bundler'
+
       PDK::Util::Bundler.ensure_bundle!(puppet_env[:gemset])
 
       exit_code = 0
       if opts[:parallel]
+        require 'pdk/cli/exec_group'
+
         exec_group = PDK::CLI::ExecGroup.new(_('Validating module using %{num_of_threads} threads' % { num_of_threads: validators.count }), opts)
 
         validators.each do |validator|

data/lib/pdk/config.rb

@@ -1,9 +1,9 @@
 require 'pdk/config/errors'
-require 'pdk/config/json'
 require 'pdk/config/namespace'
-require 'pdk/config/validator'
-require 'pdk/config/value'
+require 'pdk/config/setting'
 require 'pdk/config/yaml'
+require 'pdk/config/yaml_with_schema'
+require 'pdk/config/json'
 
 module PDK
   def self.config
@@ -12,17 +12,16 @@ module PDK
 
   class Config
     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::YAML.new(file: PDK::Config.analytics_config_path, persistent_defaults: true) do
-          value :disabled do
-            validate PDK::Config::Validator.boolean
+        mount :analytics, PDK::Config::YAMLWithSchema.new(file: PDK::Config.analytics_config_path, persistent_defaults: true, schema_file: PDK::Config.json_schema('analytics')) do
+          setting :disabled do
             default_to { PDK::Config.bolt_analytics_config.fetch('disabled', true) }
           end
 
-          value 'user-id' do
-            validate PDK::Config::Validator.uuid
+          setting 'user-id' do
             default_to do
               require 'securerandom'
 
@@ -60,11 +59,22 @@ module PDK
       File.join(PDK::Util.configdir, 'user_config.json')
     end
 
+    def self.json_schemas_path
+      File.join(__dir__, 'config')
+    end
+
+    # return nil if not exist
+    def self.json_schema(name)
+      File.join(json_schemas_path, name + '_schema.json')
+    end
+
     def self.analytics_config_exist?
       PDK::Util::Filesystem.file?(analytics_config_path)
     end
 
     def self.analytics_config_interview!
+      require 'pdk/cli/util'
+
       return unless PDK::CLI::Util.interactive?
 
       pre_message = _(
@@ -90,6 +100,8 @@ module PDK
         },
       ]
 
+      require 'pdk/cli/util/interview'
+
       PDK.logger.info(text: pre_message, wrap: true)
       prompt = TTY::Prompt.new(help_color: :cyan)
       interview = PDK::CLI::Util::Interview.new(prompt)