pdk-akerl 1.9.1.1 → 1.14.0.1

data/lib/pdk/module/update.rb

@@ -6,6 +6,8 @@ module PDK
       GIT_DESCRIBE_PATTERN = %r{\A(?<base>.+?)-(?<additional_commits>\d+)-g(?<sha>.+)\Z}
 
       def run
+        template_uri.git_ref = new_template_version
+
         stage_changes!
 
         if current_version == new_version
@@ -39,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
@@ -50,8 +56,8 @@ module PDK
         raise PDK::CLI::ExitWithError, e.message
       end
 
-      def template_url
-        @template_url ||= module_metadata.data['template-url']
+      def template_uri
+        @template_uri ||= PDK::Util::TemplateURI.new(module_metadata.data['template-url'])
       end
 
       def current_version
@@ -62,6 +68,16 @@ module PDK
         @new_version ||= fetch_remote_version(new_template_version)
       end
 
+      def new_template_version
+        return options[:'template-ref'] if options[:'template-ref']
+
+        if template_uri.default? && template_uri.ref_is_tag? && PDK::Util.package_install?
+          PDK::Util::TemplateURI.default_template_ref
+        else
+          template_uri.git_ref
+        end
+      end
+
       private
 
       def current_template_version
@@ -73,27 +89,23 @@ module PDK
 
         return data if data.nil?
 
-        if data[:base].start_with?('heads/')
-          "#{data[:base].gsub(%r{^heads/}, '')}@#{data[:sha]}"
+        if data[:base] =~ %r{^(?:heads|remotes)/}
+          "#{data[:base].gsub(%r{^(heads/|remotes/\w+?/)}, '')}@#{data[:sha]}"
         else
           data[:base]
         end
       end
 
-      def new_template_version
-        PDK::Util.default_template_ref
-      end
-
-      def fetch_remote_version(version)
-        return version unless version.include?('/')
+      def fetch_remote_version(template_ref)
+        return template_ref unless current_template_version.is_a?(String)
+        return template_ref if template_ref == PDK::TEMPLATE_REF
 
-        branch = version.partition('/').last
         sha_length = GIT_DESCRIBE_PATTERN.match(current_template_version)[:sha].length - 1
-        "#{branch}@#{PDK::Util::Git.ls_remote(template_url, "refs/heads/#{branch}")[0..sha_length]}"
+        "#{template_ref}@#{PDK::Util::Git.ls_remote(template_uri.git_remote, template_ref)[0..sha_length]}"
       end
 
       def update_message
-        format_string = if template_url == PDK::Util.puppetlabs_template_url
+        format_string = if template_uri.default?
                           _('Updating %{module_name} using the default template, from %{current_version} to %{new_version}')
                         else
                           _('Updating %{module_name} using the template at %{template_url}, from %{current_version} to %{new_version}')
@@ -101,7 +113,7 @@ module PDK
 
         format_string % {
           module_name:     module_metadata.data['name'],
-          template_url:    template_url,
+          template_url:    template_uri.git_remote,
           current_version: current_version,
           new_version:     new_version,
         }

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
@@ -73,7 +70,7 @@ module PDK
       def changed?(path)
         changes[:added].any? { |add| add[:path] == path } ||
           changes[:removed].include?(path) ||
-          changes[:modified].keys.include?(path)
+          changes[:modified].key?(path)
       end
 
       # Apply any pending changes stored in the UpdateManager to the module.
@@ -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)
@@ -174,7 +180,9 @@ module PDK
 
         diffs = Diff::LCS.diff(old_lines, new_lines)
 
-        return nil if diffs.empty?
+        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')

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?
@@ -267,7 +269,7 @@ module PDK
       # @return [Integer] the provided value, converted into an Integer if
       #   necessary.
       def sanitise_line(value)
-        return nil if value.nil?
+        return if value.nil?
 
         valid_types = [String, Integer]
         if RUBY_VERSION.split('.')[0..1].join('.').to_f < 2.4
@@ -292,7 +294,7 @@ module PDK
       # @return [Integer] the provided value, converted into an Integer if
       #   necessary.
       def sanitise_column(value)
-        return nil if value.nil?
+        return if value.nil?
 
         valid_types = [String, Integer]
         if RUBY_VERSION.split('.')[0..1].join('.').to_f < 2.4
@@ -317,7 +319,7 @@ module PDK
       #
       # @return [Array] Array of stack trace lines with less relevant lines excluded
       def sanitise_trace(value)
-        return nil if value.nil?
+        return if value.nil?
 
         valid_types = [Array]
 

data/lib/pdk/template_file.rb

@@ -45,7 +45,7 @@ module PDK
     end
 
     def config_for(path)
-      return nil unless respond_to?(:template_dir)
+      return unless respond_to?(:template_dir)
 
       template_dir.config_for(path)
     end

data/lib/pdk/tests/unit.rb

@@ -1,34 +1,51 @@
-require 'pdk'
-require 'pdk/cli/exec'
-require 'pdk/util/bundler'
-require 'json'
-
 module PDK
   module Test
     class Unit
       def self.cmd(tests, opts = {})
-        rake_args = opts.key?(:parallel) ? 'parallel_spec_standalone' : 'spec_standalone'
-        rake_args += "[#{tests}]" unless tests.nil?
+        rake_args = opts[:parallel] ? 'parallel_spec_standalone' : 'spec_standalone'
+        rake_args += "[#{tests}]" unless tests.nil? || tests.empty?
         rake_args
       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)
