Add conformance test script

Signed-off-by: Markus Hentsch <[email protected]>

Author: markus-hentsch

Standards/scs-01xx-v1-dns.md

@@ -160,4 +160,8 @@ In Neutron, this can be done by activating either the `subnet_dns_publish_fixed_
 
 ## Conformance Tests
 
-Conformance Tests, OPTIONAL
+Conformance tests verify the existence of necessary APIs and API extensions as mandated by the standard.
+
+There is a test suite in [`dns-extensions-check.py`](https://github.com/SovereignCloudStack/standards/blob/main/Tests/iaas/dns-extensions/dns-extensions-check.py).
+The test suite connects to the OpenStack API and queries the applicable APIs and extensions related to the DNS features.
+Please consult the associated [README.md](https://github.com/SovereignCloudStack/standards/blob/main/Tests/iaas/dns-extensions/README.md) for detailed setup and testing instructions.

Tests/iaas/dns-extensions/README.md

@@ -0,0 +1,58 @@
+# DNS Extensions Test Suite
+
+## Test Environment Setup
+
+### Test Execution Environment
+
+> **NOTE:** The test execution procedure does not require cloud admin rights.
+
+To execute the test suite a valid cloud configuration for the OpenStack SDK in the shape of "`clouds.yaml`" is mandatory[^1].
+**The file is expected to be located in the current working directory where the test script is executed unless configured otherwise.**
+
+[^1]: [OpenStack Documentation: Configuring OpenStack SDK Applications](https://docs.openstack.org/openstacksdk/latest/user/config/configuration.html)
+
+The test execution environment can be located on any system outside of the cloud infrastructure that has OpenStack API access.
+Make sure that the API access is configured properly in "`clouds.yaml`".
+
+It is recommended to use a Python virtual environment[^2].
+Next, install the OpenStack SDK required by the test suite:
+
+```bash
+pip3 install openstacksdk
+```
+
+Within this environment execute the test suite.
+
+[^2]: [Python 3 Documentation: Virtual Environments and Packages](https://docs.python.org/3/tutorial/venv.html)
+
+## Test Execution
+
+The test suite is executed as follows:
+
+```bash
+python3 dns-extensions-check.py --os-cloud mycloud
+```
+
+As an alternative to "`--os-cloud`", the "`OS_CLOUD`" environment variable may be specified instead.
+The parameter is used to look up the correct cloud configuration in "`clouds.yaml`".
+For the example command above, this file should contain a `clouds.mycloud` section like this:
+
+```yaml
+---
+clouds:
+  mycloud:
+    auth:
+      auth_url: ...
+      ...
+    ...
+```
+
+For any further options consult the output of "`python3 dns-extensions-check.py --help`".
+
+### Script Behavior & Test Results
+
+The script will print all executed tests and their results to `stdout`.
+
+If all tests pass, the script will return with an exit code of `0`.
+
+If any test fails, the script will abort, print the failed test to `stdout` and return with a non-zero exit code.

Tests/iaas/dns-extensions/dns-extensions-check.py

@@ -0,0 +1,126 @@
+"""Networking API extension checker for DNS functionality
+
+This script uses the OpenStack SDK to check conformance to the SCS standard
+concerning DNS API extensions.
+"""
+
+import openstack
+import os
+import sys
+import argparse
+
+
+def connect(cloud_name: str,
+            auth_overrides: dict = None) -> openstack.connection.Connection:
+    """Create a connection to an OpenStack cloud
+
+    :param string cloud_name:
+        The name of the configuration to load from clouds.yaml.
+    :param dict auth_overrides:
+        A dict that overrides option of the auth section of the cloud
+        configuration of the loaded clouds.yaml. Allows to authenticate
+        as a different user based on the same general cloud settings.
+        Example:
+
+            {
+                "username": "claudia",
+                "password": "foobar123!%",
+                "project_name": "customer1"
+            }
+
+    :returns: openstack.connnection.Connection
+    """
+
+    if auth_overrides:
+        return openstack.connect(
+            cloud=cloud_name,
+            auth=auth_overrides
+        )
+    else:
+        return openstack.connect(
+            cloud=cloud_name,
+        )
+
+
+def has_extension(conn: openstack.connection.Connection, name: str) -> bool:
+    """Checks whether a given Networking API extension is present.
+
+    Connects to the Extension API of the Networking API and checks if the
+    extension given by `name` is present and in case it is returns True.
+    Otherwise returns False.
+    """
+    ext = conn.network.find_extension(name, ignore_missing=True)
+    if ext:
+        # note that ext.name is a human-readable description, the name as
+        # referenced in the standard is the ext.alias
+        return ext.alias == name
+    else:
+        return False
+
+
+def has_dns_api(conn: openstack.connection.Connection) -> bool:
+    """Checks whether the OpenStack DNS API is offered by the connected cloud.
+
+    Returns True if the DNS API is offered and False otherwise.
+    """
+    # "[...] the dns member of a Connection object [...]"
+    # "[...] will only be added if the service is detected."
+    # see https://docs.openstack.org/openstacksdk/latest/user/proxies/dns.html
+    return hasattr(conn, "dns")
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="SCS Domain Manager Conformance Checker")
+    parser.add_argument(
+        "--os-cloud", type=str,
+        help="Name of the cloud from clouds.yaml, alternative "
+        "to the OS_CLOUD environment variable"
+    )
+    parser.add_argument(
+        "--debug", action="store_true",
+        help="Enable OpenStack SDK debug logging"
+    )
+    args = parser.parse_args()
+    openstack.enable_logging(debug=args.debug)
+
+    # parse cloud name for lookup in clouds.yaml
+    cloud = os.environ.get("OS_CLOUD", None)
+    if args.os_cloud:
+        cloud = args.os_cloud
+    assert cloud, (
+        "You need to have the OS_CLOUD environment variable set to your cloud "
+        "name or pass it via --os-cloud"
+    )
+    conn = connect(cloud)
+
+    # bare minimum: dns-integration extension
+    if has_extension(conn, "dns-integration"):
+        print(
+            "Networking API MUST offer 'dns-integration' extension: PASS"
+        )
+    else:
+        print(
+            "Networking API MUST offer 'dns-integration' extension: FAIL"
+        )
+        sys.exit(1)
+
+    has_designate = has_dns_api(conn)
+    print("Is DNS API present (OPTIONAL):", has_designate)
+
+    if has_designate:
+        if has_extension(conn, "dns-domain-ports"):
+            print(
+                "When the DNS API is present, the Networking API MUST offer "
+                "the 'dns-domain-ports' extension: PASS"
+            )
+        else:
+            print(
+                "When the DNS API is present, the Networking API MUST offer "
+                "the 'dns-domain-ports' extension: FAIL"
+            )
+            sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()