pdk 1.17.0 → 1.18.0

data/lib/pdk/generate/provider.rb

@@ -2,75 +2,26 @@ require 'pdk'
 
 module PDK
   module Generate
-    class Provider < PuppetObject
-      OBJECT_TYPE = :provider
-
-      # Prepares the data needed to render the new defined type template.
-      #
-      # @return [Hash{Symbol => Object}] a hash of information that will be
-      # provided to the defined type and defined type spec templates during
-      # rendering.
-      def template_data
-        data = {
-          name: object_name,
-          provider_class: Provider.class_name_from_object_name(object_name),
-        }
-
-        data
-      end
-
-      def raise_precondition_error(error)
-        raise PDK::CLI::ExitWithError, _('%{error}: Creating a provider needs some local configuration in your module.' \
-          ' Please follow the docs at https://puppet.com/docs/puppet/latest/create_types_and_providers_resource_api.html.') % { error: error }
-      end
-
-      def check_preconditions
-        super
-        # These preconditions can be removed once the pdk-templates are carrying the puppet-resource_api gem by default, and have switched
-        # the default mock_with value.
-        sync_path = PDK::Util.find_upwards('.sync.yml')
-        if sync_path.nil?
-          raise_precondition_error(_('.sync.yml not found'))
-        end
-        sync = YAML.load_file(sync_path)
-        if !sync.is_a? Hash
-          raise_precondition_error(_('.sync.yml contents is not a Hash'))
-        elsif !sync.key? 'Gemfile'
-          raise_precondition_error(_('Gemfile configuration not found'))
-        elsif !sync['Gemfile'].key? 'optional'
-          raise_precondition_error(_('Gemfile.optional configuration not found'))
-        elsif !sync['Gemfile']['optional'].key? ':development'
-          raise_precondition_error(_('Gemfile.optional.:development configuration not found'))
-        elsif sync['Gemfile']['optional'][':development'].none? { |g| g['gem'] == 'puppet-resource_api' }
-          raise_precondition_error(_('puppet-resource_api not found in the Gemfile config'))
-        elsif !sync.key? 'spec/spec_helper.rb'
-          raise_precondition_error(_('spec/spec_helper.rb configuration not found'))
-        elsif !sync['spec/spec_helper.rb'].key? 'mock_with'
-          raise_precondition_error(_('spec/spec_helper.rb.mock_with configuration not found'))
-        elsif !sync['spec/spec_helper.rb']['mock_with'] == ':rspec'
-          raise_precondition_error(_('spec/spec_helper.rb.mock_with not set to \':rspec\''))
-        end
-      end
-
-      # @return [String] the path where the new provider will be written.
-      def target_object_path
-        @target_object_path ||= File.join(module_dir, 'lib', 'puppet', 'provider', object_name, object_name) + '.rb'
+    class Provider < ResourceAPIObject
+      def friendly_name
+        'Resource API Provider'.freeze
       end
 
-      # @return [String] the path where the new type will be written.
-      def target_type_path
-        @target_type_path ||= File.join(module_dir, 'lib', 'puppet', 'type', object_name) + '.rb'
-      end
-
-      # @return [String] the path where the tests for the new provider
-      # will be written.
-      def target_spec_path
-        @target_spec_path ||= File.join(module_dir, 'spec', 'unit', 'puppet', 'provider', object_name, object_name) + '_spec.rb'
+      def template_files
+        files = {
+          'provider_spec.erb'      => File.join('spec', 'unit', 'puppet', 'provider', object_name, object_name) + '_spec.rb',
+          'provider_type_spec.erb' => File.join('spec', 'unit', 'puppet', 'type', object_name) + '_spec.rb',
+        }
+        return files if spec_only?
+        files.merge(
+          'provider.erb' => File.join('lib', 'puppet', 'provider', object_name, object_name) + '.rb',
+          'provider_type.erb' => File.join('lib', 'puppet', 'type', object_name) + '.rb',
+        )
       end
 
-      # @return [String] the path where the tests for the new type will be written.
-      def target_type_spec_path
-        @target_type_spec_path ||= File.join(module_dir, 'spec', 'unit', 'puppet', 'type', object_name) + '_spec.rb'
+      def template_data
+        { name: object_name,
+          provider_class: class_name_from_object_name(object_name) }
       end
     end
   end

data/lib/pdk/generate/puppet_class.rb

@@ -3,46 +3,40 @@ require 'pdk'
 module PDK
   module Generate
     class PuppetClass < PuppetObject
