DAS-1894 #5

eni-awowale · 2023-08-09T15:41:25Z

Description

Added functionality for downloading a granule locally from CMR

Jira Issue ID

DAS-1894

Local Test Steps

# Import CMR query and environment types
from cmr import GranuleQuery, CMR_UAT
import requests
from varinfo.cmr_search import get_granules, get_granule_name, get_granule_link, download_granule

granule_response = get_granules(concept_id='G1245662789-EEDTEST',
                                cmr_env=CMR_UAT,
                                token=token_uat) # Change token to your UAT token

link = get_granule_link(granule_response)
download_granule(link, get_granule_name(granule_response)) # Saves to your current directory

PR Acceptance Checklist

[ X] Jira ticket acceptance criteria met.
[ X] CHANGELOG.md updated to include high level summary of PR changes.
VERSION updated if publishing a release.
[ X] Tests added/updated and passing.
Documentation updated (if needed).

eni-awowale · 2023-08-09T15:47:34Z

.gitignore

@@ -22,6 +22,13 @@ __pycache__/

 # Generated files
 stash
+downloaded_granules


download_granules saves a file into the current directory, so I added these file types to the .gitignore

eni-awowale · 2023-08-09T15:48:45Z

tests/unit/test_cmr_search.py

-from unittest import TestCase
-from unittest.mock import patch
+from unittest import TestCase, mock
+from unittest.mock import patch, MagicMock


Oops I don't use MagicMock will remove for the next commit

eni-awowale · 2023-08-09T15:49:22Z

tests/unit/test_cmr_search.py

@@ -45,6 +49,7 @@ def test_with_concept_id(self, granule_query_mock):
        ('foo')
        granule_query_mock.return_value.get.assert_called_once_with(10)

+


I need two spaces and realized that it's PEP8

eni-awowale · 2023-08-09T15:50:36Z

varinfo/cmr_search.py

@@ -62,13 +63,41 @@ def get_granules(concept_id: str = None,
    return granule_response


-def get_granule_link(query_response: list) -> str:
+def get_granule_link(granule_response: list) -> str:


I thought this name was better

eni-awowale · 2023-08-09T15:52:01Z

varinfo/cmr_search.py

    return granule_link
+
+
+def get_granule_name(granule_response: list) -> str:


This really just a helper function for getting the granule filename, so we don't have to go through the granule_response

eni-awowale · 2023-08-09T15:54:40Z

varinfo/cmr_search.py

+    ''' Use the requests module to download data via https.
+    '''
+    # Check if a string was entered for input parameters
+    if isinstance(granule_link, str) and isinstance(out_filename, str):


I decided go with checking if granule_link and out_filename are strings. I won't be offended if you think we should do this differently.

eni-awowale · 2023-08-09T15:56:04Z

varinfo/exceptions.py

@@ -91,3 +91,12 @@ class MissingGranuleDownloadLinks(CustomError):
    def __init__(self, download_link):
        super().__init__('MissingGranuleDownloadLinks',
                         f'No links for granule record: {download_link}')
+
+
+class RequestsException(CustomError):


CustomError for the W 😎

eni-awowale · 2023-08-09T16:00:07Z

tests/unit/test_cmr_search.py

+
+
+    def _mock_requests(self, status=200, content="CONTENT"):


Okay, I am pretty proud of this one. I wanted to mock requests.get and figured out it would be easier to write a function that returns this mock object, instead of creating the mocked object in the same test for checking the mocked object against download_granules. Also, I noticed in some of your harmony code you start functions that are only used once with a _?? I was reading somewhere that this is convention but feel free to correct me if I am wrong.

eni-awowale · 2023-08-09T19:34:16Z

varinfo/cmr_search.py

+    if isinstance(granule_link, str) and isinstance(out_filename, str):
+        f = open(out_filename, 'w+')
+    else:
+        raise ValueError('Not a string')


I think I should make this error message more meaningful.

DAS-1894

e4c0dd1

eni-awowale requested a review from owenlittlejohns August 9, 2023 15:41

eni-awowale commented Aug 9, 2023

View reviewed changes

eni-awowale merged commit e4c0dd1 into main Aug 9, 2023
4 checks passed

eni-awowale commented Aug 9, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DAS-1894 #5

DAS-1894 #5

eni-awowale commented Aug 9, 2023

eni-awowale Aug 9, 2023

eni-awowale Aug 9, 2023

eni-awowale Aug 9, 2023

eni-awowale Aug 9, 2023

eni-awowale Aug 9, 2023

eni-awowale Aug 9, 2023

eni-awowale Aug 9, 2023

eni-awowale Aug 9, 2023 •

edited

Loading

eni-awowale Aug 9, 2023

		@@ -45,6 +49,7 @@ def test_with_concept_id(self, granule_query_mock):
		('foo')
		granule_query_mock.return_value.get.assert_called_once_with(10)

		return granule_link


		def get_granule_name(granule_response: list) -> str:

DAS-1894 #5

DAS-1894 #5

Conversation

eni-awowale commented Aug 9, 2023

Description

Jira Issue ID

Local Test Steps

PR Acceptance Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eni-awowale Aug 9, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eni-awowale Aug 9, 2023 •

edited

Loading