Package io.quarkus.jacoco.runtime

Interface JacocoConfig

@ConfigRoot(phase=BUILD_AND_RUN_TIME_FIXED) @ConfigMapping(prefix="quarkus.jacoco") public interface JacocoConfig

  • Field Details

  • Method Details

    • enabled

      @WithDefault("true") boolean enabled()
      Whether or not the Jacoco extension is enabled.

    • dataFile

      @ConfigDocDefault("target/jacoco-quarkus.exec") Optional<String> dataFile()
      The Jacoco data file. The path can be relative (to the project/module root) or absolute.

    • reuseDataFile

      @WithDefault("false") boolean reuseDataFile()
      Whether to reuse (true) or delete (false) the Jacoco data file on each run.

    • report

      @WithDefault("true") boolean report()
      If Quarkus should generate the Jacoco report

    • outputEncoding

      @WithDefault("UTF-8") String outputEncoding()
      Encoding of the generated reports.

    • title

      @WithDefault("${quarkus.application.name}") Optional<String> title()
      Name of the root node HTML report pages.

    • footer

      Optional<String> footer()
      Footer text used in HTML report pages.

    • sourceEncoding

      @WithDefault("UTF-8") String sourceEncoding()
      Encoding of the source files.

    • includes

      @WithDefault("**") List<String> includes()
      A list of class files to include in the report. May use wildcard characters (* and ?). When not specified everything will be included.

      For instance:

      • **/fo/**/* targets all classes under fo and sub packages
      • **/bar/* targets all classes directly under bar
      • **/*BAR*.class targets classes that contain BAR in their name regardless of path

    • excludes

      Optional<List<String>> excludes()
      A list of class files to exclude from the report. May use wildcard characters (* and ?). When not specified nothing will be excluded.

      For instance:

      • **/fo/**/* targets all classes under fo and sub packages
      • **/bar/* targets all classes directly under bar
      • **/*BAR*.class targets classes that contain BAR in their name regardless of path

    • reportLocation

      @ConfigDocDefault("target/jacoco-report") Optional<String> reportLocation()
      The location of the report files. The path can be relative (to the project/module root) or absolute.

    • instrumentArtifacts

      @ConfigDocSection @ConfigDocMapKey("dependency-name") Map<String,io.quarkus.deployment.index.IndexDependencyConfig> instrumentArtifacts()
      Artifacts that should be instrumented.

      By default, all application archives are instrumented. This property allows for fine-grained configuration. It is also necessary for extension authors, because runtime modules are usually not application archives.

    • aggregateReportData

      @WithDefault("false") boolean aggregateReportData()
      If set to true then the report data (source directories and class files) are aggregated so that a single report can be generated.