add tests

Author: Laura Sandoval

imap_data_access/cli.py

@@ -450,7 +450,13 @@ def add_query_args(subparser: ArgumentParser) -> None:
         "--type",
         type=str,
         required=False,
-        help="SPICE kernel type (e.g. ephemeris_predicted). Only used with --table spice.",
+        help="SPICE kernel type. Only used with --table spice. "
+        "Valid types: attitude_history, attitude_predict, spin, repoint, "
+        "ephemeris_reconstructed, ephemeris_nominal, ephemeris_predicted, "
+        "ephemeris_90days, ephemeris_long, ephemeris_launch, planetary_ephemeris, "
+        "planetary_constants, leapseconds, pointing_attitude, spacecraft_clock, "
+        "imap_frames, science_frames, metakernel, thruster, lagrange_point, "
+        "earth_attitude.",
     )
     subparser.set_defaults(func=_query_parser)
 

tests/test_cli.py

@@ -16,6 +16,29 @@ def test_cli_works():
             cli.main()
 
 
+def test_cli_spice_query(capsys):
+    """Test the CLI SPICE query command."""
+    with mock.patch.object(
+        sys,
+        "argv",
+        [
+            "imap-data-access",
+            "query",
+            "--table",
+            "spice",
+            "--type",
+            "ephemeris_predicted",
+        ],
+    ):
+        with mock.patch(
+            "imap_data_access.cli.spice_query", return_value=[]
+        ) as mock_spice_query:
+            cli.main()
+    captured = capsys.readouterr()
+    assert "Found [0] matching files" in captured.out
+    mock_spice_query.assert_called_once_with(type="ephemeris_predicted")
+
+
 def test_cli_error_message(capsys):
     """Test the CLI error message when no arguments are passed."""
     with mock.patch.object(

tests/test_io.py

@@ -283,6 +283,91 @@ def test_query_bad_params(mock_send_request):
     assert mock_send_request.call_count == 0
 
 
+@pytest.mark.parametrize(
+    "query_params",
+    [
+        # All parameters should send full query
+        {
+            "start_date": "20100101",
+            "end_date": "20100102",
+            "ingestion_start_date": "20100101",
+            "ingestion_end_date": "20100102",
+            "type": "ephemeris_predicted",
+            "version": "v000",
+        },
+        # Make sure not all query params are sent if they are missing
+        {"type": "ephemeris_predicted"},
+        # Ingestion dates are remapped to /spice-query naming convention
+        {"ingestion_start_date": "20100101", "ingestion_end_date": "20100102"},
+        # version=latest maps to latest=true
+        {"type": "ephemeris_predicted", "version": "latest"},
+    ],
+)
+def test_spice_query(mock_send_request, query_params: dict):
+    """Test a basic call to the SPICE Query API.
+
+    Parameters
+    ----------
+    mock_send_request : unittest.mock.MagicMock
+        Mock object for requests.Session
+    query_params : dict
+        Dictionary of key/value pairs that set the query parameters
+    """
+    mock_response = MagicMock()
+    mock_response.json.return_value = []
+    mock_send_request.return_value = mock_response
+
+    response = imap_data_access.spice_query(**query_params)
+    # No data found, and JSON decoding works as expected
+    assert response == list()
+
+    # Should have only been one call to send
+    mock_send_request.assert_called_once()
+    # Assert that the correct URL was used for the query
+    sent_request = mock_send_request.call_args[0][0]
+    called_url = sent_request.url
+    # Mirror the remapping logic in spice_query
+    fixed_query = query_params.copy()
+    if fixed_query.get("version") == "latest":
+        del fixed_query["version"]
+        fixed_query["latest"] = "true"
+    if "ingestion_start_date" in fixed_query:
+        fixed_query["start_ingest_date"] = fixed_query.pop("ingestion_start_date")
+    if "ingestion_end_date" in fixed_query:
+        fixed_query["end_ingest_date"] = fixed_query.pop("ingestion_end_date")
+    str_params = "&".join(f"{k}={v}" for k, v in fixed_query.items())
+    expected_url_encoded = f"https://api.test.com/spice-query?{str_params}"
+    assert called_url == expected_url_encoded
+
+
+def test_spice_query_no_params(mock_send_request):
+    """Test a call to the SPICE Query API that has no parameters.
+
+    Parameters
+    ----------
+    mock_send_request : unittest.mock.MagicMock
+        Mock object for ``requests.session``
+    """
+    with pytest.raises(ValueError, match="At least one query"):
+        imap_data_access.spice_query()
+    # Should not have made any calls to urlopen
+    assert mock_send_request.call_count == 0
+
+
+def test_spice_query_bad_params(mock_send_request):
+    """Test a call to the SPICE Query API that has invalid parameters.
+
+    Parameters
+    ----------
+    mock_send_request : unittest.mock.MagicMock
+        Mock object for ``requests.session``
+    """
+    with pytest.raises(TypeError, match="got an unexpected"):
+        imap_data_access.spice_query(bad_param="test")
+    # Should not have made any calls to urlopen
+    assert mock_send_request.call_count == 0
+
+
 @pytest.mark.parametrize(
     ("query_flag", "query_input", "expected_output"),
     [