bolt 2.28.0 → 2.33.1

data/lib/bolt/catalog.rb

@@ -97,7 +97,7 @@ module Bolt
       }
 
       with_puppet_settings(puppet_settings) do
-        Puppet::Pal.in_tmp_environment('bolt_catalog', env_conf) do |pal|
+        Puppet::Pal.in_tmp_environment('bolt_catalog', **env_conf) do |pal|
           Puppet.override(puppet_overrides) do
             Puppet.lookup(:pal_current_node).trusted_data = target['trusted']
             pal.with_catalog_compiler do |compiler|

data/lib/bolt/cli.rb

@@ -20,28 +20,31 @@ require 'bolt/logger'
 require 'bolt/outputter'
 require 'bolt/puppetdb'
 require 'bolt/plugin'
-require 'bolt/project_migrate'
+require 'bolt/project_migrator'
 require 'bolt/pal'
 require 'bolt/target'
 require 'bolt/version'
 require 'bolt/secret'
+require 'bolt/module_installer'
 
 module Bolt
   class CLIExit < StandardError; end
   class CLI
-    COMMANDS = { 'command' => %w[run],
-                 'script' => %w[run],
-                 'task' => %w[show run],
-                 'plan' => %w[show run convert new],
-                 'file' => %w[download upload],
-                 'puppetfile' => %w[install show-modules generate-types],
-                 'secret' => %w[encrypt decrypt createkeys],
-                 'inventory' => %w[show],
-                 'group' => %w[show],
-                 'project' => %w[init migrate],
-                 'apply' => %w[],
-                 'guide' => %w[],
-                 'module' => %w[install show generate-types] }.freeze
+    COMMANDS = {
+      'command'    => %w[run],
+      'script'     => %w[run],
+      'task'       => %w[show run],
+      'plan'       => %w[show run convert new],
+      'file'       => %w[download upload],
+      'puppetfile' => %w[install show-modules generate-types],
+      'secret'     => %w[encrypt decrypt createkeys],
+      'inventory'  => %w[show],
+      'group'      => %w[show],
+      'project'    => %w[init migrate],
+      'module'     => %w[add generate-types install show],
+      'apply'      => %w[],
+      'guide'      => %w[]
+    }.freeze
 
     attr_reader :config, :options
 
@@ -99,6 +102,10 @@ module Bolt
       # This part aims to handle both `bolt <mode> --help` and `bolt help <mode>`.
       remaining = handle_parser_errors { parser.permute(@argv) } unless @argv.empty?
       if @argv.empty? || help?(remaining)
+        # If the subcommand is not enabled, display the default
+        # help text
+        options[:subcommand] = nil unless COMMANDS.include?(options[:subcommand])
+
         # Update the parser for the subcommand (or lack thereof)
         parser.update
         puts parser.help
@@ -107,6 +114,11 @@ module Bolt
 
       options[:object] = remaining.shift
 
+      # Handle reading a command from a file
+      if options[:subcommand] == 'command' && options[:object]
+        options[:object] = Bolt::Util.get_arg_input(options[:object])
+      end
+
       # Only parse task_options for task or plan
       if %w[task plan].include?(options[:subcommand])
         task_options, remaining = remaining.partition { |s| s =~ /.+=/ }
@@ -184,6 +196,10 @@ module Bolt
 
       warn_inventory_overrides_cli(options)
 
+      # Assert whether the puppetfile/module commands are available depending
+      # on whether 'modules' is configured.
+      assert_puppetfile_or_module_command(config.project.modules)
+
       options
     rescue Bolt::Error => e
       outputter.fatal_error(e)
@@ -211,14 +227,10 @@ module Bolt
     end
 
     def validate(options)
-      # Disables the 'module' subcommand unless the module feature flag is set.
-      commands = COMMANDS.dup
-      commands.delete('module') unless ENV['BOLT_MODULE_FEATURE']
-
-      unless commands.include?(options[:subcommand])
+      unless COMMANDS.include?(options[:subcommand])
         raise Bolt::CLIError,
               "Expected subcommand '#{options[:subcommand]}' to be one of " \
-              "#{commands.keys.join(', ')}"
+              "#{COMMANDS.keys.join(', ')}"
       end
 
       actions = COMMANDS[options[:subcommand]]
@@ -235,12 +247,6 @@ module Bolt
         end
       end
 
