(FM-7602) Fix APIKey task for Transport

The APIKey task schema has been updated to accept a credentials file, as per other tasks.

Author: Will Meek

spec/acceptance/tasks/apikey_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper_acceptance'
+require 'json'
+
+describe 'API Key task' do
+  before(:each) do
+    params = {
+      'credentials_file' => credentials,
+    }
+    ENV['PARAMS'] = JSON.generate(params)
+  end
+
+  let(:result) do
+    puts "Executing apikey.rb task with `#{ENV['PARAMS']}`" if debug_output?
+    Open3.capture2e('bundle exec ruby -Ilib tasks/apikey.rb')
+  end
+  let(:stdout_str) { result[0] }
+  let(:status) { result[1] }
+
+  context 'when apikey task is called with valid credentials' do
+    let(:credentials) { "file://#{Dir.getwd}/spec/fixtures/acceptance-credentials.conf" }
+
+    it 'will return an API key' do
+      expect(stdout_str).to match %r{"apikey":}
+      puts stdout_str if debug_output?
+      expect(status.exitstatus).to eq 0
+    end
+  end
+  context 'when apikey task is called with invalid credential_file parameter specified' do
+    let(:credentials) { 'foo' }
+
+    it 'will throw an error and not return an API key' do
+      expect(stdout_str).not_to match %r{"apikey":}
+      expect(stdout_str).to match %r{Unexpected url 'foo' found. Only file:/// URLs for configuration supported at the moment}
+      puts stdout_str if debug_output?
+      expect(status.exitstatus).not_to eq 0
+    end
+  end
+end

tasks/apikey.json

@@ -3,16 +3,8 @@
   "supports_noop": false,
   "description": "Retrieve a PAN-OS apikey using PAN-OS host, username and password.",
   "parameters": {
-    "host": {
-      "description": "The host to connect to",
-      "type": "String"
-    },
-    "user": {
-      "description": "The user name",
-      "type": "String"
-    },
-    "password": {
-      "description": "The password",
+    "credentials_file": {
+      "description": "The filename of the credentials file (as referenced in device.conf)",
       "type": "String"
     }
   }

tasks/apikey.rb

@@ -20,7 +20,8 @@
 require 'puppet/resource_api/transport/wrapper'
 
 params = JSON.parse(ENV['PARAMS'] || STDIN.read)
+
 wrapper = Puppet::ResourceApi::Transport::Wrapper.new('panos', params['credentials_file'])
-transport = wrapper.transport
+api = Puppet::Transport::Panos::API.new(wrapper.transport.instance_variable_get(:@connection_info))
 
-puts JSON.generate(apikey: transport.apikey)
+puts JSON.generate(apikey: api.apikey)