Merge pull request #99 from puppetlabs/pdksync_maint-pdk-update

pdksync - (MAINT) PDK Update

Author: Ramesh7

.rubocop.yml

@@ -1,70 +1,19 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-11-29 07:54:54 UTC using RuboCop version 1.48.1.
+# on 2023-12-21 10:51:41 UTC using RuboCop version 1.48.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
-# Configuration parameters: AllowedMethods.
-# AllowedMethods: enums
-Lint/ConstantDefinitionInBlock:
-  Exclude:
-    - 'lib/puppet/provider/windows_env/windows_env.rb'
-
 # Offense count: 1
-# Configuration parameters: AllowComments, AllowEmptyLambdas.
-Lint/EmptyBlock:
-  Exclude:
-    - 'lib/puppet/provider/windows_env/windows_env.rb'
-
-# Offense count: 5
-# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
-Metrics/AbcSize:
-  Max: 66
-
-# Offense count: 4
-# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
-# AllowedMethods: refine
-Metrics/BlockLength:
-  Max: 206
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 301
 
 # Offense count: 2
-# Configuration parameters: AllowedMethods, AllowedPatterns.
-Metrics/CyclomaticComplexity:
-  Max: 24
-
-# Offense count: 5
-# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
-Metrics/MethodLength:
-  Max: 47
-
-# Offense count: 2
-# Configuration parameters: AllowedMethods, AllowedPatterns.
-Metrics/PerceivedComplexity:
-  Max: 25
-
-# Offense count: 2
-# Configuration parameters: Prefixes, AllowedPatterns.
-# Prefixes: when, with, without
-RSpec/ContextWording:
-  Exclude:
-    - 'spec/acceptance/windows_env_spec.rb'
-
-# Offense count: 2
-# Configuration parameters: IgnoredMetadata.
-RSpec/DescribeClass:
-  Exclude:
-    - '**/spec/features/**/*'
-    - '**/spec/requests/**/*'
-    - '**/spec/routing/**/*'
-    - '**/spec/system/**/*'
-    - '**/spec/views/**/*'
-    - 'spec/acceptance/windows_env_spec.rb'
-    - 'spec/unit/puppet/type/windows_env_type_spec.rb'
-
-# Offense count: 1
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: nested, compact
@@ -73,20 +22,39 @@ Style/ClassAndModuleChildren:
     - 'lib/puppet/provider/windows_env/windows_env.rb'
 
 # Offense count: 2
-# Configuration parameters: AllowedConstants.
-Style/Documentation:
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, AllowInnerSlashes.
+# SupportedStyles: slashes, percent_r, mixed
+Style/RegexpLiteral:
   Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/puppet/provider/windows_env/windows_env.rb'
+    - 'lib/puppet/type/windows_env.rb'
+
+# Offense count: 8
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: MinSize.
+# SupportedStyles: percent, brackets
+Style/SymbolArray:
+  EnforcedStyle: percent
 
 # Offense count: 1
-Style/MixinUsage:
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, AllowSafeAssignment.
+# SupportedStyles: require_parentheses, require_no_parentheses, require_parentheses_when_complex
+Style/TernaryParentheses:
   Exclude:
-    - 'spec/spec_helper.rb'
+    - 'lib/puppet/provider/windows_env/windows_env.rb'
 
 # Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Style/SlicingWithRange:
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyleForMultiline.
+# SupportedStylesForMultiline: comma, consistent_comma, no_comma
+Style/TrailingCommaInArrayLiteral:
   Exclude:
-    - 'lib/puppet/provider/windows_env/windows_env.rb'
+    - 'spec/unit/puppet/type/windows_env_type_spec.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: MinSize, WordRegex.
+# SupportedStyles: percent, brackets
+Style/WordArray:
+  EnforcedStyle: percent

.rubocop_todo.yml

@@ -12,4 +12,4 @@ spec/acceptance/nodesets/ec2/ubuntu-1604-x64.yml:
 spec/acceptance/nodesets/archlinux-2-x64.yml:
   delete: true
 .rubocop.yml:
-  unmanaged: true
+  include_todos: true

.sync.yml

@@ -23,6 +23,7 @@ group :development do
   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 "dependency_checker", '~> 1.0.0',          require: false
@@ -33,6 +34,7 @@ group :development do
   gem "rubocop", '= 1.48.1',                     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]
 end
 group :system_tests do
@@ -41,7 +43,7 @@ group :system_tests do
 end
 group :release_prep do
   gem "puppet-strings", '~> 4.0',         require: false
-  gem "puppetlabs_spec_helper", '~> 7.0', require: false
+  gem "puppetlabs_spec_helper", '~> 6.0', require: false
 end
 
 puppet_version = ENV['PUPPET_GEM_VERSION']

Gemfile

@@ -4,85 +4,6 @@ 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'
 
-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
-
 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?
-    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
-

Rakefile

@@ -6,30 +6,30 @@
     require 'puppet/util/windows/process'
 
     # This list must be in uppercase
