Add CLI support for subs publishing stages and time range types

Resolves #968
Resolves #969

Author: sgillies

CHANGES.txt

@@ -1,5 +1,6 @@
 2.1.0 (TBD)
 
+- Support for publishing stages and time range types has been added to the subscriptions CLI ().
 - The --cloudconfig option of the request command of the orders CLI has been
   superseded by a new --delivery option, with --cloudconfig left as an alias.
   New --archive-type, --archive-filename, and --single-archive options to

planet/cli/subscriptions.py

@@ -237,10 +237,10 @@ async def list_subscription_results_cmd(ctx,
     '--notifications',
     type=types.JSON(),
     help='Notifications JSON. Can be a string, filename, or - for stdin.')
-@click.option(
-    '--tools',
-    type=types.JSON(),
-    help='Toolchain JSON. Can be a string, filename, or - for stdin.')
+@click.option('--tools',
+              type=types.JSON(),
+              help='Toolchain JSON. Can be a string, filename, or - for stdin.'
+              )
 @click.option(
     '--clip-to-source',
     is_flag=True,
@@ -297,10 +297,20 @@ def request(name,
 @click.option('--rrule',
               type=str,
               help='iCalendar recurrance rule to specify recurrances.')
+@click.option('--filter',
+              type=types.JSON(),
+              help='Search filter.  Can be a string, filename, or - for stdin.'
+              )
 @click.option(
-    '--filter',
-    type=types.JSON(),
-    help='Search filter.  Can be a string, filename, or - for stdin.')
+    '--publishing-stage',
+    'publishing_stages',
+    type=click.Choice(["preview", "standard", "finalized"]),
+    multiple=True,
+    help=("Subscribe to results at a particular publishing stage. Multiple "
+          "instances of this option are allowed."))
+@click.option('--time-range-type',
+              type=click.Choice(["acquired", "published"]),
+              help="Subscribe by acquisition time or time of publication.")
 @pretty
 def request_catalog(item_types,
                     asset_types,
@@ -309,15 +319,20 @@ def request_catalog(item_types,
                     end_time,
                     rrule,
                     filter,
+                    publishing_stages,
+                    time_range_type,
                     pretty):
     """Generate a subscriptions request catalog source description."""
-    res = subscription_request.catalog_source(item_types,
-                                              asset_types,
-                                              geometry,
-                                              start_time,
-                                              end_time=end_time,
-                                              rrule=rrule,
-                                              filter=filter)
+    res = subscription_request.catalog_source(
+        item_types,
+        asset_types,
+        geometry,
+        start_time,
+        end_time=end_time,
+        rrule=rrule,
+        filter=filter,
+        publishing_stages=publishing_stages,
+        time_range_type=time_range_type)
     echo_json(res, pretty)
 
 

tests/integration/test_subscriptions_cli.py

@@ -12,6 +12,7 @@
 TODO: tests for 3 options of the planet-subscriptions-results command.
 
 """
+import itertools
 import json
 
 from click.testing import CliRunner
@@ -356,3 +357,46 @@ def test_request_pv_success(invoke, geom_geojson):
     source = json.loads(result.output)
     assert source["type"] == "biomass_proxy"
     assert source["parameters"]["id"] == "BIOMASS-PROXY_V3.0_10"
+
+
+@pytest.mark.parametrize(
+    # Test all the combinations of the three options plus some with dupes.
+    "publishing_stages",
+    list(
+        itertools.chain.from_iterable(
+            itertools.combinations(["preview", "standard", "finalized"], i)
+            for i in range(1, 4))) + [("preview", "preview"),
+                                      ("preview", "finalized", "preview")])
+def test_catalog_source_publishing_stages(invoke,
+                                          geom_geojson,
+                                          publishing_stages):
+    """Catalog source publishing stages are configured."""
+    result = invoke([
+        'request-catalog',
+        '--item-types=PSScene',
+        '--asset-types=ortho_analytic_4b',
+        f"--geometry={json.dumps(geom_geojson)}",
+        '--start-time=2021-03-01T00:00:00',
+    ] + [f'--publishing-stage={stage}' for stage in publishing_stages])
+
+    assert result.exit_code == 0  # success.
+    req = json.loads(result.output)
+    assert req['parameters']['publishing_stages'] == list(
+        set(publishing_stages))
+
+
+@pytest.mark.parametrize("time_range_type", ["acquired", "published"])
+def test_catalog_source_time_range_type(invoke, geom_geojson, time_range_type):
+    """Catalog source time range type is configured."""
+    result = invoke([
+        'request-catalog',
+        '--item-types=PSScene',
+        '--asset-types=ortho_analytic_4b',
+        f"--geometry={json.dumps(geom_geojson)}",
+        '--start-time=2021-03-01T00:00:00',
+        f'--time-range-type={time_range_type}',
+    ])
+
+    assert result.exit_code == 0  # success.
+    req = json.loads(result.output)
+    assert req['parameters']['time_range_type'] == time_range_type