build.gradle

/*
 * This file was generated by the Gradle 'init' task.
 *
 * This generated file contains a sample Java library project to get you started.
 * For more details take a look at the 'Building Java & JVM projects' chapter in the Gradle
 * User Manual available at https://docs.gradle.org/7.3.3/userguide/building_java_projects.html
 */

plugins {
    // Apply the java-library plugin for API and implementation separation.
    id 'java-library'
    id 'signing'
    id 'maven-publish'
    id 'jacoco'
    id 'jvm-test-suite'
    id 'jacoco-report-aggregation'
    id 'checkstyle'
    id 'com.github.johnrengelman.shadow' version '7.1.2'
    id 'org.revapi.revapi-gradle-plugin' version '1.8.0'
}

repositories {
    // Use Maven Central for resolving dependencies.
    mavenCentral()
}

group = 'software.amazon.nio.s3'
archivesBaseName = 'nio-spi-for-s3'
version = '2.1.0'

java {
    withSourcesJar()
    withJavadocJar()
}

java {
    toolchain {
        languageVersion = JavaLanguageVersion.of(11)
    }
}

tasks.withType(JavaCompile).configureEach {
    options.release.set(11)
    options.compilerArgs += ['-Xlint:all,-serial']
}

sourceSets {
    examples {
        java {
        }
    }
}

dependencies {
    implementation 'io.reactivex.rxjava3:rxjava:3.1.9'

    implementation platform('software.amazon.awssdk:bom:2.28.18')

    implementation('software.amazon.awssdk:s3') {
        exclude group: 'software.amazon.awssdk', module: 'apache-client'
    }
    implementation('software.amazon.awssdk:s3-transfer-manager') {
        exclude group: 'software.amazon.awssdk', module: 'apache-client'
    }
    implementation 'software.amazon.awssdk.crt:aws-crt:0.31.3'
    implementation 'org.slf4j:slf4j-api:2.0.16'
    implementation 'com.github.ben-manes.caffeine:caffeine:3.1.8'

    examplesImplementation project
    examplesImplementation 'org.slf4j:slf4j-api:2.0.16'
}

publishing {
    publications {
        maven(MavenPublication) {
            from components.java
            pom {
                name = 'AWS Java NIO SPI for S3'
                description = 'A Java NIO.2 service provider for S3, allowing Java NIO operations to be performed on paths using the `s3` scheme. This\n' +
                        'package implements the service provider interface (SPI) defined for Java NIO.2 in JDK 1.7 providing "plug-in" non-blocking\n' +
                        'access to S3 objects for Java applications using Java NIO.2 for file access.'
                url = 'https://github.com/awslabs/aws-java-nio-spi-for-s3'
                inceptionYear = '2022'
                scm {
                    url = 'https://github.com/awslabs/aws-java-nio-spi-for-s3/tree/main'
                    connection = 'scm:git:ssh://git@github.com/awslabs/aws-java-nio-spi-for-s3.git'
                    developerConnection = 'scm:git:ssh://git@github.com/awslabs/aws-java-nio-spi-for-s3.git'
                }

                licenses {
                    license {
                        name = 'The Apache License, Version 2.0'
                        url = 'https://www.apache.org/licenses/LICENSE-2.0.txt'
                        distribution = 'repo'
                    }
                }

                developers {
                    developer {
                        id = 'markjschreiber'
                        name = 'Mark Schreiber'
                        email = 'mrschre@amazon.com'
                    }
                }
            }
        }
    }
    repositories {
        maven {
            def releasesRepoUrl = 'https://aws.oss.sonatype.org/service/local/staging/deploy/maven2/'
            def snapshotsRepoUrl = 'https://aws.oss.sonatype.org/content/repositories/snapshots'
            url = version.endsWith('SNAPSHOT') ? snapshotsRepoUrl : releasesRepoUrl
            credentials(PasswordCredentials)
        }
    }
}

signing {
    sign publishing.publications.maven
}

javadoc {
    if (JavaVersion.current().isJava9Compatible()) {
        options.addBooleanOption('html5', true)
    }
}

// JVM test suite plugin https://docs.gradle.org/7.3.3/userguide/jvm_test_suite_plugin.html
testing {
    suites {
        integrationTest(JvmTestSuite) {
            dependencies {
                implementation project
                implementation 'org.testcontainers:junit-jupiter:1.20.2'
                implementation 'org.testcontainers:localstack:1.20.2'
                implementation 'org.testcontainers:testcontainers:1.20.2'
            }
        }
        withType(JvmTestSuite).configureEach {
            useJUnitJupiter('5.10.0')
            targets {
                all {
                    testTask.configure {
                        systemProperty "aws.region",  "us-east-1"
                    }
                }
            }
            dependencies {
                implementation 'org.assertj:assertj-core:3.26.3'
                implementation 'org.mockito:mockito-core:5.14.1'
                implementation 'org.mockito:mockito-junit-jupiter:5.14.1'
                implementation 'com.github.stefanbirkner:system-lambda:1.2.1'
                implementation 'ch.qos.logback:logback-classic:1.5.8'
            }
        }
    }
}

reporting {
    reports {
        testFullCodeCoverageReport(JacocoCoverageReport) {
            testType = 'full'
        }
    }
}

tasks.named('testFullCodeCoverageReport') {
    dependsOn( testCodeCoverageReport, integrationTestCodeCoverageReport )
    executionData fileTree( project.buildDir.absolutePath ).include( "jacoco/*.exec" )
}

jacocoTestReport {
    dependsOn test
    reports {
        xml.required = true
        xml.outputLocation = file("build/reports/coverage.xml")
    }
}

checkstyle {
    toolVersion = '10.12.5'
    configDirectory.set(new File(projectDir, ".checkstyle"))
}