bolt 2.31.0 → 2.32.0

data/lib/bolt/module_installer/specs/git_spec.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'set'
+
+require 'bolt/error'
+
+# This class represents a Git module specification.
+#
+module Bolt
+  class ModuleInstaller
+    class Specs
+      class GitSpec
+        NAME_REGEX    = %r{\A(?:[a-z][a-z0-9_]*[-/])?(?<name>[a-z][a-z0-9_]*)\z}.freeze
+        REQUIRED_KEYS = Set.new(%w[git ref]).freeze
+
+        attr_reader :git, :ref, :type
+
+        def initialize(init_hash)
+          @name       = parse_name(init_hash['name'])
+          @git, @repo = parse_git(init_hash['git'])
+          @ref        = init_hash['ref']
+          @type       = :git
+        end
+
+        def self.implements?(hash)
+          REQUIRED_KEYS == hash.keys.to_set
+        end
+
+        # Parses the name into owner and name segments, and formats the full
+        # name.
+        #
+        private def parse_name(name)
+          return unless name
+
+          unless (match = name.match(NAME_REGEX))
+            raise Bolt::ValidationError,
+                  "Invalid name for Git module specification: #{name}. Name must match "\
+                  "'name' or 'owner/name', must start with a lowercase letter, and may "\
+                  "only include lowercase letters, digits, and underscores."
+          end
+
+          match[:name]
+        end
+
+        # Gets the repo from the git URL.
+        #
+        private def parse_git(git)
+          repo = if git.start_with?('git@github.com:')
+                   git.split('git@github.com:').last.split('.git').first
+                 elsif git.start_with?('https://github.com')
+                   git.split('https://github.com/').last.split('.git').first
+                 else
+                   raise Bolt::ValidationError,
+                         "Invalid git source: #{git}. Only GitHub modules are supported."
+                 end
+
+          [git, repo]
+        end
+
+        # Returns true if the specification is satisfied by the module.
+        #
+        def satisfied_by?(mod)
+          @type == mod.type && @git == mod.git
+        end
+
+        # Returns a hash matching the module spec in bolt-project.yaml
+        #
+        def to_hash
+          {
+            'git' => @git,
+            'ref' => @ref
+          }
+        end
+
+        # Returns a PuppetfileResolver::Model::GitModule object for resolving.
+        #
+        def to_resolver_module
+          require 'puppetfile-resolver'
+
+          PuppetfileResolver::Puppetfile::GitModule.new(name).tap do |mod|
+            mod.remote = @git
+            mod.ref    = sha
+          end
+        end
+
+        # Resolves the module's title from the module metadata. This is lazily
+        # resolved since Bolt does not always need to know a Git module's name.
+        #
+        def name
+          @name ||= begin
+            url      = "https://raw.githubusercontent.com/#{@repo}/#{sha}/metadata.json"
+            response = make_request(:Get, url)
+
+            case response
+            when Net::HTTPOK
+              body = JSON.parse(response.body)
+
+              unless body.key?('name')
+                raise Bolt::Error.new(
+                  "Missing name in metadata.json at #{git}. This is not a valid module.",
+                  "bolt/missing-module-name-error"
+                )
+              end
+
+              parse_name(body['name'])
+            else
+              raise Bolt::Error.new(
+                "Missing metadata.json at #{git}. This is not a valid module.",
+                "bolt/missing-module-metadata-error"
+              )
+            end
+          end
+        end
+
+        # Resolves the SHA for the specified ref. This is lazily resolved since
+        # Bolt does not always need to know a Git module's SHA.
+        #
+        def sha
+          @sha ||= begin
+            url      = "https://api.github.com/repos/#{@repo}/commits/#{ref}"
+            headers  = ENV['GITHUB_TOKEN'] ? { "Authorization" => "token #{ENV['GITHUB_TOKEN']}" } : {}
+            response = make_request(:Get, url, headers)
+
+            case response
+            when Net::HTTPOK
+              body = JSON.parse(response.body)
+              body['sha']
+            when Net::HTTPUnauthorized
+              raise Bolt::Error.new(
+                "Invalid token at GITHUB_TOKEN, unable to resolve git modules.",
+                "bolt/invalid-git-token-error"
+              )
+            when Net::HTTPForbidden
+              message = "GitHub API rate limit exceeded, unable to resolve git modules. "
+
+              unless ENV['GITHUB_TOKEN']
+                message += "To increase your rate limit, set the GITHUB_TOKEN environment "\
+                          "variable with a GitHub personal access token."
+              end
+
+              raise Bolt::Error.new(message, 'bolt/github-api-rate-limit-error')
+            when Net::HTTPNotFound
+              raise Bolt::Error.new(
+                "#{git} is not a git repository.",
+                "bolt/missing-git-repository-error"
+              )
+            else
+              raise Bolt::Error.new(
+                "Ref #{ref} at #{git} is not a commit, tag, or branch.",
+                "bolt/invalid-git-ref-error"
+              )
+            end
+          end
+        end
+
+        # Makes a generic HTTP request.
+        #
+        private def make_request(verb, url, headers = {})
+          require 'net/http'
+
+          uri      = URI.parse(url)
+          opts     = { use_ssl: uri.scheme == 'https' }
+
+          Net::HTTP.start(uri.host, uri.port, opts) do |client|
+            request = Net::HTTP.const_get(verb).new(uri, headers)
+            client.request(request)
+          end
+        rescue StandardError => e
+          raise Bolt::Error.new(
+            "Failed to connect to #{uri}: #{e.message}",
+            "bolt/http-connect-error"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/bolt/outputter.rb

@@ -27,10 +27,6 @@ module Bolt
       string.gsub(/^/, indent.to_s)
     end
 
-    def print_message_event(event)
-      print_message(stringify(event[:message]))
-    end
-
     def print_message
       raise NotImplementedError, "print_message() must be implemented by the outputter class"
     end
@@ -38,49 +34,6 @@ module Bolt
     def print_error
       raise NotImplementedError, "print_error() must be implemented by the outputter class"
     end
-
-    def stringify(message)
-      formatted = format_message(message)
-      if formatted.is_a?(Hash) || formatted.is_a?(Array)
-        ::JSON.pretty_generate(formatted)
-      else
-        formatted
-      end
-    end
-
-    def format_message(message)
-      case message
-      when Array
-        message.map { |item| format_message(item) }
-      when Bolt::ApplyResult
-        format_apply_result(message)
-      when Bolt::Result, Bolt::ResultSet
-        # This is equivalent to to_s, but formattable
-        message.to_data
-      when Bolt::RunFailure
-        formatted_resultset = message.result_set.to_data
-        message.to_h.merge('result_set' => formatted_resultset)
-      when Hash
-        message.each_with_object({}) do |(k, v), h|
-          h[format_message(k)] = format_message(v)
-        end
-      when Integer, Float, NilClass
-        message
-      else
-        message.to_s
-      end
-    end
-
-    def format_apply_result(result)
-      logs = result.resource_logs&.map do |log|
-        # Omit low-level info/debug messages
-        next if %w[info debug].include?(log['level'])
-        indent(2, format_log(log))
-      end
-      hash = result.to_data
-      hash['logs'] = logs unless logs.empty?
-      hash
-    end
   end
 end
 

data/lib/bolt/outputter/human.rb

@@ -45,7 +45,7 @@ module Bolt
         when :disable_default_output
           @disable_depth += 1
         when :message
-          print_message_event(event)
+          print_message(event[:message])
         end
 
         if enabled?
@@ -344,7 +344,7 @@ module Bolt
         end
 
         @stream.puts "INVENTORY FILE:"
-        if inventoryfile.exist?
+        if File.exist?(inventoryfile)
           @stream.puts inventoryfile
         else
           @stream.puts wrap("Tried to load inventory from #{inventoryfile}, but the file does not exist")

data/lib/bolt/outputter/json.rb

@@ -22,7 +22,7 @@ module Bolt
         when :node_result
           print_result(event[:result])
         when :message
-          print_message_event(event)
+          print_message(event[:message])
         end
       end
 

data/lib/bolt/project.rb

@@ -210,14 +210,9 @@ module Bolt
           raise Bolt::ValidationError, "'modules' in bolt-project.yaml must be an array"
         end
 
-        @data['modules'].each do |mod|
-          next if (mod.is_a?(Hash) && mod.key?('name')) || mod.is_a?(String)
-          raise Bolt::ValidationError, "Module declaration #{mod.inspect} must be a hash with a name key"
-        end
-
-        unknown_keys = modules.flat_map(&:keys).uniq - %w[name version_requirement]
-        if unknown_keys.any?
-          @logs << { warn: "Ignoring unknown keys in module declarations: #{unknown_keys.join(', ')}." }
+        @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

data/lib/bolt/project_migrator/modules.rb

@@ -42,12 +42,14 @@ module Bolt
       # to the new moduledir.
       #
       private def migrate_modules_from_puppetfile(config, puppetfile_path, managed_moduledir, modulepath)
-        require 'bolt/puppetfile'
-        require 'bolt/puppetfile/installer'
+        require 'bolt/module_installer/installer'
+        require 'bolt/module_installer/puppetfile'
+        require 'bolt/module_installer/resolver'
+        require 'bolt/module_installer/specs'
 
         begin
           @outputter.print_action_step("Parsing Puppetfile at #{puppetfile_path}")
-          puppetfile = Bolt::Puppetfile.parse(puppetfile_path, skip_unsupported_modules: true)
+          puppetfile = Bolt::ModuleInstaller::Puppetfile.parse(puppetfile_path, skip_unsupported_modules: true)
         rescue Bolt::Error => e
           @outputter.print_action_error("#{e.message}\nSkipping module migration.")
           return false
@@ -56,14 +58,14 @@ module Bolt
         # Prompt for direct dependencies
         modules = select_modules(puppetfile.modules)
 
-        # Create new Puppetfile object
-        puppetfile = Bolt::Puppetfile.new(modules)
+        # Create specs to resolve from
+        specs = Bolt::ModuleInstaller::Specs.new(modules.map(&:to_hash))
 
         # Attempt to resolve dependencies
         begin
           @outputter.print_message('')
           @outputter.print_action_step("Resolving module dependencies, this may take a moment")
-          puppetfile.resolve
+          puppetfile = Bolt::ModuleInstaller::Resolver.new.resolve(specs)
         rescue Bolt::Error => e
           @outputter.print_action_error("#{e.message}\nSkipping module migration.")
           return false
@@ -98,7 +100,7 @@ module Bolt
 
           # Install Puppetfile
           @outputter.print_action_step("Syncing modules from #{puppetfile_path} to #{managed_moduledir}")
-          Bolt::Puppetfile::Installer.new({}).install(puppetfile_path, managed_moduledir)
+          Bolt::ModuleInstaller::Installer.new.install(puppetfile_path, managed_moduledir)
         else
           @outputter.print_action_step(
             "Project does not include any managed modules, deleting Puppetfile "\
@@ -123,7 +125,7 @@ module Bolt
         return modules if all
 
         modules.select do |mod|
-          Bolt::Util.prompt_yes_no("Select #{mod.title}?", @outputter)
+          Bolt::Util.prompt_yes_no("Select #{mod.full_name}?", @outputter)
         end
       end
 

data/lib/bolt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bolt
-  VERSION = '2.31.0'
+  VERSION = '2.32.0'
 end

data/lib/bolt_server/schemas/partials/task.json

@@ -63,9 +63,24 @@
                   "environment": {
                     "description": "Environment the task is in",
                     "type": "string"
+                  },
+                  "project": {
+                    "description": "Project the task is in",
+                    "type": "string"
                   }
                 },
-                "required": ["environment"],
+                "oneOf": [
+                  {
+                    "required": [
+                      "environment"
+                    ]
+                  },
+                  {
+                    "required": [
+                      "project"
+                    ]
+                  }
+                ],              
                 "additionalProperties": true
               }
             },
