pdk 1.14.1 → 1.15.0

data/lib/pdk/module/template_dir/local.rb

@@ -0,0 +1,21 @@
+require 'pdk'
+require 'pdk/module/template_dir/base'
+
+module PDK
+  module Module
+    module TemplateDir
+      class Local < Base
+        def template_path(uri)
+          [uri.shell_path, false]
+        end
+
+        # For plain fileystem directories, this will return the URL to the repository only.
+        #
+        # @return [Hash{String => String}] A hash of identifying metadata.
+        def metadata
+          super.merge('template-url' => uri.bare_uri)
+        end
+      end
+    end
+  end
+end

data/lib/pdk/module/update.rb

@@ -6,7 +6,7 @@ module PDK
       GIT_DESCRIBE_PATTERN = %r{\A(?<base>.+?)-(?<additional_commits>\d+)-g(?<sha>.+)\Z}
 
       def run
-        template_uri.git_ref = new_template_version
+        template_uri.uri_fragment = new_template_version
 
         stage_changes!
 
@@ -71,15 +71,27 @@ module PDK
       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?
+        if template_uri.default? && PDK::Util::Git.tag?(template_uri.bare_uri, template_uri.uri_fragment) && PDK::Util.package_install?
           PDK::Util::TemplateURI.default_template_ref
         else
-          template_uri.git_ref
+          template_uri.uri_fragment
         end
       end
 
+      def pinned_to_puppetlabs_template_tag?
+        return false unless template_uri.puppetlabs_template?
+        return false unless PDK::Util::Git.tag?(template_uri.bare_uri, template_uri.uri_fragment)
+        return false if latest_template?
+
+        template_uri.uri_fragment == new_template_version
+      end
+
       private
 
+      def latest_template?
+        [PDK::TEMPLATE_REF, 'master'].include?(template_uri.uri_fragment)
+      end
+
       def current_template_version
         @current_template_version ||= module_metadata.data['template-ref']
       end
@@ -101,7 +113,7 @@ module PDK
         return template_ref if template_ref == PDK::TEMPLATE_REF
 
         sha_length = GIT_DESCRIBE_PATTERN.match(current_template_version)[:sha].length - 1
-        "#{template_ref}@#{PDK::Util::Git.ls_remote(template_uri.git_remote, template_ref)[0..sha_length]}"
+        "#{template_ref}@#{PDK::Util::Git.ls_remote(template_uri.bare_uri, template_ref)[0..sha_length]}"
       end
 
       def update_message
@@ -113,7 +125,7 @@ module PDK
 
         format_string % {
           module_name:     module_metadata.data['name'],
-          template_url:    template_uri.git_remote,
+          template_url:    template_uri.bare_uri,
           current_version: current_version,
           new_version:     new_version,
         }

data/lib/pdk/module/update_manager.rb

@@ -186,7 +186,7 @@ module PDK
 
         require 'diff/lcs/hunk'
 
-        file_mtime = File.stat(path).mtime.localtime.strftime('%Y-%m-%d %H:%M:%S.%N %z')
+        file_mtime = PDK::Util::Filesystem.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')
 
         output << "--- #{path}\t#{file_mtime}"

data/lib/pdk/report.rb

@@ -51,9 +51,6 @@ module PDK
       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
-
       document = REXML::Document.new
       document << REXML::XMLDecl.new
       testsuites = REXML::Element.new('testsuites')
@@ -81,9 +78,14 @@ module PDK
       end
 
       document.elements << testsuites
-      document.write(target, 2)
-    ensure
-      target.close if target.is_a? File
+      report = ''
+      document.write(report, 2)
+
+      if target.is_a?(String)
+        PDK::Util::Filesystem.write_file(target, report)
+      else
+        target << report
+      end
     end
 
     # Renders the report as plain text.
@@ -94,22 +96,26 @@ module PDK
     # @param target [#write] an IO object that the report will be written to.
     #   Defaults to PDK::Report.default_target.
     def write_text(target = self.class.default_target)
-      # 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
       coverage_report = nil
+      report = []
 
       events.each do |_tool, tool_events|
         tool_events.each do |event|
           if event.rspec_puppet_coverage?
             coverage_report = event.to_text
           else
-            target.puts(event.to_text) unless event.pass?
+            report << event.to_text unless event.pass?
           end
         end
       end
-    ensure
-      target.puts "\n#{coverage_report}" if coverage_report
-      target.close if target.is_a? File
+
+      report << "\n#{coverage_report}" if coverage_report
+
+      if target.is_a?(String)
+        PDK::Util::Filesystem.write_file(target, report.join("\n"))
+      else
+        target << report.join("\n")
+      end
     end
   end
 end

data/lib/pdk/report/event.rb

