Skip to content

Commit

Permalink
[ansible_runner] Add VaultCredential
Browse files Browse the repository at this point in the history
NOTE:  The `--vault-password-file` is used instead of populating the
`env/passwords` file here in case multiple credentials were used at the
same time.  This differs from how `awx` does things:

  https://github.com/ansible/awx/blob/1242ee2b/awx/main/tasks.py#L1554

Where as passwords expect file yaml file is used, but there is also
contextual awareness of all of the passwords being added at the time of
writing the file, where in the current case of MIQ, this is done for
each credential type, so we don't have the context available at when
writing the files.
  • Loading branch information
NickLaMuro committed Jul 18, 2019
1 parent e120e56 commit 62dd90c
Show file tree
Hide file tree
Showing 2 changed files with 105 additions and 0 deletions.
32 changes: 32 additions & 0 deletions lib/ansible/runner/credential/vault_credential.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
module Ansible
class Runner
class VaultCredential < Credential
def self.auth_type
"ManageIQ::Providers::EmbeddedAnsible::AutomationManager::VaultCredential"
end

def env_vars
if auth.vault_password.present?
{ "ANSIBLE_VAULT_PASSWORD_FILE" => vault_password_file }
else
{}
end
end

def write_config_files
write_vault_password_file if auth.vault_password.present?
end

private

def write_vault_password_file
File.write(vault_password_file, auth.vault_password)
File.chmod(0o0400, vault_password_file)
end

def vault_password_file
File.join(base_dir, "vault_password")
end
end
end
end
73 changes: 73 additions & 0 deletions spec/lib/ansible/runner/credential/vault_credential_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
require 'ansible/runner'
require 'ansible/runner/credential'

RSpec.describe Ansible::Runner::VaultCredential do
it ".auth_type is the correct Authentication sub-class" do
expect(described_class.auth_type).to eq("ManageIQ::Providers::EmbeddedAnsible::AutomationManager::VaultCredential")
end

context "with a credential object" do
around do |example|
Dir.mktmpdir("ansible-runner-credential-test") do |dir|
@base_dir = dir
example.run
end
end

let(:auth) { FactoryBot.create(:embedded_ansible_vault_credential, auth_attributes) }
let(:cred) { described_class.new(auth.id, @base_dir) }
let(:auth_attributes) { { :password => "vault_secret" } }
let(:vault_filename) { File.join(@base_dir, "vault_password") }

describe "#command_line" do
it "returns an empty hash" do
expect(cred.command_line).to eq({})
end
end

describe "#env_vars" do
context "with a password" do
it "passes --vault-password-file" do
expected = { "ANSIBLE_VAULT_PASSWORD_FILE" => vault_filename }
expect(cred.env_vars).to eq(expected)
end
end

context "without a password" do
it "passes --vault-password-file" do
auth.update!(:password => nil)
expect(cred.env_vars).to eq({})
end
end
end

describe "#extra_vars" do
it "returns an empty hash" do
expect(cred.extra_vars).to eq({})
end
end

describe "#write_config_files" do
context "with a password" do
before { cred.write_config_files }

it "writes the vault password file with the password" do
expect(File.read(vault_filename)).to eq("vault_secret")
end

it "sets the permission to 400" do
expect(File.stat(vault_filename).mode).to eq(0o100400)
end
end

context "without a password" do
it "does nothing" do
auth.update!(:password => nil)
cred.write_config_files

expect(File.exist?(vault_filename)).to be_falsey
end
end
end
end
end

0 comments on commit 62dd90c

Please sign in to comment.