Merge pull request #61 from puppetlabs/PA-7815-template-update

cthorn42 · web-flow · commit db37ba65818c · 2025-11-24T15:15:58.000-08:00
(PA-7815) Updates for PDK template 3.5.1
diff --git a/.gitignore b/.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
diff --git a/.pdkignore b/.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
diff --git a/.puppet-lint.rc b/.puppet-lint.rc
@@ -1 +1,9 @@
+--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
+--ignore-paths=.vendor/**/*.pp,.bundle/**/*.pp,pkg/**/*.pp,spec/**/*.pp,tests/**/*.pp,types/**/*.pp,vendor/**/*.pp
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -5,7 +5,7 @@ require:
 AllCops:
   NewCops: enable
   DisplayCopNames: true
-  TargetRubyVersion: '2.6'
+  TargetRubyVersion: 3.1
   Include:
   - "**/*.rb"
   Exclude:
diff --git a/Gemfile b/Gemfile
@@ -1,53 +1,79 @@
-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.1.0',                                                       require: false if Gem::Requirement.create(['>= 2.5.0', '< 2.7.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
-  gem "json", '= 2.3.0',                                                       require: false if Gem::Requirement.create(['>= 2.7.0', '< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
-  gem "json", '= 2.5.1',                                                       require: false if Gem::Requirement.create(['>= 3.0.0', '< 3.0.5']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
-  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.0',                                                  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 "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.0',                                             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-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 "async", '~> 1',                                                         require: false
-  gem "beaker-module_install_helper",                                          require: false
-  gem "nokogiri",                                                              require: false
+  gem "async", '~> 1',                                                                     require: false
+  gem "beaker-module_install_helper",                                                      require: false
+  gem "nokogiri",                                                                          require: false
 end
 group :development, :release_prep do
   gem "puppet-strings", '~> 4.0',         require: false
-  gem "puppetlabs_spec_helper", '~> 7.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",      require: false
@@ -58,31 +84,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
diff --git a/Rakefile b/Rakefile
@@ -8,3 +8,12 @@ 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.fail_on_warnings = true
+PuppetLint.configuration.ignore_paths = [".vendor/**/*.pp", ".bundle/**/*.pp", "pkg/**/*.pp", "spec/**/*.pp", "tests/**/*.pp", "types/**/*.pp", "vendor/**/*.pp"]
+
diff --git a/metadata.json b/metadata.json
@@ -63,7 +63,7 @@
       "version_requirement": ">= 6.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"
 }
diff --git a/spec/spec_helper_acceptance.rb b/spec/spec_helper_acceptance.rb
@@ -52,7 +52,7 @@ def run_puppet_install_helper
 
         agent_sha = ENV['BEAKER_PUPPET_AGENT_SHA'] || ENV['PUPPET_AGENT_SHA']
         if agent_sha.nil? || agent_sha.empty?
-          install_puppet_agent_on(hosts, options.merge(version: version))
+          install_puppet_agent_on(hosts, options.merge(version:))
         else
           # If we have a development sha, assume we're testing internally
           dev_builds_url = ENV['DEV_BUILDS_URL'] || 'http://builds.delivery.puppetlabs.net'
diff --git a/spec/unit/type/host_spec.rb b/spec/unit/type/host_spec.rb
@@ -4,7 +4,7 @@
 
 describe Puppet::Type.type(:host) do
   let(:provider) { FakeHostProvider.new }
-  let(:resource) { instance_double('Puppet::Type::Host', provider: provider) }
+  let(:resource) { instance_double('Puppet::Type::Host', provider:) }
 
   it 'has :name be its namevar' do
     expect(described_class.key_attributes).to eq([:name])
@@ -257,7 +257,7 @@
      '::0:a:b:c:d:e:f', # syntactically correct, but bad form (::0:... could be combined)
      'a:b:c:d:e:f:0::'].each do |ip|
       it "accepts #{ip.inspect} as an IPv6 address" do
-        expect { described_class.new(name: 'foo', ip: ip) }.not_to raise_error
+        expect { described_class.new(name: 'foo', ip:) }.not_to raise_error
       end
     end
 
@@ -588,7 +588,7 @@
      '::3333:4444:5555:6666:7777:8888:',
      '::2222:3333:4444:5555:6666:7777:8888:'].each do |ip|
       it "rejects #{ip.inspect} as an IPv6 address" do
