Standalone tests progress for client.py

Author: abhaasgoyal

meorg_client/tests/test_client.py

@@ -5,6 +5,8 @@
 from meorg_client.client import Client
 import meorg_client.utilities as mu
 from conftest import store
+
+# from requests import RequestException
 import tempfile as tf
 import time
 
@@ -37,20 +39,6 @@ def _get_authenticated_client() -> Client:
     return client
 
 
-@pytest.fixture
-def model_output_id() -> str:
-    """Get the model output ID.
-
-    Returns
-    -------
-    str
-        Model output ID.
-    """
-    # response = client.model_output_create(model_profile_id, model_output_name)
-    # if client failure then use from env
-    return os.environ.get("MEORG_MODEL_OUTPUT_ID")
-
-
 @pytest.fixture
 def client() -> Client:
     """Get an authenticated client.
@@ -95,89 +83,131 @@ def test_list_endpoints(client: Client):
     assert isinstance(response, dict)
 
 
-def test_create_model_output(
-    client: Client, model_profile_id: str, model_output_name: str
-):
-    """Test Creation of Model output."""
-    response = client.model_output_create(model_profile_id, model_output_name)
-    assert client.success()
+@pytest.fixture
+def model_output_generator(client: Client, model_profile_id):
+    model_output_ids = []
 
-    model_output_id = response.get("data").get("modeloutput")
-    assert model_output_id is not None
+    def _make_model_output(model_output_name):
+        response = client.model_output_create(model_profile_id, model_output_name)
+        model_output_id = response.get("data").get("modeloutput")
+        model_output_ids.append(model_output_id)
+        return model_output_id
 
-    store.set("model_output_id", model_output_id)
-    test_model_output_query(client, model_output_id)
+    yield _make_model_output
 
+    # TODO: Make tests more tight
+    # try:
+    #     for model_output_id in model_output_ids:
+    #         client.model_output_delete(model_output_id)
+    # except RequestException:
+    #     pass
 
-def test_model_output_query(client: Client):
-    """Test Existing Model output."""
-    response = client.model_output_query(store.get("model_output_id"))
-    assert client.success()
 
-    response_model_output_data = response.get("data").get("modeloutput")
-    assert response_model_output_data.get("id") == model_output_id
+@pytest.fixture
+def model_output_id(client: Client, model_output_generator: str):
+    return model_output_generator("model_output_test")
 
 
-def test_model_output_update(
-    client: Client,
-    model_profile_id: str,
-):
-    """Test updation of model output."""
-
-    update_data = {
-        "name": "updated_mo_name",
-        "model": model_profile_id,
-        "state_selection": "default model initialisation",
-        "parameter_selection": "automated calibration",
-        "comments": "updated model output pytest",
-        "is_bundle": False,
-    }
-    _ = client.model_output_update(store.get("model_output_id"), update_data)
-    assert client.success()
+class ModelOutput:
 
+    def test_create_model_output(
+        self, client: Client, model_profile_id: str, model_output_name: str
+    ):
+        """Test Creation of Model output."""
+        response = client.model_output_create(model_profile_id, model_output_name)
+        assert client.success()
 
-class TestBenchmark:
-    pass
-    # Create temporary new model output and have it benchmarked against that
+        model_output_id = response.get("data").get("modeloutput")
+        assert model_output_id is not None
 
+        store.set("model_output_id", model_output_id)
 
-def test_model_output_benchmarks_list(client: Client, experiment_id: str):
-    test_model_output_experiments_extend(client, experiment_id)
-    response = client.model_output_benchmarks_list(
-        store.get("model_output_id"), experiment_id
-    )
+        self.test_model_output_query(client, model_output_id)
 
-    benchmarks_list = response.get("data").get("benchmarks")
+    def test_model_output_query(self, client: Client, model_output_id: str):
+        """Test Existing Model output."""
+        # response = client.model_output_query(store.get("model_output_id"))
+        response = client.model_output_query(model_output_id)
+        assert client.success()
 
-    assert type(benchmarks_list) is list
-    assert len(benchmarks_list) > 0
+        response_model_output_data = response.get("data").get("modeloutput")
+        assert response_model_output_data.get("id") == model_output_id
 
-    store.set("sample_benchmark_id", benchmarks_list[0]["id"])
+    def test_model_output_update(
+        self,
+        client: Client,
+        model_profile_id: str,
+    ):
+        """Test updation of model output."""
 
-    assert client.success()
+        update_data = {
+            "name": "updated_mo_name",
+            "model": model_profile_id,
+            "state_selection": "default model initialisation",
+            "parameter_selection": "automated calibration",
+            "comments": "updated model output pytest",
+            "is_bundle": False,
+        }
+        _ = client.model_output_update(store.get("model_output_id"), update_data)
+        assert client.success()
 
+    def test_model_output_delete(client: Client, model_output_id: str):
+        _ = client.model_output_delete(model_output_id)
+        assert client.success()
 
-def test_model_output_benchmarks_replace(client: Client, experiment_id: str):
-    client.model_output_benchmarks_replace(
-        store.get("model_output_id"), experiment_id, [store.get("sample_benchmark_id")]
-    )
-    assert client.success()
 
+class TestBenchmark:
 
-def test_model_output_experiments_extend(client: Client, experiment_id: str):
-    client.model_output_experiments_extend(
-        store.get("model_output_id"), [experiment_id]
-    )
-    assert client.success()
+    # This model_output_id will always have multiple benchmarks
+    @pytest.fixture
+    def model_output_id(
+        self, client: Client, model_output_generator, experiment_id: str
+    ):
+        id1 = model_output_generator("model_output_benchmark1")
+        id2 = model_output_generator("model_output_benchmark2")
+        client.model_output_experiments_extend(id1, [experiment_id])
+        client.model_output_experiments_extend(id2, [experiment_id])
+        return id1
+
+    def test_model_output_benchmarks_list(
+        self, client: Client, model_output_id: str, experiment_id: str
+    ):
+
+        response = client.model_output_benchmarks_list(model_output_id, experiment_id)
 
+        benchmarks_list = response.get("data").get("benchmarks")
 
-def test_model_output_experiment_delete(client: Client, experiment_id: str):
-    client.model_output_experiment_delete(store.get("model_output_id"), experiment_id)
+        assert type(benchmarks_list) is list
+        assert len(benchmarks_list) > 0
+
+        store.set("sample_benchmark_id", benchmarks_list[0]["id"])
+
+        assert client.success()
+
+    def test_model_output_benchmarks_replace(
+        self, client: Client, model_output_id: str, experiment_id: str
+    ):
+        client.model_output_benchmarks_replace(
+            model_output_id,
+            experiment_id,
+            [store.get("sample_benchmark_id")],
+        )
+        assert client.success()
+
+
+def test_model_output_experiments_extend(
+    client: Client, model_output_id: str, experiment_id: str
+):
+    client.model_output_experiments_extend(model_output_id, [experiment_id])
     assert client.success()
 
 
-def test_model_output_delete(client: Client):
-    _ = client.model_output_delete(store.get("model_output_id"))
+def test_model_output_experiment_delete(
+    client: Client, model_output_id: str, experiment_id: str
+):
+    # For now, since fresh model output id
+    client.model_output_experiments_extend(model_output_id, [experiment_id])
+    client.model_output_experiment_delete(model_output_id, experiment_id)
     assert client.success()
 
 
@@ -243,37 +273,53 @@ def test_file_list(client: Client, model_output_id: str):
     store.set("file_list", response)
 
 
-def test_start_analysis(client: Client, model_output_id: str, experiment_id: str):
-    """Test starting an analysis.
-
-    Parameters
-    ----------
-    client : Client
-        Client.
-    model_output_id : str
-        Model output ID.
-    """
-    # Wait 5s for data to move from cache to store (otherwise analysis will fail, still might)
-    time.sleep(5)
-    response = client.start_analysis(model_output_id, experiment_id)
-    assert client.success()
-
-    # Store result for status check below
-    store.set("start_analysis", response)
-
-
-def test_get_analysis_status(client: Client):
-    """Test getting the analysis status.
-
-    Parameters
-    ----------
-    client : Client
-        Client.
-    """
-    # Get the analysis id from the store
-    analysis_id = store.get("start_analysis").get("data").get("analysisId")
-    _ = client.get_analysis_status(analysis_id)
-    assert client.success()
+class TestAnalysis:
+
+    @pytest.fixture
+    def model_output_id_analysis(
+        self,
+        client: Client,
+        test_filepath: str,
+        experiment_id: str,
+        model_output_generator,
+    ):
+        model_output_id = model_output_generator("model_output_analysis_test")
+        client.model_output_experiments_extend(model_output_id, [experiment_id])
+        client.upload_files([test_filepath, test_filepath], model_output_id)
+        return model_output_id
+
+    def test_start_analysis(
+        self, client: Client, model_output_id_analysis: str, experiment_id: str
+    ):
+        """Test starting an analysis.
+
+        Parameters
+        ----------
+        client : Client
+            Client.
+        model_output_id : str
+            Model output ID.
+        """
+        # Wait 5s for data to move from cache to store (otherwise analysis will fail, still might)
+        time.sleep(5)
+        response = client.start_analysis(model_output_id_analysis, experiment_id)
+        assert client.success()
+
+        # Store result for status check below
+        store.set("start_analysis", response)
+
+    def test_get_analysis_status(self, client: Client):
+        """Test getting the analysis status.
+
+        Parameters
+        ----------
+        client : Client
+            Client.
+        """
+        # Get the analysis id from the store
+        analysis_id = store.get("start_analysis").get("data").get("analysisId")
+        _ = client.get_analysis_status(analysis_id)
+        assert client.success()
 
 
 @pytest.mark.xfail(strict=False)