bolt 0.18.2 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5705a6c7d44fd856ef5bf240252574ddb823a336
-  data.tar.gz: 70027049c0bb060a5b04bd7a9ca5b00772466fc4
+  metadata.gz: a2227748b6143c5d3515d1c9f24faaf212eb30b7
+  data.tar.gz: 5547e32cf4a0d588a201c4b011bb2c9fffae983f
 SHA512:
-  metadata.gz: 032844c9618c04162ef3bfe3e4ae6eade64f952478906d6b02539d57fd6e4325d38f35ba818e6ff1fb42fa3fd2e7f01a25527666b68560038a0c479a5ec39dfd
-  data.tar.gz: b9df84d3b06f1d24d1c554cd5631f381356b2e0cadcbe2c2685b3b6fe610ca237611877148d5ff7f90064fc08d9925d53bfef6a0c85f0f3f5c516fc6216eb4ca
+  metadata.gz: 4c628c28a11c9779918352684e2ce04ab3ff078ede27694f669312d63ac9329e1538ee870bb8238efb1cc81a8b2ef1e6d44af92f550173fe16f2d274cd1d0de1
+  data.tar.gz: c0fdcf6f47139a80565fe393f9ad079dac585dab2cc5b490ea1db5e526be898878e0e544d0704504ca09a5ecfa9471611764f0089ea9610b2e64f2f0c49d11e5

data/bolt-modules/boltlib/lib/puppet/functions/run_plan.rb

@@ -47,7 +47,17 @@ Puppet::Functions.create_function(:run_plan, Puppet::Functions::InternalFunction
       end
 
       begin
-        result = func.class.dispatcher.dispatchers[0].call_by_name_with_scope(scope, params, true)
+        # If the plan does not throw :return by calling the return function it's result is
+        # undef/nil
+        result = catch(:return) do
+          func.class.dispatcher.dispatchers[0].call_by_name_with_scope(scope, params, true)
+          nil
+        end&.value
+        # Validate the result is a PlanResult
+        unless Puppet::Pops::Types::TypeParser.singleton.parse('Boltlib::PlanResult').instance?(result)
+          raise Bolt::InvalidPlanResult.new(plan_name, result.to_s)
+        end
+        result
       rescue Puppet::PreformattedError => err
         if named_args['_catch_errors'] && err.cause.is_a?(Bolt::Error)
           result = err.cause.to_puppet_error

data/bolt-modules/boltlib/types/planresult.pp

@@ -0,0 +1,5 @@
+# A Planresult describes the supported return values of a plan. It
+# should be used as the return type of functions that run plans and return the
+# results.
+
+type Boltlib::PlanResult = Variant[Boolean, Numeric, String, Undef, Error, Result, ResultSet, Target, Array[Boltlib::PlanResult], Hash[String, Boltlib::PlanResult]]

data/lib/bolt/error.rb

@@ -73,4 +73,13 @@ module Bolt
       new(err.msg, err.kind, err.details, err.issue_code)
     end
   end
+
+  class InvalidPlanResult < Error
+    def initialize(plan_name, result_str)
+      super("Plan #{plan_name} returned an invalid result: #{result_str}",
+            'bolt/invalid-plan-result',
+            { 'plan_name' => plan_name,
+              'result_string' => result_str })
+    end
+  end
 end

data/lib/bolt/inventory/group.rb

@@ -52,7 +52,6 @@ module Bolt
         if node_names.include?(@name)
           raise ValidationError.new("Group #{@name} conflicts with node of the same name", @name)
         end
-        raise ValidationError.new("Group #{@name} is too deeply nested", @name) if depth > 1
 
         check_deprecated_config('Group', @name, @config)
 
@@ -129,7 +128,7 @@ module Bolt
           # Shallow merge instead of deep merge so that vars with a hash value
           # are assigned a new hash, rather than merging the existing value
           # with the value meant to replace it
-          'vars'   => data2['vars'].merge(data1['vars']),
+          'vars'   => data1['vars'].merge(data2['vars']),
           'facts'  => Bolt::Util.deep_merge(data1['facts'], data2['facts']),
           'groups' => data2['groups'] + data1['groups']
         }

data/lib/bolt/outputter/human.rb

