pdk 2.3.0 → 2.4.0

data/lib/pdk/cli/set/config.rb

@@ -1,119 +1,119 @@
-module PDK::CLI
-  module Set
-    module Config
-      ALLOWED_TYPE_NAMES = %w[array boolean number string].freeze
-
-      # :nocov:
-      def self.pretty_allowed_names
-        ALLOWED_TYPE_NAMES.map { |name| "'#{name}'" }.join(', ')
-      end
-      # :nocov:
-
-      def self.transform_value(type_name, value)
-        normalized_name = type_name.downcase.strip
-        unless ALLOWED_TYPE_NAMES.include?(normalized_name)
-          raise PDK::CLI::ExitWithError, _('Unknown type %{type_name}. Expected one of %{allowed}') % { type_name: type_name, allowed: pretty_allowed_names }
-        end
-
-        # Short circuit string conversions as it's trivial
-        if normalized_name == 'string'
-          raise PDK::CLI::ExitWithError, _('An error occured converting \'%{value}\' into a %{type_name}') % { value: value.nil? ? 'nil' : value, type_name: type_name } unless value.is_a?(String)
-          return value
-        end
-
-        begin
-          case normalized_name
-          when 'array'
-            convert_to_array(value)
-          when 'boolean'
-            convert_to_boolean(value)
-          when 'number'
-            convert_to_number(value)
-          else
-            value
-          end
-        rescue ArgumentError, TypeError
-          raise PDK::CLI::ExitWithError, _('An error occured converting \'%{value}\' into a %{type_name}') % { value: value.nil? ? 'nil' : value, type_name: type_name }
-        end
-      end
-
-      def self.convert_to_array(value)
-        return [] if value.nil?
-        value.is_a?(Array) ? value : [value]
-      end
-      private_class_method :convert_to_array
-
-      def self.convert_to_boolean(value)
-        string_val = value.to_s.strip.downcase
-
-        return true  if %w[yes true -1 1].include?(string_val)
-        return false if %w[no false 0].include?(string_val)
-
-        raise ArgumentError
-      end
-      private_class_method :convert_to_boolean
-
-      def self.convert_to_number(value)
-        float_val = Float(value)
-        # Return an Integer if this is actually and Integer, otherwise return the float
-        (float_val.truncate == float_val) ? float_val.truncate : float_val
-      end
-      private_class_method :convert_to_number
-
-      def self.run(opts, args)
-        item_name = (args.count > 0) ? args[0] : nil
-        item_value = (args.count > 1) ? args[1] : nil
-
-        opts[:type] = opts[:as] if opts[:type].nil? && !opts[:as].nil?
-        force = opts[:force] || false
-
-        # Transform the value if we need to
-        item_value = PDK::CLI::Set::Config.transform_value(opts[:type], item_value) unless opts[:type].nil?
-
-        raise PDK::CLI::ExitWithError, _('Configuration name is required') if item_name.nil?
-        raise PDK::CLI::ExitWithError, _('Configuration value is required. If you wish to remove a value use \'pdk remove config\'') if item_value.nil?
-
-        current_value = PDK.config.get(item_name)
-        raise PDK::CLI::ExitWithError, _("The configuration item '%{name}' can not have a value set.") % { name: item_name } if current_value.is_a?(PDK::Config::Namespace)
-
-        # If we're forcing the value, don't do any munging
-        unless force
-          # Check if the setting already exists
-          if current_value.is_a?(Array) && current_value.include?(item_value)
-            PDK.logger.info(_("No changes made to '%{name}' as it already contains value '%{to}'") % { name: item_name, to: item_value })
-            return 0
-          end
-        end
-
-        new_value = PDK.config.set(item_name, item_value, force: opts[:force])
-        if current_value.nil? || force
-          PDK.logger.info(_("Set initial value of '%{name}' to '%{to}'") % { name: item_name, to: new_value })
-        elsif current_value.is_a?(Array)
-          # Arrays have a special output format
-          PDK.logger.info(_("Added new value '%{to}' to '%{name}'") % { name: item_name, to: item_value })
-        else
-          PDK.logger.info(_("Changed existing value of '%{name}' from '%{from}' to '%{to}'") % { name: item_name, from: current_value, to: new_value })
-        end
-
-        # Same output as `get config`
-        $stdout.puts _('%{name}=%{value}') % { name: item_name, value: PDK.config.get(item_name) }
-        0
-      end
-    end
-  end
-
-  @set_config_cmd = @set_cmd.define_command do
-    name 'config'
-    usage _('config [name] [value]')
-    summary _('Set or update the configuration for <name>')
-
-    option :f, :force, _('Force the configuration setting to be overwitten.'), argument: :forbidden
-
-    option :t, :type, _('The type of value to set. Acceptable values: %{values}') % { values: PDK::CLI::Set::Config.pretty_allowed_names }, argument: :required
-    option nil, :as, _('Alias of --type'), argument: :required
-
-    run do |opts, args, _cmd|
-      exit PDK::CLI::Set::Config.run(opts, args)
-    end
-  end
-end
+module PDK::CLI
+  module Set
+    module Config
+      ALLOWED_TYPE_NAMES = %w[array boolean number string].freeze
+
+      # :nocov:
+      def self.pretty_allowed_names
+        ALLOWED_TYPE_NAMES.map { |name| "'#{name}'" }.join(', ')
+      end
+      # :nocov:
+
+      def self.transform_value(type_name, value)
+        normalized_name = type_name.downcase.strip
+        unless ALLOWED_TYPE_NAMES.include?(normalized_name)
+          raise PDK::CLI::ExitWithError, _('Unknown type %{type_name}. Expected one of %{allowed}') % { type_name: type_name, allowed: pretty_allowed_names }
+        end
+
+        # Short circuit string conversions as it's trivial
+        if normalized_name == 'string'
+          raise PDK::CLI::ExitWithError, _('An error occured converting \'%{value}\' into a %{type_name}') % { value: value.nil? ? 'nil' : value, type_name: type_name } unless value.is_a?(String)
+          return value
+        end
+
+        begin
+          case normalized_name
+          when 'array'
+            convert_to_array(value)
+          when 'boolean'
+            convert_to_boolean(value)
+          when 'number'
+            convert_to_number(value)
+          else
+            value
+          end
+        rescue ArgumentError, TypeError
+          raise PDK::CLI::ExitWithError, _('An error occured converting \'%{value}\' into a %{type_name}') % { value: value.nil? ? 'nil' : value, type_name: type_name }
+        end
+      end
+
+      def self.convert_to_array(value)
+        return [] if value.nil?
+        value.is_a?(Array) ? value : [value]
+      end
+      private_class_method :convert_to_array
+
+      def self.convert_to_boolean(value)
+        string_val = value.to_s.strip.downcase
+
+        return true  if %w[yes true -1 1].include?(string_val)
+        return false if %w[no false 0].include?(string_val)
+
+        raise ArgumentError
+      end
+      private_class_method :convert_to_boolean
+
+      def self.convert_to_number(value)
+        float_val = Float(value)
+        # Return an Integer if this is actually and Integer, otherwise return the float
+        (float_val.truncate == float_val) ? float_val.truncate : float_val
+      end
+      private_class_method :convert_to_number
+
+      def self.run(opts, args)
+        item_name = (args.count > 0) ? args[0] : nil
+        item_value = (args.count > 1) ? args[1] : nil
+
+        opts[:type] = opts[:as] if opts[:type].nil? && !opts[:as].nil?
+        force = opts[:force] || false
+
+        # Transform the value if we need to
+        item_value = PDK::CLI::Set::Config.transform_value(opts[:type], item_value) unless opts[:type].nil?
+
+        raise PDK::CLI::ExitWithError, _('Configuration name is required') if item_name.nil?
+        raise PDK::CLI::ExitWithError, _('Configuration value is required. If you wish to remove a value use \'pdk remove config\'') if item_value.nil?
+
+        current_value = PDK.config.get(item_name)
+        raise PDK::CLI::ExitWithError, _("The configuration item '%{name}' can not have a value set.") % { name: item_name } if current_value.is_a?(PDK::Config::Namespace)
+
+        # If we're forcing the value, don't do any munging
+        unless force
+          # Check if the setting already exists
+          if current_value.is_a?(Array) && current_value.include?(item_value)
+            PDK.logger.info(_("No changes made to '%{name}' as it already contains value '%{to}'") % { name: item_name, to: item_value })
+            return 0
+          end
+        end
+
+        new_value = PDK.config.set(item_name, item_value, force: opts[:force])
+        if current_value.nil? || force
+          PDK.logger.info(_("Set initial value of '%{name}' to '%{to}'") % { name: item_name, to: new_value })
+        elsif current_value.is_a?(Array)
+          # Arrays have a special output format
+          PDK.logger.info(_("Added new value '%{to}' to '%{name}'") % { name: item_name, to: item_value })
+        else
+          PDK.logger.info(_("Changed existing value of '%{name}' from '%{from}' to '%{to}'") % { name: item_name, from: current_value, to: new_value })
+        end
+
+        # Same output as `get config`
+        $stdout.puts _('%{name}=%{value}') % { name: item_name, value: PDK.config.get(item_name) }
+        0
+      end
+    end
+  end
+
+  @set_config_cmd = @set_cmd.define_command do
+    name 'config'
+    usage _('config [name] [value]')
+    summary _('Set or update the configuration for <name>')
+
+    option :f, :force, _('Force the configuration setting to be overwitten.'), argument: :forbidden
+
+    option :t, :type, _('The type of value to set. Acceptable values: %{values}') % { values: PDK::CLI::Set::Config.pretty_allowed_names }, argument: :required
+    option nil, :as, _('Alias of --type'), argument: :required
+
+    run do |opts, args, _cmd|
+      exit PDK::CLI::Set::Config.run(opts, args)
+    end
+  end
+end

