pdk 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61c49c154cc69ce1e3c47ddfdd089b42c9c4c5e610bfb2e6caf3256939a16d5d
-  data.tar.gz: 420c70b35bfaf64077b990f6853bfc92062659fc7ba36379cb053232b99313a5
+  metadata.gz: 7ea7fd13c13423022b2ef3e28275d98860b34b9afe9d4b5ccac56c06a0a29346
+  data.tar.gz: 5025806f00ad6d9b36bb0957d8da65765cc46cd335c11ef75cf3b82f88a61e79
 SHA512:
-  metadata.gz: 3e2e8f1e63a936c310459a67a14b632e00a4ac1694fa4cc77f2849b3d19bf09cc9a5e4a19d7ce3e3a0eb6493a31141c76a72bc98d30cbb4eb7ffd1f5d3da7ca0
-  data.tar.gz: fe219a60e2cf9f7263e1b8fd8e721f143349aa3f03125649e551f9978ae3a9012c4b051f21b2707a266ed31a67772ad6c3cef026f1c5a1a0dadaf8257dc888dc
+  metadata.gz: a3b2866a2a221d87d7c87ecc15231b0a97b00bce150cdd97fd6a6a1ee99f36d9ead2fcee2aef644360aaef84e499f1adff1cdb8de9a10ec084ac302743255a6a
+  data.tar.gz: e4fbd9517b238b85d55c59df0a838f831ac1033e84ec2daa96487470f91e1c5954bf96208b223311ab8c8e4c00bc3150570094017576d7e1ffb105c57f2f2eff

data/CHANGELOG.md

@@ -5,6 +5,20 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org).
 
