Run path tracer compare from Jenkins

AnastaZIuk · AnastaZIuk · commit 0e942f40bb45 · 2026-04-27T17:16:29.000+02:00
diff --git a/.github/scripts/ci_common.py b/.github/scripts/ci_common.py
@@ -99,7 +99,7 @@ def add_args(parser, names, required=True, default=None):
         parser.add_argument(f"--{name}", required=required, default=default)
 
 
-def multipart(fields, file_field, file_path):
+def multipart_files(fields, files):
     boundary = "----devsh-ci-" + os.urandom(12).hex()
     parts = []
     for name, value in fields.items():
@@ -108,17 +108,22 @@ def multipart(fields, file_field, file_path):
             str(value).encode(),
             b"\r\n",
         ]
-    path = Path(file_path)
-    parts += [
-        f"--{boundary}\r\nContent-Disposition: form-data; name=\"{file_field}\"; filename=\"{path.name}\"\r\n".encode(),
-        b"Content-Type: application/zip\r\n\r\n",
-        path.read_bytes(),
-        b"\r\n",
-        f"--{boundary}--\r\n".encode(),
-    ]
+    for file_field, file_path in files:
+        path = Path(file_path)
+        parts += [
+            f"--{boundary}\r\nContent-Disposition: form-data; name=\"{file_field}\"; filename=\"{path.name}\"\r\n".encode(),
+            b"Content-Type: application/zip\r\n\r\n",
+            path.read_bytes(),
+            b"\r\n",
+        ]
+    parts.append(f"--{boundary}--\r\n".encode())
     return f"multipart/form-data; boundary={boundary}", b"".join(parts)
 
 
+def multipart(fields, file_field, file_path):
+    return multipart_files(fields, [(file_field, file_path)])
+
+
 def extract_single_tar(artifact_dir, pattern):
     artifact_dir = Path(artifact_dir)
     matches = list(artifact_dir.glob(pattern))
@@ -284,6 +289,14 @@ def start_file_job(base, headers, job, fields, file_field, file_path):
     return wait_queue(base, headers, response_headers["Location"], job)
 
 
+def start_files_job(base, headers, job, fields, files):
+    content_type, body = multipart_files(fields, files)
+    _, response_headers, _ = jpost(base, headers, f"/{job_path(job)}/buildWithParameters", body, content_type)
+    if not response_headers.get("Location"):
+        raise CiError(f"Jenkins did not return a queue location for {job}.")
+    return wait_queue(base, headers, response_headers["Location"], job)
+
+
 def stop_build(base, headers, job, number):
     try:
         jpost(base, headers, f"/{job_path(job)}/{number}/stop")
diff --git a/.github/scripts/path_tracer_jenkins.py b/.github/scripts/path_tracer_jenkins.py
@@ -23,6 +23,7 @@
     print_console_tail,
     require_sha,
     start_file_job,
+    start_files_job,
     stop_build,
     wait_build,
     wait_workflow_job_artifact,
@@ -121,6 +122,10 @@ def set_status(args, suite, state, target, description):
     commit_status(REPO, args.sha, args.github_token, f"jenkins/path-tracer-{suite}", state, target, description)
 
 
+def set_compare_status(args, suite, state, target, description):
+    commit_status(REPO, args.sha, args.github_token, f"jenkins/path-tracer-compare-{suite}", state, target, description)
+
+
 def start_suite(args, headers, suite):
     job = f"ci/ditt/real/ex40-{suite}"
     set_status(args, suite, "pending", f"https://github.com/{REPO}/actions/runs/{args.source_run_id}", f"Waiting for Jenkins {suite} path tracer run.")
@@ -157,6 +162,45 @@ def start_suite(args, headers, suite):
     return job, number, result, build_url
 
 
