pdk 2.3.0 → 2.4.0

data/lib/pdk/cli/console.rb

@@ -1,148 +1,148 @@
-module PDK::CLI
-  @console_cmd = @base_cmd.define_command do
-    name 'console'
-    usage _('console [console_options]')
-    summary _('(Experimental) Start a session of the puppet debugger console.')
-    default_subcommand 'help'
-    description _(<<-EOF
-The pdk console runs a interactive session of the puppet debugger tool to test out snippets of code, run
-language evaluations, datatype prototyping and much more.  A virtual playground for your puppet code!
-For usage details see the puppet debugger docs at https://docs.puppet-debugger.com.
-
-EOF
-                 )
-    PDK::CLI.puppet_version_options(self)
-    PDK::CLI.puppet_dev_option(self)
-    # we have to skip option parsing because it is expected the user
-    # will be passing additional args that are passed to the debugger
-    skip_option_parsing
-
-    # TODO: using -h or --help skips the pdk help and passes to puppet debugger help
-    run do |_opts, args, _cmd|
-      require 'pdk/cli/util'
-      require 'pdk/util'
-
-      PDK::CLI::Util.ensure_in_module!(
-        message: _('Console can only be run from inside a valid module directory'),
-        log_level: :fatal,
-      )
-
-      PDK::CLI::Util.module_version_check
-
-      processed_options, processed_args = process_opts(args)
-
-      PDK::CLI::Util.validate_puppet_version_opts(processed_options)
-
-      PDK::CLI::Util.analytics_screen_view('console', args)
-
-      # TODO: figure out if we need to remove default configs set by puppet
-      # so it is scoped for the module only
-      # "--environmentpath"...
-      flags = if PDK::Util.in_module_root?
-                ["--basemodulepath=#{base_module_path}",
-                 "--modulepath=#{base_module_path}"]
-              else
-                []
-              end
-      debugger_args = ['debugger'] + processed_args + flags
-      result = run_in_module(processed_options, debugger_args)
-
-      exit result[:exit_code]
-    end
-
-    # Logs a fatal message about the gem missing and how to add it
-    def inform_user_for_missing_gem(gem_name = 'puppet-debugger', version = '~> 0.14')
-      PDK.logger.fatal(<<-EOF
-Your Gemfile is missing the #{gem_name} gem.  You can add the missing gem
-by updating your #{File.join(PDK::Util.module_root, '.sync.yml')} file with the following
-and running pdk update.
-
-Gemfile:
-  required:
-    ":development":
-      - gem: #{gem_name}
-        version: \"#{version}\"
-
-EOF
-                      )
-    end
-
-    # @return [Boolean] - true if the gem was found in the lockfile
-    # @param [String] - name of ruby gem to check in bundle lockfile
-    def gem_in_bundle_lockfile?(gem_name)
-      require 'bundler'
-      require 'pdk/util/bundler'
-
-      lock_file_path = PDK::Util::Bundler::BundleHelper.new.gemfile_lock
-      PDK.logger.debug("Checking lockfile #{lock_file_path} for #{gem_name}")
-      lock_file = ::Bundler::LockfileParser.new(::Bundler.read_file(lock_file_path))
-      !lock_file.specs.find { |spec| spec.name.eql?(gem_name) }.nil?
-    rescue ::Bundler::GemfileNotFound => e
-      PDK.logger.debug _(e.message)
-      false
-    end
-
-    def check_fixtures_dir
-      existing_path = base_module_path.split(':').find do |path|
-        PDK::Util::Filesystem.directory?(path) && Dir.entries(path).length > 2
-      end
-      PDK.logger.warn _('Module fixtures not found, please run pdk bundle exec rake spec_prep.') unless existing_path
-    end
-
-    # @return [Array] - array of split options [{:"puppet-version"=>"6.9.0"}, ['--loglevel=debug']]
-    # options are for the pdk and debugger pass through
-    def process_opts(opts)
-      args = opts.map do |e|
-        if e =~ %r{\A-{2}puppet|pe\-version|dev}
-          value = e.split('=')
-          (value.count < 2) ? value + [''] : value
-        end
-      end
-      args = args.compact.to_h
-      # symbolize keys
-      args = args.inject({}) do |memo, (k, v)| # rubocop:disable Style/EachWithObject
-        memo[k.sub('--', '').to_sym] = v
-        memo
-      end
-      # pass through all other args that are bound for puppet debugger
-      processed_args = opts.map { |e| e unless e =~ %r{\A-{2}puppet|pe\-version|dev} }.compact
-      [args, processed_args]
-    end
-
-    # @param opts [Hash] - the options passed into the CRI command
-    # @param bundle_args [Array] array of bundle exec args and puppet debugger args
-    # @return [Hash] - a command result hash
-    def run_in_module(opts, bundle_args)
-      require 'pdk/cli/exec'
-      require 'pdk/cli/exec/interactive_command'
-      require 'pdk/util/ruby_version'
-      require 'pdk/util/bundler'
-
-      check_fixtures_dir
-      output = opts[:debug].nil?
-      puppet_env = PDK::CLI::Util.puppet_from_opts_or_env(opts, output)
-      gemfile_env = PDK::Util::Bundler::BundleHelper.gemfile_env(puppet_env[:gemset])
-      PDK::Util::RubyVersion.use(puppet_env[:ruby_version])
-      PDK::Util::RubyVersion.instance(puppet_env[:ruby_version])
-      PDK::Util::Bundler.ensure_bundle!(puppet_env[:gemset])
-      unless gem_in_bundle_lockfile?('puppet-debugger')
-        inform_user_for_missing_gem
-        return { exit_code: 1 }
-      end
-
-      debugger_args = %w[exec puppet] + bundle_args
-      command = PDK::CLI::Exec::InteractiveCommand.new(PDK::CLI::Exec.bundle_bin, *debugger_args).tap do |c|
-        c.context = :pwd
-        c.update_environment(gemfile_env)
-      end
-      command.execute!
-    end
-
-    # @return [String] - the basemodulepath of the fixtures and modules from the current module
-    # also includes ./modules in case librarian puppet is used
-    def base_module_path
-      base_module_path = File.join(PDK::Util.module_fixtures_dir, 'modules')
-      "#{base_module_path}:#{File.join(PDK::Util.module_root, 'modules')}"
-    end
-  end
-end
+module PDK::CLI
+  @console_cmd = @base_cmd.define_command do
+    name 'console'
+    usage _('console [console_options]')
+    summary _('(Experimental) Start a session of the puppet debugger console.')
+    default_subcommand 'help'
+    description _(<<-EOF
+The pdk console runs a interactive session of the puppet debugger tool to test out snippets of code, run
+language evaluations, datatype prototyping and much more.  A virtual playground for your puppet code!
+For usage details see the puppet debugger docs at https://docs.puppet-debugger.com.
+
+EOF
+                 )
+    PDK::CLI.puppet_version_options(self)
+    PDK::CLI.puppet_dev_option(self)
+    # we have to skip option parsing because it is expected the user
+    # will be passing additional args that are passed to the debugger
+    skip_option_parsing
+
+    # TODO: using -h or --help skips the pdk help and passes to puppet debugger help
+    run do |_opts, args, _cmd|
+      require 'pdk/cli/util'
+      require 'pdk/util'
+
+      PDK::CLI::Util.ensure_in_module!(
+        message: _('Console can only be run from inside a valid module directory'),
+        log_level: :fatal,
+      )
+
+      PDK::CLI::Util.module_version_check
+
+      processed_options, processed_args = process_opts(args)
+
+      PDK::CLI::Util.validate_puppet_version_opts(processed_options)
+
+      PDK::CLI::Util.analytics_screen_view('console', args)
+
+      # TODO: figure out if we need to remove default configs set by puppet
+      # so it is scoped for the module only
+      # "--environmentpath"...
+      flags = if PDK::Util.in_module_root?
+                ["--basemodulepath=#{base_module_path}",
+                 "--modulepath=#{base_module_path}"]
+              else
+                []
+              end
+      debugger_args = ['debugger'] + processed_args + flags
+      result = run_in_module(processed_options, debugger_args)
+
+      exit result[:exit_code]
+    end
+
+    # Logs a fatal message about the gem missing and how to add it
+    def inform_user_for_missing_gem(gem_name = 'puppet-debugger', version = '~> 0.14')
+      PDK.logger.fatal(<<-EOF
+Your Gemfile is missing the #{gem_name} gem.  You can add the missing gem
+by updating your #{File.join(PDK::Util.module_root, '.sync.yml')} file with the following
+and running pdk update.
+
+Gemfile:
+  required:
+    ":development":
+      - gem: #{gem_name}
+        version: \"#{version}\"
+
+EOF
+                      )
+    end
+
+    # @return [Boolean] - true if the gem was found in the lockfile
+    # @param [String] - name of ruby gem to check in bundle lockfile
+    def gem_in_bundle_lockfile?(gem_name)
+      require 'bundler'
+      require 'pdk/util/bundler'
+
+      lock_file_path = PDK::Util::Bundler::BundleHelper.new.gemfile_lock
+      PDK.logger.debug("Checking lockfile #{lock_file_path} for #{gem_name}")
+      lock_file = ::Bundler::LockfileParser.new(::Bundler.read_file(lock_file_path))
+      !lock_file.specs.find { |spec| spec.name.eql?(gem_name) }.nil?
+    rescue ::Bundler::GemfileNotFound => e
+      PDK.logger.debug _(e.message)
+      false
+    end
+
+    def check_fixtures_dir
+      existing_path = base_module_path.split(':').find do |path|
+        PDK::Util::Filesystem.directory?(path) && Dir.entries(path).length > 2
+      end
+      PDK.logger.warn _('Module fixtures not found, please run pdk bundle exec rake spec_prep.') unless existing_path
+    end
+
+    # @return [Array] - array of split options [{:"puppet-version"=>"6.9.0"}, ['--loglevel=debug']]
+    # options are for the pdk and debugger pass through
+    def process_opts(opts)
+      args = opts.map do |e|
+        if e =~ %r{\A-{2}puppet|pe\-version|dev}
+          value = e.split('=')
+          (value.count < 2) ? value + [''] : value
+        end
+      end
+      args = args.compact.to_h
+      # symbolize keys
+      args = args.inject({}) do |memo, (k, v)| # rubocop:disable Style/EachWithObject
+        memo[k.sub('--', '').to_sym] = v
+        memo
+      end
+      # pass through all other args that are bound for puppet debugger
+      processed_args = opts.map { |e| e unless e =~ %r{\A-{2}puppet|pe\-version|dev} }.compact
+      [args, processed_args]
+    end
+
+    # @param opts [Hash] - the options passed into the CRI command
+    # @param bundle_args [Array] array of bundle exec args and puppet debugger args
+    # @return [Hash] - a command result hash
+    def run_in_module(opts, bundle_args)
+      require 'pdk/cli/exec'
+      require 'pdk/cli/exec/interactive_command'
+      require 'pdk/util/ruby_version'
+      require 'pdk/util/bundler'
+
+      check_fixtures_dir
+      output = opts[:debug].nil?
+      puppet_env = PDK::CLI::Util.puppet_from_opts_or_env(opts, output)
+      gemfile_env = PDK::Util::Bundler::BundleHelper.gemfile_env(puppet_env[:gemset])
+      PDK::Util::RubyVersion.use(puppet_env[:ruby_version])
+      PDK::Util::RubyVersion.instance(puppet_env[:ruby_version])
+      PDK::Util::Bundler.ensure_bundle!(puppet_env[:gemset])
+      unless gem_in_bundle_lockfile?('puppet-debugger')
+        inform_user_for_missing_gem
+        return { exit_code: 1 }
+      end
+
+      debugger_args = %w[exec puppet] + bundle_args
+      command = PDK::CLI::Exec::InteractiveCommand.new(PDK::CLI::Exec.bundle_bin, *debugger_args).tap do |c|
+        c.context = :pwd
+        c.update_environment(gemfile_env)
+      end
+      command.execute!
+    end
+
+    # @return [String] - the basemodulepath of the fixtures and modules from the current module
+    # also includes ./modules in case librarian puppet is used
+    def base_module_path
+      base_module_path = File.join(PDK::Util.module_fixtures_dir, 'modules')
+      "#{base_module_path}:#{File.join(PDK::Util.module_root, 'modules')}"
+    end
+  end
+end

