Gradle Integration Test Plugin

Description

Gradle Integration Test Plugin provides an easy set up for integration tests

Requirements

Gradle 7+

Changelog

Applying

Using the plugins DSL (Kotlin):

plugins {
  id("com.scalified.plugins.gradle.it") version "$version"
}

Using legacy plugin application (Kotlin):

buildscript {
  repositories {
    maven {
      url = uri("https://plugins.gradle.org/m2/")
    }
  }
  dependencies {
    classpath("gradle.plugin.com.scalified.plugins.gradle:it:$version")
  }
}

apply(plugin = "com.scalified.plugins.gradle.it")

Usage

After applying the plugin, the following takes place:

JavaPlugin applied if not yet applied
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)
Gradle configurations added:
- itImplementation - configuration for integration test compile scope (contains implementation classpath)
- itRuntimeOnly - configuration for integration test runtime scope (contains testRuntimeOnly classpath)
Gradle it task created, which runs integration tests located in integration test source set

Configuration

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

License

MIT License

Copyright (c) 2019 Scalified

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Scalified/gradle-it-plugin