pdk 1.14.1 → 1.18.1

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

data/lib/pdk/generate/task.rb

@@ -3,44 +3,21 @@ require 'pdk'
 module PDK
   module Generate
     class Task < PuppetObject
-      OBJECT_TYPE = :task
+      def friendly_name
+        'Task'
+      end
 
-      # Prepares the data needed to render the new task template.
-      #
-      # @return [Hash{Symbol => Object}] a hash of information that will be
-      # provided to the task template during rendering. Additionally, this hash
-      # (with the :name key removed) makes up the task metadata.
-      def template_data
+      def template_files
+        return {} if spec_only?
         {
-          name:                object_name,
-          puppet_task_version: 1,
-          supports_noop:       false,
-          description:         options.fetch(:description, 'A short description of this task'),
-          parameters:          {},
+          'task.erb' => File.join('tasks', task_name + '.sh'),
         }
       end
 
-      # Calculates the path to the file where the new task will be written.
-      #
-      # @return [String] the path to the task file.
-      def target_object_path
-        @target_object_path ||= File.join(module_dir, 'tasks', "#{task_name}.sh")
-      end
-
-      # Calculates the path to the file where the tests for the new task will
-      # be written.
-      #
-      # @return [nil] as there is currently no test framework for Tasks.
-      def target_spec_path
-        nil
-      end
-
-      def run
-        check_if_task_already_exists
-
-        super
-
-        write_task_metadata
+      def template_data
+        {
+          name: object_name,
+        }
       end
 
       # Checks that the task has not already been defined with a different
@@ -48,30 +25,26 @@ module PDK
       #
       # @raise [PDK::CLI::ExitWithError] if files with the same name as the
       # task exist in the <module>/tasks/ directory
-      #
-      # @api private
-      def check_if_task_already_exists
+      def check_preconditions
+        super
+
         error = _("A task named '%{name}' already exists in this module; defined in %{file}")
         allowed_extensions = %w[.md .conf]
 
-        Dir.glob(File.join(module_dir, 'tasks', "#{task_name}.*")).each do |file|
+        PDK::Util::Filesystem.glob(File.join(context.root_path, 'tasks', task_name + '.*')).each do |file|
           next if allowed_extensions.include?(File.extname(file))
 
           raise PDK::CLI::ExitWithError, error % { name: task_name, file: file }
         end
       end
 
-      # Writes the <module>/tasks/<task_name>.json metadata file for the task.
-      #
-      # @api private
-      def write_task_metadata
-        write_file(File.join(module_dir, 'tasks', "#{task_name}.json")) do
-          task_metadata = template_data.dup
-          task_metadata.delete(:name)
-          JSON.pretty_generate(task_metadata)
-        end
+      def non_template_files
+        task_metadata_file = File.join('tasks', task_name + '.json')
+        { task_metadata_file => JSON.pretty_generate(task_metadata) }
       end
 
+      private
+
       # Calculates the file name of the task files ('init' if the task has the
       # same name as the module, otherwise use the specified task name).
       #
@@ -81,6 +54,15 @@ module PDK
       def task_name
         (object_name == module_name) ? 'init' : object_name
       end
+
+      def task_metadata
+        {
+          puppet_task_version: 1,
+          supports_noop:       false,
+          description:         options.fetch(:description, 'A short description of this task'),
+          parameters:          {},
+        }
+      end
     end
   end
 end

data/lib/pdk/generate/transport.rb

@@ -2,85 +2,31 @@ require 'pdk'
 
 module PDK
   module Generate
