pdk 1.13.0 → 1.14.0

data/lib/pdk/module.rb

@@ -1,5 +1,3 @@
-require 'pathspec'
-
 module PDK
   module Module
     DEFAULT_IGNORED = [
@@ -13,6 +11,8 @@ module PDK
     ].freeze
 
     def default_ignored_pathspec(ignore_dotfiles = true)
+      require 'pathspec'
+
       PathSpec.new(DEFAULT_IGNORED).tap do |ps|
         ps.add('.*') if ignore_dotfiles
       end

data/lib/pdk/module/build.rb

@@ -1,11 +1,3 @@
-require 'fileutils'
-require 'minitar'
-require 'zlib'
-require 'pathspec'
-require 'find'
-require 'pdk/module'
-require 'pdk/tests/unit'
-
 module PDK
   module Module
     class Build
@@ -26,6 +18,8 @@ module PDK
       #
       # @return [Hash{String => Object}] The hash of metadata values.
       def metadata
+        require 'pdk/module/metadata'
+
         @metadata ||= PDK::Module::Metadata.from_file(File.join(module_dir, 'metadata.json')).data
       end
 
@@ -71,6 +65,8 @@ module PDK
       #
       # If the directory already exists, remove it first.
       def create_build_dir
+        require 'fileutils'
+
         cleanup_build_dir
 
         FileUtils.mkdir_p(build_dir)
@@ -80,6 +76,8 @@ module PDK
       #
       # @return nil.
       def cleanup_build_dir
+        require 'fileutils'
+
         FileUtils.rm_rf(build_dir, secure: true)
       end
 
@@ -99,6 +97,8 @@ module PDK
       #
       # @return nil
       def stage_module_in_build_dir
+        require 'find'
+
         Find.find(module_dir) do |path|
           next if path == module_dir
 
@@ -112,6 +112,9 @@ module PDK
       #
       # @return nil.
       def stage_path(path)
+        require 'pathname'
+        require 'fileutils'
+
         relative_path = Pathname.new(path).relative_path_from(Pathname.new(module_dir))
         dest_path = File.join(build_dir, relative_path)
 
@@ -149,6 +152,8 @@ module PDK
       #
       # @return nil.
       def warn_symlink(path)
+        require 'pathname'
+
         symlink_path = Pathname.new(path)
         module_path = Pathname.new(module_dir)
 
@@ -217,6 +222,11 @@ module PDK
       #
       # @return nil.
       def build_package
+        require 'fileutils'
+        require 'zlib'
+        require 'minitar'
+        require 'find'
+
         FileUtils.rm_f(package_file)
 
         Dir.chdir(target_dir) do
@@ -268,6 +278,9 @@ module PDK
       #
       # @return [PathSpec] The populated ignore path matcher.
       def ignored_files
+        require 'pdk/module'
+        require 'pathspec'
+
         @ignored_files ||=
           begin
             ignored = if ignore_file.nil?

data/lib/pdk/module/convert.rb

@@ -1,8 +1,3 @@
-require 'pdk/generate/module'
-require 'pdk/module/update_manager'
-require 'pdk/util'
-require 'pdk/report'
-
 module PDK
   module Module
     class Convert
@@ -24,7 +19,14 @@ module PDK
         stage_changes!
 
         unless update_manager.changes?
-          PDK::Report.default_target.puts(_('No changes required.'))
+          if adding_tests?
+            add_tests!
+          else
+            require 'pdk/report'
+
+            PDK::Report.default_target.puts(_('No changes required.'))
+          end
+
           return
         end
 
@@ -35,6 +37,8 @@ module PDK
         return if noop?
 
         unless force?