data/lib/pdk/cli/set.rb

@@ -1,20 +1,20 @@
-module PDK::CLI
-  @set_cmd = @base_cmd.define_command do
-    name 'set'
-    usage _('set [subcommand] [options]')
-    summary _('Set or update information about the PDK or current project.')
-    default_subcommand 'help'
-
-    run do |_opts, args, _cmd|
-      if args == ['help']
-        PDK::CLI.run(%w[set --help])
-        exit 0
-      end
-
-      PDK::CLI.run(%w[set help]) if args.empty?
-    end
-  end
-  @set_cmd.add_command Cri::Command.new_basic_help
-end
-
-require 'pdk/cli/set/config'
+module PDK::CLI
+  @set_cmd = @base_cmd.define_command do
+    name 'set'
+    usage _('set [subcommand] [options]')
+    summary _('Set or update information about the PDK or current project.')
+    default_subcommand 'help'
+
+    run do |_opts, args, _cmd|
+      if args == ['help']
+        PDK::CLI.run(%w[set --help])
+        exit 0
+      end
+
+      PDK::CLI.run(%w[set help]) if args.empty?
+    end
+  end
+  @set_cmd.add_command Cri::Command.new_basic_help
+end
+
+require 'pdk/cli/set/config'

data/lib/pdk/cli/test/unit.rb

