Merge pull request #814 from puppetlabs/PA-7820/main/pdk-update

Update to PDK template 3.5.1

Author: mhashizume

.gitignore

@@ -19,10 +19,17 @@
 /spec/fixtures/modules/*
 /tmp/
 /vendor/
+/.vendor/
 /convert_report.txt
 /update_report.txt
 .DS_Store
 .project
 .envrc
 /inventory.yaml
 /spec/fixtures/litmus_inventory.yaml
+.resource_types
+.modules
+.task_cache.json
+.plan_cache.json
+.rerun.json
+bolt-debug.log

.pdkignore

@@ -19,13 +19,20 @@
 /spec/fixtures/modules/*
 /tmp/
 /vendor/
+/.vendor/
 /convert_report.txt
 /update_report.txt
 .DS_Store
 .project
 .envrc
 /inventory.yaml
 /spec/fixtures/litmus_inventory.yaml
+.resource_types
+.modules
+.task_cache.json
+.plan_cache.json
+.rerun.json
+bolt-debug.log
 /.fixtures.yml
 /Gemfile
 /.gitattributes

.puppet-lint.rc

@@ -1,2 +1,10 @@
+--fail-on-warnings
 --relative
+--no-80chars-check
+--no-140chars-check
+--no-class_inherits_from_params_class-check
+--no-autoloader_layout-check
+--no-documentation-check
+--no-single_quote_string_with_variables-check
 --no-puppet_url_without_modules-check
+--ignore-paths=.vendor/**/*.pp,.bundle/**/*.pp,pkg/**/*.pp,spec/**/*.pp,tests/**/*.pp,types/**/*.pp,vendor/**/*.pp

.rubocop.yml

@@ -5,7 +5,7 @@ require:
 AllCops:
   NewCops: enable
   DisplayCopNames: true
-  TargetRubyVersion: '2.6'
+  TargetRubyVersion: 3.1
   Include:
   - "**/*.rb"
   Exclude:

.sync.yml

@@ -20,13 +20,12 @@ Gemfile:
         version: '~> 1.0'
       - gem: beaker-hostgenerator
         from_env: BEAKER_HOSTGENERATOR_VERSION
+        version: '~> 2.0'
       - gem: beaker-rspec
         from_env: BEAKER_RSPEC_VERSION
-      # Prevent beaker-puppet from being installed on Ruby > 3.1 until beaker-puppet supports newer Rubies (PA-6136)
       - gem: beaker-puppet
         from_env: BEAKER_PUPPET_VERSION
         version: '~> 4.0'
-        condition: Gem::Requirement.create('< 3.2.0').satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
       - gem: beaker-module_install_helper
       - gem: beaker-puppet_install_helper
       - gem: nokogiri
@@ -41,22 +40,14 @@ Gemfile:
       - gem: 'orchestrator_client'
         version: '< 0.7.1'
         condition: 'ENV["GEM_BOLT"]'
-      - gem: async
-        version: '~> 1.30' # otherwise async 2.0.0(needs ruby >=3.1.0) is wrongly selected by bundler on jenkins while running with ruby 2.7.1
     ":system_tests":
       - gem: voxpupuli-acceptance
         version: '~> 3'
 
-appveyor.yml:
-  delete: true
-.travis.yml:
-  delete: true
 .github/workflows/release.yml:
   unmanaged: false
 .github/workflows/release_prep.yml:
   unmanaged: false
-.gitlab-ci.yml:
-  delete: true
 spec/default_facts.yml:
   delete: true
 spec/spec_helper.rb:

Gemfile

@@ -1,56 +1,82 @@
-source ENV['GEM_SOURCE'] || 'https://rubygems.org'
+# frozen_string_literal: true
 
