pdk 1.16.0 → 2.1.0

data/lib/pdk/cli/get.rb

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

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

@@ -0,0 +1,24 @@
+module PDK::CLI
+  @get_config_cmd = @get_cmd.define_command do
+    name 'config'
+    usage _('config [name]')
+    summary _('Retrieve the configuration for <name>. If not specified, retrieve all configuration settings')
+
+    run do |_opts, args, _cmd|
+      item_name = args[0]
+      resolved_config = PDK.config.resolve(item_name)
+      # If the user wanted to know a setting but it doesn't exist, raise an error
+      if resolved_config.empty? && !item_name.nil?
+        PDK.logger.error(_("Configuration item '%{name}' does not exist") % { name: item_name })
+        exit 1
+      end
+      # If the user requested a setting and it's the only one resolved, then just output the value
+      if resolved_config.count == 1 && resolved_config.keys[0] == item_name
+        puts _('%{value}') % { value: resolved_config.values[0] }
+        exit 0
+      end
+      # Otherwise just output everything
+      resolved_config.keys.sort.each { |key| puts _('%{name}=%{value}') % { name: key, value: resolved_config[key] } }
+    end
+  end
+end

data/lib/pdk/cli/new.rb

@@ -17,3 +17,5 @@ require 'pdk/cli/new/provider'
 require 'pdk/cli/new/task'
 require 'pdk/cli/new/test'
 require 'pdk/cli/new/transport'
+require 'pdk/cli/new/fact'
+require 'pdk/cli/new/function'

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

@@ -25,7 +25,8 @@ module PDK::CLI
 
       PDK::CLI::Util.analytics_screen_view('new_class', opts)
 
-      PDK::Generate::PuppetClass.new(PDK::Util.module_root, class_name, opts).run
+      updates = PDK::Generate::PuppetClass.new(PDK.context, class_name, opts).run
+      PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
     end
   end
 end

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

@@ -25,7 +25,8 @@ module PDK::CLI
 
       require 'pdk/generate/defined_type'
 
-      PDK::Generate::DefinedType.new(PDK::Util.module_root, defined_type_name, opts).run
+      updates = PDK::Generate::DefinedType.new(PDK.context, defined_type_name, opts).run
+      PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
     end
   end
 end

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

@@ -0,0 +1,29 @@
+module PDK::CLI
+  @new_fact_cmd = @new_cmd.define_command do
+    name 'fact'
+    usage _('fact [options] <name>')
+    summary _('Create a new custom fact named <name> using given options')
+
+    run do |opts, args, _cmd|
+      PDK::CLI::Util.ensure_in_module!
+
+      fact_name = args[0]
+
+      if fact_name.nil? || fact_name.empty?
+        puts command.help
+        exit 1
+      end
+
+      unless Util::OptionValidator.valid_fact_name?(fact_name)
+        raise PDK::CLI::ExitWithError, _("'%{name}' is not a valid fact name") % { name: fact_name }
+      end
+
+      PDK::CLI::Util.analytics_screen_view('new_fact', opts)
+
+      require 'pdk/generate/fact'
+
+      updates = PDK::Generate::Fact.new(PDK.context, fact_name, opts).run
+      PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module PDK::CLI
+  @new_function_cmd = @new_cmd.define_command do
+    name 'function'
+    usage _('function [options] <name>')
+    summary _('Create a new function named <name> using given options')
+    option :t, :type, _('The function type, (native or v4)'), argument: :required, default: 'native'
+
+    run do |opts, args, _cmd|
+      PDK::CLI::Util.ensure_in_module!
+
+      function_name = args[0]
+
+      if function_name.nil? || function_name.empty?
+        puts command.help
+        exit 1
+      end
+
+      unless Util::OptionValidator.valid_function_name?(function_name)
+        raise PDK::CLI::ExitWithError, _("'%{name}' is not a valid function name") % { name: function_name }
+      end
+
+      PDK::CLI::Util.analytics_screen_view('new_function', opts)
+
+      require 'pdk/generate/function'
+      updates = PDK::Generate::Function.new(PDK.context, function_name, opts).run
+      PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
+    end
+  end
+end

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

@@ -22,7 +22,8 @@ module PDK::CLI
 
       require 'pdk/generate/provider'
 
-      PDK::Generate::Provider.new(PDK::Util.module_root, provider_name, opts).run
+      updates = PDK::Generate::Provider.new(PDK.context, provider_name, opts).run
+      PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
     end
   end
 end

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

@@ -27,7 +27,8 @@ module PDK::CLI
 
       PDK::CLI::Util.analytics_screen_view('new_task', opts)
 
-      PDK::Generate::Task.new(PDK::Util.module_root, task_name, opts).run
+      updates = PDK::Generate::Task.new(PDK.context, task_name, opts).run
+      PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
     end
   end
 end

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

@@ -40,7 +40,8 @@ module PDK::CLI
 
         PDK::CLI::Util.analytics_screen_view('new_test', opts)
 
-        generator.new(PDK::Util.module_root, obj['name'], opts.merge(spec_only: true)).run
+        updates = generator.new(PDK.context, obj['name'], opts.merge(spec_only: true)).run
+        PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
       rescue PDK::Util::PuppetStrings::NoObjectError
         raise PDK::CLI::ExitWithError, _('Unable to find anything called "%{object}" to generate unit tests for.') % { object: object_name }
       rescue PDK::Util::PuppetStrings::NoGeneratorError => e

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

@@ -20,7 +20,8 @@ module PDK::CLI
 
       require 'pdk/generate/transport'
 