+def start_compare_suite(args, headers, suite):
+    job = f"ci/ditt/compare/o1experimental-vs-o3-{suite}"
+    set_compare_status(args, suite, "pending", f"https://github.com/{REPO}/actions/runs/{args.source_run_id}", f"Waiting for Jenkins {suite} O1experimental vs O3 comparison.")
+    cancel_superseded(args.jenkins_url, headers, job, {"SOURCE_REPOSITORY": REPO, "SOURCE_BRANCH": BRANCH}, {
+        "SOURCE_RUN_ID": args.source_run_id,
+        "SOURCE_RUN_ATTEMPT": args.source_run_attempt,
+    })
+    fields = {
+        "PUBLISH": args.publish,
+        "SOURCE_REPOSITORY": REPO,
+        "SOURCE_BRANCH": BRANCH,
+        "SOURCE_SHA": args.sha,
+        "SOURCE_RUN_ID": args.source_run_id,
+        "SOURCE_RUN_ATTEMPT": args.source_run_attempt,
+        "SOURCE_WORKFLOW": args.source_workflow,
+    }
+    files = [
+        ("EX40_RELEASE_PACKAGE_FILE", args.release_package_path),
+        ("EX40_O1_PACKAGE_FILE", args.o1_package_path),
+    ]
+    number = start_files_job(args.jenkins_url, headers, job, fields, files)
+    build_url = f"{args.jenkins_url.rstrip('/')}/{job_path(job)}/{number}/"
+    set_compare_status(args, suite, "pending", build_url, f"Jenkins {suite} O1experimental vs O3 build #{number} is running.")
+    print(f"Started Jenkins {job} #{number}: {build_url}")
+    try:
+        result = wait_build(args.jenkins_url, headers, job, number, int(args.jenkins_timeout_minutes) * 60)
+    except CiError:
+        stop_build(args.jenkins_url, headers, job, number)
+        print_console_tail(args.jenkins_url, headers, job, number)
+        set_compare_status(args, suite, "failure", build_url, f"Jenkins {suite} comparison did not complete.")
+        raise
+    if result not in {"SUCCESS", "UNSTABLE"}:
+        print_console_tail(args.jenkins_url, headers, job, number)
+        set_compare_status(args, suite, "failure", build_url, f"Jenkins {suite} comparison finished with {result}.")
+        raise CiError(f"Jenkins {job} #{number} finished with {result}.")
+    set_compare_status(args, suite, "success", build_url, f"Jenkins {suite} O1experimental vs O3 {result.lower()}.")
+    return job, number, result, build_url
+
+
 def trigger(args):
     if args.repository != REPO or choice(args.branch, {BRANCH}, "branch") != BRANCH:
         raise CiError("Invalid source repository or branch.")
@@ -179,6 +223,28 @@ def trigger(args):
         print(f"{result[0]} #{result[1]} {result[2]} {result[3]}")
 
 
+def trigger_compare(args):
+    if args.repository != REPO or choice(args.branch, {BRANCH}, "branch") != BRANCH:
+        raise CiError("Invalid source repository or branch.")
+    args.sha = require_sha(args.sha)
+    args.scene_set = choice(args.scene_set, SCENES, "scene set")
+    args.publish = bool_text(args.publish)
+    if not args.jenkins_url.startswith("https://") or not args.jenkins_user or not args.jenkins_token:
+        raise CiError("Invalid Jenkins connection settings.")
+    if not args.source_run_id.isdigit() or not args.source_run_attempt.isdigit():
+        raise CiError("Invalid source run metadata.")
+    if not args.jenkins_timeout_minutes.isdigit() or not 10 <= int(args.jenkins_timeout_minutes) <= 720:
+        raise CiError("Invalid Jenkins timeout.")
+    for path in [Path(args.release_package_path), Path(args.o1_package_path)]:
+        if not path.is_file() or path.stat().st_size > MAX_PACKAGE_BYTES:
+            raise CiError("Invalid compare package path or size.")
+    headers = basic_headers(args.jenkins_user, args.jenkins_token)
+    add_jenkins_crumb(args.jenkins_url, headers)
+    suites = ["public", "private"] if args.scene_set == "both" else [args.scene_set]
+    for result in [start_compare_suite(args, headers, suite) for suite in suites]:
+        print(f"{result[0]} #{result[1]} {result[2]} {result[3]}")
+
+
 def parser():
     parser = argparse.ArgumentParser()
     sub = parser.add_subparsers(dest="cmd", required=True)
@@ -196,6 +262,10 @@ def parser():
     add_args(trigger_parser, ["jenkins-url", "jenkins-user", "jenkins-token", "github-token", "package-path", "repository", "branch", "sha", "source-run-id", "source-run-attempt", "source-workflow", "scene-set", "publish"])
     trigger_parser.add_argument("--jenkins-timeout-minutes", default="300")
     trigger_parser.set_defaults(func=trigger)
+    compare_parser = sub.add_parser("trigger-compare")
+    add_args(compare_parser, ["jenkins-url", "jenkins-user", "jenkins-token", "github-token", "release-package-path", "o1-package-path", "repository", "branch", "sha", "source-run-id", "source-run-attempt", "source-workflow", "scene-set", "publish"])
+    compare_parser.add_argument("--jenkins-timeout-minutes", default="420")
+    compare_parser.set_defaults(func=trigger_compare)
     return parser
 
 
