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: listing after failed direct download now works #88

Merged
merged 2 commits into from
Jul 1, 2024
+69 −15
Merged

fix: listing after failed direct download now works #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d286cf5
fix: listing after failed direct download now works
renaudjester Jul 1, 2024
1dc4d32
test: use tmp file for direct download tests
renaudjester Jul 1, 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
2 changes: 1 addition & 1 deletion copernicusmarine/download_functions/download_original_files.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ def _download_header_for_direct_download(
else:
filenames_without_sync.append(full_path)
else:
filenames_not_found.append(full_path)
filenames_not_found.append(file_path)
if not filenames_in:
logger.warning(
"No files found to download for direct download. "
Expand Down
1 change: 1 addition & 0 deletions tests/resources/file_list_examples/direct_download_fails_listing_succeeds.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
CMEMS_v5r1_IBI_PHY_MY_PdE_01mav_20211001_20211031_R20230101_RE01.nc
81 changes: 67 additions & 14 deletions tests/test_get_direct_download.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,14 @@
"direct_download_file_list_different_path_types.txt"
)

DIRECT_DOWNLOAD_FAILS_BUT_LISTING_SUCCEEDS = (
"tests/resources/file_list_examples/"
"direct_download_fails_listing_succeeds.txt"
)


class TestGetDirectDownload:
def test_get_direct_download_file_list(self):
def test_get_direct_download_file_list(self, tmp_path):
self.command = [
"copernicusmarine",
"get",
Expand All @@ -30,6 +35,8 @@ def test_get_direct_download_file_list(self):
"--force-download",
"--show-outputnames",
"--overwrite-output-data",
"-o",
str(tmp_path),
]
self.output = execute_in_terminal(self.command)
assert (
Expand All @@ -38,16 +45,21 @@ def test_get_direct_download_file_list(self):
b"history/BO/AR_PR_BO_58JM.nc"
) in self.output.stdout
assert b"Skipping" not in self.output.stdout
self._assert_file_exists_locally("history/BO/AR_PR_BO_58JM.nc")
self._assert_file_exists_locally("history/BO/AR_PR_BO_58US.nc")
self._assert_insitu_file_exists_locally(
tmp_path, "history/BO/AR_PR_BO_58JM.nc"
)
self._assert_insitu_file_exists_locally(
tmp_path, "history/BO/AR_PR_BO_58US.nc"
)
assert self.output.returncode == 0

# Mocking to skip the listing and search phase
@mock.patch(
"copernicusmarine.download_functions.download_original_files._download_header",
return_value=None,
)
def test_get_direct_download_list_file_only_one_not_found(
self, mock_download_header
self, mock_download_header, tmp_path
):
self.command = [
"copernicusmarine",
Expand All @@ -57,6 +69,8 @@ def test_get_direct_download_list_file_only_one_not_found(
"--file-list",
DIRECT_DOWNLOAD_FILE_LIST_EXAMPLE_WITH_ONE_WRONG,
"--force-download",
"-o",
str(tmp_path),
]
self.output = execute_in_terminal(self.command)
assert (
Expand All @@ -68,10 +82,12 @@ def test_get_direct_download_list_file_only_one_not_found(
assert (
b"history/BO/AR_PR_BO_58JM.nc not found on the server. Skipping."
) not in self.output.stdout
self._assert_file_exists_locally("history/BO/AR_PR_BO_58JM.nc")
self._assert_insitu_file_exists_locally(
tmp_path, file_name="history/BO/AR_PR_BO_58JM.nc"
)
assert self.output.returncode == 0

def test_get_direct_download_different_path_types(self):
def test_get_direct_download_different_path_types(self, tmp_path):
self.command = [
"copernicusmarine",
"get",
Expand All @@ -80,39 +96,76 @@ def test_get_direct_download_different_path_types(self):
"--file-list",
DIRECT_DOWNLOAD_FILE_LIST_EXAMPLE_DIIFERENT_PATH_TYPES,
"--force-download",
"-o",
str(tmp_path),
]
self.output = execute_in_terminal(self.command)
assert b"WARNING" not in self.output.stdout
assert b"Skipping" not in self.output.stdout
assert self.output.returncode == 0

def test_get_direct_download_fails_but_listing_succeeds(self, tmp_path):
self.command = [
"copernicusmarine",
"get",
"--dataset-id",
"cmems_mod_ibi_phy_my_0.083deg-3D_P1M-m",
"--file-list",
DIRECT_DOWNLOAD_FAILS_BUT_LISTING_SUCCEEDS,
"--force-download",
"-o",
str(tmp_path),
]
self.output = execute_in_terminal(self.command)
assert b"Skipping" in self.output.stdout
assert (
b"No files found to download for direct download."
in self.output.stdout
)
assert os.path.exists(
f"{tmp_path}/"
f"IBI_MULTIYEAR_PHY_005_002/"
f"cmems_mod_ibi_phy_my_0.083deg-3D_P1M-m_202012/"
f"2021/"
f"CMEMS_v5r1_IBI_PHY_MY_PdE_01mav_20211001_20211031_R20230101_RE01.nc"
)
assert self.output.returncode == 0

# Python interface tests

def test_get_direct_download_file_list_python(self):
def test_get_direct_download_file_list_python(self, tmp_path):
get_result = get(
dataset_id="cmems_obs-ins_glo_phybgcwav_mynrt_na_irr",
file_list=pathlib.Path(DIRECT_DOWNLOAD_FILE_LIST_EXAMPLE),
force_download=True,
show_outputnames=True,
overwrite_output_data=True,
output_directory=tmp_path,
)
assert set(get_result) == {
pathlib.Path(
"INSITU_GLO_PHYBGCWAV_DISCRETE_MYNRT_013_030/"
"cmems_obs-ins_glo_phybgcwav_mynrt_na_irr_202311/"
"history/BO/AR_PR_BO_58JM.nc"
f"{tmp_path}/"
f"INSITU_GLO_PHYBGCWAV_DISCRETE_MYNRT_013_030/"
f"cmems_obs-ins_glo_phybgcwav_mynrt_na_irr_202311/"
f"history/BO/AR_PR_BO_58JM.nc"
),
pathlib.Path(
"INSITU_GLO_PHYBGCWAV_DISCRETE_MYNRT_013_030/"
"cmems_obs-ins_glo_phybgcwav_mynrt_na_irr_202311/"
"history/BO/AR_PR_BO_58US.nc"
f"{tmp_path}/"
f"INSITU_GLO_PHYBGCWAV_DISCRETE_MYNRT_013_030/"
f"cmems_obs-ins_glo_phybgcwav_mynrt_na_irr_202311/"
f"history/BO/AR_PR_BO_58US.nc"
),
}
for file_path in get_result:
assert os.path.exists(file_path)

def _assert_file_exists_locally(self, file_name: str):
def _assert_insitu_file_exists_locally(
self,
temp_path,
file_name: str,
):
assert os.path.exists(
f"{temp_path}/"
f"INSITU_GLO_PHYBGCWAV_DISCRETE_MYNRT_013_030/"
f"cmems_obs-ins_glo_phybgcwav_mynrt_na_irr_202311/"
f"{file_name}"
Expand Down