bolt 2.6.0 → 2.11.0

data/lib/bolt_spec/plans/action_stubs.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'bolt/plan_result'
 require 'bolt/result'
 require 'bolt/util'
 
@@ -23,8 +24,8 @@ module BoltSpec
         @stubs.each { |s| s.assert_called(object) }
       end
 
-      def add_stub
-        stub = Plans.const_get(@action_stub).new
+      def add_stub(inventory = nil)
+        stub = Plans.const_get(@action_stub).new(false, inventory)
         @stubs.unshift stub
         stub
       end
@@ -33,7 +34,7 @@ module BoltSpec
     class ActionStub
       attr_reader :invocation
 
-      def initialize(expect = false)
+      def initialize(expect = false, inventory = nil)
         @calls = 0
         @expect = expect
         @expected_calls = nil
@@ -41,6 +42,7 @@ module BoltSpec
         @invocation = {}
         # return value
         @data = { default: {} }
+        @inventory = inventory
       end
 
       def assert_called(object)
@@ -55,7 +57,16 @@ module BoltSpec
           end
           message = "Expected #{object} to be called #{times} times"
           message += " with targets #{@invocation[:targets]}" if @invocation[:targets]
-          message += " with parameters #{parameters}" if parameters
+          if parameters
+            # Print the parameters hash by converting it to JSON and then re-parsing.
+            # This prevents issues in Bolt data types, such as Targets, from generating
+            # gigantic, unreadable, data when converted to string by interpolation.
+            # Targets exhibit this behavior because they have a reference to @inventory.
+            # When the target is converted into a string, it converts the full Inventory
+            # into a string recursively.
+            parameters_str = JSON.parse(parameters.to_json)
+            message += " with parameters #{parameters_str}"
+          end
           raise message
         end
       end
@@ -71,6 +82,14 @@ module BoltSpec
       # Used to create a valid Bolt::Result object from result data.
       def default_for(target)
         case @data[:default]
+        when Bolt::PlanFailure
+          # Bolt::PlanFailure needs to be declared before Bolt::Error because
+          # Bolt::PlanFailure is an instance of Bolt::Error, so it can match both
+          # in this case we need to treat Bolt::PlanFailure's in a different way
+          #
+          # raise Bolt::PlanFailure errors so that the PAL can catch them and wrap
+          # them into Bolt::PlanResult's for us.
+          raise @data[:default]
         when Bolt::Error
           Bolt::Result.from_exception(target, @data[:default])
         when Hash
@@ -87,6 +106,13 @@ module BoltSpec
         result_set
       end
 
+      def check_plan_result(plan_result, plan_clj)
+        unless plan_result.is_a?(Bolt::PlanResult)
+          raise "Return block for #{plan_clj.closure_name} did not return a Bolt::PlanResult"
+        end
+        plan_result
+      end
+
       # Below here are the intended 'public' methods of the stub
 
       # Restricts the stub to only match invocations with
@@ -127,7 +153,10 @@ module BoltSpec
       def return_for_targets(data)
         data.each_with_object(@data) do |(target, result), hsh|
           raise "Mocked results must be hashes: #{target}: #{result}" unless result.is_a? Hash
-          hsh[target] = result_for(Bolt::Target.new(target), Bolt::Util.walk_keys(result, &:to_sym))
+          # set the inventory from the BoltSpec::Plans, otherwise if we try to convert
+          # this target to a string, it will fail to string conversion because the
+          # inventory is nil
+          hsh[target] = result_for(Bolt::Target.new(target, @inventory), Bolt::Util.walk_keys(result, &:to_sym))
         end
         raise "Cannot set return values and return block." if @return_block
         @data_set = true
@@ -143,10 +172,10 @@ module BoltSpec
       end
 
       # Set a default error result for all targets.
-      def error_with(data)
+      def error_with(data, clazz = Bolt::Error)
         data = Bolt::Util.walk_keys(data, &:to_s)
         if data['msg'] && data['kind'] && (data.keys - %w[msg kind details issue_code]).empty?
-          @data[:default] = Bolt::Error.new(data['msg'], data['kind'], data['details'], data['issue_code'])
+          @data[:default] = clazz.new(data['msg'], data['kind'], data['details'], data['issue_code'])
         else
           STDERR.puts "In the future 'error_with()' may require msg and kind, and " \
                       "optionally accept only details and issue_code."
