pdk 1.11.1 → 1.12.0

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

@@ -0,0 +1,110 @@
+require 'pdk/cli/exec/command'
+
+module PDK
+  module CLI
+    module Exec
+      class InteractiveCommand < Command
+        def initialize(*argv)
+          @argv = argv
+
+          # Default to running things in the system context.
+          @context = :system
+
+          # Extra environment vars to add to base set.
+          @environment = {}
+        end
+
+        def register_spinner(_spinner, _opts = {})
+          raise _('This method is not implemented for PDK::CLI::Exec::InteractiveCommand')
+        end
+
+        def add_spinner(_message, _opts = {})
+          raise _('This method is not implemented for PDK::CLI::Exec::InteractiveCommand')
+        end
+
+        def timeout
+          raise _('This method is not implemented for PDK::CLI::Exec::InteractiveCommand')
+        end
+
+        def timeout=(_val)
+          raise _('This method is not implemented for PDK::CLI::Exec::InteractiveCommand')
+        end
+
+        def exec_group=(_val)
+          raise _('This method is not implemented for PDK::CLI::Exec::InteractiveCommand')
+        end
+
+        def execute!
+          @resolved_env = resolved_env_for_command
+
+          if [:module, :pwd].include?(context)
+            mod_root = PDK::Util.module_root
+
+            unless mod_root
+              raise PDK::CLI::FatalError, _('Current working directory is not part of a module. (No metadata.json was found.)')
+            end
+
+            unless context == :pwd || Dir.pwd == mod_root
+              orig_workdir = Dir.pwd
+              Dir.chdir(mod_root)
+            end
+
+            result = run_process_in_clean_env!
+          else
+            result = run_process!
+          end
+
+          {
+            interactive: true,
+            stdout: nil,
+            stderr: nil,
+            exit_code: result[:exit_code],
+            duration: result[:duration],
+          }
+        ensure
+          Dir.chdir(orig_workdir) if orig_workdir
+        end
+
+        protected
+
+        # TODO: debug logging
+        def run_process!
+          command_string = argv.join(' ')
+          PDK.logger.debug(_("Executing '%{command}' interactively") % { command: command_string })
+
+          if context == :module
+            PDK.logger.debug(_('Command environment:'))
+            @resolved_env.each do |var, val|
+              PDK.logger.debug("  #{var}: #{val}")
+            end
+          end
+
+          start_time = Time.now
+
+          system(@resolved_env, *argv)
+
+          exit_code = child_status.exitstatus
+          duration = Time.now - start_time
+
+          PDK.logger.debug(_("Execution of '%{command}' complete (duration: \
+                              %{duration_in_seconds}s; exit code: %{exit_code})") %
+                              {
+                                command: command_string,
+                                exit_code: exit_code,
+                                duration_in_seconds: duration,
+                              })
+
+          { exit_code: exit_code, duration: duration }
+        end
+
+        def child_status
+          $CHILD_STATUS
+        end
+
+        def stop_spinner
+          raise _('This method is not implemented for PDK::CLI::Exec::InteractiveCommand')
+        end
+      end
+    end
+  end
+end

data/lib/pdk/cli/exec_group.rb

@@ -27,7 +27,7 @@ module PDK
       end
 
       def register(&block)
-        raise PDK::CLI::FatalError, 'No block registered' unless block_given?
+        raise PDK::CLI::FatalError, _('No block registered') unless block_given?
 
         @threads_or_procs << if parallel?
                                Thread.new do

data/lib/pdk/cli/new.rb

@@ -15,3 +15,4 @@ require 'pdk/cli/new/defined_type'
 require 'pdk/cli/new/module'
 require 'pdk/cli/new/provider'
 require 'pdk/cli/new/task'
+require 'pdk/cli/new/transport'

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