-      OBJECT_TYPE = :class
       PUPPET_STRINGS_TYPE = 'puppet_classes'.freeze
 
-      # Prepares the data needed to render the new Puppet class template.
-      #
-      # @return [Hash{Symbol => Object}] a hash of information that will be
-      # provided to the class and class spec templates during rendering.
-      def template_data
-        data = { name: object_name }
+      def initialize(*_args)
+        super
+        object_name_parts = @object_name.split('::')
 
-        data
+        @object_name = if object_name_parts.first == module_name
+                         object_name
+                       else
+                         [module_name, object_name].join('::')
+                       end
       end
 
-      # Calculates the path to the .pp file that the new class will be written
-      # to.
-      #
-      # @return [String] the path where the new class will be written.
-      def target_object_path
-        @target_pp_path ||= begin
-          class_name_parts = object_name.split('::')[1..-1]
-          class_name_parts << 'init' if class_name_parts.empty?
-
-          "#{File.join(module_dir, 'manifests', *class_name_parts)}.pp"
-        end
+      def friendly_name
+        'Puppet Class'.freeze
       end
 
-      # Calculates the path to the file where the tests for the new class will
-      # be written.
-      #
-      # @return [String] the path where the tests for the new class will be
-      # written.
-      def target_spec_path
-        @target_spec_path ||= begin
-          class_name_parts = object_name.split('::')
+      def template_files
+        # Calculate the class tests name
+        class_name_parts = object_name.split('::')
+        # Drop the module name if the object name contains multiple parts
+        class_name_parts.delete_at(0) if class_name_parts.length > 1
+        files = { 'class_spec.erb' => File.join('spec', 'classes', *class_name_parts) + '_spec.rb' }
+        return files if spec_only?
+
+        class_name_parts = object_name.split('::')[1..-1]
+        class_name_parts << 'init' if class_name_parts.empty?
+        files['class.erb'] = File.join('manifests', *class_name_parts) + '.pp'
 
-          # drop the module name if the object name contains multiple parts
-          class_name_parts.delete_at(0) if class_name_parts.length > 1
+        files
+      end
 
-          "#{File.join(module_dir, 'spec', 'classes', *class_name_parts)}_spec.rb"
-        end
+      def template_data
+        { name: object_name }
       end
     end
   end

data/lib/pdk/generate/puppet_object.rb

@@ -3,7 +3,7 @@ require 'pdk'
 module PDK
   module Generate
     class PuppetObject
-      attr_reader :module_dir
+      attr_reader :context
       attr_reader :object_name
       attr_reader :options
 
@@ -20,228 +20,124 @@ module PDK
       #   will contain the object.
       # @param object_name [String] The name of the object.
       # @param options [Hash{Symbol => Object}]
-      #
-      # @api public
-      def initialize(module_dir, object_name, options)
-        @module_dir = module_dir
+      def initialize(context, object_name, options)
+        raise ArgumentError, _('Expected PDK::Context::AbstractContext but got \'%{klass}\' for context') % { klass: context.class } unless context.is_a?(PDK::Context::AbstractContext)
+        @context = context
         @options = options
         @object_name = object_name
-
-        if [:class, :defined_type].include?(object_type) # rubocop:disable Style/GuardClause
-          object_name_parts = object_name.split('::')
-
-          @object_name = if object_name_parts.first == module_name
-                           object_name
-                         else
-                           [module_name, object_name].join('::')
-                         end
-        end
       end
 
+      # Whether the generator should only return test (spec) files
+      # @return [Boolean]
       def spec_only?
         @options[:spec_only]
       end
 
-      # @abstract Subclass and implement {#template_data} to provide data to
-      #   the templates during rendering. Implementations of this method should
-      #   return a Hash!{Symbol => Object}.
-      def template_data
+      # Subclass and implement {#friendly_name} to provide a nice name to show users in CLI
+      # @abstract
+      # @return String
+      def friendly_name
         raise NotImplementedError
       end
 
-      # @abstract Subclass and implement {#target_object_path}. Implementations
-      #   of this method should return a String containing the destination path
-      #   of the object being generated.
-      def target_object_path
+      # Subclass and implement {#template_files} to provide the template files to
+      #   render. Implementations of this method should return a Hash!{String => String}.
+      # @abstract
+      # @return Hash{String => String} Hash key is the source template file and the Hash value is
+      #                                the relative destination path
+      def template_files
         raise NotImplementedError
       end
 
