pdk 1.17.0 → 1.18.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdk
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 1.18.0
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-27 00:00:00.000000000 Z
+date: 2020-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,16 +76,22 @@ dependencies:
   name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.25
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.25
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: gettext-setup
   requirement: !ruby/object:Gem::Requirement
@@ -315,6 +321,10 @@ files:
 - lib/pdk/cli/release.rb
 - lib/pdk/cli/release/prep.rb
 - lib/pdk/cli/release/publish.rb
+- lib/pdk/cli/remove.rb
+- lib/pdk/cli/remove/config.rb
+- lib/pdk/cli/set.rb
+- lib/pdk/cli/set/config.rb
 - lib/pdk/cli/test.rb
 - lib/pdk/cli/test/unit.rb
 - lib/pdk/cli/update.rb
@@ -324,6 +334,7 @@ files:
 - lib/pdk/cli/util/option_normalizer.rb
 - lib/pdk/cli/util/option_validator.rb
 - lib/pdk/cli/util/spinner.rb
+- lib/pdk/cli/util/update_manager_printer.rb
 - lib/pdk/cli/validate.rb
 - lib/pdk/config.rb
 - lib/pdk/config/analytics_schema.json
@@ -350,6 +361,7 @@ files:
 - lib/pdk/generate/provider.rb
 - lib/pdk/generate/puppet_class.rb
 - lib/pdk/generate/puppet_object.rb
+- lib/pdk/generate/resource_api_object.rb
 - lib/pdk/generate/task.rb
 - lib/pdk/generate/transport.rb
 - lib/pdk/i18n.rb
@@ -359,15 +371,20 @@ files:
 - lib/pdk/module/convert.rb
 - lib/pdk/module/metadata.rb
 - lib/pdk/module/release.rb
-- lib/pdk/module/template_dir.rb
-- lib/pdk/module/template_dir/base.rb
-- lib/pdk/module/template_dir/git.rb
-- lib/pdk/module/template_dir/local.rb
 - lib/pdk/module/update.rb
 - lib/pdk/module/update_manager.rb
 - lib/pdk/report.rb
 - lib/pdk/report/event.rb
-- lib/pdk/template_file.rb
+- lib/pdk/template.rb
+- lib/pdk/template/fetcher.rb
+- lib/pdk/template/fetcher/git.rb
+- lib/pdk/template/fetcher/local.rb
+- lib/pdk/template/renderer.rb
+- lib/pdk/template/renderer/v1.rb
+- lib/pdk/template/renderer/v1/legacy_template_dir.rb
+- lib/pdk/template/renderer/v1/renderer.rb
+- lib/pdk/template/renderer/v1/template_file.rb
+- lib/pdk/template/template_dir.rb
 - lib/pdk/tests/unit.rb
 - lib/pdk/util.rb
 - lib/pdk/util/bundler.rb
@@ -375,6 +392,7 @@ files:
 - lib/pdk/util/env.rb
 - lib/pdk/util/filesystem.rb
 - lib/pdk/util/git.rb
+- lib/pdk/util/json_finder.rb
 - lib/pdk/util/puppet_strings.rb
 - lib/pdk/util/puppet_version.rb
 - lib/pdk/util/ruby_version.rb
@@ -387,6 +405,8 @@ files:
 - lib/pdk/util/windows/process.rb
 - lib/pdk/util/windows/string.rb
 - lib/pdk/validate.rb
+- lib/pdk/validate/control_repo/control_repo_validator_group.rb
+- lib/pdk/validate/control_repo/environment_conf_validator.rb
 - lib/pdk/validate/external_command_validator.rb
 - lib/pdk/validate/internal_ruby_validator.rb
 - lib/pdk/validate/invokable_validator.rb
@@ -427,7 +447,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubyforge_project: 
+rubygems_version: 2.6.14.3
 signing_key: 
 specification_version: 4
 summary: A key part of the Puppet Development Kit, the shortest path to better modules

data/lib/pdk/module/template_dir/base.rb

