pdk 1.14.0 → 1.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b164195fde06a45412e475f2afc5916a45208da08c90841dd30b9b01808ca6f
-  data.tar.gz: e449e823329c01f0542da0c7a864e91019a9dad86054083c62f7f2bdf67488e6
+  metadata.gz: fa7118858cde5b6a4ea492a22683a8a077386d31e00157469186a373f91d8559
+  data.tar.gz: 4feab9cf89fd58a0c4023d04905efaccb56021dc7f44d0110b332de0fd1c7781
 SHA512:
-  metadata.gz: 76b3ccf9f3b8d4ab51784f9690d44b0faf165af9a7b6df9ebee00d4a2c612050bf29a69b413163177d330ad2bf354a34437c9b870506c8e32a67d26e0d24e220
-  data.tar.gz: 78816fe4269f30053ac201c8eb8bb86be89cc0dc2440e4fa3c9c13312417621a843a8751b4b009ab33b699b835471f012ec18b5e7ba1723566301c1d8ada054e
+  metadata.gz: 63e8e385a5f17a12dd36d3d6938ee601e0020b0e8b55603ec409d111cd0add4f5b748c1cc493b7612d02381d1832d56ab7de7c933ab85c9773eee463e9c60dc9
+  data.tar.gz: 33063bc92b0d8678cf2ac33333e23a1c3ca2d51bfece32eb326376f8681334e8b9574cf9a9df9c19da931248afc88197c0367e4659a81df9b96fca3ab6ba74fa

data/CHANGELOG.md