@@ -1,90 +1,90 @@
-module PDK::CLI
-  @test_unit_cmd = @test_cmd.define_command do
-    name 'unit'
-    usage _('unit [options]')
-    summary _('Run unit tests.')
-
-    PDK::CLI.puppet_version_options(self)
-    PDK::CLI.puppet_dev_option(self)
-    flag nil, :list, _('List all available unit test files.')
-    flag nil, :parallel, _('Run unit tests in parallel.')
-    flag :v, :verbose, _('More verbose --list output. Displays a list of examples in each unit test file.')
-    flag :c, 'clean-fixtures', _('Clean up downloaded fixtures after the test run.')
-
-    option nil, :tests, _('Specify a comma-separated list of unit test files to run.'), argument: :required, default: '' do |values|
-      require 'pdk/cli/util/option_validator'
-      PDK::CLI::Util::OptionValidator.comma_separated_list?(values)
-    end
-
-    # TODO
-    # option nil, :runner_options, _("options to pass through to the actual test-runner"), argument: :required
-
-    run do |opts, _args, _cmd|
-      require 'pdk/tests/unit'
-      require 'pdk/report'
-      require 'pdk/util/bundler'
-
-      PDK::CLI::Util.validate_puppet_version_opts(opts)
-
-      PDK::CLI::Util.ensure_in_module!(
-        message:   _('Unit tests can only be run from inside a valid module directory.'),
-        log_level: :info,
-      )
-
-      PDK::CLI::Util.module_version_check
-
-      PDK::CLI::Util.analytics_screen_view('test_unit', opts)
-
-      # Ensure that the bundled gems are up to date and correct Ruby is activated before running or listing tests.
-      puppet_env = PDK::CLI::Util.puppet_from_opts_or_env(opts)
-      PDK::Util::RubyVersion.use(puppet_env[:ruby_version])
-
-      opts.merge!(puppet_env[:gemset])
-
-      PDK::Util::Bundler.ensure_bundle!(puppet_env[:gemset])
-
-      report = nil
-
-      if opts[:list]
-        examples = PDK::Test::Unit.list(opts)
-
-        if examples.empty?
-          puts _('No unit test files with examples were found.')
-        else
-          puts _('Unit Test Files:')
-          files = examples.map { |example| example[:file_path] }
-          files.uniq.each do |file|
-            puts _(file)
-
-            next unless opts[:verbose]
-
-            file_examples = examples.select { |example| example[:file_path] == file }
-            file_examples.each do |file_example|
-              puts _("\t%{id}\t%{description}" % { id: file_example[:id], description: file_example[:full_description] })
-            end
-          end
-        end
-      else
-        report = PDK::Report.new
-        report_formats = if opts[:format]
-                           opts[:interactive] = false
-                           PDK::CLI::Util::OptionNormalizer.report_formats(opts[:format])
-                         else
-                           opts[:interactive] = true
-                           [{
-                             method: PDK::Report.default_format,
-                             target: PDK::Report.default_target,
-                           }]
-                         end
-
-        exit_code = PDK::Test::Unit.invoke(report, opts)
-
-        report_formats.each do |format|
-          report.send(format[:method], format[:target])
-        end
-
-        exit exit_code
-      end
-    end
-  end
-end
+module PDK::CLI
+  @test_unit_cmd = @test_cmd.define_command do
+    name 'unit'
+    usage _('unit [options]')
+    summary _('Run unit tests.')
+
+    PDK::CLI.puppet_version_options(self)
+    PDK::CLI.puppet_dev_option(self)
+    flag nil, :list, _('List all available unit test files.')
+    flag nil, :parallel, _('Run unit tests in parallel.')
+    flag :v, :verbose, _('More verbose --list output. Displays a list of examples in each unit test file.')
+    flag :c, 'clean-fixtures', _('Clean up downloaded fixtures after the test run.')
+
+    option nil, :tests, _('Specify a comma-separated list of unit test files to run.'), argument: :required, default: '' do |values|
+      require 'pdk/cli/util/option_validator'
+      PDK::CLI::Util::OptionValidator.comma_separated_list?(values)
+    end
+
+    # TODO
+    # option nil, :runner_options, _("options to pass through to the actual test-runner"), argument: :required
+
+    run do |opts, _args, _cmd|
+      require 'pdk/tests/unit'
+      require 'pdk/report'
+      require 'pdk/util/bundler'
+
+      PDK::CLI::Util.validate_puppet_version_opts(opts)
+
+      PDK::CLI::Util.ensure_in_module!(
+        message:   _('Unit tests can only be run from inside a valid module directory.'),
+        log_level: :info,
+      )
+
+      PDK::CLI::Util.module_version_check
+
+      PDK::CLI::Util.analytics_screen_view('test_unit', opts)
+
+      # Ensure that the bundled gems are up to date and correct Ruby is activated before running or listing tests.
+      puppet_env = PDK::CLI::Util.puppet_from_opts_or_env(opts)
+      PDK::Util::RubyVersion.use(puppet_env[:ruby_version])
+
+      opts.merge!(puppet_env[:gemset])
+
+      PDK::Util::Bundler.ensure_bundle!(puppet_env[:gemset])
+
+      report = nil
+
+      if opts[:list]
+        examples = PDK::Test::Unit.list(opts)
+
+        if examples.empty?
+          puts _('No unit test files with examples were found.')
+        else
+          puts _('Unit Test Files:')
+          files = examples.map { |example| example[:file_path] }
+          files.uniq.each do |file|
+            puts _(file)
+
+            next unless opts[:verbose]
+
+            file_examples = examples.select { |example| example[:file_path] == file }
+            file_examples.each do |file_example|
+              puts _("\t%{id}\t%{description}" % { id: file_example[:id], description: file_example[:full_description] })
+            end
+          end
+        end
+      else
+        report = PDK::Report.new
+        report_formats = if opts[:format]
+                           opts[:interactive] = false
+                           PDK::CLI::Util::OptionNormalizer.report_formats(opts[:format])
+                         else
+                           opts[:interactive] = true
+                           [{
+                             method: PDK::Report.default_format,
+                             target: PDK::Report.default_target,
+                           }]
+                         end
+
+        exit_code = PDK::Test::Unit.invoke(report, opts)
+
+        report_formats.each do |format|
+          report.send(format[:method], format[:target])
+        end
+
+        exit exit_code
+      end
+    end
+  end
+end

