pdk 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3c5a5c1229e58da80498533964f4d7ae26cd5e7
-  data.tar.gz: 656f786a2d964d6ee08da649d7649580a9ea24d0
+  metadata.gz: 93cc8f9f706dd2ce506fe5cba80f8dc1b850be29
+  data.tar.gz: f8132274481cb6f6cdcb60241829d32de7e33118
 SHA512:
-  metadata.gz: de547cceb59992ac724afbfd57888c9aea06bb875dff612d5f4fab63e52b25f39fead90fb9720fc9915c4bff40774efe1d03174742884c2903f44555b8a03a5f
-  data.tar.gz: c716798699ba50f829f8b444b41706c12d0f4310ae0ad80efd000f893ef82dd34cde7c193dcef98c059ad79f9d011cd9a4d77f625eb6eab0b0bd99cfa73e9adc
+  metadata.gz: ae5eeee330f86efe4d4fcc728aea7260fa0a066da55e21f120e0cf983750d5f12bc1c72422b58e435e1d46be94de9e07dfd071f37eebcf0482705186a879ba9f
+  data.tar.gz: 11a7de86e1765630c50d0adff32af9131262eaa4fb6e17a0ad86cd6f2218834f04e79f75a549f38ecfd8db95444a8d8a8d8201f20c8d4aa20cb2b22e7a929d80

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.
 
 
+## [v1.5.0](https://github.com/puppetlabs/pdk/tree/v1.5.0) (2018-04-30)
+[Full Changelog](https://github.com/puppetlabs/pdk/compare/v1.4.1...v1.5.0)
+
+**Implemented enhancements:**
+
+- \(PDK-904\) Warns users of pdk version compatibility  [\#482](https://github.com/puppetlabs/pdk/pull/482) ([bmjen](https://github.com/bmjen))
+- \(maint\) Allow `pdk bundle` to work without `--` [\#466](https://github.com/puppetlabs/pdk/pull/466) ([DavidS](https://github.com/DavidS))
+- \(PDK-877\) Make PDK compatible with Ruby 2.5 [\#459](https://github.com/puppetlabs/pdk/pull/459) ([scotje](https://github.com/scotje))
+- Ruby 2.4.3 transition [\#453](https://github.com/puppetlabs/pdk/pull/453) ([bmjen](https://github.com/bmjen))
+- \(PDK-846\) add Resource API type unit test template [\#451](https://github.com/puppetlabs/pdk/pull/451) ([tphoney](https://github.com/tphoney))
+- \(PDK-785\) Add --puppet-version and --pe-version CLI options [\#448](https://github.com/puppetlabs/pdk/pull/448) ([rodjek](https://github.com/rodjek))
+
+**Fixed bugs:**
+
+- \(PDK-877\) `make\_tmpdir\_name': undefined method `make\_tmpname' for Dir::Tmpname:Module [\#455](https://github.com/puppetlabs/pdk/issues/455)
+- pdk validate fails if host puppet.conf contains deprecated settings [\#304](https://github.com/puppetlabs/pdk/issues/304)
+- \(maint\) Allow module name to contain underscores when verifying [\#491](https://github.com/puppetlabs/pdk/pull/491) ([rodjek](https://github.com/rodjek))
+- \(MAINT\) Make Bundler update\_lock! helper more resilient [\#489](https://github.com/puppetlabs/pdk/pull/489) ([scotje](https://github.com/scotje))
+- \(maint\) Unhide parallel flag in test unit. [\#486](https://github.com/puppetlabs/pdk/pull/486) ([bmjen](https://github.com/bmjen))
+- \(PDK-831, PDK-832\) Fix ability to unmanage/delete files via .sync.yml  [\#479](https://github.com/puppetlabs/pdk/pull/479) ([bmjen](https://github.com/bmjen))
+- \(MAINT\) Use `bundle lock --update` to pin json to built-in versions [\#460](https://github.com/puppetlabs/pdk/pull/460) ([scotje](https://github.com/scotje))
+
+**Closed issues:**
+
+- PDK should default to mock\_with :rspec and resolve deprecation message [\#477](https://github.com/puppetlabs/pdk/issues/477)
+- Support for template URL with a branch [\#447](https://github.com/puppetlabs/pdk/issues/447)
+- Any interest in adding a `--parallel` option to `pdk test unit`? [\#446](https://github.com/puppetlabs/pdk/issues/446)
+- Installing PDK from .deb causes unmet dependencies on Ubuntu 17.10 Artful [\#370](https://github.com/puppetlabs/pdk/issues/370)
+- Repo Configs Contain Invalid URLs [\#319](https://github.com/puppetlabs/pdk/issues/319)
+- Gems not found in pre-release [\#254](https://github.com/puppetlabs/pdk/issues/254)
+
+**Merged pull requests:**
+
+- \(FIXUP\) Fix issue where PDK was invoking wrong Ruby on Windows [\#492](https://github.com/puppetlabs/pdk/pull/492) ([scotje](https://github.com/scotje))
+- \(maint\) Update package testing for ruby 2.4.4. [\#488](https://github.com/puppetlabs/pdk/pull/488) ([bmjen](https://github.com/bmjen))
+- \(MAINT\) Fix package tests for version selection and airgapped usage [\#485](https://github.com/puppetlabs/pdk/pull/485) ([scotje](https://github.com/scotje))
+- \(maint\) Some minor corrections to CLI strings. [\#484](https://github.com/puppetlabs/pdk/pull/484) ([bmjen](https://github.com/bmjen))
+- \(maint\) Remove static PE version map from PDK::Util::PuppetVersion [\#483](https://github.com/puppetlabs/pdk/pull/483) ([rodjek](https://github.com/rodjek))
+- \(PDK-842\) Wire puppet-version and pe-version options into subcommands [\#480](https://github.com/puppetlabs/pdk/pull/480) ([scotje](https://github.com/scotje))
+- \(FIXUP\) Revert incorrect path change in PDK::CLI::Exec.bundle\_bin [\#478](https://github.com/puppetlabs/pdk/pull/478) ([scotje](https://github.com/scotje))
+- \(maint\) Allow users to major or major.minor versions [\#475](https://github.com/puppetlabs/pdk/pull/475) ([rodjek](https://github.com/rodjek))
+- \(PDK-923\) Honour PDK::Util::RubyVersion.active\_ruby\_version when executing commands [\#474](https://github.com/puppetlabs/pdk/pull/474) ([rodjek](https://github.com/rodjek))
+- \(MAINT\) Fix argument bug with BundleHelper\#update\_lock! [\#473](https://github.com/puppetlabs/pdk/pull/473) ([scotje](https://github.com/scotje))
+- \(PDK-921\) Update PDK::Util::Bundler helpers to support gem switching [\#472](https://github.com/puppetlabs/pdk/pull/472) ([scotje](https://github.com/scotje))
+- Link to PDK template repo [\#470](https://github.com/puppetlabs/pdk/pull/470) ([turbodog](https://github.com/turbodog))
+- \(maint\) Update bundler before build because Ruby 2.5 [\#465](https://github.com/puppetlabs/pdk/pull/465) ([DavidS](https://github.com/DavidS))
+- \(MAINT\) Refactor templatedir path\_or\_url calculation [\#462](https://github.com/puppetlabs/pdk/pull/462) ([scotje](https://github.com/scotje))
+- \(PDK-840\) Add PDK::Util::PuppetVersion.from\_module\_metadata [\#461](https://github.com/puppetlabs/pdk/pull/461) ([rodjek](https://github.com/rodjek))
+- \(maint\) bump dev version [\#458](https://github.com/puppetlabs/pdk/pull/458) ([bmjen](https://github.com/bmjen))
+- \(MAINT\) Add Ruby 2.5 to Travis and Appveyor config [\#457](https://github.com/puppetlabs/pdk/pull/457) ([scotje](https://github.com/scotje))
+- \(maint\) Fixup remaining ruby 2.4.3 issues [\#454](https://github.com/puppetlabs/pdk/pull/454) ([bmjen](https://github.com/bmjen))
+
 ## [v1.4.1](https://github.com/puppetlabs/pdk/tree/v1.4.1) (2018-02-26)
 [Full Changelog](https://github.com/puppetlabs/pdk/compare/v1.4.0...v1.4.1)
 
@@ -13,6 +65,7 @@ See the [release notes](https://puppet.com/docs/pdk/latest/release_notes.html) f
 
 **Merged pull requests:**
 
+- Release 1.4.1 amend [\#443](https://github.com/puppetlabs/pdk/pull/443) ([bmjen](https://github.com/bmjen))
 - Updates msg in pdk update on unconverted module [\#442](https://github.com/puppetlabs/pdk/pull/442) ([bmjen](https://github.com/bmjen))
 - Release 1.4.1 amend [\#441](https://github.com/puppetlabs/pdk/pull/441) ([bmjen](https://github.com/bmjen))
 - \(maint\) pdk update checks if module is pdk compat [\#440](https://github.com/puppetlabs/pdk/pull/440) ([bmjen](https://github.com/bmjen))

data/README.md

@@ -50,29 +50,29 @@ This command asks a series of metadata questions and then generates the basic co
 
 To generate a class in your module, use the `pdk new class` command, specifying the name of your new class. To generate the main class of the module, which is defined in an `init.pp` file, give the class the same name as the module.
 
-1. From the command line, in your module's directory, run: 
+1. From the command line, in your module's directory, run:
 ```
-pdk new class class_name 
+pdk new class class_name
 ```
 
-PDK creates the new class manifest and a test file (as `class_name_spec.rb`) in your module's `/spec/classes` directory. 
+PDK creates the new class manifest and a test file (as `class_name_spec.rb`) in your module's `/spec/classes` directory.
 
 ### Generate a defined type
 
 To generate a defined type in your module, use the `pdk new defined_type` command, specifying the name of your new defined type.
 
-1. From the command line, in your module's directory, run: 
+1. From the command line, in your module's directory, run:
 ```
 pdk new defined_type defined_type_name
 ```
 
-PDK creates the new defined\_type manifest and a test file (as `defined_type_name_spec.rb`) in your module's `/spec/defines` directory. 
+PDK creates the new defined\_type manifest and a test file (as `defined_type_name_spec.rb`) in your module's `/spec/defines` directory.
 
 ### Generate a task
 
 To generate a task in your module, use the `pdk new task` command, specifying the name of your new task.
 
-1. From the command line, in your module's directory, run: 
+1. From the command line, in your module's directory, run:
 ```
 pdk new task task_name
 ```
@@ -93,7 +93,7 @@ This command validates the metadata, Puppet code syntax and style, and Ruby synt
 
 ### Run unit tests
 
-PDK's default template sets up [rspec](http://rspec.info/) for Ruby-level unit testing, and [rspec-puppet](https://github.com/rodjek/rspec-puppet/) for catalog-level unit testing.
+PDK's [default template](https://github.com/puppetlabs/pdk-templates) sets up [rspec](http://rspec.info/) for Ruby-level unit testing, and [rspec-puppet](https://github.com/rodjek/rspec-puppet/) for catalog-level unit testing.
 
 In the module's directory, run unit tests with:
 
@@ -111,28 +111,6 @@ This command executes arbitrary commands in a bundler context within the module
 
 Note that for most uses, you must use the `--` to separate bundler options from pdk options. Compare the following two commands:
 
-```
-$ pdk bundle exec rake -T
-bundle: illegal option -- T
-
-```
-
-and
-
-```
-$ pdk bundle -- exec rake -T
-rake beaker                # Run beaker acceptance tests
-rake beaker:sets           # List available beaker nodesets
-rake beaker:ssh[set,node]  # Try to use vagrant to login to the Beaker node
-rake build                 # Build puppet module package
-[...]
-```
-
-#### Known issues
-
-
-Note that for PowerShell the `--` must be escaped using a backtick ( <code>`-- </code> ) or the shell parses it and strips it out of the command. See [PDK-408](https://tickets.puppet.com/browse/PDK-408) for details.
-
 ## Module Compatibility
 
 **PDK Version Compatibility:** Modules created with PDK version validate against and run on all Puppet and Ruby version combinations currently under maintenance (see https://docs.puppet.com/puppet/latest/about_agent.html and https://puppet.com/misc/puppet-enterprise-lifecycle)

data/lib/pdk/cli.rb

@@ -11,6 +11,7 @@ require 'pdk/i18n'
 require 'pdk/logger'
 require 'pdk/report'
 require 'pdk/util/version'
+require 'pdk/util/puppet_version'
 
 module PDK::CLI
   def self.run(args)
@@ -49,6 +50,11 @@ module PDK::CLI
     dsl.option nil, 'full-interview', _('When specified, interactive querying of metadata will include all optional questions.')
   end
 
+  def self.puppet_version_options(dsl)
+    dsl.option nil, 'puppet-version', _('Puppet version to run tests or validations against.'), argument: :required
+    dsl.option nil, 'pe-version', _('Puppet Enterprise version to run tests or validations against.'), argument: :required
+  end
+
   @base_cmd = Cri::Command.define do
     name 'pdk'
     usage _('pdk command [options]')

data/lib/pdk/cli/bundle.rb

@@ -2,11 +2,7 @@
 module PDK::CLI
   @bundle_cmd = @base_cmd.define_command do
     name 'bundle'
-    if Gem.win_platform?
-      usage _('bundle `-- [bundler_options]')
-    else
-      usage _('bundle -- [bundler_options]')
-    end
+    usage _('bundle [bundler_options]')
     summary _('(Experimental) Command pass-through to bundler')
     description _(<<-EOF
 [experimental] For advanced users, pdk bundle runs arbitrary commands in the bundler environment that pdk manages.
@@ -15,14 +11,24 @@ Careless use of this command can lead to errors that pdk can't help recover from
 Note that for PowerShell the '--' needs to be escaped using a backtick: '`--' to avoid it being parsed by the shell.
 EOF
                  )
+    skip_option_parsing
 
     run do |_opts, args, _cmd|
       PDK::CLI::Util.ensure_in_module!(
         message: _('`pdk bundle` can only be run from inside a valid module directory.'),
       )
 
+      PDK::CLI::Util.validate_puppet_version_opts({})
+
+      # Ensure that the correct Ruby is activated before running commend.
+      puppet_env = PDK::CLI::Util.puppet_from_opts_or_env({})
+      PDK::Util::RubyVersion.use(puppet_env[:ruby_version])
+
+      gemfile_env = PDK::Util::Bundler::BundleHelper.gemfile_env(puppet_env[:gemset])
+
       command = PDK::CLI::Exec::Command.new(PDK::CLI::Exec.bundle_bin, *args).tap do |c|
         c.context = :module
+        c.update_environment(gemfile_env)
       end
 
       result = command.execute!

data/lib/pdk/cli/exec.rb

@@ -6,6 +6,7 @@ require 'tty-which'
 
 require 'pdk/util'
 require 'pdk/util/git'
+require 'pdk/util/ruby_version'
 
 module PDK
   module CLI
@@ -14,6 +15,10 @@ module PDK
         Command.new(*cmd).execute!
       end
 
+      def self.execute_with_env(env, *cmd)
+        Command.new(*cmd).tap { |c| c.environment = env }.execute!
+      end
+
       def self.ensure_bin_present!(bin_path, bin_name)
         message = _('Unable to find `%{name}`. Check that it is installed and try again.') % {
           name: bin_name,
@@ -30,24 +35,31 @@ module PDK
 
       def self.bundle_bin
         bundle_bin = Gem.win_platform? ? 'bundle.bat' : 'bundle'
-        vendored_bin_path = File.join('private', 'ruby', '2.1.9', 'bin', bundle_bin)
+        vendored_bin_path = File.join('private', 'ruby', PDK::Util::RubyVersion.active_ruby_version, 'bin', bundle_bin)
 
         try_vendored_bin(vendored_bin_path, bundle_bin)
       end
 
       def self.try_vendored_bin(vendored_bin_path, fallback)
         unless PDK::Util.package_install?
-          PDK.logger.debug(_("PDK package installation not found. Trying '%{fallback}' from the system PATH instead.") % { fallback: fallback })
+          PDK.logger.debug(_("PDK package installation not found. Trying '%{fallback}' from the system PATH instead.") % {
+            fallback: fallback,
+          })
           return fallback
         end
 
-        if File.exist?(File.join(PDK::Util.pdk_package_basedir, vendored_bin_path))
-          PDK.logger.debug(_("Using '%{vendored_bin_path}' from PDK package.") % { vendored_bin_path: vendored_bin_path })
-          File.join(PDK::Util.pdk_package_basedir, vendored_bin_path)
-        else
-          PDK.logger.debug(_("Could not find '%{vendored_bin_path}' in PDK package. Trying '%{fallback}' from the system PATH instead.") % { fallback: fallback, vendored_bin_path: vendored_bin_path })
-          fallback
+        vendored_bin_full_path = File.join(PDK::Util.pdk_package_basedir, vendored_bin_path)
+
+        unless File.exist?(vendored_bin_full_path)
+          PDK.logger.debug(_("Could not find '%{vendored_bin}' in PDK package. Trying '%{fallback}' from the system PATH instead.") % {
+            fallback: fallback,
+            vendored_bin: vendored_bin_full_path,
+          })
+          return fallback
         end
+
+        PDK.logger.debug(_("Using '%{vendored_bin}' from PDK package.") % { vendored_bin: vendored_bin_full_path })
+        vendored_bin_full_path
       end
 
       # TODO: decide how/when to connect stdin to child process for things like pry
@@ -105,6 +117,10 @@ module PDK
           @spinner = TTY::Spinner.new("[:spinner] #{message}", opts.merge(PDK::CLI::Util.spinner_opts_for_platform))
         end
 
+        def update_environment(additional_env)
+          @environment.merge!(additional_env)
+        end
+
         def execute!
           # Start spinning if configured.
           @spinner.auto_spin if @spinner
@@ -115,26 +131,13 @@ module PDK
           end
 
           if context == :module
-            # `bundle install --path` ignores all "system" installed gems and causes unnecessary package installs
-            # `bundle install` (without --path) installs into GEM_HOME, which by default is non-user writeable
-            # To still use the pre-installed packages, but allow folks to install additional gems
-            # we set GEM_HOME to the user's cachedir, and put all other cache locations onto GEM_PATH
-            # See https://stackoverflow.com/a/11277228 for background
-            @process.environment['GEM_HOME'] = File.join(PDK::Util.cachedir, 'ruby', RbConfig::CONFIG['ruby_version'])
-
-            if PDK::Util.package_install?
-              # Subprocesses use their own set of gems which are managed by pdk or installed with the package.
-              @process.environment['GEM_PATH'] = File.join(PDK::Util.package_cachedir, 'ruby', RbConfig::CONFIG['ruby_version'])
-            else
-              # This allows the subprocess to find the 'bundler' gem, which isn't in the cachedir above for gem installs.
-              bundler_gem_path = File.absolute_path(File.join(`gem which bundler`, '..', '..', '..', '..'))
-              @process.environment['GEM_PATH'] = bundler_gem_path
-            end
+            @process.environment['GEM_HOME'] = PDK::Util::RubyVersion.gem_home
+            @process.environment['GEM_PATH'] = PDK::Util::RubyVersion.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
             @process.environment['PATH'] = [
-              RbConfig::CONFIG['bindir'],
+              PDK::Util::RubyVersion.bin_path,
               File.join(@process.environment['GEM_HOME'], 'bin'),
               File.join(@process.environment['GEM_PATH'], 'bin'),
               package_binpath,
@@ -201,12 +204,18 @@ module PDK
 
         def run_process!
           command_string = argv.join(' ')
+
           PDK.logger.debug(_("Executing '%{command}'") % { command: command_string })
+
           if context == :module
-            PDK.logger.debug(_("Command environment: GEM_HOME is '%{gem_home}' and GEM_PATH is '%{gem_path}'") % { gem_home: @process.environment['GEM_HOME'],
-                                                                                                                   gem_path: @process.environment['GEM_PATH'] })
+            PDK.logger.debug(_('Command environment:'))
+            @process.environment.each do |var, val|
+              PDK.logger.debug("  #{var}: #{val}")
+            end
           end
+
           start_time = Time.now
+
           begin
             @process.start
           rescue ChildProcess::LaunchError => e
@@ -223,7 +232,9 @@ module PDK
             # Wait indfinitely if no timeout set.
             @process.wait
           end
+
           @duration = Time.now - start_time
+
           PDK.logger.debug(_("Execution of '%{command}' complete (duration: %{duration_in_seconds}s; exit code: %{exit_code})") %
             { command: command_string, duration_in_seconds: @duration, exit_code: @process.exit_code })
         end

data/lib/pdk/cli/test/unit.rb

@@ -7,8 +7,9 @@ module PDK::CLI
     usage _('unit [options]')
     summary _('Run unit tests.')
 
+    PDK::CLI.puppet_version_options(self)
     flag nil, :list, _('List all available unit test files.')
-    flag nil, :parallel, _('Run unit tests in parallel.'), hidden: true
+    flag nil, :parallel, _('Run unit tests in parallel.')
     flag :v, :verbose, _('More verbose output. Displays examples in each unit test file.')
 
     option nil, :tests, _('Specify a comma-separated list of unit test files to run.'), argument: :required, default: '' do |values|
@@ -21,11 +22,15 @@ module PDK::CLI
     run do |opts, _args, _cmd|
       require 'pdk/tests/unit'
 
+      PDK::CLI::Util.validate_puppet_version_opts(opts)
+
       PDK::CLI::Util.ensure_in_module!(
         message:   _('Unit tests can only be run from inside a valid module directory.'),
         log_level: :info,
       )
 
+      PDK::CLI::Util.module_version_check
+
       report = nil
 
       if opts[:list]
@@ -57,6 +62,11 @@ module PDK::CLI
                            }]
                          end
 
+        # Ensure that the bundled gems are up to date and correct Ruby is activated before running tests.
+        puppet_env = PDK::CLI::Util.puppet_from_opts_or_env(opts)
+        PDK::Util::RubyVersion.use(puppet_env[:ruby_version])
+        PDK::Util::Bundler.ensure_bundle!(puppet_env[:gemset])
+
         exit_code = PDK::Test::Unit.invoke(report, opts)
 
         report_formats.each do |format|

data/lib/pdk/cli/util.rb

@@ -1,15 +1,6 @@
 module PDK
   module CLI
     module Util
-      MODULE_FOLDERS = %w[
-        manifests
-        lib
-        tasks
-        facts.d
-        functions
-        types
-      ].freeze
-
       # Ensures the calling code is being run from inside a module directory.
       #
       # @param opts [Hash] options to change the behavior of the check logic.
@@ -21,7 +12,7 @@ module PDK
       #   contain a Puppet module.
       def ensure_in_module!(opts = {})
         return unless PDK::Util.module_root.nil?
-        return if opts[:check_module_layout] && PDK::CLI::Util::MODULE_FOLDERS.any? { |dir| File.directory?(dir) }
+        return if opts[:check_module_layout] && PDK::Util.in_module_root?
 
         message = opts.fetch(:message, _('This command must be run from inside a valid module (no metadata.json found).'))
         raise PDK::CLI::ExitWithError.new(message, opts)
@@ -65,6 +56,112 @@ module PDK
         true
       end
       module_function :interactive?
+
+      def module_version_check
+        module_pdk_ver = PDK::Util.module_pdk_version
+
+        # This means the module does not have a pdk-version tag in the metadata.json
+        # and will require a pdk convert.
+        if module_pdk_ver.nil?
+          PDK.logger.warn _('This module is not PDK compatible. Run `pdk convert` to make it compatible with your version of PDK.')
+        # This checks that the version of pdk in the module's metadata is older
+        # than 1.3.1, which means the module will need to run pdk convert to the
+        # new templates.
+        elsif Gem::Version.new(module_pdk_ver) < Gem::Version.new('1.3.1')
+          PDK.logger.warn _('This module template is out of date. Run `pdk convert` to make it compatible with your version of PDK.')
+        # This checks if the version of the installed PDK is older than the
+        # version in the module's metadata, and advises the user to upgrade to
+        # their install of PDK.
+        elsif Gem::Version.new(PDK::VERSION) < Gem::Version.new(module_pdk_ver)
+          PDK.logger.warn _('This module is compatible with a newer version of PDK. Upgrade your version of PDK to ensure compatibility.')
+        # This checks if the version listed in the module's metadata is older
+        # than the installed PDK, and advises the user to run pdk update.
+        elsif Gem::Version.new(PDK::VERSION) > Gem::Version.new(module_pdk_ver)
+          PDK.logger.warn _('This module is compatible with an older version of PDK. Run `pdk update` to update it to your version of PDK.')
+        end
+      end
+      module_function :module_version_check
+
+      def puppet_from_opts_or_env(opts)
+        desired_puppet_version = (opts || {})[:'puppet-version'] || ENV['PDK_PUPPET_VERSION']
+        desired_pe_version = (opts || {})[:'pe-version'] || ENV['PDK_PE_VERSION']
+
+        begin
+          puppet_env =
+            if desired_puppet_version
+              PDK::Util::PuppetVersion.find_gem_for(desired_puppet_version)
+            elsif desired_pe_version
+              PDK::Util::PuppetVersion.from_pe_version(desired_pe_version)
+            else
+              PDK::Util::PuppetVersion.from_module_metadata || PDK::Util::PuppetVersion.latest_available
+            end
+        rescue ArgumentError => e
+          raise PDK::CLI::ExitWithError, e.message
+        end
+
+        # Notify user of what Ruby version will be used.
+        PDK.logger.info(_('Using Ruby %{version}') % {
+          version: puppet_env[:ruby_version],
+        })
+
+        gemset = { puppet: puppet_env[:gem_version].to_s }
+
+        # Notify user of what gems are being activated.
+        gemset.each do |gem, version|
+          next if version.nil?
+
+          PDK.logger.info(_('Using %{gem} %{version}') % {
+            gem: gem.to_s.capitalize,
+            version: version,
+          })
+        end
+
+        {
+          gemset: gemset,
+          ruby_version: puppet_env[:ruby_version],
+        }
+      end
+      module_function :puppet_from_opts_or_env
+
+      def validate_puppet_version_opts(opts)
+        puppet_ver_specs = []
+        puppet_ver_specs << '--puppet-version option' if opts[:'puppet-version']
+        puppet_ver_specs << 'PDK_PUPPET_VERSION environment variable' if ENV['PDK_PUPPET_VERSION'] && !ENV['PDK_PUPPET_VERSION'].empty?
+
+        pe_ver_specs = []
+        pe_ver_specs << '--pe-version option' if opts[:'pe-version']
+        pe_ver_specs << 'PDK_PE_VERSION environment variable' if ENV['PDK_PE_VERSION'] && !ENV['PDK_PE_VERSION'].empty?
+
+        puppet_ver_specs.each do |pup_ver_spec|
+          next if pe_ver_specs.empty?
+
+          offending = [pup_ver_spec, pe_ver_specs[0]].sort
+
+          raise PDK::CLI::ExitWithError, _('You cannot specify a %{first} and %{second} at the same time.') % {
+            first: offending[0],
+            second: offending[1],
+          }
+        end
+
+        if puppet_ver_specs.size == 2
+          warning_str = 'Puppet version option from command line: "--puppet-version=%{pup_ver_opt}" '
+          warning_str += 'overrides value from environment: "PDK_PUPPET_VERSION=%{pup_ver_env}". You should not specify both.'
+
+          PDK.logger.warn(_(warning_str) % {
+            pup_ver_opt: opts[:'puppet-version'],
+            pup_ver_env: ENV['PDK_PUPPET_VERSION'],
+          })
+        elsif pe_ver_specs.size == 2
+          warning_str = 'Puppet Enterprise version option from command line: "--pe-version=%{pe_ver_opt}" '
+          warning_str += 'overrides value from environment: "PDK_PE_VERSION=%{pe_ver_env}". You should not specify both.'
+
+          PDK.logger.warn(_(warning_str) % {
+            pup_ver_opt: opts[:'pe-version'],
+            pup_ver_env: ENV['PDK_PE_VERSION'],
+          })
+        end
+      end
+      module_function :validate_puppet_version_opts
     end
   end
 end