-      if options[:subcommand] != 'file' && options[:subcommand] != 'script' &&
-         !options[:leftovers].empty?
-        raise Bolt::CLIError,
-              "Unknown argument(s) #{options[:leftovers].join(', ')}"
-      end
-
       if %w[task plan].include?(options[:subcommand]) && options[:action] == 'run'
         if options[:object].nil?
           raise Bolt::CLIError, "Must specify a #{options[:subcommand]} to run"
@@ -252,23 +258,6 @@ module Bolt
         end
       end
 
-      if options[:boltdir] && options[:configfile]
-        raise Bolt::CLIError, "Only one of '--boltdir', '--project', or '--configfile' may be specified"
-      end
-
-      if options[:noop] &&
-         !(options[:subcommand] == 'task' && options[:action] == 'run') && options[:subcommand] != 'apply'
-        raise Bolt::CLIError,
-              "Option '--noop' may only be specified when running a task or applying manifest code"
-      end
-
-      if options[:env_vars]
-        unless %w[command script].include?(options[:subcommand]) && options[:action] == 'run'
-          raise Bolt::CLIError,
-                "Option '--env-var' may only be specified when running a command or script"
-        end
-      end
-
       if options[:subcommand] == 'apply' && (options[:object] && options[:code])
         raise Bolt::CLIError, "--execute is unsupported when specifying a manifest file"
       end
@@ -291,6 +280,38 @@ module Bolt
         raise Bolt::CLIError, "Must specify a plan name."
       end
 
+      if options[:subcommand] == 'module' && options[:action] == 'add' && !options[:object]
+        raise Bolt::CLIError, "Must specify a module name."
+      end
+
+      if options[:subcommand] == 'module' && options[:action] == 'install' && options[:object]
+        raise Bolt::CLIError, "Invalid argument '#{options[:object]}'. To add a new module to "\
+                              "the project, run 'bolt module add #{options[:object]}'."
+      end
+
+      if options[:subcommand] != 'file' && options[:subcommand] != 'script' &&
+         !options[:leftovers].empty?
+        raise Bolt::CLIError,
+              "Unknown argument(s) #{options[:leftovers].join(', ')}"
+      end
+
+      if options[:boltdir] && options[:configfile]
+        raise Bolt::CLIError, "Only one of '--boltdir', '--project', or '--configfile' may be specified"
+      end
+
+      if options[:noop] &&
+         !(options[:subcommand] == 'task' && options[:action] == 'run') && options[:subcommand] != 'apply'
+        raise Bolt::CLIError,
+              "Option '--noop' may only be specified when running a task or applying manifest code"
+      end
+
+      if options[:env_vars]
+        unless %w[command script].include?(options[:subcommand]) && options[:action] == 'run'
+          raise Bolt::CLIError,
+                "Option '--env-var' may only be specified when running a command or script"
+        end
+      end
+
       if options.key?(:debug) && options.key?(:log)
         raise Bolt::CLIError, "Only one of '--debug' or '--log-level' may be specified"
       end
@@ -384,7 +405,7 @@ module Bolt
                                   inventory_version: inventory.version)
       end
 
-      analytics.screen_view(screen, screen_view_fields)
+      analytics.screen_view(screen, **screen_view_fields)
 
       case options[:action]
       when 'show'
@@ -439,9 +460,7 @@ module Bolt
         when 'init'
           code = initialize_project
         when 'migrate'
-          inv = config.inventoryfile
-          path = config.project.path
-          code = Bolt::ProjectMigrate.new(path, outputter, inv).migrate_project
+          code = Bolt::ProjectMigrator.new(config, outputter).migrate
         end
       when 'plan'
         case options[:action]
@@ -452,8 +471,10 @@ module Bolt
         end
       when 'module'
         case options[:action]
+        when 'add'
+          code = add_project_module(options[:object], config.project)
         when 'install'
-          code = install_project_modules
+          code = install_project_modules(config.project, options[:force], options[:resolve])
         when 'generate-types'
           code = generate_types
         end
@@ -462,7 +483,11 @@ module Bolt
         when 'generate-types'
           code = generate_types
         when 'install'
-          code = install_puppetfile(config.puppetfile_config, config.puppetfile, config.modulepath.first)
+          code = install_puppetfile(
+            config.puppetfile_config,
+            config.puppetfile,
+            config.modulepath.first
+          )
         end
       when 'secret'
         code = Bolt::Secret.execute(plugins, outputter, options)
@@ -562,8 +587,24 @@ module Bolt
     end
 
     def list_targets
+      inventoryfile = config.inventoryfile || config.default_inventoryfile
+
+      # Retrieve the known group and target names. This needs to be done before
+      # updating targets, as that will add adhoc targets to the inventory.
+      known_names = inventory.target_names
+
       update_targets(options)
