Liking cljdoc? Tell your friends :D

com.blockether.spel.spel-allure-alternative-html-report

Blockether Allure report renderer. Reads allure-results/ JSON files and generates a standalone HTML report with a clean neutral palette, search, sorting, compact investigation-first layout, and shared attachment UX reused from the standard Allure report helpers.

Blockether Allure report renderer.
Reads allure-results/ JSON files and generates a standalone HTML report
with a clean neutral palette, search, sorting, compact investigation-first
layout, and shared attachment UX reused from the standard Allure report
helpers.
raw docstring

generate!clj

(generate! results-dir output-dir)
(generate! results-dir output-dir opts)

Generate a compact Blockether-themed HTML report from allure-results.

Parameters: results-dir - path to allure-results/ directory output-dir - path to write the HTML report directory

Options (opts map): :title - report title (default: "Allure Report") :kicker - small mono heading above title (default: "Allure Report") :subtitle - optional subtitle under title (default: "")

Customization (all optional): :logo - logo to display above the title. Accepts: • data:image/… URL (inlined) • inline <svg …> markup (wrapped as data URL) • http(s):// URL (referenced directly) • filesystem path (copied to assets/) Can also be set via environment.properties key report.logo. :description - HTML or text block rendered under the title. Text is escaped; strings starting with < pass through as HTML. Can also be set via environment.properties key report.description. :custom-css - extra CSS string appended after the built-in stylesheet. Layered with :custom-css-file and environment.properties report.custom_css. :custom-css-file - path (absolute or relative to results-dir) to a CSS file whose contents are inlined. :build-id - build/run identifier shown in the header kicker (e.g. "#544"). Maps to run-info :run-name. Env fallback: build.id. :build-date - build timestamp. Accepts epoch-millis Long or ISO-ish string. Maps to run-info :commit-ts. Env fallback: build.date. :build-url - URL to the CI run, linked from the header. Maps to run-info :run-url. Env fallback: build.url. :run-info - opt-out: pass a fully-built run-info map to override anything derived from env/executor.

:results-dir - kept for CLI compatibility; generated report now packages referenced attachments into its own output directory.

Returns the output directory path on success.

Generate a compact Blockether-themed HTML report from allure-results.

Parameters:
  results-dir - path to allure-results/ directory
  output-dir  - path to write the HTML report directory

Options (opts map):
  :title       - report title (default: "Allure Report")
  :kicker      - small mono heading above title (default: "Allure Report")
  :subtitle    - optional subtitle under title (default: "")

Customization (all optional):
  :logo             - logo to display above the title. Accepts:
                      • `data:image/…` URL       (inlined)
                      • inline `<svg …>` markup  (wrapped as data URL)
                      • `http(s)://` URL         (referenced directly)
                      • filesystem path          (copied to assets/)
                      Can also be set via `environment.properties`
                      key `report.logo`.
  :description      - HTML or text block rendered under the title.
                      Text is escaped; strings starting with `<` pass
                      through as HTML. Can also be set via
                      `environment.properties` key `report.description`.
  :custom-css       - extra CSS string appended after the built-in
                      stylesheet. Layered with :custom-css-file and
                      environment.properties `report.custom_css`.
  :custom-css-file  - path (absolute or relative to results-dir) to a
                      CSS file whose contents are inlined.
  :build-id         - build/run identifier shown in the header kicker
                      (e.g. "#544"). Maps to run-info :run-name.
                      Env fallback: `build.id`.
  :build-date       - build timestamp. Accepts epoch-millis Long or
                      ISO-ish string. Maps to run-info :commit-ts.
                      Env fallback: `build.date`.
  :build-url        - URL to the CI run, linked from the header.
                      Maps to run-info :run-url.
                      Env fallback: `build.url`.
  :run-info         - opt-out: pass a fully-built run-info map to
                      override anything derived from env/executor.

  :results-dir - kept for CLI compatibility; generated report now packages
                  referenced attachments into its own output directory.

Returns the output directory path on success.
sourceraw docstring

generate-from-results!clj

(generate-from-results! results output-dir)
(generate-from-results! results output-dir opts)

Generate a report directly from in-memory result maps — no allure-results directory needed. Perfect for single-test runs, lambda functions, or any scenario where you have results in memory and don't want to write them to disk first.

Parameters: results - vector of Allure result maps (same format as *-result.json) output-dir - path to write the report (index.html + summary.json + report.json)

Options: same as generate! (:title, :logo, :description, :custom-css, etc.)

Example: ;; Single test result from a lambda: (generate-from-results! [{"name" "health check" "status" "passed" "start" 1000 "stop" 2000 "labels" [{"name" "suite" "value" "monitoring"} {"name" "epic" "value" "API"}]}] "/tmp/report" {:title "Lambda Health Check"})

Returns: output-dir path string.

Generate a report directly from in-memory result maps — no allure-results
directory needed. Perfect for single-test runs, lambda functions, or any
scenario where you have results in memory and don't want to write them to
disk first.

Parameters:
  results    - vector of Allure result maps (same format as *-result.json)
  output-dir - path to write the report (index.html + summary.json + report.json)

Options: same as `generate!` (:title, :logo, :description, :custom-css, etc.)

Example:
  ;; Single test result from a lambda:
  (generate-from-results!
    [{"name"   "health check"
      "status" "passed"
      "start"  1000
      "stop"   2000
      "labels" [{"name" "suite" "value" "monitoring"}
                  {"name" "epic"  "value" "API"}]}]
    "/tmp/report"
    {:title "Lambda Health Check"})

Returns: output-dir path string.
sourceraw docstring

load-resultsclj

(load-results results-dir)

Load all *-result.json files from the given directory.

Load all *-result.json files from the given directory.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close