data/lib/pdk/cli/convert.rb

@@ -1,52 +1,52 @@
-module PDK::CLI
-  @convert_cmd = @base_cmd.define_command do
-    name 'convert'
-    usage _('convert [options]')
-    summary _('Convert an existing module to be compatible with the PDK.')
-
-    PDK::CLI.template_url_option(self)
-    PDK::CLI.template_ref_option(self)
-    PDK::CLI.skip_interview_option(self)
-    PDK::CLI.full_interview_option(self)
-    flag nil, :noop, _('Do not convert the module, just output what would be done.')
-    flag nil, :force, _('Convert the module automatically, with no prompts.')
-    flag nil, :'add-tests', _('Add any missing tests while converting the module.')
-    flag nil, :'default-template', _('Convert the module to use the default PDK template.')
-
-    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 convert` can only be run from inside a valid module directory.')
-      end
-
-      if opts[:noop] && opts[:force]
-        raise PDK::CLI::ExitWithError, _('You can not specify --noop and --force when converting a module')
-      end
-
-      if opts[:'default-template']
-        raise PDK::CLI::ExitWithError, _('You can not specify --template-url and --default-template.') if opts[:'template-url']
-
-        opts[:'template-url'] = PDK::Util::TemplateURI.default_template_addressable_uri.to_s
-        PDK.config.set(%w[user module_defaults template-url], nil)
-      end
-
-      PDK::CLI::Util.validate_template_opts(opts)
-
-      PDK::CLI::Util.analytics_screen_view('convert', opts)
-
-      if opts[:'skip-interview'] && opts[:'full-interview']
-        PDK.logger.info _('Ignoring --full-interview and continuing with --skip-interview.')
-        opts[:'full-interview'] = false
-      end
-
-      if opts[:force] && opts[:'full-interview']
-        PDK.logger.info _('Ignoring --full-interview and continuing with --force.')
-        opts[:'full-interview'] = false
-      end
-
-      PDK::Module::Convert.invoke(PDK.context.root_path, opts)
-    end
-  end
-end
+module PDK::CLI
+  @convert_cmd = @base_cmd.define_command do
+    name 'convert'
+    usage _('convert [options]')
+    summary _('Convert an existing module to be compatible with the PDK.')
+
+    PDK::CLI.template_url_option(self)
+    PDK::CLI.template_ref_option(self)
+    PDK::CLI.skip_interview_option(self)
+    PDK::CLI.full_interview_option(self)
+    flag nil, :noop, _('Do not convert the module, just output what would be done.')
+    flag nil, :force, _('Convert the module automatically, with no prompts.')
+    flag nil, :'add-tests', _('Add any missing tests while converting the module.')
+    flag nil, :'default-template', _('Convert the module to use the default PDK template.')
+
+    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 convert` can only be run from inside a valid module directory.')
+      end
+
+      if opts[:noop] && opts[:force]
+        raise PDK::CLI::ExitWithError, _('You can not specify --noop and --force when converting a module')
+      end
+
+      if opts[:'default-template']
+        raise PDK::CLI::ExitWithError, _('You can not specify --template-url and --default-template.') if opts[:'template-url']
+
+        opts[:'template-url'] = PDK::Util::TemplateURI.default_template_addressable_uri.to_s
+        PDK.config.set(%w[user module_defaults template-url], nil)
+      end
+
+      PDK::CLI::Util.validate_template_opts(opts)
+
+      PDK::CLI::Util.analytics_screen_view('convert', opts)
+
+      if opts[:'skip-interview'] && opts[:'full-interview']
+        PDK.logger.info _('Ignoring --full-interview and continuing with --skip-interview.')
+        opts[:'full-interview'] = false
+      end
+
+      if opts[:force] && opts[:'full-interview']
+        PDK.logger.info _('Ignoring --full-interview and continuing with --force.')
+        opts[:'full-interview'] = false
+      end
+
+      PDK::Module::Convert.invoke(PDK.context.root_path, opts)
+    end
+  end
+end