@@ -1,268 +0,0 @@
-require 'pdk'
-
-module PDK
-  module Module
-    module TemplateDir
-      class Base
-        attr_accessor :module_metadata
-        attr_reader :uri
-
-        # Initialises the TemplateDir object with the path or URL to the template
-        # and the block of code to run to be run while the template is available.
-        #
-        # The template directory is only guaranteed to be available on disk
-        # within the scope of the block passed to this method.
-        #
-        # @param uri [PDK::Util::TemplateURI] The path to a directory to use as the
-        # template or a URI to a git repository.
-        # @param module_metadata [Hash] A Hash containing the module metadata.
-        # Defaults to an empty Hash.
-        # @yieldparam self [PDK::Module::TemplateDir] The initialised object with
-        # the template available on disk.
-        #
-        # @example Using a git repository as a template
-        #   PDK::Module::TemplateDir::Base.new('https://github.com/puppetlabs/pdk-templates') do |t|
-        #     t.render do |filename, content|
-        #       File.open(filename, 'w') do |file|
-        #         file.write(content)
-        #       end
-        #     end
-        #   end
-        #
-        # @raise [ArgumentError] If no block is given to this method.
-        # @raise [PDK::CLI::FatalError] (see #clone_repo)
-        # @raise [ArgumentError] (see #validate_module_template!)
-        #
-        # @api public
-        def initialize(uri, module_metadata = {}, init = false)
-          unless block_given?
-            raise ArgumentError, _('%{class_name} must be initialized with a block.') % { class_name: self.class.name }
-          end
-          unless uri.is_a? PDK::Util::TemplateURI
-            raise ArgumentError, _('%{class_name} must be initialized with a PDK::Util::TemplateURI, got a %{uri_type}') % { uri_type: uri.class, class_name: self.class.name }
-          end
-
-          @path, @is_temporary_path = template_path(uri)
-          @uri = uri
-
-          @init = init
-          @moduleroot_dir = PDK::Module::TemplateDir.moduleroot_dir(@path)
-          @moduleroot_init = PDK::Module::TemplateDir.moduleroot_init(@path)
-          @dirs = [@moduleroot_dir]
-          @dirs << @moduleroot_init if @init
-          @object_dir = File.join(@path, 'object_templates')
-
-          PDK::Module::TemplateDir.validate_module_template!(@path)
-
-          @module_metadata = module_metadata
-
-          template_type = uri.default? ? 'default' : 'custom'
-          PDK.analytics.event('TemplateDir', 'initialize', label: template_type)
-
-          yield self
-        ensure
-          # If the the path is temporary, clean it up
-          if @is_temporary_path
-            PDK::Util::Filesystem.rm_rf(@path)
-          end
-        end
-
-        # Retrieve identifying metadata for the template.
-        #
-        # For git repositories, this will return the URL to the repository and
-        # a reference to the HEAD.
-        #
-        # For plain fileystem directories, this will return the URL to the repository only.
-        #
-        # @return [Hash{String => String}] A hash of identifying metadata.
-        #
-        # @api public
-        # @abstract
-        def metadata
-          {
-            'pdk-version'  => PDK::Util::Version.version_string,
-            'template-url' => nil,
-            'template-ref' => nil,
-          }
-        end
-
-        # Loop through the files in the template, yielding each rendered file to
-        # the supplied block.
-        #
-        # @yieldparam dest_path [String] The path of the destination file,
-        # relative to the root of the module.
-        # @yieldparam dest_content [String] The rendered content of the
-        # destination file.
-        #
-        # @raise [PDK::CLI::FatalError] If the template fails to render.
-        #
-        # @return [void]
-        #
-        # @api public
-        def render
-          require 'pdk/template_file'
-
-          PDK::Module::TemplateDir.files_in_template(@dirs).each do |template_file, template_loc|
-            template_file = template_file.to_s
-            PDK.logger.debug(_("Rendering '%{template}'...") % { template: template_file })
-            dest_path = template_file.sub(%r{\.erb\Z}, '')
-            config = config_for(dest_path)
-
-            dest_status = if template_loc.start_with?(@moduleroot_init)
-                            :init
-                          else
-                            :manage
-                          end
-
-            if config['unmanaged']
-              dest_status = :unmanage
-            elsif config['delete']
-              dest_status = :delete
-            else
-              begin
-                dest_content = PDK::TemplateFile.new(File.join(template_loc, template_file), configs: config, template_dir: self).render
-              rescue => error
-                error_msg = _(
-                  "Failed to render template '%{template}'\n" \
-                  '%{exception}: %{message}',
-                ) % { template: template_file, exception: error.class, message: error.message }
-                raise PDK::CLI::FatalError, error_msg
-              end
-            end
-
-            yield dest_path, dest_content, dest_status
-          end
-        end
-
-        # Searches the template directory for template files that can be used to
-        # render files for the specified object type.
-        #
-        # @param object_type [Symbol] The object type, e.g. (`:class`,
-        # `:defined_type`, `:fact`, etc).
-        #
-        # @return [Hash{Symbol => String}] if the templates are available in the
-        # template dir, otherwise `nil`. The returned hash can contain two keys,
-        # :object contains the path on disk to the template for the object, :spec
-        # contains the path on disk to the template for the object's spec file
-        # (if available).
-        #
-        # @api public
-        def object_template_for(object_type)
-          object_path = File.join(@object_dir, "#{object_type}.erb")
-          type_path = File.join(@object_dir, "#{object_type}_type.erb")
-          device_path = File.join(@object_dir, "#{object_type}_device.erb")
-          spec_path = File.join(@object_dir, "#{object_type}_spec.erb")
-          type_spec_path = File.join(@object_dir, "#{object_type}_type_spec.erb")
-
-          if PDK::Util::Filesystem.file?(object_path) && PDK::Util::Filesystem.readable?(object_path)
-            result = { object: object_path }
-            result[:type] = type_path if PDK::Util::Filesystem.file?(type_path) && PDK::Util::Filesystem.readable?(type_path)
-            result[:spec] = spec_path if PDK::Util::Filesystem.file?(spec_path) && PDK::Util::Filesystem.readable?(spec_path)
-            result[:device] = device_path if PDK::Util::Filesystem.file?(device_path) && PDK::Util::Filesystem.readable?(device_path)
-            result[:type_spec] = type_spec_path if PDK::Util::Filesystem.file?(type_spec_path) && PDK::Util::Filesystem.readable?(type_spec_path)
-            result
-          else
-            nil
-          end
-        end
-
-        # Generate a hash of data to be used when rendering object templates.
-        #
-        # Read `config_defaults.yml` from the root of the template directory (if
-        # it exists) build a hash of values from the value of the `:global`
-        # key.
-        #
-        # @return [Hash] The data that will be available to the template via the
-        # `@configs` instance variable.
-        #
-        # @api private
-        def object_config
-          config_for(nil)
-        end
-
-        # Generate a hash of data to be used when rendering the specified
-        # template.
-        #
-        # @param dest_path [String] The destination path of the file that the
-        # data is for, relative to the root of the module.
-        #
-        # @return [Hash] The data that will be available to the template via the
-        # `@configs` instance variable.
-        #
-        # @api private
-        def config_for(dest_path, sync_config_path = nil)
-          require 'pdk/util'
-          require 'pdk/analytics'
-
-          module_root = PDK::Util.module_root
-          sync_config_path ||= File.join(module_root, '.sync.yml') unless module_root.nil?
-          config_path = File.join(@path, 'config_defaults.yml')
-
-          if @config.nil?
-            require 'deep_merge'
-            conf_defaults = read_config(config_path)
-            @sync_config = read_config(sync_config_path) unless sync_config_path.nil?
-            @config = conf_defaults
-            @config.deep_merge!(@sync_config, knockout_prefix: '---') unless @sync_config.nil?
-          end
-          file_config = @config.fetch(:global, {})
-          file_config['module_metadata'] = @module_metadata
-          file_config.merge!(@config.fetch(dest_path, {})) unless dest_path.nil?
-          file_config.merge!(@config).tap do |c|
-            if uri.default?
-              file_value = if c['unmanaged']
-                             'unmanaged'
-                           elsif c['delete']
-                             'deleted'
-                           elsif @sync_config && @sync_config.key?(dest_path)
-                             'customized'
-                           else
-                             'default'
-                           end
-
-              PDK.analytics.event('TemplateDir', 'file', label: dest_path, value: file_value)
-            end
-          end
-        end
-
-        # Generates a hash of data from a given yaml file location.
-        #
-        # @param loc [String] The path of the yaml config file.
-        #
-        # @warn If the specified path is not a valid yaml file. Returns an empty Hash
-        # if so.
-        #
-        # @return [Hash] The data that has been read in from the given yaml file.
-        #
-        # @api private
-        def read_config(loc)
-          if PDK::Util::Filesystem.file?(loc) && PDK::Util::Filesystem.readable?(loc)
-            require 'yaml'
-
-            begin
-              YAML.safe_load(PDK::Util::Filesystem.read_file(loc), [], [], true)
-            rescue Psych::SyntaxError => e
-              PDK.logger.warn _("'%{file}' is not a valid YAML file: %{problem} %{context} at line %{line} column %{column}") % {
-                file:    loc,
-                problem: e.problem,
-                context: e.context,
-                line:    e.line,
-                column:  e.column,
-              }
-              {}
-            end
-          else
-            {}
-          end
-        end
-
-        # @return [Path, Boolean] The path to the Template and whether this path is temporary. Temporary paths
-        #         are deleted once the object has yielded
-        # @api private
-        def template_path(uri)
-          [uri.shell_path, false]
-        end
-      end
-    end
-  end
-end

