bolt 2.33.1 → 2.37.0

data/lib/bolt/plugin/cache.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'bolt/error'
+require 'bolt/util'
+
+module Bolt
+  class Plugin
+    class Cache
+      attr_reader :reference, :cache_file, :default_config, :id
+
+      def initialize(reference, cache_file, default_config)
+        @reference = reference
+        @cache_file = cache_file
+        @default_config = default_config
+      end
+
+      def read_and_clean_cache
+        return if ttl == 0
+        validate
+
+        # Luckily we don't need to use a serious hash algorithm
+        require 'digest/bubblebabble'
+        r = reference.select { |k, _| k == '_cache' }.sort.to_s
+        @id = Digest::SHA2.bubblebabble(r)[0..20]
+
+        unmodified = true
+        # First remove any cache entries past their ttl
+        # This prevents removing plugins from leaving orphaned cache entries
+        cache.delete_if do |_, entry|
+          expired = Time.now - Time.parse(entry['mtime']) >= entry['ttl']
+          unmodified = false if expired
+          expired
+        end
+        File.write(cache_file, cache.to_json) unless cache.empty? || unmodified
+
+        cache.dig(id, 'result')
+      end
+
+      private def cache
+        @cache ||= Bolt::Util.read_optional_json_file(@cache_file, 'cache')
+      end
+
+      def write_cache(result)
+        cache.merge!({ id => { 'result' => result,
+                               'mtime' => Time.now,
+                               'ttl' => ttl } })
+        FileUtils.touch(cache_file)
+        File.write(cache_file, cache.to_json)
+      end
+
+      def validate
+        # The default cache `plugin-cache` will be validated by the config
+        # validator
+        return if reference['_cache'].nil?
+        r = reference['_cache']
+        unless r.is_a?(Hash)
+          raise Bolt::ValidationError,
+                "_cache must be a Hash, received #{r.class}: #{r.inspect}"
+        end
+
+        unless r.key?('ttl')
+          raise Bolt::ValidationError, "_cache must set 'ttl' key."
+        end
+
+        unless r['ttl'] >= 0
+          raise Bolt::ValidationError, "'ttl' key under '_cache' must be a minimum of 0."
+        end
+      end
+
+      private def ttl
+        @ttl ||= reference.dig('_cache', 'ttl') || default_config['ttl']
+      end
+    end
+  end
+end

data/lib/bolt/plugin/module.rb

@@ -12,15 +12,15 @@ module Bolt
         end
       end
 
-      def self.load(name, modules, opts)
-        mod = modules[name]
-        if mod&.plugin?
+      # mod should not be nil
+      def self.load(mod, opts)
+        if mod.plugin?
           opts[:mod] = mod
           plugin = Bolt::Plugin::Module.new(**opts)
           plugin.setup
           plugin
         else
-          raise PluginError::Unknown, name
+          raise PluginError::Unknown, mod.name
         end
       end
 

data/lib/bolt/project.rb

@@ -2,24 +2,19 @@
 
 require 'pathname'
 require 'bolt/config'
+require 'bolt/config/validator'
 require 'bolt/pal'
 require 'bolt/module'
 
 module Bolt
   class Project
     BOLTDIR_NAME = 'Boltdir'
-    PROJECT_SETTINGS = {
-      "name"  => "The name of the project",
-      "plans" => "An array of plan names to show, if they exist in the project."\
-                 "These plans are included in `bolt plan show` output",
-      "tasks" => "An array of task names to show, if they exist in the project."\
-                 "These tasks are included in `bolt task show` output"
-    }.freeze
+    CONFIG_NAME  = 'bolt-project.yaml'
 
     attr_reader :path, :data, :config_file, :inventory_file, :hiera_config,
                 :puppetfile, :rerunfile, :type, :resource_types, :logs, :project_file,
                 :deprecations, :downloads, :plans_path, :modulepath, :managed_moduledir,
-                :backup_dir
+                :backup_dir, :cache_file
 
     def self.default_project(logs = [])
       create_project(File.expand_path(File.join('~', '.puppetlabs', 'bolt')), 'user', logs)
@@ -32,23 +27,31 @@ module Bolt
     # directory called Boltdir or a file called bolt.yaml (for a control repo
     # type Project). Otherwise, repeat the check on each directory up the
     # hierarchy, falling back to the default if we reach the root.
-    def self.find_boltdir(dir, logs = [])
+    def self.find_boltdir(dir, logs = [], deprecations = [])
       dir = Pathname.new(dir)
 
       if (dir + BOLTDIR_NAME).directory?
         create_project(dir + BOLTDIR_NAME, 'embedded', logs)
