pdk 2.7.1 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ff7ec7444ab1a8f6876541359c945180230d9a1b0d6d1496ca012a974f33f4e
-  data.tar.gz: e35b850c844aa4fbb02236f080491b67a020fa52c76ead9a124b5974bb53ecc4
+  metadata.gz: c39902d0ebbac37358fd3fccf5de760b47f77860054b08864ccdae63150b7597
+  data.tar.gz: 6a4d8beb3013edf1ed946b9cf94cd90b055ad63500102e131734600c81c3a5a5
 SHA512:
-  metadata.gz: 3bc285deba8e2655836f16ddb7e8a121ab06e8e7b3c1ef8988332d605dd60ed95da7bc22f1a23e23ccd6059e913962307d9f6459ff563a5a601cb3b22bb0d99e
-  data.tar.gz: '0419acc5d19400b8908e7fc44b2361159d64ff24a7a328b87400994df9a30276f3bfac1c8dff77e1c6630df0643e8c8e42a205510288392bbd67f27a90e35498'
+  metadata.gz: 7af78ce8b0c4bb9122081a2c6449d862da04c9fec85d428b2e8ace3e88a74930fcf809462062b07994307c54c3ee5a827a83ae26e5c67b95f659c3f5c0cb89b5
+  data.tar.gz: c5af71c375d94c9e22f4c7ae284213a39aaa87b8bc21980580ce4e79743979d4cbb967f330c775dcd2ebc4d3046c4c9c5080480172e07dec33afd9546b94da7e

data/CHANGELOG.md

