pdk 1.15.0 → 2.0.0

data/lib/pdk/generate/transport.rb

@@ -3,84 +3,30 @@ 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'
+      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

@@ -4,7 +4,6 @@ module PDK
     autoload :Convert, 'pdk/module/convert'
     autoload :Metadata, 'pdk/module/metadata'
     autoload :Release, 'pdk/module/release'
-    autoload :TemplateDir, 'pdk/module/template_dir'
     autoload :UpdateManager, 'pdk/module/update_manager'
     autoload :Update, 'pdk/module/update'
 
@@ -16,6 +15,7 @@ module PDK
       '/REVISION',
       '/spec/fixtures/modules/',
       '/vendor/',
+      '.DS_Store',
     ].freeze
 
     def default_ignored_pathspec(ignore_dotfiles = true)

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
 
@@ -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,41 +86,59 @@ module PDK
       end
 
       def missing_tests?
-        test_generators.any? { |gen| gen.can_run? }
+        !available_test_generators.empty?
+      end
+
+      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
+      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!
+      def stage_changes!(context = PDK.context)
         require 'pdk/util/filesystem'
 
-        metadata_path = 'metadata.json'
-
-        PDK::Module::TemplateDir.with(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)
@@ -128,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

data/lib/pdk/module/metadata.rb

@@ -27,7 +27,7 @@ module PDK
         'Debian based Linux' => [
           {
             'operatingsystem'        => 'Debian',
-            'operatingsystemrelease' => ['9'],
+            'operatingsystemrelease' => ['10'],
           },
           {
             'operatingsystem'        => 'Ubuntu',
@@ -54,6 +54,10 @@ module PDK
           'operatingsystem'        => 'windows',
           'operatingsystemrelease' => %w[2019 10],
         },
+        'AIX' => {
+          'operatingsystem'        => 'AIX',
+          'operatingsystemrelease' => %w[6.1 7.1 7.2],
+        },
       }.freeze
 
       DEFAULT_OPERATING_SYSTEMS = [
@@ -77,7 +81,7 @@ module PDK
           OPERATING_SYSTEMS[os_name]
         }.flatten,
         'requirements' => [
-          { 'name' => 'puppet', 'version_requirement' => '>= 4.10.0 < 7.0.0' },
+          { 'name' => 'puppet', 'version_requirement' => '>= 6.21.0 < 8.0.0' },
         ],
       }.freeze
 

data/lib/pdk/module/release.rb

@@ -105,20 +105,14 @@ module PDK
 
         PDK::CLI::Util.module_version_check
 
-        report = PDK::Report.new
         puppet_env = PDK::CLI::Util.puppet_from_opts_or_env(opts)
         PDK::Util::PuppetVersion.fetch_puppet_dev if opts[:'puppet-dev']
         PDK::Util::RubyVersion.use(puppet_env[:ruby_version])
 
-        opts = opts.merge(puppet_env[:gemset])
-
         PDK::Util::Bundler.ensure_bundle!(puppet_env[:gemset])
 
-        validators = PDK::Validate.validators
-        validators.each do |validator|
-          validator_exit_code = validator.invoke(report, opts.dup)
-          raise PDK::CLI::ExitWithError, _('An error occured during validation') unless validator_exit_code.zero?
-        end
+        validator_exit_code, = PDK::Validate.invoke_validators_by_name(PDK.context, PDK::Validate.validator_names, false, options)
+        raise PDK::CLI::ExitWithError, _('An error occured during validation') unless validator_exit_code.zero?
       end
 
       def run_documentation(_opts)
@@ -169,7 +163,7 @@ module PDK
           http.request(request)
         end
 
-        raise PDK::CLI::ExitWithError, _('Error uploading to Puppet Forge: %{result}') % { result: response } unless response.is_a?(Net::HTTPSuccess)
+        raise PDK::CLI::ExitWithError, _('Error uploading to Puppet Forge: %{result}') % { result: response.body } unless response.is_a?(Net::HTTPSuccess)
         PDK.logger.info _('Publish to Forge was successful')
       end
 

data/lib/pdk/module/update.rb

@@ -33,25 +33,21 @@ module PDK
           return unless PDK::CLI::Util.prompt_for_yes(message)
         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!
 
         print_result 'Update completed'
       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
@@ -89,7 +85,7 @@ module PDK
       private
 
       def latest_template?
-        [PDK::TEMPLATE_REF, 'master'].include?(template_uri.uri_fragment)
+        [PDK::TEMPLATE_REF, 'master', 'main'].include?(template_uri.uri_fragment)
       end
 
       def current_template_version

data/lib/pdk/module/update_manager.rb

@@ -75,6 +75,13 @@ module PDK
           changes[:modified].key?(path)
       end
 
+      def clear!
+        @modified_files.clear
+        @added_files.clear
+        @removed_files.clear
+        nil
+      end
+
       # Apply any pending changes stored in the UpdateManager to the module.
       #
       # @raise (see #calculate_diffs)

data/lib/pdk/report.rb

@@ -104,7 +104,7 @@ module PDK
           if event.rspec_puppet_coverage?
             coverage_report = event.to_text
           else
-            report << event.to_text unless event.pass?
+            report << event.to_text unless event.pass? || event.skipped?
           end
         end
       end
@@ -113,8 +113,8 @@ module PDK
 
       if target.is_a?(String)
         PDK::Util::Filesystem.write_file(target, report.join("\n"))
-      else
-        target << report.join("\n")
+      elsif !report.empty?
+        target << report.join("\n") << "\n"
       end
     end
   end