Skip to main content

Reporting

SHAFT Engine ships with two complementary report formats, each suited to a different audience and workflow. You can enable or disable them independently using properties.

Report Types at a Glance​

ReportBest ForDefault State
Allure ReportDeep debugging — step-by-step logs, screenshots, videos✅ Opens automatically after execution
Execution SummaryQuick supplemental feedback — fast, portable, no setup⚙️ Opt-in via property

Allure Report​

The Allure Report is the primary report in SHAFT. It opens automatically in your default browser at the end of every test run and provides a rich, single-file HTML report with:

  • Step-by-step action logs with screenshots attached
  • Video recordings (when enabled)
  • Animated GIFs of browser sessions
  • Test history and trend graphs across multiple runs
  • Environment information and categories

Open Allure Report Manually​

SHAFT writes convenience scripts to your project root during the first run. Use them to regenerate and serve the Allure report at any time:

Windows
generate_allure_report.bat
macOS / Linux
./generate_allure_report.sh

Disable Auto-Opening the Allure Report​

The Allure report opens automatically by default (allure.automaticallyOpen=true). To disable this:

src/main/resources/properties/custom.properties
allure.automaticallyOpen=false

Generate an Allure Report Archive (for CI/CD)​

To generate a portable ZIP archive of the Allure report that you can publish as a CI/CD artifact:

src/main/resources/properties/custom.properties
allure.generateArchive=true

Customize the Allure Report​

You can customize the report title and logo displayed in the generated HTML:

src/main/resources/properties/custom.properties
allure.customTitle=My Regression Suite
allure.customLogo=https://example.com/my-logo.png

Accumulate History and Reports Across Runs​

By default, SHAFT keeps Allure history to enable trend graphs across runs. You can control this behavior:

src/main/resources/properties/custom.properties
# Accumulate history to show trends across runs (default: true)
allure.accumulateHistory=true

# Keep previous HTML report files in the report directory (default: true)
allure.accumulateReports=true

# Clean the results directory before each run (default: true)
allure.cleanResultsDirectory=true

Execution Summary Report​

The Execution Summary report is a lightweight supplement to the Allure report. It is disabled by default and is most useful when you want a quick, portable HTML summary without opening the full Allure report.

  • No extra setup required — just enable the property.
  • Portable — a fast self-contained HTML file you can share or archive.

Enable the Execution Summary Report​

src/main/resources/properties/custom.properties
openExecutionSummaryReportAfterExecution=true

Video Recording​

SHAFT can record a video of every test session and automatically attach it to the Allure report. There is no code change required — it is purely a property:

src/main/resources/properties/custom.properties
videoParams_recordVideo=true

Where to Put Your Properties File​

Create a custom.properties file under src/main/resources/properties/ in your project. SHAFT automatically creates a properties/ directory with some core files on first run — just add your file there:

your-project/
└── src/
    └── main/
        └── resources/
            └── properties/
                ├── default/               ← auto-generated by SHAFT
                └── custom.properties      ← your file

Control Video Recording Scope​

You can control which part of the session is recorded:

src/main/resources/properties/custom.properties
videoParams_recordVideo=true
# Scope options: DriverSession | TestMethod
videoParams_scope=DriverSession
ScopeDescription
DriverSessionRecords the entire browser/driver session (default)
TestMethodRecords each test method as a separate video

Animated GIFs​

In addition to full video recordings, SHAFT can create an animated GIF from the screenshots taken during execution. This lightweight alternative is also attached to the Allure report:

src/main/resources/properties/custom.properties
createAnimatedGif=true
# Delay between frames in milliseconds (default: 500)
animatedGif_frameDelay=500

CI/CD Pipeline (archive report as artifact)​

src/main/resources/properties/custom.properties
# Do not open the browser during CI
allure.automaticallyOpen=false
# Generate a ZIP artifact to publish from the pipeline
allure.generateArchive=true

Active Debugging (rich visuals)​

src/main/resources/properties/custom.properties
# Allure opens automatically by default — add visual evidence
videoParams_recordVideo=true
createAnimatedGif=true
screenshotParams_whenToTakeAScreenshot=Always

Quick Pass/Fail Summary​

src/main/resources/properties/custom.properties
# Enable fast portable summary alongside the Allure report
openExecutionSummaryReportAfterExecution=true

All Reporting Properties​

For the full list of reporting-related properties and their default values, see the Properties List page.

Key properties quick reference:

PropertyDefaultDescription
allure.automaticallyOpentrueOpen the Allure report in the browser automatically after the run
allure.generateArchivefalseGenerate a portable ZIP archive of the Allure report
allure.accumulateHistorytrueAccumulate history across runs for trend graphs
allure.accumulateReportstrueKeep previous Allure HTML report files
allure.cleanResultsDirectorytrueClean Allure results directory before each run
allure.customTitleTest run reportCustom title in the Allure report header
allure.customLogo(SHAFT default logo)Custom logo URL for the Allure report
openExecutionSummaryReportAfterExecutionfalseOpen the Execution Summary report after the run
videoParams_recordVideofalseEnable video recording of test sessions
videoParams_scopeDriverSessionScope of video recording
createAnimatedGiffalseCreate an animated GIF from screenshots
animatedGif_frameDelay500Delay between GIF frames (milliseconds)
screenshotParams_whenToTakeAScreenshotValidationPointsOnlyWhen to capture screenshots