pdk 1.15.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1b4321e6c37cde43ae58cb4ca94cd578254270065c698c87455aa37976cea36
-  data.tar.gz: 054d826aefa38e7697d7b45e6f9c6733f4ad2f36501c9cb34dab7c1c6e47d2af
+  metadata.gz: fff9ce82e1ef158819f1089c8350fde37df2c9d8e105b09e4ecea52f542469bb
+  data.tar.gz: cff148b17b8175f7fe5401d5de87bebd36de18b939dcec7c456793d1da674ef7
 SHA512:
-  metadata.gz: 6ab2eba8dc386d45b6894a4aac0e17ff24208890fd73932cdebc10e9ffa0405e30280de45fc6190f24e3042b2ad7b208714171f581922be1a7bc601d6d212934
-  data.tar.gz: 52da98af48384e23b1fb2ca97dc1ad77d4811aa9f5dc6d9eaa89f9894e6d33a7e533b3b612699a33f9bbb02a3b29bd64a9b9b498cf04130288d16c78399f8b8b
+  metadata.gz: 0b8b0dc86dec798fcb51c8c1ab44ae0f591f84e0b6ee86ad6ede292e3fbd496495584ce83bcafdc6791bf93bdb134678033dbb695e9fb84519844bb7a776e69a
+  data.tar.gz: 365ba46da5e62d7519b9df797140cf75c904e2d64765b1ef72a6161e53a0e98bba5c2a8948404c6e2aff67b45678e842bd1621b86b8f334e4a7add46881948d3

data/CHANGELOG.md