-      elsif (dir + 'bolt.yaml').file? || (dir + 'bolt-project.yaml').file?
+      elsif (dir + 'bolt.yaml').file?
+        command = Bolt::Util.powershell? ? 'Update-BoltProject' : 'bolt project migrate'
+        msg = "Configuration file #{dir + 'bolt.yaml'} is deprecated and will be "\
+          "removed in Bolt 3.0.\nUpdate your Bolt project to the latest Bolt practices "\
+          "using #{command}"
+        deprecations << { type: "Project level bolt.yaml",
+                          msg: msg }
+        create_project(dir, 'local', logs, deprecations)
+      elsif (dir + CONFIG_NAME).file?
         create_project(dir, 'local', logs)
       elsif dir.root?
         default_project(logs)
       else
         logs << { debug: "Did not detect Boltdir, bolt.yaml, or bolt-project.yaml at '#{dir}'. "\
                   "This directory won't be loaded as a project." }
-        find_boltdir(dir.parent, logs)
+        find_boltdir(dir.parent, logs, deprecations)
       end
     end
 
-    def self.create_project(path, type = 'option', logs = [])
+    def self.create_project(path, type = 'option', logs = [], deprecations = [])
       fullpath = Pathname.new(path).expand_path
 
       if type == 'user'
@@ -73,21 +76,36 @@ module Bolt
         )
       end
 
-      project_file = File.join(fullpath, 'bolt-project.yaml')
-      data = Bolt::Util.read_optional_yaml_hash(File.expand_path(project_file), 'project')
-      default = type =~ /user|system/ ? 'default ' : ''
-      exist = File.exist?(File.expand_path(project_file))
+      project_file = File.join(fullpath, CONFIG_NAME)
+      data         = Bolt::Util.read_optional_yaml_hash(File.expand_path(project_file), 'project')
+      default      = type =~ /user|system/ ? 'default ' : ''
+      exist        = File.exist?(File.expand_path(project_file))
+
       logs << { info: "Loaded #{default}project from '#{fullpath}'" } if exist
-      new(data, path, type, logs)
-    end
 
-    def initialize(raw_data, path, type = 'option', logs = [])
-      @path = Pathname.new(path).expand_path
+      # Validate the config against the schema. This will raise a single error
+      # with all validation errors.
+      schema = Bolt::Config::OPTIONS.slice(*Bolt::Config::BOLT_PROJECT_OPTIONS)
+
+      Bolt::Config::Validator.new.tap do |validator|
+        validator.validate(data, schema, project_file)
+
+        validator.warnings.each { |warning| logs << { warn: warning } }
+
+        validator.deprecations.each do |dep|
+          deprecations << { type: "#{CONFIG_NAME} #{dep[:option]}", msg: dep[:message] }
+        end
+      end
 
-      @project_file = @path + 'bolt-project.yaml'
+      new(data, path, type, logs, deprecations)
+    end
+
+    def initialize(raw_data, path, type = 'option', logs = [], deprecations = [])
+      @path         = Pathname.new(path).expand_path
+      @project_file = @path + CONFIG_NAME
+      @logs         = logs
+      @deprecations = deprecations
 
-      @logs = logs
-      @deprecations = []
       if (@path + 'bolt.yaml').file? && project_file?
         msg = "Project-level configuration in bolt.yaml is deprecated if using bolt-project.yaml. "\
           "Transport config should be set in inventory.yaml, all other config should be set in "\
@@ -105,6 +123,7 @@ module Bolt
       @plans_path        = @path + 'plans'
       @managed_moduledir = @path + '.modules'
       @backup_dir        = @path + '.bolt-bak'
+      @cache_file        = @path + '.plugin_cache.json'
 
       tc = Bolt::Config::INVENTORY_OPTIONS.keys & raw_data.keys
       if tc.any?
@@ -173,6 +192,10 @@ module Bolt
       @data['plans']
     end
 
+    def plugin_cache
+      @data['plugin-cache']
+    end
+
     def modules
       @modules ||= @data['modules']&.map do |mod|
         if mod.is_a?(String)
@@ -198,23 +221,6 @@ module Bolt
         message = "No project name is specified in bolt-project.yaml. Project-level content will not be available."
         @logs << { warn: message }
       end
-
-      %w[tasks plans].each do |conf|
-        unless @data.fetch(conf, []).is_a?(Array)
-          raise Bolt::ValidationError, "'#{conf}' in bolt-project.yaml must be an array"
-        end
-      end
-
-      if @data['modules']
-        unless @data['modules'].is_a?(Array)
-          raise Bolt::ValidationError, "'modules' in bolt-project.yaml must be an array"
-        end
-
-        @data['modules'].each do |spec|
-          next if spec.is_a?(Hash) || spec.is_a?(String)
-          raise Bolt::ValidationError, "Module specification #{spec.inspect} must be a hash or string"
-        end
-      end
     end
 
     def check_deprecated_file

