Description: Allow Gradle to correctly build this package Author: Olek Wojnar Forwarded: not-needed Last-Update: 2020-07-04 --- a/build.gradle +++ b/build.gradle @@ -1,38 +1,12 @@ -import de.undercouch.gradle.tasks.download.Download - -plugins { - // https://plugins.gradle.org/plugin/com.github.johnrengelman.shadow (v5 requires Gradle 5) - id 'com.github.johnrengelman.shadow' version '5.2.0' - // https://plugins.gradle.org/plugin/de.undercouch.download - id "de.undercouch.download" version "4.0.4" - id 'java' - // https://github.com/tbroyer/gradle-errorprone-plugin - id "net.ltgt.errorprone" version "1.1.1" - // https://plugins.gradle.org/plugin/org.ajoberstar.grgit - id 'org.ajoberstar.grgit' version '4.0.1' apply false - // https://github.com/n0mer/gradle-git-properties ; target is: generateGitProperties - id "com.gorylenko.gradle-git-properties" version "2.2.2" -} -apply plugin: "de.undercouch.download" - -import org.ajoberstar.grgit.Grgit - repositories { jcenter() mavenCentral() } -gitProperties { - gitPropertiesResourceDir = "${project.rootDir}/framework/src/main/resources" -} ext { release = false - // On a Java 8 JVM, use error-prone javac and source/target 8. - // On a Java 9+ JVM, use the host javac, default source/target, and required module flags. - isJava8 = JavaVersion.current() == JavaVersion.VERSION_1_8 - errorproneJavacVersion = '9+181-r4173-1' parentDir = file("${rootDir}/../").absolutePath @@ -45,8 +19,6 @@ stubparserJar = "${stubparser}/javaparser-core/target/stubparser.jar" jtregHome = "${parentDir}/jtreg" - formatScriptsHome = "${project(':checker').projectDir}/bin-devel/.run-google-java-format" - plumeScriptsHome = "${project(':checker').projectDir}/bin-devel/.plume-scripts" javadocMemberLevel = JavadocMemberLevel.PROTECTED @@ -54,22 +26,6 @@ // This value is always overwritten, but Gradle needs the variable to be initialized. localRepo = ".git" } -// Keep in sync with check in org.checkerframework.framework.source.SourceChecker.init -// and with text in #installation -switch (JavaVersion.current()) { - case JavaVersion.VERSION_1_9: - case JavaVersion.VERSION_1_10: - case JavaVersion.VERSION_12: - logger.warn("The Checker Framework has only been tested with JDK 8 and 11." + - " Found version " + JavaVersion.current().majorVersion); - break; - case JavaVersion.VERSION_1_8: - case JavaVersion.VERSION_11: - break; // Supported versions - default: - throw new GradleException("Build the Checker Framework with JDK 8 or JDK 11." + - " Found version " + JavaVersion.current().majorVersion); -} task setLocalRepo(type:Exec) { commandLine 'git', 'worktree', 'list' @@ -80,18 +36,8 @@ } } -task installGitHooks(type: Copy, dependsOn: 'setLocalRepo') { - description 'Copies git hooks to .git directory' - from files("checker/bin-devel/git.post-merge", "checker/bin-devel/git.pre-commit") - rename('git\\.(.*)', '$1') - into localRepo + "/hooks" -} - allprojects { apply plugin: 'java' - apply plugin: 'com.github.johnrengelman.shadow' - apply plugin: "de.undercouch.download" - apply plugin: 'net.ltgt.errorprone' group 'org.checkerframework' // Increment the minor version rather than just the patch level if: @@ -116,48 +62,8 @@ annotationProcessor.exclude group:'org.checkerframework', module:'checker-qual' } - dependencies { - if (isJava8) { - javacJar group: 'com.google.errorprone', name: 'javac', version: "$errorproneJavacVersion" - } - - errorproneJavac("com.google.errorprone:javac:$errorproneJavacVersion") - } - // After all the tasks have been created, modify some of them. afterEvaluate { - // Add the fat checker.jar to the classpath of every Javadoc task. This allows Javadoc in - // any module to reference classes in any other module. - // Also, build and use ManualTaglet as a taglet. - tasks.withType(Javadoc) { - def tagletVersion = isJava8 ? 'taglet' : 'tagletJdk11' - - dependsOn(':checker:shadowJar') - dependsOn(":framework-test:${tagletVersion}Classes") - doFirst { - options.encoding = 'UTF-8' - if (!name.startsWith('requireJavadoc') && !name.equals("javadocDoclintAll")) { - options.memberLevel = javadocMemberLevel - } - classpath += files(project(':checker').tasks.getByName('shadowJar').archivePath) - if (isJava8) { - classpath += configurations.javacJar - } - options.taglets 'org.checkerframework.taglet.ManualTaglet' - options.tagletPath(project(':framework-test').sourceSets."${tagletVersion}".output.classesDirs.getFiles() as File[]) - - // We want to link to Java 9 documentation of the compiler classes since we use Java 9 - // versions of those classes and Java 8 for everything else. Because the compiler classes are not - // apart of the main documentation of Java 8, javadoc links to the Java 9 versions. - // TODO, this creates broken links to the com.sun.tools.javac package. - options.links = ['https://docs.oracle.com/javase/8/docs/api/', 'https://docs.oracle.com/javase/9/docs/api/'] - // This file is looked for by Javadoc. - file("${destinationDir}/resources/fonts/").mkdirs() - ant.touch(file: "${destinationDir}/resources/fonts/dejavu.css") - options.addStringOption('source', '8') - } - } - /// TODO: One day we can enable this. For now, CI jobs require Javadoc on changed lines. // // Turn Javadoc warnings into errors. // tasks.withType(Javadoc) { @@ -166,7 +72,6 @@ // Add standard javac options tasks.withType(JavaCompile) { - dependsOn(':installGitHooks') sourceCompatibility = 8 targetCompatibility = 8 // Because the target is 8, all of the public compiler classes are accessible, so @@ -211,11 +116,7 @@ options.encoding = 'UTF-8' options.fork = true - if (isJava8) { - options.forkOptions.jvmArgs += ["-Xbootclasspath/p:${configurations.javacJar.asPath}"] - } - // Don't use error-prone by default - options.errorprone.enabled = false + } } } @@ -233,90 +134,8 @@ } } -/** - * Creates a task that runs the checker on the main source set of each subproject. The task is named - * "check${shortName}", for example "checkPurity" or "checkNullness". - * @param projectName name of the project - * @param checker full qualified name of the checker to run - * @param shortName shorter version of the checker to use to name the task. - * @param args list of arguments to pass to the checker - */ -def createCheckTypeTask(projectName, checker, shortName, args = []) { - project("${projectName}").tasks.create(name: "check${shortName}", type: JavaCompile, dependsOn: ':checker:shadowJar') { - description "Run the ${shortName} Checker on the main sources." - group 'Verification' - dependsOn ':checker:updateJdk' - // Always run the task. - outputs.upToDateWhen { false } - source = project("${projectName}").sourceSets.main.java - classpath = files(project("${projectName}").compileJava.classpath,project(':checker-qual').sourceSets.main.output) - destinationDir = file("${buildDir}") - - options.annotationProcessorPath = files(project(':checker').tasks.shadowJar.archivePath) - options.compilerArgs += [ - '-processor', "${checker}", - '-proc:only', - '-Xlint:-processing', - ] - options.compilerArgs += args - if (isJava8) { - options.compilerArgs += [ - "-Xbootclasspath/p:${rootDir}/checker/dist/jdk8.jar", - "-source", - "8", - "-target", - "8" - ] - } else { - options.fork = true - options.forkOptions.jvmArgs += [ - "--add-opens", "jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED", - ] - } - } -} -/** - * Returns a list of all the Java files that should be formatted for the given project. These are: - * - * All java files in the main sourceSet. - * All java files in the tests directory that compile. - * - * @param projectName name of the project to format - * @return a list of all Java files that should be formatted for projectName - */ -List getJavaFilesToFormat(projectName) { - List javaFiles = new ArrayList<>(); - project(':' + projectName).sourceSets.forEach { set -> - javaFiles.addAll(set.java.files) - } - // Collect all java files in tests directory - fileTree("${project(projectName).projectDir}/tests").visit { details -> - if (!details.path.contains("nullness-javac-errors") && details.name.endsWith('java')) { - javaFiles.add(details.file) - } - } - // Collect all java files in jtreg directory - fileTree("${project(projectName).projectDir}/jtreg").visit { details -> - if (!details.path.contains("nullness-javac-errors") && details.name.endsWith('java')) { - javaFiles.add(details.file) - } - } - - // Collect all java files in jtreg directory - fileTree("${project(projectName).projectDir}/jtregJdk11").visit { details -> - if (!details.path.contains("nullness-javac-errors") && details.name.endsWith('java')) { - javaFiles.add(details.file) - } - } - - List args = new ArrayList<>(); - for (File f : javaFiles) { - args += f.absolutePath - } - return args -} task htmlValidate(type: Exec, group: 'Format') { description 'Validate that HTML files are well-formed' @@ -331,51 +150,6 @@ } -// `gradle allJavadoc` builds the Javadoc for all modules in `docs/api`. -// This is what is published to checkerframework.org. -// `gradle javadoc` builds the Javadoc for each sub-project in /build/docs/javadoc/ . -// It's needed to create the Javadoc jars that we release in Maven Central. -// To make javadoc for only one subproject, run `./gradlew javadoc` -// in the subproject or `./gradlew :checker:javadoc` at the top level. -task allJavadoc(type: Javadoc, group: "Documentation") { - description = 'Generates a global API documentation for all the modules' - dependsOn(':checker:shadowJar', 'getPlumeScripts') - destinationDir = file("${rootDir}/docs/api") - source(project(':checker').sourceSets.main.allJava, project(':framework').sourceSets.main.allJava, - project(':dataflow').sourceSets.main.allJava, project(':javacutil').sourceSets.main.allJava) - - classpath = files(subprojects.collect { it.sourceSets.main.compileClasspath }) - if (isJava8) { - classpath += configurations.javacJar - } - doLast { - exec { - // Javadoc for to com.sun.tools.java.* is not publicly available, so these links are broken. - // This command removes those links. - workingDir "${rootDir}/docs/api" - executable "${plumeScriptsHome}/preplace" - args += [' - String junitClassName = file.name.replaceAll(".java", "") - tasks.create(name: "${junitClassName}", type: Test) { - description "Run ${junitClassName} tests." - include "**/${name}.class" - } - } - - // Configure JUnit tests - tasks.withType(Test) { - if (isJava8) { - jvmArgs "-Xbootclasspath/p:${configurations.javacJar.asPath}" - } else { - // Without this, the test throw "java.lang.OutOfMemoryError: Java heap space" - forkEvery(1) - jvmArgs += [ - "--illegal-access=warn", - "--add-opens", "jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED", - ] - } - - if (project.name.is('checker')) { - dependsOn('copyJarsToDist') - systemProperties += [JDK_JAR: "${projectDir}/dist/jdk8.jar"] - } - - if (project.hasProperty('emit.test.debug')) { - systemProperties += ["emit.test.debug": 'true'] - } - - testLogging { - showStandardStreams = true - // Always run the tests - outputs.upToDateWhen { false } - - // Show the found unexpected diagnostics and expected diagnostics not found. - exceptionFormat "full" - events "failed" - } - - // After each test, print a summary. - afterSuite { desc, result -> - if (desc.getClassName() != null) { - long mils = result.getEndTime() - result.getStartTime() - double seconds = mils / 1000.0 - - println "Testsuite: ${desc.getClassName()}\n" + - "Tests run: ${result.testCount}, " + - "Failures: ${result.failedTestCount}, " + - "Skipped: ${result.skippedTestCount}, " + - "Time elapsed: ${seconds} sec\n" - } - } } - // Create a runErrorProne task. - tasks.create(name: 'runErrorProne', type: JavaCompile, group: 'Verification') { - description 'Run the error-prone compiler on the main sources' - - source = sourceSets.main.java.asFileTree - classpath = sourceSets.main.compileClasspath.asFileTree - destinationDir = new File("${buildDir}", 'errorprone') - - // Error Prone must be available in the annotation processor path - options.annotationProcessorPath = configurations.errorprone - // Enable Error Prone - options.errorprone.enabled = true - options.errorprone.disableWarningsInGeneratedCode = true - options.errorprone.errorproneArgs = [ - // Many compiler classes are interned. - '-Xep:ReferenceEquality:OFF', - // These might be worth fixing. - '-Xep:DefaultCharset:OFF', - // Not useful to suggest Splitter; maybe clean up. - '-Xep:StringSplitter:OFF', - // Too broad, rejects seemingly-correct code. - '-Xep:EqualsGetClass:OFF', - // Not a real problem - '-Xep:MixedMutabilityReturnType:OFF', - // Don't want to add a dependency to ErrorProne. - '-Xep:AnnotateFormatMethod:OFF', - // -Werror halts the build if Error Prone issues a warning, which ensures that - // the errors get fixed. On the downside, Error Prone (or maybe the compiler?) - // stops as soon as it one warning, rather than outputting them all. - // https://github.com/google/error-prone/issues/436 - '-Werror', - ] - } - - // Create a nonJunitTests task per project - tasks.create(name: 'nonJunitTests', group: 'Verification') { - description 'Run all Checker Framework tests except for the Junit tests.' - dependsOn('checkInterning', 'checkPurity', 'checkSignature', 'checkWorkingNullness') - if (project.name.is('framework') || project.name.is('checker')) { - dependsOn('checkCompilerMessages', 'jtregTests') - } - if (project.name.is('framework')) { - dependsOn('wholeProgramInferenceTests', 'loaderTests') - } - - if (project.name.is('checker')) { - if (!isJava8) { - dependsOn('jtregJdk11Tests') - } - dependsOn('nullnessExtraTests', 'commandLineTests', 'tutorialTests') - } - } - - // Create an allTests task per project - tasks.create(name: 'allTests', group: 'Verification') { - description 'Run all Checker Framework tests' - // The 'test' target is just the JUnit tests. - dependsOn('nonJunitTests', 'test') - } - - task javadocPrivate(dependsOn: javadoc) { - doFirst { - javadocMemberLevel = JavadocMemberLevel.PRIVATE - } - doLast { - javadocMemberLevel = JavadocMemberLevel.PROTECTED - } - } } } -assemble.dependsOn(':checker:copyJarsToDist') task checkBasicStyle(group: 'Format') { description 'Check basic style guidelines. Not related to Checkstyle tool.' @@ -936,7 +307,6 @@ assemble.mustRunAfter(clean) task buildAll { description 'Build all jar files, including source and javadoc jars' - dependsOn(allJavadoc) subprojects { Project subproject -> dependsOn("${subproject.name}:assemble") dependsOn("${subproject.name}:javadocJar") --- a/settings.gradle +++ b/settings.gradle @@ -1,9 +1,3 @@ rootProject.name = 'checker-framework' -include 'checker' -include 'javacutil' -include 'dataflow' -include 'framework' include 'checker-qual' include 'checker-qual-android' -include 'framework-test' -