pdk 1.14.1 → 1.18.1

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/module/build.rb

@@ -5,7 +5,7 @@ module PDK::CLI
     summary _('This command is now \'pdk build\'.')
 
     run do |_opts, _args, _cmd|
-      PDK.logger.warn(_('Modules are built using the ‘pdk build’ command.'))
+      PDK.logger.warn(_("Modules are built using the 'pdk build' command."))
       exit 1
     end
   end

data/lib/pdk/cli/module/generate.rb

@@ -21,7 +21,7 @@ module PDK::CLI
 
       PDK::CLI::Util.validate_template_opts(opts)
 
-      PDK.logger.info(_('New modules are created using the ‘pdk new module’ command.'))
+      PDK.logger.info(_("New modules are created using the 'pdk new module' command."))
       prompt = TTY::Prompt.new(help_color: :cyan)
       redirect = PDK::CLI::Util::CommandRedirector.new(prompt)
       redirect.target_command('pdk new module')

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

@@ -13,7 +13,6 @@ module PDK::CLI
       )
 
       class_name = args[0]
-      module_dir = Dir.pwd
 
       if class_name.nil? || class_name.empty?
         puts command.help
@@ -26,7 +25,8 @@ module PDK::CLI
 
       PDK::CLI::Util.analytics_screen_view('new_class', opts)
 
-      PDK::Generate::PuppetClass.new(module_dir, 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

@@ -11,7 +11,6 @@ module PDK::CLI
       )
 
       defined_type_name = args[0]
-      module_dir = Dir.pwd
 
       if defined_type_name.nil? || defined_type_name.empty?
         puts command.help
@@ -26,7 +25,8 @@ module PDK::CLI
 
       require 'pdk/generate/defined_type'
 