data/lib/bolt/project_manager.rb

@@ -0,0 +1,199 @@
+# frozen_string_literal: true
+
+require 'bolt/project_manager/config_migrator'
+require 'bolt/project_manager/inventory_migrator'
+require 'bolt/project_manager/module_migrator'
+
+module Bolt
+  class ProjectManager
+    INVENTORY_TEMPLATE = <<~INVENTORY
+      # This is an example inventory.yaml
+      # To read more about inventory files, see https://pup.pt/bolt-inventory
+      #
+      # groups:
+      #   - name: linux
+      #     targets:
+      #       - target1.example.com
+      #       - target2.example.com
+      #     config:
+      #       transport: ssh
+      #       ssh:
+      #         private-key: /path/to/private_key.pem
+      #   - name: windows
+      #     targets:
+      #       - name: win1
+      #         uri: target3.example.com
+      #       - name: win2
+      #         uri: target4.example.com
+      #     config:
+      #       transport: winrm
+      # config:
+      #   ssh:
+      #     host-key-check: false
+      #   winrm:
+      #     user: Administrator
+      #     password: Bolt!
+      #     ssl: false
+    INVENTORY
+
+    def initialize(config, outputter, pal)
+      @config    = config
+      @outputter = outputter
+      @pal       = pal
+    end
+
+    # Creates a new project at the specified directory.
+    #
+    def create(path, name, modules)
+      require 'bolt/module_installer'
+
+      project       = Pathname.new(File.expand_path(path))
+      old_config    = project + 'bolt.yaml'
+      config        = project + 'bolt-project.yaml'
+      puppetfile    = project + 'Puppetfile'
+      moduledir     = project + '.modules'
+      inventoryfile = project + 'inventory.yaml'
+      project_name  = name || File.basename(project)
+
+      if config.exist?
+        if modules
+          command = Bolt::Util.powershell? ? 'Add-BoltModule -Module' : 'bolt module add'
+          raise Bolt::Error.new(
+            "Found existing project directory with #{config.basename} at #{project}, "\
+            "unable to initialize project with modules. To add modules to the project, "\
+            "run '#{command} <module>' instead.",
+            'bolt/existing-project-error'
+          )
+        else
+          raise Bolt::Error.new(
+            "Found existing project directory with #{config.basename} at #{project}, "\
+            "unable to initialize project.",
+            'bolt/existing-project-error'
+          )
+        end
+      elsif old_config.exist?
+        command = Bolt::Util.powershell? ? 'Update-BoltProject' : 'bolt project migrate'
+        raise Bolt::Error.new(
+          "Found existing project directory with #{old_config.basename} at #{project}, "\
+          "unable to initialize project. #{old_config.basename} is deprecated. To "\
+          "update the project to current best practices, run '#{command}'.",
+          'bolt/existing-project-error'
+        )
+      elsif modules && puppetfile.exist?
+        raise Bolt::Error.new(
+          "Found existing Puppetfile at #{puppetfile}, unable to initialize project "\
+          "with modules.",
+          'bolt/existing-puppetfile-error'
+        )
+      elsif project_name !~ Bolt::Module::MODULE_NAME_REGEX
+        if name
+          raise Bolt::ValidationError,
+                "The provided project name '#{project_name}' is invalid; project name must "\
+                "begin with a lowercase letter and can include lowercase letters, "\
+                "numbers, and underscores."
+        else
+          command = Bolt::Util.powershell? ? 'New-BoltProject -Name' : 'bolt project init'
+          raise Bolt::ValidationError,
+                "The current directory name '#{project_name}' is an invalid project name. "\
+                "Please specify a name using '#{command} <name>'."
+        end
+      end
+
+      # If modules were specified, resolve and install first. We want to error
+      # early here and not initialize the project if the modules cannot be
+      # resolved and installed.
+      if modules
+        Bolt::ModuleInstaller.new(@outputter, @pal).install(modules, puppetfile, moduledir)
+      end
+
+      data = { 'name' => project_name }
+      data['modules'] = modules || []
+
+      begin
+        File.write(config.to_path, data.to_yaml)
+      rescue StandardError => e
+        raise Bolt::FileError.new("Could not create bolt-project.yaml at #{project}: #{e.message}", nil)
+      end
+
+      unless inventoryfile.exist?
+        begin
+          File.write(inventoryfile.to_path, INVENTORY_TEMPLATE)
+        rescue StandardError => e
+          raise Bolt::FileError.new("Could not create inventory.yaml at #{project}: #{e.message}", nil)
+        end
+      end
+
+      @outputter.print_message("Successfully created Bolt project at #{project}")
+
+      0
+    end
+
+    # Migrates a project to use the latest file versions and best practices.
+    #
+    def migrate
+      unless $stdin.tty?
+        raise Bolt::Error.new(
+          "stdin is not a tty, unable to migrate project",
+          'bolt/stdin-not-a-tty-error'
+        )
+      end
+
+      @outputter.print_message("Migrating project #{@config.project.path}\n\n")
+
+      @outputter.print_action_step(
+        "Migrating a Bolt project may make irreversible changes to the project's "\
+        "configuration and inventory files. Before continuing, make sure the "\
+        "project has a backup or uses a version control system."
+      )
+
+      return 0 unless Bolt::Util.prompt_yes_no("Continue with project migration?", @outputter)
+
+      @outputter.print_message('')
+
+      ok = migrate_inventory && migrate_config && migrate_modules
+
+      if ok
+        @outputter.print_message("Project successfully migrated")
+      else
+        @outputter.print_error("Project could not be migrated completely")
+      end
+
+      ok ? 0 : 1
+    end
+
+    # Migrates the project-level configuration file to the latest version.
+    #
+    private def migrate_config
+      migrator = ConfigMigrator.new(@outputter)
+
+      migrator.migrate(
+        @config.project.config_file,
+        @config.project.project_file,
+        @config.inventoryfile || @config.project.inventory_file,
+        @config.project.backup_dir
+      )
+    end
+
+    # Migrates the inventory file to the latest version.
+    #
+    private def migrate_inventory
+      migrator = InventoryMigrator.new(@outputter)
+
+      migrator.migrate(
+        @config.inventoryfile || @config.project.inventory_file,
+        @config.project.backup_dir
+      )
+    end
+
+    # Migrates the project's modules to use current best practices.
+    #
+    private def migrate_modules
+      migrator = ModuleMigrator.new(@outputter)
+
+      migrator.migrate(
+        @config.project,
+        @config.modulepath
+      )
+    end
+  end
+end