@@ -163,8 +163,10 @@ module Bolt
 
       # @param [Hash] A hash representing the plan result
       def print_plan_result(result)
-        # If the object has a json representation display it
-        if result.respond_to?(:to_json)
+        if result.nil?
+          @stream.puts("Plan completed successfully with no result")
+        # Otherwise if object has a json representation display it
+        elsif result.respond_to?(:to_json)
           # Guard against to_json methods that don't accept options
           # and don't print empty results on multiple lines
           if result.method(:to_json).arity == 0 ||

data/lib/bolt/pal.rb

@@ -43,12 +43,13 @@ module Bolt
       Bolt::ResultSet.include_iterable
     end
 
-    # Create a top-level alias for TargetSpec so that users don't have to
+    # Create a top-level alias for TargetSpec and PlanResult so that users don't have to
     # namespace it with Boltlib, which is just an implementation detail. This
-    # allows TargetSpec to feel like a built-in type in bolt, rather than
+    # allows them to feel like a built-in type in bolt, rather than
     # something has been, no pun intended, "bolted on".
-    def add_target_spec(compiler)
+    def alias_types(compiler)
       compiler.evaluate_string('type TargetSpec = Boltlib::TargetSpec')
+      compiler.evaluate_string('type PlanResult = Boltlib::PlanResult')
     end
 
     def full_modulepath(modulepath)
@@ -61,7 +62,7 @@ module Bolt
     def in_bolt_compiler
       r = Puppet::Pal.in_tmp_environment('bolt', modulepath: full_modulepath(@config[:modulepath]), facts: {}) do |pal|
         pal.with_script_compiler do |compiler|
-          add_target_spec(compiler)
+          alias_types(compiler)
           begin
             yield compiler
           rescue Puppet::PreformattedError => err

data/lib/bolt/transport/orch.rb

@@ -11,7 +11,9 @@ module Bolt
   module Transport
     class Orch < Base
       CONF_FILE = File.expand_path('~/.puppetlabs/client-tools/orchestrator.conf')
-      BOLT_MOCK_TASK = Struct.new(:name, :executable).new('bolt', 'bolt/tasks/init').freeze
+      BOLT_COMMAND_TASK = Struct.new(:name).new('bolt_shim::command').freeze
+      BOLT_SCRIPT_TASK = Struct.new(:name).new('bolt_shim::script').freeze
+      BOLT_UPLOAD_TASK = Struct.new(:name).new('bolt_shim::upload').freeze
 
       def self.options
         %w[service-url cacert token-file task-environment local-validation]
@@ -79,11 +81,10 @@ module Bolt
 
       def batch_command(targets, command, options = {}, &callback)
         params = {
-          action: 'command',
           command: command
         }
         results = run_task_job(targets,
-                               BOLT_MOCK_TASK,
+                               BOLT_COMMAND_TASK,
                                params,
                                options,
                                &callback)
@@ -98,12 +99,11 @@ module Bolt
         content = File.open(script, &:read)
         content = Base64.encode64(content)
         params = {
-          action: 'script',
           content: content,
           arguments: arguments
         }
         callback ||= proc {}
-        results = run_task_job(targets, BOLT_MOCK_TASK, params, options, &callback)
+        results = run_task_job(targets, BOLT_SCRIPT_TASK, params, options, &callback)
         results.map! { |result| unwrap_bolt_result(result.target, result) }
         results.each do |result|
           callback.call(type: :node_result, result: result)
@@ -115,13 +115,12 @@ module Bolt
         content = Base64.encode64(content)
         mode = File.stat(source).mode
         params = {
-          action: 'upload',
           path: destination,
           content: content,
           mode: mode
         }
         callback ||= proc {}
-        results = run_task_job(targets, BOLT_MOCK_TASK, params, options, &callback)
+        results = run_task_job(targets, BOLT_UPLOAD_TASK, params, options, &callback)
         results.map! do |result|
           if result.error_hash
             result

data/lib/bolt/version.rb

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

data/modules/aggregate/plans/count.pp

@@ -31,5 +31,5 @@ plan aggregate::count(
     run_script($script, $nodes, $params)
   }
 
-  aggregate::count($res)
+  return aggregate::count($res)
 }

data/modules/aggregate/plans/nodes.pp

@@ -31,5 +31,5 @@ plan aggregate::nodes(
     run_script($script, $nodes, $params)
   }
 
