Added integration test test_feature_schema_is_archived

Author: Tim-Kerr

labelbox/client.py

@@ -36,7 +36,7 @@
 from labelbox.schema.role import Role
 from labelbox.schema.slice import CatalogSlice, ModelSlice
 from labelbox.schema.queue_mode import QueueMode
-from labelbox.schema.ontology import Ontology
+from labelbox.schema.ontology import Ontology, DeleteFeatureFromOntologyResult
 
 from labelbox.schema.media_type import MediaType, get_media_type_validation_error
 
@@ -45,11 +45,6 @@
 _LABELBOX_API_KEY = "LABELBOX_API_KEY"
 
 
-class DeleteFeatureFromOntologyResult:
-    archived: bool
-    deleted: bool
-
-
 class Client:
     """ A Labelbox client.
 

labelbox/schema/ontology.py

@@ -11,11 +11,21 @@
 from labelbox.exceptions import InconsistentOntologyException
 from labelbox.orm.db_object import DbObject
 from labelbox.orm.model import Field, Relationship
+import json
 
 FeatureSchemaId: Type[str] = constr(min_length=25, max_length=25)
 SchemaId: Type[str] = constr(min_length=25, max_length=25)
 
 
+class DeleteFeatureFromOntologyResult:
+    archived: bool
+    deleted: bool
+
+    def __str__(self):
+        return "<%s %s>" % (self.__class__.__name__.split(".")[-1],
+                            json.dumps(self.__dict__))
+
+
 class FeatureSchema(DbObject):
     name = Field.String("name")
     color = Field.String("name")

tests/integration/test_ontology.py

@@ -5,14 +5,24 @@
 import json
 import time
 
-
-def test_is_feature_schema_archived(client, ontology):
+def test_feature_schema_is_not_archived(client, ontology):
     feature_schema_to_check = ontology.normalized['tools'][0]
     result = client.is_feature_schema_archived(
         ontology.uid, feature_schema_to_check['featureSchemaId'])
     assert result == False
 
 
+def test_feature_schema_is_archived(client, configured_project_with_label):
+    project, _, _, label = configured_project_with_label
+    ontology = project.ontology()
+    feature_schema_id = ontology.normalized['tools'][0]['featureSchemaId']
+    result = client.delete_feature_schema_from_ontology(ontology.uid,
+                                                        feature_schema_id)
+    assert result.archived == True and result.deleted == False
+    assert client.is_feature_schema_archived(ontology.uid,
+                                             feature_schema_id) == True
+
+
 def test_is_feature_schema_archived_for_non_existing_feature_schema(
         client, ontology):
     with pytest.raises(
@@ -21,7 +31,6 @@ def test_is_feature_schema_archived_for_non_existing_feature_schema(
         client.is_feature_schema_archived(ontology.uid,
                                           'invalid-feature-schema-id')
 
-
 def test_is_feature_schema_archived_for_non_existing_ontology(client, ontology):
     feature_schema_to_unarchive = ontology.normalized['tools'][0]
     with pytest.raises(
@@ -31,7 +40,6 @@ def test_is_feature_schema_archived_for_non_existing_ontology(client, ontology):
         client.is_feature_schema_archived(
             'invalid-ontology', feature_schema_to_unarchive['featureSchemaId'])
 
-
 def test_delete_tool_feature_from_ontology(client, ontology):
     feature_schema_to_delete = ontology.normalized['tools'][0]
     assert len(ontology.normalized['tools']) == 2
@@ -42,7 +50,6 @@ def test_delete_tool_feature_from_ontology(client, ontology):
     updatedOntology = client.get_ontology(ontology.uid)
     assert len(updatedOntology.normalized['tools']) == 1
 
-
 @pytest.mark.skip(reason="normalized ontology contains Relationship, "
                   "which is not finalized yet. introduce this back when"
                   "Relationship feature is complete and we introduce"
@@ -51,14 +58,12 @@ def test_from_project_ontology(project) -> None:
     o = OntologyBuilder.from_project(project)
     assert o.asdict() == project.ontology().normalized
 
-
 point = Tool(
     tool=Tool.Type.POINT,
     name="name",
     color="#ff0000",
 )
 
-
 def test_deletes_an_ontology(client):
     tool = client.upsert_feature_schema(point.asdict())
     feature_schema_id = tool.normalized['featureSchemaId']
@@ -71,7 +76,6 @@ def test_deletes_an_ontology(client):
 
     client.delete_unused_feature_schema(feature_schema_id)
 
-
 def test_cant_delete_an_ontology_with_project(client):
     project = client.create_project(name="test project",
                                     media_type=MediaType.Image)
@@ -94,7 +98,6 @@ def test_cant_delete_an_ontology_with_project(client):
     client.delete_unused_ontology(ontology.uid)
     client.delete_unused_feature_schema(feature_schema_id)
 
-
 def test_cant_delete_an_ontology_that_doesnt_exist(client):
     with pytest.raises(
             Exception,
@@ -103,7 +106,6 @@ def test_cant_delete_an_ontology_that_doesnt_exist(client):
     ):
         client.delete_unused_ontology("doesntexist")
 
-
 def test_inserts_a_feature_schema_at_given_position(client):
     tool1 = {'tool': 'polygon', 'name': 'tool1', 'color': 'blue'}
     tool2 = {'tool': 'polygon', 'name': 'tool2', 'color': 'blue'}
@@ -121,7 +123,6 @@ def test_inserts_a_feature_schema_at_given_position(client):
 
     client.delete_unused_ontology(ontology.uid)
 
-
 def test_moves_already_added_feature_schema_in_ontology(client):
     tool1 = {'tool': 'polygon', 'name': 'tool1', 'color': 'blue'}
     ontology_normalized_json = {"tools": [tool1], "classifications": []}
@@ -144,7 +145,6 @@ def test_moves_already_added_feature_schema_in_ontology(client):
 
     client.delete_unused_ontology(ontology.uid)
 
-
 def test_does_not_include_used_ontologies(client):
     tool = client.upsert_feature_schema(point.asdict())
     feature_schema_id = tool.normalized['featureSchemaId']
@@ -163,14 +163,12 @@ def test_does_not_include_used_ontologies(client):
     client.delete_unused_ontology(ontology_with_project.uid)
     client.delete_unused_feature_schema(feature_schema_id)
 
-
 def _get_attr_stringify_json(obj, attr):
     value = getattr(obj, attr.name)
     if attr.field_type.name.lower() == "json":
         return json.dumps(value, sort_keys=True)
     return value
 
-
 def test_feature_schema_create_read(client, rand_gen):
     name = f"test-root-schema-{rand_gen(str)}"
     feature_schema_cat_normalized = {
@@ -199,7 +197,6 @@ def test_feature_schema_create_read(client, rand_gen):
                                         attr) == _get_attr_stringify_json(
                                             queried_feature_schema, attr)
 
-
 def test_ontology_create_read(client, rand_gen):
     ontology_name = f"test-ontology-{rand_gen(str)}"
     tool_name = f"test-ontology-tool-{rand_gen(str)}"