From 4fae46f2726a8466bf0eb24414c05bc9ca477d68 Mon Sep 17 00:00:00 2001 From: Matt Wynne Date: Thu, 9 Apr 2026 16:35:57 -0700 Subject: [PATCH 1/2] Handle empty/incomplete gcloud config file When ~/.config/gcloud/configurations/config_default exists but is empty or missing the [core] section, return nil with a warning log instead of crashing. This lets the credential fallback chain continue. --- lib/goth/config.ex | 15 +++++++++-- .../home/gcloud/configurations/config_empty | 0 .../home/gcloud/configurations/config_no_core | 3 +++ test/goth/config_test.exs | 27 +++++++++++++++++++ 4 files changed, 43 insertions(+), 2 deletions(-) create mode 100644 test/data/home/gcloud/configurations/config_empty create mode 100644 test/data/home/gcloud/configurations/config_no_core diff --git a/lib/goth/config.ex b/lib/goth/config.ex index 82439dc..b945f77 100644 --- a/lib/goth/config.ex +++ b/lib/goth/config.ex @@ -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 diff --git a/test/data/home/gcloud/configurations/config_empty b/test/data/home/gcloud/configurations/config_empty new file mode 100644 index 0000000..e69de29 diff --git a/test/data/home/gcloud/configurations/config_no_core b/test/data/home/gcloud/configurations/config_no_core new file mode 100644 index 0000000..97d3f15 --- /dev/null +++ b/test/data/home/gcloud/configurations/config_no_core @@ -0,0 +1,3 @@ +[compute] +zone = us-central1-c +region = us-central1 diff --git a/test/goth/config_test.exs b/test/goth/config_test.exs index 3b8b1b1..d314430 100644 --- a/test/goth/config_test.exs +++ b/test/goth/config_test.exs @@ -150,6 +150,33 @@ 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 + test "GOOGLE_APPLICATION_CREDENTIALS is read" do # The test configuration sets an example JSON blob. We override it briefly # during this test. From 4d9d4a5e67b173be62cfea07e6d8dedf21c7e9b0 Mon Sep 17 00:00:00 2001 From: Dominik Ilnicki Date: Wed, 28 Oct 2026 18:28:20 +0100 Subject: [PATCH 2/2] Prepare the gcloud config fix for v1.4.5-mo.1 --- .github/workflows/main.yml | 4 +- CHANGELOG.md | 5 +++ .../gcloud/configurations/config_no_account | 2 + .../gcloud/configurations/config_no_project | 2 + test/goth/config_test.exs | 38 +++++++++++++++++++ 5 files changed, 49 insertions(+), 2 deletions(-) create mode 100644 test/data/home/gcloud/configurations/config_no_account create mode 100644 test/data/home/gcloud/configurations/config_no_project diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 4bc2a3d..1f243fa 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -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: diff --git a/CHANGELOG.md b/CHANGELOG.md index 6d4f33f..08c296c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/test/data/home/gcloud/configurations/config_no_account b/test/data/home/gcloud/configurations/config_no_account new file mode 100644 index 0000000..a6d1c21 --- /dev/null +++ b/test/data/home/gcloud/configurations/config_no_account @@ -0,0 +1,2 @@ +[core] +project = first_project diff --git a/test/data/home/gcloud/configurations/config_no_project b/test/data/home/gcloud/configurations/config_no_project new file mode 100644 index 0000000..84e653f --- /dev/null +++ b/test/data/home/gcloud/configurations/config_no_project @@ -0,0 +1,2 @@ +[core] +account = username@domain.com diff --git a/test/goth/config_test.exs b/test/goth/config_test.exs index d314430..00b8c54 100644 --- a/test/goth/config_test.exs +++ b/test/goth/config_test.exs @@ -177,6 +177,44 @@ defmodule Goth.ConfigTest do 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.