pdk 2.0.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b0614fb53065a8c2545ffe2bf3839b9d30aaef65d3b9827635ceb5f24d0181e
-  data.tar.gz: b582b1d8c5622fd2bbbe7facc1676a2c4d2d4c50729b2156667a96eb6bcc73e4
+  metadata.gz: 7108ed8889a1ee93bf944b2a35cc1bd527fee723ab8466126e293d621bb033d9
+  data.tar.gz: d823aa9385c7f1d0daf86f31a8f338706562aa1df67fe049fa9e393f609d046d
 SHA512:
-  metadata.gz: a09558ee0700783e650c8506ee291c768b89567f7c063763652a449c50544e9f31b95173918f8c553bd120742232d542b897c8eaccd23e8153702b7c75609582
-  data.tar.gz: e93a741e535ffe7bd3f9929cc7464891d0a9bbb04d13e5c4e9faf3ff2fd03434a2e127d7a62be06ad64479994198b0427e172ab9df496d48ce79b8f189079a2f
+  metadata.gz: 4a65547c79720dfb12c74c7392844d06dc2e094e97c1812459aa8e055ffb865fea41c6304286dae180600f7182a62b96b7ae1ec295d62e6f09fbb7b3872992c7
+  data.tar.gz: 6b3fc743d50509f50e672f397f9de2e27c62c6807870f2daa4f21c4ea88536934adf2dadcac10cd83c9aa9348d49434a239602f9917e6b957479241ab00d5e1e

data/CHANGELOG.md

