Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(secrets): add Doppler adapter #1099

Merged
merged 5 commits into from
Nov 21, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions lib/kamal/secrets/adapters/doppler.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
class Kamal::Secrets::Adapters::Doppler < Kamal::Secrets::Adapters::Base
private
def login(account)
unless loggedin?(account)
`doppler login -y`
raise RuntimeError, "Failed to login to Doppler" unless $?.success?
end
end

def loggedin?(account)
`doppler me --json 2> /dev/null`
$?.success?
end

def fetch_secrets(secrets, account:, session:)
project, config = account.split("/")

raise RuntimeError, "Missing project or config from --acount=project/config option" unless project && config
raise RuntimeError, "Using --from option or FOLDER/SECRET is not supported by Doppler" if secrets.any?(/\//)

items = `doppler secrets get #{secrets.map(&:shellescape).join(" ")} --json -p #{project} -c #{config}`
mrbongiolo marked this conversation as resolved.
Show resolved Hide resolved
raise RuntimeError, "Could not read #{secrets} from Doppler" unless $?.success?

items = JSON.parse(items)

items.transform_values { |value| value["computed"] }
end
end
100 changes: 100 additions & 0 deletions test/secrets/doppler_adapter_test.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
require "test_helper"

class DopplerAdapterTest < SecretAdapterTestCase
setup do
`true` # Ensure $? is 0
end

test "fetch" do
stub_ticks.with("doppler me --json 2> /dev/null")

stub_ticks
.with("doppler secrets get SECRET1 FSECRET1 FSECRET2 --json -p my-project -c prd")
.returns(<<~JSON)
{
"SECRET1": {
"computed":"secret1",
"computedVisibility":"unmasked",
"note":""
},
"FSECRET1": {
"computed":"fsecret1",
"computedVisibility":"unmasked",
"note":""
},
"FSECRET2": {
"computed":"fsecret2",
"computedVisibility":"unmasked",
"note":""
}
}
JSON

json = JSON.parse(shellunescape(run_command("fetch", "SECRET1", "FSECRET1", "FSECRET2")))

expected_json = {
"SECRET1"=>"secret1",
"FSECRET1"=>"fsecret1",
"FSECRET2"=>"fsecret2"
}

assert_equal expected_json, json
end

test "fetch with from" do
stub_ticks.with("doppler me --json 2> /dev/null")

error = assert_raises RuntimeError do
run_command("fetch", "--from", "FOLDER1", "FSECRET1", "FSECRET2")
end

assert_match(/Using --from option or FOLDER\/SECRET is not supported by Doppler/, error.message)
end

test "fetch with folder in secret" do
stub_ticks.with("doppler me --json 2> /dev/null")

error = assert_raises RuntimeError do
run_command("fetch", "FOLDER1/FSECRET1", "SECRET2")
end

assert_match(/Using --from option or FOLDER\/SECRET is not supported by Doppler/, error.message)
end

test "fetch with signin" do
stub_ticks_with("doppler me --json 2> /dev/null", succeed: false)
stub_ticks_with("doppler login -y", succeed: true).returns("")
stub_ticks.with("doppler secrets get SECRET1 --json -p my-project -c prd").returns(single_item_json)

json = JSON.parse(shellunescape(run_command("fetch", "SECRET1")))

expected_json = {
"SECRET1"=>"secret1"
}

assert_equal expected_json, json
end

private
def run_command(*command)
stdouted do
Kamal::Cli::Secrets.start \
[ *command,
"-c", "test/fixtures/deploy_with_accessories.yml",
"--adapter", "doppler",
"--account", "my-project/prd" ]
end
end

def single_item_json
<<~JSON
{
"SECRET1": {
"computed":"secret1",
"computedVisibility":"unmasked",
"note":""
}
}
JSON
end
end