category manage (#193)

* category manage

* pre commit

Co-authored-by: Joey Gibson <jgibson@saltstack.com>

Author: joechainz

src/saltext/vmware/modules/datastore.py

@@ -25,49 +25,49 @@ def __virtual__():
     return __virtualname__
 
 
-def maintenance_mode(datastore_name, dc_name=None, service_instance=None):
+def maintenance_mode(datastore_name, datacenter_name=None, service_instance=None):
     """
     Put datastore in maintenance mode.
 
     datastore_name
         Name of datastore.
 
-    dc_name
-        Name of datacenter where folder will be created.
+    datacenter_name
+        (optional) Name of datacenter where datastore exists.
 
     service_instance
         (optional) The Service Instance from which to obtain managed object references.
     """
     if service_instance is None:
         service_instance = get_service_instance(opts=__opts__, pillar=__pillar__)
     dc_ref = None
-    if dc_name:
-        dc_ref = utils_common.get_datacenter(service_instance, dc_name)
+    if datacenter_name:
+        dc_ref = utils_common.get_datacenter(service_instance, datacenter_name)
     ds = utils_common.get_datastore(datastore_name, dc_ref, service_instance)
     ret = utils_common.datastore_enter_maintenance_mode(ds)
     if ret:
         return {"maintenanceMode": "inMaintenance"}
     return {"maintenanceMode": "failed to enter maintenance mode"}
 
 
-def exit_maintenance_mode(datastore_name, dc_name=None, service_instance=None):
+def exit_maintenance_mode(datastore_name, datacenter_name=None, service_instance=None):
     """
     Take datastore out of maintenance mode.
 
     datastore_name
         Name of datastore.
 
-    dc_name
-        Name of datacenter where folder will be created.
+    datacenter_name
+        (optional) Name of datacenter where datastore exists.
 
     service_instance
         (optional) The Service Instance from which to obtain managed object references.
     """
     if service_instance is None:
         service_instance = get_service_instance(opts=__opts__, pillar=__pillar__)
     dc_ref = None
-    if dc_name:
-        dc_ref = utils_common.get_datacenter(service_instance, dc_name)
+    if datacenter_name:
+        dc_ref = utils_common.get_datacenter(service_instance, datacenter_name)
     ds = utils_common.get_datastore(datastore_name, dc_ref, service_instance)
     ret = utils_common.datastore_exit_maintenance_mode(ds)
     if ret:

src/saltext/vmware/modules/tag.py

@@ -142,3 +142,93 @@ def get_category(category_id):
     response = connect.request(url, "GET", opts=__opts__, pillar=__pillar__)
     response = response["response"].json()
     return {"category": response["value"]}
+
+
+def create_category(category_name, associable_types, cardinality, description=""):
+    """
+    Create a new category.
+
+    category_name
+        The display name of the category.
+
+    associable_types
+        (list) Object types to which this category’s tags can be attached.
+
+    cardinality
+        The CategoryModel.Cardinality enumerated type defines the number of tags in a category that can be assigned to an object. SINGLE, MULTIPLE
+
+    description
+        (optional) The description of the category.
+    """
+    data = {
+        "create_spec": {
+            "associable_types": associable_types,
+            "cardinality": cardinality,
+            "description": description,
+            "name": category_name,
+        }
+    }
+    response = connect.request(
+        "/rest/com/vmware/cis/tagging/category", "POST", body=data, opts=__opts__, pillar=__pillar__
+    )
+    response = response["response"].json()
+    return {"category": response["value"]}
+
+
+def update_category(
+    category_id, category_name=None, associable_types=None, cardinality=None, description=""
+):
+    """
+    Update a new category.
+
+    category_id
+        The identifier of the category to be updated. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.
+
+    category_name
+        The display name of the category.
+
+    associable_types
+        (list) Object types to which this categorys tags can be attached.
+
+    cardinality
+        The CategoryModel.Cardinality enumerated type defines the number of tags in a category that can be assigned to an object. SINGLE, MULTIPLE
+
+    description
+        (optional) The description of the category.
+    """
+    spec = {"update_spec": {}}
+    if category_name:
+        spec["update_spec"]["name"] = category_name
+    if associable_types:
+        spec["update_spec"]["associable_types"] = associable_types
+    if cardinality:
+        spec["update_spec"]["cardinality"] = cardinality
+    if description:
+        spec["update_spec"]["description"] = description
+    url = f"/rest/com/vmware/cis/tagging/category/id:{category_id}"
+    response = connect.request(url, "PATCH", body=spec, opts=__opts__, pillar=__pillar__)
+    if response["response"].status_code == 200:
+        return {"category": "updated"}
+    return {
+        "category": "failed to update",
+        "status_code": response["response"].status_code,
+        "reason": response["response"].reason,
+    }
+
+
+def delete_category(category_id):
+    """
+    Delete given category.
+
+    category_id
+        The identifier of category to be deleted. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.
+    """
+    url = f"/rest/com/vmware/cis/tagging/category/id:{category_id}"
+    response = connect.request(url, "DELETE", opts=__opts__, pillar=__pillar__)
+    if response["response"].status_code == 200:
+        return {"category": "deleted"}
+    return {
+        "category": "failed to update",
+        "status_code": response.status_code,
+        "reason": response.reason,
+    }

src/saltext/vmware/states/tag.py

@@ -28,7 +28,7 @@ def __virtual__():
 
 def present(name, description=None, category_id=None):
     """
-    Create and update a tag instance.
+    Create or update a tag instance.
 
     name
         Name of tag.
@@ -151,3 +151,143 @@ def absent(name):
     else:
         ret["comment"] = "Tag does not exist"
         return ret
+
+
+def present_category(name, associable_types, cardinality, description=""):
+    """
+    Create or update a category.
+
+    name
+        The display name of the category.
+
+    associable_types
+        (list) Object types to which this category’s tags can be attached.
+
+    cardinality
+        The CategoryModel.Cardinality enumerated type defines the number of tags in a category that can be assigned to an object. SINGLE, MULTIPLE
+
+    description
+        (optional) The description of the category.
+    """
+    ret = {"name": name, "changes": {}, "result": True, "comment": ""}
+    res = connect.request(
+        "/rest/com/vmware/cis/tagging/category", "GET", opts=__opts__, pillar=__pillar__
+    )
+    response = res["response"].json()
+    token = res["token"]
+    found = None
+    for cat in response["value"]:
+        url = f"/rest/com/vmware/cis/tagging/category/id:{cat}"
+        cat_ref = connect.request(url, "GET", token=token, opts=__opts__, pillar=__pillar__)
+        cat_ref = cat_ref["response"].json()
+        if cat_ref["value"]["name"] == name:
+            found = cat_ref["value"]
+            break
+    if found:
+        if (
+            associable_types == found["associable_types"]
+            and cardinality == found["cardinality"]
+            and description == found["description"]
+        ):
+            ret["comment"] = "category exists"
+            return ret
+        else:
+            ret["changes"]["new"] = {}
+            ret["changes"]["old"] = {}
+            if associable_types != found["associable_types"]:
+                ret["changes"]["old"]["associable_types"] = found["associable_types"]
+                ret["changes"]["new"]["associable_types"] = associable_types
+            if cardinality != found["cardinality"]:
+                ret["changes"]["old"]["cardinality"] = found["cardinality"]
+                ret["changes"]["new"]["cardinality"] = cardinality
+            if description != found["description"]:
+                ret["changes"]["old"]["description"] = found["description"]
+                ret["changes"]["new"]["description"] = description
+            if __opts__["test"]:
+                ret["result"] = None
+                ret["comment"] = f"{name} category will be updated"
+                return ret
+            id = found["id"]
+            spec = {"update_spec": {}}
+            if associable_types:
+                spec["update_spec"]["associable_types"] = associable_types
+            if cardinality:
+                spec["update_spec"]["cardinality"] = cardinality
+            if description:
+                spec["update_spec"]["description"] = description
+            url = f"/rest/com/vmware/cis/tagging/category/id:{id}"
+            updated = connect.request(url, "PATCH", body=spec, opts=__opts__, pillar=__pillar__)
+            if updated["response"].status_code == 200:
+                ret["comment"] = "updated"
+                return ret
+            ret["status_code"] = updated["response"].status_code
+            ret["reason"] = updated["response"].reason
+            ret["comment"] = "failed to update"
+            ret["result"] = False
+            return ret
+    else:
+        if __opts__["test"]:
+            ret["result"] = None
+            ret["comment"] = f"{name} category will be created"
+            return ret
+        data = {
+            "create_spec": {
+                "associable_types": associable_types,
+                "cardinality": cardinality,
+                "description": description,
+                "name": name,
+            }
+        }
+        create = connect.request(
+            "/rest/com/vmware/cis/tagging/category",
+            "POST",
+            body=data,
+            opts=__opts__,
+            pillar=__pillar__,
+        )
+        response = create["response"].json()
+        ret["changes"]["category_id"] = response["value"]
+        ret["comment"] = "created"
+        return ret
+
+
+def absent_category(name):
+    """
+    Delete category.
+
+    name
+        Name of category.
+    """
+    ret = {"name": name, "changes": {}, "result": True, "comment": ""}
+    res = connect.request(
+        "/rest/com/vmware/cis/tagging/category", "GET", opts=__opts__, pillar=__pillar__
+    )
+    response = res["response"].json()
+    token = res["token"]
+    found = None
+    for cat in response["value"]:
+        url = f"/rest/com/vmware/cis/tagging/category/id:{cat}"
+        cat_ref = connect.request(url, "GET", token=token, opts=__opts__, pillar=__pillar__)
+        cat_ref = cat_ref["response"].json()
+        if cat_ref["value"]["name"] == name:
+            found = cat_ref["value"]
+            break
+    if found:
+        if __opts__["test"]:
+            ret["result"] = None
+            ret["comment"] = f"{name} category will be deleted"
+            return ret
+        id = found["id"]
+        url = f"/rest/com/vmware/cis/tagging/category/id:{id}"
+        delete = connect.request(url, "DELETE", opts=__opts__, pillar=__pillar__)
+        if delete["response"].status_code == 200:
+            ret["comment"] = "deleted"
+            return ret
+        ret["status_code"] = delete["response"].status_code
+        ret["reason"] = delete["response"].reason
+        ret["comment"] = "failed to delete"
+        ret["result"] = False
+        return ret
+    else:
+        ret["comment"] = "Category does not exist"
+        return ret

tests/integration/conftest.py

@@ -278,7 +278,29 @@ def patch_salt_globals_tag_state(vmware_conf):
     Patch __opts__ and __pillar__
     """
 
-    setattr(tagging_state, "__opts__", {})
+    setattr(
+        tagging_state,
+        "__opts__",
+        {
+            "test": False,
+        },
+    )
+    setattr(tagging_state, "__pillar__", vmware_conf)
+
+
+@pytest.fixture
+def patch_salt_globals_tag_state_test(vmware_conf):
+    """
+    Patch __opts__ and __pillar__
+    """
+
+    setattr(
+        tagging_state,
+        "__opts__",
+        {
+            "test": True,
+        },
+    )
     setattr(tagging_state, "__pillar__", vmware_conf)
 
 

tests/integration/modules/test_tag.py

@@ -92,3 +92,47 @@ def test_tag_delete(patch_salt_globals_tag):
                 break
     else:
         pytest.skip("test requires at least one tag")
+
+
+def test_cat_create(patch_salt_globals_tag):
+    """
+    Test create category functionality
+    """
+    res = tagging.create_category("test cat", ["string"], "SINGLE", "test category")
+    assert "urn:vmomi:InventoryServiceCategory:" in res["category"]
+
+
+def test_cat_update(patch_salt_globals_tag):
+    """
+    Test update category functionality
+    """
+    cats = tagging.list_category()
+    if len(cats["categories"]) > 0:
+        for cat in cats["categories"]:
+            res = tagging.get_category(cat)
+            if res["category"]["name"] == "test cat":
+                update_res = tagging.update_category(
+                    res["category"]["id"],
+                    res["category"]["name"],
+                    res["category"]["associable_types"],
+                    res["category"]["cardinality"],
+                    "new description",
+                )
+                assert "updated" in update_res["category"]
+    else:
+        pytest.skip("test requires at least one category")
+
+
+def test_cat_delete(patch_salt_globals_tag):
+    """
+    Test update category functionality
+    """
+    cats = tagging.list_category()
+    if len(cats["categories"]) > 0:
+        for cat in cats["categories"]:
+            res = tagging.get_category(cat)
+            if res["category"]["name"] == "test cat":
+                delete_res = tagging.delete_category(res["category"]["id"])
+                assert "deleted" in delete_res["category"]
+    else:
+        pytest.skip("test requires at least one category")