-      # @abstract Subclass and implement {#target_type_path}. Implementations
-      #   of this method should return a String containing the destination path
-      #   of the additional object file being generated.
-      # @return [String] returns nil if there is no additional object file
-      def target_type_path
-        nil
-      end
-
-      # @abstract Subclass and implement {#target_spec_path}. Implementations
-      #   of this method should return a String containing the destination path
-      #   of the tests for the object being generated.
-      def target_spec_path
+      #  Subclass and implement {#template_data} to provide data to the templates during rendering.
+      # @abstract
+      # @return Hash{Symbol => Object}
+      def template_data
         raise NotImplementedError
       end
 
-      # @abstract Subclass and implement {#target_type_spec_path}. Implementations
-      #   of this method should return a String containing the destination path
-      #   of the tests for the object being generated.
-      def target_type_spec_path
-        nil
-      end
-
-      # @abstract Subclass and implement {#target_device_path}. Implementations
-      #   of this method should return a String containing the destination path
-      #   of the device class being generated.
-      def target_device_path
-        nil
-      end
-
-      # Retrieves the type of the object being generated, e.g. :class,
-      # :defined_type, etc. This is specified in the subclass' OBJECT_TYPE
-      # constant.
+      # Raises an error if any pre-conditions are not met
       #
-      # @return [Symbol] the type of the object being generated.
-      #
-      # @api private
-      def object_type
-        self.class::OBJECT_TYPE
+      # @return [void]
+      # @abstract
+      def check_preconditions
+        raise ArgumentError, _('Expected a module context but got %{context_name}') % { context_name: context.display_name } unless context.is_a?(PDK::Context::Module)
       end
 
-      # Retrieves the type of the object being generated as represented in
-      # the JSON output of puppet-strings.
+      # Check the preconditions of this template group, behaving as a predicate rather than raising an exception.
       #
-      # @return [String] the type of the object being generated or nil if
-      #   there is no mapping.
-      #
-      # @api private
-      def self.puppet_strings_type
-        return nil unless const_defined?(:PUPPET_STRINGS_TYPE)
-
-        self::PUPPET_STRINGS_TYPE
+      # @return [Boolean] true if the generator is safe to run, otherwise false.
+      def can_run?
+        check_preconditions
+        true
+      rescue StandardError
+        false
       end
 
-      # Returns an array of possible target path strings.
-      def targets
-        targets = [
-          target_spec_path,
-          target_type_spec_path,
-        ]
-
-        unless spec_only?
-          targets += [
-            target_object_path,
-            target_type_path,
-            target_device_path,
-          ]
-        end
-
-        targets.compact
+      # Creates an instance of an update manager
+      # @api private
+      def update_manager_instance
+        require 'pdk/module/update_manager'
+        PDK::Module::UpdateManager.new
       end
 
-      # Check preconditions of this template group. By default this only makes sure that the target files do not
-      # already exist. Override this (and call super) to add your own preconditions.
-      #
-      # @raise [PDK::CLI::ExitWithError] if the target files already exist.
+      # Stages and then executes the changes for the templates to be rendereed.
+      # This is the main entry point for the class.
       #
+      # @see #stage_changes
+      # @return [PDK::Module::UpdateManager] The update manager which implemented the changes
       # @api public
-      def check_preconditions
-        require 'pdk/util/filesystem'
-
-        targets.each do |target_file|
-          next unless PDK::Util::Filesystem.exist?(target_file)
-
-          raise PDK::CLI::ExitWithError, _("Unable to generate %{object_type}; '%{file}' already exists.") % {
-            file:        target_file,
-            object_type: spec_only? ? 'unit test' : object_type,
-          }
-        end
-      end
-
-      # Check the preconditions of this template group, behaving as a
-      # predicate rather than raising an exception.
-      #
-      # @return [Boolean] true if the generator is safe to run, otherwise
-      #   false.
-      def can_run?
-        check_preconditions
-        true
-      rescue PDK::CLI::ExitWithError
-        false
+      def run(update_manager = update_manager_instance)
+        stage_changes(update_manager).sync_changes!
+        update_manager
       end
 
       # Check that the templates can be rendered. Find an appropriate template
-      # and create the target files from the template. This is the main entry
+      # and stages the target files from the template. This is the main entry
       # point for the class.
       #
       # @raise [PDK::CLI::ExitWithError] if the target files already exist.
       # @raise [PDK::CLI::FatalError] (see #render_file)
-      #
+      # @return [PDK::Module::UpdateManager] The update manager with the staged changes
       # @api public
