(BOLT-994) Task helper for remote resources

Author: da-ar

lib/puppet/util/task_helper.rb

@@ -0,0 +1,39 @@
+require 'puppet'
+require 'json'
+
+# Sets up the transport for a remote task
+class Puppet::Util::TaskHelper
+  def initialize(transport_name)
+    @transport_name = transport_name
+
+    return unless params.key? '_installdir'
+    add_plugin_paths(params['_installdir'])
+  end
+
+  def transport
+    require 'puppet/resource_api/transport'
+
+    Puppet::ResourceApi::Transport.connect(@transport_name, credentials)
+  end
+
+  def params
+    @params ||= JSON.parse(ENV['PARAMS'] || STDIN.read)
+  end
+
+  def target
+    @target ||= params['_target']
+  end
+
+  def credentials
+    @credentials ||= target.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+  end
+
+  private
+
+  # Syncs across anything from the module lib
+  def add_plugin_paths(install_dir)
+    Dir.glob(File.join([install_dir, '*'])).each do |mod|
+      $LOAD_PATH << File.join([mod, 'lib'])
+    end
+  end
+end

spec/unit/puppet/util/task_helper_spec.rb

@@ -0,0 +1,110 @@
+require 'json'
+require 'puppet/util/task_helper'
+require 'puppet/resource_api/transport'
+
+RSpec.describe Puppet::Util::TaskHelper do
+
+  let(:helper) { described_class.new('panos') }
+  let(:params) { {} }
+
+  before(:each) do
+    allow(STDIN).to receive(:read).and_return(JSON.generate(params))
+  end
+
+  it 'does not throw' do
+    expect{helper}.not_to raise_error
+  end
+
+  context 'when `_installdir` is present' do
+    let(:params) do
+      {
+        '_installdir': '.'
+      }
+    end
+    it 'does not throw' do
+      expect{helper}.not_to raise_error
+    end
+  end
+
+  describe '#transport' do
+    let(:creds) do
+      {
+        host: '1.2.3.4',
+        user: 'admin',
+        password: 'admin'
+      }
+    end
+    let(:params) do
+      {
+        '_target': creds
+      }
+    end
+
+    it 'returns a transport object' do
+      expect(Puppet::ResourceApi::Transport).to receive(:connect).with('panos', creds)
+      helper.transport
+    end
+  end
+
+  describe '#params' do
+    context 'when params are provided through STDIN' do
+      let(:params) do
+        {
+          'foo': 'wibble'
+        }
+      end
+      it { expect(helper.params).to eq({"foo"=>"wibble"}) }
+    end
+    context 'when params are provided through ENV' do
+      let(:env) { '{"wibble": "foo"}' }
+
+      it {
+        allow(ENV).to receive(:[]).with('PARAMS').and_return(env)
+        expect(helper.params).to eq({"wibble"=>"foo"})
+      }
+    end
+  end
+
+  describe '#target' do
+    let(:creds) do
+      {
+        host: '1.2.3.4',
+        user: 'admin',
+        password: 'admin'
+      }
+    end
+    let(:params) do
+      {
+        '_target': creds
+      }
+    end
+    it 'returns  the creds with string keys' do
+      expect(helper.target).to eq({
+        "host"=>"1.2.3.4",
+        "password"=>"admin",
+        "user"=>"admin"})
+    end
+  end
+
+  describe '#credentials' do
+    let(:creds) do
+      {
+        host: '1.2.3.4',
+        user: 'admin',
+        password: 'admin'
+      }
+    end
+    let(:params) do
+      {
+        '_target': creds
+      }
+    end
+    it 'returns the creds with symbolised keys' do
+      expect(helper.credentials).to eq({
+        :host=>"1.2.3.4",
+        :password=>"admin",
+        :user=>"admin"})
+    end
+  end
+
+end

tasks/apikey.json

@@ -6,7 +6,7 @@
   "parameters": {
   },
   "files": [
-    "panos/tasks/panos_task.rb",
+    "panos/lib/puppet/util/task_helper.rb",
     "panos/lib/puppet/transport/panos.rb",
     "panos/lib/puppet/transport/schema/panos.rb"
   ]

tasks/apikey.rb

@@ -1,6 +1,6 @@
 #!/opt/puppetlabs/puppet/bin/ruby
 
-require_relative 'panos_task'
-task = PanosTask.new
+require_relative '../lib/puppet/util/task_helper'
+task = Puppet::Util::TaskHelper.new('panos')
 
 puts JSON.generate(apikey: task.transport.apikey)

tasks/commit.json

@@ -6,7 +6,7 @@
   "parameters": {
   },
   "files": [
-    "panos/tasks/panos_task.rb",
+    "panos/lib/puppet/util/task_helper.rb",
     "panos/lib/puppet/transport/panos.rb",
     "panos/lib/puppet/transport/schema/panos.rb"
   ]

tasks/commit.rb

@@ -1,7 +1,7 @@
 #!/opt/puppetlabs/puppet/bin/ruby
 
-require_relative 'panos_task'
-task = PanosTask.new
+require_relative '../lib/puppet/util/task_helper'
+task = Puppet::Util::TaskHelper.new('panos')
 
 if task.transport.outstanding_changes?
   task.transport.commit

tasks/panos_task.rb

@@ -14,7 +14,7 @@
     }
   },
   "files": [
-    "panos/tasks/panos_task.rb",
+    "panos/lib/puppet/util/task_helper.rb",
     "panos/lib/puppet/transport/panos.rb",
     "panos/lib/puppet/transport/schema/panos.rb"
   ]

tasks/set_config.json

@@ -1,7 +1,7 @@
 #!/opt/puppetlabs/puppet/bin/ruby
 
-require_relative 'panos_task'
-task = PanosTask.new
+require_relative '../lib/puppet/util/task_helper'
+task = Puppet::Util::TaskHelper.new('panos')
 
 file = task.params['config_file']
 transport.import(file, 'configuration')