data/lib/pdk/module/template_dir/git.rb

@@ -1,91 +0,0 @@
-require 'pdk'
-require 'pdk/module/template_dir/base'
-
-module PDK
-  module Module
-    module TemplateDir
-      class Git < Base
-        def template_path(uri)
-          # We don't do a checkout of local-path repos. There are lots of edge
-          # cases or user un-expectations.
-          if PDK::Util::Git.work_tree?(uri.shell_path)
-            PDK.logger.warn _("Repository '%{repo}' has a work-tree; skipping git reset.") % {
-              repo: uri.shell_path,
-            }
-            [uri.shell_path, false]
-          else
-            # This is either a bare local repo or a remote. either way it needs cloning.
-            # A "remote" can also be git repo on the local filsystem.
-            [clone_template_repo(uri), true]
-          end
-        end
-
-        # For git repositories, this will return the URL to the repository and
-        # a reference to the HEAD.
-        #
-        # @return [Hash{String => String}] A hash of identifying metadata.
-        def metadata
-          super.merge('template-url' => uri.metadata_format, 'template-ref' => cache_template_ref(@path))
-        end
-
-        private
-
-        def cache_template_ref(path, ref = nil)
-          require 'pdk/util/git'
-
-          @template_ref ||= PDK::Util::Git.describe(File.join(path, '.git'), ref)
-        end
-
-        # @return [String] Path to working directory into which template repo has been cloned and reset
-        #
-        # @raise [PDK::CLI::FatalError] If unable to clone the given origin_repo into a tempdir.
-        # @raise [PDK::CLI::FatalError] If reset HEAD of the cloned repo to desired ref.
-        #
-        # @api private
-        def clone_template_repo(uri)
-          # @todo When switching this over to using rugged, cache the cloned
-          # template repo in `%AppData%` or `$XDG_CACHE_DIR` and update before
-          # use.
-          require 'pdk/util'
-          require 'pdk/util/git'
-
-          temp_dir = PDK::Util.make_tmpdir_name('pdk-templates')
-          origin_repo = uri.bare_uri
-          git_ref = uri.uri_fragment
-
-          clone_result = PDK::Util::Git.git('clone', origin_repo, temp_dir)
-
-          if clone_result[:exit_code].zero?
-            checkout_template_ref(temp_dir, git_ref)
-          else
-            PDK.logger.error clone_result[:stdout]
-            PDK.logger.error clone_result[:stderr]
-            raise PDK::CLI::FatalError, _("Unable to clone git repository at '%{repo}' into '%{dest}'.") % { repo: origin_repo, dest: temp_dir }
-          end
-
-          PDK::Util.canonical_path(temp_dir)
-        end
-
-        # @api private
-        def checkout_template_ref(path, ref)
-          require 'pdk/util/git'
-
-          if PDK::Util::Git.work_dir_clean?(path)
-            Dir.chdir(path) do
-              full_ref = PDK::Util::Git.ls_remote(path, ref)
-              cache_template_ref(path, full_ref)
-              reset_result = PDK::Util::Git.git('reset', '--hard', full_ref)
-              return if reset_result[:exit_code].zero?
-
-              PDK.logger.error reset_result[:stdout]
-              PDK.logger.error reset_result[:stderr]
-              raise PDK::CLI::FatalError, _("Unable to checkout '%{ref}' of git repository at '%{path}'.") % { ref: ref, path: path }
-            end
-          else
-            PDK.logger.warn _("Uncommitted changes found when attempting to checkout '%{ref}' of git repository at '%{path}'; skipping git reset.") % { ref: ref, path: path }
-          end
-        end
-      end
-    end
-  end
-end