@@ -4,6 +4,37 @@ All changes to this repo will be documented in this file.
 See the [release notes](https://puppet.com/docs/pdk/latest/release_notes.html) for a high-level summary.
 
 
+## [v1.14.1](https://github.com/puppetlabs/pdk/tree/v1.14.1) (2019-11-01)
+[Full Changelog](https://github.com/puppetlabs/pdk/compare/v1.14.0...v1.14.1)
+
+**Fixed bugs:**
+
+- "pdk validate" fails with "uninitialized constant PDK::VERSION \(NameError\)" [\#786](https://github.com/puppetlabs/pdk/issues/786)
+- Networking facts missing for RHEL7 and facter 2.x [\#776](https://github.com/puppetlabs/pdk/issues/776)
+- 'pdk test unit --verbose' does not change the rspec output format [\#773](https://github.com/puppetlabs/pdk/issues/773)
+- rake build gives error NoMethodError: undefined method `package\_install?' for PDK::Util:Module [\#770](https://github.com/puppetlabs/pdk/issues/770)
+- PDK::Util.in\_module\_root? can give a false positive result [\#768](https://github.com/puppetlabs/pdk/issues/768)
+- pdk console --puppet-dev does not grab latest Puppet source [\#764](https://github.com/puppetlabs/pdk/issues/764)
+- \(PDK-1527\) Handle pdk new module --skip-interview without module name [\#788](https://github.com/puppetlabs/pdk/pull/788) ([rodjek](https://github.com/rodjek))
+
+**Merged pull requests:**
+
+- \(maint\) Raise error when template content is empty or nil [\#794](https://github.com/puppetlabs/pdk/pull/794) ([rodjek](https://github.com/rodjek))
+- \(PDK-1530\) Disable schema validation of config files [\#793](https://github.com/puppetlabs/pdk/pull/793) ([glennsarti](https://github.com/glennsarti))
+- \(\#764\) Ensure --puppet-dev checkout is always updated [\#792](https://github.com/puppetlabs/pdk/pull/792) ([rodjek](https://github.com/rodjek))
+- \(\#773\) Respect --verbose in interactive pdk test unit [\#791](https://github.com/puppetlabs/pdk/pull/791) ([rodjek](https://github.com/rodjek))
+- \(PDK-1443\) Windows safe Tempfiles & environment variable access [\#790](https://github.com/puppetlabs/pdk/pull/790) ([rodjek](https://github.com/rodjek))
+- \(maint\) Use same rspec pattern in acceptance suite [\#789](https://github.com/puppetlabs/pdk/pull/789) ([glennsarti](https://github.com/glennsarti))
+- \(PDK-1519\) Print deprecation notice on Ruby \< 2.4 [\#785](https://github.com/puppetlabs/pdk/pull/785) ([rodjek](https://github.com/rodjek))
+- \(maint\) Setup autoloads for TTY::Prompt [\#784](https://github.com/puppetlabs/pdk/pull/784) ([rtib](https://github.com/rtib))
+- \(GH-768\) Fix in\_module\_root? gives false positives [\#783](https://github.com/puppetlabs/pdk/pull/783) ([glennsarti](https://github.com/glennsarti))
+- \(maint\) Run acceptance:local tests in parallel during CI [\#781](https://github.com/puppetlabs/pdk/pull/781) ([rodjek](https://github.com/rodjek))
+- \(MAINT\) Fix new provider error message [\#780](https://github.com/puppetlabs/pdk/pull/780) ([michaeltlombardi](https://github.com/michaeltlombardi))
+- \(PDK-1525\) Use less restrictive minitar version [\#779](https://github.com/puppetlabs/pdk/pull/779) ([glennsarti](https://github.com/glennsarti))
+- \(maint\) PDK as a library [\#778](https://github.com/puppetlabs/pdk/pull/778) ([rodjek](https://github.com/rodjek))
+- \(PDK-1517\) Bump version to 1.15.0.pre [\#772](https://github.com/puppetlabs/pdk/pull/772) ([scotje](https://github.com/scotje))
+- \(\#770\) Add missing require to PDK::Module::Metadata.from\_file [\#771](https://github.com/puppetlabs/pdk/pull/771) ([hajee](https://github.com/hajee))
+
 ## [v1.14.0](https://github.com/puppetlabs/pdk/tree/v1.14.0) (2019-10-09)
 [Full Changelog](https://github.com/puppetlabs/pdk/compare/v1.13.0...v1.14.0)
 

data/lib/pdk.rb

@@ -1,12 +1,67 @@
-require 'pdk/analytics'
-require 'pdk/answer_file'
-require 'pdk/config'
-require 'pdk/generate'
 require 'pdk/i18n'
-require 'pdk/logger'
-require 'pdk/report'
-require 'pdk/validate'
-require 'pdk/version'
 
 module PDK
+  autoload :Analytics, 'pdk/analytics'
+  autoload :AnswerFile, 'pdk/answer_file'
+  autoload :Config, 'pdk/config'
+  autoload :Generate, 'pdk/generate'
+  autoload :Logger, 'pdk/logger'
+  autoload :Module, 'pdk/module'
+  autoload :Report, 'pdk/report'
+  autoload :TemplateFile, 'pdk/template_file'
+  autoload :TEMPLATE_REF, 'pdk/version'
+  autoload :Util, 'pdk/util'
+  autoload :Validate, 'pdk/validate'
+  autoload :VERSION, 'pdk/version'
+
+  # TODO: Refactor backend code to not raise CLI errors or use CLI util
+  #       methods.
+  module CLI
+    autoload :ExitWithError, 'pdk/cli/errors'
+    autoload :FatalError, 'pdk/cli/errors'
+    autoload :Util, 'pdk/cli/util'
+    autoload :Exec, 'pdk/cli/exec'
+    autoload :ExecGroup, 'pdk/cli/exec_group'
+  end
+
+  module Test
+    autoload :Unit, 'pdk/tests/unit'
+  end
+
+  # Singleton accessor to the current answer file being used by the PDK.
+  #
+  # @return [PDK::AnswerFile] The AnswerFile instance currently being used by
+  #   the PDK.
+  def self.answers
+    @answer_file ||= PDK::AnswerFile.new
+  end
+
+  # Specify the path to a custom answer file that the PDK should use.
+  #
+  # @param path [String] A path on disk to the file where the PDK should store
+  #   answers to interactive questions.
+  def self.answer_file=(path)
+    @answer_file = PDK::AnswerFile.new(path)
+  end
+
+  def self.logger
+    @logger ||= PDK::Logger.new
+  end
+
+  def self.config
+    @config ||= PDK::Config.new
+  end
+
+  def self.analytics
+    @analytics ||= PDK::Analytics.build_client(
+      logger:        PDK.logger,
+      disabled:      PDK::Util::Env['PDK_DISABLE_ANALYTICS'] || PDK.config.user['analytics']['disabled'],
+      user_id:       PDK.config.user['analytics']['user-id'],
+      app_id:        "UA-139917834-#{PDK::Util.development_mode? ? '2' : '1'}",
+      client:        :google_analytics,
+      app_name:      'pdk',
+      app_version:   PDK::VERSION,
+      app_installer: PDK::Util.package_install? ? 'package' : 'gem',
+    )
+  end
 end

data/lib/pdk/analytics.rb

@@ -1,30 +1,15 @@
-require 'pdk/analytics/client/google_analytics'
-require 'pdk/analytics/client/noop'
+require 'pdk'
 
-module PDK
-  def self.analytics
-    require 'pdk/config'
-    require 'pdk/logger'
-    require 'pdk/util'
-    require 'pdk/version'
-
-    @analytics ||= PDK::Analytics.build_client(
-      logger:        PDK.logger,
-      disabled:      ENV['PDK_DISABLE_ANALYTICS'] || PDK.config.user['analytics']['disabled'],
-      user_id:       PDK.config.user['analytics']['user-id'],
-      app_id:        "UA-139917834-#{PDK::Util.development_mode? ? '2' : '1'}",
-      client:        :google_analytics,
-      app_name:      'pdk',
-      app_version:   PDK::VERSION,
-      app_installer: PDK::Util.package_install? ? 'package' : 'gem',
-    )
-  end
+autoload :Logger, 'logger'
 
+module PDK
   module Analytics
-    CLIENTS = {
-      noop:             Client::Noop,
-      google_analytics: Client::GoogleAnalytics,
-    }.freeze
+    autoload :Util, 'pdk/analytics/util'
+
+    module Client
+      autoload :Noop, 'pdk/analytics/client/noop'
+      autoload :GoogleAnalytics, 'pdk/analytics/client/google_analytics'
+    end
 
     def self.build_client(opts = {})
       opts[:logger] ||= ::Logger.new(STDERR)
@@ -32,13 +17,14 @@ module PDK
 
       if opts[:disabled]
         opts[:logger].debug 'Analytics opt-out is set, analytics will be disabled'
-        CLIENTS[:noop].new(opts)
-      else
-        CLIENTS[opts[:client]].new(opts)
+        opts[:client] = :noop
       end
+
+      client_const = opts[:client].to_s.split('_').map(&:capitalize).join
+      PDK::Analytics::Client.const_get(client_const).new(opts)
     rescue StandardError => e
       opts[:logger].debug "Failed to initialize analytics client, analytics will be disabled: #{e}"
-      CLIENTS[:noop].new(opts)
+      PDK::Analytics::Client::Noop.new(opts)
     end
   end
 end

data/lib/pdk/analytics/client/google_analytics.rb

@@ -1,3 +1,5 @@
+require 'pdk'
+
 module PDK
   module Analytics
     module Client

data/lib/pdk/analytics/client/noop.rb

@@ -1,3 +1,5 @@
+require 'pdk'
+
 module PDK
   module Analytics
     module Client

data/lib/pdk/analytics/util.rb

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

data/lib/pdk/answer_file.rb

@@ -1,22 +1,7 @@
-require 'pdk/util/filesystem'
+require 'pdk'
+autoload :JSON, 'json'
 
 module PDK
-  # Singleton accessor to the current answer file being used by the PDK.
-  #
-  # @return [PDK::AnswerFile] The AnswerFile instance currently being used by
-  #   the PDK.
-  def self.answers
-    @answer_file ||= PDK::AnswerFile.new
-  end
-
-  # Specify the path to a custom answer file that the PDK should use.
-  #
-  # @param path [String] A path on disk to the file where the PDK should store
-  #   answers to interactive questions.
-  def self.answer_file=(path)
-    @answer_file = PDK::AnswerFile.new(path)
-  end
-
   class AnswerFile
     attr_reader :answers
     attr_reader :answer_file_path
@@ -79,8 +64,6 @@ module PDK
     #
     # @return [Hash{String => Object}] The existing questions and answers.
     def read_from_disk
-      require 'json'
-
       return {} if !File.file?(answer_file_path) || File.zero?(answer_file_path)
 
       unless File.readable?(answer_file_path)
@@ -109,8 +92,6 @@ module PDK
     #
     # @raise [PDK::CLI::FatalError] if the answer file can not be written to.
     def save_to_disk
-      require 'json'
-
       FileUtils.mkdir_p(File.dirname(answer_file_path))
 
       write_file(answer_file_path, JSON.pretty_generate(answers))

data/lib/pdk/cli.rb

@@ -1,18 +1,12 @@
 require 'cri'
 
-require 'pdk/analytics'
+require 'pdk'
 require 'pdk/cli/errors'
-require 'pdk/cli/util'
-require 'pdk/cli/util/command_redirector'
-require 'pdk/cli/util/option_normalizer'
-require 'pdk/cli/util/option_validator'
-require 'pdk/config'
-require 'pdk/i18n'
-require 'pdk/logger'
-require 'pdk/report'
-require 'pdk/util/version'
-require 'pdk/util/puppet_version'
-require 'pdk/util/filesystem'
+
+module TTY
+  autoload :Prompt, 'tty/prompt'
+  autoload :TestPrompt, 'tty/test_prompt'
+end
 
 class Cri::Command::CriExitException
   def initialize(is_error:)
@@ -22,6 +16,8 @@ class Cri::Command::CriExitException
 end
 
 module PDK::CLI
+  autoload :Util, 'pdk/cli/util'
+
   # Attempt to anonymise the raw ARGV array if the command parsing failed.
   #
   # If an item does not start with '-' but is preceeded by an item that does
@@ -50,9 +46,25 @@ module PDK::CLI
     end
   end
 
+  def self.deprecated_runtime?
+    Gem::Version.new(RbConfig::CONFIG['ruby_version']) < Gem::Version.new('2.4.0')
+  end
+
   def self.run(args)
+    if deprecated_runtime?
+      PDK.logger.info(
+        text: _(
+          'Support for Ruby versions older than 2.4 will be dropped in the ' \
+          'future PDK 2.0.0 release. We recommend updating your Ruby ' \
+          'installation to ensure that you can continue using the latest ' \
+          'version of PDK.',
+        ),
+        wrap: true,
+      )
+    end
+
     @args = args
-    PDK::Config.analytics_config_interview! unless ENV['PDK_DISABLE_ANALYTICS'] || PDK::Config.analytics_config_exist?
+    PDK::Config.analytics_config_interview! unless PDK::Util::Env['PDK_DISABLE_ANALYTICS'] || PDK::Config.analytics_config_exist?
     @base_cmd.run(args)
   rescue PDK::CLI::ExitWithError => e
     PDK.logger.send(e.log_level, e.message)

data/lib/pdk/cli/errors.rb

@@ -1,3 +1,5 @@
+require 'pdk'
+
 module PDK
   module CLI
     class FatalError < StandardError

data/lib/pdk/cli/exec.rb

@@ -1,6 +1,11 @@
+require 'pdk'
+
 module PDK
   module CLI
     module Exec
+      autoload :Command, 'pdk/cli/exec/command'
+      autoload :InteractiveCommand, 'pdk/cli/exec/interactive_command'
+
       def self.execute(*cmd)
         require 'pdk/cli/exec/command'
 

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

@@ -1,3 +1,5 @@
+require 'pdk'
+
 module PDK
   module CLI
     module Exec
@@ -8,6 +10,8 @@ module PDK
         attr_accessor :environment
         attr_writer :exec_group
 
+        TEMPFILE_MODE = File::RDWR | File::BINARY | File::CREAT | File::TRUNC
+
         def initialize(*argv)
           require 'childprocess'
           require 'tempfile'
@@ -17,8 +21,8 @@ module PDK
           @process = ChildProcess.build(*@argv)
           @process.leader = true
 
-          @stdout = Tempfile.new('stdout').tap { |io| io.sync = true }
-          @stderr = Tempfile.new('stderr').tap { |io| io.sync = true }
+          @stdout = Tempfile.new('stdout', mode: TEMPFILE_MODE).tap { |io| io.sync = true }
+          @stderr = Tempfile.new('stderr', mode: TEMPFILE_MODE).tap { |io| io.sync = true }
 
           @process.io.stdout = @stdout
           @process.io.stderr = @stderr
@@ -124,7 +128,7 @@ module PDK
         protected
 
         def warn_on_legacy_env_vars!
-          if ENV['PUPPET_GEM_VERSION']
+          if PDK::Util::Env['PUPPET_GEM_VERSION']
             PDK.logger.warn_once _(
               'PUPPET_GEM_VERSION is not supported by PDK. ' \
               'Use the --puppet-version option on your PDK command ' \
@@ -133,7 +137,7 @@ module PDK
           end
 
           %w[FACTER HIERA].each do |gem|
-            if ENV["#{gem}_GEM_VERSION"]
+            if PDK::Util::Env["#{gem}_GEM_VERSION"]
               PDK.logger.warn_once _('%{varname} is not supported by PDK.') % { varname: "#{gem}_GEM_VERSION" }
             end
           end
@@ -144,7 +148,7 @@ module PDK
 
           resolved_env = {}
 
-          resolved_env['TERM'] = ENV['TERM']
+          resolved_env['TERM'] = PDK::Util::Env['TERM']
           resolved_env['PUPPET_GEM_VERSION'] = nil
           resolved_env['FACTER_GEM_VERSION'] = nil
           resolved_env['HIERA_GEM_VERSION'] = nil
@@ -170,7 +174,7 @@ module PDK
               PDK::Util::RubyVersion.gem_paths_raw.map { |gem_path| File.join(gem_path, 'bin') },
               package_binpath,
               PDK::Util.package_install? ? PDK::Util::Git.git_paths : nil,
-              ENV['PATH'],
+              PDK::Util::Env['PATH'],
             ].compact.flatten.join(File::PATH_SEPARATOR)
           end
 

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

@@ -1,4 +1,4 @@
-require 'pdk/cli/exec/command'
+require 'pdk'
 
 module PDK
   module CLI

data/lib/pdk/cli/exec_group.rb

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

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

@@ -10,7 +10,7 @@ module PDK::CLI
 
     run do |opts, args, _cmd|
       require 'pdk/generate/module'
-      require 'tty-prompt'
+      require 'tty/prompt'
 
       module_name = args[0]
 

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

@@ -28,7 +28,14 @@ module PDK::CLI
         opts[:'full-interview'] = false
       end
 
-      unless module_name.nil? || module_name.empty?
+      if module_name.nil? || module_name.empty?
+        if opts[:'skip-interview']
+          raise PDK::CLI::ExitWithError, _(
+            'You must specify a module name on the command line when running ' \
+            'with --skip-interview.',
+          )
+        end
+      else
         module_name_parts = module_name.split('-', 2)
         if module_name_parts.size > 1
           opts[:username] = module_name_parts[0]

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

@@ -33,7 +33,6 @@ module PDK::CLI
       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])
       PDK::Util::Bundler.ensure_bundle!(puppet_env[:gemset])
 

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

@@ -37,7 +37,6 @@ module PDK::CLI
 
       # Ensure that the bundled gems are up to date and correct Ruby is activated before running or listing tests.
       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])
 
       opts.merge!(puppet_env[:gemset])
@@ -66,8 +65,6 @@ module PDK::CLI
           end
         end
       else
-        PDK.logger.info _('--verbose has no effect when not used with --list') if opts[:verbose]
-
         report = PDK::Report.new
         report_formats = if opts[:format]
                            opts[:interactive] = false