-  aggregate::nodes($res)
+  return aggregate::nodes($res)
 }

data/modules/canary/plans/init.pp

@@ -48,5 +48,5 @@ plan canary(
     $restr = canary::skip($rest)
   }
 
-  canary::merge($canr, $restr)
+  return canary::merge($canr, $restr)
 }

data/modules/facts/plans/info.pp

@@ -5,7 +5,7 @@
 # The $nodes parameter is a list of the nodes for which to print the OS
 # information.
 plan facts::info(TargetSpec $nodes) {
-  run_plan(facts::retrieve, nodes => $nodes).reduce([]) |$info, $r| {
+  return run_plan(facts::retrieve, nodes => $nodes).reduce([]) |$info, $r| {
     if ($r.ok) {
       $info + "${r.target.name}: ${r[os][name]} ${r[os][release][full]} (${r[os][family]})"
     } else {

data/modules/facts/plans/init.pp

@@ -12,5 +12,5 @@ plan facts(TargetSpec $nodes) {
     }
   }
 
-  $result_set
+  return $result_set
 }

data/modules/facts/plans/retrieve.pp

@@ -21,7 +21,7 @@ plan facts::retrieve(TargetSpec $nodes) {
 
   # Return a single result set composed of results from the result sets
   # returned by the individual task runs.
-  ResultSet(
+  return ResultSet(
     $task_targets.map |$task, $targets| {
       run_task($task, $targets, '_catch_errors' => true)
     }.reduce([]) |$results, $result_set| {

data/modules/facts/tasks/powershell.ps1

@@ -5,8 +5,11 @@ if (Get-Command facter -ErrorAction SilentlyContinue) {
     facter --json
 }
 else {
+    # The number 2 in the condition below is the value of
+    # the [System.PlatformID]::Win32NT constant. We don't
+    # use the constant here as it doesn't work on Windows
+    # Server Core.
     if ([System.Environment]::OSVersion.Platform -gt 2) {
-        # [System.PlatformID]::Win32NT
         @'
 {
   "_error": {
@@ -24,24 +27,16 @@ else {
         $os = Get-CimInstance Win32_OperatingSystem -ErrorAction SilentlyContinue
         $consumerrel = $os.ProductType -eq '1'
 
-        if ($version -eq '10.0') {
-            $release = if ($consumerrel) { '10' } else { '2016' }
-        }
-        elseif ($version -eq '6.3') {
-            $release = if ($consumerrel) { '8.1' } else { '2012 R2' }
-        }
-        elseif ($version -eq '6.2') {
-            $release = if ($consumerrel) { '8' } else { '2012' }
-        }
-        elseif ($version -eq '6.1') {
-            $release = if ($consumerrel) { '7' } else { '2008 R2' }
-        }
-        elseif ($version -eq '6.0') {
-            $release = if ($consumerrel) { 'Vista' } else { '2008' }
-        }
-        elseif ($version -eq '5.2') {
-            $release = if ($consumerrel) { 'XP' } else {
-                if ($os.OtherTypeDescription -eq 'R2') { '2003 R2' } else { '2003' }
+        $release = switch($version){
+            '10.0'{ if ($consumerrel) { '10' } else { '2016' } }
+            '6.3' { if ($consumerrel) { '8.1' } else { '2012 R2' } }
+            '6.2' { if ($consumerrel) { '8' } else { '2012' } }
+            '6.1' { if ($consumerrel) { '7' } else { '2008 R2' } }
+            '6.0' { if ($consumerrel) { 'Vista' } else { '2008' } }
+            '5.2' { 
+                if ($consumerrel) { 'XP' } else {
+                    if ($os.OtherTypeDescription -eq 'R2') { '2003 R2' } else { '2003' }
+                }
             }
         }
 

data/modules/package/tasks/init.json

@@ -0,0 +1,22 @@
+{
+  "description": "Manage and inspect the state of packages",
+  "input_method": "stdin",
+  "parameters": {
+    "action": {
+      "description": "The operation (install, status, uninstall and upgrade) to perform on the package",
+      "type": "Enum[install, status, uninstall, upgrade]"
+    },
+    "name": {
+      "description": "The name of the package to be manipulated",
+      "type": "String[1]"
+    },
+    "version": {
+      "description": "Version numbers must match the full version to install, including release if the provider uses a release moniker. Ranges or semver patterns are not accepted except for the gem package provider. For example, to install the bash package from the rpm bash-4.1.2-29.el6.x86_64.rpm, use the string '4.1.2-29.el6'.",
+      "type": "Optional[String[1]]"
+    },
+    "provider": {
+      "description": "The provider to use to manage or inspect the package, defaults to the system package manager",
+      "type": "Optional[String[1]]"
+    }
+  }
+}

data/modules/package/tasks/init.rb

@@ -0,0 +1,69 @@
+#!/opt/puppetlabs/puppet/bin/ruby
+require 'puppet'
+# Required to find pluginsync'd plugins
+Puppet.initialize_settings
+require 'json'
+
+def install(provider, _version)
+  if !([:absent, :purged] & Array(provider.properties[:ensure])).empty?
+    provider.install
+    provider.flush
+    { status: 'installed', version: Array(provider.properties[:ensure]).join(', ') }
+  else
+    { status: 'present', version: Array(provider.properties[:ensure]).join(', ') }
+  end
+end
+
+def status(provider, _version)
+  version = Array(provider.properties[:ensure])
+  if !([:absent, :purged] & version).empty?
+    { status: 'absent', version: version }
+  elsif provider.respond_to?(:latest)
+    latest = provider.latest
+    if !version.include?(latest)
+      { status: 'out of date', version: version.join(', '), latest: latest }
+    else
+      { status: 'up to date', version: version.join(', ') }
+    end
+  else
+    { status: 'unknown', version: version.join(', ') }
+  end
+end
+
+def uninstall(provider, _version)
+  if !([:absent, :purged] & Array(provider.properties[:ensure])).empty?
+    { status: 'absent' }
+  else
+    provider.uninstall
+    provider.flush
+    { status: 'uninstalled' }
+  end
+end
+
+def upgrade(provider, version)
+  old_version = Array(provider.properties[:ensure])
+  provider.resource[:ensure] = version unless version.nil?
+  provider.update
+  provider.flush
+  { old_version: old_version.join(', '), version: Array(provider.properties[:ensure]).join(', ') }
+end
+
+params = JSON.parse(STDIN.read)
+name = params['name']
+provider = params['provider']
+action = params['action']
+version = params['version']
+
+opts = { name: name }
+opts[:provider] = provider if provider
+
+begin
+  provider = Puppet::Type.type(:package).new(opts).provider
+
+  result = send(action, provider, version)
+  puts result.to_json
+  exit 0
+rescue Puppet::Error => e
+  puts({ status: 'failure', error: e.message }.to_json)
+  exit 1
+end

data/modules/puppet_conf/tasks/init.json

@@ -0,0 +1,22 @@
+{
+  "description": "Inspect puppet agent configuration settings",
+  "input_method": "stdin",
+  "parameters": {
+    "action": {
+      "description": "The operation (get, set) to perform on the configuration setting",
+      "type": "Enum[get, set]"
+    },
+    "section": {
+      "description": "The section of the config file. Defaults to main",
+      "type": "Optional[String[1]]"
+    },
+    "setting": {
+      "description": "The name of the config entry to set/get",
+      "type": "String[1]"
+    },
+     "value": {
+      "description": "The value you are setting. Only required for set",
+      "type": "Optional[String[1]]"
+    }
+  }
+}

data/modules/puppet_conf/tasks/init.rb

@@ -0,0 +1,43 @@
+#!/opt/puppetlabs/puppet/bin/ruby
+require 'json'
+require 'open3'
+require 'puppet'
+
+def set(setting, section, value)
+  cmd = %w[puppet config set]
+  cmd += ['--section', section] if section
+  cmd += [setting, value]
+  _stdout, stderr, status = Open3.capture3(*cmd)
+  raise Puppet::Error, stderr if status != 0
+  { status: value, setting: setting, section: section }
+end
+
+def get(setting, section, _value)
+  cmd = %w[puppet config print]
+  cmd += ['--section', section]
+  cmd += [setting]
+  stdout, stderr, status = Open3.capture3(*cmd)
+  raise Puppet::Error, stderr if status != 0
+  { status: stdout.strip, setting: setting, section: section }
+end
+
+params = JSON.parse(STDIN.read)
+action = params['action']
+setting = params['setting']
+section = params['section']
+value = params['value']
+section = 'main' if section.nil?
+
+begin
+  result = if action == 'get'
+             get(setting, section, value)
+           else
+             raise Puppet::Error, 'You must pass a value argument' if value.nil?
+             set(setting, section, value)
+           end
+  puts result.to_json
+  exit 0
+rescue Puppet::Error => e
+  puts({ status: 'failure', error: e.message }.to_json)
+  exit 1
+end

data/modules/service/tasks/init.json

@@ -0,0 +1,18 @@
+{
+  "description": "Manage and inspect the state of services",
+  "input_method": "stdin",
+  "parameters": {
+    "action": {
+      "description": "The operation (start, stop, restart, enable, disable, status) to perform on the service",
+      "type": "Enum[start, stop, restart, enable, disable, status]"
+    },
+    "name": {
+      "description": "The name of the service to operate on.",
+      "type": "String[1]"
+    },
+    "provider": {
+      "description": "The provider to use to manage or inspect the service, defaults to the system service manager",
+      "type": "Optional[String[1]]"
+    }
+  }
+}

data/modules/service/tasks/init.rb

@@ -0,0 +1,71 @@
+#!/opt/puppetlabs/puppet/bin/ruby
+
+require 'puppet'
+
+def start(provider)
+  if provider.status == :running
+    { status: 'in_sync' }
+  else
+    provider.start
+    { status: 'started' }
+  end
+end
+
+def stop(provider)
+  if provider.status == :stopped
+    { status: 'in_sync' }
+  else
+    provider.stop
+    { status: 'stopped' }
+  end
+end
+
+def restart(provider)
+  provider.restart
+
+  { status: 'restarted' }
+end
+
+def status(provider)
+  { status: provider.status, enabled: provider.enabled? }
+end
+
+def enable(provider)
+  if provider.enabled?.to_s == 'true'
+    { status: 'in_sync' }
+  else
+    provider.enable
+    { status: 'enabled' }
+  end
+end
+
+def disable(provider)
+  if provider.enabled?.to_s == 'true'
+    provider.disable
+    { status: 'disabled' }
+  else
+    { status: 'in_sync' }
+  end
+end
+
+params = JSON.parse(STDIN.read)
+name = params['name']
+provider = params['provider']
+action = params['action']
+
+opts = { name: name }
+opts[:provider] = provider if provider
+
+begin
+  provider = Puppet::Type.type(:service).new(opts).provider
+
+  result = send(action, provider)
+  puts result.to_json
+  exit 0
+rescue Puppet::Error => e
+  puts({ status: 'failure',
+         _error: { msg: e.message,
+                   kind: 'puppet_error',
+                   details: {} } }.to_json)
+  exit 1
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 0.18.2
+  version: 0.19.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-04 00:00:00.000000000 Z
+date: 2018-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -151,25 +151,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: gettext-setup
+  name: fast_gettext
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1'
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 1.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1'
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 1.1.2
 - !ruby/object:Gem::Dependency
   name: locale
   requirement: !ruby/object:Gem::Requirement
@@ -334,6 +328,7 @@ files:
 - bolt-modules/boltlib/lib/puppet/functions/run_task.rb
 - bolt-modules/boltlib/lib/puppet/functions/set_var.rb
 - bolt-modules/boltlib/lib/puppet/functions/vars.rb
+- bolt-modules/boltlib/types/planresult.pp
 - bolt-modules/boltlib/types/targetspec.pp
 - exe/bolt
 - exe/bolt-inventory-pdb
@@ -385,7 +380,13 @@ files:
 - modules/facts/tasks/bash.sh
 - modules/facts/tasks/powershell.ps1
 - modules/facts/tasks/ruby.rb
+- modules/package/tasks/init.json
+- modules/package/tasks/init.rb
+- modules/puppet_conf/tasks/init.json
+- modules/puppet_conf/tasks/init.rb
 - modules/puppetdb_fact/plans/init.pp
+- modules/service/tasks/init.json
+- modules/service/tasks/init.rb
 - vendored/facter/lib/facter.rb
 - vendored/facter/lib/facter/Cfkey.rb
 - vendored/facter/lib/facter/application.rb