data/lib/pdk/cli/env.rb

@@ -1,52 +1,52 @@
-module PDK::CLI
-  @env_cmd = @base_cmd.define_command do
-    name 'env'
-    usage _('env')
-    summary _('(Experimental) Output environment variables for specific Puppet context')
-    description _(<<-EOF
-[experimental] Aids in setting a CLI context for a specified version of Puppet by outputting export commands for necessary environment variables.
-EOF
-                 )
-
-    PDK::CLI.puppet_version_options(self)
-    PDK::CLI.puppet_dev_option(self)
-
-    run do |opts, _args, _cmd|
-      require 'pdk/util'
-      require 'pdk/util/ruby_version'
-
-      PDK::CLI::Util.validate_puppet_version_opts(opts)
-
-      PDK::CLI::Util.analytics_screen_view('env')
-
-      # Ensure that the correct Ruby is activated before running command.
-      puppet_env = PDK::CLI::Util.puppet_from_opts_or_env(opts)
-      PDK::Util::RubyVersion.use(puppet_env[:ruby_version])
-
-      resolved_env = {
-        'PDK_RESOLVED_PUPPET_VERSION' => puppet_env[:gemset][:puppet],
-        'PDK_RESOLVED_RUBY_VERSION' => puppet_env[:ruby_version],
-      }
-
-      resolved_env['GEM_HOME'] = PDK::Util::RubyVersion.gem_home
-      gem_path = PDK::Util::RubyVersion.gem_path
-      resolved_env['GEM_PATH'] = gem_path.empty? ? resolved_env['GEM_HOME'] : gem_path
-
-      # Make sure invocation of Ruby prefers our private installation.
-      package_binpath = PDK::Util.package_install? ? File.join(PDK::Util.pdk_package_basedir, 'bin') : nil
-
-      resolved_env['PATH'] = [
-        PDK::Util::RubyVersion.bin_path,
-        File.join(resolved_env['GEM_HOME'], 'bin'),
-        PDK::Util::RubyVersion.gem_paths_raw.map { |gem_path_raw| File.join(gem_path_raw, 'bin') },
-        package_binpath,
-        PDK::Util::Env['PATH'],
-      ].compact.flatten.join(File::PATH_SEPARATOR)
-
-      resolved_env.each do |var, val|
-        puts "export #{var}=\"#{val}\""
-      end
-      exit 0
-    end
-  end
-end
+module PDK::CLI
+  @env_cmd = @base_cmd.define_command do
+    name 'env'
+    usage _('env')
+    summary _('(Experimental) Output environment variables for specific Puppet context')
+    description _(<<-EOF
+[experimental] Aids in setting a CLI context for a specified version of Puppet by outputting export commands for necessary environment variables.
+EOF
+                 )
+
+    PDK::CLI.puppet_version_options(self)
+    PDK::CLI.puppet_dev_option(self)
+
+    run do |opts, _args, _cmd|
+      require 'pdk/util'
+      require 'pdk/util/ruby_version'
+
+      PDK::CLI::Util.validate_puppet_version_opts(opts)
+
+      PDK::CLI::Util.analytics_screen_view('env')
+
+      # Ensure that the correct Ruby is activated before running command.
+      puppet_env = PDK::CLI::Util.puppet_from_opts_or_env(opts)
+      PDK::Util::RubyVersion.use(puppet_env[:ruby_version])
+
+      resolved_env = {
+        'PDK_RESOLVED_PUPPET_VERSION' => puppet_env[:gemset][:puppet],
+        'PDK_RESOLVED_RUBY_VERSION' => puppet_env[:ruby_version],
+      }
+
+      resolved_env['GEM_HOME'] = PDK::Util::RubyVersion.gem_home
+      gem_path = PDK::Util::RubyVersion.gem_path
+      resolved_env['GEM_PATH'] = gem_path.empty? ? resolved_env['GEM_HOME'] : gem_path
+
+      # Make sure invocation of Ruby prefers our private installation.
+      package_binpath = PDK::Util.package_install? ? File.join(PDK::Util.pdk_package_basedir, 'bin') : nil
+
+      resolved_env['PATH'] = [
+        PDK::Util::RubyVersion.bin_path,
+        File.join(resolved_env['GEM_HOME'], 'bin'),
+        PDK::Util::RubyVersion.gem_paths_raw.map { |gem_path_raw| File.join(gem_path_raw, 'bin') },
+        package_binpath,
+        PDK::Util::Env['PATH'],
+      ].compact.flatten.join(File::PATH_SEPARATOR)
+
+      resolved_env.each do |var, val|
+        puts "export #{var}=\"#{val}\""
+      end
+      exit 0
+    end
+  end
+end