-    class Transport < PuppetObject
-      OBJECT_TYPE = :transport
-
-      # 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,
-          transport_class: Transport.class_name_from_object_name(object_name),
-        }
-
-        data
-      end
-
-      def raise_precondition_error(error)
-        raise PDK::CLI::ExitWithError, _('%{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.') % { 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 transport will be written.
-      def target_object_path
-        @target_object_path ||= File.join(module_dir, 'lib', 'puppet', 'transport', object_name) + '.rb'
+    class Transport < ResourceAPIObject
+      def friendly_name
+        'Resource API Transport'.freeze
       end
 
-      # @return [String] the path where the new schema will be written.
-      def target_type_path
-        @target_type_path ||= File.join(module_dir, 'lib', 'puppet', 'transport', 'schema', object_name) + '.rb'
-      end
-
-      # @return [String] the path where the deviceshim for the transport will be written.
-      def target_device_path
-        @target_device_path ||= File.join(module_dir, 'lib', 'puppet', 'util', 'network_device', object_name, 'device.rb')
-      end
-
-      # @return [String] the path where the tests for the new transport
-      # will be written.
-      def target_spec_path
-        @target_spec_path ||= File.join(module_dir, 'spec', 'unit', 'puppet', 'transport', object_name) + '_spec.rb'
-      end
-
-      # @return [String] the path where the tests for the new schema will be written.
-      def target_type_spec_path
-        @target_type_spec_path ||= File.join(module_dir, 'spec', 'unit', 'puppet', 'transport', 'schema', object_name) + '_spec.rb'
+      def template_files
+        # Note : Due to how the V1 templates work, the names of the source template files may be mismatched to
+        # their destination, e.g. transport_type.erb is really a transport schema
+        files = {
+          'transport_spec.erb'      => File.join('spec', 'unit', 'puppet', 'transport', object_name) + '_spec.rb',
+          'transport_type_spec.erb' => File.join('spec', 'unit', 'puppet', 'transport', 'schema', object_name) + '_spec.rb',
+        }
+        return files if spec_only?
+        files.merge(
+          'transport.erb' => File.join('lib', 'puppet', 'transport', object_name) + '.rb',
+          'transport_device.erb'    => File.join('lib', 'puppet', 'util', 'network_device', object_name, 'device.rb'),
+          'transport_type.erb'      => File.join('lib', 'puppet', 'transport', 'schema', object_name) + '.rb',
+        )
       end
 
-      # transform a object name into a ruby class name
-      def self.class_name_from_object_name(object_name)
-        object_name.to_s.split('_').map(&:capitalize).join
+      def template_data
+        {
+          name: object_name,
+          transport_class: class_name_from_object_name(object_name),
+        }
       end
     end
   end

data/lib/pdk/module.rb

@@ -3,7 +3,7 @@ module PDK
     autoload :Build, 'pdk/module/build'
     autoload :Convert, 'pdk/module/convert'
     autoload :Metadata, 'pdk/module/metadata'
-    autoload :TemplateDir, 'pdk/module/templatedir'
+    autoload :Release, 'pdk/module/release'
     autoload :UpdateManager, 'pdk/module/update_manager'
     autoload :Update, 'pdk/module/update'
 

data/lib/pdk/module/build.rb

@@ -11,8 +11,8 @@ module PDK
       attr_reader :target_dir
 
       def initialize(options = {})
-        @module_dir = File.expand_path(options[:module_dir] || Dir.pwd)
-        @target_dir = File.expand_path(options[:'target-dir'] || File.join(module_dir, 'pkg'))
+        @module_dir = PDK::Util::Filesystem.expand_path(options[:module_dir] || Dir.pwd)
+        @target_dir = PDK::Util::Filesystem.expand_path(options[:'target-dir'] || File.join(module_dir, 'pkg'))
       end
 
       # Read and parse the values from metadata.json for the module that is
@@ -47,7 +47,7 @@ module PDK
       # Verify if there is an existing package in the target directory and prompts
       # the user if they want to overwrite it.
       def package_already_exists?
-        File.exist? package_file
+        PDK::Util::Filesystem.exist?(package_file)
       end
 
       # Check if the module is PDK Compatible. If not, then prompt the user if
@@ -67,20 +67,16 @@ module PDK
       #
       # If the directory already exists, remove it first.
       def create_build_dir
-        require 'fileutils'
-
         cleanup_build_dir
 
-        FileUtils.mkdir_p(build_dir)
+        PDK::Util::Filesystem.mkdir_p(build_dir)
       end
 
       # Remove the temporary build directory and all its contents from disk.
       #
       # @return nil.
       def cleanup_build_dir
-        require 'fileutils'
-
-        FileUtils.rm_rf(build_dir, secure: true)
+        PDK::Util::Filesystem.rm_rf(build_dir, secure: true)
       end
 
       # Combine the module name and version into a Forge-compatible dash
@@ -115,18 +111,19 @@ module PDK
       # @return nil.
       def stage_path(path)
         require 'pathname'
-        require 'fileutils'
 
         relative_path = Pathname.new(path).relative_path_from(Pathname.new(module_dir))
         dest_path = File.join(build_dir, relative_path)
 
-        if File.directory?(path)
-          FileUtils.mkdir_p(dest_path, mode: File.stat(path).mode)
-        elsif File.symlink?(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)
           warn_symlink(path)
         else
           validate_ustar_path!(relative_path.to_path)
-          FileUtils.cp(path, dest_path, preserve: true)
+          PDK::Util::Filesystem.cp(path, dest_path, preserve: true)
         end
       rescue ArgumentError => e
         raise PDK::CLI::ExitWithError, _(
@@ -142,7 +139,7 @@ module PDK
       #
       # @return [Boolean] true if the path matches and should be ignored.
       def ignored_path?(path)
-        path = path.to_s + '/' if File.directory?(path)
+        path = path.to_s + '/' if PDK::Util::Filesystem.directory?(path)
 
         !ignored_files.match_paths([path], module_dir).empty?
       end
@@ -217,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
@@ -224,23 +242,22 @@ module PDK
       #
       # @return nil.
       def build_package
-        require 'fileutils'
         require 'zlib'
         require 'minitar'
         require 'find'
 
-        FileUtils.rm_f(package_file)
+        PDK::Util::Filesystem.rm_f(package_file)
 
         Dir.chdir(target_dir) do
           begin
-            gz = Zlib::GzipWriter.new(File.open(package_file, 'wb'))
+            gz = Zlib::GzipWriter.new(File.open(package_file, 'wb')) # rubocop:disable PDK/FileOpen
             tar = Minitar::Output.new(gz)
             Find.find(release_name) do |entry|
               entry_meta = {
                 name: entry,
               }
 
-              orig_mode = File.stat(entry).mode
+              orig_mode = PDK::Util::Filesystem.stat(entry).mode
               min_mode = Minitar.dir?(entry) ? 0o755 : 0o644
 
               entry_meta[:mode] = orig_mode | min_mode
@@ -272,7 +289,7 @@ module PDK
           File.join(module_dir, '.pdkignore'),
           File.join(module_dir, '.pmtignore'),
           File.join(module_dir, '.gitignore'),
-        ].find { |file| File.file?(file) && File.readable?(file) }
+        ].find { |file| PDK::Util::Filesystem.file?(file) && PDK::Util::Filesystem.readable?(file) }
       end
 
       # Instantiate a new PathSpec class and populate it with the pattern(s) of