@@ -160,6 +189,7 @@ module BoltSpec
 end
 
 require_relative 'action_stubs/command_stub'
+require_relative 'action_stubs/plan_stub'
 require_relative 'action_stubs/script_stub'
 require_relative 'action_stubs/task_stub'
 require_relative 'action_stubs/upload_stub'

data/lib/bolt_spec/plans/action_stubs/plan_stub.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module BoltSpec
+  module Plans
+    class PlanStub < ActionStub
+      def matches(_scope, _plan, params)
+        targets = params.fetch('nodes', params.fetch('targets', nil))
+        if @invocation[:targets] && Set.new(@invocation[:targets]) != Set.new(targets)
+          return false
+        end
+
+        if @invocation[:params] && params != @invocation[:params]
+          return false
+        end
+
+        true
+      end
+
+      def call(_scope, plan, params)
+        @calls += 1
+        if @return_block
+          check_plan_result(@return_block.call(plan: plan, params: params), plan)
+        else
+          default_for(nil)
+        end
+      end
+
+      def parameters
+        @invocation[:params]
+      end
+
+      # Allow any data.
+      def result_for(_target, data)
+        Bolt::PlanResult.new(Bolt::Util.walk_keys(data, &:to_s), 'success')
+      end
+
+      # Public methods
+
+      # Restricts the stub to only match invocations with certain parameters.
+      # All parameters must match exactly.
+      def with_params(params)
+        @invocation[:params] = params
+        self
+      end
+
+      def return_for_targets(_data)
+        raise "return_for_targets is not implemented for plan spec tests (allow_plan, expect_plan, allow_any_plan, etc)"
+      end
+
+      def error_with(data, clazz = Bolt::PlanFailure)
+        super(data, clazz)
+      end
+    end
+  end
+end

data/lib/bolt_spec/plans/mock_executor.rb

@@ -3,6 +3,7 @@
 require 'bolt_spec/plans/action_stubs'
 require 'bolt_spec/plans/publish_stub'
 require 'bolt/error'
+require 'bolt/executor'
 require 'bolt/result_set'
 require 'bolt/result'
 require 'pathname'
@@ -10,14 +11,14 @@ require 'set'
 
 module BoltSpec
   module Plans
-    MOCKED_ACTIONS = %i[command script task upload].freeze
+    MOCKED_ACTIONS = %i[command plan script task upload].freeze
 
     class UnexpectedInvocation < ArgumentError; end
 
     # Nothing on the executor is 'public'
     class MockExecutor
       attr_reader :noop, :error_message
-      attr_accessor :run_as, :transport_features
+      attr_accessor :run_as, :transport_features, :execute_any_plan
 
       def initialize(modulepath)
         @noop = false
@@ -28,6 +29,13 @@ module BoltSpec
         MOCKED_ACTIONS.each { |action| instance_variable_set(:"@#{action}_doubles", {}) }
         @stub_out_message = nil
         @transport_features = ['puppet-agent']
+        @executor_real = Bolt::Executor.new
+        # by default, we want to execute any plan that we come across without error
+        # or mocking. users can toggle this behavior so that plans will either need to
+        # be mocked out, or an error will be thrown.
+        @execute_any_plan = true
+        # plans that are allowed to be executed by the @executor_real
+        @allowed_exec_plans = {}
       end
 
       def module_file_id(file)
@@ -96,6 +104,57 @@ module BoltSpec
         result
       end
 