-        expect { described_class.new(name: 'foo', ip: ip) }.to raise_error(Puppet::ResourceError, %r{Parameter ip failed})
+        expect { described_class.new(name: 'foo', ip:) }.to raise_error(Puppet::ResourceError, %r{Parameter ip failed})
       end
     end
 
@@ -623,42 +623,42 @@
 
   describe 'when syncing' do
     it 'sends the first value to the provider for ip property' do
-      ip = described_class.attrclass(:ip).new(resource: resource, should: ['192.168.0.1', '192.168.0.2'])
+      ip = described_class.attrclass(:ip).new(resource:, should: ['192.168.0.1', '192.168.0.2'])
       ip.sync
 
       expect(provider.ip).to eq('192.168.0.1')
     end
 
     it 'sends the first value to the provider for comment property' do
-      comment = described_class.attrclass(:comment).new(resource: resource, should: ['Bazinga', 'Notme'])
+      comment = described_class.attrclass(:comment).new(resource:, should: ['Bazinga', 'Notme'])
       comment.sync
 
       expect(provider.comment).to eq('Bazinga')
     end
 
     it 'sends the joined array to the provider for host_alias' do
-      host_aliases = described_class.attrclass(:host_aliases).new(resource: resource, should: ['foo', 'bar'])
+      host_aliases = described_class.attrclass(:host_aliases).new(resource:, should: ['foo', 'bar'])
       host_aliases.sync
 
       expect(provider.host_aliases).to eq('foo bar')
     end
 
     it 'alsoes use the specified delimiter for joining' do
-      host_aliases = described_class.attrclass(:host_aliases).new(resource: resource, should: ['foo', 'bar'])
+      host_aliases = described_class.attrclass(:host_aliases).new(resource:, should: ['foo', 'bar'])
       allow(host_aliases).to receive(:delimiter).and_return "\t"
       host_aliases.sync
 
       expect(provider.host_aliases).to eq("foo\tbar")
     end
 
     it 'cares about the order of host_aliases' do
-      host_aliases = described_class.attrclass(:host_aliases).new(resource: resource, should: ['foo', 'bar'])
+      host_aliases = described_class.attrclass(:host_aliases).new(resource:, should: ['foo', 'bar'])
       expect(host_aliases.insync?(['foo', 'bar'])).to eq(true)
       expect(host_aliases.insync?(['bar', 'foo'])).to eq(false)
     end
 
     it 'does not consider aliases to be in sync if should is a subset of current' do
-      host_aliases = described_class.attrclass(:host_aliases).new(resource: resource, should: ['foo', 'bar'])
+      host_aliases = described_class.attrclass(:host_aliases).new(resource:, should: ['foo', 'bar'])
       expect(host_aliases.insync?(['foo', 'bar', 'anotherone'])).to eq(false)
     end
   end

Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@`
`63`	`63`	`"version_requirement": ">= 6.0.0 < 9.0.0"`
`64`	`64`	`}`
`65`	`65`	`],`
`66`		`- "pdk-version": "3.2.0",`
`67`		`- "template-url": "https://github.com/puppetlabs/pdk-templates#3.2.0",`
`68`		`- "template-ref": "tags/3.2.0-0-gb257ef1"`
	`66`	`+ "pdk-version": "3.5.1",`
	`67`	`+ "template-url": "https://github.com/puppetlabs/pdk-templates#3.5.1",`
	`68`	`+ "template-ref": "tags/3.5.1-0-g9d5b193"`
`69`	`69`	`}`