(gh-26) Extract a base ruby Task class from the check.rb task

This will be shared with the configure.rb task.

Author: jpartlow

lib/openvox_bootstrap/task.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module OpenvoxBootstrap
+  # Base class for openvox_bootstrap Ruby tasks.
+  class Task
+    # Run the task and print the result as JSON.
+    def self.run
+      params = JSON.parse($stdin.read)
+      raise(ArgumentError, <<~ERR) unless params.is_a?(Hash)
+        Expected a Hash, got #{params.class}: #{params.inspect}
+      ERR
+
+      params.transform_keys!(&:to_sym)
+      # Clean out empty params so that task defaults are used.
+      params.delete_if { |_, v| v.nil? || v == '' }
+
+      result = new.task(**params)
+      puts JSON.pretty_generate(result)
+
+      result
+    end
+  end
+end

spec/lib/contexts.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'json'
-
 # Mirrors the output from puppetlabs-facts.
 module OBRspecFacts
   UBUNTU_2404 = {
@@ -130,3 +128,24 @@ def mock_facts_task_bash_sh(os)
     EOF
   end
 end
+
+RSpec.shared_context 'task_run_helpers' do
+  def validate_task_run_for(subject, input:, expected: {}, code: 0)
+    old_stdin = $stdin
+    $stdin = StringIO.new(input.to_json)
+    old_stdout = $stdout
+    $stdout = StringIO.new
+
+    begin
+      subject.run
+    rescue SystemExit => e
+      expect(e.status).to eq(code)
+    end
+
+    output = JSON.parse($stdout.string, symbolize_names: true)
+    expect(output).to eq(expected)
+  ensure
+    $stdin = old_stdin
+    $stdout = old_stdout
+  end
+end

spec/tasks/check_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
+require 'lib/contexts'
 require_relative '../../tasks/check'
 
 describe 'openvox_bootstrap::check' do
@@ -9,6 +10,8 @@
   end
 
   describe '.run' do
+    include_context 'task_run_helpers'
+
     let(:input) do
       {
         version: nil
@@ -21,23 +24,8 @@
       }
     end
 
-    def validate_task_run(input:, expected: {}, code: 0)
-      old_stdin = $stdin
-      $stdin = StringIO.new(input.to_json)
-      old_stdout = $stdout
-      $stdout = StringIO.new
-
-      begin
-        OpenvoxBootstrap::Check.run
-      rescue SystemExit => e
-        expect(e.status).to eq(code)
-      end
-
-      output = JSON.parse($stdout.string, symbolize_names: true)
-      expect(output).to eq(expected)
-    ensure
-      $stdin = old_stdin
-      $stdout = old_stdout
+    def validate_task_run(input:, expected:, code: 0)
+      validate_task_run_for(OpenvoxBootstrap::Check, input: input, expected: expected, code: code)
     end
 
     it 'raises for empty input' do

spec/unit/openvox_bootstrap/task_spec.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'lib/contexts'
+require 'openvox_bootstrap/task'
+
+class OpenvoxBootstrap::TaskTester < OpenvoxBootstrap::Task
+  def task(foo:, baz: 'default')
+    {
+      foo: foo,
+      baz: baz,
+    }
+  end
+end
+
+describe 'openvox_bootstrap::task' do
+  describe '.run' do
+    include_context 'task_run_helpers'
+
+    let(:input) { { foo: 'bar', baz: 'dingo' } }
+    let(:expected_output) do
+      {
+        foo: 'bar',
+        baz: 'dingo',
+      }
+    end
+    let(:tester) { OpenvoxBootstrap::TaskTester }
+
+    it 'raises for empty input' do
+      expect do
+        validate_task_run_for(tester, input: nil)
+      end.to raise_error(ArgumentError)
+    end
+
+    it 'returns the task result' do
+      validate_task_run_for(tester, input: input, expected: expected_output)
+    end
+
+    it 'uses default values for missing params' do
+      input[:baz] = nil
+      expected_output[:baz] = 'default'
+      validate_task_run_for(tester, input: input, expected: expected_output)
+    end
+  end
+end

tasks/check.json

@@ -15,13 +15,18 @@
     {
       "name": "check.rb",
       "input_method": "stdin",
-      "requirements": ["puppet-agent"]
+      "requirements": ["puppet-agent"],
+      "files": [
+        "openvox_bootstrap/lib/openvox_bootstrap/task.rb",
+        "openvox_bootstrap/tasks/check.rb"
+      ]
     },
     {
       "name": "check_linux.sh",
       "input_method": "environment",
       "requirements": ["shell"],
       "files": [
+        "openvox_bootstrap/lib/openvox_bootstrap/task.rb",
         "openvox_bootstrap/tasks/check.rb"
       ]
     }

tasks/check.rb

@@ -1,10 +1,10 @@
 #! /opt/puppetlabs/puppet/bin/ruby
 # frozen_string_literal: true
 
-require 'json'
+require_relative '../lib/openvox_bootstrap/task'
 
 module OpenvoxBootstrap
-  class Check
+  class Check < Task
     # Get the Puppet version from the installed Puppet library.
     #
     # "require 'puppet/version'" can be fooled by the Ruby environment
@@ -22,17 +22,7 @@ def self.puppet_version
 
     # Run the task and print the result as JSON.
     def self.run
-      params = JSON.parse($stdin.read)
-      raise(ArgumentError, <<~ERR) unless params.is_a?(Hash)
-        Expected a Hash, got #{params.class}: #{params.inspect}
-      ERR
-
-      params.transform_keys!(&:to_sym)
-      # Clean out empty params so that task defaults are used.
-      params.delete_if { |_, v| v.nil? || v == '' }
-
-      result = Check.new.task(**params)
-      puts JSON.pretty_generate(result)
+      result = super
       result[:valid] ? exit(0) : exit(1)
     end