Use pytest for tests.

Author: jimf5

.github/workflows/ubuntu.yml

@@ -8,92 +8,40 @@ on:
 
 jobs:
   build-module:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
       - name: Install dependencies
         run: |
           sudo apt-get update
-          sudo apt-get install -y cmake libc-ares-dev libre2-dev
+          sudo apt-get install -y cmake libc-ares-dev
       - name: Checkout nginx
         uses: actions/checkout@v4
         with:
           repository: nginx/nginx
           path: nginx
-      - name: Configure nginx
+      - name: Build nginx
         working-directory: nginx
-        run: auto/configure --with-compat
-      - name: Create build directory
-        run: mkdir build
+        run: |
+          auto/configure --with-compat --with-debug --with-http_ssl_module \
+                         --with-http_v2_module --with-http_v3_module
+          make -j $(nproc)
       - name: Build module
-        working-directory: build
         run: |
+          mkdir build
+          cd build
           cmake -DNGX_OTEL_NGINX_BUILD_DIR=${PWD}/../nginx/objs \
                 -DNGX_OTEL_DEV=ON ..
-          make -j 4
-          strip ngx_otel_module.so
-      - name: Archive module
-        uses: actions/upload-artifact@v4
-        with:
-          name: nginx-otel-module
-          path: build/ngx_otel_module.so
-      - name: Archive protoc and opentelemetry-proto
-        uses: actions/upload-artifact@v4
-        with:
-          name: protoc-opentelemetry-proto
-          path: |
-            build/_deps/grpc-build/third_party/protobuf/protoc
-            build/_deps/otelcpp-src/third_party/opentelemetry-proto
-  test-module:
-    needs: build-module
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-      - name: Download module
-        uses: actions/download-artifact@v4
-        with:
-          name: nginx-otel-module
-          path: build
-      - name: Download protoc and opentelemetry-proto
-        uses: actions/download-artifact@v4
-        with:
-          name: protoc-opentelemetry-proto
-          path: build/_deps
-      - name: List files
-        run: ls -laR .
-      - name: Fix protoc file permissions
-        run: chmod +x build/_deps/grpc-build/third_party/protobuf/protoc
-      - name: Install perl modules
-        run: sudo cpan IO::Socket::SSL Crypt::Misc
+          make -j $(nproc)
       - name: Download otelcol
         run: |
-          curl -LO https://github.com/\
+          curl -sLo - https://github.com/\
           open-telemetry/opentelemetry-collector-releases/releases/download/\
-          v0.76.1/otelcol_0.76.1_linux_amd64.tar.gz
-          tar -xzf otelcol_0.76.1_linux_amd64.tar.gz
-      - name: Checkout nginx
-        uses: actions/checkout@v4
-        with:
-          repository: nginx/nginx
-          path: nginx
-      - name: Build nginx
-        working-directory: nginx
-        run: |
-          auto/configure --with-compat --with-debug --with-http_ssl_module \
-                         --with-http_v2_module --with-http_v3_module
-          make -j 4
-      - name: Checkout lib from nginx-tests
-        uses: actions/checkout@v4
-        with:
-          repository: nginx/nginx-tests
-          sparse-checkout: |
-            lib
-          path: nginx-tests
+          v0.115.1/otelcol_0.115.1_linux_amd64.tar.gz | tar -xzv
+      - name: Install test dependencies
+        run: pip install -r tests/requirements.txt
       - name: Run tests
-        working-directory: tests
         run: |
-          PERL5LIB=../nginx-tests/lib TEST_NGINX_UNSAFE=1 \
-              TEST_NGINX_VERBOSE=1 TEST_NGINX_GLOBALS="load_module \
-              ${PWD}/../build/ngx_otel_module.so;" prove -v .
+          pytest tests --maxfail=10 --nginx=nginx/objs/nginx \
+                       --module=build/ngx_otel_module.so --otelcol=./otelcol

tests/conftest.py

@@ -0,0 +1,100 @@
+import jinja2
+import logging
+from OpenSSL import crypto
+import os
+import pytest
+import subprocess
+import time
+
+
+pytest_plugins = [
+    "trace_service",
+]
+
+
+def pytest_addoption(parser):
+    parser.addoption("--nginx", required=True)
+    parser.addoption("--module", required=True)
+    parser.addoption("--otelcol")
+    parser.addoption("--globals", default="")
+
+
+def self_signed_cert(test_dir, name):
+    k = crypto.PKey()
+    k.generate_key(crypto.TYPE_RSA, 2048)
+    cert = crypto.X509()
+    cert.get_subject().CN = name
+    cert.set_issuer(cert.get_subject())
+    cert.gmtime_adj_notBefore(0)
+    cert.gmtime_adj_notAfter(365 * 86400)  # 365 days
+    cert.set_pubkey(k)
+    cert.sign(k, "sha512")
+    (test_dir / f"{name}.key").write_text(
+        crypto.dump_privatekey(crypto.FILETYPE_PEM, k).decode("utf-8")
+    )
+    (test_dir / f"{name}.crt").write_text(
+        crypto.dump_certificate(crypto.FILETYPE_PEM, cert).decode("utf-8")
+    )
+
+
+@pytest.fixture(scope="session")
+def logger():
+    logging.basicConfig(level=logging.INFO)
+    return logging.getLogger(__name__)
+
+
+@pytest.fixture(scope="module")
+def testdir(tmp_path_factory):
+    return tmp_path_factory.mktemp("nginx")
+
+
+@pytest.fixture(scope="module")
+def nginx_config(request, pytestconfig, testdir, logger):
+    tmpl = jinja2.Environment().from_string(request.module.NGINX_CONFIG)
+    params = getattr(request, "param", {})
+    params["globals"] = (
+        f"pid {testdir}/nginx.pid;\n"
+        + "error_log stderr info;\n"
+        + f"error_log {testdir}/error.log info;\n"
+        + f"load_module {os.path.abspath(pytestconfig.option.module)};\n"
+        + pytestconfig.option.globals
+    )
+    params["http_globals"] = f"root {testdir};\n" + "access_log off;\n"
+    conf = tmpl.render(params)
+    logger.debug(conf)
+    return conf
+
+
+@pytest.fixture(scope="module")
+def nginx(testdir, pytestconfig, nginx_config, certs, logger, otelcol):
+    (testdir / "nginx.conf").write_text(nginx_config)
+    logger.info("Starting nginx...")
+    proc = subprocess.Popen(
+        [
+            pytestconfig.option.nginx,
+            "-p",
+            str(testdir),
+            "-c",
+            "nginx.conf",
+            "-e",
+            "error.log",
+        ]
+    )
+    logger.debug(f"args={' '.join(proc.args)}")
+    logger.debug(f"pid={proc.pid}")
+    while not (testdir / "nginx.pid").exists():
+        time.sleep(0.1)
+        assert proc.poll() is None, "Can't start nginx"
+    yield proc
+    logger.info("Stopping nginx...")
+    proc.terminate()
+    try:
+        proc.wait(timeout=5)
+    except subprocess.TimeoutExpired:
+        proc.kill()
+    assert "[alert]" not in (testdir / "error.log").read_text()
+
+
+@pytest.fixture(scope="module")
+def certs(testdir):
+    self_signed_cert(testdir, "localhost")