-      PDK::Generate::Transport.new(PDK::Util.module_root, transport_name, opts).run
+      updates = PDK::Generate::Transport.new(PDK.context, transport_name, opts).run
+      PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
     end
   end
 end

data/lib/pdk/cli/release/publish.rb

@@ -11,7 +11,7 @@ module PDK::CLI
     option nil, :'forge-upload-url', _('Set forge upload url path.'),
            argument: :required, default: 'https://forgeapi.puppetlabs.com/v3/releases'
 
-    option nil, :'forge-token', _('Set Forge API token.'), argument: :required, default: nil
+    option nil, :'forge-token', _('Set Forge API token (you may also set via environment variable PDK_FORGE_TOKEN)'), argument: :required
 
     run do |opts, _args, cmd|
       # Make sure build is being run in a valid module directory with a metadata.json
@@ -27,6 +27,16 @@ module PDK::CLI
       opts[:'skip-build'] = true
       opts[:'skip-versionset'] = true
       opts[:force] = true unless PDK::CLI::Util.interactive?
+      opts[:'forge-token'] ||= PDK::Util::Env['PDK_FORGE_TOKEN']
+
+      if opts[:'forge-token'].nil? || opts[:'forge-token'].empty?
+        PDK.logger.error _(
+          'You must supply a Forge API token either via `--forge-token` option ' \
+          'or PDK_FORGE_TOKEN environment variable.',
+        )
+
+        exit 1
+      end
 
       Release.prepare_publish_interview(TTY::Prompt.new(help_color: :cyan), opts) unless opts[:force]
 

data/lib/pdk/cli/remove.rb

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

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

@@ -0,0 +1,80 @@
+module PDK::CLI
+  module Remove
+    module Config
+      def self.run(opts, args)
+        item_name = (args.count > 0) ? args[0] : nil
+        item_value = (args.count > 1) ? args[1].strip : nil
+        item_value = nil if !item_value.nil? && item_value.empty?
+
+        force = opts[:force] || false
+
+        raise PDK::CLI::ExitWithError, _('Configuration name is required') if item_name.nil?
+
+        current_value = PDK.config.get(item_name)
+        raise PDK::CLI::ExitWithError, _("The configuration item '%{name}' can not be removed.") % { name: item_name } if current_value.is_a?(PDK::Config::Namespace)
+        if current_value.nil?
+          PDK.logger.info(_("Could not remove '%{name}' as it has not been set") % { name: item_name })
+          return 0
+        end
+
+        PDK.logger.info(_("Ignoring the item value '%{value}' as --force has been set") % { value: item_value }) if current_value.is_a?(Array) && !item_value.nil? && force
+        PDK.logger.info(_('Ignoring --force as the setting is not multi-valued')) if !current_value.is_a?(Array) && force
+
+        # FIXME: It'd be nice to shortcircuit deleting default values.  This causes the configuration file
+        # to be saved, even though nothing actually changes
+
+        # For most value types, just changing the value to nil is enough, however Arrays are a special case.
+        # Unless they're forced, array removal with either remove a single entry (matched by .to_s) or clear the
+        # array.  When forced, the array is completed removed just like a string or number.
+        if current_value.is_a?(Array) && !force
+          # If the user didn't set a value then set the array as empty, otherwise remove that one item
+          new_value = item_value.nil? ? [] : current_value.reject { |item| item.to_s == item_value }
+          if current_value.count == new_value.count
+            if item_value.nil?
+              PDK.logger.info(_("Could not remove '%{name}' as it is already empty") % { name: item_name })
+            else
+              PDK.logger.info(_("Could not remove '%{value}' from '%{name}' as it has not been set") % { value: item_value, name: item_name })
+            end
+            return 0
+          end
+          PDK.config.set(item_name, new_value, force: true)
+        else
+          # Set the value to nil for deleting.
+          PDK.config.set(item_name, nil, force: true)
+        end
+
+        # Output the result to the user
+        new_value = PDK.config.get(item_name)
+        if current_value.is_a?(Array) && !force
+          # Arrays have a special output format. If item_value is nil then the user wanted to empty/clear
+          # the array otherwise they just wanted to remove a single entry.
+          if item_value.nil?
+            PDK.logger.info(_("Cleared '%{name}' which had a value of '%{from}'") % { name: item_name, from: current_value })
+          else
+            PDK.logger.info(_("Removed '%{value}' from '%{name}'") % { value: item_value, name: item_name })
+          end
+        elsif !new_value.nil?
+          PDK.logger.info(_("Could not remove '%{name}' as it using a default value of '%{to}'") % { name: item_name, to: new_value })
+        else
+          PDK.logger.info(_("Removed '%{name}' which had a value of '%{from}'") % { name: item_name, from: current_value })
+        end
+
+        # Same output as `get config`
+        $stdout.puts _('%{name}=%{value}') % { name: item_name, value: new_value }
+        0
+      end
+    end
+  end
+
+  @remove_config_cmd = @remove_cmd.define_command do
+    name 'config'
+    usage _('config [name] [value]')
+    summary _('Remove or delete the configuration for <name>')
+
+    option :f, :force, _('Force multi-value configuration settings to be removed instead of emptied.'), argument: :forbidden
+
+    run do |opts, args, _cmd|
+      exit PDK::CLI::Remove::Config.run(opts, args)
+    end
+  end
+end

data/lib/pdk/cli/set.rb

@@ -0,0 +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'

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

@@ -0,0 +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