data/lib/pdk/module/template_dir/local.rb

@@ -1,21 +0,0 @@
-require 'pdk'
-require 'pdk/module/template_dir/base'
-
-module PDK
-  module Module
-    module TemplateDir
-      class Local < Base
-        def template_path(uri)
-          [uri.shell_path, false]
-        end
-
-        # For plain fileystem directories, this will return the URL to the repository only.
-        #
-        # @return [Hash{String => String}] A hash of identifying metadata.
-        def metadata
-          super.merge('template-url' => uri.bare_uri)
-        end
-      end
-    end
-  end
-end

data/lib/pdk/module/template_dir.rb

@@ -1,115 +0,0 @@
-require 'pdk'
-
-module PDK
-  module Module
-    module TemplateDir
-      # Creates a TemplateDir object with the path or URL to the template
-      # and the block of code to run to be run while the template is available.
-      #
-      # The template directory is only guaranteed to be available on disk
-      # within the scope of the block passed to this method.
-      #
-      # @param uri [PDK::Util::TemplateURI] The path to a directory to use as the
-      # template or a URI to a git repository.
-      # @param module_metadata [Hash] A Hash containing the module metadata.
-      # Defaults to an empty Hash.
-      # @yieldparam self [PDK::Module::TemplateDir] The initialised object with
-      # the template available on disk.
-      #
-      # @example Using a git repository as a template
-      #   PDK::Module::TemplateDir.with('https://github.com/puppetlabs/pdk-templates') do |t|
-      #     t.render do |filename, content|
-      #       File.open(filename, 'w') do |file|
-      #         file.write(content)
-      #       end
-      #     end
-      #   end
-      #
-      # @raise [ArgumentError] If no block is given to this method.
-      # @raise [PDK::CLI::FatalError] (see #clone_repo)
-      # @raise [ArgumentError] (see #validate_module_template!)
-      #
-      # @api public
-      def self.with(uri, module_metadata = {}, init = false)
-        unless block_given?
-          raise ArgumentError, _('%{class_name}.with must be passed a block.') % { class_name: name }
-        end
-        unless uri.is_a? PDK::Util::TemplateURI
-          raise ArgumentError, _('%{class_name}.with must be passed a PDK::Util::TemplateURI, got a %{uri_type}') % { uri_type: uri.class, class_name: name }
-        end
-
-        if PDK::Util::Git.repo?(uri.bare_uri)
-          require 'pdk/module/template_dir/git'
-          PDK::Module::TemplateDir::Git.new(uri, module_metadata, init) { |value| yield value }
-        else
-          require 'pdk/module/template_dir/local'
-          PDK::Module::TemplateDir::Local.new(uri, module_metadata, init) { |value| yield value }
-        end
-      end
-
-      def self.moduleroot_dir(template_root_dir)
-        File.join(template_root_dir, 'moduleroot')
-      end
-
-      def self.moduleroot_init(template_root_dir)
-        File.join(template_root_dir, 'moduleroot_init')
-      end
-
-      # Validate the content of the template directory.
-      #
-      # @raise [ArgumentError] If the specified path is not a directory.
-      # @raise [ArgumentError] If the template directory does not contain
-      # a directory called 'moduleroot'.
-      #
-      # @return [void]
-      #
-      # @api public
-      def self.validate_module_template!(template_root_dir)
-        # rubocop:disable Style/GuardClause
-        unless PDK::Util::Filesystem.directory?(template_root_dir)
-          require 'pdk/util'
-
-          if PDK::Util.package_install? && PDK::Util::Filesystem.fnmatch?(File.join(PDK::Util.package_cachedir, '*'), template_root_dir)
-            raise ArgumentError, _('The built-in template has substantially changed. Please run "pdk convert" on your module to continue.')
-          else
-            raise ArgumentError, _("The specified template '%{path}' is not a directory.") % { path: template_root_dir }
-          end
-        end
-
-        unless PDK::Util::Filesystem.directory?(moduleroot_dir(template_root_dir))
-          raise ArgumentError, _("The template at '%{path}' does not contain a 'moduleroot/' directory.") % { path: template_root_dir }
-        end
-
-        unless PDK::Util::Filesystem.directory?(moduleroot_init(template_root_dir))
-          # rubocop:disable Metrics/LineLength
-          raise ArgumentError, _("The template at '%{path}' does not contain a 'moduleroot_init/' directory, which indicates you are using an older style of template. Before continuing please use the --template-url flag when running the pdk new commands to pass a new style template.") % { path: template_root_dir }
-          # rubocop:enable Metrics/LineLength
-        end
-        # rubocop:enable Style/GuardClause
-      end
-
-      # Get a list of template files in the template directory.
-      #
-      # @return [Hash{String=>String}] A hash of key file names and
-      # value locations.
-      #
-      # @api public
-      def self.files_in_template(dirs)
-        temp_paths = []
-        dirlocs = []
-        dirs.each do |dir|
-          raise ArgumentError, _("The directory '%{dir}' doesn't exist") % { dir: dir } unless PDK::Util::Filesystem.directory?(dir)
-          temp_paths += PDK::Util::Filesystem.glob(File.join(dir, '**', '*'), File::FNM_DOTMATCH).select do |template_path|
-            if PDK::Util::Filesystem.file?(template_path) && !PDK::Util::Filesystem.symlink?(template_path)
-              dirlocs << dir
-            end
-          end
-          temp_paths.map do |template_path|
-            template_path.sub!(%r{\A#{Regexp.escape(dir)}#{Regexp.escape(File::SEPARATOR)}}, '')
-          end
-        end
-        Hash[temp_paths.zip dirlocs]
-      end
-    end
-  end
-end