bolt 1.31.1 → 1.32.0

data/lib/bolt/target.rb

@@ -1,8 +1,154 @@
 # frozen_string_literal: true
 
 require 'bolt/error'
+require 'bolt/util'
 
 module Bolt
+  class Target2
+    attr_accessor :inventory
+
+    # Target.new from a plan initialized with a hash
+    def self.from_asserted_hash(hash)
+      inventory = Puppet.lookup(:bolt_inventory)
+      inventory.create_target_from_plan(hash)
+    end
+
+    # Target.new from a plan with just a uri
+    # rubocop:disable UnusedMethodArgument
+    def self.from_asserted_args(uri = nil,
+                                name = nil,
+                                target_alias = nil,
+                                config = nil,
+                                facts = nil,
+                                vars = nil,
+                                features = nil,
+                                plugin_hooks = nil)
+      inventory = Puppet.lookup(:bolt_inventory)
+      inventory.create_target_from_plan('uri' => uri)
+    end
+
+    # URI can be passes as nil
+    def initialize(uri = nil,
+                   name = nil,
+                   target_alias = nil,
+                   config = nil,
+                   facts = nil,
+                   vars = nil,
+                   features = nil,
+                   plugin_hooks = nil)
+      @name = name
+    end
+    # rubocop:enable UnusedMethodArgument
+
+    # Used for munging target + group data
+    def target_data_hash
+      {
+        'config' => @inventory.targets[@name]['config'],
+        'vars' => @inventory.targets[@name]['vars'],
+        'facts' => @inventory.targets[@name]['facts'],
+        'features' => @inventory.targets[@name]['features'].to_a,
+        'plugin_hooks' => @inventory.targets[@name]['plugin_hooks'],
+        'name' => @inventory.targets[@name]['name'],
+        'uri' => @inventory.targets[@name]['uri'],
+        'alias' => @inventory.targets[@name]['target_alias']
+      }
+    end
+
+    # features returns an array to be compatible with plans
+    def features
+      @inventory.features(self).to_a
+    end
+
+    # Use feature_set internally to access set
+    def feature_set
+      @inventory.features(self)
+    end
+
+    def vars
+      @inventory.vars(self)
+    end
+
+    def facts
+      @inventory.facts(self)
+    end
+
+    def to_s
+      safe_name
+    end
+
+    def config
+      @inventory.target_config(self)
+    end
+
+    def safe_name
+      @inventory.targets[@name]['safe_name']
+    end
+
+    def target_alias
+      @inventory.targets[@name]['target_alias']
+    end
+
+    def to_h
+      options.merge(
+        'name' => name,
+        'uri' => uri,
+        'protocol' => protocol,
+        'user' => user,
+        'password' => password,
+        'host' => host,
+        'port' => port
+      )
+    end
+
+    def host
+      @inventory.targets[@name]['uri_obj']&.hostname || @inventory.targets[@name]['host']
+    end
+
+    attr_reader :name
+
+    def uri
+      @inventory.targets[@name]['uri']
+    end
+
+    def remote?
+      @inventory.targets[@name]['uri_obj']&.scheme == 'remote' || @inventory.targets[@name]['protocol'] == 'remote'
+    end
+
+    def port
+      @inventory.targets[@name]['uri_obj']&.port || @inventory.targets[@name]['port']
+    end
+
+    # transport is separate from protocol for remote targets.
+    def transport
+      remote? ? 'remote' : protocol
+    end
+
+    def protocol
+      @inventory.targets[@name]['uri_obj']&.scheme || @inventory.targets[@name]['protocol']
+    end
+
+    def user
+      unencode(@inventory.targets[@name]['uri_obj']&.user) || @inventory.targets[@name]['user']
+    end
+
+    def password
+      unencode(@inventory.targets[@name]['uri_obj']&.password) || @inventory.targets[@name]['password']
+    end
+
+    def options
+      @inventory.targets[@name]['options']
+    end
+
+    def plugin_hooks
+      @inventory.targets[@name]['cached_state']['plugin_hooks']
+    end
+
+    def unencode(component)
+      Addressable::URI.unencode_component(component)
+    end
+    private :unencode
+  end
+
   class Target
     attr_reader :options
     # CODEREVIEW: this feels wrong. The altertative is threading inventory through the
@@ -87,6 +233,7 @@ module Bolt
         Set.new
       end
     end
+    alias feature_set features
 
     def plugin_hooks
       if @inventory

data/lib/bolt/task.rb

@@ -73,7 +73,7 @@ module Bolt
     # and any additional files (name and path)
     def select_implementation(target, provided_features = [])
       impl = if (impls = implementations)
-               available_features = target.features + provided_features
+               available_features = target.feature_set + provided_features
                impl = impls.find do |imp|
                  remote_impl = imp['remote']
                  remote_impl = metadata['remote'] if remote_impl.nil?

