pdk-akerl 1.9.1.1 → 1.14.0.1

data/lib/pdk/analytics/client/noop.rb

@@ -0,0 +1,23 @@
+module PDK
+  module Analytics
+    module Client
+      class Noop
+        attr_reader :logger
+
+        def initialize(opts)
+          @logger = opts[:logger]
+        end
+
+        def screen_view(screen, **_kwargs)
+          logger.debug "Skipping submission of '#{screen}' screenview because analytics is disabled"
+        end
+
+        def event(category, action, **_kwargs)
+          logger.debug "Skipping submission of '#{category} #{action}' event because analytics is disabled"
+        end
+
+        def finish; end
+      end
+    end
+  end
+end

data/lib/pdk/analytics/util.rb

@@ -0,0 +1,17 @@
+module PDK
+  module Analytics
+    module Util
+      def self.fetch_os_async
+        require 'concurrent/configuration'
+        require 'concurrent/future'
+
+        Concurrent::Future.execute(executor: :io) do
+          require 'facter'
+          os = Facter.value('os')
+
+          os.nil? ? 'unknown' : "#{os['name']} #{os.fetch('release', {}).fetch('major', '')}".strip
+        end
+      end
+    end
+  end
+end

data/lib/pdk/answer_file.rb

@@ -1,4 +1,3 @@
-require 'json'
 require 'pdk/util/filesystem'
 
 module PDK
@@ -80,6 +79,8 @@ module PDK
     #
     # @return [Hash{String => Object}] The existing questions and answers.
     def read_from_disk
+      require 'json'
+
       return {} if !File.file?(answer_file_path) || File.zero?(answer_file_path)
 
       unless File.readable?(answer_file_path)
@@ -108,6 +109,8 @@ module PDK
     #
     # @raise [PDK::CLI::FatalError] if the answer file can not be written to.
     def save_to_disk
+      require 'json'
+
       FileUtils.mkdir_p(File.dirname(answer_file_path))
 
       write_file(answer_file_path, JSON.pretty_generate(answers))

data/lib/pdk/cli.rb

@@ -1,20 +1,58 @@
 require 'cri'
 
+require 'pdk/analytics'
 require 'pdk/cli/errors'
 require 'pdk/cli/util'
 require 'pdk/cli/util/command_redirector'
 require 'pdk/cli/util/option_normalizer'
 require 'pdk/cli/util/option_validator'
-require 'pdk/cli/exec_group'
-require 'pdk/generate/module'
+require 'pdk/config'
 require 'pdk/i18n'
 require 'pdk/logger'
 require 'pdk/report'
 require 'pdk/util/version'
 require 'pdk/util/puppet_version'
+require 'pdk/util/filesystem'
+
+class Cri::Command::CriExitException
+  def initialize(is_error:)
+    @is_error = is_error
+    PDK.analytics.event('CLI', 'invalid command', label: PDK::CLI.anonymised_args.join(' ')) if error?
+  end
+end
 
 module PDK::CLI
+  # Attempt to anonymise the raw ARGV array if the command parsing failed.
+  #
+  # If an item does not start with '-' but is preceeded by an item that does
+  # start with '-', assume that these items are an option/value pair and redact
+  # the value. Any additional values that do not start with '-' that follow an
+  # option/value pair are assumed to be arguments (rather than subcommand
+  # names) and are also redacted.
+  #
+  # @example
+  #   # Where PDK::CLI.args => ['new', 'plan', '--some', 'value', 'plan_name']
+  #
+  #   PDK::CLI.anonymised_args
+  #     => ['new', 'plan', '--some', 'redacted', 'redacted']
+  #
+  # @return Array[String] the command arguments with any identifying values
+  #   redacted.
+  def self.anonymised_args
+    in_args = false
+    @args.map do |arg|
+      if arg.start_with?('-')
+        in_args = true
+        arg
+      else
+        in_args ? 'redacted' : arg
+      end
+    end
+  end
+
   def self.run(args)
+    @args = args
+    PDK::Config.analytics_config_interview! unless ENV['PDK_DISABLE_ANALYTICS'] || PDK::Config.analytics_config_exist?
     @base_cmd.run(args)
   rescue PDK::CLI::ExitWithError => e
     PDK.logger.send(e.log_level, e.message)
@@ -39,11 +77,17 @@ module PDK::CLI
   end
 
   def self.template_url_option(dsl)
-    desc = _('Specifies the URL to the template to use when creating new modules or classes. (default: %{default_url})') % { default_url: PDK::Util.default_template_url }
+    require 'pdk/util/template_uri'
+
+    desc = _('Specifies the URL to the template to use when creating new modules or classes. (default: %{default_url})') % { default_url: PDK::Util::TemplateURI.default_template_uri }
 
     dsl.option nil, 'template-url', desc, argument: :required
   end
 
