Merge pull request #1041 from planetlabs/steve/data-api-tests

add Data API search tests using positional args

Author: stephenhillier

.gitignore

@@ -26,3 +26,4 @@ coverage.xml
 .vscode/
 # Docs build
 site
+.venv

tests/integration/test_data_api.py

@@ -211,7 +211,8 @@ async def test_search_filter(item_descriptions,
 
     cl = DataClient(session, base_url=TEST_URL)
     items_list = [
-        i async for i in cl.search(['PSScene'], search_filter=search_filter)
+        i async for i in cl.search(item_types=['PSScene'],
+                                   search_filter=search_filter)
     ]
 
     # check that request is correct
@@ -223,6 +224,35 @@ async def test_search_filter(item_descriptions,
     assert items_list == item_descriptions
 
 
+@respx.mock
+@pytest.mark.anyio
+async def test_search_filter_positional_args(item_descriptions,
+                                             search_filter,
+                                             search_response,
+                                             session):
+    """test the search method using positional args"""
+
+    quick_search_url = f'{TEST_URL}/quick-search'
+
+    item1, item2, item3 = item_descriptions
+    response = {"features": [item1, item2, item3]}
+    mock_resp = httpx.Response(HTTPStatus.OK, json=response)
+    respx.post(quick_search_url).return_value = mock_resp
+
+    cl = DataClient(session, base_url=TEST_URL)
+
+    # search using a positional arg for the filter.
+    items_list = [i async for i in cl.search(['PSScene'], search_filter)]
+
+    # check that request is correct
+    expected_request = {"item_types": ["PSScene"], "filter": search_filter}
+    actual_body = json.loads(respx.calls[0].request.content)
+    assert actual_body == expected_request
+
+    # check that all of the items were returned unchanged
+    assert items_list == item_descriptions
+
+
 @respx.mock
 @pytest.mark.anyio
 async def test_search_sort(item_descriptions,
@@ -295,7 +325,7 @@ async def test_create_search_basic(search_filter, session):
     respx.post(TEST_SEARCHES_URL).return_value = mock_resp
 
     cl = DataClient(session, base_url=TEST_URL)
-    search = await cl.create_search(['PSScene'],
+    search = await cl.create_search(item_types=['PSScene'],
                                     search_filter=search_filter,
                                     name='test')
 
@@ -313,6 +343,43 @@ async def test_create_search_basic(search_filter, session):
     assert search == page_response
 
 
+@respx.mock
+@pytest.mark.anyio
+async def test_create_search_basic_positional_args(search_filter, session):
+    """Test that positional arguments are accepted for create_search"""
+
+    page_response = {
+        "__daily_email_enabled": False,
+        "_links": {
+            "_self": "string", "thumbnail": "string"
+        },
+        "created": "2019-08-24T14:15:22Z",
+        "filter": search_filter,
+        "id": "string",
+        "last_executed": "2019-08-24T14:15:22Z",
+        "name": "test",
+        "updated": "2019-08-24T14:15:22Z"
+    }
+    mock_resp = httpx.Response(HTTPStatus.OK, json=page_response)
+    respx.post(TEST_SEARCHES_URL).return_value = mock_resp
+
+    cl = DataClient(session, base_url=TEST_URL)
+    search = await cl.create_search(['PSScene'], search_filter, name='test')
+
+    # check that request is correct
+    expected_request = {
+        "item_types": ["PSScene"],
+        "filter": search_filter,
+        "name": "test",
+        "__daily_email_enabled": False
+    }
+    actual_body = json.loads(respx.calls[0].request.content)
+    assert actual_body == expected_request
+
+    # check the response is returned unaltered
+    assert search == page_response
+
+
 @respx.mock
 @pytest.mark.anyio
 async def test_create_search_email(search_filter, session):
@@ -420,6 +487,46 @@ async def test_update_search_basic(search_filter, session):
     assert search == page_response
 
 
+@respx.mock
+@pytest.mark.anyio
+async def test_update_search_basic_positional_args(search_filter, session):
+    """Test that positional arguments are accepted for update_search"""
+
+    page_response = {
+        "__daily_email_enabled": False,
+        "_links": {
+            "_self": "string", "thumbnail": "string"
+        },
+        "created": "2019-08-24T14:15:22Z",
+        "filter": search_filter,
+        "id": VALID_SEARCH_ID,
+        "last_executed": "2019-08-24T14:15:22Z",
+        "name": "test",
+        "updated": "2019-08-24T14:15:22Z"
+    }
+    mock_resp = httpx.Response(HTTPStatus.OK, json=page_response)
+    respx.put(
+        f'{TEST_SEARCHES_URL}/{VALID_SEARCH_ID}').return_value = mock_resp
+
+    cl = DataClient(session, base_url=TEST_URL)
+    search = await cl.update_search(VALID_SEARCH_ID, ['PSScene'],
+                                    search_filter,
+                                    name='test')
+
+    # check that request is correct
+    expected_request = {
+        "item_types": ["PSScene"],
+        "filter": search_filter,
+        "name": "test",
+        "__daily_email_enabled": False
+    }
+    actual_body = json.loads(respx.calls[0].request.content)
+    assert actual_body == expected_request
+
+    # check the response is returned unaltered
+    assert search == page_response
+
+
 @respx.mock
 @pytest.mark.anyio
 @pytest.mark.parametrize("limit, expected_list_length", [(None, 4), (3, 3)])