Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
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
4 changes: 2 additions & 2 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ on:
pull_request:
push:
branches:
- master
- main

jobs:
test:
runs-on: ubuntu-20.04
runs-on: ubuntu-22.04
env:
MIX_ENV: test
strategy:
Expand Down
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Changelog

## v1.4.5-mo.1 (2026-10-28)

* Ignore empty or incomplete gcloud configuration files so application default
credentials and metadata fallback remain available.

## v1.4.5 (2024-12-20)

* Support workload identity scopes
Expand Down
15 changes: 13 additions & 2 deletions lib/goth/config.ex
Original file line number Diff line number Diff line change
Expand Up @@ -235,8 +235,19 @@ defmodule Goth.Config do
if File.regular?(configuration_file) do
configuration_data = configuration_file |> File.read!() |> decode_ini()

# Only retrieve the required data.
%{"project_id" => configuration_data["core"]["project"], "actor_email" => configuration_data["core"]["account"]}
case configuration_data do
%{"core" => %{"project" => project, "account" => account}} ->
%{"project_id" => project, "actor_email" => account}

_ ->
Logger.warning(
"Gcloud configuration file #{configuration_file} is missing " <>
"required [core] section with project and account settings. " <>
"Run 'gcloud init' or delete this file to resolve."
)

nil
end
else
nil
end
Expand Down
Empty file.
2 changes: 2 additions & 0 deletions test/data/home/gcloud/configurations/config_no_account
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[core]
project = first_project
3 changes: 3 additions & 0 deletions test/data/home/gcloud/configurations/config_no_core
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[compute]
zone = us-central1-c
region = us-central1
2 changes: 2 additions & 0 deletions test/data/home/gcloud/configurations/config_no_project
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[core]
account = username@domain.com
65 changes: 65 additions & 0 deletions test/goth/config_test.exs
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,71 @@ defmodule Goth.ConfigTest do
Application.start(:goth)
end

test "get_configuration_data returns nil for empty config file" do
import ExUnit.CaptureLog

path = Path.expand("test/data/home/gcloud/configurations/config_empty")

log =
capture_log(fn ->
assert Config.get_configuration_data(path) == nil
end)

assert log =~ "missing required [core] section"
assert log =~ "Run 'gcloud init' or delete this file"
end

test "get_configuration_data returns nil for config file missing [core] section" do
import ExUnit.CaptureLog

path = Path.expand("test/data/home/gcloud/configurations/config_no_core")

log =
capture_log(fn ->
assert Config.get_configuration_data(path) == nil
end)

assert log =~ "missing required [core] section"
end

for configuration_file <- ~w(config_empty config_no_core config_no_project config_no_account) do
@tag :capture_log
test "#{configuration_file} allows metadata fallback", %{bypass: bypass} do
Bypass.expect_once(bypass, "GET", "/computeMetadata/v1/project/project-id", fn conn ->
Plug.Conn.resp(conn, 200, "metadata-project")
end)

assert {:ok, %{default: config}} =
Config.init(
config_root_dir: Path.expand("test/data/home/gcloud"),
configuration_file: "configurations/#{unquote(configuration_file)}",
credentials_file: "missing-credentials.json"
)

assert config["token_source"] == :metadata
assert config["project_id"] == "metadata-project"
end

@tag :capture_log
test "#{configuration_file} preserves application default credentials" do
assert {:ok, %{default: config}} =
Config.init(
config_root_dir: Path.expand("test/data/home/gcloud"),
configuration_file: "configurations/#{unquote(configuration_file)}",
project_id: "configured-project"
)

credentials =
"test/data/home/gcloud/application_default_credentials.json"
|> File.read!()
|> Jason.decode!()

assert Map.take(config, Map.keys(credentials)) == credentials
assert config["token_source"] == :oauth_refresh
assert config["project_id"] == "configured-project"
end
end

test "GOOGLE_APPLICATION_CREDENTIALS is read" do
# The test configuration sets an example JSON blob. We override it briefly
# during this test.
Expand Down