+          require 'pdk/cli/util'
+
           PDK.logger.info _(
             'Module conversion is a potentially destructive action. ' \
             'Ensure that you have committed your module to a version control ' \
@@ -52,7 +56,12 @@ module PDK
 
         update_manager.sync_changes!
 
-        PDK::Util::Bundler.ensure_bundle! if needs_bundle_update?
+        if needs_bundle_update?
+          require 'pdk/util/bundler'
+          PDK::Util::Bundler.ensure_bundle!
+        end
+
+        add_tests! if adding_tests?
 
         print_result 'Convert completed'
       end
@@ -65,11 +74,45 @@ module PDK
         options[:force]
       end
 
+      def add_tests?
+        options[:'add-tests']
+      end
+
+      def adding_tests?
+        add_tests? && missing_tests?
+      end
+
+      def missing_tests?
+        test_generators.any? { |gen| gen.can_run? }
+      end
+
+      def test_generators
+        return @test_generators unless @test_generators.nil?
+        require 'pdk/util/puppet_strings'
+
+        test_gens = PDK::Util::PuppetStrings.all_objects.map do |generator, objects|
+          (objects || []).map do |obj|
+            generator.new(Dir.pwd, obj['name'], spec_only: true)
+          end
+        end
+
+        @test_generators = test_gens.flatten
+      end
+
+      def add_tests!
+        test_generators.each do |gen|
+          gen.run if gen.can_run?
+        end
+      end
+
       def needs_bundle_update?
         update_manager.changed?('Gemfile')
       end
 
       def stage_changes!
+        require 'pdk/module/templatedir'
+        require 'pdk/util/filesystem'
+
         metadata_path = 'metadata.json'
 
         PDK::Module::TemplateDir.new(template_uri, nil, true) do |templates|
@@ -108,14 +151,22 @@ module PDK
       end
 
       def update_manager
+        require 'pdk/module/update_manager'
+
         @update_manager ||= PDK::Module::UpdateManager.new
       end
 
       def template_uri
+        require 'pdk/util/template_uri'
+
         @template_uri ||= PDK::Util::TemplateURI.new(options)
       end
 
       def update_metadata(metadata_path, template_metadata)
+        require 'pdk/generate/module'
+        require 'pdk/util/filesystem'
+        require 'pdk/module/metadata'
+
         if PDK::Util::Filesystem.file?(metadata_path)
           unless PDK::Util::Filesystem.readable?(metadata_path)
             raise PDK::CLI::ExitWithError, _('Unable to update module metadata; %{path} exists but it is not readable.') % {
@@ -172,6 +223,8 @@ module PDK
       end
 
       def print_summary
+        require 'pdk/report'
+
         footer = false
 
         summary.keys.each do |category|
@@ -186,12 +239,16 @@ module PDK
       end
 
       def print_result(banner_text)
+        require 'pdk/report'
+
         PDK::Report.default_target.puts(_("\n%{banner}") % { banner: generate_banner(banner_text, 40) })
         summary_to_print = summary.map { |k, v| "#{v.length} files #{k}" unless v.empty? }.compact
         PDK::Report.default_target.puts(_("\n%{summary}\n\n") % { summary: "#{summary_to_print.join(', ')}." })
       end
 
       def full_report(path)
+        require 'pdk/report'
+
         File.open(path, 'w') do |f|
           f.write("/* Report generated by PDK at #{Time.now} */")
           update_manager.changes[:modified].each do |_, diff|

data/lib/pdk/module/metadata.rb

@@ -1,4 +1,3 @@
-require 'json'
 require 'pdk/util/filesystem'
 
 module PDK
@@ -102,6 +101,7 @@ module PDK
           raise ArgumentError, _("Unable to open '%{file}' for reading.") % { file: metadata_json_path }
         end
 
+        require 'json'
         begin
           data = JSON.parse(PDK::Util::Filesystem.read_file(metadata_json_path))
         rescue JSON::JSONError => e
@@ -120,6 +120,8 @@ module PDK
       end
 
       def to_json
+        require 'json'
+
         JSON.pretty_generate(@data.dup.delete_if { |_key, value| value.nil? })
       end
 
@@ -132,6 +134,8 @@ module PDK
       end
 
       def interview_for_forge!
+        require 'pdk/generate/module'
+
         PDK::Generate::Module.module_interview(self, only_ask: missing_fields)
       end
 

data/lib/pdk/module/templatedir.rb

@@ -1,10 +1,3 @@
-require 'yaml'
-require 'deep_merge'
-require 'pdk/util'
-require 'pdk/util/git'
-require 'pdk/cli/errors'
-require 'pdk/template_file'
-
 module PDK
   module Module
     class TemplateDir
@@ -39,6 +32,10 @@ module PDK
       #
       # @api public
       def initialize(uri, module_metadata = {}, init = false)
+        require 'pdk/analytics'
+        require 'pdk/util/template_uri'
+        require 'pdk/util/git'
+
         unless block_given?
           raise ArgumentError, _('%{class_name} must be initialized with a block.') % { class_name: self.class.name }
         end
@@ -83,6 +80,7 @@ module PDK
         # If we cloned a git repo to get the template, remove the clone once
         # we're done with it.
         if temp_dir_clone
+          require 'fileutils'
           FileUtils.remove_dir(@path)
         end
       end
@@ -96,6 +94,8 @@ module PDK
       #
       # @api public
       def metadata
+        require 'pdk/util/version'
+
         {
           'pdk-version'  => PDK::Util::Version.version_string,
           'template-url' => uri.metadata_format,
@@ -117,6 +117,8 @@ module PDK
       #
       # @api public
       def render
+        require 'pdk/template_file'
+
         PDK::Module::TemplateDir.files_in_template(@dirs).each do |template_file, template_loc|
           template_file = template_file.to_s
           PDK.logger.debug(_("Rendering '%{template}'...") % { template: template_file })
@@ -207,6 +209,8 @@ module PDK
       def validate_module_template!
         # rubocop:disable Style/GuardClause
         unless File.directory?(@path)
+          require 'pdk/util'
+
           if PDK::Util.package_install? && File.fnmatch?(File.join(PDK::Util.package_cachedir, '*'), @path)
             raise ArgumentError, _('The built-in template has substantially changed. Please run "pdk convert" on your module to continue.')
           else
@@ -260,11 +264,15 @@ module PDK
       #
       # @api private
       def config_for(dest_path, sync_config_path = nil)
+        require 'pdk/util'
+        require 'pdk/analytics'
+
         module_root = PDK::Util.module_root
         sync_config_path ||= File.join(module_root, '.sync.yml') unless module_root.nil?
         config_path = File.join(@path, 'config_defaults.yml')
 
         if @config.nil?
+          require 'deep_merge'
           conf_defaults = read_config(config_path)
           @sync_config = read_config(sync_config_path) unless sync_config_path.nil?
           @config = conf_defaults
@@ -302,6 +310,8 @@ module PDK
       # @api private
       def read_config(loc)
         if File.file?(loc) && File.readable?(loc)
+          require 'yaml'
+
           begin
             YAML.safe_load(File.read(loc), [], [], true)
           rescue Psych::SyntaxError => e
@@ -329,6 +339,9 @@ module PDK
         # @todo When switching this over to using rugged, cache the cloned
         # template repo in `%AppData%` or `$XDG_CACHE_DIR` and update before
         # use.
+        require 'pdk/util'
+        require 'pdk/util/git'
+
         temp_dir = PDK::Util.make_tmpdir_name('pdk-templates')
         origin_repo = uri.git_remote
         git_ref = uri.git_ref
@@ -348,6 +361,8 @@ module PDK
 
       # @api private
       def checkout_template_ref(path, ref)
+        require 'pdk/util/git'
+
         if PDK::Util::Git.work_dir_clean?(path)
           Dir.chdir(path) do
             full_ref = PDK::Util::Git.ls_remote(path, ref)
@@ -365,6 +380,8 @@ module PDK
       end
 
       def cache_template_ref(path, ref = nil)
+        require 'pdk/util/git'
+
         @template_ref ||= PDK::Util::Git.describe(File.join(path, '.git'), ref)
       end
     end

data/lib/pdk/module/update.rb

@@ -41,7 +41,11 @@ module PDK
 
         update_manager.sync_changes!
 
-        PDK::Util::Bundler.ensure_bundle! if needs_bundle_update?
+        if needs_bundle_update?
+          require 'pdk/util/bundler'
+
+          PDK::Util::Bundler.ensure_bundle!
+        end
 
         print_result 'Update completed'
       end

data/lib/pdk/module/update_manager.rb

@@ -1,16 +1,11 @@
-require 'diff/lcs'
-require 'diff/lcs/hunk'
-require 'English'
-require 'fileutils'
-require 'set'
-require 'pdk/util/filesystem'
-
 module PDK
   module Module
     class UpdateManager
       # Initialises a blank UpdateManager object, which is used to store and
       # process file additions/removals/modifications.
       def initialize
+        require 'set'
+
         @modified_files = Set.new
         @added_files = Set.new
         @removed_files = Set.new
@@ -45,11 +40,13 @@ module PDK
       # @raise (see #calculate_diffs)
       # @return [Hash{Symbol => Set,Hash}] the summary of the pending changes.
       def changes
+        require 'pdk/util/filesystem'
+
         calculate_diffs
 
         {
           added:    @added_files,
-          removed:  @removed_files.select { |f| File.exist?(f) },
+          removed:  @removed_files.select { |f| PDK::Util::Filesystem.exist?(f) },
           modified: @diff_cache.reject { |_, value| value.nil? },
         }
       end
@@ -106,9 +103,11 @@ module PDK
       #
       # @raise [PDK::CLI::ExitWithError] if the file could not be removed.
       def unlink_file(path)
-        if File.file?(path)
+        require 'pdk/util/filesystem'
+
+        if PDK::Util::Filesystem.file?(path)
           PDK.logger.debug(_("unlinking '%{path}'") % { path: path })
-          FileUtils.rm(path)
+          PDK::Util::Filesystem.rm(path)
         else
           PDK.logger.debug(_("'%{path}': already gone") % { path: path })
         end
@@ -127,14 +126,16 @@ module PDK
       # @raise [PDK::CLI::ExitWithError] if a file being modified isn't
       #   readable.
       def calculate_diffs
+        require 'pdk/util/filesystem'
+
         @modified_files.each do |file|
           next if @diff_cache.key?(file[:path])
 
-          unless File.readable?(file[:path])
+          unless PDK::Util::Filesystem.readable?(file[:path])
             raise PDK::CLI::ExitWithError, _("Unable to open '%{path}' for reading") % { path: file[:path] }
           end
 
-          old_content = File.read(file[:path])
+          old_content = PDK::Util::Filesystem.read_file(file[:path])
           file_diff = unified_diff(file[:path], old_content, file[:content])
           @diff_cache[file[:path]] = file_diff
         end
@@ -147,7 +148,9 @@ module PDK
       #
       # @raise [PDK::CLI::ExitWithError] if the file is not writeable.
       def write_file(path, content)
-        FileUtils.mkdir_p(File.dirname(path))
+        require 'pdk/util/filesystem'
+
+        PDK::Util::Filesystem.mkdir_p(File.dirname(path))
         PDK.logger.debug(_("writing '%{path}'") % { path: path })
         PDK::Util::Filesystem.write_file(path, content)
       rescue Errno::EACCES
@@ -167,6 +170,9 @@ module PDK
       #
       # @return [String] The unified diff of the pending changes to the file.
       def unified_diff(path, old_content, new_content, lines_of_context = 3)
+        require 'diff/lcs'
+        require 'English'
+
         output = []
 
         old_lines = old_content.split($INPUT_RECORD_SEPARATOR).map(&:chomp)
@@ -176,6 +182,8 @@ module PDK
 
         return if diffs.empty?
 
+        require 'diff/lcs/hunk'
+
         file_mtime = File.stat(path).mtime.localtime.strftime('%Y-%m-%d %H:%M:%S.%N %z')
         now = Time.now.localtime.strftime('%Y-%m-%d %H:%M:%S.%N %z')