-      PDK::Generate::DefinedType.new(module_dir, 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/provider.rb

@@ -8,7 +8,6 @@ module PDK::CLI
       PDK::CLI::Util.ensure_in_module!
 
       provider_name = args[0]
-      module_dir = Dir.pwd
 
       if provider_name.nil? || provider_name.empty?
         puts command.help
@@ -23,7 +22,8 @@ module PDK::CLI
 
       require 'pdk/generate/provider'
 
-      PDK::Generate::Provider.new(module_dir, 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

@@ -15,7 +15,6 @@ module PDK::CLI
       )
 
       task_name = args[0]
-      module_dir = Dir.pwd
 
       if task_name.nil? || task_name.empty?
         puts command.help
@@ -28,7 +27,8 @@ module PDK::CLI
 
       PDK::CLI::Util.analytics_screen_view('new_task', opts)
 
-      PDK::Generate::Task.new(module_dir, 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

@@ -18,7 +18,6 @@ module PDK::CLI
       )
 
       object_name = args[0]
-      module_dir = Dir.pwd
 
       if object_name.nil? || object_name.empty?
         puts command.help
@@ -41,7 +40,8 @@ module PDK::CLI
 
         PDK::CLI::Util.analytics_screen_view('new_test', opts)
 
-        generator.new(module_dir, 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

@@ -8,7 +8,6 @@ module PDK::CLI
       PDK::CLI::Util.ensure_in_module!
 
       transport_name = args[0]
-      module_dir = Dir.pwd
 
       if transport_name.nil? || transport_name.empty?
         puts command.help
@@ -21,7 +20,8 @@ module PDK::CLI
 
       require 'pdk/generate/transport'
 
-      PDK::Generate::Transport.new(module_dir, 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.rb

@@ -0,0 +1,192 @@
+require 'pdk/cli/util'
+require 'pdk/validate'
+require 'pdk/util/bundler'
+require 'pdk/cli/util/interview'
+require 'pdk/util/changelog_generator'
+require 'pdk/module/build'
+
+module PDK::CLI
+  @release_cmd = @base_cmd.define_command do
+    name 'release'
+    usage _('release [options]')
+    summary _('(Experimental) Release a module to the Puppet Forge.')
+
+    flag nil, :force,                _('Release the module automatically, with no prompts.')
+    flag nil, :'skip-validation',    _('Skips the module validation check.')
+    flag nil, :'skip-changelog',     _('Skips the automatic changelog generation.')
+    flag nil, :'skip-dependency',    _('Skips the module dependency check.')
+    flag nil, :'skip-documentation', _('Skips the documentation update.')
+    flag nil, :'skip-build',         _('Skips module build.')
+    flag nil, :'skip-publish',       _('Skips publishing the module to the forge.')
+
+    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, :version, _('Update the module to the specified version prior to release. When not specified, the new version will be computed from the Changelog where possible.'),
+           argument: :required
+
+    option nil, :file, _('Path to the built module to push to the Forge. This option can only be used when --skip-build is also used. Defaults to pkg/<module version>.tar.gz'),
+           argument: :required
+
+    run do |opts, _args, _cmd|
+      # Make sure build is being run in a valid module directory with a metadata.json
+      PDK::CLI::Util.ensure_in_module!(
+        message:   _('`pdk release` can only be run from inside a valid module with a metadata.json.'),
+        log_level: :info,
+      )
+
+      Release.prepare_interview(opts) unless opts[:force]
+
+      Release.send_analytics('release', opts)
+
+      release = PDK::Module::Release.new(nil, opts)
+
+      Release.module_compatibility_checks!(release, opts)
+
+      release.run
+    end
+  end
+
+  module Release
+    # Checks whether the module is compatible with PDK release process
+    # @param release PDK::Module::Release Object representing the release
+    # @param opts Options Hash from Cri
+    def self.module_compatibility_checks!(release, opts)
+      unless release.module_metadata.forge_ready?
+        if opts[:force]
+          PDK.logger.warn _(
+            'This module is missing the following fields in the metadata.json: %{fields}. ' \
+            'These missing fields may affect the visibility of the module on the Forge.',
+          ) % {
+            fields: release.module_metadata.missing_fields.join(', '),
+          }
+        else
+          release.module_metadata.interview_for_forge!
+          release.write_module_metadata!
+        end
+      end
+
+      unless release.pdk_compatible? # rubocop:disable Style/GuardClause Nope!
+        if opts[:force]
+          PDK.logger.warn _('This module is not compatible with PDK, so PDK can not validate or test this build.')
+        else
+          PDK.logger.info _('This module is not compatible with PDK, so PDK can not validate or test this build. ' \
+                            'Unvalidated modules may have errors when uploading to the Forge. ' \
+                            'To make this module PDK compatible and use validate features, cancel the build and run `pdk convert`.')
+          unless PDK::CLI::Util.prompt_for_yes(_('Continue build without converting?'))
+            PDK.logger.info _('Build cancelled; exiting.')
+            PDK::Util.exit_process(1)
+          end
+        end
+      end
+    end
+
+    # Send_analytics for the given command and Cri options
+    def self.send_analytics(command, opts)
+      # Don't pass tokens to analytics
+      PDK::CLI::Util.analytics_screen_view(command, opts.reject { |k, _| k == :'forge-token' })
+    end
+
+    def self.prepare_interview(opts)
+      questions = []
+
+      unless opts[:'skip-validation']
+        questions << {
+          name:     'validation',
+          question: _('Do you want to run the module validation ?'),
+          type:     :yes,
+        }
+      end
+      unless opts[:'skip-changelog']
+        questions << {
+          name:     'changelog',
+          question: _('Do you want to run the automatic changelog generation ?'),
+          type:     :yes,
+        }
+      end
+      unless opts[:version]
+        questions << {
+          name:     'setversion',
+          question: _('Do you want to set the module version ?'),
+          type:     :yes,
+        }
+      end
+      unless opts[:'skip-dependency']
+        questions << {
+          name:     'dependency',
+          question: _('Do you want to run the dependency-checker on this module?'),
+          type:     :yes,
+        }
+      end
+      unless opts[:'skip-documentation']
+        questions << {
+          name:     'documentation',
+          question: _('Do you want to update the documentation for this module?'),
+          type:     :yes,
+        }
+      end
+      unless opts[:'skip-publish']
+        questions << {
+          name:     'publish',
+          question: _('Do you want to publish the module on the Puppet Forge?'),
+          type:     :yes,
+        }
+      end
+
+      prompt = TTY::Prompt.new(help_color: :cyan)
+      interview = PDK::CLI::Util::Interview.new(prompt)
+      interview.add_questions(questions)
+      answers = interview.run
+
+      unless answers.nil?
+        opts[:'skip-validation'] = !answers['validation']
+        opts[:'skip-changelog'] = !answers['changelog']
+        opts[:'skip-dependency'] = !answers['dependency']
+        opts[:'skip-documentation'] = !answers['documentation']
+
+        prepare_version_interview(prompt, opts) if answers['setversion']
+
+        prepare_publish_interview(prompt, opts) if answers['publish']
+      end
+      answers
+    end
+
+    def self.prepare_version_interview(prompt, opts)
+      questions = [
+        {
+          name:             'version',
+          question:         _('Please set the module version'),
+          help:             _('This value is the version that will be used in the changelog generator and building of the module.'),
+          required:         true,
+          validate_pattern: %r{(\*|\d+(\.\d+){0,2}(\.\*)?)$}i,
+          validate_message: _('The version format should be in the format x.y.z where x represents the major version, y the minor version and z the build number.'),
+        },
+      ]
+      interview = PDK::CLI::Util::Interview.new(prompt)
+      interview.add_questions(questions)
+      ver_answer = interview.run
+      opts[:version] = ver_answer['version']
+    end
+
+    def self.prepare_publish_interview(prompt, opts)
+      return if opts[:'forge-token']
+      questions = [
+        {
+          name:             'apikey',
+          question:         _('Please set the api key(authorization token) to upload on the Puppet Forge'),
+          help:             _('This value is used for authentication on the Puppet Forge to upload your module tarball.'),
+          required:         true,
+        },
+      ]
+      interview = PDK::CLI::Util::Interview.new(prompt)
+      interview.add_questions(questions)
+      api_answer = interview.run
+      opts[:'forge-token'] = api_answer['apikey']
+    end
+  end
+end
+
+require 'pdk/cli/release/prep'
+require 'pdk/cli/release/publish'

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

@@ -0,0 +1,39 @@
+require 'pdk/cli/release'
+
+module PDK::CLI
+  @release_prep_cmd = @release_cmd.define_command do
+    name 'prep'
+    usage _('prep [options]')
+    summary _('(Experimental) Performs all the pre-release checks to ensure module is ready to be released')
+
+    flag nil, :force,                _('Prepare the module automatically, with no prompts.')
+    flag nil, :'skip-validation',    _('Skips the module validation check.')
+    flag nil, :'skip-changelog',     _('Skips the automatic changelog generation.')
+    flag nil, :'skip-dependency',    _('Skips the module dependency check.')
+    flag nil, :'skip-documentation', _('Skips the documentation update.')
+
+    option nil, :version, _('Update the module to the specified version prior to release. When not specified, the new version will be computed from the Changelog where possible.'),
+           argument: :required
+
+    run do |opts, _args, cmd|
+      # Make sure build is being run in a valid module directory with a metadata.json
+      PDK::CLI::Util.ensure_in_module!(
+        message:   _("`pdk release #{cmd.name}` can only be run from inside a valid module with a metadata.json."),
+        log_level: :info,
+      )
+
+      opts[:'skip-build'] = true
+      opts[:'skip-publish'] = true
+
+      Release.prepare_interview(opts) unless opts[:force]
+
+      Release.send_analytics("release #{cmd.name}", opts)
+
+      release = PDK::Module::Release.new(nil, opts)
+
+      Release.module_compatibility_checks!(release, opts)
+
+      release.run
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+require 'pdk/cli/release'
+
+module PDK::CLI
+  @release_publish_cmd = @release_cmd.define_command do
+    name 'publish'
+    usage _('publish [options] <tarball>')
+    summary _('(Experimental) Publishes the module <tarball> to the Forge.')
+
+    flag nil, :force,                _('Publish the module automatically, with no prompts.')
+
+    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
+
+    run do |opts, _args, cmd|
+      # Make sure build is being run in a valid module directory with a metadata.json
+      PDK::CLI::Util.ensure_in_module!(
+        message:   _("`pdk release #{cmd.name}` can only be run from inside a valid module with a metadata.json."),
+        log_level: :info,
+      )
+
+      opts[:'skip-validation'] = true
+      opts[:'skip-changelog'] = true
+      opts[:'skip-dependency'] = true
+      opts[:'skip-documentation'] = true
+      opts[:'skip-build'] = true
+      opts[:'skip-versionset'] = true
+      opts[:force] = true unless PDK::CLI::Util.interactive?
+
+      Release.prepare_publish_interview(TTY::Prompt.new(help_color: :cyan), opts) unless opts[:force]
+
+      Release.send_analytics("release #{cmd.name}", opts)
+
+      release = PDK::Module::Release.new(nil, opts)
+
+      release.run
+    end
+  end
+end