-      def run
+      def stage_changes(update_manager)
         check_preconditions
 
-        with_templates do |template_path, config_hash|
-          data = template_data.merge(configs: config_hash)
+        with_templates do |template_dir|
+          template_files.each do |source_file, relative_dest_path|
+            new_content = template_dir.render_single_item(source_file, template_data)
+            next if new_content.nil?
 
-          render_file(target_object_path, template_path[:object], data) unless spec_only?
-          render_file(target_type_path, template_path[:type], data) if template_path[:type]
-          render_file(target_device_path, template_path[:device], data) if template_path[:device]
-          render_file(target_spec_path, template_path[:spec], data) if template_path[:spec]
-          render_file(target_type_spec_path, template_path[:type_spec], data) if template_path[:type_spec]
+            stage_change(relative_dest_path, new_content, update_manager)
+          end
         end
+        non_template_files.each { |relative_dest_path, content| stage_change(relative_dest_path, content, update_manager) }
+
+        update_manager
       end
 
-      # Render a file using the provided template and write it to disk.
-      #
-      # @param dest_path [String] The path that the rendered file should be
-      #   written to. Any necessary directories will be automatically created.
-      # @param template_path [String] The path on disk to the file containing
-      #   the template.
-      # @param data [Hash{Object => Object}] The data to be provided to the
-      #   template when rendering.
-      #
-      # @raise [PDK::CLI::FatalError] if the parent directories to `dest_path`
-      #   do not exist and could not be created.
-      # @raise [PDK::CLI::FatalError] if the rendered file could not be written
-      #   to `dest_path`.
-      #
+      # Stages a single file into the Update Manager.
       # @return [void]
-      #
       # @api private
-      def render_file(dest_path, template_path, data)
-        require 'pdk/template_file'
-
-        write_file(dest_path) do
-          PDK::TemplateFile.new(template_path, data).render
+      def stage_change(relative_dest_path, content, update_manager)
+        absolute_file_path = File.join(context.root_path, relative_dest_path)
+        if PDK::Util::Filesystem.exist?(absolute_file_path)
+          raise PDK::CLI::ExitWithError, _("Unable to generate %{object_type}; '%{file}' already exists.") % {
+            file:        absolute_file_path,
+            object_type: spec_only? ? 'unit test' : friendly_name,
+          }
         end
+        update_manager.add_file(absolute_file_path, content)
       end
 
-      # Write the result of the block to disk.
-      #
-      # @param dest_path [String] The path that the rendered file should be
-      #   written to. Any necessary directories will be automatically created.
-      # @param &block [String] The content to be written
-      #
-      # @raise [PDK::CLI::FatalError] if the parent directories to `dest_path`
-      #   do not exist and could not be created.
-      # @raise [PDK::CLI::FatalError] if the rendered file could not be written
-      #   to `dest_path`.
-      #
-      # @return [void]
+      # A subclass may wish to stage files into the Update Manager, but the content is not templated. Subclasses
+      # can override this method to stage arbitrary files
       #
       # @api private
-      def write_file(dest_path)
-        require 'pdk/logger'
-        require 'pdk/util/filesystem'
-
-        PDK.logger.info(_("Creating '%{file}' from template.") % { file: dest_path })
-
-        file_content = yield
-
-        begin
-          PDK::Util::Filesystem.mkdir_p(File.dirname(dest_path))
-        rescue SystemCallError => e
-          raise PDK::CLI::FatalError, _("Unable to create directory '%{path}': %{message}") % {
-            path:    File.dirname(dest_path),
-            message: e.message,
-          }
-        end
-
-        PDK::Util::Filesystem.write_file(dest_path, file_content)
-      rescue SystemCallError => e
-        raise PDK::CLI::FatalError, _("Unable to write to file '%{path}': %{message}") % {
-          path:    dest_path,
-          message: e.message,
-        }
+      # @return [Hash{String => String}] A Hash with the relative file path as the key and the new file content as the value.
+      # @abstract
+      def non_template_files
+        {}
       end
 
       # Search the possible template directories in order of preference to find
@@ -268,18 +164,15 @@ module PDK
             next
           end
 