-    whitelist = %w[
-      ALLUSERSPROFILE
-      APPDATA
-      COMMONPROGRAMFILES
-      COMMONPROGRAMFILES(X86)
-      HOME
-      HOMEDRIVE
-      HOMEPATH
-      LOCALAPPDATA
-      PATHEXT
-      PROCESSOR_IDENTIFIER
-      PROCESSOR_LEVEL
-      PROCESSOR_REVISION
-      PROGRAMDATA
-      PROGRAMFILES
-      PROGRAMFILES(X86)
-      PSMODULEPATH
-      PUBLIC
-      SYSTEMDRIVE
-      SYSTEMROOT
-      TEMP
-      TMP
-      USERPROFILE
-      WINDIR
+    whitelist = [
+      'ALLUSERSPROFILE',
+      'APPDATA',
+      'COMMONPROGRAMFILES',
+      'COMMONPROGRAMFILES(X86)',
+      'HOME',
+      'HOMEDRIVE',
+      'HOMEPATH',
+      'LOCALAPPDATA',
+      'PATHEXT',
+      'PROCESSOR_IDENTIFIER',
+      'PROCESSOR_LEVEL',
+      'PROCESSOR_REVISION',
+      'PROGRAMDATA',
+      'PROGRAMFILES',
+      'PROGRAMFILES(X86)',
+      'PSMODULEPATH',
+      'PUBLIC',
+      'SYSTEMDRIVE',
+      'SYSTEMROOT',
+      'TEMP',
+      'TMP',
+      'USERPROFILE',
+      'WINDIR',
     ]
 
     result = {}

lib/facter/windows_env.rb

@@ -63,16 +63,16 @@ module self::WinAPI
       ffi_convention :stdcall
 
       ffi_lib :User32
-      attach_function :SendMessageTimeout, :SendMessageTimeoutA, %i[uintptr_t uint pointer pointer uint uint pointer], :pointer
+      attach_function :SendMessageTimeout, :SendMessageTimeoutA, [:uintptr_t, :uint, :pointer, :pointer, :uint, :uint, :pointer], :pointer
 
       ffi_lib :Advapi32
-      attach_function :RegLoadKey, :RegLoadKeyA, %i[uintptr_t pointer pointer], :long
-      attach_function :RegUnLoadKey, :RegUnLoadKeyA, %i[uintptr_t pointer], :long
+      attach_function :RegLoadKey, :RegLoadKeyA, [:uintptr_t, :pointer, :pointer], :long
+      attach_function :RegUnLoadKey, :RegUnLoadKeyA, [:uintptr_t, :pointer], :long
 
       # Ruby < 1.9 doesn't know about encoding.
       if defined?(::Encoding)
         # Workaround for https://bugs.ruby-lang.org/issues/10820 .
-        attach_function :RegDeleteValue, :RegDeleteValueW, %i[uintptr_t buffer_in], :long
+        attach_function :RegDeleteValue, :RegDeleteValueW, [:uintptr_t, :buffer_in], :long
 
         # Borrowed from Puppet core. Duplicated for old version compatibilty.
         def self.from_string_to_wide_string(str)
@@ -163,7 +163,7 @@ def exists?
     # when removing in 'prepend' and 'append' modes. Otherwise, if the value
     # were in the variable but not at the beginning (prepend) or end (append),
     # it would not be removed.
-    @resource[:mergemode] = :insert if @resource[:ensure] == :absent && %i[append prepend].include?(@resource[:mergemode])
+    @resource[:mergemode] = :insert if @resource[:ensure] == :absent && [:append, :prepend].include?(@resource[:mergemode])
 
     case @resource[:mergemode]
     when :clobber

lib/puppet/provider/windows_env/windows_env.rb

@@ -14,7 +14,10 @@ def self.check_collisions(resource)
     # Cannot have two resources in clobber mode on the same var
     @mergemode[user] ||= {}
     last = @mergemode[user][var]
-    raise "Multiple resources are managing the same environment variable but at least one is in clobber mergemode. (Offending resources: #{resource}, #{last})" if (!last.nil? && last.catalog == resource.catalog) && ((resource[:mergemode] == :clobber && last) || (last && last[:mergemode] == :clobber))
+    raise "Multiple resources are managing the same environment variable but at least one is in clobber mergemode. (Offending resources: #{resource}, #{last})" \
+      if (!last.nil? && last.catalog == resource.catalog) && \
+         ((resource[:mergemode] == :clobber && last) || \
+         (last && last[:mergemode] == :clobber))
 
     @mergemode[user][var] = resource
 
@@ -97,7 +100,7 @@ def self.title_patterns
   validate do
     raise "'value' parameter must be provided when 'ensure => present'" if self[:ensure] == :present && [nil, :undef].include?(self[:value])
     if self[:ensure] == :absent && [nil, :undef].include?(self[:value]) &&
-       %i[prepend append insert].include?(self[:mergemode])
+       [:prepend, :append, :insert].include?(self[:mergemode])
       raise "'value' parameter must be provided when 'ensure => absent' and 'mergemode => #{self[:mergemode]}'"
     end
 

lib/puppet/type/windows_env.rb

@@ -31,5 +31,5 @@
   ],
   "pdk-version": "3.0.0",
   "template-url": "https://github.com/puppetlabs/pdk-templates.git#main",
-  "template-ref": "heads/main-0-g01c6a19"
+  "template-ref": "heads/main-0-g79a2f93"
 }

metadata.json

@@ -13,12 +13,12 @@
 
 default_facts = {
   puppetversion: Puppet.version,
-  facterversion: Facter.version
+  facterversion: Facter.version,
 }
 
 default_fact_files = [
   File.expand_path(File.join(File.dirname(__FILE__), 'default_facts.yml')),
-  File.expand_path(File.join(File.dirname(__FILE__), 'default_module_facts.yml'))
+  File.expand_path(File.join(File.dirname(__FILE__), 'default_module_facts.yml')),
 ]
 
 default_fact_files.each do |f|
@@ -38,7 +38,7 @@
 
 RSpec.configure do |c|
   c.default_facts = default_facts
-  c.before do
+  c.before :each do
     # set to strictest setting for testing
     # by default Puppet runs at warning level
     Puppet.settings[:strict] = :warning
@@ -51,8 +51,8 @@
 
   # Filter backtrace noise
   backtrace_exclusion_patterns = [
-    /spec_helper/,
-    /gems/
+    %r{spec_helper},
+    %r{gems},
   ]
 
   if c.respond_to?(:backtrace_exclusion_patterns)