data/lib/bolt/transport/powershell.rb

@@ -52,16 +52,23 @@ module Bolt
           "[Environment]::SetEnvironmentVariable('#{arg}', @'\n#{val}\n'@)"
         end
 
+        def quote_string(string)
+          "'" + string.gsub("'", "''") + "'"
+        end
+
         def execute_process(path, arguments, stdin = nil)
-          quoted_args = arguments.map do |arg|
-            "'" + arg.gsub("'", "''") + "'"
-          end.join(' ')
+          quoted_args = arguments.map { |arg| quote_string(arg) }.join(' ')
 
+          quoted_path = if path =~ /^'.*'$/ || path =~ /^".*"$/
+                          path
+                        else
+                          quote_string(path)
+                        end
           exec_cmd =
             if stdin.nil?
-              "& #{path} #{quoted_args}"
+              "& #{quoted_path} #{quoted_args}"
             else
-              "@'\n#{stdin}\n'@ | & #{path} #{quoted_args}"
+              "@'\n#{stdin}\n'@ | & #{quoted_path} #{quoted_args}"
             end
           <<-PS
 $OutputEncoding = [Console]::OutputEncoding

data/lib/bolt/transport/winrm.rb

@@ -163,8 +163,7 @@ module Bolt
               if Powershell.powershell_file?(remote_task_path) && stdin.nil?
                 conn.execute(Powershell.run_ps_task(arguments, remote_task_path, input_method))
               else
-                interpreter = select_interpreter(remote_task_path, target.options['interpreters'])
-                if interpreter
+                if (interpreter = select_interpreter(remote_task_path, target.options['interpreters']))
                   path = interpreter
                   args = [remote_task_path]
                 else

data/lib/bolt/version.rb

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

data/lib/bolt_server/schemas/action-run_script.json

@@ -36,7 +36,10 @@
       ]
     },
     "arguments": {
-      "type": "string"
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
     },
     "target": { "$ref": "partial:target-any" }
   },

data/lib/bolt_spec/plans/mock_executor.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'bolt_spec/plans/action_stubs'
+require 'bolt_spec/plans/publish_stub'
 require 'bolt/error'
 require 'bolt/result_set'
 require 'bolt/result'
@@ -25,6 +26,7 @@ module BoltSpec
         @allow_apply = false
         @modulepath = [modulepath].flatten.map { |path| File.absolute_path(path) }
         MOCKED_ACTIONS.each { |action| instance_variable_set(:"@#{action}_doubles", {}) }
+        @stub_out_message = nil
       end
 
       def module_file_id(file)
@@ -99,6 +101,7 @@ module BoltSpec
             doub.assert_called(object)
           end
         end
+        @stub_out_message.assert_called('out::message') if @stub_out_message
       end
 
       MOCKED_ACTIONS.each do |action|
@@ -107,6 +110,10 @@ module BoltSpec
         end
       end
 
+      def stub_out_message
+        @stub_out_message ||= ActionDouble.new(:PublishStub)
+      end
+
       def stub_apply
         @allow_apply = true
       end
@@ -133,6 +140,16 @@ module BoltSpec
 
       def report_apply(_statements, _resources); end
 
+      def publish_event(event)
+        if event[:type] == :message
+          unless @stub_out_message
+            @error_message = "Unexpected call to 'out::message(#{event[:message]})'"
+            raise UnexpectedInvocation, @error_message
+          end
+          @stub_out_message.process(event[:message])
+        end
+      end
+
       # Mocked for Apply so it does not compile and execute.
       def with_node_logging(_description, targets)
         raise "Unexpected call to apply(#{targets})" unless @allow_apply

data/lib/bolt_spec/plans/publish_stub.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'bolt/result'
+require 'bolt/util'
+
+module BoltSpec
+  module Plans
+    class PublishStub < ActionStub
+      def return
+        raise "return is not implemented for out_message"
+      end
+
+      def return_for_targets(_data)
+        raise "return_for_targets is not implemented for out_message"
+      end
+
+      def always_return(_data)
+        raise "always_return is not implemented for out_message"
+      end
+
+      def error_with(_data)
+        raise "error_with is not implemented for out_message"
+      end
+
+      def matches(message)
+        if @invocation[:options] && message != @invocation[:options]
+          return false
+        end
+
+        true
+      end
+
+      def call(_event)
+        @calls += 1
+      end
+
+      def parameters
+        @invocation[:options]
+      end
+
+      # Public methods
+
+      def with_params(params)
+        @invocation[:options] = params
+        self
+      end
+    end
+  end
+end

data/lib/bolt_spec/plans.rb

