lucene/gradle/validation/error-prone.gradle

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

def skipReason

if (rootProject.usesAltJvm && rootProject.runtimeJavaVersion > JavaVersion.VERSION_15) {
  skipReason = "won't work with JDK ${rootProject.runtimeJavaVersion} if used as alternative java toolchain"
}

if (!propertyOrDefault("validation.errorprone", isCIBuild).asBoolean()) {
  skipReason = "skipped on builds not running inside CI environments, pass -Pvalidation.errorprone=true to enable"
}

if (skipReason) {
  configure(rootProject) {
    task errorProneSkipped() {
      doFirst {
        logger.warn("WARNING: errorprone disabled (${skipReason})")
      }
    }
  }
}

allprojects { prj ->
  plugins.withType(JavaPlugin) {
    // LUCENE-9650: Errorprone on master/gradle does not work with JDK-16+ when running as plugin
    // inside a forked Javac process. Javac running inside Gradle works, because we have
    // additional module system opens in place.
    // This is a hack to keep the dependency (so that palantir's version check doesn't complain)
    // but don't include the plugin (which fails on JDK16+).
    if (skipReason) {
      tasks.withType(JavaCompile) { task -> task.dependsOn ":errorProneSkipped" }
      configurations {
        errorprone
      }
      dependencies {
        errorprone("com.google.errorprone:error_prone_core")
      }
    } else {
      prj.apply plugin: 'net.ltgt.errorprone'

      dependencies {
        errorprone("com.google.errorprone:error_prone_core")
      }

      tasks.withType(JavaCompile) { task ->
        // Disable errorprone on the MR-JAR tasks
        if (task.name ==~ /compileMain\d+Java/) {
          options.errorprone.enabled = false
          return
        }

        task.dependsOn ":checkJdkInternalsExportedToGradle"

        options.errorprone.disableWarningsInGeneratedCode = true
        options.errorprone.errorproneArgs = [
            '-XepAllErrorsAsWarnings', // warnings still fail build by default, but allows usage of -Pjavac.failOnWarnings=false
            '-Xep:InlineMeSuggester:OFF', // We don't use this annotation

            // test
            '-Xep:AlmostJavadoc:OFF',
            '-Xep:AlreadyChecked:OFF',
            '-Xep:AmbiguousMethodReference:OFF',
            '-Xep:ArgumentSelectionDefectChecker:OFF',
            '-Xep:ArrayAsKeyOfSetOrMap:OFF',
            '-Xep:ArrayEquals:OFF',
            '-Xep:ArrayHashCode:OFF',
            '-Xep:ArrayToString:OFF',
            '-Xep:AssertionFailureIgnored:OFF',
            '-Xep:BadImport:OFF',
            '-Xep:BadInstanceof:OFF',
            '-Xep:BadShiftAmount:OFF',
            '-Xep:BoxedPrimitiveConstructor:OFF', // we have forbiddenapis for that
            '-Xep:ByteBufferBackingArray:OFF',
            '-Xep:CanIgnoreReturnValueSuggester:OFF',
            '-Xep:CatchAndPrintStackTrace:OFF',
            '-Xep:CatchFail:OFF',
            '-Xep:CharacterGetNumericValue:OFF',
            '-Xep:ClassCanBeStatic:OFF',
            '-Xep:CollectionIncompatibleType:OFF',
            '-Xep:CollectionUndefinedEquality:OFF',
            '-Xep:ComparableType:OFF',
            '-Xep:ComplexBooleanConstant:OFF',
            '-Xep:DefaultPackage:OFF',
            '-Xep:DoNotCallSuggester:OFF',
            '-Xep:DoNotCall:OFF',
            '-Xep:DoubleBraceInitialization:OFF',
            '-Xep:DoubleCheckedLocking:OFF',
            '-Xep:EmptyCatch:OFF',
            '-Xep:EmptyTopLevelDeclaration:OFF',
            '-Xep:EqualsGetClass:OFF',
            '-Xep:EqualsIncompatibleType:OFF',
            '-Xep:EqualsUnsafeCast:OFF',
            '-Xep:EscapedEntity:OFF',
            '-Xep:ExtendingJUnitAssert:OFF',
            '-Xep:ExtendsObject:OFF',
            '-Xep:FallThrough:OFF',
            '-Xep:Finally:OFF',
            '-Xep:FloatingPointLiteralPrecision:OFF',
            '-Xep:FormatString:OFF',
            '-Xep:FutureReturnValueIgnored:OFF',
            '-Xep:HidingField:OFF',
            '-Xep:IdentityBinaryExpression:OFF',
            '-Xep:IdentityHashMapUsage:OFF',
            '-Xep:ImmutableEnumChecker:OFF',
            '-Xep:InconsistentCapitalization:OFF',
            '-Xep:InconsistentHashCode:OFF',
            '-Xep:InfiniteRecursion:OFF',
            '-Xep:InlineFormatString:OFF',
            '-Xep:InputStreamSlowMultibyteRead:OFF',
            '-Xep:IntLongMath:OFF',
            '-Xep:InvalidBlockTag:OFF',
            '-Xep:InvalidInlineTag:OFF',
            '-Xep:InvalidParam:OFF',
            '-Xep:InvalidPatternSyntax:OFF',
            '-Xep:JUnit4TestNotRun:OFF',
            '-Xep:JavaLangClash:OFF',
            '-Xep:JavaUtilDate:OFF',
            '-Xep:JdkObsolete:OFF',
            '-Xep:LockNotBeforeTry:OFF',
            '-Xep:LogicalAssignment:OFF',
            '-Xep:LongDoubleConversion:OFF',
            '-Xep:MathAbsoluteRandom:OFF',
            '-Xep:MissingFail:OFF',
            '-Xep:MissingOverride:OFF',
            '-Xep:MissingSummary:OFF',
            '-Xep:MisusedDayOfYear:OFF',
            '-Xep:MixedMutabilityReturnType:OFF',
            '-Xep:ModifiedButNotUsed:OFF',
            '-Xep:MutablePublicArray:OFF',
            '-Xep:NarrowingCompoundAssignment:OFF',
            '-Xep:NonAtomicVolatileUpdate:OFF',
            '-Xep:NonCanonicalType:OFF',
            '-Xep:ObjectToString:OFF',
            '-Xep:ObjectsHashCodePrimitive:OFF',
            '-Xep:OperatorPrecedence:OFF',
            '-Xep:ProtectedMembersInFinalClass:OFF',
            '-Xep:ReferenceEquality:OFF',
            '-Xep:ReturnValueIgnored:OFF',
            '-Xep:SameNameButDifferent:OFF',
            '-Xep:SelfAssignment:OFF',
            '-Xep:ShortCircuitBoolean:OFF',
            '-Xep:StaticAssignmentInConstructor:OFF',
            '-Xep:StaticAssignmentOfThrowable:OFF',
            '-Xep:StaticGuardedByInstance:OFF',
            '-Xep:StreamResourceLeak:OFF',
            '-Xep:StringSplitter:OFF',
            '-Xep:SynchronizeOnNonFinalField:OFF',
            '-Xep:ThreadJoinLoop:OFF',
            '-Xep:ThreadLocalUsage:OFF',
            '-Xep:ThreadPriorityCheck:OFF',
            '-Xep:ThrowNull:OFF',
            '-Xep:ToStringReturnsNull:OFF',
            '-Xep:TryFailThrowable:OFF',
            '-Xep:TypeParameterShadowing:OFF',
            '-Xep:TypeParameterUnusedInFormals:OFF',
            '-Xep:UndefinedEquals:OFF',
            '-Xep:UnnecessaryLongToIntConversion:OFF',
            '-Xep:UnusedTypeParameter:OFF',
            '-Xep:UnicodeInCode:OFF',
            '-Xep:UnescapedEntity:OFF',
            '-Xep:UnicodeEscape:OFF',
            '-Xep:UnnecessaryLambda:OFF',
            '-Xep:UnnecessaryParentheses:OFF',
            '-Xep:UnsynchronizedOverridesSynchronized:OFF',
            '-Xep:UnusedMethod:OFF',
            '-Xep:UnusedVariable:OFF',
            '-Xep:UseCorrectAssertInTests:OFF',
            '-Xep:WaitNotInLoop:OFF',
        ]
      }
    }
  }
}