data/lib/bolt/{project_migrator/config.rb → project_manager/config_migrator.rb}

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
-require 'bolt/project_migrator/base'
+require 'bolt/project_manager/migrator'
 
 module Bolt
-  class ProjectMigrator
-    class Config < Base
+  class ProjectManager
+    class ConfigMigrator < Migrator
       def migrate(config_file, project_file, inventory_file, backup_dir)
-        bolt_yaml_to_bolt_project(config_file, project_file, inventory_file, backup_dir)
+        bolt_yaml_to_bolt_project(config_file, project_file, inventory_file, backup_dir) &&
+          update_options(project_file)
       end
 
       private def bolt_yaml_to_bolt_project(config_file, project_file, inventory_file, backup_dir)
@@ -54,14 +55,51 @@ module Bolt
         @outputter.print_action_step("Renaming bolt.yaml to bolt-project.yaml")
         FileUtils.mv(config_file, project_file)
 
+        command = Bolt::Util.powershell? ? 'Get-Help about_bolt_project' : 'bolt guide project'
         @outputter.print_action_step(
           "Successfully migrated config. Please add a 'name' key to bolt-project.yaml "\
           "to use project-level tasks and plans. Learn more about projects by running "\
-          "'bolt guide project'."
+          "'#{command}'."
         )
 
         true
       end
+
+      private def update_options(project_file)
+        return true unless File.exist?(project_file)
+
+        @outputter.print_message("Updating project configuration options\n\n")
+        data     = Bolt::Util.read_yaml_hash(project_file, 'config')
+        modified = false
+
+        [%w[apply_settings apply-settings], %w[plugin_hooks plugin-hooks]].each do |old, new|
+          next unless data.key?(old)
+
+          if data.key?(new)
+            @outputter.print_action_step("Removing deprecated option '#{old}'")
+            data.delete(old)
+          else
+            @outputter.print_action_step("Updating deprecated option '#{old}' to '#{new}'")
+            data[new] = data.delete(old)
+          end
+
+          modified = true
+        end
+
+        if modified
+          begin
+            File.write(project_file, data.to_yaml)
+          rescue StandardError => e
+            raise Bolt::FileError.new("#{e.message}; unable to write config.", project_file)
+          end
+
+          @outputter.print_action_step("Successfully updated project configuration #{project_file}")
+        else
+          @outputter.print_action_step("Project configuration is up to date, nothing to do.")
+        end
+
+        true
+      end
     end
   end
 end