+      def with_plan_allowed_exec(plan_name, params)
+        @allowed_exec_plans[plan_name] = params
+        result = yield
+        @allowed_exec_plans.delete(plan_name)
+        result
+      end
+
+      def run_plan(scope, plan_clj, params)
+        result = nil
+        plan_name = plan_clj.closure_name
+
+        # get the mock object either by plan name, or the default in case allow_any_plan
+        # was called, if both are nil / don't exist, then dub will be nil and we'll fall
+        # through to another conditional statement
+        doub = @plan_doubles[plan_name] || @plan_doubles[:default]
+
+        # High level:
+        #  - If we've explicitly allowed execution of the plan (normally the main plan
+        #    passed into BoltSpec::Plan::run_plan()), then execute it
+        #  - If we've explicitly "allowed/expected" the plan (mocked),
+        #    then run it through the mock object
+        #  - If we're allowing "any" plan to be executed,
+        #    then execute it
+        #  - Otherwise we have an error
+        if @allowed_exec_plans.key?(plan_name) && @allowed_exec_plans[plan_name] == params
+          # This plan's name + parameters were explicitly allowed to be executed.
+          # run it with the real executor.
+          # We require this functionality so that the BoltSpec::Plans.run_plan()
+          # function can kick off the initial plan. In reality, no other plans should
+          # be in this hash.
+          result = @executor_real.run_plan(scope, plan_clj, params)
+        elsif doub
+          result = doub.process(scope, plan_clj, params)
+          # the throw here is how Puppet exits out of a closure and returns a result
+          # it throws this special symbol with a result object that is captured by
+          # the run_plan Puppet function
+          throw :return, result
+        elsif @execute_any_plan
+          # if the plan wasn't allowed or mocked out, and we're allowing any plan to be
+          # executed, then execute the plan
+          result = @executor_real.run_plan(scope, plan_clj, params)
+        else
+          # convert to JSON and back so that we get the ruby representation with all keys and
+          # values converted to a string .to_s instead of their ruby object notation
+          params_str = JSON.parse(params.to_json)
+          @error_message = "Unexpected call to 'run_plan(#{plan_name}, #{params_str})'"
+          raise UnexpectedInvocation, @error_message
+        end
+        result
+      end
+
       def assert_call_expectations
         MOCKED_ACTIONS.each do |action|
           instance_variable_get(:"@#{action}_doubles").map do |object, doub|
@@ -171,6 +230,7 @@ module BoltSpec
       def transport(_protocol)
         Class.new do
           attr_reader :provided_features
+
           def initialize(features)
             @provided_features = features
           end

data/lib/bolt_spec/run.rb

@@ -126,25 +126,25 @@ module BoltSpec
     end
 
     class BoltRunner
-      # Creates a temporary boltdir so no settings are picked up
-      # WARNING: puppetdb config and orch config which do not use the boltdir may
+      # Creates a temporary project so no settings are picked up
+      # WARNING: puppetdb config and orch config which do not use the project may
       # still be loaded
       def self.with_runner(config_data, inventory_data)
-        Dir.mktmpdir do |boltdir_path|
-          runner = new(Bolt::Util.deep_clone(config_data), Bolt::Util.deep_clone(inventory_data), boltdir_path)
+        Dir.mktmpdir do |project_path|
+          runner = new(Bolt::Util.deep_clone(config_data), Bolt::Util.deep_clone(inventory_data), project_path)
           yield runner
         end
       end
 
-      def initialize(config_data, inventory_data, boltdir_path)
+      def initialize(config_data, inventory_data, project_path)
         @config_data = config_data || {}
         @inventory_data = inventory_data || {}
-        @boltdir_path = boltdir_path
+        @project_path = project_path
         @analytics = Bolt::Analytics::NoopClient.new
       end
 
       def config
-        @config ||= Bolt::Config.new(Bolt::Boltdir.new(@boltdir_path), @config_data)
+        @config ||= Bolt::Config.new(Bolt::Project.new(@project_path), @config_data)
       end
 
       def inventory
@@ -152,20 +152,17 @@ module BoltSpec
       end
 
       def plugins
-        @plugins ||= Bolt::Plugin.setup(config, pal, puppetdb_client, @analytics)
+        @plugins ||= Bolt::Plugin.setup(config, pal)
       end
 
       def puppetdb_client
-        @puppetdb_client ||= begin
-                               puppetdb_config = Bolt::PuppetDB::Config.load_config(nil, config.puppetdb)
-                               Bolt::PuppetDB::Client.new(puppetdb_config)
-                             end
+        plugins.puppetdb_client
       end
 
       def pal
         @pal ||= Bolt::PAL.new(config.modulepath,
                                config.hiera_config,
-                               config.boltdir.resource_types,
+                               config.project.resource_types,
                                config.compile_concurrency)
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.11.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-20 00:00:00.000000000 Z
+date: 2020-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -184,7 +184,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.11.0
+        version: 6.15.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
@@ -194,7 +194,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.11.0
+        version: 6.15.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
@@ -324,6 +324,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: puppetlabs_spec_helper
   requirement: !ruby/object:Gem::Requirement
