Add bolt task to return unit state in a more parsable way

.gitignore

@@ -21,3 +21,5 @@
 .*.sw?
 /.yardoc/
 /Guardfile
+bolt-debug.log
+.rerun.json

README.md

@@ -10,12 +10,11 @@
 [![Apache-2 License](https://img.shields.io/github/license/voxpupuli/puppet-systemd.svg)](LICENSE)
 [![Donated by Camptocamp](https://img.shields.io/badge/donated%20by-camptocamp-fb7047.svg)](#transfer-notice)
 
-
 ## Overview
 
 This module declares exec resources to create global sync points for reloading systemd.
 
-**Version 2 and newer of the module don't work with Hiera 3! You need to migrate your existing Hiera setup to Hiera 5**
+### Version 2 and newer of the module don't work with Hiera 3! You need to migrate your existing Hiera setup to Hiera 5
 
 ## Usage and examples
 
@@ -181,6 +180,7 @@ file { '/etc/tmpfiles.d/foo.conf':
 ```
 
 ### timer units
+
 Create a systemd timer unit and a systemd service unit to execute from
 that timer
 
@@ -339,7 +339,8 @@ class { 'systemd':
 ```
 
 will stop the service and should also copy `/run/systemd/resolve/resolv.conf` to `/etc/resolve.conf`.
-* Writing your own file to `/etc/resolv.conf` is also possible.
+
+- Writing your own file to `/etc/resolv.conf` is also possible.
 
 It is possible to configure the default ntp servers in `/etc/systemd/timesyncd.conf`:
 
@@ -356,8 +357,6 @@ systemd-resolved will only occur on second puppet run after that installation.
 
 This requires [puppetlabs-inifile](https://forge.puppet.com/puppetlabs/inifile), which is only a soft dependency in this module (you need to explicitly install it). Both parameters accept a string or an array.
 
-
-
 ### Resource Accounting
 
 Systemd has support for different accounting option. It can track
@@ -376,6 +375,7 @@ class { 'systemd':
   }
 }
 ```
+
 ### journald configuration
 
 It also allows you to manage journald settings. You can manage journald settings through setting the `journald_settings` parameter. If you want a parameter to be removed, you can pass its value as params.
@@ -424,7 +424,8 @@ systemd::udev::rule:
 ```
 
 ### oomd configuration
-The `systemd-oomd `system can be configured.
+
+The `systemd-oomd` system can be configured.
 
 ```puppet
 class { 'systemd':
@@ -439,7 +440,8 @@ class { 'systemd':
 ```
 
 ### coredump configuration
-The `systemd-coredump `system can be configured.
+
+The `systemd-coredump` system can be configured.
 
 ```puppet
 class{'systemd':
@@ -483,43 +485,86 @@ loginctl_user { 'foo':
 or as a hash via the `systemd::loginctl_users` parameter.
 
 ### Systemd Escape Function
+
 Partially escape strings as `systemd-escape` command does.
 
 This functions only escapes a subset of chars. Non-ASCII character will not escape.
 
 ```puppet
 $result = systemd::escape('foo::bar/')
 ```
+
 `$result` would be `foo::bar-`
 
 or path escape as if with `-p` option.
 
 ```puppet
 $result = systemd::escape('/mnt/foobar/', true)
 ```
+
 `$result` would be `mnt-foobar`.
 
 ### Systemd Escape Function (uses systemd-escape)
+
 Escape strings call the `systemd-escape` command in the background.
 
 It's highly recommend running the function as [deferred function](https://puppet.com/docs/puppet/6/deferring_functions.html) since it executes the command on the agent.
 
 ```puppet
 $result = Deferred('systemd::systemd_escape', ["foo::bar"])
 ```
+
 `$result` would be `foo::bar-`
 
 or path escape as if with `-p` option.
 
 ```puppet
 $result = Deferred('systemd::systemd_escape', ["/mnt/foo-bar/", true])
 ```
+
 `$result` would be `mnt-foo\x2dbar`.
 
+## Tasks
+
+### systemd::systemctl_show
+
+Returns more parseable output then the standard service task from bolt itself.
+
+Default property filter: `["ActiveState", "LoadState", "MainPID", "SubState", "UnitFileState"]`
+
+#### output of standard task from bolt
+
+```text
+bolt task run service name=puppet.service action=status -t controller-0
+
+Started on controller-0...
+Finished on controller-0:
+  {
+    "status": "MainPID=686,LoadState=loaded,ActiveState=active",
+    "enabled": "enabled"
+  }
+```
+
+#### output of systemd::systemctl_show
+
+```text
+bolt task run systemd::systemctl_show unit_name=puppet.service -t controller-0
+
+Started on controller-0...
+Finished on controller-0:
+  {
+    "MainPID": "686",
+    "LoadState": "loaded",
+    "ActiveState": "active",
+    "SubState": "running",
+    "UnitFileState": "enabled"
+  }
+```
+
 ## Transfer Notice
 
 This plugin was originally authored by [Camptocamp](http://www.camptocamp.com).
 The maintainer preferred that Puppet Community take ownership of the module for future improvement and maintenance.
 Existing pull requests and issues were transferred over, please fork and continue to contribute here instead of Camptocamp.
 
-Previously: https://github.com/camptocamp/puppet-systemd
+Previously: [https://github.com/camptocamp/puppet-systemd]

REFERENCE.md

@@ -75,6 +75,10 @@
 * [`Systemd::Unit::Timespan`](#Systemd--Unit--Timespan): Timer specification for systemd time spans, e.g. timers.
 * [`Systemd::Unit::Unit`](#Systemd--Unit--Unit): Possible keys for the [Unit] section of a unit file
 
+### Tasks
+
+* [`systemctl_show`](#systemctl_show): Get systemctl show output of a unit
+
 ## Classes
 
 ### <a name="systemd"></a>`systemd`
@@ -2931,3 +2935,31 @@ Struct[{
   }]
 ```
 
+## Tasks
+
+### <a name="systemctl_show"></a>`systemctl_show`
+
+Get systemctl show output of a unit
+
+**Supports noop?** false
+
+#### Parameters
+
+##### `bin_path`
+
+Data type: `String[1]`
+
+Path to systemctl binary
+
+##### `properties`
+
+Data type: `Array[String[1]]`
+
+Properties to retrieve from the unit
+
+##### `unit_name`
+
+Data type: `String[1]`
+
+Name of the unit
+

tasks/systemctl_show.json

@@ -0,0 +1,20 @@
+{
+  "description": "Get systemctl show output of a unit",
+  "input_method": "stdin",
+  "parameters": {
+    "bin_path": {
+      "description": "Path to systemctl binary",
+      "type": "String[1]",
+      "default": "/usr/bin/systemctl"
+    },
+    "properties": {
+      "description": "Properties to retrieve from the unit",
+      "type": "Array[String[1]]",
+      "default": ["ActiveState", "LoadState", "MainPID", "SubState", "UnitFileState"]
+    },
+    "unit_name": {
+      "description": "Name of the unit",
+      "type": "String[1]"
+    }
+  }
+}

tasks/systemctl_show.rb

@@ -0,0 +1,15 @@
+#!/opt/puppetlabs/puppet/bin/ruby
+# frozen_string_literal: true
+
+require 'json'
+require 'open3'
+
+params  = JSON.parse($stdin.read)
+
+systemctl_cmd = params['bin_path']
+systemctl_args = ['show', '--no-pager', '--no-legend', '--property', params['properties'].join(','), params['unit_name']]
+output, status = Open3.capture2(systemctl_cmd, *systemctl_args)
+
+raise "Error running systemctl show: #{output}" unless status.success?
+
+puts output.split("\n").to_h { |item| item.split('=', 2) }.to_json