Merge branch 'main' into data-asset-reporter

Author: jreiberkyle

planet/cli/data.py

@@ -71,8 +71,8 @@ def assets_to_filter(ctx, param, assets: List[str]) -> Optional[dict]:
 
 
 def check_item_types(ctx, param, item_types) -> Optional[List[dict]]:
-    '''Validates the item type by comparing the inputted item type to all
-    supported item types.'''
+    '''Validates each item types provided by comparing them to all supported
+    item types.'''
     try:
         for item_type in item_types:
             validate_item_type(item_type)
@@ -81,6 +81,17 @@ def check_item_types(ctx, param, item_types) -> Optional[List[dict]]:
         raise click.BadParameter(str(e))
 
 
+def check_item_type(ctx, param, item_type) -> Optional[List[dict]]:
+    '''Validates the item type provided by comparing it to all supported
+    item types.'''
+    try:
+        validate_item_type(item_type)
+    except SpecificationException as e:
+        raise click.BadParameter(str(e))
+
+    return item_type
+
+
 def check_search_id(ctx, param, search_id) -> str:
     '''Ensure search id is a valix hex string'''
     try:
@@ -487,11 +498,9 @@ async def search_update(ctx,
 @click.pass_context
 @translate_exceptions
 @coro
-@click.argument("item_type",
-                type=types.CommaSeparatedString(),
-                callback=check_item_types)
+@click.argument("item_type", type=str, callback=check_item_type)
 @click.argument("item_id")
-@click.argument("asset_type_id")
+@click.argument("asset_type")
 @click.option('--directory',
               default='.',
               help=('Base directory for file download.'),
@@ -514,7 +523,7 @@ async def search_update(ctx,
 async def asset_download(ctx,
                          item_type,
                          item_id,
-                         asset_type_id,
+                         asset_type,
                          directory,
                          filename,
                          overwrite,
@@ -537,7 +546,7 @@ async def asset_download(ctx,
     """
     quiet = ctx.obj['QUIET']
     async with data_client(ctx) as cl:
-        asset = await cl.get_asset(item_type.pop(), item_id, asset_type_id)
+        asset = await cl.get_asset(item_type, item_id, asset_type)
         path = await cl.download_asset(asset=asset,
                                        filename=filename,
                                        directory=Path(directory),
@@ -551,27 +560,23 @@ async def asset_download(ctx,
 @click.pass_context
 @translate_exceptions
 @coro
-@click.argument("item_type",
-                type=types.CommaSeparatedString(),
-                callback=check_item_types)
+@click.argument("item_type", type=str, callback=check_item_type)
 @click.argument("item_id")
-@click.argument("asset_type_id")
-async def asset_activate(ctx, item_type, item_id, asset_type_id):
+@click.argument("asset_type")
+async def asset_activate(ctx, item_type, item_id, asset_type):
     '''Activate an asset.'''
     async with data_client(ctx) as cl:
-        asset = await cl.get_asset(item_type.pop(), item_id, asset_type_id)
+        asset = await cl.get_asset(item_type, item_id, asset_type)
         await cl.activate_asset(asset)
 
 
 @data.command()
 @click.pass_context
 @translate_exceptions
 @coro
-@click.argument("item_type",
-                type=types.CommaSeparatedString(),
-                callback=check_item_types)
+@click.argument("item_type", type=str, callback=check_item_type)
 @click.argument("item_id")
-@click.argument("asset_type_id")
+@click.argument("asset_type")
 @click.option('--delay',
               type=int,
               default=5,
@@ -581,21 +586,16 @@ async def asset_activate(ctx, item_type, item_id, asset_type_id):
               default=200,
               show_default=True,
               help='Maximum number of polls. Set to zero for no limit.')
-async def asset_wait(ctx,
-                     item_type,
-                     item_id,
-                     asset_type_id,
-                     delay,
-                     max_attempts):
+async def asset_wait(ctx, item_type, item_id, asset_type, delay, max_attempts):
     '''Wait for an asset to be activated.
 
     Returns when the asset status has reached "activated" and the asset is
     available.
     '''
     quiet = ctx.obj['QUIET']
     async with data_client(ctx) as cl:
-        asset = await cl.get_asset(item_type.pop(), item_id, asset_type_id)
-        with AssetStatusBar(item_type, item_id, asset_type_id,
+        asset = await cl.get_asset(item_type, item_id, asset_type)
+        with AssetStatusBar(item_type, item_id, asset_type,
                             disable=quiet) as bar:
             status = await cl.wait_asset(asset,
                                          delay,

tests/integration/test_data_cli.py

@@ -62,7 +62,7 @@ def item_id():
 
 
 @pytest.fixture
-def asset_type_id():
+def asset_type():
     return 'basic_udm2'
 
 
@@ -72,7 +72,7 @@ def dl_url():
 
 
 @pytest.fixture
-def mock_asset_get_response(item_type, item_id, asset_type_id, dl_url):
+def mock_asset_get_response(item_type, item_id, asset_type, dl_url):
 
     def _func():
         basic_udm2_asset = {
@@ -85,7 +85,7 @@ def _func():
             "md5_digest": None,
             "status": 'active',
             "location": dl_url,
-            "type": asset_type_id
+            "type": asset_type
         }
 
         page_response = {
@@ -951,7 +951,7 @@ def test_asset_download_default(invoke,
                                 mock_asset_get_response,
                                 item_type,
                                 item_id,
-                                asset_type_id,
+                                asset_type,
                                 dl_url):
 
     mock_asset_get_response()
@@ -986,7 +986,7 @@ async def _stream_img():
             'asset-download',
             item_type,
             item_id,
-            asset_type_id,
+            asset_type,
             f'--directory={Path(folder)}',
             '--filename',
             'img.tif'
@@ -1015,7 +1015,7 @@ def test_asset_activate(invoke,
                         mock_asset_get_response,
                         item_type,
                         item_id,
-                        asset_type_id,
+                        asset_type,
                         dl_url):
 
     mock_asset_get_response()
@@ -1025,7 +1025,7 @@ def test_asset_activate(invoke,
     respx.get(dl_url).return_value = mock_resp_activate
 
     runner = CliRunner()
-    result = invoke(['asset-activate', item_type, item_id, asset_type_id],
+    result = invoke(['asset-activate', item_type, item_id, asset_type],
                     runner=runner)
 
     assert not result.exception
@@ -1036,7 +1036,7 @@ def test_asset_wait(invoke,
                     mock_asset_get_response,
                     item_type,
                     item_id,
-                    asset_type_id,
+                    asset_type,
                     dl_url):
 
     mock_asset_get_response()
@@ -1047,7 +1047,7 @@ def test_asset_wait(invoke,
 
     runner = CliRunner()
     result = invoke(
-        ['asset-wait', item_type, item_id, asset_type_id, '--delay', '0'],
+        ['asset-wait', item_type, item_id, asset_type, '--delay', '0'],
         runner=runner)
 
     assert not result.exception

tests/unit/test_data_callbacks.py

@@ -14,7 +14,7 @@
 import logging
 import pytest
 import click
-from planet.cli.data import check_item_types
+from planet.cli.data import check_item_types, check_item_type
 
 LOGGER = logging.getLogger(__name__)
 
@@ -43,13 +43,32 @@ def __init__(self):
                              'PSScene4Band',
                              'REScene'
                          ])
-def test_item_type_success(item_types):
+def test_item_types_success(item_types):
     ctx = MockContext()
     result = check_item_types(ctx, 'item_types', [item_types])
     assert result == [item_types]
 
 
+def test_item_types_fail():
+    ctx = MockContext()
+    with pytest.raises(click.BadParameter):
+        check_item_types(ctx, 'item_types', "bad_item_type")
+
+
+def test_item_type_success():
+    ctx = MockContext()
+    item_type = "PSScene"
+    result = check_item_type(ctx, 'item_type', item_type)
+    assert result == item_type
+
+
 def test_item_type_fail():
     ctx = MockContext()
     with pytest.raises(click.BadParameter):
-        check_item_types(ctx, 'item_type', "bad_item_type")
+        check_item_type(ctx, 'item_type', "bad_item_type")
+
+
+def test_item_type_too_many_item_types():
+    ctx = MockContext()
+    with pytest.raises(click.BadParameter):
+        check_item_types(ctx, 'item_type', "PSScene,SkySatScene")