@@ -0,0 +1,25 @@
+module PDK::CLI
+  @new_transport_cmd = @new_cmd.define_command do
+    name 'transport'
+    usage _('transport [options] <name>')
+    summary _('[experimental] Create a new ruby transport named <name> using given options')
+
+    run do |opts, args, _cmd|
+      PDK::CLI::Util.ensure_in_module!
+
+      transport_name = args[0]
+      module_dir = Dir.pwd
+
+      if transport_name.nil? || transport_name.empty?
+        puts command.help
+        exit 1
+      end
+
+      unless Util::OptionValidator.valid_transport_name?(transport_name)
+        raise PDK::CLI::ExitWithError, _("'%{name}' is not a valid transport name") % { name: transport_name }
+      end
+
+      PDK::Generate::Transport.new(module_dir, transport_name, opts).run
+    end
+  end
+end

data/lib/pdk/cli/util.rb

@@ -164,7 +164,7 @@ module PDK
           [puppet_ver_specs, pe_ver_specs].each do |offending|
             next if offending.empty?
 
-            raise PDK::CLI::ExitWithError, _('You cannot specify a %{first} and %{second} at the same time') % {
+            raise PDK::CLI::ExitWithError, _('You cannot specify a %{first} and %{second} at the same time.') % {
               first: pup_dev_spec,
               second: offending.first,
             }

data/lib/pdk/cli/util/option_validator.rb

@@ -28,6 +28,10 @@ module PDK
         # Let's assume that only strings similar to module names can actually be resolved by the puppet language.
         singleton_class.send(:alias_method, :valid_provider_name?, :valid_module_name?)
 
+        # The name has to be a ruby symbol.
+        # While overly strict, let's apply the provider and module name rules for consistency.
+        singleton_class.send(:alias_method, :valid_transport_name?, :valid_provider_name?)
+
         # Validate a Puppet namespace against the regular expression in the
         # documentation: https://docs.puppet.com/puppet/4.10/lang_reserved.html#classes-and-defined-resource-types
         def self.valid_namespace?(string)

data/lib/pdk/config.rb

@@ -34,7 +34,14 @@ module PDK
     end
 
     def self.bolt_analytics_config
-      PDK::Config::YAML.new(file: File.expand_path('~/.puppetlabs/bolt/analytics.yaml'))
+      file = File.expand_path('~/.puppetlabs/bolt/analytics.yaml')
+      PDK::Config::YAML.new(file: file)
+    rescue PDK::Config::LoadError => e
+      PDK.logger.debug _('Unable to load %{file}: %{message}') % {
+        file:    file,
+        message: e.message,
+      }
+      PDK::Config::YAML.new
     end
 
     def self.analytics_config_path

data/lib/pdk/config/validator.rb

@@ -13,7 +13,7 @@ module PDK
       def self.boolean
         {
           proc:    ->(value) { [true, false].include?(value) },
-          message: _('must be a boolean true or false'),
+          message: _('must be a boolean: true or false'),
         }
       end
 

data/lib/pdk/config/value.rb

@@ -39,7 +39,7 @@ module PDK
       #
       # @return [nil]
       def validate(validator)
-        raise ArgumentError, _('validator must be a Hash') unless validator.is_a?(Hash)
+        raise ArgumentError, _('`validator` must be a Hash') unless validator.is_a?(Hash)
         raise ArgumentError, _('the :proc key must contain a Proc') unless validator.key?(:proc) && validator[:proc].is_a?(Proc)
         raise ArgumentError, _('the :message key must contain a String') unless validator.key?(:message) && validator[:message].is_a?(String)
 

data/lib/pdk/generate.rb

@@ -3,6 +3,7 @@ require 'pdk/generate/module'
 require 'pdk/generate/provider'
 require 'pdk/generate/puppet_class'
 require 'pdk/generate/task'
+require 'pdk/generate/transport'
 require 'pdk/module/metadata'
 require 'pdk/module/templatedir'
 

data/lib/pdk/generate/module.rb

@@ -258,17 +258,27 @@ module PDK
 
         interview.add_questions(questions)
 
-        action = File.file?('metadata.json') ? _('update') : _('create')
+        if File.file?('metadata.json')
+          puts _(
+            "\nWe need to update the metadata.json file for this module, so we\'re going to ask you %{count} " \
+            "questions.\n",
+          ) % {
+            count: interview.num_questions,
+          }
+        else
+          puts _(
+            "\nWe need to create the metadata.json file for this module, so we\'re going to ask you %{count} " \
+            "questions.\n",
+          ) % {
+            count: interview.num_questions,
+          }
+        end
+
         puts _(
-          "\nWe need to %{action} the metadata.json file for this module, so we\'re going to ask you %{count} " \
-          "questions.\n" \
           '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",
-        ) % {
-          count: interview.num_questions,
-          action: action,
-        }
+        )
 
         answers = interview.run
 