diff --git a/.github/workflows/path-tracer-compare-jenkins.yml b/.github/workflows/path-tracer-compare-jenkins.yml
@@ -0,0 +1,122 @@
+name: Run Path Tracer Compare Jenkins
+
+on:
+  workflow_dispatch:
+    inputs:
+      run_id:
+        description: "Build workflow run id to use as the EX40 package source"
+        required: true
+      scene_set:
+        description: "Path tracer scene set to compare in Jenkins"
+        required: true
+        default: "both"
+        type: choice
+        options:
+          - both
+          - public
+          - private
+      publish:
+        description: "Publish the generated comparison report to store.devsh.eu"
+        required: true
+        default: true
+        type: boolean
+
+permissions:
+  contents: read
+  actions: read
+  statuses: write
+
+concurrency:
+  group: path-tracer-compare-jenkins-ptCLI
+  cancel-in-progress: true
+
+jobs:
+  trigger-jenkins:
+    name: Trigger Path Tracer Compare Jenkins
+    runs-on: ubuntu-latest
+    timeout-minutes: 420
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 1
+          sparse-checkout: |
+            .github/scripts
+
+      - name: Resolve source build
+        id: source
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          python3 .github/scripts/path_tracer_jenkins.py resolve \
+            --github-token "$GH_TOKEN" \
+            --repository "${{ github.repository }}" \
+            --event-name "${{ github.event_name }}" \
+            --branch "${{ github.ref_name }}" \
+            --sha "${{ github.sha }}" \
+            --run-id "${{ inputs.run_id }}" \
+            --build-config Release \
+            --scene-set "${{ inputs.scene_set || 'both' }}" \
+            --publish "${{ inputs.publish }}"
+
+      - name: Download Release install artifact
+        uses: actions/download-artifact@v8
+        with:
+          run-id: ${{ steps.source.outputs.run_id }}
+          pattern: run-windows-*-msvc-Release-install
+          path: artifact-release
+          merge-multiple: true
+          github-token: ${{ secrets.READ_PAT || github.token }}
+          repository: Devsh-Graphics-Programming/Nabla
+
+      - name: Download RelWithDebInfo install artifact
+        uses: actions/download-artifact@v8
+        with:
+          run-id: ${{ steps.source.outputs.run_id }}
+          pattern: run-windows-*-msvc-RelWithDebInfo-install
+          path: artifact-o1experimental
+          merge-multiple: true
+          github-token: ${{ secrets.READ_PAT || github.token }}
+          repository: Devsh-Graphics-Programming/Nabla
+
+      - name: Prepare Release package
+        id: release_package
+        run: |
+          python3 .github/scripts/path_tracer_jenkins.py package \
+            --artifact-dir artifact-release \
+            --build-config Release \
+            --package-root ex40-release-package \
+            --zip-path ex40-release-package.zip
+
+      - name: Prepare O1experimental package
+        id: o1_package
+        run: |
+          python3 .github/scripts/path_tracer_jenkins.py package \
+            --artifact-dir artifact-o1experimental \
+            --build-config RelWithDebInfo \
+            --package-root ex40-o1experimental-package \
+            --zip-path ex40-o1experimental-package.zip
+
+      - name: Trigger Jenkins
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+          JENKINS_URL: https://jenkins.devsh.eu
+          JENKINS_USER: ${{ secrets.JENKINS_DITT_USER }}
+          JENKINS_TOKEN: ${{ secrets.JENKINS_DITT_TOKEN }}
+        run: |
+          python3 .github/scripts/path_tracer_jenkins.py trigger-compare \
+            --jenkins-url "$JENKINS_URL" \
+            --jenkins-user "$JENKINS_USER" \
+            --jenkins-token "$JENKINS_TOKEN" \
+            --github-token "$GITHUB_TOKEN" \
+            --release-package-path "${{ steps.release_package.outputs.zip_path }}" \
+            --o1-package-path "${{ steps.o1_package.outputs.zip_path }}" \
+            --repository "${{ github.repository }}" \
+            --branch "${{ steps.source.outputs.branch }}" \
+            --sha "${{ steps.source.outputs.sha }}" \
+            --source-run-id "${{ steps.source.outputs.run_id }}" \
+            --source-run-attempt "${{ steps.source.outputs.run_attempt }}" \
+            --source-workflow "${{ steps.source.outputs.workflow }}" \
+            --scene-set "${{ steps.source.outputs.scene_set }}" \
+            --publish "${{ steps.source.outputs.publish }}"