@@ -98,7 +98,7 @@ module PDK
       #   results.
       def rspec_puppet_coverage?
         @rspec_puppet_coverage_pattern ||= File.join('**', 'lib', 'rspec-puppet', 'coverage.rb')
-        source == 'rspec' && File.fnmatch?(@rspec_puppet_coverage_pattern, File.expand_path(file))
+        source == 'rspec' && PDK::Util::Filesystem.fnmatch?(@rspec_puppet_coverage_pattern, PDK::Util::Filesystem.expand_path(file))
       end
 
       # Renders the event in a clang style text format.
@@ -346,10 +346,13 @@ module PDK
       def context_lines(max_num_lines = 5)
         return if file.nil? || line.nil?
 
-        file_path = [file, File.join(PDK::Util.module_root, file)].find { |r| File.file?(r) }
+        file_path = [file, File.join(PDK::Util.module_root, file)].find do |path|
+          PDK::Util::Filesystem.file?(path)
+        end
+
         return if file_path.nil?
 
-        file_content = File.read(file_path).split("\n")
+        file_content = PDK::Util::Filesystem.read_file(file_path).split("\n")
         delta = (max_num_lines - 1) / 2
         min = [0, (line - 1) - delta].max
         max = [(line - 1) + delta, file_content.length].min

data/lib/pdk/template_file.rb

@@ -62,8 +62,8 @@ module PDK
     #
     # @api private
     def template_content
-      if File.file?(@template_file) && File.readable?(@template_file)
-        return File.read(@template_file)
+      if PDK::Util::Filesystem.file?(@template_file) && PDK::Util::Filesystem.readable?(@template_file)
+        return PDK::Util::Filesystem.read_file(@template_file)
       end
 
       raise ArgumentError, _("'%{template}' is not a readable file") % { template: @template_file }

data/lib/pdk/util.rb

@@ -10,6 +10,7 @@ autoload :Pathname, 'pathname'
 module PDK
   module Util
     autoload :Bundler, 'pdk/util/bundler'
+    autoload :ChangelogGenerator, 'pdk/util/changelog_generator'
     autoload :Env, 'pdk/util/env'
     autoload :Filesystem, 'pdk/util/filesystem'
     autoload :Git, 'pdk/util/git'
@@ -31,6 +32,16 @@ module PDK
       types
     ].freeze
 
+    #:nocov:
+    # This method just wraps core Ruby functionality and
+    # can be ignored for code coverage
+
+    # Calls Kernel.exit with an exitcode
+    def exit_process(exit_code)
+      exit exit_code
+    end
+    #:nocov:
+
     # Searches upwards from current working directory for the given target file.
     #
     # @param target [String] Name of file to search for.
@@ -40,13 +51,13 @@ module PDK
     #   nil if the target file could not be found.
     def find_upwards(target, start_dir = nil)
       previous = nil
-      current  = File.expand_path(start_dir || Dir.pwd)
+      current  = PDK::Util::Filesystem.expand_path(start_dir || Dir.pwd)
 
-      until !File.directory?(current) || current == previous
+      until !PDK::Util::Filesystem.directory?(current) || current == previous
         filename = File.join(current, target)
-        return filename if File.file?(filename)
+        return filename if PDK::Util::Filesystem.file?(filename)
         previous = current
-        current = File.expand_path('..', current)
+        current = PDK::Util::Filesystem.expand_path('..', current)
       end
     end
     module_function :find_upwards
@@ -72,12 +83,12 @@ module PDK
     # @return [String] Canonical path
     def canonical_path(path)
       if Gem.win_platform?
-        unless File.exist?(path)
+        unless PDK::Util::Filesystem.exist?(path)
           raise PDK::CLI::FatalError, _("Cannot resolve a full path to '%{path}', as it does not currently exist.") % { path: path }
         end
         PDK::Util::Windows::File.get_long_pathname(path)
       else
-        File.expand_path(path)
+        PDK::Util::Filesystem.expand_path(path)
       end
     end
     module_function :canonical_path

data/lib/pdk/util/bundler.rb

@@ -6,8 +6,6 @@ module PDK
       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
@@ -34,11 +32,11 @@ module PDK
           original_lockfile = bundle.gemfile_lock
           temp_lockfile = "#{original_lockfile}.tmp"
 
-          FileUtils.mv(original_lockfile, temp_lockfile)
+          PDK::Util::Filesystem.mv(original_lockfile, temp_lockfile)
 
           all_deps_available = bundle.installed?(gem_overrides)
         ensure
-          FileUtils.mv(temp_lockfile, original_lockfile, force: true)
+          PDK::Util::Filesystem.mv(temp_lockfile, original_lockfile, force: true)
         end
 
         bundle.update_lock!(with: gem_overrides, local: all_deps_available)
@@ -91,7 +89,7 @@ module PDK
         end
 
         def locked?
