Skip to content

Gradle plugin that visualises tests execution schedule

License

Notifications You must be signed in to change notification settings

arrekb/tests-execution-chart

 
 

Repository files navigation

Gradle plugin that visualises tests execution schedule

build status

Usage

Warning This project is under development and has not yet been published to the Gradle Plugin Portal.

Since this project has not been published to the Gradle Plugin Portal you have to publish it locally to use it:

cd tests-execution-chart
./gradlew publish

Artifacts are published to ../local-plugin-repository directory.

Configure your project:

settings.gradle (set proper path instead of /path-to):

pluginManagement {
    repositories {
        maven {
            url '/path-to/local-plugin-repository'
        }
        gradlePluginPortal()
    }
}

build.gradle:

plugins {
    id 'com.github.platan.tests-execution-chart' version '0.0.1-SNAPSHOT'
}
./gradlew test createTestsExecutionReport --rerun-tasks

#...

Tests execution schedule report saved to /my-project/build/reports/tests-execution/mermaid/test.txt file.
Tests execution schedule report saved to /my-project/build/reports/tests-execution/json/test.json file.
Tests execution schedule report saved to /my-project/build/reports/tests-execution/html/test.html file.

Example result (HTML report):

Configuration

Options:

Key Type Description Default
formats.json.enabled boolean Generate report in json format true
formats.html.enabled boolean Generate report in html format true
formats.html.script.src url Url to mermaid which should be used to generate html report https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js
formats.html.script.embed boolean If true mermaid source will be downloaded and used locally in html false
formats.mermaid.enabled boolean Generate report in mermaid text format true

Gradle + Kotlin:

configure<com.github.platan.tests_execution_chart.CreateTestsExecutionReportExtension> {
    formats {
        html {
            enabled.set(true)
            script {
                src.set("https://cdn.jsdelivr.net/npm/mermaid@8.13.3/dist/mermaid.js")
                embed.set(true)
            }
        }
        json {
            enabled.set(true)
        }
        mermaid {
            enabled.set(true)
        }
    }
}

Gradle + Groovy:

createTestsExecutionReport {
    formats {
        json {
            enabled = false
        }
        html {
            enabled = true
            script {
                src = "https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"
                embed = true
            }
        }
        mermaid {
            enabled = false
        }
    }
}

Changelog

Unreleased

  • ...

License

This project is licensed under the MIT license.

About

Gradle plugin that visualises tests execution schedule

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Kotlin 65.0%
  • Groovy 27.7%
  • HTML 6.1%
  • Shell 1.2%