+          c.add_spinner(spinner_text) if spinner_text
           c.environment = environment
         end
 
         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,31 +81,40 @@ module PDK
       end
 
       def self.invoke(report, options = {})
+        require 'pdk/util'
+        require 'pdk/util/bundler'
+
         PDK::Util::Bundler.ensure_binstubs!('rake', 'rspec-core')
 
         setup
 
-        tests = options.fetch(:tests)
+        tests = options[:tests]
 
         environment = { 'CI_SPEC_OPTIONS' => '--format j' }
         environment['PUPPET_GEM_VERSION'] = options[:puppet] if options[:puppet]
-        spinner_msg = options.key?(:parallel) ? _('Running unit tests in parallel.') : _('Running unit tests.')
+        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.key?(:parallel)
+        json_result = if options[:parallel]
                         PDK::Util.find_all_json_in(result[:stdout])
                       else
                         PDK::Util.find_first_json_in(result[:stdout])
                       end
 
-        if parallel_with_no_tests?(options.key?(:parallel), json_result, result)
+        if parallel_with_no_tests?(options[:parallel], json_result, result)
           json_result = [{ 'messages' => ['No examples found.'] }]
           result[:exit_code] = 0
         end
 
         raise PDK::CLI::FatalError, _('Unit test output did not contain a valid JSON result: %{output}') % { output: result[:stdout] } if json_result.nil? || json_result.empty?
 
-        json_result = merge_json_results(json_result) if options.key?(:parallel)
+        json_result = merge_json_results(json_result) if options[:parallel]
 
         parse_output(report, json_result, result[:duration])
 
@@ -183,15 +209,16 @@ module PDK
       end
 
       # @return array of { :id, :full_description }
-      def self.list
+      def self.list(options = {})
+        require 'pdk/util'
+        require 'pdk/util/bundler'
+
         PDK::Util::Bundler.ensure_binstubs!('rake')
 
-        command_argv = [File.join(PDK::Util.module_root, 'bin', 'rake'), 'spec_list_json']
-        command_argv.unshift(File.join(PDK::Util::RubyVersion.bin_path, 'ruby.exe')) if Gem.win_platform?
+        environment = {}
+        environment['PUPPET_GEM_VERSION'] = options[:puppet] if options[:puppet]
 
-        list_command = PDK::CLI::Exec::Command.new(*command_argv)
-        list_command.context = :module
-        output = list_command.execute!
+        output = rake('spec_list_json', _('Finding unit tests.'), environment)
 
         rspec_json = PDK::Util.find_first_json_in(output[:stdout])
         raise PDK::CLI::FatalError, _('Failed to find valid JSON in output from rspec: %{output}' % { output: output[:stdout] }) unless rspec_json

data/lib/pdk/util.rb

@@ -1,10 +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'
 
 module PDK
   module Util
@@ -43,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)
@@ -67,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?
@@ -83,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
@@ -105,6 +109,15 @@ module PDK
     end
     module_function :cachedir
 
+    def configdir
+      if Gem.win_platform?
+        File.join(ENV['LOCALAPPDATA'], 'PDK')
+      else
+        File.join(ENV.fetch('XDG_CONFIG_HOME', File.join(Dir.home, '.config')), 'pdk')
+      end
+    end
+    module_function :configdir
+
     # Returns path to the root of the module being worked on.
     #
     # @return [String, nil] Fully qualified base path to module, or nil if
@@ -121,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
     #
@@ -197,65 +218,10 @@ module PDK
     end
     module_function :targets_relative_to_pwd
 
-    def default_template_url
-      answer_file_url = PDK.answers['template-url']
-
-      return puppetlabs_template_url if answer_file_url.nil?
-
-      # Ignore answer file template-url if the value is the old or new default.
-      return puppetlabs_template_url if answer_file_url == 'https://github.com/puppetlabs/pdk-module-template'
-      return puppetlabs_template_url if answer_file_url == puppetlabs_template_url
-
-      if File.directory?(answer_file_url)
-        # Instantiating a new TemplateDir object pointing to the directory
-        # will cause the directory contents to be validated, raising
-        # ArgumentError if it does not appear to be a valid template.
-        PDK::Module::TemplateDir.new(answer_file_url) {}
-        return answer_file_url
-      end
-
-      raise ArgumentError unless PDK::Util::Git.repo?(answer_file_url)
-
-      answer_file_url
-    rescue ArgumentError
-      PDK.logger.warn(
-        _("Unable to access the previously used template '%{template}', using the default template instead.") % {
-          template: answer_file_url,
-        },
-      )
-      PDK.answers.update!('template-url' => nil)
-      return puppetlabs_template_url
-    end
-    module_function :default_template_url
-
-    def puppetlabs_template_url
-      if package_install?
-        'file://' + File.join(package_cachedir, 'pdk-templates.git')
-      else
-        'https://github.com/puppetlabs/pdk-templates'
-      end
-    end
-    module_function :puppetlabs_template_url
-
-    def default_template_ref
-      # TODO: This should respect a --template-ref option if we add that
-      return 'origin/master' if default_template_url != puppetlabs_template_url
-
-      puppetlabs_template_ref
-    end
-    module_function :default_template_ref
-
-    def puppetlabs_template_ref
-      if PDK::Util.development_mode?
-        'origin/master'
-      else
-        PDK::TEMPLATE_REF
-      end
-    end
-    module_function :puppetlabs_template_ref
-
     # 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