@@ -4,6 +4,30 @@ 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.16.0](https://github.com/puppetlabs/pdk/tree/v1.16.0) (2020-02-05)
+[Full Changelog](https://github.com/puppetlabs/pdk/compare/v1.15.0...v1.16.0)
+
+**Implemented enhancements:**
+
+- \(PDK-1545\) Include template-ref in module generation output [\#840](https://github.com/puppetlabs/pdk/pull/840) ([rodjek](https://github.com/rodjek))
+- \(PDK-1587\) Reject paths with non-ASCII characters when building [\#832](https://github.com/puppetlabs/pdk/pull/832) ([rodjek](https://github.com/rodjek))
+- \(PDK-1588\) Increase granularity of `pdk bundle` analytics [\#827](https://github.com/puppetlabs/pdk/pull/827) ([rodjek](https://github.com/rodjek))
+- \(PDK-1557\) Detect Control Repositories [\#826](https://github.com/puppetlabs/pdk/pull/826) ([glennsarti](https://github.com/glennsarti))
+- \(PDK-1556\) Use the module root when generating objects [\#824](https://github.com/puppetlabs/pdk/pull/824) ([glennsarti](https://github.com/glennsarti))
+
+**Fixed bugs:**
+
+- Puppetfile Resolver can't detect version of Puppet from PDK using Visual Studio Code [\#830](https://github.com/puppetlabs/pdk/issues/830)
+- Validate and Test failing on new module [\#811](https://github.com/puppetlabs/pdk/issues/811)
+
+**Merged pull requests:**
+
+- \(maint\) Fix license\_finder failures [\#837](https://github.com/puppetlabs/pdk/pull/837) ([glennsarti](https://github.com/glennsarti))
+- \(PDK-1590\) Remove Gemfile.lock before running bundle update [\#834](https://github.com/puppetlabs/pdk/pull/834) ([rodjek](https://github.com/rodjek))
+- \(maint\) Use case insensitive environment variable names on Windows [\#825](https://github.com/puppetlabs/pdk/pull/825) ([glennsarti](https://github.com/glennsarti))
+- \(maint\) Update methods for Bundler 2.x deprecations  [\#820](https://github.com/puppetlabs/pdk/pull/820) ([glennsarti](https://github.com/glennsarti))
+- \(MAINT\) Refactor how gem\_path to bundler is calculated [\#745](https://github.com/puppetlabs/pdk/pull/745) ([scotje](https://github.com/scotje))
+
 ## [v1.15.0](https://github.com/puppetlabs/pdk/tree/v1.15.0) (2019-12-13)
 [Full Changelog](https://github.com/puppetlabs/pdk/compare/v1.14.1...v1.15.0)
 

data/lib/pdk.rb

@@ -3,7 +3,9 @@ require 'pdk/i18n'
 module PDK
   autoload :Analytics, 'pdk/analytics'
   autoload :AnswerFile, 'pdk/answer_file'
+  autoload :Bolt, 'pdk/bolt'
   autoload :Config, 'pdk/config'
+  autoload :ControlRepo, 'pdk/control_repo'
   autoload :Generate, 'pdk/generate'
   autoload :Logger, 'pdk/logger'
   autoload :Module, 'pdk/module'

data/lib/pdk/bolt.rb

@@ -0,0 +1,19 @@
+require 'pdk'
+
+module PDK
+  module Bolt
+    # Returns true or false depending on if any of the common files and directories in
+    # a Bolt Project are found in the specified directory. If a directory is not specified,
+    # the current working directory is used.
+    #
+    # @see https://puppet.com/docs/bolt/latest/bolt_project_directories.html
+    #
+    # @return [boolean] True if any bolt specific files or directories are present
+    #
+    def bolt_project_root?(path = Dir.pwd)
+      return true if File.basename(path) == 'Boltdir' && PDK::Util::Filesystem.directory?(path)
+      PDK::Util::Filesystem.file?(File.join(path, 'bolt.yaml'))
+    end
+    module_function :bolt_project_root?
+  end
+end

data/lib/pdk/cli/bundle.rb

@@ -20,7 +20,11 @@ EOF
 
       PDK::CLI::Util.validate_puppet_version_opts({})
 
-      PDK::CLI::Util.analytics_screen_view('bundle')
+      screen_view_name = ['bundle']
+      screen_view_name << args[0] if args.size >= 1
+      screen_view_name << args[1] if args.size >= 2 && args[0] == 'exec'
+
+      PDK::CLI::Util.analytics_screen_view(screen_view_name.join('_'))
 
       # Ensure that the correct Ruby is activated before running command.
       puppet_env = PDK::CLI::Util.puppet_from_opts_or_env({})

data/lib/pdk/cli/convert.rb

@@ -48,7 +48,7 @@ module PDK::CLI
         opts[:'full-interview'] = false
       end
 
-      PDK::Module::Convert.invoke(opts)
+      PDK::Module::Convert.invoke(PDK::Util.module_root, opts)
     end
   end
 end

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

@@ -163,7 +163,8 @@ module PDK
             require 'pdk/util/ruby_version'
 
             resolved_env['GEM_HOME'] = PDK::Util::RubyVersion.gem_home
-            resolved_env['GEM_PATH'] = PDK::Util::RubyVersion.gem_path
+            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
@@ -171,7 +172,7 @@ module PDK
             resolved_env['PATH'] = [
               PDK::Util::RubyVersion.bin_path,
               File.join(resolved_env['GEM_HOME'], 'bin'),
-              PDK::Util::RubyVersion.gem_paths_raw.map { |gem_path| File.join(gem_path, 'bin') },
+              PDK::Util::RubyVersion.gem_paths_raw.map { |gem_path_raw| File.join(gem_path_raw, 'bin') },
               package_binpath,
               PDK::Util.package_install? ? PDK::Util::Git.git_paths : nil,
               PDK::Util::Env['PATH'],
@@ -195,8 +196,13 @@ module PDK
         def run_process_in_clean_env!
           require 'bundler'
 
-          ::Bundler.with_clean_env do
-            run_process!
+          # Bundler 2.1.0 has deprecated the use of `Bundler.with_clean_env` in favour of
+          # `Bundler.with_unbundled_env`. So prefer to use the newer method if it exists
+          # otherwise revert back to the old method.
+          if ::Bundler.respond_to?(:with_unbundled_env)
+            run_process_with_unbundled_env!
+          else
+            run_process_with_clean_env!
           end
         end
 
@@ -236,6 +242,28 @@ module PDK
           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
+
+        private
+
+        #:nocov:
+        # These are just bundler helper methods and are tested via the public run_process_in_clean_env! method
+        def run_process_with_unbundled_env!
+          # Bundler 2.1.0 or greater
+          ::Bundler.with_unbundled_env do
+            run_process!
+          end
+        end
+        #:nocov:
+
+        #:nocov:
+        # These are just bundler helper methods and are tested via the public run_process_in_clean_env! method
+        def run_process_with_clean_env!
+          # Bundler 2.0.2 or less
+          ::Bundler.with_clean_env do
+            run_process!
+          end
+        end
+        #:nocov:
       end
     end
   end

data/lib/pdk/cli/new/class.rb

@@ -13,7 +13,6 @@ module PDK::CLI
       )
 
       class_name = args[0]
-      module_dir = Dir.pwd
 
       if class_name.nil? || class_name.empty?
         puts command.help
@@ -26,7 +25,7 @@ module PDK::CLI
 
       PDK::CLI::Util.analytics_screen_view('new_class', opts)
 
-      PDK::Generate::PuppetClass.new(module_dir, class_name, opts).run
+      PDK::Generate::PuppetClass.new(PDK::Util.module_root, class_name, opts).run
     end
   end
 end

data/lib/pdk/cli/new/defined_type.rb

@@ -11,7 +11,6 @@ module PDK::CLI
       )
 
       defined_type_name = args[0]
-      module_dir = Dir.pwd
 
       if defined_type_name.nil? || defined_type_name.empty?
         puts command.help
@@ -26,7 +25,7 @@ module PDK::CLI
 
       require 'pdk/generate/defined_type'
 
-      PDK::Generate::DefinedType.new(module_dir, defined_type_name, opts).run
+      PDK::Generate::DefinedType.new(PDK::Util.module_root, defined_type_name, opts).run
     end
   end
 end

data/lib/pdk/cli/new/provider.rb

@@ -8,7 +8,6 @@ module PDK::CLI
       PDK::CLI::Util.ensure_in_module!
 
       provider_name = args[0]
-      module_dir = Dir.pwd
 
       if provider_name.nil? || provider_name.empty?
         puts command.help
@@ -23,7 +22,7 @@ module PDK::CLI
 
       require 'pdk/generate/provider'
 
-      PDK::Generate::Provider.new(module_dir, provider_name, opts).run
+      PDK::Generate::Provider.new(PDK::Util.module_root, provider_name, opts).run
     end
   end
 end

data/lib/pdk/cli/new/task.rb

@@ -15,7 +15,6 @@ module PDK::CLI
       )
 
       task_name = args[0]
-      module_dir = Dir.pwd
 
       if task_name.nil? || task_name.empty?
         puts command.help
@@ -28,7 +27,7 @@ module PDK::CLI
 
       PDK::CLI::Util.analytics_screen_view('new_task', opts)
 
-      PDK::Generate::Task.new(module_dir, task_name, opts).run
+      PDK::Generate::Task.new(PDK::Util.module_root, task_name, opts).run
     end
   end
 end

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

@@ -18,7 +18,6 @@ module PDK::CLI
       )
 
       object_name = args[0]
-      module_dir = Dir.pwd
 
       if object_name.nil? || object_name.empty?
         puts command.help
@@ -41,7 +40,7 @@ module PDK::CLI
 
         PDK::CLI::Util.analytics_screen_view('new_test', opts)
 
-        generator.new(module_dir, obj['name'], opts.merge(spec_only: true)).run
+        generator.new(PDK::Util.module_root, obj['name'], opts.merge(spec_only: true)).run
       rescue PDK::Util::PuppetStrings::NoObjectError
         raise PDK::CLI::ExitWithError, _('Unable to find anything called "%{object}" to generate unit tests for.') % { object: object_name }
       rescue PDK::Util::PuppetStrings::NoGeneratorError => e

data/lib/pdk/cli/new/transport.rb

@@ -8,7 +8,6 @@ module PDK::CLI
       PDK::CLI::Util.ensure_in_module!
 
       transport_name = args[0]
-      module_dir = Dir.pwd
 
       if transport_name.nil? || transport_name.empty?
         puts command.help
@@ -21,7 +20,7 @@ module PDK::CLI
 
       require 'pdk/generate/transport'
 
-      PDK::Generate::Transport.new(module_dir, transport_name, opts).run
+      PDK::Generate::Transport.new(PDK::Util.module_root, transport_name, opts).run
     end
   end
 end

data/lib/pdk/cli/update.rb

@@ -46,7 +46,7 @@ module PDK::CLI
 
       PDK::CLI::Util.analytics_screen_view('update', opts)
 
-      updater = PDK::Module::Update.new(opts)
+      updater = PDK::Module::Update.new(PDK::Util.module_root, opts)
 
       if updater.pinned_to_puppetlabs_template_tag?
         PDK.logger.info _(

data/lib/pdk/control_repo.rb

@@ -0,0 +1,50 @@
+require 'pdk'
+
+module PDK
+  module ControlRepo
+    CONTROL_REPO_FILES = %w[environment.conf Puppetfile].freeze
+
+    # Returns path to the root of the Control Repo being worked on.
+    #
+    # An environment.conf is required for a PDK compatible Control Repo,
+    # whereas Puppetfile is optional.
+    #
+    # Note - A Bolt Project can also be a Control Repo.
+    #
+    # Note - Non-Directory environments can exist however directory based
+    # environments are the supported/preferred way.
+    #
+    # @see https://puppet.com/docs/pe/latest/control_repo.html
+    #
+    # @param strict_check [Boolean] When strict_check is true, only return the path
+    #   if the Control Repo is strictly _only_ a control repository. For example,
+    #   not also a Puppet Bolt project directory  Default is false.
+    #
+    # @return [String, nil] Fully qualified base path to Control Repo, or nil if
+    #   the current working dir does not appear to be within a Control Repo.
+    def find_control_repo_root(strict_check = false)
+      environment_conf_path = PDK::Util.find_upwards('environment.conf')
+      path = if environment_conf_path
+               File.dirname(environment_conf_path)
+             elsif control_repo_root?(Dir.pwd)
+               Dir.pwd
+             else
+               nil
+             end
+      return path if path.nil? || !strict_check
+      PDK::Bolt.bolt_project_root?(path) ? nil : path
+    end
+    module_function :find_control_repo_root
+
+    # Returns true or false depending on if any of the common files in a Control Repo
+    # are found in the specified directory. If a directory is not specified, the current
+    # working directory is used.
+    #
+    # @return [boolean] True if any folders from CONTROL_REPO_FILES are found in the current dir,
+    #   false otherwise.
+    def control_repo_root?(path = Dir.pwd)
+      CONTROL_REPO_FILES.any? { |file| PDK::Util::Filesystem.file?(File.join(path, file)) }
+    end
+    module_function :control_repo_root?
+  end
+end

data/lib/pdk/generate/module.rb

@@ -46,6 +46,17 @@ module PDK
 
         template_uri = PDK::Util::TemplateURI.new(opts)
 
+        if template_uri.default? && template_uri.default_ref?
+          PDK.logger.info _('Using the default template-url and template-ref.')
+        else
+          PDK.logger.info _(
+            "Using the %{method} template-url and template-ref '%{template_uri}'." % {
+              method: opts.key?(:'template-url') ? _('specified') : _('saved'),
+              template_uri: template_uri.metadata_format,
+            },
+          )
+        end
+
         begin
           PDK::Module::TemplateDir.with(template_uri, metadata.data, true) do |templates|
             templates.render do |file_path, file_content, file_status|
@@ -67,7 +78,7 @@ module PDK
 
         # Only update the answers files after metadata has been written.
         require 'pdk/answer_file'
-        if template_uri.default?
+        if template_uri.default? && template_uri.default_ref?
           # If the user specifies our default template url via the command
           # line, remove the saved template-url answer so that the template_uri
           # resolution can find new default URLs in the future.
@@ -87,8 +98,13 @@ module PDK
               end
             end
 
-            PDK.logger.info _('Module \'%{name}\' generated at path \'%{path}\', from template \'%{url}\'.') % { name: opts[:module_name], path: target_dir, url: template_uri.bare_uri }
-            PDK.logger.info(_('In your module directory, add classes with the \'pdk new class\' command.'))
+            PDK.logger.info _("Module '%{name}' generated at path '%{path}'.") % {
+              name: opts[:module_name],
+              path: target_dir,
+            }
+            PDK.logger.info _(
+              "In your module directory, add classes with the 'pdk new class' command.",
+            )
           end
         rescue Errno::EACCES => e
           raise PDK::CLI::FatalError, _("Failed to move '%{source}' to '%{target}': %{message}") % {

data/lib/pdk/generate/puppet_object.rb

@@ -16,7 +16,7 @@ module PDK
       # OBJECT_TYPE constant and implement the {#template_data},
       # {#target_object_path} and {#target_spec_path} methods.
       #
-      # @param module_dir [String] The path to the module directory that the
+      # @param module_dir [String] The path to the root of module that the
       #   will contain the object.
       # @param object_name [String] The name of the object.
       # @param options [Hash{Symbol => Object}]

data/lib/pdk/module/build.rb

@@ -115,6 +115,8 @@ module PDK
         relative_path = Pathname.new(path).relative_path_from(Pathname.new(module_dir))
         dest_path = File.join(build_dir, relative_path)
 
+        validate_path_encoding!(relative_path.to_path)
+
         if PDK::Util::Filesystem.directory?(path)
           PDK::Util::Filesystem.mkdir_p(dest_path, mode: PDK::Util::Filesystem.stat(path).mode)
         elsif PDK::Util::Filesystem.symlink?(path)
@@ -212,6 +214,27 @@ module PDK
         ) % { path: path }
       end
 
+      # Checks if the path contains any non-ASCII characters.
+      #
+      # Java will throw an error when it encounters a path containing
+      # characters that are not supported by the hosts locale. In order to
+      # maximise compatibility we limit the paths to contain only ASCII
+      # characters, which should be part of any locale character set.
+      #
+      # @param path [String] the relative path to be added to the tar file.
+      #
+      # @raise [ArgumentError] if the path contains non-ASCII characters.
+      #
+      # @return [nil]
+      def validate_path_encoding!(path)
+        return unless path =~ %r{[^\x00-\x7F]}
+
+        raise ArgumentError, _(
+          "'%{path}' can only include ASCII characters in its path or " \
+          'filename in order to be compatible with a wide range of hosts.',
+        ) % { path: path }
+      end
+
       # Creates a gzip compressed tarball of the build directory.
       #
       # If the destination package already exists, it will be removed before

data/lib/pdk/module/convert.rb

@@ -3,13 +3,16 @@ require 'pdk'
 module PDK
   module Module
     class Convert
-      def self.invoke(options)
-        new(options).run
+      def self.invoke(module_dir, options)
+        new(module_dir, options).run
       end
 
+      attr_reader :module_dir
+
       attr_reader :options
 
-      def initialize(options = {})
+      def initialize(module_dir, options = {})
+        @module_dir = module_dir
         @options = options
       end
 
@@ -94,7 +97,7 @@ module PDK
 
         test_gens = PDK::Util::PuppetStrings.all_objects.map do |generator, objects|
           (objects || []).map do |obj|
-            generator.new(Dir.pwd, obj['name'], spec_only: true)
+            generator.new(module_dir, obj['name'], spec_only: true)
           end
         end
 
@@ -114,7 +117,7 @@ module PDK
       def stage_changes!
         require 'pdk/util/filesystem'
 
-        metadata_path = 'metadata.json'
+        metadata_path = File.join(module_dir, 'metadata.json')
 
         PDK::Module::TemplateDir.with(template_uri, nil, true) do |templates|
           new_metadata = update_metadata(metadata_path, templates.metadata)
@@ -128,21 +131,22 @@ module PDK
             update_manager.add_file(metadata_path, new_metadata.to_json)
           end
 
-          templates.render do |file_path, file_content, file_status|
+          templates.render do |relative_file_path, file_content, file_status|
+            absolute_file_path = File.join(module_dir, relative_file_path)
             case file_status
             when :unmanage
-              PDK.logger.debug(_("skipping '%{path}'") % { path: file_path })
+              PDK.logger.debug(_("skipping '%{path}'") % { path: absolute_file_path })
             when :delete
-              update_manager.remove_file(file_path)
+              update_manager.remove_file(absolute_file_path)
             when :init
-              if convert? && !PDK::Util::Filesystem.exist?(file_path)
-                update_manager.add_file(file_path, file_content)
+              if convert? && !PDK::Util::Filesystem.exist?(absolute_file_path)
+                update_manager.add_file(absolute_file_path, file_content)
               end
             when :manage
-              if PDK::Util::Filesystem.exist?(file_path)
-                update_manager.modify_file(file_path, file_content)
+              if PDK::Util::Filesystem.exist?(absolute_file_path)
+                update_manager.modify_file(absolute_file_path, file_content)
               else
-                update_manager.add_file(file_path, file_content)
+                update_manager.add_file(absolute_file_path, file_content)
               end
             end
           end

data/lib/pdk/module/update.rb

@@ -51,7 +51,7 @@ module PDK
       end
 
       def module_metadata
-        @module_metadata ||= PDK::Module::Metadata.from_file('metadata.json')
+        @module_metadata ||= PDK::Module::Metadata.from_file(File.join(module_dir, 'metadata.json'))
       rescue ArgumentError => e
         raise PDK::CLI::ExitWithError, e.message
       end

data/lib/pdk/util/env.rb

@@ -4,25 +4,42 @@ require 'forwardable'
 module PDK
   module Util
     class Env
-      class << self
+      class WindowsEnv
         extend Forwardable
 
-        def_delegators :env_hash, :[], :key?, :fetch, :select, :reject
+        # Note, these delegators may not have case insensitive keys
+        def_delegators :env_hash, :fetch, :select, :reject
 
         def []=(key, value)
-          if Gem.win_platform?
-            PDK::Util::Windows::Process.set_environment_variable(key, value)
-          else
-            ENV[key] = value
+          PDK::Util::Windows::Process.set_environment_variable(key, value)
+        end
+
+        def key?(key)
+          !env_hash.keys.find { |item| key.casecmp(item).zero? }.nil?
+        end
+
+        def [](key)
+          env_hash.each do |item, value|
+            next unless key.casecmp(item).zero?
+            return value
           end
+          nil
         end
 
+        private
+
         def env_hash
-          if Gem.win_platform?
-            PDK::Util::Windows::Process.environment_hash
-          else
-            ENV
-          end
+          PDK::Util::Windows::Process.environment_hash
+        end
+      end
+
+      class << self
+        extend Forwardable
+
+        def_delegators :implementation, :key?, :[], :[]=, :fetch, :select, :reject
+
+        def implementation
+          @implementation ||= Gem.win_platform? ? WindowsEnv.new : ENV
         end
       end
     end

data/lib/pdk/util/ruby_version.rb

@@ -115,9 +115,7 @@ module PDK
         else
           # This allows the subprocess to find the 'bundler' gem, which isn't
           # in GEM_HOME for gem installs.
-          # TODO: There must be a better way to do this than shelling out to
-          # gem... Perhaps can be replaced with "Gem.path"?
-          [File.absolute_path(File.join(`gem which bundler`, '..', '..', '..', '..'))]
+          [File.absolute_path(File.join(bundler_basedir, '..', '..', '..'))]
         end
       end
 
@@ -128,6 +126,7 @@ module PDK
       def gem_home
         require 'pdk/util'
 
+        # TODO: bundle install --path is deprecated
         # `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
@@ -167,6 +166,10 @@ module PDK
       def versions
         self.class.versions
       end
+
+      def bundler_basedir
+        Gem::Specification.latest_specs.find { |spec| spec.name.eql?('bundler') }.base_dir
+      end
     end
   end
 end

data/lib/pdk/util/template_uri.rb

@@ -94,6 +94,10 @@ module PDK
         bare_uri == PDK::Util::TemplateURI.bare_uri(PDK::Util::TemplateURI.default_template_addressable_uri)
       end
 
+      def default_ref?
+        uri_fragment == self.class.default_template_ref(self)
+      end
+
       def puppetlabs_template?
         self.class.packaged_template?(bare_uri) || bare_uri == PDK_TEMPLATE_URL
       end

data/lib/pdk/version.rb

@@ -1,4 +1,4 @@
 module PDK
-  VERSION = '1.15.0'.freeze
+  VERSION = '1.16.0'.freeze
   TEMPLATE_REF = VERSION
 end

data/locales/pdk.pot

@@ -1,16 +1,16 @@
 # SOME DESCRIPTIVE TITLE.
-# Copyright (C) 2019 Puppet, Inc.
+# Copyright (C) 2020 Puppet, Inc.
 # This file is distributed under the same license as the puppet development kit package.
-# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2020.
 #
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: puppet development kit v1.14.1-59-gac5bc75\n"
+"Project-Id-Version: puppet development kit v1.15.0-30-g4c79619\n"
 "\n"
 "Report-Msgid-Bugs-To: docs@puppet.com\n"
-"POT-Creation-Date: 2019-12-13 13:31+1100\n"
-"PO-Revision-Date: 2019-12-13 13:31+1100\n"
+"POT-Creation-Date: 2020-02-05 12:17+1100\n"
+"PO-Revision-Date: 2020-02-05 12:17+1100\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
 "Language: \n"
@@ -317,19 +317,19 @@ msgstr ""
 msgid "%{varname} is not supported by PDK."
 msgstr ""
 
-#: ../lib/pdk/cli/exec/command.rb:206
+#: ../lib/pdk/cli/exec/command.rb:212
 msgid "Executing '%{command}'"
 msgstr ""
 
-#: ../lib/pdk/cli/exec/command.rb:209 ../lib/pdk/cli/exec/interactive_command.rb:78
+#: ../lib/pdk/cli/exec/command.rb:215 ../lib/pdk/cli/exec/interactive_command.rb:78
 msgid "Command environment:"
 msgstr ""
 
-#: ../lib/pdk/cli/exec/command.rb:220
+#: ../lib/pdk/cli/exec/command.rb:226
 msgid "Failed to execute '%{command}': %{message}"
 msgstr ""
 
-#: ../lib/pdk/cli/exec/command.rb:236
+#: ../lib/pdk/cli/exec/command.rb:242
 msgid "Execution of '%{command}' complete (duration: %{duration_in_seconds}s; exit code: %{exit_code})"
 msgstr ""
 
@@ -415,7 +415,7 @@ msgstr ""
 msgid "Classes can only be created from inside a valid module directory."
 msgstr ""
 
-#: ../lib/pdk/cli/new/class.rb:24
+#: ../lib/pdk/cli/new/class.rb:23
 msgid "'%{name}' is not a valid class name"
 msgstr ""
 
@@ -431,7 +431,7 @@ msgstr ""
 msgid "Defined types can only be created from inside a valid module directory."
 msgstr ""
 
-#: ../lib/pdk/cli/new/defined_type.rb:22
+#: ../lib/pdk/cli/new/defined_type.rb:21
 msgid "'%{name}' is not a valid defined type name"
 msgstr ""
 
@@ -463,7 +463,7 @@ msgstr ""
 msgid "[experimental] Create a new ruby provider named <name> using given options"
 msgstr ""
 
-#: ../lib/pdk/cli/new/provider.rb:19
+#: ../lib/pdk/cli/new/provider.rb:18
 msgid "'%{name}' is not a valid provider name"
 msgstr ""
 
@@ -483,7 +483,7 @@ msgstr ""
 msgid "Tasks can only be created from inside a valid module directory."
 msgstr ""
 
-#: ../lib/pdk/cli/new/task.rb:26
+#: ../lib/pdk/cli/new/task.rb:25
 msgid "'%{name}' is not a valid task name"
 msgstr ""
 
@@ -503,15 +503,15 @@ msgstr ""
 msgid "Tests can only be created from inside a valid module directory."
 msgstr ""
 
-#: ../lib/pdk/cli/new/test.rb:31
+#: ../lib/pdk/cli/new/test.rb:30
 msgid "Test type not specified, assuming unit."
 msgstr ""
 
-#: ../lib/pdk/cli/new/test.rb:46
+#: ../lib/pdk/cli/new/test.rb:45
 msgid "Unable to find anything called \"%{object}\" to generate unit tests for."
 msgstr ""
 
-#: ../lib/pdk/cli/new/test.rb:48
+#: ../lib/pdk/cli/new/test.rb:47
 msgid "PDK does not support generating unit tests for \"%{object_type}\" objects."
 msgstr ""
 
@@ -523,7 +523,7 @@ msgstr ""
 msgid "[experimental] Create a new ruby transport named <name> using given options"
 msgstr ""
 
-#: ../lib/pdk/cli/new/transport.rb:19
+#: ../lib/pdk/cli/new/transport.rb:18
 msgid "'%{name}' is not a valid transport name"
 msgstr ""
 
@@ -975,145 +975,161 @@ msgstr ""
 msgid "You do not have permission to write to '%{parent_dir}'"
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:90
-msgid "Module '%{name}' generated at path '%{path}', from template '%{url}'."
+#: ../lib/pdk/generate/module.rb:50
+msgid "Using the default template-url and template-ref."
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:91
+#: ../lib/pdk/generate/module.rb:52
+msgid "Using the %{method} template-url and template-ref '%{template_uri}'."
+msgstr ""
+
+#: ../lib/pdk/generate/module.rb:54
+msgid "specified"
+msgstr ""
+
+#: ../lib/pdk/generate/module.rb:54
+msgid "saved"
+msgstr ""
+
+#: ../lib/pdk/generate/module.rb:101
+msgid "Module '%{name}' generated at path '%{path}'."
+msgstr ""
+
+#: ../lib/pdk/generate/module.rb:105
 msgid "In your module directory, add classes with the 'pdk new class' command."
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:94
+#: ../lib/pdk/generate/module.rb:110
 msgid "Failed to move '%{source}' to '%{target}': %{message}"
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:110
+#: ../lib/pdk/generate/module.rb:126
 msgid "Your username is not a valid Forge username. Proceeding with the username %{username}. You can fix this later in metadata.json."
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:148
+#: ../lib/pdk/generate/module.rb:164
 msgid "Unable to create directory '%{dir}': %{message}"
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:163
+#: ../lib/pdk/generate/module.rb:179
 msgid "If you have a name for your module, add it here."
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:164
+#: ../lib/pdk/generate/module.rb:180
 msgid "This is the name that will be associated with your module, it should be relevant to the modules content."
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:167
+#: ../lib/pdk/generate/module.rb:183
 msgid "Module names must begin with a lowercase letter and can only include lowercase letters, numbers, and underscores."
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:171
+#: ../lib/pdk/generate/module.rb:187
 msgid "If you have a Puppet Forge username, add it here."
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:172
+#: ../lib/pdk/generate/module.rb:188
 msgid "We can use this to upload your module to the Forge when it's complete."
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:175
+#: ../lib/pdk/generate/module.rb:191
 msgid "Forge usernames can only contain lowercase letters and numbers"
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:180
+#: ../lib/pdk/generate/module.rb:196
 msgid "What version is this module?"
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:181
+#: ../lib/pdk/generate/module.rb:197
 msgid "Puppet uses Semantic Versioning (semver.org) to version modules."
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:184
+#: ../lib/pdk/generate/module.rb:200
 msgid "Semantic Version numbers must be in the form MAJOR.MINOR.PATCH"
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:190
+#: ../lib/pdk/generate/module.rb:206
 msgid "Who wrote this module?"
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:191
+#: ../lib/pdk/generate/module.rb:207
 msgid "This is used to credit the module's author."
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:197
+#: ../lib/pdk/generate/module.rb:213
 msgid "What license does this module code fall under?"
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:198
+#: ../lib/pdk/generate/module.rb:214
 msgid "This should be an identifier from https://spdx.org/licenses/. Common values are \"Apache-2.0\", \"MIT\", or \"proprietary\"."
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:204
+#: ../lib/pdk/generate/module.rb:220
 msgid "What operating systems does this module support?"
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:205
+#: ../lib/pdk/generate/module.rb:221
 msgid "Use the up and down keys to move between the choices, space to select and enter to continue."
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:216
+#: ../lib/pdk/generate/module.rb:232
 msgid "Summarize the purpose of this module in a single sentence."
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:217
+#: ../lib/pdk/generate/module.rb:233
 msgid "This helps other Puppet users understand what the module does."
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:224
+#: ../lib/pdk/generate/module.rb:240
 msgid "If there is a source code repository for this module, enter the URL here."
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:225
+#: ../lib/pdk/generate/module.rb:241
 msgid "Skip this if no repository exists yet. You can update this later in the metadata.json."
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:232
+#: ../lib/pdk/generate/module.rb:248
 msgid "If there is a URL where others can learn more about this module, enter it here."
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:233 ../lib/pdk/generate/module.rb:240
+#: ../lib/pdk/generate/module.rb:249 ../lib/pdk/generate/module.rb:256
 msgid "Optional. You can update this later in the metadata.json."
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:239
+#: ../lib/pdk/generate/module.rb:255
 msgid "If there is a public issue tracker for this module, enter its URL here."
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:267
+#: ../lib/pdk/generate/module.rb:283
 msgid ""
 "\n"
 "We need to update the metadata.json file for this module, so we\\'re going to ask you %{count} questions.\n"
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:274
+#: ../lib/pdk/generate/module.rb:290
 msgid ""
 "\n"
 "We need to create the metadata.json file for this module, so we\\'re going to ask you %{count} questions.\n"
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:282
+#: ../lib/pdk/generate/module.rb:298
 msgid ""
 "If the question is not applicable to this module, accept the default option shown after each question. You can modify any answers at any time by manually updating the metadata.json file.\n"
 "\n"
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:291
+#: ../lib/pdk/generate/module.rb:307
 msgid "No answers given, interview cancelled."
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:317
+#: ../lib/pdk/generate/module.rb:333
 msgid "Metadata will be generated based on this information, continue?"
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:319
+#: ../lib/pdk/generate/module.rb:335
 msgid "Interview cancelled; exiting."
 msgstr ""
 
-#: ../lib/pdk/generate/module.rb:323
+#: ../lib/pdk/generate/module.rb:339
 msgid "Process cancelled; exiting."
 msgstr ""
 
@@ -1193,64 +1209,68 @@ msgstr ""
 msgid "%{error}: Creating a transport needs some local configuration in your module. Please follow the docs at https://github.com/puppetlabs/puppet-resource_api#getting-started."
 msgstr ""
 
-#: ../lib/pdk/module/build.rb:127
+#: ../lib/pdk/module/build.rb:129
 msgid "%{message} Rename the file or exclude it from the package by adding it to the .pdkignore file in your module."
 msgstr ""
 
-#: ../lib/pdk/module/build.rb:157
+#: ../lib/pdk/module/build.rb:159
 msgid "Symlinks in modules are not supported and will not be included in the package. Please investigate symlink %{from} -> %{to}."
 msgstr ""
 
-#: ../lib/pdk/module/build.rb:184
+#: ../lib/pdk/module/build.rb:186
 msgid "The path '%{path}' is longer than 256 bytes."
 msgstr ""
 
-#: ../lib/pdk/module/build.rb:208
+#: ../lib/pdk/module/build.rb:210
 msgid "'%{path}' could not be split at a directory separator into two parts, the first having a maximum length of 155 bytes and the second having a maximum length of 100 bytes."
 msgstr ""
 
-#: ../lib/pdk/module/build.rb:243
+#: ../lib/pdk/module/build.rb:232
+msgid "'%{path}' can only include ASCII characters in its path or filename in order to be compatible with a wide range of hosts."
+msgstr ""
+
+#: ../lib/pdk/module/build.rb:266
 msgid "Updated permissions of packaged '%{entry}' to %{new_mode}"
 msgstr ""
 
-#: ../lib/pdk/module/convert.rb:29 ../lib/pdk/module/update.rb:20
+#: ../lib/pdk/module/convert.rb:32 ../lib/pdk/module/update.rb:20
 msgid "No changes required."
 msgstr ""
 
-#: ../lib/pdk/module/convert.rb:44
+#: ../lib/pdk/module/convert.rb:47
 msgid "Module conversion is a potentially destructive action. Ensure that you have committed your module to a version control system or have a backup, and review the changes above before continuing."
 msgstr ""
 
-#: ../lib/pdk/module/convert.rb:49 ../lib/pdk/module/update.rb:32
+#: ../lib/pdk/module/convert.rb:52 ../lib/pdk/module/update.rb:32
 msgid "Do you want to continue and make these changes to your module?"
 msgstr ""
 
-#: ../lib/pdk/module/convert.rb:134
+#: ../lib/pdk/module/convert.rb:138
 msgid "skipping '%{path}'"
 msgstr ""
 
-#: ../lib/pdk/module/convert.rb:173
+#: ../lib/pdk/module/convert.rb:177
 msgid "Unable to update module metadata; %{path} exists but it is not readable."
 msgstr ""
 
-#: ../lib/pdk/module/convert.rb:189
+#: ../lib/pdk/module/convert.rb:193
 msgid "Unable to update module metadata; %{path} exists but it is not a file."
 msgstr ""
 
-#: ../lib/pdk/module/convert.rb:234 ../lib/pdk/module/convert.rb:239 ../lib/pdk/module/convert.rb:245
+#: ../lib/pdk/module/convert.rb:238 ../lib/pdk/module/convert.rb:243 ../lib/pdk/module/convert.rb:249
 msgid ""
 "\n"
 "%{banner}"
 msgstr ""
 
-#: ../lib/pdk/module/convert.rb:247
+#: ../lib/pdk/module/convert.rb:251
 msgid ""
 "\n"
 "%{summary}\n"
 "\n"
 msgstr ""
 
-#: ../lib/pdk/module/convert.rb:256
+#: ../lib/pdk/module/convert.rb:260
 msgid ""
 "\n"
 "You can find a report of differences in %{path}.\n"
@@ -1749,31 +1769,31 @@ msgstr ""
 msgid "PDK::Util::TemplateURI attempted initialization with a non-uri string: {string}"
 msgstr ""
 
-#: ../lib/pdk/util/template_uri.rb:177
+#: ../lib/pdk/util/template_uri.rb:181
 msgid "%{scp_uri} appears to be an SCP style URL; it will be converted to an RFC compliant URI: %{rfc_uri}"
 msgstr ""
 
-#: ../lib/pdk/util/template_uri.rb:228
+#: ../lib/pdk/util/template_uri.rb:232
 msgid "--template-url"
 msgstr ""
 
-#: ../lib/pdk/util/template_uri.rb:229
+#: ../lib/pdk/util/template_uri.rb:233
 msgid "metadata.json"
 msgstr ""
 
-#: ../lib/pdk/util/template_uri.rb:230
+#: ../lib/pdk/util/template_uri.rb:234
 msgid "PDK answers"
 msgstr ""
 
-#: ../lib/pdk/util/template_uri.rb:231
+#: ../lib/pdk/util/template_uri.rb:235
 msgid "default"
 msgstr ""
 
-#: ../lib/pdk/util/template_uri.rb:255
+#: ../lib/pdk/util/template_uri.rb:259
 msgid "Unable to find a valid module template to use."
 msgstr ""
 
-#: ../lib/pdk/util/template_uri.rb:279
+#: ../lib/pdk/util/template_uri.rb:283
 msgid "Unable to find a valid template at %{uri}"
 msgstr ""
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdk
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 1.16.0
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-13 00:00:00.000000000 Z
+date: 2020-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -286,6 +286,7 @@ files:
 - lib/pdk/analytics/client/noop.rb
 - lib/pdk/analytics/util.rb
 - lib/pdk/answer_file.rb
+- lib/pdk/bolt.rb
 - lib/pdk/cli.rb
 - lib/pdk/cli/build.rb
 - lib/pdk/cli/bundle.rb
@@ -334,6 +335,7 @@ files:
 - lib/pdk/config/validator.rb
 - lib/pdk/config/yaml.rb
 - lib/pdk/config/yaml_with_schema.rb
+- lib/pdk/control_repo.rb
 - lib/pdk/generate.rb
 - lib/pdk/generate/defined_type.rb
 - lib/pdk/generate/module.rb