Package io.qameta.allure.gradle.report

Class AllureReportExtension

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Constructor Summary

      Constructors 
      Constructor Description
      AllureReportExtension(ReportingExtension reporting, ObjectFactory objects)

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      final DirectoryProperty getReportDir() Base directory for Allure report.
      final Property<Boolean> getDependsOnTests() By default, allureReport and allureServe tasks do not execute tests since it might be time-consuming.
      final Property<Boolean> getSingleFile() By default, Allure generates multi-file reports.
      final RegularFileProperty getConfigFile() Path to a custom Allure 3 config file.
      final Unit dependsOnTests() By default, allureReport and allureServe tasks do not execute tests since it might be time-consuming.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • AllureReportExtension

        AllureReportExtension(ReportingExtension reporting, ObjectFactory objects)

    • Method Detail

      • getReportDir

         final DirectoryProperty getReportDir()

        Base directory for Allure report. Note: since the same project can have both aggregate and regular reports, the actual reports would be placed to $reportDir/allureReport and $reportDir/allureAggregateReport folders.

      • getDependsOnTests

         final Property<Boolean> getDependsOnTests()

        By default, allureReport and allureServe tasks do not execute tests since it might be time-consuming. However, in case tests are up-to-date or from-cache, it might be a nice idea to follow Gradle's default approach: "the task should (re)build all its prerequisites", so the user could edit the source file, launch allureReport and get the updated report with all the tests updated.

      • getSingleFile

         final Property<Boolean> getSingleFile()

        By default, Allure generates multi-file reports. To generate single-file reports, set this property to true.

      • getConfigFile

         final RegularFileProperty getConfigFile()

        Path to a custom Allure 3 config file.

      • dependsOnTests

         final Unit dependsOnTests()

        By default, allureReport and allureServe tasks do not execute tests since it might be time-consuming. However, in case tests are up-to-date or from-cache, it might be a nice idea to follow Gradle's default approach: "the task should (re)build all its prerequisites", so the user could edit the source file, launch allureReport and get the updated report with all the tests updated.