@@ -90,5 +105,5 @@
     }
   },
   "required": ["name", "files"],
-  "additionalProperties": false
+  "additionalProperties": true
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 2.31.0
+  version: 2.32.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-19 00:00:00.000000000 Z
+date: 2020-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -182,16 +182,22 @@ dependencies:
   name: puppet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 6.18.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '6.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 6.18.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '6.19'
 - !ruby/object:Gem::Dependency
   name: puppetfile-resolver
   requirement: !ruby/object:Gem::Requirement
@@ -432,6 +438,8 @@ files:
 - bolt-modules/system/lib/puppet/functions/system/env.rb
 - exe/bolt
 - guides/inventory.txt
+- guides/module.txt
+- guides/modulepath.txt
 - guides/project.txt
 - lib/bolt.rb
 - lib/bolt/analytics.rb
@@ -463,6 +471,15 @@ files:
 - lib/bolt/logger.rb
 - lib/bolt/module.rb
 - lib/bolt/module_installer.rb
+- lib/bolt/module_installer/installer.rb
+- lib/bolt/module_installer/puppetfile.rb
+- lib/bolt/module_installer/puppetfile/forge_module.rb
+- lib/bolt/module_installer/puppetfile/git_module.rb
+- lib/bolt/module_installer/puppetfile/module.rb
+- lib/bolt/module_installer/resolver.rb
+- lib/bolt/module_installer/specs.rb
+- lib/bolt/module_installer/specs/forge_spec.rb
+- lib/bolt/module_installer/specs/git_spec.rb
 - lib/bolt/node/errors.rb
 - lib/bolt/node/output.rb
 - lib/bolt/outputter.rb
@@ -504,9 +521,6 @@ files:
 - lib/bolt/puppetdb.rb
 - lib/bolt/puppetdb/client.rb
 - lib/bolt/puppetdb/config.rb
-- lib/bolt/puppetfile.rb
-- lib/bolt/puppetfile/installer.rb
-- lib/bolt/puppetfile/module.rb
 - lib/bolt/r10k_log_proxy.rb
 - lib/bolt/rerun.rb
 - lib/bolt/resource_instance.rb