-          PDK::Module::TemplateDir.with(PDK::Util::TemplateURI.new(template[:uri])) do |template_dir|
-            template_paths = template_dir.object_template_for(object_type)
-
-            if template_paths
-              config_hash = template_dir.object_config
-              yield template_paths, config_hash
+          PDK::Template.with(PDK::Util::TemplateURI.new(template[:uri]), context) do |template_dir|
+            if template_files.any? { |source_file, _| template_dir.has_single_item?(source_file) }
+              yield template_dir
               # TODO: refactor to a search-and-execute form instead
               return # work is done # rubocop:disable Lint/NonLocalExitFromIterator
             elsif template[:allow_fallback]
-              PDK.logger.debug(_('Unable to find a %{type} template in %{url}; trying next template directory.') % { type: object_type, url: template[:uri] })
+              PDK.logger.debug(_('Unable to find a %{type} template in %{url}; trying next template directory.') % { type: friendly_name, url: template[:uri] })
             else
-              raise PDK::CLI::FatalError, _('Unable to find the %{type} template in %{url}.') % { type: object_type, url: template[:uri] }
+              raise PDK::CLI::FatalError, _('Unable to find the %{type} template in %{url}.') % { type: friendly_name, url: template[:uri] }
             end
           end
         end
@@ -320,15 +213,18 @@ module PDK
       #
       # @api private
       def module_name
-        require 'pdk/util'
+        return nil unless context.is_a?(PDK::Context::Module)
 
-        @module_name ||= PDK::Util.module_metadata['name'].rpartition('-').last
+        require 'pdk/util'
+        @module_name ||= PDK::Util.module_metadata(context.root_path)['name'].rpartition('-').last
       rescue ArgumentError => e
         raise PDK::CLI::FatalError, e
       end
 
-      # transform a object name into a ruby class name
-      def self.class_name_from_object_name(object_name)
+      private
+
+      # Transform an object name into a ruby class name
+      def class_name_from_object_name(object_name)
         object_name.to_s.split('_').map(&:capitalize).join
       end
     end

data/lib/pdk/generate/resource_api_object.rb

@@ -0,0 +1,55 @@
+require 'pdk'
+
+module PDK
+  module Generate
+    # An abstract class for generated objects that require the Puppet Resource API Gem
+    #
+    # @abstract
+    class ResourceAPIObject < PuppetObject
+      #:nocov: This is tested in spec/acceptance/new_transport_spec.rb
+      # @see PDK::Generate::PuppetObject.check_preconditions
+      def check_preconditions
+        super
+        # Note that these preconditions are only applicable to the current (V1) template rendering layout and will need to be changed
+        # when additional template renderers are introduced.
+        #
+        # These preconditions can be removed once the pdk-templates are carrying the puppet-resource_api gem by default, and have switched
+        # the default mock_with value.
+        sync_path = PDK::Util.find_upwards('.sync.yml')
+        if sync_path.nil?
+          raise_precondition_error(_('.sync.yml not found'))
+        end
+        sync = YAML.load_file(sync_path)
+        if !sync.is_a? Hash
+          raise_precondition_error(_('.sync.yml contents is not a Hash'))
+        elsif !sync.key? 'Gemfile'
+          raise_precondition_error(_('Gemfile configuration not found'))
+        elsif !sync['Gemfile'].key? 'optional'
+          raise_precondition_error(_('Gemfile.optional configuration not found'))
+        elsif !sync['Gemfile']['optional'].key? ':development'
+          raise_precondition_error(_('Gemfile.optional.:development configuration not found'))
+        elsif sync['Gemfile']['optional'][':development'].none? { |g| g['gem'] == 'puppet-resource_api' }
+          raise_precondition_error(_('puppet-resource_api not found in the Gemfile config'))
+        elsif !sync.key? 'spec/spec_helper.rb'
+          raise_precondition_error(_('spec/spec_helper.rb configuration not found'))
+        elsif !sync['spec/spec_helper.rb'].key? 'mock_with'
+          raise_precondition_error(_('spec/spec_helper.rb.mock_with configuration not found'))
+        elsif !sync['spec/spec_helper.rb']['mock_with'] == ':rspec'
+          raise_precondition_error(_('spec/spec_helper.rb.mock_with not set to \':rspec\''))
+        end
+      end
+
+      # Helper method to raise an error if the Resource API is not available
+      #
+      # @api private
+      def raise_precondition_error(error)
+        raise PDK::CLI::ExitWithError, _('%{error}: Creating a %{thing_name} needs some local configuration in your module.' \
+          ' Please follow the docs at https://puppet.com/docs/puppet/latest/create_types_and_providers_resource_api.html') % {
+            thing_name: friendly_name,
+            error: error,
+          }
+      end
+      #:nocov:
+    end
+  end
+end