Skip to content

test: add test coverage for ee_initialize (#77) #2757

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.

Sign up for GitHub

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

Open
schwehr wants to merge 3 commits into
base: master
Choose a base branch
from
Open

test: add test coverage for ee_initialize (#77) #2757

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6e407e7
test: add test coverage for ee_initialize (#77)
schwehr Apr 20, 2026
73c3d9d
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 20, 2026
5fc686d
Merge branch 'master' into jules-3331853548565919833-195aa69b
schwehr Apr 28, 2026
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
166 changes: 166 additions & 0 deletions tests/test_coreutils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"""Tests for `coreutils` module."""

import json
import google.oauth2.credentials
import os
import string
import sys
Expand Down Expand Up @@ -160,5 +161,170 @@ def test_temp_file_path(self):
self.fail("file id is not a valid UUID4")


class TestEeInitialize(unittest.TestCase):
@mock.patch.object(coreutils.ee, "Initialize")
@mock.patch.object(coreutils.ee, "Authenticate")
@mock.patch.object(coreutils.ee.data, "setUserAgent")
@mock.patch.object(coreutils.ee.data, "_get_state")
Comment on lines +165 to +168
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot Apr 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

These four mocks are repeated across all test methods in this class. To reduce boilerplate and improve maintainability, you can apply these patches at the class level. Note that when patching at the class level, the mock objects are passed as arguments to each test method after any method-level mocks.

def test_ee_initialize_already_authenticated(
self, mock_get_state, mock_set_user_agent, mock_authenticate, mock_initialize
):
# Setup state to have credentials
mock_state = mock.Mock()
mock_state.credentials = mock.Mock()
mock_get_state.return_value = mock_state

coreutils.ee_initialize()

mock_set_user_agent.assert_called_once()
mock_initialize.assert_not_called()
mock_authenticate.assert_not_called()

@mock.patch.object(coreutils.ee, "Initialize")
@mock.patch.object(coreutils.ee, "Authenticate")
@mock.patch.object(coreutils.ee.data, "setUserAgent")
@mock.patch.object(coreutils.ee.data, "_get_state")
@mock.patch.object(coreutils, "get_env_var")
@mock.patch.object(google.oauth2.credentials, "Credentials")
def test_ee_initialize_with_ee_token(
self,
mock_credentials,
mock_get_env_var,
mock_get_state,
mock_set_user_agent,
mock_authenticate,
mock_initialize,
):
# Setup state to not have credentials
mock_state = mock.Mock()
mock_state.credentials = None
mock_get_state.return_value = mock_state

# Setup env var
mock_get_env_var.return_value = '{"client_id": "cid", "client_secret": "csec", "refresh_token": "rt", "project": "proj"}'

# Setup credentials
mock_cred_instance = mock.Mock()
mock_credentials.return_value = mock_cred_instance

coreutils.ee_initialize(project="test_proj", opt_url="http://test")

mock_set_user_agent.assert_called_once()
mock_credentials.assert_called_once_with(
None,
token_uri="https://oauth2.googleapis.com/token",
client_id="cid",
client_secret="csec",
refresh_token="rt",
quota_project_id="proj",
)
mock_initialize.assert_called_once_with(
credentials=mock_cred_instance, opt_url="http://test"
)
Comment on lines +221 to +223
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot Apr 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

This assertion confirms that the project argument passed to ee_initialize is ignored when an EARTHENGINE_TOKEN is present. In geemap/coreutils.py, the project parameter is not passed to ee.Initialize in the token-based initialization path (lines 83-96). This appears to be a bug in the implementation, and the test should be updated to expect the project to be passed correctly.

Suggested change
mock_initialize.assert_called_once_with(
credentials=mock_cred_instance, opt_url="http://test"
)
mock_initialize.assert_called_once_with(
credentials=mock_cred_instance, project="test_proj", opt_url="http://test"
)

mock_authenticate.assert_not_called()

@mock.patch.object(coreutils.ee, "Initialize")
@mock.patch.object(coreutils.ee, "Authenticate")
@mock.patch.object(coreutils.ee.data, "setUserAgent")
@mock.patch.object(coreutils.ee.data, "_get_state")
@mock.patch.object(coreutils, "get_env_var")
@mock.patch.object(coreutils, "in_colab_shell")
def test_ee_initialize_in_colab(
self,
mock_in_colab,
mock_get_env_var,
mock_get_state,
mock_set_user_agent,
mock_authenticate,
mock_initialize,
):
# Setup state to not have credentials
mock_state = mock.Mock()
mock_state.credentials = None
mock_get_state.return_value = mock_state

# Setup env var (no token)
def mock_env_var(key):
if key == "EARTHENGINE_TOKEN":
return None
elif key == "EE_PROJECT_ID":
return "env_proj"
return None

mock_get_env_var.side_effect = mock_env_var

# Setup colab
mock_in_colab.return_value = True

coreutils.ee_initialize()

mock_set_user_agent.assert_called_once()
mock_authenticate.assert_called_once_with()
mock_initialize.assert_called_once_with(project="env_proj")

@mock.patch.object(coreutils.ee, "Initialize")
@mock.patch.object(coreutils.ee, "Authenticate")
@mock.patch.object(coreutils.ee.data, "setUserAgent")
@mock.patch.object(coreutils.ee.data, "_get_state")
@mock.patch.object(coreutils, "get_env_var")
@mock.patch.object(coreutils, "in_colab_shell")
def test_ee_initialize_default(
self,
mock_in_colab,
mock_get_env_var,
mock_get_state,
mock_set_user_agent,
mock_authenticate,
mock_initialize,
):
# Setup state to not have credentials
mock_state = mock.Mock()
mock_state.credentials = None
mock_get_state.return_value = mock_state

# Setup env var (no token)
mock_get_env_var.return_value = None

# Setup colab
mock_in_colab.return_value = False

coreutils.ee_initialize()

mock_set_user_agent.assert_called_once()
mock_authenticate.assert_called_once_with(auth_mode="notebook")
mock_initialize.assert_called_once_with(project=None)

@mock.patch.object(coreutils.ee, "Initialize")
@mock.patch.object(coreutils.ee, "Authenticate")
@mock.patch.object(coreutils.ee.data, "setUserAgent")
@mock.patch.object(coreutils.ee.data, "_get_state")
@mock.patch.object(coreutils, "get_env_var")
@mock.patch.object(coreutils, "in_colab_shell")
def test_ee_initialize_with_custom_args(
self,
mock_in_colab,
mock_get_env_var,
mock_get_state,
mock_set_user_agent,
mock_authenticate,
mock_initialize,
):
# Setup state to not have credentials
mock_state = mock.Mock()
mock_state.credentials = None
mock_get_state.return_value = mock_state

# Setup env var (no token)
mock_get_env_var.return_value = None

coreutils.ee_initialize(
auth_mode="gcloud", project="test_proj", auth_args={"quiet": True}
)

mock_set_user_agent.assert_called_once()
mock_authenticate.assert_called_once_with(auth_mode="gcloud", quiet=True)
mock_initialize.assert_called_once_with(project="test_proj")


if __name__ == "__main__":
unittest.main()
Loading