codeQuality.gradle

/**
 * Configurations for code quality analysis
 */
import static org.gradle.util.GradleVersion.version

apply plugin: 'org.kordamp.gradle.stats'
apply plugin: 'org.checkerframework'
apply plugin: 'com.github.spotbugs'
apply plugin: 'net.ltgt.errorprone'
apply plugin: 'net.ltgt.nullaway'
apply plugin: 'org.sonarqube'
apply plugin: 'java-library'
apply plugin: 'checkstyle'
apply plugin: 'jacoco'
apply plugin: 'pmd'

configurations {
  checkstyleConfig
}

repositories {
  flatDir {
    dirs "${rootDir}/build/libs"
  }
}

dependencies {
  checkerFramework libraries.checkerFramework
  checkstyleConfig gradlePlugins.checkstyle
  errorproneJavac libraries.errorproneJavac
  errorprone libraries.errorproneCore
  errorprone libraries.nullaway
  errorprone name: 'caffeine_local'
}

// Gradle rewrites the compiler's dependency on Caffeine to a project dependency, which fails
// Instead we have to download and trick the build to put the jar on the compiler's classpath
// See the downloadCaffeineLocal() task and https://github.com/gradle/gradle/issues/11625
task downloadCaffeineLocal() {
  def url = 'https://repo1.maven.org/maven2/com/github/ben-manes/caffeine/caffeine/2.9.0/caffeine-2.9.0.jar'
  def local = file("${rootDir}/build/libs/caffeine_local.jar")
  if (!local.exists()) {
    local.parentFile.mkdirs()
    new URL(url).withInputStream{ input -> local.withOutputStream{ it << input }}
  }
}

javadoc.options.links(
  'https://checkerframework.org/api/',
  'https://lightbend.github.io/config/latest/api/',
  "https://guava.dev/releases/${versions.guava}/api/docs/",
  "https://docs.oracle.com/en/java/javase/${JavaVersion.current().majorVersion}/docs/api/")

jar {
  manifest.attributes 'Bundle-License': 'https://www.apache.org/licenses/LICENSE-2.0'
  metaInf {
    from "${rootDir}/LICENSE"
  }
}

checkerFramework {
  checkers = [
    'org.checkerframework.checker.nullness.NullnessChecker',
  ]
  extraJavacArgs = [ '-Werror' ]
  excludeTests = true
}

checkstyle {
  showViolations = true
  toolVersion = pluginVersions.checkstyle
  config = resources.text.fromArchiveEntry(configurations.checkstyleConfig, 'google_checks.xml')
}

spotbugs {
  effort = 'max'
  excludeFilter = file("${rootDir}/config/spotbugs/exclude.xml")
  toolVersion = [version(pluginVersions.spotbugs), version(toolVersion.get())].max().version
}

pmd {
  ruleSets = []
  ruleSetConfig = resources.text.fromFile(file("${rootDir}/config/pmd/rulesSets.xml"))
  toolVersion = [version(pluginVersions.pmd), version(toolVersion)].max().version
}

jacoco {
  toolVersion = [version(pluginVersions.jacoco), version(toolVersion)].max().version
}

jacocoTestReport {
  group = 'Coverage reports'
  description = 'Generates a test coverage report for a project'

  reports {
    xml.enabled = true
    html.enabled = true
  }
}

sonarqube {
  properties {
    property 'sonar.organization', 'caffeine'
    property 'sonar.projectKey', 'caffeine:caffeine'
    property 'sonar.login', System.env.'SONAR_TOKEN'
    property 'sonar.host.url', 'https://sonarcloud.io'
  }
}

tasks.withType(JavaExec) {
  jvmArgs += [
    '--add-exports', 'jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED',
    '--add-exports', 'jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED',
    '--add-exports', 'jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED',
    '--add-exports', 'jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED',
    '--add-exports', 'jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED',
  ]
}

tasks.withType(JavaCompile).configureEach {
  dependsOn downloadCaffeineLocal
  options.compilerArgs << '-Xlint:all,-auxiliaryclass'
  options.encoding = 'UTF-8'
  options.errorprone {
    option('ClassName')
    option('ComparisonContractViolated')
    option('DepAnn')
    option('DivZero')
    option('EqualsBrokenForNull')
    option('FunctionalInterfaceClash')
    option('LockMethodChecker')
    option('LongLiteralLowerCaseSuffix')
    option('MissingDefault')
    option('MixedArrayDimensions')
    option('NoAllocation')
    option('NumericEquality')
    option('RedundantThrows')
    option('RemoveUnusedImports')
    option('TimeUnitMismatch')
    option('UnlockMethod')
    option('UnnecessaryDefaultInEnumSwitch')
    disable('EmptyCatch')
    disable('MissingSummary')
    error('NullAway')
    excludedPaths = "${buildDir}/generated-sources/.*"

    nullaway {
      annotatedPackages.add('com.github.benmanes.caffeine')
    }
  }
  checkerFramework.skipCheckerFramework = true
}

tasks.named('compileTestJava').configure {
  options.errorprone.disable('NullAway')
}

tasks.withType(Test) {
  if (System.properties.containsKey('debug')) {
    jvmArgs '-Xdebug', '-Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=5005'
  }
  options {
    jvmArgs '-XX:SoftRefLRUPolicyMSPerMB=0'
  }
  if (System.env.'CI') {
    reports.html.enabled = false
  }
  testLogging {
    events 'skipped', 'failed'
    exceptionFormat 'full'
    showCauses = true
    showExceptions = true
    showStackTraces = true
  }
}

tasks.withType(Checkstyle) {
  enabled = System.properties.containsKey('checkstyle')
  group = 'Checkstyle'
  reports {
    xml.enabled = false
    html.enabled = true
  }
}

afterEvaluate {
  tasks.findAll { it.name.startsWith('spotbugs') }.each {
    it.enabled = System.properties.containsKey('spotbugs')
    it.group = 'SpotBugs'
    it.reports {
      html.enabled = true
    }
  }
}

tasks.withType(Pmd) {
  enabled = System.properties.containsKey('pmd')
  group = 'PMD'
  reports {
    xml.enabled = false
    html.enabled = true
  }
}