run integration tests (#74)

* run integration tests

* fix get_config test

* raising=False

* change all-tests

* skip licence validation

* fix doc tests

Author: malmans2

.github/workflows/on-push.yml

@@ -148,7 +148,7 @@ jobs:
 
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.12']
+        python-version: ['3.8', '3.12']
         extra: ['-ci']
 
     steps:
@@ -173,8 +173,10 @@ jobs:
       run: |
         python -m pip install --no-deps -e .
     - name: Run tests
+      env:
+        CADS_API_URL: ${{ secrets.CADS_API_URL }}
       run: |
-        make unit-tests COV_REPORT=xml
+        make all-tests COV_REPORT=xml
 
   distribution:
     runs-on: ubuntu-latest

Makefile

@@ -39,4 +39,4 @@ integration-tests:
 doc-tests:
 	python -m pytest -vv --doctest-glob='*.md' README.md
 
-all-tests: default integration-tests doc-tests
+all-tests: unit-tests integration-tests doc-tests

README.md

@@ -12,8 +12,11 @@ it is designed to be the least performant option to access the system.
 Draft Python API:
 
 ```python
+>>> import os
+>>> anon_key = os.getenv("CADS_API_ANON_KEY", "00112233-4455-6677-c899-aabbccddeeff")
+
 >>> import cads_api_client
->>> client = cads_api_client.ApiClient()
+>>> client = cads_api_client.ApiClient(key=anon_key)
 >>> assert client.check_authentication()
 
 >>> collection = client.collection("reanalysis-era5-pressure-levels")

tests/integration_test_40_api_client.py

@@ -4,6 +4,7 @@
 import datetime
 import os
 import pathlib
+import warnings
 from typing import Any
 
 import pytest
@@ -21,7 +22,12 @@ def api_anon_client(api_root_url: str, api_anon_key: str) -> ApiClient:
 
 
 def test_accept_licence() -> None:
-    client = ApiClient(maximum_tries=0)
+    with warnings.catch_warnings():
+        warnings.simplefilter("ignore")
+        client = ApiClient(maximum_tries=0)
+
+    if client.key is None:
+        pytest.skip("The API key is missing")
 
     licence = client.licences["licences"][0]
     licence_id = licence["id"]

tests/test_10_config.py

@@ -34,15 +34,18 @@ def test_read_configuration_error(tmp_path: pathlib.Path) -> None:
         config.read_configuration_file("non-existent-file")
 
 
-def test_get_config_from_configuration_file(tmp_path: pathlib.Path) -> None:
+def test_get_config_from_configuration_file(
+    tmp_path: pathlib.Path, monkeypatch: pytest.MonkeyPatch
+) -> None:
+    monkeypatch.delenv("CADS_API_KEY", raising=False)
+    monkeypatch.delenv("CADS_API_URL", raising=False)
     expected_config = {"url": "dummy-url", "key": "dummy-key"}
 
     config_file = tmp_path / ".cads-api-client.json"
     with config_file.open("w") as fp:
         json.dump(expected_config, fp)
 
     res = config.get_config("url", str(config_file))
-
     assert res == expected_config["url"]
 
     with pytest.raises(KeyError):