-      outputter.print_targets(options[:targets])
+
+      inventory_targets, adhoc_targets = options[:targets].partition do |target|
+        known_names.include?(target.name)
+      end
+
+      target_list = {
+        inventory: inventory_targets,
+        adhoc:     adhoc_targets
+      }
+
+      outputter.print_targets(target_list, inventoryfile)
     end
 
     def show_targets
@@ -592,10 +633,10 @@ module Bolt
         message = <<~MESSAGE.chomp
           Invalid plan name '#{plan_name}'. Plan names are composed of one or more name segments
           separated by double colons '::'.
-          
+
           Each name segment must begin with a lowercase letter, and may only include lowercase
           letters, digits, and underscores.
-          
+
           Examples of valid plan names:
               - #{config.project.name}
               - #{config.project.name}::my_plan
@@ -837,7 +878,8 @@ module Bolt
                 "project with modules."
         end
 
-        install_modules(puppetfile, {}, moduledir, options[:modules])
+        installer = Bolt::ModuleInstaller.new(outputter, pal)
+        installer.install(options[:modules], puppetfile, moduledir)
       end
 
       # If either bolt.yaml or bolt-project.yaml exist, the user has already
@@ -858,81 +900,86 @@ module Bolt
 
     # Installs modules declared in the project configuration file.
     #
-    def install_project_modules
-      if config.project.modules.nil?
-        outputter.print_message "Project configuration file '#{config.project.project_file}' "\
-                                "does not specify any module dependencies. Nothing to do."
+    def install_project_modules(project, force, resolve)
+      assert_project_file(project)
+
+      unless project.modules
+        outputter.print_message "Project configuration file #{project.project_file} does not "\
+                                "specify any module dependencies. Nothing to do."
         return 0
       end
 
-      install_modules(
-        config.puppetfile,
-        config.puppetfile_config,
-        config.project.path + '.modules',
-        config.project.modules
-      )
+      installer = Bolt::ModuleInstaller.new(outputter, pal)
+
+      ok = installer.install(project.modules,
+                             project.puppetfile,
+                             project.managed_moduledir,
+                             force: force,
+                             resolve: resolve)
+      ok ? 0 : 1
     end
 
-    # Installs modules declared in the project configuration file.
+    # Adds a single module to the project.
     #
-    def install_modules(puppetfile_path, config, moduledir, modules)
-      require 'bolt/puppetfile'
-      require 'bolt/puppetfile/installer'
-
-      puppetfile = Bolt::Puppetfile.new(modules)
-
-      # If the Puppetfile exists, check if it includes specs for each declared
-      # module, erroring if there are any missing. Otherwise, resolve the
-      # module dependencies and write a new Puppetfile. Users can forcibly
-      # overwrite an existing Puppetfile with the '--force' option.
-      if puppetfile_path.exist? && !options[:force]
-        outputter.print_message "Parsing existing Puppetfile at #{puppetfile_path}"
-        existing = Bolt::Puppetfile.parse(puppetfile_path)
-
-        unless existing.modules.superset? puppetfile.modules
-          missing_modules = puppetfile.modules - existing.modules
-
-          raise Bolt::Error.new(
-            "Puppetfile #{puppetfile_path} is missing specifications for modules: "\
-            "#{missing_modules.map(&:title).join(', ')}. This may not be a Puppetfile "\
-            "managed by Bolt. To forcibly overwrite the Puppetfile, run with the "\
-            "'--force' option.",
-            'bolt/missing-module-specs'
-          )
-        end
-      else
-        outputter.print_message "Resolving module dependencies, this may take a moment"
-        puppetfile.resolve
-        outputter.print_message "Writing Puppetfile at #{puppetfile_path}"
-        puppetfile.write(puppetfile_path, force: true)
-      end
-
-      outputter.print_message "Syncing modules from #{puppetfile_path} to #{moduledir}"
-      ok = Bolt::Puppetfile::Installer.new(config).install(puppetfile_path, moduledir)
+    def add_project_module(name, project)
+      assert_project_file(project)
 
-      # Automatically generate types after installing modules.
-      pal.generate_types
+      modules   = project.modules || []
+      installer = Bolt::ModuleInstaller.new(outputter, pal)
 
-      outputter.print_puppetfile_result(ok, puppetfile_path, moduledir)
+      ok = installer.add(name,
+                         modules,
+                         project.puppetfile,
+                         project.managed_moduledir,
+                         project.project_file)
       ok ? 0 : 1
     end
 