@@ -4,6 +4,58 @@ All changes to this repo will be documented in this file.
 See the [release notes](https://puppet.com/docs/pdk/latest/release_notes.html) for a high-level summary.
 
 
+## [v2.3.0](https://github.com/puppetlabs/pdk/tree/v2.3.0) (2021-10-21)
+
+[Full Changelog](https://github.com/puppetlabs/pdk/compare/v2.2.0...v2.3.0)
+
+**Merged pull requests:**
+
+- Account for Psych API changes [\#1147](https://github.com/puppetlabs/pdk/pull/1147) ([binford2k](https://github.com/binford2k))
+
+## [v2.2.0](https://github.com/puppetlabs/pdk/tree/v2.2.0) (2021-08-02)
+
+[Full Changelog](https://github.com/puppetlabs/pdk/compare/v2.1.1...v2.2.0)
+
+**Implemented enhancements:**
+
+- \(GH-1118\) Add ability to skip validating files [\#1114](https://github.com/puppetlabs/pdk/pull/1114) ([jpogran](https://github.com/jpogran))
+
+**Fixed bugs:**
+
+- \(GH-1113\) \(GH-917\) Fix forge-token handling [\#1121](https://github.com/puppetlabs/pdk/pull/1121) ([sanfrancrisko](https://github.com/sanfrancrisko))
+
+**Merged pull requests:**
+
+- \(PDK-1729\) version to 2.2.0.pre2 [\#1106](https://github.com/puppetlabs/pdk/pull/1106) ([da-ar](https://github.com/da-ar))
+
+## [v2.1.1](https://github.com/puppetlabs/pdk/tree/v2.1.1) (2021-06-22)
+
+[Full Changelog](https://github.com/puppetlabs/pdk/compare/v2.1.0...v2.1.1)
+
+**Fixed bugs:**
+
+- \(PDK-1085\) Fail gracefully when no unit tests available [\#1096](https://github.com/puppetlabs/pdk/pull/1096) ([sanfrancrisko](https://github.com/sanfrancrisko))
+- \(GH-1090\) Verify the changelog top most version matches the metadata version [\#1088](https://github.com/puppetlabs/pdk/pull/1088) ([carabasdaniel](https://github.com/carabasdaniel))
+- \(GH-1083\) Bump childprocess to '~\> 4.0.0'; Disable @process.leader [\#1084](https://github.com/puppetlabs/pdk/pull/1084) ([sanfrancrisko](https://github.com/sanfrancrisko))
+
+**Merged pull requests:**
+
+- \(PDK-1041\) Use diff-lcs 1.4.4 [\#1091](https://github.com/puppetlabs/pdk/pull/1091) ([da-ar](https://github.com/da-ar))
+- Update CODEOWNERS [\#1082](https://github.com/puppetlabs/pdk/pull/1082) ([jpogran](https://github.com/jpogran))
+
+## [v2.1.0](https://github.com/puppetlabs/pdk/tree/v2.1.0) (2021-04-06)
+
+[Full Changelog](https://github.com/puppetlabs/pdk/compare/v2.0.0...v2.1.0)
+
+**Merged pull requests:**
+
+- \(maint\) Mark stale issues [\#1028](https://github.com/puppetlabs/pdk/pull/1028) ([jpogran](https://github.com/jpogran))
+- \(PF-2332\) Add `pdk env` subcommand [\#957](https://github.com/puppetlabs/pdk/pull/957) ([nkanderson](https://github.com/nkanderson))
+- Docs: Install on macOS with brew [\#954](https://github.com/puppetlabs/pdk/pull/954) ([rwaffen](https://github.com/rwaffen))
+- \(MAINT\) Bump version to 2.1.0.pre [\#952](https://github.com/puppetlabs/pdk/pull/952) ([scotje](https://github.com/scotje))
+- \(MAINT\) Fixup some superfluous entries in the 2.0.0 release notes [\#951](https://github.com/puppetlabs/pdk/pull/951) ([scotje](https://github.com/scotje))
+- \(Docs\) Update version number in welcome page [\#950](https://github.com/puppetlabs/pdk/pull/950) ([hestonhoffman](https://github.com/hestonhoffman))
+- \(Docs\) Release notes edits [\#949](https://github.com/puppetlabs/pdk/pull/949) ([hestonhoffman](https://github.com/hestonhoffman))
 ## [v2.0.0](https://github.com/puppetlabs/pdk/tree/v2.0.0) (2021-02-24)
 
 [Full Changelog](https://github.com/puppetlabs/pdk/compare/v1.18.1...v2.0.0)
@@ -58,7 +110,6 @@ See the [release notes](https://puppet.com/docs/pdk/latest/release_notes.html) f
 - Warning from libhoney when running unit test with PDK 1.17 [\#875](https://github.com/puppetlabs/pdk/issues/875)
 - 'pdk convert' of a module that's inside a control repo adds boilerplate to the control repo [\#874](https://github.com/puppetlabs/pdk/issues/874)
 - GemNotFound error for public\_suffix-3.1.1 when using --add-tests [\#869](https://github.com/puppetlabs/pdk/issues/869)
-- Scrollback of failed rspec tests in VS code is extremely limited [\#829](https://github.com/puppetlabs/pdk/issues/829)
 - Running individual rspec tests on Windows requires escaping the path [\#828](https://github.com/puppetlabs/pdk/issues/828)
 - Generated descriptions for certain test comparisons break JUnit output [\#821](https://github.com/puppetlabs/pdk/issues/821)
 - Fix PDK release command module validation [\#880](https://github.com/puppetlabs/pdk/pull/880) ([carabasdaniel](https://github.com/carabasdaniel))

data/lib/pdk/cli/env.rb

@@ -0,0 +1,52 @@
+module PDK::CLI
+  @env_cmd = @base_cmd.define_command do
+    name 'env'
+    usage _('env')
+    summary _('(Experimental) Output environment variables for specific Puppet context')
+    description _(<<-EOF
+[experimental] Aids in setting a CLI context for a specified version of Puppet by outputting export commands for necessary environment variables.
+EOF
+                 )
+
+    PDK::CLI.puppet_version_options(self)
+    PDK::CLI.puppet_dev_option(self)
+
+    run do |opts, _args, _cmd|
+      require 'pdk/util'
+      require 'pdk/util/ruby_version'
+
+      PDK::CLI::Util.validate_puppet_version_opts(opts)
+
+      PDK::CLI::Util.analytics_screen_view('env')
+
+      # Ensure that the correct Ruby is activated before running command.
+      puppet_env = PDK::CLI::Util.puppet_from_opts_or_env(opts)
+      PDK::Util::RubyVersion.use(puppet_env[:ruby_version])
+
+      resolved_env = {
+        'PDK_RESOLVED_PUPPET_VERSION' => puppet_env[:gemset][:puppet],
+        'PDK_RESOLVED_RUBY_VERSION' => puppet_env[:ruby_version],
+      }
+
+      resolved_env['GEM_HOME'] = PDK::Util::RubyVersion.gem_home
+      gem_path = PDK::Util::RubyVersion.gem_path
+      resolved_env['GEM_PATH'] = gem_path.empty? ? resolved_env['GEM_HOME'] : gem_path
+
+      # Make sure invocation of Ruby prefers our private installation.
+      package_binpath = PDK::Util.package_install? ? File.join(PDK::Util.pdk_package_basedir, 'bin') : nil
+
+      resolved_env['PATH'] = [
+        PDK::Util::RubyVersion.bin_path,
+        File.join(resolved_env['GEM_HOME'], 'bin'),
+        PDK::Util::RubyVersion.gem_paths_raw.map { |gem_path_raw| File.join(gem_path_raw, 'bin') },
+        package_binpath,
+        PDK::Util::Env['PATH'],
+      ].compact.flatten.join(File::PATH_SEPARATOR)
+
+      resolved_env.each do |var, val|
+        puts "export #{var}=\"#{val}\""
+      end
+      exit 0
+    end
+  end
+end

data/lib/pdk/cli/exec/command.rb

@@ -27,7 +27,17 @@ module PDK
           @argv = argv
 
           @process = ChildProcess.build(*@argv)
-          @process.leader = true
+          # https://github.com/puppetlabs/pdk/issues/1083:
+          # When @process.leader is set, childprocess will set the CREATE_BREAKAWAY_FROM_JOB
+          # and JOB_OBJECT_LIMIT_BREAKAWAY_OK flags in the Win32 API calls. This will cause
+          # issues on systems > Windows 7 / Server 2008, if the JOB_OBJECT_LIMIT_BREAKAWAY_OK
+          # flag is set and the Task Scheduler is trying to kick off a job, it can sometimes
+          # result in ACCESS_DENIED being returned by the Win32 API, depending on the permission
+          # levels / user account this user.
+          # The resolution for pdk/issues/1083 is to ensure @process.leader is not set.
+          # This will potentially cause issues on older Windows systems, in which case we may
+          # need to revisit and conditionally set this param depending on what OS we're on
+          # @process.leader = true
 
           @stdout = Tempfile.new('stdout', mode: TEMPFILE_MODE).tap { |io| io.sync = true }
           @stderr = Tempfile.new('stderr', mode: TEMPFILE_MODE).tap { |io| io.sync = true }

data/lib/pdk/cli/release.rb

@@ -22,7 +22,8 @@ module PDK::CLI
     option nil, :'forge-upload-url', _('Set forge upload url path.'),
            argument: :required, default: 'https://forgeapi.puppetlabs.com/v3/releases'
 
-    option nil, :'forge-token', _('Set Forge API token.'), argument: :required, default: nil
+    option nil, :'forge-token', _('Set Forge API token.'),
+           argument: :optional
 
     option nil, :version, _('Update the module to the specified version prior to release. When not specified, the new version will be computed from the Changelog where possible.'),
            argument: :required
@@ -145,6 +146,7 @@ module PDK::CLI
         opts[:'skip-changelog'] = !answers['changelog']
         opts[:'skip-dependency'] = !answers['dependency']
         opts[:'skip-documentation'] = !answers['documentation']
+        opts[:'skip-publish'] = !answers['publish']
 
         prepare_version_interview(prompt, opts) if answers['setversion']
 

data/lib/pdk/cli.rb

@@ -159,6 +159,7 @@ module PDK::CLI
   require 'pdk/cli/build'
   require 'pdk/cli/config'
   require 'pdk/cli/convert'
+  require 'pdk/cli/env'
   require 'pdk/cli/get'
   require 'pdk/cli/new'
   require 'pdk/cli/set'

data/lib/pdk/config/yaml.rb

@@ -13,7 +13,11 @@ module PDK
 
         require 'yaml'
 
-        data = ::YAML.safe_load(data, [Symbol], [], true)
+        data = if Gem::Version.new(Psych::VERSION) >= Gem::Version.new('3.1.0.pre1')
+                 ::YAML.safe_load(data, permitted_classes: [Symbol], permitted_symbols: [], aliases: true)
+               else
+                 ::YAML.safe_load(data, [Symbol], [], true)
+               end
         return if data.nil?
 
         data.each { |k, v| yield k, PDK::Config::Setting.new(k, self, v) }

data/lib/pdk/config.rb

@@ -94,6 +94,12 @@ module PDK
         if context.is_a?(PDK::Context::ControlRepo)
           mount :environment, PDK::ControlRepo.environment_conf_as_config(File.join(context.root_path, 'environment.conf'))
         end
+
+        mount :validate, PDK::Config::YAML.new('validate', file: File.join(context.root_path, 'pdk.yaml'), persistent_defaults: true) do
+          setting 'ignore' do
+            default_to { [] }
+          end
+        end
       end
     end
 

data/lib/pdk/module/release.rb

@@ -65,6 +65,12 @@ module PDK
 
           # Update the changelog with the correct version
           PDK::Util::ChangelogGenerator.generate_changelog unless skip_changelog?
+
+          # Check if the versions match
+          latest_version = PDK::Util::ChangelogGenerator.latest_version
+          unless latest_version
+            raise PDK::CLI::ExitWithError, _('%{new_version} does not match %{latest_version}') % { new_version: new_version, latest_version: latest_version } if new_version != latest_version
+          end
         end
 
         run_documentation(options) unless skip_documentation?

data/lib/pdk/util/changelog_generator.rb

@@ -110,6 +110,19 @@ module PDK
         version.join('.')
       end
 
+      # Returns the top most version from the CHANGELOG file
+      def self.latest_version
+        latest = nil
+        changelog_content.each_line do |line|
+          line.strip!
+          if line.start_with?('## [')
+            latest = line[line.index('[') + 1..line.index(']') - 1].delete('v')
+            break # stops after the top version is extracted
+          end
+        end
+        latest
+      end
+
       def self.changelog_file
         # Default Changelog file is CHANGELOG.md, but also search for the .MD prefix as well.
         @changelog_file ||= ['CHANGELOG.md', 'CHANGELOG.MD'].map { |file| PDK::Util::Filesystem.expand_path(file) }.find { |path| PDK::Util::Filesystem.file?(path) }

data/lib/pdk/util/json_finder.rb

@@ -39,6 +39,7 @@ module PDK
                                end
         end
 
+        return [] if @objects.nil?
         @objects = @objects.compact
       end
 

data/lib/pdk/validate/invokable_validator.rb

@@ -213,6 +213,14 @@ module PDK
           end
         end
 
+        # block will always be [] because it is intialized in config
+        ignore_files = PDK.config.get_within_scopes('validate.ignore')
+        unless ignore_files.nil? || ignore_files.empty?
+          Array(ignore_files).each do |pattern|
+            ignore_pathspec.add(pattern)
+          end
+        end
+
         ignore_pathspec
       end
     end

data/lib/pdk/version.rb

@@ -1,4 +1,4 @@
 module PDK
-  VERSION = '2.0.0'.freeze
-  TEMPLATE_REF = VERSION
+  VERSION = '2.3.0'.freeze
+  TEMPLATE_REF = '2.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdk
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Puppet, Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-25 00:00:00.000000000 Z
+date: 2021-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: cri
   requirement: !ruby/object:Gem::Requirement
@@ -62,16 +62,22 @@ dependencies:
   name: diff-lcs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.4.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
@@ -112,14 +118,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
@@ -306,6 +312,7 @@ files:
 - lib/pdk/cli/config/get.rb
 - lib/pdk/cli/console.rb
 - lib/pdk/cli/convert.rb
+- lib/pdk/cli/env.rb
 - lib/pdk/cli/errors.rb
 - lib/pdk/cli/exec.rb
 - lib/pdk/cli/exec/command.rb
@@ -441,7 +448,7 @@ files:
 homepage: https://github.com/puppetlabs/pdk
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -456,9 +463,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 2.7.6.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A key part of the Puppet Development Kit, the shortest path to better modules
 test_files: []