pdksync - "PDK update" (#16)

* "Update PDK to 3.3.0"

* Remove deprecated metadata fqdn option

.github/workflows/ci.yml

@@ -35,7 +35,7 @@ jobs:
 
       - name: Setup Test Matrix
         id: get-outputs
-        run: bundle exec metadata2gha --use-fqdn --pidfile-workaround false
+        run: bundle exec metadata2gha --pidfile-workaround false
 
   unit:
     needs: setup_matrix
@@ -60,6 +60,7 @@ jobs:
 
   acceptance:
     name: Litmus Acceptance
+    needs: unit
     runs-on: ubuntu-20.04
     env:
       BOLT_GEM: true

.gitignore

@@ -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
 /[Bb]ackup*/
 /.devcontainer/
 /.gitlab-ci.yml

.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

.rubocop.yml

@@ -3,6 +3,7 @@ require:
 - rubocop-performance
 - rubocop-rspec
 AllCops:
+  NewCops: enable
   DisplayCopNames: true
   TargetRubyVersion: '2.6'
   Include:
@@ -527,6 +528,8 @@ Lint/DuplicateBranch:
   Enabled: false
 Lint/DuplicateMagicComment:
   Enabled: false
+Lint/DuplicateMatchPattern:
+  Enabled: false
 Lint/DuplicateRegexpCharacterClassElement:
   Enabled: false
 Lint/EmptyBlock:
@@ -643,6 +646,8 @@ Style/ComparableClamp:
   Enabled: false
 Style/ConcatArrayLiterals:
   Enabled: false
+Style/DataInheritance:
+  Enabled: false
 Style/DirEmpty:
   Enabled: false
 Style/DocumentDynamicEvalDefinition:
@@ -711,6 +716,8 @@ Style/RedundantHeredocDelimiterQuotes:
   Enabled: false
 Style/RedundantInitialize:
   Enabled: false
+Style/RedundantLineContinuation:
+  Enabled: false
 Style/RedundantSelfAssignmentBranch:
   Enabled: false
 Style/RedundantStringEscape:

.sync.yml

@@ -25,8 +25,87 @@ appveyor.yml:
     - /pdk.yaml
 Rakefile:
   requires:
-      - require: puppet_blacksmith/rake_tasks
-        conditional: "Gem.loaded_specs.key? 'puppet-blacksmith'"
+    - require: puppet_blacksmith/rake_tasks
+      conditional: "Gem.loaded_specs.key? 'puppet-blacksmith'"
+    - require: github_changelog_generator/task
+      conditional: "Gem.loaded_specs.key? 'github_changelog_generator'"
+  extras:
+    - >
+      def changelog_user
+        return unless Rake.application.top_level_tasks.include? "changelog"
+        returnVal = nil || JSON.load(File.read('metadata.json'))['author']
+        raise "unable to find the changelog_user in .sync.yml, or the author in metadata.json" if returnVal.nil?
+        puts "GitHubChangelogGenerator user:#{returnVal}"
+        returnVal
+      end
+    - >
+      def changelog_project
+        return unless Rake.application.top_level_tasks.include? "changelog"
+
+        returnVal = nil
+        returnVal ||= begin
+          metadata_source = JSON.load(File.read('metadata.json'))['source']
+          metadata_source_match = metadata_source && metadata_source.match(%r{.*\/([^\/]*?)(?:\.git)?\Z})
+
+          metadata_source_match && metadata_source_match[1]
+        end
+
+        raise "unable to find the changelog_project in .sync.yml or calculate it from the source in metadata.json" if returnVal.nil?
+
+        puts "GitHubChangelogGenerator project:#{returnVal}"
+        returnVal
+      end
+    - >
+      def changelog_future_release
+        return unless Rake.application.top_level_tasks.include? "changelog"
+        returnVal = "v%s" % JSON.load(File.read('metadata.json'))['version']
+        raise "unable to find the future_release (version) in metadata.json" if returnVal.nil?
+        puts "GitHubChangelogGenerator future_release:#{returnVal}"
+        returnVal
+      end
+    - >
+      if Gem.loaded_specs.key? 'github_changelog_generator'
+        GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+          raise "Set CHANGELOG_GITHUB_TOKEN environment variable eg 'export CHANGELOG_GITHUB_TOKEN=valid_token_here'" if Rake.application.top_level_tasks.include? "changelog" and ENV['CHANGELOG_GITHUB_TOKEN'].nil?
+          config.user = "#{changelog_user}"
+          config.project = "#{changelog_project}"
+          config.future_release = "#{changelog_future_release}"
+          config.exclude_labels = ['maintenance']
+          config.header = "# Change log\n\nAll 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)."
+          config.add_pr_wo_labels = true
+          config.issues = false
+          config.merge_prefix = "### UNCATEGORIZED PRS; LABEL THEM ON GITHUB"
+          config.configure_sections = {
+            "Changed" => {
+              "prefix" => "### Changed",
+              "labels" => ["backwards-incompatible"],
+            },
+            "Added" => {
+              "prefix" => "### Added",
+              "labels" => ["enhancement", "feature"],
+            },
+            "Fixed" => {
+              "prefix" => "### Fixed",
+              "labels" => ["bug", "documentation", "bugfix"],
+            },
+          }
+        end
+      else
+        desc 'Generate a Changelog from GitHub'
+        task :changelog do
+          raise <<EOM
+      The changelog tasks depends on recent features of the github_changelog_generator gem.
+      Please manually add it to your .sync.yml for now, and run `pdk update`:
+      ---
+      Gemfile:
+        optional:
+          ':development':
+            - gem: 'github_changelog_generator'
+              version: '~> 1.15'
+              condition: "Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.3.0')"
+      EOM
+        end
+      end
 Gemfile:
   unmanaged: false
   optional:
@@ -44,7 +123,7 @@ Gemfile:
         require: false
     ':test':
       - gem: 'puppet_metadata'
-        version: '~> 2.0'
+        version: '~> 4.0'
       - gem: 'puppet-blacksmith'
         require: false
       - gem: 'ed25519'
@@ -86,7 +165,7 @@ spec/spec_helper.rb:
     - right_to_left_relationship
     - slash_comments
     - star_comments
-    # - strict_indent
+    - strict_indent
     - trailing_comma
     - trailing_whitespace
     - unquoted_file_mode

Gemfile

@@ -20,38 +20,38 @@ 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", '~> 3.0',            require: false
-  gem "puppetlabs_spec_helper", '~> 6.0',        require: false
-  gem "rspec-puppet-facts", '~> 2.0',            require: false
-  gem "codecov", '~> 0.2',                       require: false
+  gem "facterdb", '~> 2.1',                      require: false
+  gem "metadata-json-lint", '~> 4.0',            require: false
+  gem "rspec-puppet-facts", '~> 4.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.5',             require: false
+  gem "simplecov-console", '~> 0.9',             require: false
   gem "puppet-debugger", '~> 1.0',               require: false
-  gem "rubocop", '= 1.48.1',                     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 "puppet-strings", '~> 4.0',                require: false
   gem "rb-readline", '= 0.5.5',                  require: false, platforms: [:mswin, :mingw, :x64_mingw]
+  gem "rexml", '>= 3.0.0', '< 3.2.7',            require: false
   gem "github_changelog_generator", '~> 1.15',   require: false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.3.0')
   gem "puppet-lint-file_ensure-check",           require: false
   gem "puppet-lint-manifest_whitespace-check",   require: false
   gem "puppet-lint-trailing_comma-check",        require: false
   gem "puppet-lint-optional_default-check",      require: false
 end
-group :system_tests do
-  gem "puppet_litmus", '~> 1.0', require: false, platforms: [:ruby, :x64_mingw]
-  gem "serverspec", '~> 2.41',   require: false
-end
-group :release_prep do
+group :development, :release_prep do
   gem "puppet-strings", '~> 4.0',         require: false
-  gem "puppetlabs_spec_helper", '~> 6.0', require: false
+  gem "puppetlabs_spec_helper", '~> 7.0', require: false
+end
+group :system_tests do
+  gem "puppet_litmus", '~> 1.0',   require: false, platforms: [:ruby, :x64_mingw]
+  gem "CFPropertyList", '< 3.0.7', require: false, platforms: [:mswin, :mingw, :x64_mingw]
+  gem "serverspec", '~> 2.41',     require: false
 end
 group :test do
-  gem "puppet_metadata", '~> 2.0',       require: false
+  gem "puppet_metadata", '~> 4.0',       require: false
   gem "puppet-blacksmith",               require: false
   gem "ed25519", '>= 1.2', '< 2.0',      require: false
   gem "bcrypt_pbkdf", '>= 1.0', '< 2.0', require: false

Rakefile

@@ -4,9 +4,11 @@ require 'bundler'
 require 'puppet_litmus/rake_tasks' if Gem.loaded_specs.key? 'puppet_litmus'
 require 'puppetlabs_spec_helper/rake_tasks'
 require 'puppet-syntax/tasks/puppet-syntax'
-require 'github_changelog_generator/task' if Gem.loaded_specs.key? 'github_changelog_generator'
 require 'puppet-strings/tasks' if Gem.loaded_specs.key? 'puppet-strings'
 require 'puppet_blacksmith/rake_tasks' if Gem.loaded_specs.key? 'puppet-blacksmith'
+require 'github_changelog_generator/task' if Gem.loaded_specs.key? 'github_changelog_generator'
+
+PuppetLint.configuration.send('disable_relative')
 
 def changelog_user
   return unless Rake.application.top_level_tasks.include? "changelog"
@@ -41,9 +43,6 @@ def changelog_future_release
   returnVal
 end
 
-PuppetLint.configuration.send('disable_relative')
-
-
 if Gem.loaded_specs.key? 'github_changelog_generator'
   GitHubChangelogGenerator::RakeTask.new :changelog do |config|
     raise "Set CHANGELOG_GITHUB_TOKEN environment variable eg 'export CHANGELOG_GITHUB_TOKEN=valid_token_here'" if Rake.application.top_level_tasks.include? "changelog" and ENV['CHANGELOG_GITHUB_TOKEN'].nil?
@@ -74,10 +73,7 @@ else
   desc 'Generate a Changelog from GitHub'
   task :changelog do
     raise <<EOM
-The changelog tasks depends on recent features of the github_changelog_generator gem.
-Please manually add it to your .sync.yml for now, and run `pdk update`:
----
-Gemfile:
+The changelog tasks depends on recent features of the github_changelog_generator gem. Please manually add it to your .sync.yml for now, and run `pdk update`: --- Gemfile:
   optional:
     ':development':
       - gem: 'github_changelog_generator'

metadata.json

@@ -65,7 +65,7 @@
       "version_requirement": ">= 7.0.0 < 9.0.0"
     }
   ],
-  "pdk-version": "3.0.1",
-  "template-url": "https://github.com/puppetlabs/pdk-templates#3.0.1",
-  "template-ref": "tags/3.0.1-0-gd13288a"
+  "pdk-version": "3.3.0",
+  "template-url": "https://github.com/puppetlabs/pdk-templates#3.3.0",
+  "template-ref": "tags/3.3.0-0-g5d17ec1"
 }

spec/spec_helper.rb

@@ -25,15 +25,16 @@
   next unless File.exist?(f) && File.readable?(f) && File.size?(f)
 
   begin
-    default_facts.merge!(YAML.safe_load(File.read(f), permitted_classes: [], permitted_symbols: [], aliases: true))
+    require 'deep_merge'
+    default_facts.deep_merge!(YAML.safe_load(File.read(f), permitted_classes: [], permitted_symbols: [], aliases: true))
   rescue StandardError => e
     RSpec.configuration.reporter.message "WARNING: Unable to load #{f}: #{e}"
   end
 end
 
 # read default_facts and merge them over what is provided by facterdb
 default_facts.each do |fact, value|
-  add_custom_fact fact, value
+  add_custom_fact fact, value, merge_facts: true
 end
 
 RSpec.configure do |c|