@@ -288,11 +305,7 @@ module PDK
             ignored = if ignore_file.nil?
                         PathSpec.new
                       else
-                        fd = File.open(ignore_file, 'rb:UTF-8')
-                        data = fd.read
-                        fd.close
-
-                        PathSpec.new(data)
+                        PathSpec.new(PDK::Util::Filesystem.read_file(ignore_file, open_args: 'rb:UTF-8'))
                       end
 
             if File.realdirpath(target_dir).start_with?(File.realdirpath(module_dir))

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
 
@@ -23,6 +26,7 @@ module PDK
         unless update_manager.changes?
           if adding_tests?
             add_tests!
+            print_result 'Convert completed'
           else
             require 'pdk/report'
 
@@ -50,18 +54,15 @@ module PDK
           return unless continue
         end
 
-        # Remove these files straight away as these changes are not something that the user needs to review.
-        if needs_bundle_update?
-          update_manager.unlink_file('Gemfile.lock')
-          update_manager.unlink_file(File.join('.bundle', 'config'))
-        end
+        # Remove these files straight away as these changes are not something
+        # that the user needs to review.
+        update_manager.unlink_file('Gemfile.lock')
+        update_manager.unlink_file(File.join('.bundle', 'config'))
 
         update_manager.sync_changes!
 