-          !gemfile_lock.nil? && File.file?(gemfile_lock)
+          !gemfile_lock.nil? && PDK::Util::Filesystem.file?(gemfile_lock)
         end
 
         def installed?(gem_overrides = {})
@@ -110,7 +108,6 @@ module PDK
 
         def lock!
           require 'pdk/util'
-          require 'fileutils'
           require 'pdk/util/ruby_version'
 
           if PDK::Util.package_install?
@@ -121,7 +118,9 @@ module PDK
               File.join(PDK::Util.package_cachedir, 'Gemfile.lock'),
             ]
 
-            vendored_gemfile_lock = vendored_lockfiles.find { |lockfile| File.exist?(lockfile) }
+            vendored_gemfile_lock = vendored_lockfiles.find do |lockfile|
+              PDK::Util::Filesystem.exist?(lockfile)
+            end
 
             unless vendored_gemfile_lock
               raise PDK::CLI::FatalError, _('Vendored Gemfile.lock (%{source}) not found.') % {
@@ -130,7 +129,7 @@ module PDK
             end
 
             PDK.logger.debug(_('Using vendored Gemfile.lock from %{source}.') % { source: vendored_gemfile_lock })
-            FileUtils.cp(vendored_gemfile_lock, File.join(PDK::Util.module_root, 'Gemfile.lock'))
+            PDK::Util::Filesystem.cp(vendored_gemfile_lock, File.join(PDK::Util.module_root, 'Gemfile.lock'))
           else
             argv = ['lock']
 
@@ -212,7 +211,7 @@ module PDK
 
         def binstubs!(gems)
           binstub_dir = File.join(File.dirname(gemfile), 'bin')
-          return true if gems.all? { |gem| File.file?(File.join(binstub_dir, gem)) }
+          return true if gems.all? { |gem| PDK::Util::Filesystem.file?(File.join(binstub_dir, gem)) }
 
           cmd = bundle_command('binstubs', *gems, '--force')
           result = cmd.execute!

data/lib/pdk/util/changelog_generator.rb

@@ -0,0 +1,115 @@
+require 'pdk'
+
+module PDK
+  module Util
+    module ChangelogGenerator
+      # Taken from the version regex in https://forgeapi.puppet.com/schemas/module.json
+      VERSION_REGEX = %r{^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(-(0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(\.(0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*)?(\+[0-9a-zA-Z-]+(\.[0-9a-zA-Z-]+)*)?$}
+
+      # Raises if the github_changelog_generator is not available
+      def self.github_changelog_generator_available!
+        require 'bundler'
+        raise PDK::CLI::ExitWithError, _('Unable to generate the changelog as the github_changelog_generator gem is not installed') unless Bundler.rubygems.find_name('github_changelog_generator').any?
+      end
+
+      # Runs the Changelog Generator gem (in the module's context) to automatically create a CHANGLELOG.MD file
+      #
+      # @returns [String] The content of the new Changelog
+      def self.generate_changelog
+        github_changelog_generator_available!
+
+        changelog_command = PDK::CLI::Exec::InteractiveCommand.new(PDK::CLI::Exec.bundle_bin, 'exec', 'rake', 'changelog')
+        changelog_command.context = :module
+
+        result = changelog_command.execute!
+        raise PDK::CLI::ExitWithError, _('Error generating changelog: %{stdout}' % { stdout: result[:stdout] }) unless result[:exit_code].zero?
+
+        output = changelog_content
+
+        raise PDK::CLI::ExitWithError, _('The generated changelog contains uncategorized Pull Requests. Please label them and try again. See %{changelog_file} for more details' % { changelog_file: changelog_file }) if output =~ %r{UNCATEGORIZED PRS; GO LABEL THEM} # rubocop:disable Metrics/LineLength
+        output
+      end
+
+      # Computes the next version, based on the content of a changelog
+      #
+      # @param current_version [String, Gem::Version] The current version of the module
+      # @return [String] The new version. May be the same as the current version if there are no notable changes
+      def self.compute_next_version(current_version)
+        raise PDK::CLI::ExitWithError, _('Invalid version string %{version}' % { version: current_version }) unless current_version =~ VERSION_REGEX
+        version = Gem::Version.create(current_version).segments
+        PDK.logger.info _('Determing the target version from \'%{file}\'') % { file: changelog_file }
+
+        # Grab all lines that start with ## between from the latest changes
+        # For example given the changelog below
+
+        # ```
+        # # Change log
+        #
+        # All notable changes to this project will be documented in this file.
+        #
+        # ## [v4.0.0](https://github.com/puppetlabs/puppetlabs-inifile/tree/v4.
+        #
+        # [Full Changelog](https://github.com/puppetlabs/puppetlabs-inifile/com   --+
+        #                                                                           |
+        # ### Changed                                                               |
+        #                                                                           |
+        # - pdksync - FM-8499 - remove ubuntu14 support [\#363](https://github.     |  It's this piece of text we are interested in
+        #                                                                           |
+        # ### Added                                                                 |
+        #                                                                           |
+        # - FM-8402 add debian 10 support [\#352](https://github.com/puppetlabs     |
+        #                                                                           |
+        # ## [v3.1.0](https://github.com/puppetlabs/puppetlabs-inifile/tree/v3.     |
+        #                                                                         --+
+        # [Full Changelog](https://github.com/puppetlabs/puppetlabs-inifile/com
+        #
+        # ### Added
+        #
+        # - FM-8222 - Port Module inifile to Litmus [\#344](https://github.com/
+        # - \(FM-8154\) Add Windows Server 2019 support [\#340](https://github.
+        # - \(FM-8041\) Add RedHat 8 support [\#339](https://github.com/puppetl
+        # ````
+        data = ''
+        in_changelog_entry = false
+        changelog_content.each_line do |line|
+          line.strip!
+          if line.start_with?('[')
+            # We're leaving the latest changes so we can break
+            break if in_changelog_entry
+            in_changelog_entry = true
+          end
+          if in_changelog_entry && line.start_with?('##')
+            data += line
+          end
+        end
+
+        # Check for meta headers in first two header line matches
+        if data =~ %r{^### Changed}
+          # Major Version bump
+          version[0] += 1
+          version[1] = 0
+          version[2] = 0
+        elsif data =~ %r{^### Added}
+          # Minor Version bump
+          version[1] += 1
+          version[2] = 0
+        elsif data =~ %r{^### Fixed}
+          # Patch Version bump
+          version[2] += 1
+        end
+
+        version.join('.')
+      end
+
+      def self.changelog_file
+        # Default Changelog file is CHANGELOG.md, but also search for the .MD prefix as well.
+        @changelog_file ||= ['CHANGELOG.md', 'CHANGELOG.MD'].map { |file| PDK::Util::Filesystem.expand_path(file) }.find { |path| PDK::Util::Filesystem.file?(path) }
+      end
+
+      def self.changelog_content
+        return '' if changelog_file.nil?
+        PDK::Util::Filesystem.read_file(changelog_file, open_args: 'rb:utf-8')
+      end
+    end
+  end
+end

data/lib/pdk/util/filesystem.rb

@@ -1,4 +1,5 @@
 require 'pdk'
+autoload :FileUtils, 'fileutils'
 
 module PDK
   module Util
@@ -17,8 +18,8 @@ module PDK
       end
       module_function :write_file
 
-      def read_file(file, nil_on_error: false)
-        File.read(file)
+      def read_file(file, nil_on_error: false, open_args: 'r')
+        File.read(file, open_args: Array(open_args))
       rescue => e
         raise e unless nil_on_error
         nil
@@ -58,6 +59,11 @@ module PDK
       end
       module_function :fnmatch
 
+      def fnmatch?(*args)
+        File.fnmatch?(*args)
+      end
+      module_function :fnmatch?
+
       def readable?(*args)
         File.readable?(*args)
       end
@@ -72,6 +78,60 @@ module PDK
         FileUtils.rm(*args)
       end
       module_function :rm
+
+      def rm_f(*args)
+        FileUtils.rm_f(*args)
+      end
+      module_function :rm_f
+
+      def rm_rf(*args)
+        FileUtils.rm_rf(*args)
+      end
+      module_function :rm_rf
+
+      def remove_entry_secure(*args)
+        FileUtils.remove_entry_secure(*args)
+      end
+      module_function :remove_entry_secure
+
+      def zero?(*args)
+        File.zero?(*args)
+      end
+      module_function :zero?
+
+      def stat(*args)
+        File.stat(*args)
+      end
+      module_function :stat
+
+      def symlink?(*args)
+        File.symlink?(*args)
+      end
+      module_function :symlink?
+
+      def cp(*args)
+        FileUtils.cp(*args)
+      end
+      module_function :cp
+
+      def mv(*args)
+        FileUtils.mv(*args)
+      rescue Errno::ENOENT
+        # PDK-1169 - FileUtils.mv raises Errno::ENOENT when moving files inside
+        #            VMWare shared folders on Windows. So we need to catch this
+        #            case, check if the file exists to see if the exception is
+        #            legit and "move" the file with cp & rm.
+        src, dest, opts = args
+        raise unless File.exist?(src)
+
+        FileUtils.cp(src, dest, preserve: true)
+        if (opts ||= {})[:secure]
+          FileUtils.remove_entry_secure(src, opts[:force])
+        else
+          FileUtils.remove_entry(src, opts[:force])
+        end
+      end
+      module_function :mv
       #:nocov:
     end
   end