pdk 1.13.0 → 1.14.0

data/lib/pdk/report.rb

@@ -1,7 +1,4 @@
-require 'rexml/document'
-require 'time'
 require 'pdk/report/event'
-require 'socket'
 
 module PDK
   class Report
@@ -48,6 +45,10 @@ module PDK
     # @param target [#write] an IO object that the report will be written to.
     #   Defaults to PDK::Report.default_target.
     def write_junit(target = self.class.default_target)
+      require 'rexml/document'
+      require 'time'
+      require 'socket'
+
       # Open a File Object for IO if target is a string containing a filename or path
       target = File.open(target, 'w') if target.is_a? String
 

data/lib/pdk/report/event.rb

@@ -1,6 +1,3 @@
-require 'rexml/document'
-require 'pathname'
-
 module PDK
   class Report
     class Event
@@ -132,6 +129,8 @@ module PDK
       #
       # @return [REXML::Element] The rendered event.
       def to_junit
+        require 'rexml/document'
+
         testcase = REXML::Element.new('testcase')
         testcase.attributes['classname'] = [source, test].compact.join('.')
         testcase.attributes['name'] = [file, line, column].compact.join(':')
@@ -195,6 +194,9 @@ module PDK
           raise ArgumentError, _('File must be a String.')
         end
 
+        require 'pathname'
+        require 'pdk/util'
+
         path = Pathname.new(value)
 
         if path.absolute?

data/lib/pdk/tests/unit.rb

@@ -1,8 +1,3 @@
-require 'pdk'
-require 'pdk/cli/exec'
-require 'pdk/util/bundler'
-require 'json'
-
 module PDK
   module Test
     class Unit
@@ -13,14 +8,23 @@ module PDK
       end
 
       def self.rake_bin
+        require 'pdk/util'
+
         @rake ||= File.join(PDK::Util.module_root, 'bin', 'rake')
       end
 
-      def self.rake(task, spinner_text, environment = {})
+      def self.cmd_with_args(task)
+        require 'pdk/util/ruby_version'
+
         argv = [rake_bin, task]
         argv.unshift(File.join(PDK::Util::RubyVersion.bin_path, 'ruby.exe')) if Gem.win_platform?
+        argv
+      end
 
-        command = PDK::CLI::Exec::Command.new(*argv).tap do |c|
+      def self.rake(task, spinner_text, environment = {})
+        require 'pdk/cli/exec/command'
+
+        command = PDK::CLI::Exec::Command.new(*cmd_with_args(task)).tap do |c|
           c.context = :module
           c.add_spinner(spinner_text) if spinner_text
           c.environment = environment
@@ -29,6 +33,19 @@ module PDK
         command.execute!
       end
 