-def location_for(place_or_version, fake_version = nil)
-  git_url_regex = %r{\A(?<url>(https?|git)[:@][^#]*)(#(?<branch>.*))?}
-  file_url_regex = %r{\Afile:\/\/(?<path>.*)}
+# For puppetcore, set GEM_SOURCE_PUPPETCORE = 'https://rubygems-puppetcore.puppet.com'
+gemsource_default = ENV['GEM_SOURCE'] || 'https://rubygems.org'
+gemsource_puppetcore = if ENV['PUPPET_FORGE_TOKEN']
+  'https://rubygems-puppetcore.puppet.com'
+else
+  ENV['GEM_SOURCE_PUPPETCORE'] || gemsource_default
+end
+source gemsource_default
+
+def location_for(place_or_constraint, fake_constraint = nil, opts = {})
+  git_url_regex  = /\A(?<url>(?:https?|git)[:@][^#]*)(?:#(?<branch>.*))?/
+  file_url_regex = %r{\Afile://(?<path>.*)}
+
+  if place_or_constraint && (git_url = place_or_constraint.match(git_url_regex))
+    # Git source → ignore :source, keep fake_constraint
+    [fake_constraint, { git: git_url[:url], branch: git_url[:branch], require: false }].compact
+
+  elsif place_or_constraint && (file_url = place_or_constraint.match(file_url_regex))
+    # File source → ignore :source, keep fake_constraint or default >= 0
+    [fake_constraint || '>= 0', { path: File.expand_path(file_url[:path]), require: false }]
 
-  if place_or_version && (git_url = place_or_version.match(git_url_regex))
-    [fake_version, { git: git_url[:url], branch: git_url[:branch], require: false }].compact
-  elsif place_or_version && (file_url = place_or_version.match(file_url_regex))
-    ['>= 0', { path: File.expand_path(file_url[:path]), require: false }]
   else
-    [place_or_version, { require: false }]
+    # Plain version constraint → merge opts (including :source if provided)
+    [place_or_constraint, { require: false }.merge(opts)]
+  end
+end
+
+# Print debug information if DEBUG_GEMS or VERBOSE is set
+def print_gem_statement_for(gems)
+  puts 'DEBUG: Gem definitions that will be generated:'
+  gems.each do |gem_name, gem_params|
+    puts "DEBUG:   gem #{([gem_name.inspect] + gem_params.map(&:inspect)).join(', ')}"
   end
 end
 
 group :development do
-  gem "json", '= 2.6.1',                                                       require: false if Gem::Requirement.create(['>= 3.1.0', '< 3.1.3']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
-  gem "json", '= 2.6.3',                                                       require: false if Gem::Requirement.create(['>= 3.2.0', '< 4.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
-  gem "racc", '~> 1.4.0',                                                      require: false if Gem::Requirement.create(['>= 2.7.0', '< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
-  gem "deep_merge", '~> 1.2.2',                                                require: false
-  gem "voxpupuli-puppet-lint-plugins", '~> 5.0',                               require: false
-  gem "facterdb", '~> 1.18',                                                   require: false
-  gem "metadata-json-lint", '~> 4.0',                                          require: false
-  gem "rspec-puppet-facts", '~> 3.0',                                          require: false
-  gem "json-schema", '< 5.1.1',                                                require: false
-  gem "dependency_checker", '~> 1.0.0',                                        require: false
-  gem "parallel_tests", '= 3.12.1',                                            require: false
-  gem "pry", '~> 0.10',                                                        require: false
-  gem "simplecov-console", '~> 0.9',                                           require: false
-  gem "puppet-debugger", '~> 1.6',                                             require: false
-  gem "rubocop", '~> 1.50.0',                                                  require: false
-  gem "rubocop-performance", '= 1.16.0',                                       require: false
-  gem "rubocop-rspec", '= 2.19.0',                                             require: false
-  gem "rb-readline", '= 0.5.5',                                                require: false, platforms: [:mswin, :mingw, :x64_mingw]
+  gem "json", '= 2.6.1',                                                                     require: false if Gem::Requirement.create(['>= 3.1.0', '< 3.1.3']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "json", '= 2.6.3',                                                                     require: false if Gem::Requirement.create(['>= 3.2.0', '< 4.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "racc", '~> 1.4.0',                                                                    require: false if Gem::Requirement.create(['>= 2.7.0', '< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "deep_merge", '~> 1.2.2',                                                              require: false
+  gem "voxpupuli-puppet-lint-plugins", '~> 5.0',                                             require: false
+  gem "facterdb", '~> 2.1',                                                                  require: false if Gem::Requirement.create(['< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "facterdb", '~> 3.0',                                                                  require: false if Gem::Requirement.create(['>= 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "metadata-json-lint", '~> 4.0',                                                        require: false
+  gem "json-schema", '< 5.1.1',                                                              require: false
+  gem "rspec-puppet-facts", '~> 4.0',                                                        require: false if Gem::Requirement.create(['< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "rspec-puppet-facts", '~> 5.0',                                                        require: false if Gem::Requirement.create(['>= 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "dependency_checker", '~> 1.0.0',                                                      require: false
+  gem "parallel_tests", '= 3.12.1',                                                          require: false
+  gem "pry", '~> 0.10',                                                                      require: false
+  gem "simplecov-console", '~> 0.9',                                                         require: false
+  gem "puppet-debugger", '~> 1.6',                                                           require: false
+  gem "rubocop", '~> 1.50.0',                                                                require: false
+  gem "rubocop-performance", '= 1.16.0',                                                     require: false
+  gem "rubocop-rspec", '= 2.19.0',                                                           require: false
+  gem "rb-readline", '= 0.5.5',                                                              require: false, platforms: [:mswin, :mingw, :x64_mingw]
+  gem "bigdecimal", '< 3.2.2',                                                               require: false, platforms: [:mswin, :mingw, :x64_mingw]
   gem "beaker", *location_for(ENV['BEAKER_VERSION'] || '~> 6.0')
   gem "beaker-abs", *location_for(ENV['BEAKER_ABS_VERSION'] || '~> 1.0')
-  gem "beaker-hostgenerator", *location_for(ENV['BEAKER_HOSTGENERATOR_VERSION'] || '~> 2')
+  gem "beaker-hostgenerator", *location_for(ENV['BEAKER_HOSTGENERATOR_VERSION'] || '~> 2.0')
   gem "beaker-rspec"
-  gem "beaker-puppet", *location_for(ENV['BEAKER_PUPPET_VERSION'] || '~> 4.0') if Gem::Requirement.create('< 3.2.0').satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
-  gem "beaker-module_install_helper",                                          require: false
-  gem "beaker-puppet_install_helper",                                          require: false
-  gem "nokogiri",                                                              require: false
-  gem "bolt", '~> 3.0',                                                        require: false if ENV["GEM_BOLT"]
-  gem "beaker-task_helper", '~> 1.9',                                          require: false if ENV["GEM_BOLT"]
-  gem "orchestrator_client", '< 0.7.1',                                        require: false if ENV["GEM_BOLT"]
-  gem "async", '~> 1.30',                                                      require: false
+  gem "beaker-puppet", *location_for(ENV['BEAKER_PUPPET_VERSION'] || '~> 4.0')
+  gem "beaker-module_install_helper",                                                        require: false
+  gem "beaker-puppet_install_helper",                                                        require: false
+  gem "nokogiri",                                                                            require: false
+  gem "bolt", '~> 3.0',                                                                      require: false if ENV["GEM_BOLT"]
+  gem "beaker-task_helper", '~> 1.9',                                                        require: false if ENV["GEM_BOLT"]
+  gem "orchestrator_client", '< 0.7.1',                                                      require: false if ENV["GEM_BOLT"]
 end
 group :development, :release_prep do
   gem "puppet-strings", '~> 4.0',         require: false
   gem "puppetlabs_spec_helper", '~> 8.0', require: false
   gem "puppet-blacksmith", '~> 7.0',      require: false
 end
 group :system_tests do
+  gem "puppet_litmus", '~> 2.0',      require: false, platforms: [:ruby, :x64_mingw] if !ENV['PUPPET_FORGE_TOKEN'].to_s.empty?
+  gem "puppet_litmus", '~> 1.0',      require: false, platforms: [:ruby, :x64_mingw] if ENV['PUPPET_FORGE_TOKEN'].to_s.empty?
   gem "CFPropertyList", '< 3.0.7',    require: false, platforms: [:mswin, :mingw, :x64_mingw]
   gem "serverspec", '~> 2.41',        require: false
   gem "voxpupuli-acceptance", '~> 3', require: false
@@ -61,31 +87,27 @@ puppet_version = ENV.fetch('PUPPET_GEM_VERSION', nil)
 facter_version = ENV.fetch('FACTER_GEM_VERSION', nil)
 hiera_version = ENV.fetch('HIERA_GEM_VERSION', nil)
 
-# If PUPPET_FORGE_TOKEN is set then use authenticated source for both puppet and facter, since facter is a transitive dependency of puppet
-# Otherwise, do as before and use location_for to fetch gems from the default source
-if !ENV['PUPPET_FORGE_TOKEN'].to_s.empty?
-  gems['puppet'] = ['~> 8.11', { require: false, source: 'https://rubygems-puppetcore.puppet.com' }]
-  gems['facter'] = ['~> 4.11', { require: false, source: 'https://rubygems-puppetcore.puppet.com' }]
-else
-  gems['puppet'] = location_for(puppet_version)
-  gems['facter'] = location_for(facter_version) if facter_version
-end
-
-gems['hiera'] = location_for(hiera_version) if hiera_version
+gems['puppet'] = location_for(puppet_version, nil, { source: gemsource_puppetcore })
+gems['facter'] = location_for(facter_version, nil, { source: gemsource_puppetcore })
+gems['hiera'] = location_for(hiera_version, nil, {}) if hiera_version
 
+# Generate the gem definitions
+print_gem_statement_for(gems) if ENV['DEBUG']
 gems.each do |gem_name, gem_params|
   gem gem_name, *gem_params
 end
 
 # Evaluate Gemfile.local and ~/.gemfile if they exist
 extra_gemfiles = [
   "#{__FILE__}.local",
-  File.join(Dir.home, '.gemfile'),
+  File.join(Dir.home, '.gemfile')
 ]
 
 extra_gemfiles.each do |gemfile|
-  if File.file?(gemfile) && File.readable?(gemfile)
-    eval(File.read(gemfile), binding)
-  end
+  next unless File.file?(gemfile) && File.readable?(gemfile)
+
+  # rubocop:disable Security/Eval
+  eval(File.read(gemfile), binding)
+  # rubocop:enable Security/Eval
 end
 # vim: syntax=ruby

Rakefile

@@ -8,4 +8,13 @@ require 'puppet-strings/tasks' if Gem.loaded_specs.key? 'puppet-strings'
 require 'voxpupuli/acceptance/rake' if Gem.loaded_specs.key? 'voxpupuli-acceptance'
 
 PuppetLint.configuration.send('disable_relative')
+PuppetLint.configuration.send('disable_80chars')
+PuppetLint.configuration.send('disable_140chars')
+PuppetLint.configuration.send('disable_class_inherits_from_params_class')
+PuppetLint.configuration.send('disable_autoloader_layout')
+PuppetLint.configuration.send('disable_documentation')
+PuppetLint.configuration.send('disable_single_quote_string_with_variables')
 PuppetLint.configuration.send('disable_puppet_url_without_modules')
+PuppetLint.configuration.fail_on_warnings = true
+PuppetLint.configuration.ignore_paths = [".vendor/**/*.pp", ".bundle/**/*.pp", "pkg/**/*.pp", "spec/**/*.pp", "tests/**/*.pp", "types/**/*.pp", "vendor/**/*.pp"]
+

metadata.json

@@ -82,7 +82,7 @@
       "version_requirement": ">= 7.0.0 < 9.0.0"
     }
   ],
-  "pdk-version": "3.2.0",
-  "template-url": "https://github.com/puppetlabs/pdk-templates#3.2.0",
-  "template-ref": "tags/3.2.0-0-gb257ef1"
+  "pdk-version": "3.5.1",
+  "template-url": "https://github.com/puppetlabs/pdk-templates#3.5.1",
+  "template-ref": "tags/3.5.1-0-g9d5b193"
 }

spec/classes/puppet_agent_osfamily_darwin_spec.rb

@@ -34,7 +34,7 @@
   }
 
   describe 'supported environment' do
-    let(:params) { { package_version: package_version } }
+    let(:params) { { package_version: } }
 
     context 'when running a supported macOS' do
       ['osx-11-x86_64', 'osx-12-x86_64'].each do |tag|

spec/classes/puppet_agent_osfamily_debian_spec.rb

@@ -23,7 +23,7 @@
   package_version = '1.10.100'
   let(:params) do
     {
-      package_version: package_version
+      package_version:
     }
   end
   let(:facts) { facts }
@@ -48,7 +48,7 @@
       let(:params) do
         {
           manage_repo: true,
-          package_version: package_version
+          package_version:
         }
       end
 
@@ -74,7 +74,7 @@
       let(:params) do
         {
           manage_repo: false,
-          package_version: package_version
+          package_version:
         }
       end
 
@@ -94,7 +94,7 @@
         let(:params) do
           {
             manage_repo: true,
-            package_version: package_version
+            package_version:
           }
         end
 
@@ -118,7 +118,7 @@
         let(:params) do
           {
             manage_repo: false,
-            package_version: package_version
+            package_version:
           }
         end
 
@@ -133,7 +133,7 @@
       let(:params) do
         {
           manage_repo: true,
-          package_version: package_version
+          package_version:
         }
       end
 
@@ -166,7 +166,7 @@
       let(:params) do
         {
           manage_repo: true,
-          package_version: package_version,
+          package_version:,
           source: 'https://fake-apt-mirror.com'
         }
       end
@@ -188,7 +188,7 @@
       let(:params) do
         {
           manage_repo: false,
-          package_version: package_version
+          package_version:
         }
       end
 
@@ -207,7 +207,7 @@
       let(:params) do
         {
           manage_repo: true,
-          package_version: package_version,
+          package_version:,
           collection: 'puppet5',
         }
       end
@@ -229,7 +229,7 @@
       let(:params) do
         {
           manage_repo: true,
-          package_version: package_version,
+          package_version:,
           collection: 'puppet5',
           apt_source: 'https://fake-apt-mirror.com/'
         }
@@ -252,7 +252,7 @@
       let(:params) do
         {
           manage_repo: false,
-          package_version: package_version
+          package_version:
         }
       end