-    # Loads a Puppetfile and installs its modules.
+    # Asserts that there is a project configuration file.
     #
-    def install_puppetfile(config, puppetfile, moduledir)
-      require 'bolt/puppetfile/installer'
-
-      ok = Bolt::Puppetfile::Installer.new(config).install(puppetfile, moduledir)
+    def assert_project_file(project)
+      unless project.project_file?
+        msg = if project.config_file.exist?
+                "Detected Bolt configuration file #{project.config_file}, unable to install "\
+                "modules. To update to a project configuration file, run 'bolt project migrate'."
+              else
+                "Could not find project configuration file #{project.project_file}, unable "\
+                "to install modules. To create a Bolt project, run 'bolt project init'."
+              end
 
-      # Automatically generate types after installing modules.
-      pal.generate_types
+        raise Bolt::Error.new(msg, 'bolt/missing-project-config-error')
+      end
+    end
 
-      outputter.print_puppetfile_result(ok, puppetfile, moduledir)
+    # Loads a Puppetfile and installs its modules.
+    #
+    def install_puppetfile(config, puppetfile, moduledir)
+      outputter.print_message("Installing modules from Puppetfile")
+      installer = Bolt::ModuleInstaller.new(outputter, pal)
+      ok = installer.install_puppetfile(puppetfile, moduledir, config)
       ok ? 0 : 1
     end
 
+    # Raises an error if the 'puppetfile install' command is deprecated due to
+    # modules being configured.
+    #
+    def assert_puppetfile_or_module_command(modules)
+      if modules && options[:subcommand] == 'puppetfile'
+        raise Bolt::CLIError,
+              "Unable to use command 'bolt puppetfile #{options[:action]}' when "\
+              "'modules' is configured in bolt-project.yaml. Use the 'module' command "\
+              "instead. For a list of available actions for the 'module' command, run "\
+              "'bolt module --help'."
+      elsif modules.nil? && options[:subcommand] == 'module'
+        raise Bolt::CLIError,
+              "Unable to use command 'bolt module #{options[:action]}'. To use "\
+              "this command, update your project configuration to manage module "\
+              "dependencies."
+      end
+    end
+
     def pal
-      @pal ||= Bolt::PAL.new(config.modulepath,
+      @pal ||= Bolt::PAL.new(Bolt::Config::Modulepath.new(config.modulepath),
                              config.hiera_config,
                              config.project.resource_types,
                              config.compile_concurrency,
@@ -1031,7 +1078,7 @@ module Bolt
                   'Task' => [],
                   'Plugin' => Bolt::Plugin::BUILTIN_PLUGINS }
       if %w[plan task].include?(options[:subcommand]) && options[:action] == 'run'
-        default_content = Bolt::PAL.new([], nil, nil)
+        default_content = Bolt::PAL.new(Bolt::Config::Modulepath.new([]), nil, nil)
         content['Plan'] = default_content.list_plans.each_with_object([]) do |iter, col|
           col << iter&.first
         end
@@ -1046,7 +1093,7 @@ module Bolt
     # Gem installs include the aggregate, canary, and puppetdb_fact modules, while
     # package installs include modules listed in the Bolt repo Puppetfile
     def incomplete_install?
-      (Dir.children(Bolt::PAL::MODULES_PATH) - %w[aggregate canary puppetdb_fact secure_env_vars]).empty?
+      (Dir.children(Bolt::Config::Modulepath::MODULES_PATH) - %w[aggregate canary puppetdb_fact secure_env_vars]).empty?
     end
 
     # Mimicks the output from Outputter::Human#fatal_error. This should be used to print

data/lib/bolt/config.rb

@@ -391,6 +391,12 @@ module Bolt
         @logs << { warn: msg }
       end
 
+      if @project.modules && @data['modulepath']&.include?(@project.managed_moduledir.to_s)
+        raise Bolt::ValidationError,
+              "Found invalid path in modulepath: #{@project.managed_moduledir}. This path "\
+              "is automatically appended to the modulepath and cannot be configured."
+      end
+
       keys = OPTIONS.keys - %w[plugins plugin_hooks puppetdb]
       keys.each do |key|
         next unless Bolt::Util.references?(@data[key])
@@ -445,7 +451,13 @@ module Bolt
     end
 
     def modulepath
-      @data['modulepath'] || @project.modulepath
+      path = @data['modulepath'] || @project.modulepath
+
+      if @project.modules
+        path + [@project.managed_moduledir.to_s]
+      else
+        path
+      end
     end
 
     def modulepath=(value)