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.

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

fix: re-login in UsgsApi plugin on api file error #1046

Merged
merged 3 commits into from
Mar 26, 2024
Merged

fix: re-login in UsgsApi plugin on api file error #1046

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1f9a9a0
fix: remove .usgs file and re-login if error code is "AUTH_REVOKED"
dalpasso Mar 4, 2024
906262d
test: the plugin USGS removes the `.usgs` file on AUTH_REVOKED error
dalpasso Mar 13, 2024
9bfd377
fix: remove `.usgs` file when USGSError is raised
dalpasso Mar 22, 2024
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
12 changes: 8 additions & 4 deletions eodag/plugins/apis/usgs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
from __future__ import annotations

import logging
import os
import shutil
import tarfile
import zipfile
Expand Down Expand Up @@ -101,10 +102,13 @@ def authenticate(self) -> None:
except USGSAuthExpiredError:
api.logout()
continue
except USGSError:
raise AuthenticationError(
"Please check your USGS credentials."
) from None
except USGSError as e:
if i == 0:
# `.usgs` API file key might be obsolete
# Remove it and try again
os.remove(api.TMPFILE)
continue
raise AuthenticationError("Please check your USGS credentials.") from e

def query(
self,
Expand Down
1 change: 1 addition & 0 deletions tests/context.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,3 +108,4 @@
from eodag.utils.stac_reader import fetch_stac_items, _TextOpener
from tests import TEST_RESOURCES_PATH
from usgs.api import USGSAuthExpiredError, USGSError
from usgs.api import TMPFILE as USGS_TMPFILE
23 changes: 19 additions & 4 deletions tests/units/test_apis_plugins.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
DEFAULT_MISSION_START_DATE,
ONLINE_STATUS,
USER_AGENT,
USGS_TMPFILE,
AuthenticationError,
EODataAccessGateway,
EOProduct,
Expand Down Expand Up @@ -427,12 +428,26 @@ def test_plugins_apis_usgs_authenticate(self, mock_api_logout, mock_api_login):
mock_api_login.reset_mock()
mock_api_logout.reset_mock()

# with obsolete `.usgs` API file (USGSError)
mock_api_login.side_effect = [
USGSError("USGS error"),
None,
]
with mock.patch("os.remove", autospec=True) as mock_os_remove:
self.api_plugin.authenticate()
self.assertEqual(mock_api_login.call_count, 2)
self.assertEqual(mock_api_logout.call_count, 0)
mock_os_remove.assert_called_once_with(USGS_TMPFILE)
mock_api_login.reset_mock()
mock_api_logout.reset_mock()

# with invalid credentials / USGSError
mock_api_login.side_effect = USGSError()
with self.assertRaises(AuthenticationError):
self.api_plugin.authenticate()
self.assertEqual(mock_api_login.call_count, 1)
mock_api_logout.assert_not_called()
with mock.patch("os.remove", autospec=True) as mock_os_remove:
with self.assertRaises(AuthenticationError):
self.api_plugin.authenticate()
self.assertEqual(mock_api_login.call_count, 2)
mock_api_logout.assert_not_called()

@mock.patch("usgs.api.login", autospec=True)
@mock.patch("usgs.api.logout", autospec=True)
Expand Down
Loading