data/lib/pdk/cli/errors.rb

@@ -1,25 +1,25 @@
-require 'pdk'
-
-module PDK
-  module CLI
-    class FatalError < StandardError
-      attr_reader :exit_code
-
-      def initialize(msg = _('An unexpected error has occurred. Try running the command again with --debug'), opts = {})
-        @exit_code = opts.fetch(:exit_code, 1)
-        super(msg)
-      end
-    end
-
-    class ExitWithError < StandardError
-      attr_reader :exit_code
-      attr_reader :log_level
-
-      def initialize(msg, opts = {})
-        @exit_code = opts.fetch(:exit_code, 1)
-        @log_level = opts.fetch(:log_level, :error)
-        super(msg)
-      end
-    end
-  end
-end
+require 'pdk'
+
+module PDK
+  module CLI
+    class FatalError < StandardError
+      attr_reader :exit_code
+
+      def initialize(msg = _('An unexpected error has occurred. Try running the command again with --debug'), opts = {})
+        @exit_code = opts.fetch(:exit_code, 1)
+        super(msg)
+      end
+    end
+
+    class ExitWithError < StandardError
+      attr_reader :exit_code
+      attr_reader :log_level
+
+      def initialize(msg, opts = {})
+        @exit_code = opts.fetch(:exit_code, 1)
+        @log_level = opts.fetch(:log_level, :error)
+        super(msg)
+      end
+    end
+  end
+end