data/lib/pdk/cli/test.rb

@@ -1,11 +1,11 @@
-module PDK::CLI
-  @test_cmd = @base_cmd.define_command do
-    name 'test'
-    usage _('test [subcommand] [options]')
-    summary _('Run tests.')
-    default_subcommand 'help'
-  end
-  @test_cmd.add_command Cri::Command.new_basic_help
-end
-
-require 'pdk/cli/test/unit'
+module PDK::CLI
+  @test_cmd = @base_cmd.define_command do
+    name 'test'
+    usage _('test [subcommand] [options]')
+    summary _('Run tests.')
+    default_subcommand 'help'
+  end
+  @test_cmd.add_command Cri::Command.new_basic_help
+end
+
+require 'pdk/cli/test/unit'

data/lib/pdk/cli/update.rb

@@ -1,64 +1,64 @@
-module PDK::CLI
-  @update_cmd = @base_cmd.define_command do
-    name 'update'
-    usage _('update [options]')
-    summary _('Update a module that has been created by or converted for use by PDK.')
-
-    flag nil, :noop, _('Do not update the module, just output what would be done.')
-    flag nil, :force, _('Update the module automatically, with no prompts.')
-
-    PDK::CLI.template_ref_option(self)
-
-    run do |opts, _args, _cmd|
-      # Write the context information to the debug log
-      PDK.context.to_debug_log
-
-      unless PDK.context.is_a?(PDK::Context::Module)
-        raise PDK::CLI::ExitWithError, _('`pdk update` can only be run from inside a valid module directory.')
-      end
-
-      raise PDK::CLI::ExitWithError, _('This module does not appear to be PDK compatible. To make the module compatible with PDK, run `pdk convert`.') unless PDK::Util.module_pdk_compatible?
-
-      if opts[:noop] && opts[:force]
-        raise PDK::CLI::ExitWithError, _('You can not specify --noop and --force when updating a module')
-      end
-
-      if Gem::Version.new(PDK::VERSION) < Gem::Version.new(PDK::Util.module_pdk_version)
-        PDK.logger.warn _(
-          'This module has been updated to PDK %{module_pdk_version} which ' \
-          'is newer than your PDK version (%{user_pdk_version}), proceed ' \
-          'with caution!',
-        ) % {
-          module_pdk_version: PDK::Util.module_pdk_version,
-          user_pdk_version:   PDK::VERSION,
-        }
-
-        unless opts[:force]
-          raise PDK::CLI::ExitWithError, _(
-            'Please update your PDK installation and try again. ' \
-            'You may also use the --force flag to override this and ' \
-            'continue at your own risk.',
-          )
-        end
-      end
-
-      PDK::CLI::Util.analytics_screen_view('update', opts)
-
-      updater = PDK::Module::Update.new(PDK.context.root_path, opts)
-
-      if updater.pinned_to_puppetlabs_template_tag?
-        PDK.logger.info _(
-          'This module is currently pinned to version %{current_version} ' \
-          'of the default template. If you would like to update your ' \
-          'module to the latest version of the template, please run `pdk ' \
-          'update --template-ref %{new_version}`.',
-        ) % {
-          current_version: updater.template_uri.uri_fragment,
-          new_version:     PDK::TEMPLATE_REF,
-        }
-      end
-
-      updater.run
-    end
-  end
-end
+module PDK::CLI
+  @update_cmd = @base_cmd.define_command do
+    name 'update'
+    usage _('update [options]')
+    summary _('Update a module that has been created by or converted for use by PDK.')
+
+    flag nil, :noop, _('Do not update the module, just output what would be done.')
+    flag nil, :force, _('Update the module automatically, with no prompts.')
+
+    PDK::CLI.template_ref_option(self)
+
+    run do |opts, _args, _cmd|
+      # Write the context information to the debug log
+      PDK.context.to_debug_log
+
+      unless PDK.context.is_a?(PDK::Context::Module)
+        raise PDK::CLI::ExitWithError, _('`pdk update` can only be run from inside a valid module directory.')
+      end
+
+      raise PDK::CLI::ExitWithError, _('This module does not appear to be PDK compatible. To make the module compatible with PDK, run `pdk convert`.') unless PDK::Util.module_pdk_compatible?
+
+      if opts[:noop] && opts[:force]
+        raise PDK::CLI::ExitWithError, _('You can not specify --noop and --force when updating a module')
+      end
+
+      if Gem::Version.new(PDK::VERSION) < Gem::Version.new(PDK::Util.module_pdk_version)
+        PDK.logger.warn _(
+          'This module has been updated to PDK %{module_pdk_version} which ' \
+          'is newer than your PDK version (%{user_pdk_version}), proceed ' \
+          'with caution!',
+        ) % {
+          module_pdk_version: PDK::Util.module_pdk_version,
+          user_pdk_version:   PDK::VERSION,
+        }
+
+        unless opts[:force]
+          raise PDK::CLI::ExitWithError, _(
+            'Please update your PDK installation and try again. ' \
+            'You may also use the --force flag to override this and ' \
+            'continue at your own risk.',
+          )
+        end
+      end
+
+      PDK::CLI::Util.analytics_screen_view('update', opts)
+
+      updater = PDK::Module::Update.new(PDK.context.root_path, opts)
+
+      if updater.pinned_to_puppetlabs_template_tag?
+        PDK.logger.info _(
+          'This module is currently pinned to version %{current_version} ' \
+          'of the default template. If you would like to update your ' \
+          'module to the latest version of the template, please run `pdk ' \
+          'update --template-ref %{new_version}`.',
+        ) % {
+          current_version: updater.template_uri.uri_fragment,
+          new_version:     PDK::TEMPLATE_REF,
+        }
+      end
+
+      updater.run
+    end
+  end
+end