-        if needs_bundle_update?
-          require 'pdk/util/bundler'
-          PDK::Util::Bundler.ensure_bundle!
-        end
+        require 'pdk/util/bundler'
+        PDK::Util::Bundler.ensure_bundle!
 
         add_tests! if adding_tests?
 
@@ -85,42 +86,59 @@ module PDK
       end
 
       def missing_tests?
-        test_generators.any? { |gen| gen.can_run? }
+        !available_test_generators.empty?
       end
 
-      def test_generators
+      def available_test_generators
+        # Only select generators which can run and have no pre-existing files
+        test_generators.select do |gen|
+          if gen.can_run?
+            gen.template_files.none? { |_, dst_path| PDK::Util::Filesystem.exist?(File.join(gen.context.root_path, dst_path)) }
+          else
+            false
+          end
+        end
+      end
+
+      def test_generators(context = PDK.context)
         return @test_generators unless @test_generators.nil?
         require 'pdk/util/puppet_strings'
 
         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(context, obj['name'], spec_only: true)
           end
         end
 
         @test_generators = test_gens.flatten
       end
 
-      def add_tests!
-        test_generators.each do |gen|
-          gen.run if gen.can_run?
+      def stage_tests!(manager)
+        available_test_generators.each do |gen|
+          gen.stage_changes(manager)
         end
+        manager
       end
 
-      def needs_bundle_update?
-        update_manager.changed?('Gemfile')
+      def add_tests!
+        update_manager.clear!
+        stage_tests!(update_manager)
+
+        if update_manager.changes?
+          update_manager.sync_changes!
+          print_summary
+        else
+          PDK::Report.default_target.puts(_('No test changes required.'))
+        end
       end
 
-      def stage_changes!
-        require 'pdk/module/templatedir'
+      def stage_changes!(context = PDK.context)
         require 'pdk/util/filesystem'
 
-        metadata_path = 'metadata.json'
-
-        PDK::Module::TemplateDir.new(template_uri, nil, true) do |templates|
-          new_metadata = update_metadata(metadata_path, templates.metadata)
-          templates.module_metadata = new_metadata.data unless new_metadata.nil?
+        metadata_path = File.join(module_dir, 'metadata.json')
 
+        PDK::Template.with(template_uri, context) do |template_dir|
+          new_metadata = update_metadata(metadata_path, template_dir.metadata)
           if options[:noop] && new_metadata.nil?
             update_manager.add_file(metadata_path, '')
           elsif PDK::Util::Filesystem.file?(metadata_path)
@@ -129,21 +147,26 @@ module PDK
             update_manager.add_file(metadata_path, new_metadata.to_json)
           end
 
-          templates.render do |file_path, file_content, file_status|
+          # new_metadata == nil when creating a new module but with --noop@
+          module_name = new_metadata.nil? ? 'new-module' : new_metadata.data['name']
+          metadata_for_render = new_metadata.nil? ? {} : new_metadata.data
+
+          template_dir.render_new_module(module_name, metadata_for_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
@@ -251,13 +274,9 @@ module PDK
       def full_report(path)
         require 'pdk/report'
 
-        File.open(path, 'w') do |f|
-          f.write("/* Report generated by PDK at #{Time.now} */")
-          update_manager.changes[:modified].each do |_, diff|
-            f.write("\n\n\n" + diff)
-          end
-          f.write("\n")
-        end
+        report = ["/* Report generated by PDK at #{Time.now} */"]
+        report.concat(update_manager.changes[:modified].map { |_, diff| "\n\n\n#{diff}" })
+        PDK::Util::Filesystem.write_file(path, report.join)
         PDK::Report.default_target.puts(_("\nYou can find a report of differences in %{path}.\n\n") % { path: path })
       end