bolt 2.34.0 → 2.40.1

data/lib/bolt/project_manager.rb

@@ -0,0 +1,201 @@
+# 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
+        @outputter.start_spin
+        Bolt::ModuleInstaller.new(@outputter, @pal).install(modules, puppetfile, moduledir)
+        @outputter.stop_spin
+      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)
@@ -63,6 +64,50 @@ module Bolt
 
         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
+
+        # Keys to update. The first element is the old key, while the second is
+        # the key update it to.
+        to_update = [
+          %w[apply_settings apply-settings],
+          %w[puppetfile module-install],
+          %w[plugin_hooks plugin-hooks]
+        ]
+
+        to_update.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

data/lib/bolt/{project_migrator/inventory.rb → project_manager/inventory_migrator.rb}

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'bolt/project_migrator/base'
+require 'bolt/project_manager/migrator'
 
 module Bolt
-  class ProjectMigrator
-    class Inventory < Base
+  class ProjectManager
+    class InventoryMigrator < Migrator
       def migrate(inventory_file, backup_dir)
         inventory1to2(inventory_file, backup_dir)
       end

data/lib/bolt/{project_migrator/base.rb → project_manager/migrator.rb}

@@ -4,8 +4,8 @@ require 'fileutils'
 require 'bolt/error'
 
 module Bolt
-  class ProjectMigrator
-    class Base
+  class ProjectManager
+    class Migrator
       def initialize(outputter)
         @outputter = outputter
       end

data/lib/bolt/{project_migrator/modules.rb → project_manager/module_migrator.rb}

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'bolt/project_migrator/base'
+require 'bolt/project_manager/migrator'
 
 module Bolt
-  class ProjectMigrator
-    class Modules < Base
+  class ProjectManager
+    class ModuleMigrator < Migrator
       def migrate(project, configured_modulepath)
         return true unless project.modules.nil?
 
@@ -61,6 +61,7 @@ module Bolt
         # Create specs to resolve from
         specs = Bolt::ModuleInstaller::Specs.new(modules.map(&:to_hash))
 
+        @outputter.start_spin
         # Attempt to resolve dependencies
         begin
           @outputter.print_message('')
@@ -72,6 +73,7 @@ module Bolt
         end
 
         migrate_managed_modules(puppetfile, puppetfile_path, managed_moduledir)
+        @outputter.stop_spin
 
         # Move remaining modules to 'modules'
         consolidate_modules(modulepath)

data/lib/bolt/puppetdb/client.rb

@@ -2,7 +2,6 @@
 
 require 'json'
 require 'logging'
-require 'uri'
 
 module Bolt
   module PuppetDB
@@ -19,6 +18,7 @@ module Bolt
       def query_certnames(query)
         return [] unless query
 
+        @logger.debug("Querying certnames")
         results = make_query(query)
 
         if results&.first && !results.first&.key?('certname')
@@ -35,6 +35,8 @@ module Bolt
         certnames.uniq!
         name_query = certnames.map { |c| ["=", "certname", c] }
         name_query.insert(0, "or")
+
+        @logger.debug("Querying certnames")
         result = make_query(name_query, 'inventory')
 
         result&.each_with_object({}) do |node, coll|
@@ -53,6 +55,8 @@ module Bolt
         facts_query.insert(0, "or")
 
         query = ['and', name_query, facts_query]
+
+        @logger.debug("Querying certnames")
         result = make_query(query, 'fact-contents')
         result.map! { |h| h.delete_if { |k, _v| %w[environment name].include?(k) } }
         result.group_by { |c| c['certname'] }
@@ -64,11 +68,13 @@ module Bolt
         url += "/#{path}" if path
 
         begin
+          @logger.debug("Sending PuppetDB query to #{url}")
           response = http_client.post(url, body: body, header: headers)
         rescue StandardError => e
           raise Bolt::PuppetDBFailoverError, "Failed to query PuppetDB: #{e}"
         end
 