@@ -5,6 +5,42 @@ 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.0.1](https://github.com/puppetlabs/pdk/tree/v3.0.1) - 2023-12-07
+
+[Full Changelog](https://github.com/puppetlabs/pdk/compare/v3.0.0...v3.0.1)
+
+### Fixed
+
+- (CAT-345) Update doc links where needed [#1285](https://github.com/puppetlabs/pdk/pull/1285) ([david22swan](https://github.com/david22swan))
+- (CAT-270) Adjusting expected Puppet/Ruby versions [#1283](https://github.com/puppetlabs/pdk/pull/1283) ([LukasAud](https://github.com/LukasAud))
+- (maint) - add stricter puppetlabs_spec_helper dependency [#1280](https://github.com/puppetlabs/pdk/pull/1280) ([jordanbreen28](https://github.com/jordanbreen28))
+- (PUPDOC-5439) Add Trademark icon [#1277](https://github.com/puppetlabs/pdk/pull/1277) ([pmcmaw](https://github.com/pmcmaw))
+
+## [v3.0.0](https://github.com/puppetlabs/pdk/tree/v3.0.0) - 2023-07-04
+
+[Full Changelog](https://github.com/puppetlabs/pdk/compare/v2.7.1...v3.0.0)
+
+### Changed
+- (CONT-1134) Bump PDK Templates REF [#1264](https://github.com/puppetlabs/pdk/pull/1264) ([chelnak](https://github.com/chelnak))
+- (CONT-1154) Disable console command [#1263](https://github.com/puppetlabs/pdk/pull/1263) ([chelnak](https://github.com/chelnak))
+- (CONT-1130) Bump PDK gem version [#1260](https://github.com/puppetlabs/pdk/pull/1260) ([chelnak](https://github.com/chelnak))
+- (CONT-1027) Deprecate pe-version option [#1252](https://github.com/puppetlabs/pdk/pull/1252) ([chelnak](https://github.com/chelnak))
+- (CONT-1025) Remove module command [#1250](https://github.com/puppetlabs/pdk/pull/1250) ([chelnak](https://github.com/chelnak))
+- (CONT-1024) Remove config command [#1249](https://github.com/puppetlabs/pdk/pull/1249) ([chelnak](https://github.com/chelnak))
+- (CONT-755) - Bump gem version [#1240](https://github.com/puppetlabs/pdk/pull/1240) ([chelnak](https://github.com/chelnak))
+- (CONT-755) Ruby 3 / Puppet 8 support [#1230](https://github.com/puppetlabs/pdk/pull/1230) ([chelnak](https://github.com/chelnak))
+
+### Added
+
+- (CONT-1053) Update bundle command [#1255](https://github.com/puppetlabs/pdk/pull/1255) ([chelnak](https://github.com/chelnak))
+- (ISS-1123) Verbose output w/ junit file [#1246](https://github.com/puppetlabs/pdk/pull/1246) ([coreymbe](https://github.com/coreymbe))
+- Take "operatingsystem_support" parameter from answer.json [#1165](https://github.com/puppetlabs/pdk/pull/1165) ([me-minus](https://github.com/me-minus))
+
+### Fixed
+
+- (CONT-1069) Update compatibility handling [#1259](https://github.com/puppetlabs/pdk/pull/1259) ([chelnak](https://github.com/chelnak))
+- (CONT-935) Fix issues with PDK package and tests [#1248](https://github.com/puppetlabs/pdk/pull/1248) ([chelnak](https://github.com/chelnak))
+
 ## [v2.7.1](https://github.com/puppetlabs/pdk/tree/v2.7.1) - 2023-03-24
 
 [Full Changelog](https://github.com/puppetlabs/pdk/compare/v2.7.0...v2.7.1)

data/README.md

@@ -1,6 +1,8 @@
 # pdk
 
-[![ci](https://github.com/puppetlabs/pdk/actions/workflows/ci.yml/badge.svg)](https://github.com/puppetlabs/pdk/actions/workflows/ci.yml) [![Gem Version](https://badge.fury.io/rb/pdk.svg)](https://badge.fury.io/rb/pdk)
+[![Code Owners](https://img.shields.io/badge/owners-DevX--team-blue)](https://github.com/puppetlabs/pdk/blob/main/CODEOWNERS)
+[![ci](https://github.com/puppetlabs/pdk/actions/workflows/ci.yml/badge.svg)](https://github.com/puppetlabs/pdk/actions/workflows/ci.yml) 
+[![Gem Version](https://badge.fury.io/rb/pdk.svg)](https://badge.fury.io/rb/pdk)
 
 * [Installation](#installation)
 * [Basic usage](#basic-usage)
@@ -20,7 +22,6 @@ PDK includes the following tools:
 |facterdb|A gem that contains facts for Operating Systems.| N |
 |metadata-json-lint|Validates and lints `metadata.json` files in modules against Puppet module metadata style guidelines.| N |
 |pdk|Tool to generate and test modules and module content, such as classes, from the command line.| Y |
-|puppet-debugger|Provides a REPL based debugger console.| N |
 |puppet-lint|Checks your Puppet code against the recommendations in the Puppet language style guide.| Y |
 |puppet-syntax|Checks for correct syntax in Puppet manifests, templates, and Hiera YAML.| N |
 |puppetlabs_spec_helper|Provides classes, methods, and Rake tasks to help with spec testing Puppet code.| Y |
@@ -97,7 +98,7 @@ This command validates the metadata, Puppet code syntax and style, and Ruby synt
 
 ### Run unit tests
 
-PDK's [default template](https://github.com/puppetlabs/pdk-templates) sets up [rspec](http://rspec.info/) for Ruby-level unit testing, and [rspec-puppet](https://github.com/rodjek/rspec-puppet/) for catalog-level unit testing.
+PDK's [default template](https://github.com/puppetlabs/pdk-templates) sets up [rspec](http://rspec.info/) for Ruby-level unit testing, and [rspec-puppet](https://github.com/puppetlabs/rspec-puppet/) for catalog-level unit testing.
 
 In the module's directory, run unit tests with:
 
@@ -107,52 +108,6 @@ pdk test unit
 
 This command runs all available unit tests.
 
-## Experimental features
-
-### `pdk console` command
-The pdk console command executes a session of the puppet debugger when inside a module and allows for exploration of puppet code.  See the official [puppet debugger site](https://www.puppet-debugger.com) for more info and the official docs [site here.](https://docs.puppet-debugger.com)
-
-To use, execute `pdk console` from inside your module directory.  You can also supply the `--puppet-version` or `--pe-version` or `--puppet-dev` to swap out the puppet version when using the console.
-
-Example (from within a module):
-
-* `pdk console --puppet-version=5`
-* `pdk console --pe-version=2018.1`
-
-The `pdk console` command will also pass through any puppet debugger arguments you wish to use.
-
-Example:
-
-* `pdk console  --no-facterdb`
-* `pdk console --play https://gist.github.com/logicminds/4f6bcfd723c92aad1f01f6a800319fa4`
-* `pdk console -e "md5('sdfasdfasdf')" --run-once --quiet`
-
-Use `pdk console -h` for a further explanation of pass through arguments.
-
-If you receive the following error you do not have the puppet-debugger gem installed.
-
-```
-pdk console -h
-Error: Unknown Puppet subcommand 'debugger'
-See 'puppet help' for help on available puppet subcommands
-```
-
-To fix this you will need to add the following entry to your .sync.yml file and run pdk update:
-
-```
-Gemfile:
-  required:
-    ":development":
-      - gem: puppet-debugger
-        version: "~> 0.14"
-```  
-
-**NOTE**: The puppet-debugger gem has been added to the [puppet-module-* gems](https://github.com/puppetlabs/puppet-module-gems/pull/117), so once you get the gem update you no longer need the .sync.yml entry.
-
-### `pdk bundle` command
-
-This command executes arbitrary commands in a bundler context within the module you're currently working on. Arguments to this command are passed straight through to bundler. This command is experimental  and can lead to errors that can't be resolved by PDK itself.
-
 ## Module Compatibility
 
 **PDK Version Compatibility:** Modules created with PDK validate against and run on all Puppet and Ruby version combinations currently under maintenance (see https://docs.puppet.com/puppet/latest/about_agent.html and https://puppet.com/misc/puppet-enterprise-lifecycle)
@@ -161,6 +116,11 @@ This command executes arbitrary commands in a bundler context within the module
 
 PDK encourages community contributions. See the [CONTRIBUTING.md](CONTRIBUTING.md) file for development notes.
 
+## License
+
+This codebase is licensed under Apache 2.0. However, the open source dependencies included in this codebase might be subject to other software licenses such as AGPL, GPL2.0, and MIT.
+
 ## Contact Information
 
-To contact us with questions: [pdk-maintainers@puppet.com](mailto:pdk-maintainers@puppet.com)
+* [For reporting bugs](https://github.com/puppetlabs/pdk/blob/main/CONTRIBUTING.md#reporting-bugs)
+* To contact us with questions, [join the Puppet Community on Slack](https://slack.puppet.com/)

data/lib/pdk/analytics/client/google_analytics.rb

@@ -8,18 +8,13 @@ module PDK
         TRACKING_URL      = 'https://google-analytics.com/collect'.freeze
         CUSTOM_DIMENSIONS = {
           operating_system: :cd1,
-          output_format:    :cd2,
-          ruby_version:     :cd3,
-          cli_options:      :cd4,
-          env_vars:         :cd5,
+          output_format: :cd2,
+          ruby_version: :cd3,
+          cli_options: :cd4,
+          env_vars: :cd5
         }.freeze
 
-        attr_reader :user_id
-        attr_reader :logger
-        attr_reader :app_name
-        attr_reader :app_id
-        attr_reader :app_version
-        attr_reader :app_installer
+        attr_reader :user_id, :logger, :app_name, :app_id, :app_version, :app_installer
 
         def initialize(opts)
           # lazy-load expensive gem code
@@ -42,14 +37,14 @@ module PDK
 
         def screen_view(screen, **kwargs)
           custom_dimensions = walk_keys(kwargs) do |k|
-            CUSTOM_DIMENSIONS[k] || raise("Unknown analytics key '%{key}'" % { key: k })
+            CUSTOM_DIMENSIONS[k] || raise(format("Unknown analytics key '%{key}'", key: k))
           end
 
           screen_view_params = {
             # Type
-            t:  'screenview',
+            t: 'screenview',
             # Screen Name
-            cd: screen,
+            cd: screen
           }.merge(custom_dimensions)
 
           submit(base_params.merge(screen_view_params))
@@ -57,16 +52,16 @@ module PDK
 
         def event(category, action, label: nil, value: nil, **kwargs)
           custom_dimensions = walk_keys(kwargs) do |k|
-            CUSTOM_DIMENSIONS[k] || raise("Unknown analytics key '%{key}'" % { key: k })
+            CUSTOM_DIMENSIONS[k] || raise(format("Unknown analytics key '%{key}'", key: k))
           end
 
           event_params = {
             # Type
-            t:  'event',
+            t: 'event',
             # Event Category
             ec: category,
             # Event Action
-            ea: action,
+            ea: action
           }.merge(custom_dimensions)
 
           # Event Label
@@ -95,23 +90,23 @@ module PDK
           require 'locale'
 
           {
-            v:    PROTOCOL_VERSION,
+            v: PROTOCOL_VERSION,
             # Client ID
-            cid:  user_id,
+            cid: user_id,
             # Tracking ID
-            tid:  app_id,
+            tid: app_id,
             # Application Name
-            an:   app_name,
+            an: app_name,
             # Application Version
-            av:   app_version,
+            av: app_version,
             # Application Installer ID
             aiid: app_installer,
             # Anonymize IPs
-            aip:  true,
+            aip: true,
             # User locale
-            ul:   Locale.current.to_rfc,
+            ul: Locale.current.to_rfc,
             # Custom Dimension 1 (Operating System)
-            cd1:  @os.value,
+            cd1: @os.value
           }
         end
 
@@ -128,12 +123,13 @@ module PDK
         private
 
         def walk_keys(data, &block)
-          if data.is_a?(Hash)
+          case data
+          when Hash
             data.each_with_object({}) do |(k, v), acc|
               v = walk_keys(v, &block)
               acc[yield(k)] = v
             end
-          elsif data.is_a?(Array)
+          when Array
             data.map { |v| walk_keys(v, &block) }
           else
             data

data/lib/pdk/analytics/util.rb

@@ -8,7 +8,6 @@ module PDK
         require 'concurrent/future'
 
         Concurrent::Future.execute(executor: :io) do
-          require 'facter'
           os = Facter.value('os')
 
           os.nil? ? 'unknown' : "#{os['name']} #{os.fetch('release', {}).fetch('major', '')}".strip

data/lib/pdk/analytics.rb

@@ -12,7 +12,7 @@ module PDK
     end
 
     def self.build_client(opts = {})
-      opts[:logger] ||= ::Logger.new(STDERR)
+      opts[:logger] ||= ::Logger.new($stderr)
       opts[:client] ||= :noop
 
       if opts[:disabled]

data/lib/pdk/bolt.rb

@@ -12,6 +12,7 @@ module PDK
     #
     def bolt_project_root?(path = Dir.pwd)
       return true if File.basename(path) == 'Boltdir' && PDK::Util::Filesystem.directory?(path)
+
       PDK::Util::Filesystem.file?(File.join(path, 'bolt.yaml'))
     end
     module_function :bolt_project_root?

data/lib/pdk/cli/build.rb

@@ -1,78 +1,75 @@
-module PDK::CLI
-  @build_cmd = @base_cmd.define_command do
-    name 'build'
-    usage 'build [options]'
-    summary 'Builds a package from the module that can be published to the Puppet Forge.'
+module PDK
+  module CLI
+    @build_cmd = @base_cmd.define_command do
+      name 'build'
+      usage 'build [options]'
+      summary 'Builds a package from the module that can be published to the Puppet Forge.'
 
-    option nil, 'target-dir',
-           'The target directory where you want PDK to write the package.',
-           argument: :required, default: File.join(Dir.pwd, 'pkg')
+      option nil, 'target-dir',
+             'The target directory where you want PDK to write the package.',
+             argument: :required, default: File.join(Dir.pwd, 'pkg')
 
-    option nil, 'force', 'Skips the prompts and builds the module package.'
+      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'
+      run do |opts, _args, _cmd|
+        require 'pdk/module/build'
+        require 'pdk/module/metadata'
+        require 'pdk/cli/util'
 
-      # Make sure build is being run in a valid module directory with a metadata.json
-      PDK::CLI::Util.ensure_in_module!(
-        message:   '`pdk build` can only be run from inside a valid module with a metadata.json.',
-        log_level: :info,
-      )
+        # Make sure build is being run in a valid module directory with a metadata.json
+        PDK::CLI::Util.ensure_in_module!(
+          message: '`pdk build` can only be run from inside a valid module with a metadata.json.',
+          log_level: :info
+        )
 
-      PDK::CLI::Util.analytics_screen_view('build', opts)
+        PDK::CLI::Util.analytics_screen_view('build', opts)
 
-      module_metadata = PDK::Module::Metadata.from_file('metadata.json')
+        module_metadata = PDK::Module::Metadata.from_file('metadata.json')
 
-      # TODO: Ensure forge metadata has been set, or call out to interview
-      #       to set it.
-      #
-      unless module_metadata.forge_ready?
-        if opts[:force]
-          PDK.logger.warn "This module is missing the following fields in the metadata.json: #{module_metadata.missing_fields.join(', ')}. " \
-                          'These missing fields may affect the visibility of the module on the Forge.'
-        else
-          module_metadata.interview_for_forge!
-          module_metadata.write!('metadata.json')
+        # TODO: Ensure forge metadata has been set, or call out to interview
+        #       to set it.
+        #
+        unless module_metadata.forge_ready?
+          if opts[:force]
+            PDK.logger.warn "This module is missing the following fields in the metadata.json: #{module_metadata.missing_fields.join(', ')}. " \
+                            'These missing fields may affect the visibility of the module on the Forge.'
+          else
+            module_metadata.interview_for_forge!
+            module_metadata.write!('metadata.json')
+          end
         end
-      end
 
-      builder = PDK::Module::Build.new(opts)
+        builder = PDK::Module::Build.new(opts)
 
-      unless opts[:force]
-        if builder.package_already_exists?
-          PDK.logger.info "The file '%{package}' already exists." % { package: builder.package_file }
+        unless opts[:force]
+          if builder.package_already_exists?
+            PDK.logger.info format("The file '%{package}' already exists.", package: builder.package_file)
 
-          unless PDK::CLI::Util.prompt_for_yes('Overwrite?', default: false)
-            PDK.logger.info 'Build cancelled; exiting.'
-            exit 0
+            unless PDK::CLI::Util.prompt_for_yes('Overwrite?', default: false)
+              PDK.logger.info 'Build cancelled; exiting.'
+              exit 0
+            end
           end
-        end
 
-        unless builder.module_pdk_compatible?
-          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`.'
+          unless builder.module_pdk_compatible?
+            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`.'
 
-          unless PDK::CLI::Util.prompt_for_yes('Continue build without converting?')
-            PDK.logger.info 'Build cancelled; exiting.'
-            exit 0
+            unless PDK::CLI::Util.prompt_for_yes('Continue build without converting?')
+              PDK.logger.info 'Build cancelled; exiting.'
+              exit 0
+            end
           end
         end
-      end
 
-      PDK.logger.info 'Building %{module_name} version %{module_version}' % {
-        module_name:    module_metadata.data['name'],
-        module_version: module_metadata.data['version'],
-      }
+        PDK.logger.info format('Building %{module_name} version %{module_version}', module_name: module_metadata.data['name'], module_version: module_metadata.data['version'])
 
-      builder.build
+        builder.build
 
-      PDK.logger.info 'Build of %{package_name} has completed successfully. Built package can be found here: %{package_path}' % {
-        package_name: module_metadata.data['name'],
-        package_path: builder.package_file,
-      }
+        PDK.logger.info format('Build of %{package_name} has completed successfully. Built package can be found here: %{package_path}', package_name: module_metadata.data['name'],
+                                                                                                                                        package_path: builder.package_file)
+      end
     end
   end
 end

data/lib/pdk/cli/bundle.rb

@@ -1,47 +1,48 @@
-module PDK::CLI
-  @bundle_cmd = @base_cmd.define_command do
-    name 'bundle'
-    usage 'bundle [bundler_options]'
-    summary '(Experimental) Command pass-through to bundler'
-    description <<-EOF
-[experimental] For advanced users, pdk bundle runs arbitrary commands in the bundler environment that pdk manages.
-Careless use of this command can lead to errors that pdk can't help recover from.
-EOF
-    skip_option_parsing
+module PDK
+  module CLI
+    @bundle_cmd = @base_cmd.define_command do
+      name 'bundle'
+      usage 'bundle [bundler_options]'
+      summary 'Command pass-through to bundler'
+      description <<~EOF
+        For advanced users, pdk bundle runs arbitrary commands in the bundler environment that pdk manages.
+        Careless use of this command can lead to errors that pdk can't help recover from.
+      EOF
+      skip_option_parsing
 
-    run do |_opts, args, _cmd|
-      require 'pdk/cli/exec/interactive_command'
-      require 'pdk/util/bundler'
+      run do |_opts, args, _cmd|
+        require 'pdk/util/bundler'
 
-      PDK::CLI::Util.ensure_in_module!(
-        message: '`pdk bundle` can only be run from inside a valid module directory.',
-      )
+        PDK::CLI::Util.ensure_in_module!(
+          message: '`pdk bundle` can only be run from inside a valid module directory.'
+        )
 
-      PDK::CLI::Util.validate_puppet_version_opts({})
+        PDK::CLI::Util.validate_puppet_version_opts({})
 
-      screen_view_name = ['bundle']
-      screen_view_name << args[0] if args.size >= 1
-      screen_view_name << args[1] if args.size >= 2 && args[0] == 'exec'
+        screen_view_name = ['bundle']
+        screen_view_name << args[0] if args.size >= 1
+        screen_view_name << args[1] if args.size >= 2 && args[0] == 'exec'
 
-      PDK::CLI::Util.analytics_screen_view(screen_view_name.join('_'))
+        PDK::CLI::Util.analytics_screen_view(screen_view_name.join('_'))
 
-      # Ensure that the correct Ruby is activated before running command.
-      puppet_env = PDK::CLI::Util.puppet_from_opts_or_env({})
-      PDK::Util::RubyVersion.use(puppet_env[:ruby_version])
+        # Ensure that the correct Ruby is activated before running command.
+        puppet_env = PDK::CLI::Util.puppet_from_opts_or_env({})
+        PDK::Util::RubyVersion.use(puppet_env[:ruby_version])
 
-      gemfile_env = PDK::Util::Bundler::BundleHelper.gemfile_env(puppet_env[:gemset])
+        gemfile_env = PDK::Util::Bundler::BundleHelper.gemfile_env(puppet_env[:gemset])
 
-      require 'pdk/cli/exec'
-      require 'pdk/cli/exec/interactive_command'
+        require 'pdk/cli/exec'
+        require 'pdk/cli/exec/interactive_command'
 
-      command = PDK::CLI::Exec::InteractiveCommand.new(PDK::CLI::Exec.bundle_bin, *args).tap do |c|
-        c.context = :pwd
-        c.update_environment(gemfile_env)
-      end
+        command = PDK::CLI::Exec::InteractiveCommand.new(PDK::CLI::Exec.bundle_bin, *args).tap do |c|
+          c.context = :pwd
+          c.update_environment(gemfile_env)
+        end
 
-      result = command.execute!
+        result = command.execute!
 
-      exit result[:exit_code]
+        exit result[:exit_code]
+      end
     end
   end
 end