Liking cljdoc? Tell your friends :D

com.blockether.svar.allure-reporter

Allure 3 reporter for Lazytest.

Writes JSON result files to allure-results/, then optionally generates the full HTML report to allure-report/ using Allure 3 CLI (pinned to 3.2.0 via npx).

Usage: clojure -M:test --output com.blockether.svar.allure-reporter/allure clojure -M:test --output nested --output com.blockether.svar.allure-reporter/allure

Output directory defaults to allure-results/. Override with: -Dlazytest.allure.output=path/to/dir LAZYTEST_ALLURE_OUTPUT=path/to/dir

Allure 3 reporter for Lazytest.

Writes JSON result files to allure-results/, then optionally generates
the full HTML report to allure-report/ using Allure 3 CLI (pinned to 3.2.0
via npx).

Usage:
  clojure -M:test --output com.blockether.svar.allure-reporter/allure
  clojure -M:test --output nested --output com.blockether.svar.allure-reporter/allure

Output directory defaults to allure-results/. Override with:
  -Dlazytest.allure.output=path/to/dir
  LAZYTEST_ALLURE_OUTPUT=path/to/dir
raw docstring

*context*clj

Dynamic var holding the current test's Allure context atom during execution. Bound by the reporter's wrap-try-test-case. nil when not running under the Allure reporter.

Dynamic var holding the current test's Allure context atom during
execution. Bound by the reporter's `wrap-try-test-case`. nil when
not running under the Allure reporter.
sourceraw docstring

*output-dir*clj

Dynamic var holding the allure-results output directory (java.io.File). Bound by the reporter alongside context.

Dynamic var holding the allure-results output directory (java.io.File).
Bound by the reporter alongside *context*.
sourceraw docstring

*test-err*clj

Dynamic var holding the test-level Writer for stderr accumulation.

Dynamic var holding the test-level Writer for stderr accumulation.
sourceraw docstring

*test-out*clj

Dynamic var holding the test-level Writer for stdout accumulation.

Dynamic var holding the test-level Writer for stdout accumulation.
sourceraw docstring

*test-title*clj

Dynamic var holding the current test's display title.

Dynamic var holding the current test's display title.
sourceraw docstring

allurecljmultimethod

(allure config m)

Allure 3 reporter multimethod for Lazytest.

Writes JSON results and optionally generates HTML report.

Usage: --output nested --output com.blockether.svar.allure-reporter/allure

Allure 3 reporter multimethod for Lazytest.

Writes JSON results and optionally generates HTML report.

Usage:
  --output nested --output com.blockether.svar.allure-reporter/allure
sourceraw docstring

count-test-resultsclj

(count-test-results results-dir)

Count test results from allure-results directory. Returns map with :passed, :failed, :broken, :skipped, :total.

Count test results from allure-results directory.
Returns map with :passed, :failed, :broken, :skipped, :total.
sourceraw docstring

generate-badge-file!clj

(generate-badge-file! results-dir output-dir)

Generate badge.svg file in the given directory based on test results. Returns the badge message string.

Generate badge.svg file in the given directory based on test results.
Returns the badge message string.
sourceraw docstring

generate-badge-svgclj

(generate-badge-svg
  {:keys [label message color style]
   :or {label "tests" message "0 passed" color "brightgreen" style :flat}})

Generate a shields.io-style SVG badge. Returns the SVG string.

Options: :label - left side text (default: "tests") :message - right side text (e.g. "42 passed") :color - right side color (default: "brightgreen") :style - badge style: :flat (default), :flat-square, :for-the-badge

Generate a shields.io-style SVG badge.
Returns the SVG string.

Options:
  :label   - left side text (default: "tests")
  :message - right side text (e.g. "42 passed")
  :color   - right side color (default: "brightgreen")
  :style   - badge style: :flat (default), :flat-square, :for-the-badge
sourceraw docstring

generate-html-report!clj

(generate-html-report! results-dir report-dir-path)

Resolve the Allure CLI, run allure awesome (with history when available), generate badge, and run allure history. Returns true on success.

Resolve the Allure CLI, run `allure awesome` (with history when
available), generate badge, and run `allure history`.
Returns true on success.
sourceraw docstring

make-contextclj

(make-context)

Create a fresh context map for a test case.

Create a fresh context map for a test case.
sourceraw docstring

merge-results!clj

(merge-results! source-dirs
                {:keys [output-dir clean report report-dir]
                 :or {output-dir "allure-results"
                      clean true
                      report true
                      report-dir "allure-report"}})

Merge N allure-results directories into one output directory.

Copies all result JSON files, attachment files, and supplementary files (environment.properties, categories.json) from each source dir into the output dir.

Options: :output-dir - target directory (default: "allure-results") :clean - whether to clean output dir first (default: true) :report - whether to generate HTML report after merge (default: true) :report-dir - HTML report output dir (default: "allure-report")

Returns map with :merged count and :output-dir path.

Merge N allure-results directories into one output directory.

Copies all result JSON files, attachment files, and supplementary
files (environment.properties, categories.json) from each source dir
into the output dir.

Options:
  :output-dir  - target directory (default: "allure-results")
  :clean       - whether to clean output dir first (default: true)
  :report      - whether to generate HTML report after merge (default: true)
  :report-dir  - HTML report output dir (default: "allure-report")

Returns map with :merged count and :output-dir path.
sourceraw docstring

output-dirclj

(output-dir)

Determine the output directory. Checks system property, then env var, then falls back to allure-results.

Determine the output directory. Checks system property, then env var,
then falls back to allure-results.
sourceraw docstring

report-dirclj

(report-dir)
source

reporter-active?clj

(reporter-active?)

Returns true when the Allure reporter is active.

Returns true when the Allure reporter is active.
sourceraw docstring

set-reporter-active!clj

(set-reporter-active! active?)

Called by the Allure reporter at begin/end of test run.

Called by the Allure reporter at begin/end of test run.
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