+        @logger.debug("Got response code #{response.code} from PuppetDB")
         if response.code != 200
           msg = "Failed to query PuppetDB: #{response.body}"
           if response.code == 400
@@ -93,6 +99,7 @@ module Bolt
         return @http if @http
         # lazy-load expensive gem code
         require 'httpclient'
+        @logger.trace("Creating HTTP Client")
         @http = HTTPClient.new
         @http.ssl_config.set_client_cert_file(@config.cert, @config.key) if @config.cert
         @http.ssl_config.add_trust_ca(@config.cacert)
@@ -108,13 +115,15 @@ module Bolt
       end
 
       def uri
+        require 'addressable/uri'
+
         @current_url ||= (@config.server_urls - @bad_urls).first
         unless @current_url
           msg = "Failed to connect to all PuppetDB server_urls: #{@config.server_urls.to_a.join(', ')}."
           raise Bolt::PuppetDBError, msg
         end
 
-        uri = URI.parse(@current_url)
+        uri = Addressable::URI.parse(@current_url)
         uri.port ||= 8081
         uri
       end

data/lib/bolt/puppetdb/config.rb

@@ -18,8 +18,7 @@ module Bolt
       end
 
       def self.default_windows_config
-        require 'win32/dir'
-        File.expand_path(File.join(Dir::COMMON_APPDATA, 'PuppetLabs/client-tools/puppetdb.conf'))
+        File.expand_path(File.join(ENV['ALLUSERSPROFILE'], 'PuppetLabs/client-tools/puppetdb.conf'))
       end
 
       def self.load_config(options, project_path = nil)
@@ -89,6 +88,8 @@ module Bolt
 
       def uri
         return @uri if @uri
+        require 'addressable/uri'
+
         uri = case @settings['server_urls']
               when String
                 @settings['server_urls']
@@ -100,7 +101,7 @@ module Bolt
                 raise Bolt::PuppetDBError, "server_urls must be a string or array"
               end
 
-        @uri = URI.parse(uri)
+        @uri = Addressable::URI.parse(uri)
         @uri.port ||= 8081
         @uri
       end

data/lib/bolt/rerun.rb

@@ -12,15 +12,11 @@ module Bolt
     end
 
     def data
-      @data ||= JSON.parse(File.read(@path))
+      @data ||= Bolt::Util.read_json_file(@path, 'rerun')
       unless @data.is_a?(Array) && @data.all? { |r| r['target'] && r['status'] }
         raise Bolt::FileError.new("Missing data in rerun file: #{@path}", @path)
       end
       @data
-    rescue JSON::ParserError
-      raise Bolt::FileError.new("Could not parse rerun file: #{@path}", @path)
-    rescue IOError, SystemCallError
-      raise Bolt::FileError.new("Could not read rerun file: #{@path}", @path)
     end
 
     def get_targets(filter)

data/lib/bolt/shell/bash.rb

@@ -199,7 +199,7 @@ module Bolt
         lines = buffer.split(/(?<=\n)/)
         # handle_sudo will return the line if it is not a sudo prompt or error
         lines.map! { |line| handle_sudo(inp, line, stdin) }
-        lines.join("")
+        lines.join
       # If stream has reached EOF, no password prompt is expected
       # return an empty string
       rescue EOFError
@@ -436,8 +436,14 @@ module Bolt
         result_output.stderr << read_streams[err]
         result_output.exit_code = t.value.respond_to?(:exitstatus) ? t.value.exitstatus : t.value
 
-        if result_output.exit_code == 0
+        case result_output.exit_code
+        when 0
           @logger.trace { "Command `#{command_str}` returned successfully" }
+        when 126
+          msg = "\n\nThis may be caused by the default tmpdir being mounted "\
+            "using 'noexec'. See http://pup.pt/task-failure for details and workarounds."
+          result_output.stderr << msg
+          @logger.trace { "Command #{command_str} failed with exit code #{result_output.exit_code}" }
         else
           @logger.trace { "Command #{command_str} failed with exit code #{result_output.exit_code}" }
         end