+  def self.template_ref_option(dsl)
+    dsl.option nil, 'template-ref', _('Specifies the template git branch or tag to use when creating new modules or classes.'), argument: :required
+  end
+
   def self.skip_interview_option(dsl)
     dsl.option nil, 'skip-interview', _('When specified, skips interactive querying of metadata.')
   end
@@ -96,18 +140,21 @@ module PDK::CLI
     end
 
     option nil, 'answer-file', _('Path to an answer file.'), argument: :required, hidden: true do |value|
+      require 'pdk/answer_file'
       PDK.answer_file = value
     end
   end
 
   require 'pdk/cli/bundle'
   require 'pdk/cli/build'
+  require 'pdk/cli/config'
   require 'pdk/cli/convert'
   require 'pdk/cli/new'
   require 'pdk/cli/test'
   require 'pdk/cli/update'
   require 'pdk/cli/validate'
   require 'pdk/cli/module'
+  require 'pdk/cli/console'
 
   @base_cmd.add_command Cri::Command.new_basic_help
 end

data/lib/pdk/cli/build.rb

@@ -1,5 +1,3 @@
-require 'pdk/cli/util'
-
 module PDK::CLI
   @build_cmd = @base_cmd.define_command do
     name 'build'
@@ -14,6 +12,8 @@ module PDK::CLI
 
     run do |opts, _args, _cmd|
       require 'pdk/module/build'
+      require 'pdk/module/metadata'
+      require 'pdk/cli/util'
 
       # Make sure build is being run in a valid module directory with a metadata.json
       PDK::CLI::Util.ensure_in_module!(
@@ -21,6 +21,8 @@ module PDK::CLI
         log_level: :info,
       )
 
+      PDK::CLI::Util.analytics_screen_view('build', opts)
+
       module_metadata = PDK::Module::Metadata.from_file('metadata.json')
 
       # TODO: Ensure forge metadata has been set, or call out to interview
@@ -28,8 +30,12 @@ module PDK::CLI
       #
       unless module_metadata.forge_ready?
         if opts[:force]
-          PDK.logger.error _('This module is missing required fields in the metadata.json. Re-run the build command without --force to add this information.')
-          exit 1
+          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: module_metadata.missing_fields.join(', '),
+          }
         else
           module_metadata.interview_for_forge!
           module_metadata.write!('metadata.json')

data/lib/pdk/cli/bundle.rb

@@ -1,4 +1,3 @@
-
 module PDK::CLI
   @bundle_cmd = @base_cmd.define_command do
     name 'bundle'
@@ -7,35 +6,38 @@ module PDK::CLI
     description _(<<-EOF
 [experimental] For advanced users, pdk bundle runs arbitrary commands in the bundler environment that pdk manages.
 Careless use of this command can lead to errors that pdk can't help recover from.
-
-Note that for PowerShell the '--' needs to be escaped using a backtick: '`--' to avoid it being parsed by the shell.
 EOF
                  )
     skip_option_parsing
 
     run do |_opts, args, _cmd|
+      require 'pdk/cli/exec/interactive_command'
+      require 'pdk/util/bundler'
+
       PDK::CLI::Util.ensure_in_module!(
         message: _('`pdk bundle` can only be run from inside a valid module directory.'),
       )
 
       PDK::CLI::Util.validate_puppet_version_opts({})
 
-      # Ensure that the correct Ruby is activated before running commend.
+      PDK::CLI::Util.analytics_screen_view('bundle')
+
+      # Ensure that the correct Ruby is activated before running command.
       puppet_env = PDK::CLI::Util.puppet_from_opts_or_env({})
       PDK::Util::RubyVersion.use(puppet_env[:ruby_version])
 
       gemfile_env = PDK::Util::Bundler::BundleHelper.gemfile_env(puppet_env[:gemset])
 
-      command = PDK::CLI::Exec::Command.new(PDK::CLI::Exec.bundle_bin, *args).tap do |c|
+      require 'pdk/cli/exec'
+      require 'pdk/cli/exec/interactive_command'
+
+      command = PDK::CLI::Exec::InteractiveCommand.new(PDK::CLI::Exec.bundle_bin, *args).tap do |c|
         c.context = :pwd
         c.update_environment(gemfile_env)
       end
 
       result = command.execute!
 
-      $stderr.puts result[:stdout]
-      $stderr.puts result[:stderr]
-
       exit result[:exit_code]
     end
   end

data/lib/pdk/cli/config.rb

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

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

@@ -0,0 +1,24 @@
+module PDK::CLI
+  @config_get_cmd = @config_cmd.define_command do
+    name 'get'
+    usage _('config get [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/console.rb

@@ -0,0 +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|
+        Dir.exist?(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