Generating Allure HTML reports

Author: Thesola10

.github/workflows/testing.yaml

@@ -34,3 +34,34 @@ jobs:
             nix run .#checks.x86_64-linux.${feat%%.feature}.driver
             echo "::endgroup::"
           done
+      - name: Save results
+        uses: actions/upload-artifact@v7
+        if: always()
+        with:
+          name: allure-output
+          path: allure_output
+
+  push-reports:
+    name: Upload HTML reports to Pages
+    needs: run-tests
+    if: always()
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pages: write
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Fetch report
+        uses: actions/download-artifact@v8
+        with:
+          name: allure-output
+          path: allure_output
+      - name: Deploy report to GitHub Pages
+        uses: PavanMudigonda/html-reporter-github-pages@v1.5.21
+        with:
+          test_results: allure_output
+          allure_report_generate_flag: true
+          keep_reports: 10
+          gh_pages: pages_reports
+          workflow_name: ${{ github.workflow }}

tests/default.nix

@@ -1,5 +1,4 @@
 { pkgs ? import <nixpkgs> {}
-, system ? builtins.currentSystem
 , runTest ? pkgs.testers.nixosTest
 , defaultConfig ?
     { ... }: { imports = [ ../vm.nix ]; }
@@ -17,10 +16,17 @@
 let
   lib = pkgs.lib;
 
+  # Run a test and generate an HTML report
+  behaveReport = test:
+    (pkgs.callPackage ./report.nix { inherit test; });
+  
   # Run a single Behave feature file
-  behaveTest = featureName: as: runTest
-    (import ./template.nix ({ inherit defaultConfig pkgs featureName; } // as));
+  behaveTest = featureName: as: 
+    let testDrv = runTest
+          (import ./template.nix ({ inherit defaultConfig pkgs featureName; } // as));
+    in testDrv // { report = behaveReport testDrv; };
 
+  # Gather and generate tests for all feature files
   allBehaveTests =
     let allBehaveFiles =
           lib.filterAttrs (k: v: lib.hasSuffix ".feature" k && v == "regular")

tests/features/environment.py

@@ -2,6 +2,7 @@
 from pathlib import Path
 from behave import fixture, use_fixture
 
+import allure
 import cv2
 
 class NixOSNamespace(SimpleNamespace):
@@ -57,6 +58,9 @@ def screenshot(self):
         featname = Path(self._context.config.paths[0]).name[:-len(".feature")]
         filename = f"scr-{featname}-{self._context.scenario.line}_{self._last_scr_id}.png"
         self.machine.screenshot(filename)
+
+        with open(filename, 'rb') as imfile:
+            allure.attach(imfile.read(), name=filename, attachment_type=allure.attachment_type.PNG)
         return cv2.imread(filename)
 
 @fixture

tests/report.nix

@@ -0,0 +1,22 @@
+{ pkgs, lib, stdenv, allure
+  # A NixOS Behave test (with a .driver output) to run
+, test
+, ...}:
+
+stdenv.mkDerivation {
+  name = "${test.name}-report";
+  src = pkgs.emptyDirectory;
+
+  nativeBuildInputs = [
+    allure
+  ];
+
+  buildPhase = ''
+    ${lib.getExe test.driver} || true
+  '';
+
+  installPhase = ''
+    mkdir -p $out
+    allure generate allure_output -o $out
+  '';
+}

tests/template.nix

@@ -7,7 +7,7 @@
   name = featureName;
   nodes = { machine = defaultConfig; };
 
-  extraPythonPackages = p: with p; [ behave opencv-python ];
+  extraPythonPackages = p: with p; [ behave opencv-python allure-behave ];
 
   skipTypeCheck = true;
 
@@ -16,8 +16,9 @@
     from behave.__main__ import run_behave
 
     conf = Configuration("${testsDir}/features/${featureName}", userdata = driver.test_symbols())
-    conf.capture_stdout = False
-    conf.capture_stderr = False
+    conf.format = [ "allure_behave.formatter:AllureFormatter", "pretty" ]
+    conf.outputs = []
+    conf.setup_outputs(['allure_output'])
     start_all()
     exit(run_behave(conf))
   '';