data/lib/pdk/generate/provider.rb

@@ -72,11 +72,6 @@ module PDK
       def target_type_spec_path
         @target_type_spec_path ||= File.join(module_dir, 'spec', 'unit', 'puppet', 'type', object_name) + '_spec.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
-      end
     end
   end
 end

data/lib/pdk/generate/puppet_object.rb

@@ -81,6 +81,13 @@ module PDK
         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.
@@ -99,7 +106,7 @@ module PDK
       #
       # @api public
       def check_preconditions
-        [target_object_path, target_type_path, target_spec_path, target_type_spec_path].compact.each do |target_file|
+        [target_object_path, target_type_path, target_device_path, target_spec_path, target_type_spec_path].compact.each do |target_file|
           next unless File.exist?(target_file)
 
           raise PDK::CLI::ExitWithError, _("Unable to generate %{object_type}; '%{file}' already exists.") % {
@@ -125,6 +132,7 @@ module PDK
 
           render_file(target_object_path, template_path[:object], data)
           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]
         end
@@ -219,9 +227,9 @@ module PDK
               # 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[:url] })
+              PDK.logger.debug(_('Unable to find a %{type} template in %{url}; trying next template directory.') % { type: object_type, url: template[:uri] })
             else
-              raise PDK::CLI::FatalError, _('Unable to find the %{type} template in %{url}.') % { type: object_type, url: template[:url] }
+              raise PDK::CLI::FatalError, _('Unable to find the %{type} template in %{url}.') % { type: object_type, url: template[:uri] }
             end
           end
         end
@@ -279,6 +287,11 @@ module PDK
           raise PDK::CLI::FatalError, _("'%{dir}' does not contain valid Puppet module metadata: %{msg}") % { dir: module_dir, msg: e.message }
         end
       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
+      end
     end
   end
 end

data/lib/pdk/generate/transport.rb

@@ -0,0 +1,87 @@
+require 'pdk/generate/puppet_object'
+
+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'
+      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'
+      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
+      end
+    end
+  end
+end

data/lib/pdk/module/build.rb

@@ -125,7 +125,7 @@ module PDK
         end
       rescue ArgumentError => e
         raise PDK::CLI::ExitWithError, _(
-          '%{message} Please rename the file or exclude it from the package ' \
+          '%{message} Rename the file or exclude it from the package ' \
           'by adding it to the .pdkignore file in your module.',
         ) % { message: e.message }
       end
@@ -220,8 +220,30 @@ module PDK
         FileUtils.rm_f(package_file)
 
         Dir.chdir(target_dir) do
-          Zlib::GzipWriter.open(package_file) do |package_fd|
-            Minitar.pack(release_name, package_fd)
+          begin
+            gz = Zlib::GzipWriter.new(File.open(package_file, 'wb'))
+            tar = Minitar::Output.new(gz)
+            Find.find(release_name) do |entry|
+              entry_meta = {
+                name: entry,
+              }
+
+              orig_mode = File.stat(entry).mode
+              min_mode = Minitar.dir?(entry) ? 0o755 : 0o644
+
+              entry_meta[:mode] = orig_mode | min_mode
+
+              if entry_meta[:mode] != orig_mode
+                PDK.logger.debug(_('Updated permissions of packaged \'%{entry}\' to %{new_mode}') % {
+                  entry: entry,
+                  new_mode: (entry_meta[:mode] & 0o7777).to_s(8),
+                })
+              end
+
+              Minitar.pack_file(entry_meta, tar)
+            end
+          ensure
+            tar.close
           end
         end
       end