Add initial OpenSearch tests

Author: markgoddard

requirements.txt

@@ -1,2 +1,3 @@
+opensearch-py==2.5.*
 prometheus-api-client==0.5.*
 pytest-testinfra==10.1.*

stackhpc_openstack_tests/test_opensearch.py

@@ -0,0 +1,62 @@
+# Copyright (c) 2024 StackHPC Ltd.
+
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+# TODO:
+# * Dashboard login
+# * Cluster health
+
+from opensearchpy import OpenSearch
+import os
+import pytest
+
+from stackhpc_openstack_tests import utils
+
+
+@pytest.fixture
+def opensearch() -> OpenSearch:
+    """Pytest fixture that creates an OpenSearch API client."""
+    # https://opensearch.org/docs/latest/clients/python-low-level/
+    opensearch_hosts = os.environ["OPENSEARCH_HOSTS"].split(",")
+    opensearch_port = os.environ["OPENSEARCH_PORT"]
+    opensearch_hosts = [
+        {"host": host, "port": opensearch_port} for host in opensearch_hosts
+    ]
+    opensearch_tls = utils.str_to_bool(os.environ["OPENSEARCH_TLS"])
+    if opensearch_tls:
+        opensearch_verify_certs = utils.str_to_bool(
+            os.environ["OPENSEARCH_VERIFY_CERTS"]
+        )
+    else:
+        opensearch_verify_certs = True
+    return OpenSearch(
+        hosts=opensearch_hosts,
+        http_compress=True,
+        use_ssl=opensearch_tls,
+        verify_certs=opensearch_verify_certs,
+        ssl_show_warn=False,
+    )
+
+
+def test_opensearch_has_info_logs(opensearch):
+    """Check that OpenSearch has some INFO level logs."""
+    query = {
+        "query": {
+            "match": {
+                "log_level": "INFO",
+            }
+        }
+    }
+    # https://opensearch-project.github.io/opensearch-py/api-ref/clients/opensearch_client.html#opensearchpy.OpenSearch.search
+    result = opensearch.search(body=query, index="flog-*", size=1)
+    assert len(result["hits"]["hits"]) == 1

stackhpc_openstack_tests/utils.py

@@ -0,0 +1,18 @@
+# Copyright (c) 2024 StackHPC Ltd.
+
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+
+def str_to_bool(v):
+    """Convert a boolean true/false string to a bool."""
+    return v.lower() == "true"