Skip to content

Commit

Permalink
docs: README update
Browse files Browse the repository at this point in the history
  • Loading branch information
vbaidak committed Nov 14, 2024
1 parent 7797ae6 commit c8eeda5
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,24 +31,27 @@ plugins {
After applying the plugin, the following takes place:

1. JavaPlugin applied if not yet applied
2. New directories are created (if missing):
* Source set directory for integration tests (the value of **it.srcDir** property, which is **src/it/java** by default)
* Resources directory for integration tests (the value of **it.resourcesDir** property, which is **src/it/resources** by default)
3. Gradle configurations added:
* **itImplementation** - configuration for integration test compile scope (contains **implementation** classpath)
* **itRuntimeOnly** - configuration for integration test runtime scope (contains **testRuntimeOnly** classpath)
4. Gradle **it** task created, which runs integration tests located in integration test source set
2. IdeaPlugin applied if not yet applied
3. New directories are created (if missing):
* Source set directory for integration tests (`src/it/java` by default)
* Resources directory for integration tests (`src/it/resources` by default)
4. Gradle configurations added:
* `itImplementation` - configuration for integration test compile scope (contains `implementation` classpath)
* `itRuntimeOnly` - configuration for integration test runtime scope (contains `testRuntimeOnly` classpath)
* `it*` - other configurations inherited from `Test` (e.g. `itAnnotationProcessor`)
5. Gradle `it` task created, which runs integration tests located within the integration test source set
6. Integration test sources directory marked as test sources in **IntelliJ IDEA**

## Configuration

```kotlin
it {
tasks.it {
srcDir = "src/it/kotlin"
resourcesDir = "src/it/resources"
useJUnitPlatform()
maxParallelForks = 4
}
tasks.getByName("it").finalizedBy("cleanDb") // assuming there is some cleanDb task
tasks.it.finalizedBy(tasks.cleanDb) // assuming there is some cleanDb task
```

## License
Expand Down

0 comments on commit c8eeda5

Please sign in to comment.