/build/libs/integration-test-plugin.jar"))
84 | }
85 | }
86 |
87 | apply(plugin = "com.coditory.integration-test")
88 | ```
89 |
90 | ## Validating plugin module metadata
91 |
92 | The easiest way to validate plugin's module metadata is to publish the plugin to a dummy local repository.
93 |
94 | Add to `build.gradle.kts`:
95 |
96 | ```
97 | publishing {
98 | repositories {
99 | maven {
100 | name = "localPluginRepository"
101 | url = uri("./local-plugin-repository")
102 | }
103 | }
104 | }
105 | ```
106 |
107 | ...and publish the plugin with:
108 |
109 | ```
110 | ./gradlew publish -Pversion=0.0.1
111 | ```
112 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2020 Paweł Mendelski
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Integration Test Gradle Plugin
2 |
3 | [](https://github.com/coditory/gradle-integration-test-plugin/actions/workflows/build.yml)
4 | [](https://codecov.io/gh/coditory/gradle-integration-test-plugin)
5 | [](https://plugins.gradle.org/plugin/com.coditory.integration-test)
6 |
7 | > Single line in build.gradle.kts to enable integration tests in JVM projects
8 |
9 | **Zero configuration**, **single responsibility** gradle plugin for integration tests.
10 |
11 | - Adds `integrationTest` task that executes tests under `src/integration/*`.
12 | - Adds `testAll` task that executes tests under `src/test/*` and `src/integration/*`.
13 | - Handles flags parameters to skip tests `skipTest`, `skipIntegrationTest`, `skipUnitTest`.
14 | - Makes integration classpath extend test classpath and main classpath (in this order).
15 | - Makes sure IntelliJ idea treats `src/integration/*` as test sources.
16 | - Exposes kotlin internal scope (from main and test module) to integration tests.
17 | - Integrates with test coverage tools like [Jacoco](https://docs.gradle.org/current/userguide/jacoco_plugin.html)
18 | and [Kover](https://github.com/Kotlin/kotlinx-kover).
19 | - Integrates with test frameworks like [JUnit5](https://junit.org/junit5/), [Spock](https://spockframework.org/) and
20 | [Kotest](https://kotest.io/).
21 | - Compatible with [gradle configuration cache](https://docs.gradle.org/current/userguide/configuration_cache.html)
22 | and [lazy task configuration](https://docs.gradle.org/current/userguide/lazy_configuration.html).
23 |
24 | ## Using the plugin
25 |
26 | Update `build.gradle.kts`
27 |
28 | ```gradle
29 | plugins {
30 | id("com.coditory.integration-test") version "2.2.5"
31 | }
32 |
33 | dependencies {
34 | integrationImplementation(...)
35 | }
36 | ```
37 |
38 | Add integration tests under `src/integration`. That's it!
39 |
40 | There are more details below but the rest is quite obvious as it suppose to be.
41 |
42 | ### Sample usages with different test frameworks
43 |
44 | See a [project](https://github.com/coditory/gradle-integration-test-plugin-sample) with all the examples.
45 |
46 | Java + JUnit5 (project)
47 |
48 |
49 | ```gradle
50 | // build.gradle.kts
51 | plugins {
52 | id("java")
53 | id("com.coditory.integration-test") version "2.2.5"
54 | }
55 |
56 | dependencies {
57 | testImplementation("org.junit.jupiter:junit-jupiter-api:5.11.0")
58 | testRuntime("org.junit.jupiter:junit-jupiter-engine:5.11.0")
59 | }
60 |
61 | tasks.withType {
62 | useJUnitPlatform()
63 | }
64 | ```
65 |
66 |
67 | Groovy + Spock (project)
69 |
70 |
71 | ```gradle
72 | // build.gradle
73 | plugins {
74 | id "groovy"
75 | id "com.coditory.integration-test" version "2.2.5"
76 | }
77 |
78 | dependencies {
79 | testCompile "org.spockframework:spock-core:2.4-M4-groovy-4.0"
80 | }
81 |
82 | tasks.withType(Test) {
83 | useJUnitPlatform()
84 | }
85 | ```
86 |
87 |
88 | Kotlin + JUnit5 (project)
90 |
91 |
92 | ```gradle
93 | // build.gradle.kts
94 | plugins {
95 | kotlin("jvm") version "2.0.21"
96 | id("com.coditory.integration-test") version "2.2.5"
97 | }
98 |
99 | dependencies {
100 | testImplementation("org.junit.jupiter:junit-jupiter-api:5.11.3")
101 | testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.11.3")
102 | }
103 |
104 | tasks.withType {
105 | useJUnitPlatform()
106 | }
107 | ```
108 |
109 |
110 | Kotlin + Kotest (project)
112 |
113 |
114 | ```gradle
115 | // build.gradle.kts
116 | plugins {
117 | kotlin("jvm") version "2.0.21"
118 | id("com.coditory.integration-test") version "2.2.5"
119 | }
120 |
121 | dependencies {
122 | testImplementation("org.junit.jupiter:junit-jupiter-api:5.11.3")
123 | testRuntime("org.junit.jupiter:junit-jupiter-engine:5.11.3")
124 | testImplementation("io.kotest:kotest-runner-junit5:5.9.1")
125 | }
126 |
127 | tasks.withType {
128 | useJUnitPlatform()
129 | }
130 | ```
131 |
132 |
133 |