@@ -376,6 +390,7 @@ extra_rdoc_files: []
 files:
 - Puppetfile
 - bolt-modules/boltlib/lib/puppet/datatypes/applyresult.rb
+- bolt-modules/boltlib/lib/puppet/datatypes/resourceinstance.rb
 - bolt-modules/boltlib/lib/puppet/datatypes/result.rb
 - bolt-modules/boltlib/lib/puppet/datatypes/resultset.rb
 - bolt-modules/boltlib/lib/puppet/datatypes/target.rb
@@ -396,8 +411,10 @@ files:
 - bolt-modules/boltlib/lib/puppet/functions/run_plan.rb
 - bolt-modules/boltlib/lib/puppet/functions/run_script.rb
 - bolt-modules/boltlib/lib/puppet/functions/run_task.rb
+- bolt-modules/boltlib/lib/puppet/functions/run_task_with.rb
 - bolt-modules/boltlib/lib/puppet/functions/set_config.rb
 - bolt-modules/boltlib/lib/puppet/functions/set_feature.rb
+- bolt-modules/boltlib/lib/puppet/functions/set_resources.rb
 - bolt-modules/boltlib/lib/puppet/functions/set_var.rb
 - bolt-modules/boltlib/lib/puppet/functions/upload_file.rb
 - bolt-modules/boltlib/lib/puppet/functions/vars.rb
@@ -414,6 +431,7 @@ files:
 - bolt-modules/file/lib/puppet/functions/file/readable.rb
 - bolt-modules/file/lib/puppet/functions/file/write.rb
 - bolt-modules/out/lib/puppet/functions/out/message.rb
+- bolt-modules/prompt/lib/puppet/functions/prompt.rb
 - bolt-modules/system/lib/puppet/functions/system/env.rb
 - exe/bolt
 - lib/bolt.rb
@@ -423,7 +441,6 @@ files:
 - lib/bolt/apply_result.rb
 - lib/bolt/apply_target.rb
 - lib/bolt/bolt_option_parser.rb
-- lib/bolt/boltdir.rb
 - lib/bolt/catalog.rb
 - lib/bolt/catalog/logging.rb
 - lib/bolt/cli.rb
@@ -469,19 +486,19 @@ files:
 - lib/bolt/plugin.rb
 - lib/bolt/plugin/env_var.rb
 - lib/bolt/plugin/module.rb
-- lib/bolt/plugin/pkcs7.rb
 - lib/bolt/plugin/prompt.rb
 - lib/bolt/plugin/puppetdb.rb
 - lib/bolt/plugin/task.rb
+- lib/bolt/project.rb
 - lib/bolt/puppetdb.rb
 - lib/bolt/puppetdb/client.rb
 - lib/bolt/puppetdb/config.rb
 - lib/bolt/r10k_log_proxy.rb
 - lib/bolt/rerun.rb
+- lib/bolt/resource_instance.rb
 - lib/bolt/result.rb
 - lib/bolt/result_set.rb
 - lib/bolt/secret.rb
-- lib/bolt/secret/base.rb
 - lib/bolt/shell.rb
 - lib/bolt/shell/bash.rb
 - lib/bolt/shell/bash/tmpdir.rb
@@ -502,6 +519,7 @@ files:
 - lib/bolt/transport/simple.rb
 - lib/bolt/transport/ssh.rb
 - lib/bolt/transport/ssh/connection.rb
+- lib/bolt/transport/ssh/exec_connection.rb
 - lib/bolt/transport/winrm.rb
 - lib/bolt/transport/winrm/connection.rb
 - lib/bolt/util.rb
@@ -528,6 +546,7 @@ files:
 - lib/bolt_spec/plans.rb
 - lib/bolt_spec/plans/action_stubs.rb
 - lib/bolt_spec/plans/action_stubs/command_stub.rb
+- lib/bolt_spec/plans/action_stubs/plan_stub.rb
 - lib/bolt_spec/plans/action_stubs/script_stub.rb
 - lib/bolt_spec/plans/action_stubs/task_stub.rb
 - lib/bolt_spec/plans/action_stubs/upload_stub.rb