+## [v3.3.0](https://github.com/puppetlabs/pdk/tree/v3.3.0) - 2024-09-10
+
+[Full Changelog](https://github.com/puppetlabs/pdk/compare/v3.2.0...v3.3.0)
+
+## Added
+
+- Skip 'name' validation when in a controlrepo context [#1352](https://github.com/puppetlabs/pdk/pull/1352) ([garrettrowell](https://github.com/garrettrowell))
+- (CAT-1896) - Use puppet-modulebuilder for PDK build [#1374](https://github.com/puppetlabs/pdk/pull/1374) ([jordanbreen28](https://github.com/jordanbreen28))
+
+### Fixed
+
+- (CAT-1643) Update childprocess and remove patch [#1356](https://github.com/puppetlabs/pdk/pull/1356) ([david22swan](https://github.com/david22swan))
+- (CAT-2026) Update how pdk test unit --list detects an error [#1388](https://github.com/puppetlabs/pdk/pull/1388) ([david22swan](https://github.com/david22swan))
+
 ## [v3.2.0](https://github.com/puppetlabs/pdk/tree/v3.2.0) - 2024-05-02
 
 [Full Changelog](https://github.com/puppetlabs/pdk/compare/v3.1.0...v3.2.0)

data/lib/pdk/cli/build.rb

@@ -12,7 +12,6 @@ module PDK
       option nil, 'force', 'Skips the prompts and builds the module package.'
 
       run do |opts, _args, _cmd|
-        require 'pdk/module/build'
         require 'pdk/module/metadata'
         require 'pdk/cli/util'
 
@@ -37,7 +36,11 @@ module PDK
           end
         end
 
-        builder = PDK::Module::Build.new(opts)
+        # build module
+        require 'puppet/modulebuilder'
+        module_dir = PDK::Util::Filesystem.expand_path(Dir.pwd)
+        target_dir = PDK::Util::Filesystem.expand_path(opts[:'target-dir'])
+        builder = Puppet::Modulebuilder::Builder.new(module_dir, target_dir, PDK.logger)
 
         unless opts[:force]
           if builder.package_already_exists?
@@ -49,7 +52,7 @@ module PDK
             end
           end
 
-          unless builder.module_pdk_compatible?
+          unless PDK::Util.module_pdk_compatible?(module_dir)
             PDK.logger.info 'This module is not compatible with PDK, so PDK can not validate or test this build. ' \
                             'Unvalidated modules may have errors when uploading to the Forge. ' \
                             'To make this module PDK compatible and use validate features, cancel the build and run `pdk convert`.'

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

@@ -20,8 +20,6 @@ module PDK
 
         def initialize(*argv)
           require 'childprocess'
-
-          require 'pdk/monkey_patches'
           require 'tempfile'
 
           @argv = argv

data/lib/pdk/cli/release.rb

@@ -3,7 +3,6 @@ require 'pdk/validate'
 require 'pdk/util/bundler'
 require 'pdk/cli/util/interview'
 require 'pdk/util/changelog_generator'
-require 'pdk/module/build'
 
 module PDK
   module CLI

data/lib/pdk/module/convert.rb

@@ -163,7 +163,7 @@ module PDK
             when :manage
               if PDK::Util::Filesystem.exist?(absolute_file_path)
                 update_manager.modify_file(absolute_file_path, file_content)
-                update_manager.make_file_executable(absolute_file_path) if file_executable && !PDK::Util::Filesystem.executable?(absolute_file_path)
+                update_manager.make_file_executable(absolute_file_path) if file_executable && !PDK::Util::Filesystem.stat(absolute_file_path).executable?
               else
                 update_manager.add_file(absolute_file_path, file_content)
                 update_manager.make_file_executable(absolute_file_path) if file_executable
@@ -211,7 +211,7 @@ module PDK
           return if options[:noop]
 
           project_dir = File.basename(Dir.pwd)
-          options[:module_name] = project_dir.split('-', 2).compact[-1]
+          options[:module_name] = PDK.context.is_a?(PDK::Context::ControlRepo) ? project_dir : project_dir.split('-', 2).compact[-1]
           options[:prompt] = false
           options[:'skip-interview'] = true if options[:force]
 

data/lib/pdk/module/metadata.rb

@@ -9,7 +9,7 @@ module PDK
         'RedHat based Linux' => [
           {
             'operatingsystem' => 'CentOS',
-            'operatingsystemrelease' => ['7']
+            'operatingsystemrelease' => ['7', '8', '9']
           },
           {
             'operatingsystem' => 'OracleLinux',
@@ -17,30 +17,38 @@ module PDK
           },
           {
             'operatingsystem' => 'RedHat',
-            'operatingsystemrelease' => ['8']
+            'operatingsystemrelease' => ['7', '8', '9']
           },
           {
             'operatingsystem' => 'Scientific',
             'operatingsystemrelease' => ['7']
+          },
+          {
+            'operatingsystem' => 'Rocky',
+            'operatingsystemrelease' => ['8']
+          },
+          {
+            'operatingsystem' => 'AlmaLinux',
+            'operatingsystemrelease' => ['8']
           }
         ],
         'Debian based Linux' => [
           {
             'operatingsystem' => 'Debian',
-            'operatingsystemrelease' => ['10']
+            'operatingsystemrelease' => ['10', '11', '12']
           },
           {
             'operatingsystem' => 'Ubuntu',
-            'operatingsystemrelease' => ['18.04']
+            'operatingsystemrelease' => ['18.04', '20.04', '22.04']
           }
         ],
         'Fedora' => {
           'operatingsystem' => 'Fedora',
-          'operatingsystemrelease' => ['29']
+          'operatingsystemrelease' => ['40']
         },
         'OSX' => {
           'operatingsystem' => 'Darwin',
-          'operatingsystemrelease' => ['16']
+          'operatingsystemrelease' => ['21', '22', '23']
         },
         'SLES' => {
           'operatingsystem' => 'SLES',
@@ -52,11 +60,11 @@ module PDK
         },
         'Windows' => {
           'operatingsystem' => 'windows',
-          'operatingsystemrelease' => ['2019', '10']
+          'operatingsystemrelease' => ['2019', '2022', '10', '11']
         },
         'AIX' => {
           'operatingsystem' => 'AIX',
-          'operatingsystemrelease' => ['6.1', '7.1', '7.2']
+          'operatingsystemrelease' => ['7.2', '7.3']
         }
       }.freeze
 
@@ -162,7 +170,7 @@ module PDK
 
       # Do basic validation and parsing of the name parameter.
       def process_name(data)
-        validate_name(data['name'])
+        validate_name(data['name']) unless PDK.context.is_a?(PDK::Context::ControlRepo)
         author, modname = data['name'].split(%r{[-/]}, 2)
         data['name'] = [author, modname].join('-')
 

data/lib/pdk/module/release.rb

@@ -1,5 +1,6 @@
 require 'pdk'
 require 'uri'
+require 'puppet/modulebuilder'
 
 module PDK
   module Module
@@ -77,7 +78,7 @@ module PDK
           # Use the default as a last resort
           package_file = default_package_filename if package_file.nil?
         else
-          package_file = run_build(options)
+          package_file = run_build
         end
 
         run_publish(options.dup, package_file) unless skip_publish?
@@ -95,7 +96,7 @@ module PDK
       def default_package_filename
         return @default_tarball_filename unless @default_tarball_filename.nil?
 
-        builder = PDK::Module::Build.new(module_dir: module_path)
+        builder = Puppet::Modulebuilder::Builder.new(module_path, nil, PDK.logger)
         @default_tarball_filename = builder.package_file
       end
 
@@ -135,8 +136,11 @@ module PDK
       end
 
       # @return [String] Path to the built tarball
-      def run_build(opts)
-        PDK::Module::Build.invoke(opts.dup)
+      def run_build
+        module_dir = PDK::Util::Filesystem.expand_path(module_path || Dir.pwd)
+        target_dir = File.join(module_dir, 'pkg')
+        builder = Puppet::Modulebuilder::Builder.new(module_dir, target_dir, PDK.logger)
+        builder.build
       end
 
       def run_publish(_opts, tarball_path)
@@ -238,8 +242,7 @@ module PDK
       def pdk_compatible?
         return @pdk_compatible unless @pdk_compatible.nil?
 
-        builder = PDK::Module::Build.new(module_dir: module_path)
-        @pdk_compatible = builder.module_pdk_compatible?
+        @pdk_compatible = PDK::Util.module_pdk_compatible?(module_path)
       end
       # :nocov:
 

data/lib/pdk/template/renderer/v1/renderer.rb

@@ -95,7 +95,7 @@ module PDK
                 end
               end
 
-              dest_executable = config['manage_execute_permissions'] && PDK::Util::Filesystem.executable?(File.join(template_loc, template_file))
+              dest_executable = config['manage_execute_permissions'] && PDK::Util::Filesystem.stat(File.join(template_loc, template_file)).executable?
 
               yield dest_path, dest_content, dest_status, dest_executable
             end

data/lib/pdk/tests/unit.rb

@@ -246,10 +246,10 @@ module PDK
         raise PDK::CLI::FatalError, format('Failed to find valid JSON in output from rspec: %{output}', output: output[:stdout]) unless rspec_json
 
         if rspec_json['examples'].empty?
-          rspec_message = rspec_json['messages'][0]
-          return [] if rspec_message == 'No examples found.'
+          return [] if rspec_json['messages'][0] == 'No examples found.'
+          return [] if rspec_json['messages'].include?("\nAll examples were filtered out")
 
-          raise PDK::CLI::FatalError, format('Unable to enumerate examples. rspec reported: %{message}', message: rspec_message)
+          raise PDK::CLI::FatalError, format('Unable to enumerate examples. rspec reported: %{message}', message: rspec_json['messages'])
         else
           examples = []
           rspec_json['examples'].each do |example|

data/lib/pdk/util.rb

@@ -32,6 +32,7 @@ module PDK
     def exit_process(exit_code)
       exit exit_code
     end
+    module_function :exit_process
     # :nocov:
 
     # Searches upwards from current working directory for the given target file.

data/lib/pdk/version.rb

@@ -1,4 +1,4 @@
 module PDK
-  VERSION = '3.2.0'.freeze
-  TEMPLATE_REF = '3.2.0'.freeze
+  VERSION = '3.3.0'.freeze
+  TEMPLATE_REF = '3.3.0'.freeze
 end

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: pdk
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Puppet, Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-09 00:00:00.000000000 Z
+date: 2024-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 1.15.5
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 1.15.5
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
-  name: childprocess
+  name: minitar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: cri
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.15.11
+        version: 2.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.15.11
+        version: 2.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: diff-lcs
+  name: cri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 2.15.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 2.15.11
 - !ruby/object:Gem::Dependency
-  name: ffi
+  name: childprocess
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.15.5
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.15.5
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: hitimes
   requirement: !ruby/object:Gem::Requirement
@@ -107,117 +107,131 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.0.0
 - !ruby/object:Gem::Dependency
-  name: json_pure
+  name: tty-prompt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.3
+        version: '0.23'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.3
+        version: '0.23'
 - !ruby/object:Gem::Dependency
-  name: json-schema
+  name: tty-spinner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: minitar
+  name: tty-which
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: pathspec
+  name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: tty-prompt
+  name: puppet-modulebuilder
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.23'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.23'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: tty-spinner
+  name: deep_merge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 1.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 1.2.2
 - !ruby/object:Gem::Dependency
-  name: tty-which
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: json_pure
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 2.6.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 2.6.3
 - !ruby/object:Gem::Dependency
-  name: deep_merge
+  name: pathspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: '1.1'
 description: A CLI to facilitate easy, unified development workflows for Puppet modules.
 email:
 - pdk-maintainers@puppet.com
@@ -305,13 +319,11 @@ files:
 - lib/pdk/generate/transport.rb
 - lib/pdk/logger.rb
 - lib/pdk/module.rb
-- lib/pdk/module/build.rb
 - lib/pdk/module/convert.rb
 - lib/pdk/module/metadata.rb
 - lib/pdk/module/release.rb
 - lib/pdk/module/update.rb
 - lib/pdk/module/update_manager.rb
-- lib/pdk/monkey_patches.rb
 - lib/pdk/report.rb
 - lib/pdk/report/event.rb
 - lib/pdk/template.rb
@@ -371,7 +383,7 @@ homepage: https://github.com/puppetlabs/pdk
 licenses: []
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -386,8 +398,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.5.17
+signing_key:
 specification_version: 4
 summary: A key part of the Puppet Development Kit, the shortest path to better modules
 test_files: []

data/lib/pdk/module/build.rb

@@ -1,302 +0,0 @@
-require 'pdk'
-
-module PDK
-  module Module
-    class Build
-      def self.invoke(options = {})
-        new(options).build
-      end
-
-      attr_reader :module_dir, :target_dir
-
-      def initialize(options = {})
-        @module_dir = PDK::Util::Filesystem.expand_path(options[:module_dir] || Dir.pwd)
-        @target_dir = PDK::Util::Filesystem.expand_path(options[:'target-dir'] || File.join(module_dir, 'pkg'))
-      end
-
-      # Read and parse the values from metadata.json for the module that is
-      # being built.
-      #
-      # @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
-
-      # Return the path where the built package file will be written to.
-      def package_file
-        @package_file ||= File.join(target_dir, "#{release_name}.tar.gz")
-      end
-
-      # Build a module package from a module directory.
-      #
-      # @return [String] The path to the built package file.
-      def build
-        create_build_dir
-
-        stage_module_in_build_dir
-        build_package
-
-        package_file
-      ensure
-        cleanup_build_dir
-      end
-
-      # Verify if there is an existing package in the target directory and prompts
-      # the user if they want to overwrite it.
-      def package_already_exists?
-        PDK::Util::Filesystem.exist?(package_file)
-      end
-
-      # Check if the module is PDK Compatible. If not, then prompt the user if
-      # they want to run PDK Convert.
-      def module_pdk_compatible?
-        ['pdk-version', 'template-url'].any? { |key| metadata.key?(key) }
-      end
-
-      # Return the path to the temporary build directory, which will be placed
-      # inside the target directory and match the release name (see #release_name).
-      def build_dir
-        @build_dir ||= File.join(target_dir, release_name)
-      end
-
-      # Create a temporary build directory where the files to be included in
-      # the package will be staged before building the tarball.
-      #
-      # If the directory already exists, remove it first.
-      def create_build_dir
-        cleanup_build_dir
-
-        PDK::Util::Filesystem.mkdir_p(build_dir)
-      end
-
-      # Remove the temporary build directory and all its contents from disk.
-      #
-      # @return nil.
-      def cleanup_build_dir
-        PDK::Util::Filesystem.rm_rf(build_dir, secure: true)
-      end
-
-      # Combine the module name and version into a Forge-compatible dash
-      # separated string.
-      #
-      # @return [String] The module name and version, joined by a dash.
-      def release_name
-        @release_name ||= [
-          metadata['name'],
-          metadata['version']
-        ].join('-')
-      end
-
-      # Iterate through all the files and directories in the module and stage
-      # them into the temporary build directory (unless ignored).
-      #
-      # @return nil
-      def stage_module_in_build_dir
-        require 'find'
-
-        Find.find(module_dir) do |path|
-          next if path == module_dir
-
-          ignored_path?(path) ? Find.prune : stage_path(path)
-        end
-      end
-
-      # Stage a file or directory from the module into the build directory.
-      #
-      # @param path [String] The path to the file or directory.
-      #
-      # @return nil.
-      def stage_path(path)
-        require 'pathname'
-
-        relative_path = Pathname.new(path).relative_path_from(Pathname.new(module_dir))
-        dest_path = File.join(build_dir, relative_path)
-
-        validate_path_encoding!(relative_path.to_path)
-
-        if PDK::Util::Filesystem.directory?(path)
-          PDK::Util::Filesystem.mkdir_p(dest_path, mode: PDK::Util::Filesystem.stat(path).mode)
-        elsif PDK::Util::Filesystem.symlink?(path)
-          warn_symlink(path)
-        else
-          validate_ustar_path!(relative_path.to_path)
-          PDK::Util::Filesystem.cp(path, dest_path, preserve: true)
-        end
-      rescue ArgumentError => e
-        raise PDK::CLI::ExitWithError, format('%{message} Rename the file or exclude it from the package ' \
-                                              'by adding it to the .pdkignore file in your module.', message: e.message)
-      end
-
-      # Check if the given path matches one of the patterns listed in the
-      # ignore file.
-      #
-      # @param path [String] The path to be checked.
-      #
-      # @return [Boolean] true if the path matches and should be ignored.
-      def ignored_path?(path)
-        path = "#{path}/" if PDK::Util::Filesystem.directory?(path)
-
-        !ignored_files.match_paths([path], module_dir).empty?
-      end
-
-      # Warn the user about a symlink that would have been included in the
-      # built package.
-      #
-      # @param path [String] The relative or absolute path to the symlink.
-      #
-      # @return nil.
-      def warn_symlink(path)
-        require 'pathname'
-
-        symlink_path = Pathname.new(path)
-        module_path = Pathname.new(module_dir)
-
-        PDK.logger.warn format('Symlinks in modules are not supported and will not be included in the package. Please investigate symlink %{from} -> %{to}.',
-                               from: symlink_path.relative_path_from(module_path), to: symlink_path.realpath.relative_path_from(module_path))
-      end
-
-      # Checks if the path length will fit into the POSIX.1-1998 (ustar) tar
-      # header format.
-      #
-      # POSIX.1-2001 (which allows paths of infinite length) was adopted by GNU
-      # tar in 2004 and is supported by minitar 0.7 and above. Unfortunately
-      # much of the Puppet ecosystem still uses minitar 0.6.1.
-      #
-      # POSIX.1-1998 tar format does not allow for paths greater than 256 bytes,
-      # or paths that can't be split into a prefix of 155 bytes (max) and
-      # a suffix of 100 bytes (max).
-      #
-      # This logic was pretty much copied from the private method
-      # {Archive::Tar::Minitar::Writer#split_name}.
-      #
-      # @param path [String] the relative path to be added to the tar file.
-      #
-      # @raise [ArgumentError] if the path is too long or could not be split.
-      #
-      # @return [nil]
-      def validate_ustar_path!(path)
-        raise ArgumentError, format("The path '%{path}' is longer than 256 bytes.", path: path) if path.bytesize > 256
-
-        if path.bytesize <= 100
-          prefix = ''
-        else
-          parts = path.split(File::SEPARATOR)
-          newpath = parts.pop
-          nxt = ''
-
-          loop do
-            nxt = parts.pop || ''
-            break if newpath.bytesize + 1 + nxt.bytesize >= 100
-
-            newpath = File.join(nxt, newpath)
-          end
-
-          prefix = File.join(*parts, nxt)
-          path = newpath
-        end
-
-        return unless path.bytesize > 100 || prefix.bytesize > 155
-
-        raise ArgumentError,
-              format("'%{path}' could not be split at a directory separator into two " \
-                     'parts, the first having a maximum length of 155 bytes and the ' \
-                     'second having a maximum length of 100 bytes.', path: path)
-      end
-
-      # Checks if the path contains any non-ASCII characters.
-      #
-      # Java will throw an error when it encounters a path containing
-      # characters that are not supported by the hosts locale. In order to
-      # maximise compatibility we limit the paths to contain only ASCII
-      # characters, which should be part of any locale character set.
-      #
-      # @param path [String] the relative path to be added to the tar file.
-      #
-      # @raise [ArgumentError] if the path contains non-ASCII characters.
-      #
-      # @return [nil]
-      def validate_path_encoding!(path)
-        return unless /[^\x00-\x7F]/.match?(path)
-
-        raise ArgumentError, format("'%{path}' can only include ASCII characters in its path or " \
-                                    'filename in order to be compatible with a wide range of hosts.', path: path)
-      end
-
-      # Creates a gzip compressed tarball of the build directory.
-      #
-      # If the destination package already exists, it will be removed before
-      # creating the new tarball.
-      #
-      # @return nil.
-      def build_package
-        require 'zlib'
-        require 'minitar'
-        require 'find'
-
-        PDK::Util::Filesystem.rm_f(package_file)
-
-        Dir.chdir(target_dir) do
-          gz = Zlib::GzipWriter.new(File.open(package_file, 'wb')) # rubocop:disable PDK/FileOpen
-          tar = Minitar::Output.new(gz)
-          Find.find(release_name) do |entry|
-            entry_meta = {
-              name: entry
-            }
-
-            orig_mode = PDK::Util::Filesystem.stat(entry).mode
-            min_mode = Minitar.dir?(entry) ? 0o755 : 0o644
-
-            entry_meta[:mode] = orig_mode | min_mode
-
-            PDK.logger.debug(format('Updated permissions of packaged \'%{entry}\' to %{new_mode}', entry: entry, new_mode: (entry_meta[:mode] & 0o7777).to_s(8))) if entry_meta[:mode] != orig_mode
-
-            Minitar.pack_file(entry_meta, tar)
-          end
-        ensure
-          tar.close
-        end
-      end
-
-      # Select the most appropriate ignore file in the module directory.
-      #
-      # In order of preference, we first try `.pdkignore`, then `.pmtignore`
-      # and finally `.gitignore`.
-      #
-      # @return [String] The path to the file containing the patterns of file
-      #   paths to ignore.
-      def ignore_file
-        @ignore_file ||= [
-          File.join(module_dir, '.pdkignore'),
-          File.join(module_dir, '.pmtignore'),
-          File.join(module_dir, '.gitignore')
-        ].find { |file| PDK::Util::Filesystem.file?(file) && PDK::Util::Filesystem.readable?(file) }
-      end
-
-      # Instantiate a new PathSpec class and populate it with the pattern(s) of
-      # files to be ignored.
-      #
-      # @return [PathSpec] The populated ignore path matcher.
-      def ignored_files
-        require 'pdk/module'
-        require 'pathspec'
-
-        @ignored_files ||=
-          begin
-            ignored = if ignore_file.nil?
-                        PathSpec.new
-                      else
-                        PathSpec.new(PDK::Util::Filesystem.read_file(ignore_file, open_args: 'rb:UTF-8'))
-                      end
-
-            ignored = ignored.add("/#{File.basename(target_dir)}/") if File.realdirpath(target_dir).start_with?(File.realdirpath(module_dir))
-
-            PDK::Module::DEFAULT_IGNORED.each { |r| ignored.add(r) }
-
-            ignored
-          end
-      end
-    end
-  end
-end

data/lib/pdk/monkey_patches.rb

@@ -1,268 +0,0 @@
-# frozen_string_literal: true
-
-module OS
-  # Os detection: Are we on Windows?
-  def self.windows?
-    (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
-  end
-end
-
-# Patch childprocess so that it is Ruby 3 compliant.
-# This could be removed if the following PR is ever merged
-# and released:
-# https://github.com/enkessler/childprocess/pull/185
-module ChildProcess
-  class << self
-    def build(*args)
-      case os
-      when :macosx, :linux, :solaris, :bsd, :cygwin, :aix
-        if posix_spawn?
-          Unix::PosixSpawnProcess.new(*args)
-        elsif jruby?
-          JRuby::Process.new(*args)
-        else
-          Unix::ForkExecProcess.new(*args)
-        end
-      when :windows
-        Windows::Process.new(*args)
-      else
-        raise Error, "unsupported platform #{platform_name.inspect}"
-      end
-    end
-  end
-
-  class AbstractProcess
-    def initialize(*args)
-      raise ArgumentError, "all arguments must be String: #{args.inspect}" unless args.all?(String)
-
-      @args        = args
-      @started     = false
-      @exit_code   = nil
-      @io          = nil
-      @cwd         = nil
-      @detach      = false
-      @duplex      = false
-      @leader      = false
-      @environment = {}
-    end
-  end
-
-  if OS.windows?
-    module Windows
-      module Lib
-        extend FFI::Library
-        def self.msvcrt_name
-          RbConfig::CONFIG['RUBY_SO_NAME'][/msvc\w+/] || 'ucrtbase'
-        end
-
-        ffi_lib 'kernel32', msvcrt_name
-        ffi_convention :stdcall
-
-        # We have to redefine the function declarations so that they are available
-        # with the patched ffi_lib.
-        enum :wait_status, [
-          :wait_object_0,  0, # rubocop:disable Naming/VariableNumber
-          :wait_timeout,   0x102,
-          :wait_abandoned, 0x80,
-          :wait_failed,    0xFFFFFFFF
-        ]
-
-        #
-        # BOOL WINAPI CreateProcess(
-        #   __in_opt     LPCTSTR lpApplicationName,
-        #   __inout_opt  LPTSTR lpCommandLine,
-        #   __in_opt     LPSECURITY_ATTRIBUTES lpProcessAttributes,
-        #   __in_opt     LPSECURITY_ATTRIBUTES lpThreadAttributes,
-        #   __in         BOOL bInheritHandles,
-        #   __in         DWORD dwCreationFlags,
-        #   __in_opt     LPVOID lpEnvironment,
-        #   __in_opt     LPCTSTR lpCurrentDirectory,
-        #   __in         LPSTARTUPINFO lpStartupInfo,
-        #   __out        LPPROCESS_INFORMATION lpProcessInformation
-        # );
-        #
-
-        attach_function :create_process, :CreateProcessW, [
-          :pointer,
-          :buffer_inout,
-          :pointer,
-          :pointer,
-          :bool,
-          :ulong,
-          :pointer,
-          :pointer,
-          :pointer,
-          :pointer
-        ], :bool
-
-        #
-        #   DWORD WINAPI FormatMessage(
-        #   __in      DWORD dwFlags,
-        #   __in_opt  LPCVOID lpSource,
-        #   __in      DWORD dwMessageId,
-        #   __in      DWORD dwLanguageId,
-        #   __out     LPTSTR lpBuffer,
-        #   __in      DWORD nSize,
-        #   __in_opt  va_list *Arguments
-        # );
-        #
-
-        attach_function :format_message, :FormatMessageA, [
-          :ulong,
-          :pointer,
-          :ulong,
-          :ulong,
-          :pointer,
-          :ulong,
-          :pointer
-        ], :ulong
-
-        attach_function :close_handle, :CloseHandle, [:pointer], :bool
-
-        #
-        # HANDLE WINAPI OpenProcess(
-        #   __in  DWORD dwDesiredAccess,
-        #   __in  BOOL bInheritHandle,
-        #   __in  DWORD dwProcessId
-        # );
-        #
-
-        attach_function :open_process, :OpenProcess, [:ulong, :bool, :ulong], :pointer
-
-        #
-        # HANDLE WINAPI CreateJobObject(
-        #   _In_opt_  LPSECURITY_ATTRIBUTES lpJobAttributes,
-        #   _In_opt_  LPCTSTR lpName
-        # );
-        #
-
-        attach_function :create_job_object, :CreateJobObjectA, [:pointer, :pointer], :pointer
-
-        #
-        # BOOL WINAPI AssignProcessToJobObject(
-        #   _In_  HANDLE hJob,
-        #   _In_  HANDLE hProcess
-        # );
-
-        attach_function :assign_process_to_job_object, :AssignProcessToJobObject, [:pointer, :pointer], :bool
-
-        #
-        # BOOL WINAPI SetInformationJobObject(
-        #   _In_  HANDLE hJob,
-        #   _In_  JOBOBJECTINFOCLASS JobObjectInfoClass,
-        #   _In_  LPVOID lpJobObjectInfo,
-        #   _In_  DWORD cbJobObjectInfoLength
-        # );
-        #
-
-        attach_function :set_information_job_object, :SetInformationJobObject, [:pointer, :int, :pointer, :ulong], :bool
-
-        #
-        #
-        # DWORD WINAPI WaitForSingleObject(
-        #   __in  HANDLE hHandle,
-        #   __in  DWORD dwMilliseconds
-        # );
-        #
-
-        attach_function :wait_for_single_object, :WaitForSingleObject, [:pointer, :ulong], :wait_status, blocking: true
-
-        #
-        # BOOL WINAPI GetExitCodeProcess(
-        #   __in   HANDLE hProcess,
-        #   __out  LPDWORD lpExitCode
-        # );
-        #
-
-        attach_function :get_exit_code, :GetExitCodeProcess, [:pointer, :pointer], :bool
-
-        #
-        # BOOL WINAPI GenerateConsoleCtrlEvent(
-        #   __in  DWORD dwCtrlEvent,
-        #   __in  DWORD dwProcessGroupId
-        # );
-        #
-
-        attach_function :generate_console_ctrl_event, :GenerateConsoleCtrlEvent, [:ulong, :ulong], :bool
-
-        #
-        # BOOL WINAPI TerminateProcess(
-        #   __in  HANDLE hProcess,
-        #   __in  UINT uExitCode
-        # );
-        #
-
-        attach_function :terminate_process, :TerminateProcess, [:pointer, :uint], :bool
-
-        #
-        # intptr_t _get_osfhandle(
-        #    int fd
-        # );
-        #
-
-        attach_function :get_osfhandle, :_get_osfhandle, [:int], :intptr_t
-
-        #
-        # int _open_osfhandle (
-        #    intptr_t osfhandle,
-        #    int flags
-        # );
-        #
-
-        attach_function :open_osfhandle, :_open_osfhandle, [:pointer, :int], :int
-
-        # BOOL WINAPI SetHandleInformation(
-        #   __in  HANDLE hObject,
-        #   __in  DWORD dwMask,
-        #   __in  DWORD dwFlags
-        # );
-
-        attach_function :set_handle_information, :SetHandleInformation, [:pointer, :ulong, :ulong], :bool
-
-        # BOOL WINAPI GetHandleInformation(
-        #   __in   HANDLE hObject,
-        #   __out  LPDWORD lpdwFlags
-        # );
-
-        attach_function :get_handle_information, :GetHandleInformation, [:pointer, :pointer], :bool
-
-        # BOOL WINAPI CreatePipe(
-        #   __out     PHANDLE hReadPipe,
-        #   __out     PHANDLE hWritePipe,
-        #   __in_opt  LPSECURITY_ATTRIBUTES lpPipeAttributes,
-        #   __in      DWORD nSize
-        # );
-
-        attach_function :create_pipe, :CreatePipe, [:pointer, :pointer, :pointer, :ulong], :bool
-
-        #
-        # HANDLE WINAPI GetCurrentProcess(void);
-        #
-
-        attach_function :current_process, :GetCurrentProcess, [], :pointer
-
-        #
-        # BOOL WINAPI DuplicateHandle(
-        #   __in   HANDLE hSourceProcessHandle,
-        #   __in   HANDLE hSourceHandle,
-        #   __in   HANDLE hTargetProcessHandle,
-        #   __out  LPHANDLE lpTargetHandle,
-        #   __in   DWORD dwDesiredAccess,
-        #   __in   BOOL bInheritHandle,
-        #   __in   DWORD dwOptions
-        # );
-        #
-
-        attach_function :_duplicate_handle, :DuplicateHandle, [
-          :pointer,
-          :pointer,
-          :pointer,
-          :pointer,
-          :ulong,
-          :bool,
-          :ulong
-        ], :bool
-      end
-    end
-  end
-end