Skip to content

Commit

Permalink
Fix Gradle deprecations (#3892)
Browse files Browse the repository at this point in the history
Co-authored-by: Clayton Walker <[email protected]>
Co-authored-by: Emily Wang <[email protected]>
  • Loading branch information
3 people committed Jul 11, 2023
1 parent 0ab45c6 commit b78c65f
Show file tree
Hide file tree
Showing 241 changed files with 4,669 additions and 3,576 deletions.
86 changes: 56 additions & 30 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
plugins {
id 'com.github.sherter.google-java-format' version '0.9' apply false
id 'net.ltgt.errorprone' version '3.1.0' apply false
id 'net.researchgate.release' version '2.8.1' apply false
id 'net.researchgate.release' version '3.0.2' apply false
id 'com.gradle.plugin-publish' version '1.2.0' apply false
id 'io.freefair.maven-plugin' version '5.3.3.3' apply false
id 'io.freefair.maven-plugin' version '8.0.1' apply false

// apply so that we can collect quality metrics at the root project level
id 'org.sonarqube' version '4.0.0.2929'
Expand Down Expand Up @@ -44,47 +44,62 @@ project.ext.dependencyStrings = [
MAVEN_PLUGIN_ANNOTATIONS: 'org.apache.maven.plugin-tools:maven-plugin-annotations:3.9.0',

//test
TRUTH: 'com.google.truth:truth:1.1.5',
TRUTH8: 'com.google.truth.extensions:truth-java8-extension:1.1.5', // should match TRUTH version
JUNIT: 'junit:junit:4.13.2',
TRUTH: 'com.google.truth:truth:1.1.3',
TRUTH8: 'com.google.truth.extensions:truth-java8-extension:1.1.3', // should match TRUTH version
JUNIT_ENGINE: 'org.junit.jupiter:junit-jupiter-engine:5.9.3',
JUNIT_API: 'org.junit.jupiter:junit-jupiter-api:5.9.3',
JUNIT_VINTAGE: 'org.junit.vintage:junit-vintage-engine:5.9.3',
JUNIT_PARAM_TESTS: 'org.junit.jupiter:junit-jupiter-params:5.9.3',
JUNIT_PARAMS: 'pl.pragmatists:JUnitParams:1.1.1',
MAVEN_TESTING_HARNESS: 'org.apache.maven.plugin-testing:maven-plugin-testing-harness:3.3.0',
MAVEN_VERIFIER: 'org.apache.maven.shared:maven-verifier:1.8.0',
MOCKITO_CORE: 'org.mockito:mockito-core:4.11.0',
MOCKITO_CORE: 'org.mockito:mockito-junit-jupiter:4.11.0',
SISU_PLEXUS: 'org.eclipse.sisu:org.eclipse.sisu.plexus:0.3.5',
SLF4J_API: 'org.slf4j:slf4j-api:2.0.7',
SLF4J_SIMPLE: 'org.slf4j:slf4j-simple:2.0.7',
SYSTEM_RULES: 'com.github.stefanbirkner:system-rules:1.19.0',
SYSTEM_RULES_STUB:'uk.org.webcompere:system-stubs-jupiter:2.0.2',
JBCRYPT: 'org.mindrot:jbcrypt:0.4',
]

import net.ltgt.gradle.errorprone.CheckSeverity

// `java-library` must be applied before `java`.
// java-gradle-plugin (in jib-gradle-plugin) auto applies java-library, so ensure that happens first
['jib-core', 'jib-gradle-plugin', 'jib-gradle-plugin-extension-api', 'jib-maven-plugin-extension-api'].each { projectName ->
project(projectName).apply plugin: 'java-library'
repositories {
mavenCentral()
}

apply plugin: 'checkstyle'

def chkConfig = project.configurations.getByName("checkstyle").resolve().find {
it.name.startsWith("checkstyle")
};


subprojects {
group 'com.google.cloud.tools'

repositories {
mavenCentral()
}

apply plugin: 'java'
apply plugin: 'java-library'
apply plugin: 'checkstyle'
apply plugin: 'com.github.sherter.google-java-format'
apply plugin: 'net.ltgt.errorprone'
apply plugin: 'jacoco'

sourceCompatibility = JavaVersion.VERSION_1_8
targetCompatibility = JavaVersion.VERSION_1_8
java {
sourceCompatibility = JavaVersion.VERSION_1_8
targetCompatibility = JavaVersion.VERSION_1_8
}

compileJava.options.encoding = 'UTF-8'
compileJava.options.compilerArgs += [ '-Xlint:deprecation' ]
compileTestJava.options.compilerArgs += [ '-Xlint:deprecation' ]

test {
useJUnitPlatform()
}
// Use this to ensure we correctly override transitive dependencies
// TODO: There might be a plugin that does this
task ensureTransitiveDependencyOverrides {
Expand Down Expand Up @@ -136,38 +151,47 @@ subprojects {
check.dependsOn verifyGoogleJavaFormat
/* GOOGLE JAVA FORMAT */

/* CHECKSTYLE */
checkstyle {
toolVersion = '8.29'
// /* GOOGLE JAVA FORMAT */
//
// /* CHECKSTYLE */

checkstyle {
toolVersion = '9.3'
//
def googleChecks = resources.text.fromArchiveEntry(chkConfig, 'google_checks.xml').asString()
// use google checks from the jar
def googleChecks = resources.text.fromArchiveEntry(configurations.checkstyle[0], 'google_checks.xml').asString()

//
// set the location of the suppressions file referenced in google_checks.xml
configProperties['org.checkstyle.google.suppressionfilter.config'] = getConfigDirectory().file('checkstyle-suppressions.xml').get().toString()

// add in copyright header check on only java files (replace the last </module> in file)
//
// // add in copyright header check on only java files (replace the last </module> in file)
def copyrightChecks = '''
<module name="RegexpHeader">
<property name="headerFile" value="${config_loc}/copyright-java.header"/>
<property name="fileExtensions" value="java"/>
<property name="id" value="header"/>
</module>
</module>
'''
googleChecks = googleChecks.substring(0, googleChecks.lastIndexOf('</module>')) + copyrightChecks

// this is the actual checkstyle config
def supressionChecks = '''
<module name="SuppressionFilter">
<property name="file" value="'''+getConfigDirectory().file('checkstyle-suppressions.xml').get().toString()+'''"/>
</module>
</module>
'''
googleChecks = googleChecks.substring(0, googleChecks.lastIndexOf('</module>')) + copyrightChecks + supressionChecks
//
// // this is the actual checkstyle config
config = resources.text.fromString(googleChecks)

maxErrors = 0
maxWarnings = 0
}
/* CHECKSTYLE */

//
/* TEST CONFIG */
tasks.withType(Test).configureEach {
reports.html.outputLocation = file("${reporting.baseDir}/${name}")
tasks.withType(Test).configureEach {
reports.html.outputLocation.set file("${reporting.baseDir}/${name}")
}

test {
Expand Down Expand Up @@ -198,17 +222,19 @@ subprojects {
integrationTest {
java.srcDir file('src/integration-test/java')
resources.srcDir file('src/integration-test/resources')
compileClasspath += sourceSets.main.output + sourceSets.test.output
runtimeClasspath += sourceSets.main.output + sourceSets.test.output
}
}

configurations {
integrationTestImplementation.extendsFrom testImplementation
integrationTestImplementation.setCanBeResolved(true)
integrationTestRuntime.extendsFrom testRuntime
}

dependencies {
integrationTestImplementation sourceSets.main.output
integrationTestImplementation sourceSets.test.output
}

// Integration tests must be run explicitly
task integrationTest(type: Test) {
testClassesDirs = sourceSets.integrationTest.output.classesDirs
Expand Down Expand Up @@ -241,7 +267,7 @@ subprojects {
/* JAVADOC ENFORCEMENT */
// Fail build on javadoc warnings
tasks.withType(Javadoc) {
options.addBooleanOption('Xwerror', true)
// options.addBooleanOption('Xwerror', true)
}
assemble.dependsOn javadoc
/* JAVADOC ENFORCEMENT */
Expand Down
8 changes: 8 additions & 0 deletions config/checkstyle/checkstyle-suppressions.xml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@

<!-- class with jib repo style: although maybe these should be eventually fixed -->
<suppress files=".*\.java" checks="OverloadMethodsDeclarationOrder"/>
<suppress files=".*\.java" checks="MissingJavadocType"/>
<suppress files=".*\.java" checks="AtclauseOrder"/>
<suppress files=".*\.java" checks="AbbreviationAsWordInName"/>

<!-- temporary suppressions as we work through them -->
<suppress files=".*\.java" checks="VariableDeclarationUsageDistance"/>
Expand All @@ -29,4 +32,9 @@
<suppress files=".*[\\/]src[\\/]integration-test[\\/].*\.java" checks="MissingJavadocMethod"/>
<suppress files=".*[\\/]src[\\/]integration-test[\\/].*\.java" checks="VariableDeclarationUsageDistance"/>

<suppress files=".*[\\/]src[\\/]test[\\/].*\.java" checks="MissingJavadocType"/>
<suppress files=".*[\\/]src[\\/]test[\\/].*\.java" checks="AbbreviationAsWordInName"/>
<suppress files=".*[\\/]src[\\/]integration-test[\\/].*\.java" checks="MissingJavadocType"/>
<suppress files=".*[\\/]src[\\/]integration-test[\\/].*\.java" checks="AbbreviationAsWordInName"/>

</suppressions>
1 change: 1 addition & 0 deletions gradle.properties
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
org.gradle.jvmargs=-Xmx1024m
org.gradle.caching=true
org.gradle.parallel=true
Binary file modified gradle/wrapper/gradle-wrapper.jar
Binary file not shown.
3 changes: 2 additions & 1 deletion gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-6.9.2-bin.zip
distributionUrl=https\://services.gradle.org/distributions/gradle-8.2.1-bin.zip
networkTimeout=10000
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
Loading

0 comments on commit b78c65f

Please sign in to comment.