+      def self.interactive_rake(task, environment)
+        require 'pdk/cli/exec/interactive_command'
+
+        command = PDK::CLI::Exec::InteractiveCommand.new(*cmd_with_args(task)).tap do |c|
+          c.context = :module
+          c.environment = environment.reject do |key, _|
+            key == 'CI_SPEC_OPTIONS'
+          end
+        end
+
+        command.execute!
+      end
+
       def self.parallel_with_no_tests?(ran_in_parallel, json_result, result)
         ran_in_parallel && json_result.empty? &&
           ((!result[:exit_code].zero? && result[:stderr].strip =~ %r{Pass files or folders to run$}) ||
@@ -64,6 +81,9 @@ module PDK
       end
 
       def self.invoke(report, options = {})
+        require 'pdk/util'
+        require 'pdk/util/bundler'
+
         PDK::Util::Bundler.ensure_binstubs!('rake', 'rspec-core')
 
         setup
@@ -73,6 +93,12 @@ module PDK
         environment = { 'CI_SPEC_OPTIONS' => '--format j' }
         environment['PUPPET_GEM_VERSION'] = options[:puppet] if options[:puppet]
         spinner_msg = options[:parallel] ? _('Running unit tests in parallel.') : _('Running unit tests.')
+
+        if options[:interactive]
+          result = interactive_rake(cmd(tests, options), environment)
+          return result[:exit_code]
+        end
+
         result = rake(cmd(tests, options), spinner_msg, environment)
 
         json_result = if options[:parallel]
@@ -184,6 +210,9 @@ module PDK
 
       # @return array of { :id, :full_description }
       def self.list(options = {})
+        require 'pdk/util'
+        require 'pdk/util/bundler'
+
         PDK::Util::Bundler.ensure_binstubs!('rake')
 
         environment = {}

data/lib/pdk/util.rb

@@ -1,12 +1,7 @@
-require 'tmpdir'
-require 'tempfile'
-
-require 'pdk/util/version'
+# PDK::Util::Windows can not be lazy loaded because it conditionally requires
+# other files on Windows only. This can probably be fixed up with a later
+# refactoring.
 require 'pdk/util/windows'
-require 'pdk/util/vendored_file'
-require 'pdk/util/filesystem'
-require 'pdk/util/template_uri'
-require 'pdk/util/puppet_strings'
 
 module PDK
   module Util
@@ -45,6 +40,8 @@ module PDK
     #
     # @return [String] The temporary directory path.
     def make_tmpdir_name(base)
+      require 'tmpdir'
+
       t = Time.now.strftime('%Y%m%d')
       name = "#{base}#{t}-#{Process.pid}-#{rand(0x100000000).to_s(36)}"
       File.join(Dir.tmpdir, name)
@@ -69,11 +66,15 @@ module PDK
     module_function :canonical_path
 
     def package_install?
+      require 'pdk/util/version'
+
       !PDK::Util::Version.version_file.nil?
     end
     module_function :package_install?
 
     def development_mode?
+      require 'pdk/util/version'
+
       (!PDK::Util::Version.git_ref.nil? || PDK::VERSION.end_with?('.pre'))
     end
     module_function :development_mode?
@@ -85,6 +86,7 @@ module PDK
 
     def pdk_package_basedir
       raise PDK::CLI::FatalError, _('Package basedir requested for non-package install.') unless package_install?
+      require 'pdk/util/version'
 
       File.dirname(PDK::Util::Version.version_file)
     end
@@ -132,6 +134,14 @@ module PDK
     end
     module_function :module_root
 
+    # The module's fixtures directory for spec testing
+    # @return [String] - the path to the module's fixtures directory
+    def module_fixtures_dir
+      dir = module_root
+      File.join(module_root, 'spec', 'fixtures') unless dir.nil?
+    end
+    module_function :module_fixtures_dir
+
     # Returns true or false depending on if any of the common directories in a module
     # are found in the current directory
     #
@@ -210,6 +220,8 @@ module PDK
 
     # TO-DO: Refactor replacement of lib/pdk/module/build.rb:metadata to use this function instead
     def module_metadata
+      require 'pdk/module/metadata'
+
       PDK::Module::Metadata.from_file(File.join(module_root, 'metadata.json')).data
     end
     module_function :module_metadata

data/lib/pdk/util/bundler.rb

@@ -1,15 +1,11 @@
-require 'bundler'
-require 'digest'
-require 'fileutils'
-require 'pdk/util'
-require 'pdk/cli/exec'
-
 module PDK
   module Util
     module Bundler
       class BundleHelper; end
 
       def self.ensure_bundle!(gem_overrides = nil)
+        require 'fileutils'
+
         bundle = BundleHelper.new
 
         # This will default ensure_bundle! to re-resolving everything to latest
@@ -70,6 +66,8 @@ module PDK
       end
 
       def self.bundle_cache_key(gemfile, gem_overrides)
+        require 'digest'
+
         override_sig = (gem_overrides || {}).sort_by { |gem, _| gem.to_s }.to_s
         Digest::MD5.hexdigest(gemfile.to_s + override_sig)
       end
@@ -77,6 +75,7 @@ module PDK
 
       class BundleHelper
         def gemfile
+          require 'pdk/util'
           @gemfile ||= PDK::Util.find_upwards('Gemfile')
         end
 
@@ -108,6 +107,10 @@ module PDK
         end
 
         def lock!
+          require 'pdk/util'
+          require 'fileutils'
+          require 'pdk/util/ruby_version'
+
           if PDK::Util.package_install?
             # In packaged installs, use vendored Gemfile.lock as a starting point.
             # Subsequent 'bundle install' will still pick up any new dependencies.
@@ -185,6 +188,8 @@ module PDK
         end
 
         def install!(gem_overrides = {})
+          require 'pdk/util/ruby_version'
+
           argv = ['install', "--gemfile=#{gemfile}"]
           argv << '-j4' unless Gem.win_platform? && Gem::Version.new(PDK::Util::RubyVersion.active_ruby_version) < Gem::Version.new('2.3.5')
 
@@ -239,6 +244,9 @@ module PDK
         end
 
         def bundle_command(*args)
+          require 'pdk/cli/exec'
+          require 'pdk/cli/exec/command'
+
           PDK::CLI::Exec::Command.new(PDK::CLI::Exec.bundle_bin, *args).tap do |c|
             c.context = :module
           end

data/lib/pdk/util/filesystem.rb

@@ -64,6 +64,11 @@ module PDK
         File.exist?(*args)
       end
       module_function :exist?
+
+      def rm(*args)
+        FileUtils.rm(*args)
+      end
+      module_function :rm
       #:nocov:
     end
   end

data/lib/pdk/util/git.rb

@@ -36,6 +36,8 @@ module PDK
       end
 
       def self.git_bin
+        require 'pdk/cli/exec'
+
         git_bin = Gem.win_platform? ? 'git.exe' : 'git'
         vendored_bin_path = File.join(git_bindir, git_bin)
 
@@ -43,12 +45,16 @@ module PDK
       end
 
       def self.git(*args)
+        require 'pdk/cli/exec'
+
         PDK::CLI::Exec.ensure_bin_present!(git_bin, 'git')
 
         PDK::CLI::Exec.execute(git_bin, *args)
       end
 
       def self.git_with_env(env, *args)
+        require 'pdk/cli/exec'
+
         PDK::CLI::Exec.ensure_bin_present!(git_bin, 'git')
 
         PDK::CLI::Exec.execute_with_env(env, git_bin, *args)

data/lib/pdk/util/puppet_strings.rb

@@ -1,5 +1,3 @@
-require 'pdk/cli/exec'
-
 module PDK
   module Util
     module PuppetStrings
@@ -13,6 +11,8 @@ module PDK
       #
       # @return [Hash{Symbol=>Object}] the result of the command execution.
       def self.puppet(*args)
+        require 'pdk/cli/exec/command'
+
         PDK::Util::Bundler.ensure_binstubs!('puppet')
 
         argv = [File.join(PDK::Util.module_root, 'bin', 'puppet')] + args
@@ -80,6 +80,26 @@ module PDK
         [generator, known_objects[object_type].find { |obj| object_names.include?(obj['name']) }]
       end
 
+      # Generate a list of all objects that PDK has a generator for.
+      #
+      # @returns [Array[Array[PDK::Generate::PuppetObject,
+      #   Array[Hash{String=>Object}]]]] an associative array where the first
+      #   element of each pair is the generator class and the second element of
+      #   each pair is an array of description hashes from puppet-strings.
+      def self.all_objects
+        require 'pdk/generate'
+
+        generators = PDK::Generate::GENERATORS.select do |gen|
+          gen.respond_to?(: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|
+          obj.nil? || obj.empty?
+        end
+      end
+
       # Evaluates the mapping of puppet-strings object type to PDK generator
       # class.
       #
@@ -92,6 +112,8 @@ module PDK
       #   PDK::Util::PuppetStrings.find_generator('puppet_classes')
       #   => PDK::Generate::PuppetClass
       def self.find_generator(type)
+        require 'pdk/generate'
+
         PDK::Generate::GENERATORS.find do |gen|
           gen.respond_to?(:puppet_strings_type) && gen.puppet_strings_type == type
         end

data/lib/pdk/util/puppet_version.rb

@@ -1,6 +1,3 @@
-require 'pdk/util'
-require 'pdk/util/git'
-
 module PDK
   module Util
     class PuppetVersion
@@ -21,6 +18,8 @@ module PDK
       DEFAULT_PUPPET_DEV_BRANCH = 'master'.freeze
 
       def puppet_dev_env
+        require 'pdk/util/ruby_version'
+
         {
           gem_version: 'file://%{path}' % { path: puppet_dev_path },
           ruby_version: PDK::Util::RubyVersion.latest_ruby_version,
@@ -28,6 +27,8 @@ module PDK
       end
 
       def puppet_dev_path
+        require 'pdk/util'
+
         File.join(PDK::Util.cachedir, 'src', 'puppet')
       end
 
@@ -42,6 +43,9 @@ module PDK
       end
 
       def fetch_puppet_dev
+        require 'pdk/util/git'
+        require 'fileutils'
+
         # Check if the source is cloned and is a readable git repo
         unless PDK::Util::Git.remote_repo? puppet_dev_path
           # Check if the path has something in it already. Delete it and prepare for clone if so.
@@ -133,6 +137,9 @@ module PDK
       end
 
       def from_module_metadata(metadata = nil)
+        require 'pdk/module/metadata'
+        require 'pdk/util'
+
         if metadata.nil?
           metadata_file = PDK::Util.find_upwards('metadata.json')
 
@@ -191,6 +198,8 @@ module PDK
       end
 
       def fetch_pe_version_map
+        require 'pdk/util/vendored_file'
+
         map = PDK::Util::VendoredFile.new('pe_versions.json', PE_VERSIONS_URL).read
 
         JSON.parse(map)
@@ -205,17 +214,19 @@ module PDK
       end
 
       def rubygems_puppet_versions
-        return @rubygems_puppet_versions unless @rubygems_puppet_versions.nil?
-
-        fetcher = Gem::SpecFetcher.fetcher
-        puppet_tuples = fetcher.detect(:released) do |spec_tuple|
-          spec_tuple.name == 'puppet' && Gem::Platform.match(spec_tuple.platform)
+        @rubygems_puppet_versions ||= begin
+          fetcher = Gem::SpecFetcher.fetcher
+          puppet_tuples = fetcher.detect(:released) do |spec_tuple|
+            spec_tuple.name == 'puppet' && Gem::Platform.match(spec_tuple.platform)
+          end
+          puppet_versions = puppet_tuples.map { |name, _| name.version }.uniq
+          puppet_versions.sort { |a, b| b <=> a }
         end
-        puppet_versions = puppet_tuples.map { |name, _| name.version }.uniq
-        @rubygems_puppet_versions = puppet_versions.sort { |a, b| b <=> a }
       end
 
       def find_gem(requirement)
+        require 'pdk/util'
+
         if PDK::Util.package_install?
           find_in_package_cache(requirement)
         else
@@ -224,11 +235,15 @@ module PDK
       end
 
       def find_in_rubygems(requirement)
+        require 'pdk/util/ruby_version'
+
         version = rubygems_puppet_versions.find { |r| requirement.satisfied_by?(r) }
         version.nil? ? nil : { gem_version: version, ruby_version: PDK::Util::RubyVersion.default_ruby_version }
       end
 
       def find_in_package_cache(requirement)
+        require 'pdk/util/ruby_version'
+
         PDK::Util::RubyVersion.versions.each do |ruby_version, _|
           PDK::Util::RubyVersion.use(ruby_version)
           version = PDK::Util::RubyVersion.available_puppet_versions.find { |r| requirement.satisfied_by?(r) }

data/lib/pdk/util/ruby_version.rb

@@ -1,4 +1,3 @@
-require 'pdk/util'
 require 'forwardable'
 
 module PDK
@@ -41,6 +40,8 @@ module PDK
         end
 
         def scan_for_packaged_rubies
+          require 'pdk/util'
+
           ruby_basedir = File.join(PDK::Util.pdk_package_basedir, 'private', 'ruby', '*')
           Dir[ruby_basedir].sort.map { |ruby_dir|
             version = File.basename(ruby_dir)
@@ -49,6 +50,9 @@ module PDK
         end
 
         def default_ruby_version
+          require 'pdk/util'
+          require 'pdk/util/puppet_version'
+
           @default_ruby_version ||= if PDK::Util.package_install?
                                       # Default to the ruby that supports the latest puppet gem. If you wish to default to a
                                       # specific Puppet Gem version use the following example;
@@ -69,6 +73,8 @@ module PDK
         end
 
         def versions
+          require 'pdk/util'
+
           @versions ||= if PDK::Util.package_install?
                           scan_for_packaged_rubies
                         else
@@ -84,6 +90,8 @@ module PDK
       end
 
       def bin_path
+        require 'pdk/util'
+
         if PDK::Util.package_install?
           File.join(PDK::Util.pdk_package_basedir, 'private', 'ruby', ruby_version, 'bin')
         else
@@ -92,6 +100,8 @@ module PDK
       end
 
       def gem_paths_raw
+        require 'pdk/util'
+
         if PDK::Util.package_install?
           # Subprocesses use their own set of gems which are managed by pdk or
           # installed with the package. We also include the separate gem path
@@ -115,6 +125,8 @@ module PDK
       end
 
       def gem_home
+        require 'pdk/util'
+
         # `bundle install --path` ignores all "system" installed gems and
         # causes unnecessary package installs. `bundle install` (without
         # --path) installs into GEM_HOME, which by default is non-user