Update to parse referenced list of subs, and add an integration test

Author: goldenberg

planet/cli/subscriptions.py

@@ -205,8 +205,9 @@ async def create_subscription_cmd(ctx, request, pretty, **kwargs):
 
     if kwargs.get("bulk"):
         async with subscriptions_client(ctx) as client:
-            _ = await client.bulk_create_subscriptions([request])
-            # Bulk create returns no response, so we don't echo anything
+            links = await client.bulk_create_subscriptions([request])
+            # Bulk create returns just a link to an endpoint to list created subscriptions.
+            echo_json(links, pretty)
     else:
         async with subscriptions_client(ctx) as client:
             sub = await client.create_subscription(request)

planet/clients/subscriptions.py

@@ -203,7 +203,7 @@ async def create_subscription(self, request: dict) -> dict:
             sub = resp.json()
             return sub
 
-    async def bulk_create_subscriptions(self, requests: List[dict]) -> None:
+    async def bulk_create_subscriptions(self, requests: List[dict]) -> Dict:
         """
         Create multiple subscriptions in bulk. Currently, the list of requests can only contain one item.
 
@@ -216,20 +216,20 @@ async def bulk_create_subscriptions(self, requests: List[dict]) -> None:
             ClientError: If there is an issue with the client request.
 
         Returns:
-            None: The bulk create endpoint returns an empty body, so no value
-            is returned.
+            The response including a _links key to the list endpoint for use finding the created subscriptions.
         """
         try:
             url = f'{self._base_url}/bulk'
-            _ = await self._session.request(method='POST',
-                                            url=url,
-                                            json={'subscriptions': requests})
+            resp = await self._session.request(
+                method='POST', url=url, json={'subscriptions': requests})
         # Forward APIError. We don't strictly need this clause, but it
         # makes our intent clear.
         except APIError:
             raise
         except ClientError:  # pragma: no cover
             raise
+        else:
+            return resp.json()
 
     async def cancel_subscription(self, subscription_id: str) -> None:
         """Cancel a Subscription.

planet/sync/subscriptions.py

@@ -136,7 +136,7 @@ def create_subscription(self, request: Dict) -> Dict:
         return self._client._call_sync(
             self._client.create_subscription(request))
 
-    def bulk_create_subscriptions(self, requests: List[Dict]) -> None:
+    def bulk_create_subscriptions(self, requests: List[Dict]) -> Dict:
         """Bulk create subscriptions.
 
         Args:

tests/integration/test_subscriptions_api.py

@@ -122,6 +122,17 @@ def modify_response(request):
 create_mock.route(M(url=TEST_URL),
                   method='POST').mock(side_effect=modify_response)
 
+bulk_create_mock = respx.mock()
+bulk_create_mock.route(
+    M(url=f'{TEST_URL}/bulk'), method='POST'
+).mock(return_value=Response(
+    200,
+    json={
+        '_links': {
+            'list': f'{TEST_URL}/subscriptions/v1?created={datetime.now().isoformat()}/&geom_ref=pl:features:test_features&name=test-sub'
+        }
+    }))
+
 update_mock = respx.mock()
 update_mock.route(M(url=f'{TEST_URL}/test'),
                   method='PUT').mock(side_effect=modify_response)
@@ -334,6 +345,18 @@ async def test_create_subscription_success():
         assert sub['name'] == 'test'
 
 
+@pytest.mark.anyio
+@bulk_create_mock
+async def test_bulk_create_subscription_success():
+    """Bulk subscription is created, description has the expected items."""
+    async with Session() as session:
+        client = SubscriptionsClient(session, base_url=TEST_URL)
+        resp = await client.bulk_create_subscriptions([{
+            'name': 'test', 'delivery': 'yes, please', 'source': 'test'
+        }])
+        assert '/subscriptions/v1?' in resp['_links']['list']
+
+
 @create_mock
 def test_create_subscription_success_sync():
     """Subscription is created, description has the expected items."""