feat: add support for creating metric index (#134)

**Issue number:**

### PR Type

**What kind of change does this PR introduce?**
* [x] Feature
* [ ] Bug Fix
* [ ] Refactoring (no functional or API changes)
* [ ] Documentation Update
* [ ] Maintenance (dependency updates, CI, etc.)

## Summary

These updates make it possible to create a metric index.
Test run with these changes:
https://github.com/splunk/splunk-add-on-for-microsoft-cloud-services/pull/1313/checks

Test using metric index `test_metrics_index_virtual_machines_basic` is
passing on noah and classic:

https://cd.splunkdev.com/taautomation/ta-automation-compatibility-tests/-/jobs/154571168

https://cd.splunkdev.com/taautomation/ta-automation-compatibility-tests/-/jobs/154571170

### Changes

Introduced a `datatype` parameter to index creation functions. By
default, it's `event` index

### User experience

Previously, only event indexes could be created. Now, users can choose
to create a metric index.

## Checklist

If an item doesn't apply to your changes, leave it unchecked.

* [x] I have performed a self-review of this change according to the
[development
guidelines](https://splunk.github.io/addonfactory-ucc-test/contributing/#development-guidelines)
* [ ] Tests have been added/modified to cover the changes [(testing
doc)](https://splunk.github.io/addonfactory-ucc-test/contributing/#build-and-test)
* [ ] Changes are documented
* [x] PR title and description follows the [contributing
principles](https://splunk.github.io/addonfactory-ucc-test/contributing/#pull-requests)

Author: pdzien-splunk

docs/framework_deepdive.md

@@ -82,7 +82,7 @@ Splunk client class is supposed to implement methods providing access to Splunk
 
 - *splunk_client.search(query)* - executes SPL search query at Splunk instance and returns result in SearchState class object (*splunk_add_on_ucc_modinput_test.common.splunk_instance.SearchState*)
 
-- *splunk_client.create_index(name)* - creates Splunk index with a given name and returns *splunklib.Index* object.
+- *splunk_client.create_index(name, datatype)* - creates Splunk index with a given name and data type (event or metric). Returns *splunklib.Index* object.
 
 - *splunk_client.default_index()* - returns default Splunk index name if framework configured to create one.
 

splunk_add_on_ucc_modinput_test/common/splunk_instance.py

@@ -91,7 +91,10 @@ def _get_index(
         acs_server: str | None = None,
         splunk_token: str | None = None,
     ) -> Index | None:
-        if any(i.name == index_name for i in client_service.indexes):
+        if any(
+            i.name == index_name
+            for i in client_service.indexes.iter(datatype="all")
+        ):
             return client_service.indexes[index_name]
         else:
             if (
@@ -130,13 +133,18 @@ def _validate_index_name(index_name: str) -> None:
 
     @staticmethod
     def _victoria_create_index(
-        index_name: str, *, acs_stack: str, acs_server: str, splunk_token: str
+        index_name: str,
+        *,
+        datatype: str,
+        acs_stack: str,
+        acs_server: str,
+        splunk_token: str,
     ) -> None:
         Configuration._validate_index_name(index_name)
         url = f"{acs_server}/{acs_stack}/adminconfig/v2/indexes"
         data = json.dumps(
             {
-                "datatype": "event",
+                "datatype": datatype,
                 "maxDataSizeMB": 0,
                 "name": index_name,
                 "searchableDays": 365,
@@ -210,12 +218,14 @@ def _victoria_create_index(
 
     @staticmethod
     def _enterprise_create_index(
-        index_name: str, client_service: Service
+        index_name: str, datatype: str, client_service: Service
     ) -> Index:
         idx_not_created_msg = f"Index {index_name} was not created on \
             instance {client_service.host}"
         try:
-            new_index = client_service.indexes.create(index_name)
+            new_index = client_service.indexes.create(
+                index_name, datatype=datatype
+            )
         except Exception as e:
             reason = f"{idx_not_created_msg}\nException raised:\n{e}"
             logger.critical(reason)
@@ -231,6 +241,7 @@ def _create_index(
         index_name: str,
         client_service: SplunkServicePool,
         *,
+        datatype: str = "event",
         is_cloud: bool = False,
         acs_stack: str | None = None,
         acs_server: str | None = None,
@@ -249,6 +260,7 @@ def _create_index(
         if is_cloud:
             Configuration._victoria_create_index(
                 index_name,
+                datatype=datatype,
                 acs_stack=acs_stack,
                 acs_server=acs_server,
                 splunk_token=splunk_token,
@@ -263,6 +275,7 @@ def _create_index(
         else:
             created_index = Configuration._enterprise_create_index(
                 index_name,
+                datatype,
                 client_service,
             )
         logger.debug(f"Index {index_name} has just been created")

splunk_add_on_ucc_modinput_test/functional/splunk/client.py

@@ -149,10 +149,11 @@ def search(self, searchquery: str) -> SearchState:
     def _is_cloud(self) -> bool:
         return "splunkcloud.com" in self.config.host.lower()
 
-    def create_index(self, index_name: str) -> Index:
+    def create_index(self, index_name: str, datatype: str = "event") -> Index:
         return self.config._create_index(
             index_name,
             self.splunk,
+            datatype=datatype,
             is_cloud=self._is_cloud,
             acs_stack=self.config.acs_stack if self._is_cloud else None,
             acs_server=self.config.acs_server if self._is_cloud else None,