TUN-4055: Skeleton for component tests

component-tests/.gitignore

@@ -0,0 +1,2 @@
+__pycache__
+.pytest_cache

component-tests/README.md

@@ -0,0 +1,22 @@
+# Requirements
+1. Python 3.7 or later with packages in the given `requirements.txt`
+   - E.g. with conda:
+   - `conda create -n component-tests python=3.7`  
+   - `conda activate component-tests`
+   - `pip3 install -r requirements.txt`
+
+# How to run
+## All tests
+Run `pytest` inside this(component-tests) folder
+
+## Specific files
+Run `pytest <file 1 name>.py <file 2 name>.py`
+
+## Specific tests
+Run `pytest file.py -k <test 1 name> -k <test 2 name>`
+
+## Live Logging
+Running with `-o log_cli=true` outputs logging to CLI as the tests are. By default the log level is WARN.
+`--log-cli-level` control logging level.
+For example, to log at info level, run `pytest -o log_cli=true --log-cli-level=INFO`.
+See https://docs.pytest.org/en/latest/logging.html#live-logs for more documentation on logging.

component-tests/requirements.txt

@@ -0,0 +1,2 @@
+pytest==6.2.2
+pyyaml==5.4.1

component-tests/test_config.py

@@ -0,0 +1,53 @@
+#!/usr/bin/env python
+from util import start_cloudflared
+
+class TestConfig:
+    # tmp_path is a fixture provides a temporary directory unique to the test invocation
+    def test_validate_ingress_rules(self, tmp_path):
+        config = {
+            'metrics': 'localhost:50000',
+            'ingress': [
+                {
+                    "hostname": "example.com",
+                    "service": "https://localhost:8000",
+                    "originRequest": {
+                        "originServerName": "test.example.com",
+                        "caPool": "/etc/certs/ca.pem"
+                    },
+                },
+                {
+                    "hostname": "api.example.com",
+                    "path": "login",
+                    "service": "https://localhost:9000",
+                },
+                {
+                    "hostname": "wss.example.com",
+                    "service": "wss://localhost:8000",
+                },
+                {
+                    "hostname": "ssh.example.com",
+                    "service": "ssh://localhost:8000",
+                },
+                {"service": "http_status:404"}
+            ],
+        }
+        validate_args = ["ingress", "validate"]
+        pre_args = ["tunnel"]
+        validate = start_cloudflared(tmp_path, config, validate_args, pre_args)
+        assert validate.returncode == 0, "failed to validate ingress" + validate.stderr.decode("utf-8")
+
+        self.match_rule(tmp_path, config, "http://example.com/index.html", 1)
+        self.match_rule(tmp_path, config, "https://example.com/index.html", 1)
+        self.match_rule(tmp_path, config, "https://api.example.com/login", 2)
+        self.match_rule(tmp_path, config, "https://wss.example.com", 3)
+        self.match_rule(tmp_path, config, "https://ssh.example.com", 4)
+        self.match_rule(tmp_path, config, "https://api.example.com", 5)
+
+    # This is used to check that the command tunnel ingress url <url> matches rule number <rule_num>. Note that rule number uses 1-based indexing
+    def match_rule(self, tmp_path, config, url, rule_num):
+        args = ["ingress", "rule", url]
+        pre_args = ["tunnel"]
+        match_rule = start_cloudflared(tmp_path, config, args, pre_args)
+
+        assert match_rule.returncode == 0, "failed to check rule" + match_rule.stderr.decode("utf-8")
+        assert f"Matched rule #{rule_num}" .encode() in match_rule.stdout

component-tests/util.py

@@ -0,0 +1,27 @@
+import logging
+import os
+import subprocess
+import yaml
+
+LOGGER = logging.getLogger(__name__)
+
+def get_cloudflared():
+    cfd_binary = os.getenv('CFD_BINARY')
+    return "cloudflared" if cfd_binary is None else cfd_binary
+
+
+def write_config(path, config):
+    config_path = path / "config.yaml"
+    with open(config_path, 'w') as outfile:
+        yaml.dump(config, outfile)
+    return config_path
+
+
+def start_cloudflared(path, config, args, pre_args=[]):
+    config_path = write_config(path, config)
+    cmd = [get_cloudflared()]
+    cmd += pre_args
+    cmd += ["--config", config_path]
+    cmd += args
+    LOGGER.info(f"Run cmd {cmd} with config {config}")
+    return subprocess.run(cmd, capture_output=True)