Interface Allure

All Superinterfaces:
org.aeonbits.owner.Config, EngineProperties<Allure>, Serializable
@Sources({"system:properties","file:src/main/resources/properties/Allure.properties","file:src/main/resources/properties/default/Allure.properties","classpath:Allure.properties"}) public interface Allure extends EngineProperties<Allure>
Configuration properties interface for Allure report generation in the SHAFT framework. Properties can be supplied via system properties, Allure.properties files on the classpath or file-system, and are hot-reloaded at runtime.

Use set() to change property values programmatically: 

SHAFT.Properties.allure.set().automaticallyOpen(false).generateArchive(true);

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    Allure.SetProperty
    Fluent builder that allows programmatic override of individual Allure configuration properties.

    Nested classes/interfaces inherited from interface org.aeonbits.owner.Config

    org.aeonbits.owner.Config.ConverterClass, org.aeonbits.owner.Config.DecryptorClass, org.aeonbits.owner.Config.DefaultValue, org.aeonbits.owner.Config.DisableableFeature, org.aeonbits.owner.Config.DisableFeature, org.aeonbits.owner.Config.EncryptedValue, org.aeonbits.owner.Config.HotReload, org.aeonbits.owner.Config.HotReloadType, org.aeonbits.owner.Config.Key, org.aeonbits.owner.Config.LoadPolicy, org.aeonbits.owner.Config.LoadType, org.aeonbits.owner.Config.PreprocessorClasses, org.aeonbits.owner.Config.Separator, org.aeonbits.owner.Config.Sources, org.aeonbits.owner.Config.TokenizerClass

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    accumulateHistory()
    Whether Allure history data should be accumulated across test runs, enabling trend graphs and historical comparison in the report.
    boolean
    accumulateReports()
    Whether generated Allure HTML report files should accumulate in the report directory rather than being replaced on each run.
    boolean
    automaticallyOpen()
    Whether the Allure report HTML file should be opened automatically in the default browser after the test run completes.
    boolean
    cleanResultsDirectory()
    Whether the Allure results directory should be cleaned before a new test run starts.
    String
    customLogo()
    URL pointing to a custom logo image that replaces the default SHAFT logo in the Allure report.
    String
    customTitle()
    Custom title displayed in the header of the generated Allure report.
    boolean
    forceConfiguredCliVersion()
    Opt-in switch to enforce usage of the configured Allure 3 CLI version (SHAFT.Properties.internal.allure3Version()).
    boolean
    generateArchive()
    Whether a self-contained ZIP archive of the generated Allure report should be created after the test run.
    boolean
    realtimeMonitoring()
    Enables SHAFT-managed real-time Allure 3 report monitoring via allure watch.
    default Allure.SetProperty
    set()
    Returns a fluent Allure.SetProperty builder for programmatically overriding Allure properties.

  • Method Details

    • automaticallyOpen

      @Key("allure.automaticallyOpen") @DefaultValue("true") boolean automaticallyOpen()
      Whether the Allure report HTML file should be opened automatically in the default browser after the test run completes.

      Property key: allure.automaticallyOpen — default: true

      Returns:
      true to open the report automatically; false otherwise

    • accumulateHistory

      @Key("allure.accumulateHistory") @DefaultValue("true") boolean accumulateHistory()
      Whether Allure history data should be accumulated across test runs, enabling trend graphs and historical comparison in the report.

      Property key: allure.accumulateHistory — default: true

      Returns:
      true to accumulate history; false to start fresh each run

    • accumulateReports

      @Key("allure.accumulateReports") @DefaultValue("true") boolean accumulateReports()
      Whether generated Allure HTML report files should accumulate in the report directory rather than being replaced on each run.

      Property key: allure.accumulateReports — default: true

      Returns:
      true to keep previous report HTML files; false to overwrite them

    • cleanResultsDirectory

      @Key("allure.cleanResultsDirectory") @DefaultValue("true") boolean cleanResultsDirectory()
      Whether the Allure results directory should be cleaned before a new test run starts. Disable this when you want to merge results from multiple partial runs.

      Property key: allure.cleanResultsDirectory — default: true

      Returns:
      true to delete the results directory before execution; false to preserve it

    • generateArchive

      @Key("allure.generateArchive") @DefaultValue("false") boolean generateArchive()
      Whether a self-contained ZIP archive of the generated Allure report should be created after the test run. Useful for sharing or archiving reports in CI pipelines.

      Property key: allure.generateArchive — default: false

      Returns:
      true to generate a ZIP archive of the report; false otherwise

    • customLogo

      @Key("allure.customLogo") @DefaultValue("https://github.com/ShaftHQ/SHAFT_ENGINE/blob/main/src/main/resources/images/shaft.png?raw=true") String customLogo()
      URL pointing to a custom logo image that replaces the default SHAFT logo in the Allure report.

      Property key: allure.customLogo — default: SHAFT_ENGINE white logo on GitHub

      Returns:
      a URL string for the custom logo image

    • customTitle

      @Key("allure.customTitle") @DefaultValue("SHAFT-powered test report") String customTitle()
      Custom title displayed in the header of the generated Allure report.

      Property key: allure.customTitle — default: "Test run report"

      Returns:
      the report title string

    • forceConfiguredCliVersion

      @Key("allure.forceConfiguredCliVersion") @DefaultValue("true") boolean forceConfiguredCliVersion()
      Opt-in switch to enforce usage of the configured Allure 3 CLI version (SHAFT.Properties.internal.allure3Version()).

      Property key: allure.forceConfiguredCliVersion — default: true

      When enabled:

      • SHAFT bypasses system allure binary detection (including Allure 2 compatibility checks).
      • SHAFT uses managed Allure 3 resolution only: npx --yes allure@<allure3Version> (or downloaded Node.js fallback).

      When disabled, SHAFT uses PATH-first behavior and may activate Allure 2 compatibility mode when a system 2.x binary is detected.

      Returns:
      true to enforce configured Allure 3 CLI usage; false for legacy PATH-first behavior

    • realtimeMonitoring

      @Key("allure.realtimeMonitoring") @DefaultValue("false") boolean realtimeMonitoring()
      Enables SHAFT-managed real-time Allure 3 report monitoring via allure watch.

      Property key: allure.realtimeMonitoring — default: true

      When enabled, SHAFT starts monitoring when Allure 3 CLI resolution succeeds. This feature is unavailable in Allure 2 compatibility mode.

      Returns:
      true to allow real-time monitoring when Allure 3 is available; false to disable it

    • set

      default Allure.SetProperty set()
      Returns a fluent Allure.SetProperty builder for programmatically overriding Allure properties.

      Example: 

      SHAFT.Properties.allure.set().automaticallyOpen(false).customTitle("My Suite");
      Specified by:
      set in interface EngineProperties<Allure>
      Returns:
      a new Allure.SetProperty instance