Merge pull request #33 from Exabyte-io/chore/SOF-7012

chore: add 'properties' and 'metaproperties' endpoints

Author: timurbazhirov

.github/workflows/cicd.yml

@@ -36,7 +36,7 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8]
+        python-version: [3.8.6]
 
     steps:
       - name: Checkout this repository
@@ -58,7 +58,6 @@ jobs:
           unit-test-directory: tests/unit
 
       - name: Run integration tests
-        if: matrix.python-version == '3.8'
         uses: ./actions/py/test
         with:
           integration-test-directory: tests/integration

exabyte_api_client/__init__.py

@@ -10,7 +10,7 @@
 from exabyte_api_client.endpoints.login import LoginEndpoint
 from exabyte_api_client.endpoints.logout import LogoutEndpoint
 from exabyte_api_client.endpoints.materials import MaterialEndpoints
+from exabyte_api_client.endpoints.metaproperties import MetaPropertiesEndpoints
 from exabyte_api_client.endpoints.projects import ProjectEndpoints
-from exabyte_api_client.endpoints.raw_properties import RawPropertiesEndpoints
-from exabyte_api_client.endpoints.refined_properties import RefinedPropertiesEndpoints
+from exabyte_api_client.endpoints.properties import PropertiesEndpoints
 from exabyte_api_client.endpoints.workflows import WorkflowEndpoints

exabyte_api_client/endpoints/refined_properties.py renamed to exabyte_api_client/endpoints/metaproperties.py

@@ -1,10 +1,10 @@
 from .enums import DEFAULT_API_VERSION, SECURE
-from .raw_properties import BasePropertiesEndpoints
+from .properties import BasePropertiesEndpoints
 
 
-class RefinedPropertiesEndpoints(BasePropertiesEndpoints):
+class MetaPropertiesEndpoints(BasePropertiesEndpoints):
     """
-    RefinedProperties endpoints.
+    MetaProperties endpoints.
 
     Args:
         host (str): Exabyte API hostname.
@@ -24,8 +24,8 @@ class RefinedPropertiesEndpoints(BasePropertiesEndpoints):
     """
 
     def __init__(self, host, port, account_id, auth_token, version=DEFAULT_API_VERSION, secure=SECURE, **kwargs):
-        super(RefinedPropertiesEndpoints, self).__init__(host, port, account_id, auth_token, version, secure, **kwargs)
-        self.name = "refined-properties"
+        super(MetaPropertiesEndpoints, self).__init__(host, port, account_id, auth_token, version, secure, **kwargs)
+        self.name = "metaproperties"
 
     def delete(self, id_):
         raise NotImplementedError

exabyte_api_client/endpoints/raw_properties.py renamed to exabyte_api_client/endpoints/properties.py

@@ -21,9 +21,9 @@ def get_direct_band_gap(self, job_id, unit_flowchart_id):
         return self.get_band_gap_by_type(job_id, unit_flowchart_id, "direct")
 
 
-class RawPropertiesEndpoints(BasePropertiesEndpoints):
+class PropertiesEndpoints(BasePropertiesEndpoints):
     """
-    RawProperties endpoints.
+    Properties endpoints.
 
     Args:
         host (str): Exabyte API hostname.
@@ -43,8 +43,8 @@ class RawPropertiesEndpoints(BasePropertiesEndpoints):
     """
 
     def __init__(self, host, port, account_id, auth_token, version=DEFAULT_API_VERSION, secure=SECURE, **kwargs):
-        super(RawPropertiesEndpoints, self).__init__(host, port, account_id, auth_token, version, secure, **kwargs)
-        self.name = "raw-properties"
+        super(PropertiesEndpoints, self).__init__(host, port, account_id, auth_token, version, secure, **kwargs)
+        self.name = "properties"
 
     def delete(self, id_):
         raise NotImplementedError

tests/integration/entity.py

@@ -1,5 +1,7 @@
 import time
 
+from requests.exceptions import HTTPError
+
 from tests.integration import BaseIntegrationTest
 
 
