pdk 2.7.1 → 3.0.0

data/lib/pdk/cli/release.rb

@@ -5,183 +5,186 @@ 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.'
+module PDK
+  module 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.'
+      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-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: :optional
+      option nil, :'forge-token', 'Set Forge API token.',
+             argument: :optional
 
-    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, :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
+      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,
-      )
+      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.prepare_interview(opts) unless opts[:force]
 
-      Release.send_analytics('release', opts)
+        Release.send_analytics('release', opts)
 
-      release = PDK::Module::Release.new(nil, opts)
+        release = PDK::Module::Release.new(nil, opts)
 
-      Release.module_compatibility_checks!(release, opts)
+        Release.module_compatibility_checks!(release, opts)
 
-      release.run
+        release.run
+      end
     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: #{release.module_metadata.missing_fields.join(', ')}. " \
-                          'These missing fields may affect the visibility of the module on the Forge.'
-        else
-          release.module_metadata.interview_for_forge!
-          release.write_module_metadata!
+    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: #{release.module_metadata.missing_fields.join(', ')}. " \
+                            'These missing fields may affect the visibility of the module on the Forge.'
+          else
+            release.module_metadata.interview_for_forge!
+            release.write_module_metadata!
+          end
         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)
+        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
-    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
+      # 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 = []
+      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
+        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
+        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']
-        opts[:'skip-publish'] = !answers['publish']
+        unless answers.nil?
+          opts[:'skip-validation'] = !answers['validation']
+          opts[:'skip-changelog'] = !answers['changelog']
+          opts[:'skip-dependency'] = !answers['dependency']
+          opts[:'skip-documentation'] = !answers['documentation']
+          opts[:'skip-publish'] = !answers['publish']
 
-        prepare_version_interview(prompt, opts) if answers['setversion']
+          prepare_version_interview(prompt, opts) if answers['setversion']
 
-        prepare_publish_interview(prompt, opts) if answers['publish']
+          prepare_publish_interview(prompt, opts) if answers['publish']
+        end
+        answers
       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_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: /(\*|\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']
+      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
 end

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

@@ -1,80 +1,83 @@
-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?
+module PDK
+  module CLI
+    module Remove
+      module Config
+        def self.run(opts, args)
+          item_name = args.count.positive? ? 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
+          force = opts[:force] || false
 
-        raise PDK::CLI::ExitWithError, 'Configuration name is required' if item_name.nil?
+          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
+          current_value = PDK.config.get(item_name)
+          raise PDK::CLI::ExitWithError, format("The configuration item '%{name}' can not be removed.", name: item_name) if current_value.is_a?(PDK::Config::Namespace)
 
-        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
+          if current_value.nil?
+            PDK.logger.info(format("Could not remove '%{name}' as it has not been set", name: item_name))
+            return 0
+          end
 
-        # FIXME: It'd be nice to shortcircuit deleting default values.  This causes the configuration file
-        # to be saved, even though nothing actually changes
+          PDK.logger.info(format("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
 
-        # 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 })
+          # 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(format("Could not remove '%{name}' as it is already empty", name: item_name))
+              else
+                PDK.logger.info(format("Could not remove '%{value}' from '%{name}' as it has not been set", value: item_value, name: item_name))
+              end
+              return 0
             end
-            return 0
+            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
-          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 })
+          # 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(format("Cleared '%{name}' which had a value of '%{from}'", name: item_name, from: current_value))
+            else
+              PDK.logger.info(format("Removed '%{value}' from '%{name}'", value: item_value, name: item_name))
+            end
+          elsif !new_value.nil?
+            PDK.logger.info(format("Could not remove '%{name}' as it using a default value of '%{to}'", name: item_name, to: new_value))
           else
-            PDK.logger.info("Removed '%{value}' from '%{name}'" % { value: item_value, name: item_name })
+            PDK.logger.info(format("Removed '%{name}' which had a value of '%{from}'", name: item_name, from: current_value))
           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
+          # Same output as `get config`
+          $stdout.puts format('%{name}=%{value}', name: item_name, value: new_value)
+          0
+        end
       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>'
+    @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
+      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)
+      run do |opts, args, _cmd|
+        exit PDK::CLI::Remove::Config.run(opts, args)
+      end
     end
   end
 end

data/lib/pdk/cli/remove.rb

@@ -1,20 +1,22 @@
-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'
+module PDK
+  module 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
+      run do |_opts, args, _cmd|
+        if args == ['help']
+          PDK::CLI.run(['remove', '--help'])
+          exit 0
+        end
 
-      PDK::CLI.run(%w[remove help]) if args.empty?
+        PDK::CLI.run(['remove', 'help']) if args.empty?
+      end
     end
+    @remove_cmd.add_command Cri::Command.new_basic_help
   end
-  @remove_cmd.add_command Cri::Command.new_basic_help
 end
 
 require 'pdk/cli/remove/config'