@@ -63,6 +63,8 @@ require 'bolt/pal'
 # - allow_upload(file), expect_upload(file): expect the identified source file
 # - allow_apply_prep: allows `apply_prep` to be invoked in the plan but does not allow modifiers
 # - allow_apply: allows `apply` to be invoked in the plan but does not allow modifiers
+# - allow_out_message, expect_out_message: expect a message to be passed to out::message (only modifiers are
+#   be_called_times(n), with_params(params), and not_be_called)
 #
 # Stub modifiers:
 # - be_called_times(n): if allowed, fail if the action is called more than 'n' times
@@ -128,6 +130,12 @@ require 'bolt/pal'
 #       end
 #       expect(run_plan('my_plan', { 'param1' => 10 })).to eq(10)
 #     end
+
+#     it 'expects multiple messages to out::message' do
+#       expect_out_message.be_called_times(2).with_params(message)
+#       result = run_plan(plan_name, 'messages' => [message, message])
+#       expect(result).to be_ok
+#     end
 #   end
 #
 # See spec/bolt_spec/plan_spec.rb for more examples.
@@ -172,7 +180,7 @@ module BoltSpec
     end
 
     def run_plan(name, params)
-      pal = Bolt::PAL.new(config.modulepath, config.hiera_config)
+      pal = Bolt::PAL.new(config.modulepath, config.hiera_config, config.boltdir.resource_types)
       result = pal.run_plan(name, params, executor, inventory, puppetdb_client)
 
       if executor.error_message
@@ -221,6 +229,15 @@ module BoltSpec
       nil
     end
 
+    def allow_out_message
+      executor.stub_out_message.add_stub
+    end
+    alias allow_any_out_message allow_out_message
+
+    def expect_out_message
+      allow_out_message.expect_call
+    end
+
     # Example helpers to mock other run functions
     # The with_targets method makes sense for all stubs
     # with_params could be reused for options

data/lib/bolt_spec/run.rb

@@ -110,7 +110,7 @@ module BoltSpec
       else
         begin
           unless File.stat(manifest).readable?
-            raise BOLT::FileError.new("The manifest '#{manifest}' is unreadable", manifest)
+            raise Bolt::FileError.new("The manifest '#{manifest}' is unreadable", manifest)
           end
         rescue Errno::ENOENT
           raise Bolt::FileError.new("The manifest '#{manifest}' does not exist", manifest)
@@ -152,7 +152,10 @@ module BoltSpec
       end
 
       def pal
-        @pal ||= Bolt::PAL.new(config.modulepath, config.hiera_config, config.compile_concurrency)
+        @pal ||= Bolt::PAL.new(config.modulepath,
+                               config.hiera_config,
+                               config.boltdir.resource_types,
+                               config.compile_concurrency)
       end
 
       def resolve_targets(target_spec)

data/lib/plan_executor/app.rb

@@ -39,7 +39,7 @@ module PlanExecutor
       # functional will be making changes to Puppet that remove the need for
       # global Puppet state.
       # https://github.com/puppetlabs/bolt/blob/master/lib/bolt/pal.rb#L166
-      @pal = Bolt::PAL.new(config['modulepath'], nil)
+      @pal = Bolt::PAL.new(config['modulepath'], nil, nil)
 
       @schema = JSON.parse(File.read(File.join(__dir__, 'schemas', 'run_plan.json')))
       @worker = Concurrent::SingleThreadExecutor.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 1.31.1
+  version: 1.32.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-27 00:00:00.000000000 Z
+date: 2019-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -330,6 +330,7 @@ files:
 - bolt-modules/boltlib/lib/puppet/functions/facts.rb
 - bolt-modules/boltlib/lib/puppet/functions/fail_plan.rb
 - bolt-modules/boltlib/lib/puppet/functions/get_resources.rb
+- bolt-modules/boltlib/lib/puppet/functions/get_target.rb
 - bolt-modules/boltlib/lib/puppet/functions/get_targets.rb
 - bolt-modules/boltlib/lib/puppet/functions/puppetdb_fact.rb
 - bolt-modules/boltlib/lib/puppet/functions/puppetdb_query.rb
@@ -337,6 +338,7 @@ 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/set_config.rb
 - bolt-modules/boltlib/lib/puppet/functions/set_feature.rb
 - bolt-modules/boltlib/lib/puppet/functions/set_var.rb
 - bolt-modules/boltlib/lib/puppet/functions/upload_file.rb
@@ -463,6 +465,7 @@ files:
 - lib/bolt_spec/plans/action_stubs/task_stub.rb
 - lib/bolt_spec/plans/action_stubs/upload_stub.rb
 - lib/bolt_spec/plans/mock_executor.rb
+- lib/bolt_spec/plans/publish_stub.rb
 - lib/bolt_spec/run.rb
 - lib/logging_extensions/logging.rb
 - lib/plan_executor/app.rb