@@ -11,6 +13,7 @@ class EntityIntegrationTest(BaseIntegrationTest):
     def __init__(self, *args, **kwargs):
         super(EntityIntegrationTest, self).__init__(*args, **kwargs)
         self.endpoints = None
+        self.entity_id: str = ""
 
     def entities_selector(self):
         """
@@ -20,8 +23,21 @@ def entities_selector(self):
         return {"tags": "INTEGRATION-TEST"}
 
     def tearDown(self):
-        for entity in [e for e in self.endpoints.list(query=self.entities_selector())]:
-            self.endpoints.delete(entity["_id"])
+        """Delete only the current test entity if it still exists after test.
+
+        Warn if the filtering fails, failsafe attempt to delete the entity anyways.
+        """
+        tagged_test_entity_id_list = [e["_id"] for e in self.endpoints.list(query=self.entities_selector())]
+        try:
+            if self.entity_id not in tagged_test_entity_id_list:
+                print(
+                    f"WARNING: Entity with ID {self.entity_id} not found in the list of tagged entities:"
+                    f" {tagged_test_entity_id_list}"
+                )
+            self.endpoints.delete(self.entity_id)
+
+        except HTTPError as e:
+            print(f"WARNING: Failed to delete entity with ID {self.entity_id}: {e}")
 
     def get_default_config(self):
         """
@@ -33,9 +49,10 @@ def get_default_config(self):
     def create_entity(self, kwargs=None):
         entity = self.get_default_config()
         entity.update(kwargs or {})
-        entity["tags"] = entity.get("tags", [])
-        entity["tags"].append("INTEGRATION-TEST")
-        return self.endpoints.create(entity)
+        entity.setdefault("tags", []).append("INTEGRATION-TEST")
+        created_entity = self.endpoints.create(entity)
+        self.entity_id = created_entity["_id"]
+        return created_entity
 
     def list_entities_test(self):
         entity = self.create_entity()
@@ -47,9 +64,10 @@ def get_entity_by_id_test(self):
 
     def create_entity_test(self):
         name = "test-{}".format(time.time())
-        job = self.create_entity({"name": name})
-        self.assertEqual(job["name"], name)
-        self.assertIsNotNone(job["_id"])
+        entity = self.create_entity({"name": name})
+        self.assertEqual(entity["name"], name)
+        self.assertIsNotNone(entity["_id"])
+        self.assertIn("INTEGRATION-TEST", entity["tags"])
 
     def delete_entity_test(self):
         entity = self.create_entity()

tests/integration/test_jobs.py

@@ -42,7 +42,7 @@ def test_delete_job(self):
     def test_update_job(self):
         self.update_entity_test()
 
-    def _wait_for_job_to_finish(self, id_, timeout=300):
+    def _wait_for_job_to_finish(self, id_, timeout=600):
         end = time.time() + timeout
         while time.time() < end:
             job = self.endpoints.get(id_)

tests/unit/test_bank_materials.py

@@ -1,4 +1,4 @@
-import mock
+from unittest import mock
 from exabyte_api_client.endpoints.bank_materials import BankMaterialEndpoints
 from tests.unit.entity import EntityEndpointsUnitTest
 

tests/unit/test_bank_workflows.py

@@ -1,4 +1,4 @@
-import mock
+from unittest import mock
 from exabyte_api_client.endpoints.bank_workflows import BankWorkflowEndpoints
 from tests.unit.entity import EntityEndpointsUnitTest
 

tests/unit/test_httpBase.py

@@ -1,4 +1,4 @@
-import mock
+from unittest import mock
 from exabyte_api_client.utils.http import Connection
 from requests.exceptions import HTTPError
 from tests.unit import EndpointBaseUnitTest

tests/unit/test_jobs.py

@@ -1,4 +1,4 @@
-import mock
+from unittest import mock
 
 from exabyte_api_client.endpoints.jobs import JobEndpoints
 from tests.unit.entity import EntityEndpointsUnitTest