Use an EISOP CF build

.github/dependabot.yml

@@ -9,3 +9,13 @@ updates:
   directory: "/"
   schedule:
     interval: "daily"
+
+- package-ecosystem: "gradle"
+  directory: "/conformance-test-framework"
+  schedule:
+    interval: "daily"
+
+- package-ecosystem: "gradle"
+  directory: "/usage-demo"
+  schedule:
+    interval: "daily"

.github/workflows/build.yml

@@ -19,6 +19,12 @@ jobs:
         with:
           repository: jspecify/jspecify
           path: jspecify
+# Clone the EISOP CF if necessary:
+#      - name: Check out eisop/checker-framework
+#        uses: actions/checkout@v4
+#        with:
+#          repository: eisop/checker-framework
+#          path: checker-framework
       - name: Set up Java
         uses: actions/setup-java@v4
         with:
@@ -28,17 +34,22 @@ jobs:
         uses: gradle/gradle-build-action@v3
       - name: Build and Test
         run: ./gradlew build conformanceTests demoTest --include-build ../jspecify
+# If a cloned EISOP CF is needed, use the following:
+#        run: ./gradlew build conformanceTests demoTest --include-build ../jspecify --include-build ../checker-framework
         env:
           SHALLOW: 1
-      - name: Check out jspecify/samples-google-prototype
+          JSPECIFY_CONFORMANCE_TEST_MODE: details
+      - name: Check out jspecify/samples-google-prototype-eisop
         if: always()
         run: |
-          git fetch --depth=1 origin samples-google-prototype
-          git checkout samples-google-prototype
+          git fetch --depth=1 origin samples-google-prototype-eisop
+          git checkout samples-google-prototype-eisop
         working-directory: jspecify
       - name: Run Samples Tests
         if: always()
         run: ./gradlew jspecifySamplesTest --include-build ../jspecify
+# If a cloned EISOP CF is needed, use the following:
+#        run: ./gradlew jspecifySamplesTest --include-build ../jspecify --include-build ../checker-framework
 
   publish-snapshot:
     name: Publish Conformance Test Framework Snapshot

README.md

@@ -17,21 +17,21 @@ But that's its *only* job. Notably, it is:
 
 ## Relationship to Checker Framework and EISOP
 
-The [EISOP project](https://eisop.github.io/) maintains a fork of [Checker Framework](https://checkerframework.org/), and JSpecify conformance is one of its primary goals.
+The [EISOP project](https://eisop.github.io/) maintains a fork of the [Checker Framework](https://checkerframework.org/), and JSpecify conformance is one of its goals.
 
-This tool happens to be built on top of another fork of these ([here](https://github.com/jspecify/checker-framework)). However, please view this relationship as **implementation detail** only. Building a reference checker from scratch would simply have been too difficult, so we needed to base it on some existing tool. The choice of which tool was made purely for expediency and is **subject to change**.
+This tool is built on top of the [EISOP Checker Framework](https://github.com/eisop/checker-framework). However, please view this relationship as **implementation detail** only. Building a reference checker from scratch would simply have been too difficult, so we needed to base it on some existing tool. The choice of which tool was made purely for expediency and is **subject to change**.
 
 ## Usage
 
-Building and running this tool requires building code from several other repositories, but these instructions will take care of that automatically.
+Building and running this tool depends on code from several other repositories, but these instructions will take care of that automatically.
 
 These instructions might require workarounds or fail outright. Please file an issue if you have any trouble!
 
 ### Prework
 
 Ideally set `JAVA_HOME` to a JDK 11 or JDK 17 installation.
 
-Make sure you have Apache Maven installed and in your PATH, or the Gradle build will fail:
+Make sure you have Apache Maven installed and in your PATH, or the `demo` script will fail:
 
 ```sh
 mvn

build.gradle

@@ -8,13 +8,26 @@ plugins {
 
     id 'com.diffplug.spotless' version '6.25.0'
     id 'io.github.gradle-nexus.publish-plugin' version '1.3.0'
-    id 'net.ltgt.errorprone' version '3.0.1'
+    id 'net.ltgt.errorprone' version '4.1.0'
+    // To show task list as a tree, run: ./gradlew <taskname> taskTree
+    id 'com.dorongold.task-tree' version '4.0.0'
 }
 
 // Nexus Publish plugin requires a group/version at the root project.
 group = 'org.jspecify.reference'
 version = '0.0.0-SNAPSHOT'
 
+sourceSets {
+    main {
+        resources {
+            // Minimized jspecify/jdk
+            srcDirs += [
+                "${buildDir}/generated/resources"
+            ]
+        }
+    }
+}
+
 repositories {
     mavenLocal()
     maven {
@@ -35,10 +48,14 @@ nexusPublishing {
 }
 
 ext {
-    checkerFramework = gradle.includedBuild("checker-framework")
+    // null if not included with `--include-build path/to/checker-framework`
+    checkerFramework = gradle.includedBuilds.find { it.name == 'checker-framework' }
 
     // null if not included with `--include-build path/to/jspecify`
     jspecify = gradle.includedBuilds.find { it.name == 'jspecify' }
+
+    // Location of the jspecify/jdk clone, relative to this directory
+    jspecifyJdkHome = '../jdk'
 }
 
 configurations {
@@ -61,8 +78,10 @@ java {
 dependencies {
     implementation libs.checkerFramework.checker
     implementation libs.checkerFramework.checker.qual
-    implementation libs.checkerFramework.framework
-    implementation libs.checkerFramework.javacutil
+    // Eventually, we would want to only depend on `framework` and
+    // `javacutil` artifacts instead of the entire `checker`.
+    // implementation libs.checkerFramework.framework
+    // implementation libs.checkerFramework.javacutil
 
     implementation libs.jspecify
 
@@ -78,21 +97,31 @@ dependencies {
     errorprone libs.errorProne.core
 }
 
-// Assemble checker-framework when assembling the reference checker.
-assemble.dependsOn(checkerFramework.task(":assemble"))
+// If built with `--include-build path/to/checker-framework` then
+// assemble checker-framework when assembling the reference checker.
+if (checkerFramework != null) {
+    compileJava.dependsOn(checkerFramework.task(":checker:assembleForJavac"))
+}
 
 // If built with `--include-build path/to/jspecify` then
 // assemble jspecify when assembling the reference checker.
 if (jspecify != null) {
     assemble.dependsOn(jspecify.task(':assemble'))
 }
 
+// Enable exec/javaexec
+interface InjectedExecOps {
+    @Inject
+    ExecOperations getExecOps()
+}
+
 tasks.withType(JavaCompile).configureEach {
     options.compilerArgs.add("-Xlint:all")
     // ErrorProne makes suppressing these easier
     options.compilerArgs.add("-Xlint:-fallthrough")
 
     options.errorprone.disable("BadImport")
+    options.errorprone.disable("VoidUsed")
 
     options.compilerArgs.addAll(
             [
@@ -111,6 +140,56 @@ tasks.withType(JavaCompile).configureEach {
             .collect { "--add-exports=jdk.compiler/com.sun.tools.javac.$it=ALL-UNNAMED" })
 }
 
+tasks.register('includeJSpecifyJDK')  {
+    group = 'Build'
+    dependsOn 'compileJava'
+
+    def srcDir = "${jspecifyJdkHome}/src"
+    // This directory needs to be stored at the top-level of the resulting .jar file.
+    // org.checkerframework.framework.stub.AnnotationFileElementTypes will then load
+    // the JDK classes from here instead of from checker.jar.
+    def dstDir = "${buildDir}/generated/resources/annotated-jdk/src/"
+
+    inputs.dir file(srcDir)
+    outputs.dir file(dstDir)
+
+    def injected = project.objects.newInstance(InjectedExecOps)
+
+    doLast {
+        FileTree srcTree = fileTree(dir: srcDir)
+        NavigableSet<String> specFiles = new TreeSet<>();
+        srcTree.visit { FileVisitDetails fvd ->
+            if (!fvd.file.isDirectory() && fvd.file.name.matches('.*\\.java')) {
+                fvd.getFile().readLines().any { line ->
+                    if (line.contains('org.jspecify')) {
+                        specFiles.add(fvd.file.absolutePath)
+                        return true;
+                    }
+                }
+            }
+        }
+        String absoluteSrcDir = file(srcDir).absolutePath
+        int srcPrefixSize = absoluteSrcDir.size()
+        copy {
+            from(srcDir)
+            into(dstDir)
+            for (String specFile : specFiles) {
+                include specFile.substring(srcPrefixSize)
+            }
+        }
+        injected.execOps.javaexec {
+            classpath = sourceSets.main.runtimeClasspath
+            standardOutput = System.out
+            errorOutput = System.err
+
+            mainClass = 'org.checkerframework.framework.stub.JavaStubifier'
+            args dstDir
+        }
+    }
+}
+
+processResources.dependsOn(includeJSpecifyJDK)
+
 tasks.withType(Test).configureEach {
     if (!JavaVersion.current().java9Compatible) {
         jvmArgs "-Xbootclasspath/p:${configurations.errorproneJavac.asPath}"
@@ -132,14 +211,16 @@ tasks.withType(Test).configureEach {
         showStackTraces = false
         showStandardStreams = true
         events "failed"
-        exceptionFormat "full"
+        exceptionFormat = "full"
     }
 }
 
 test {
     include '**/NullSpecTest$Minimal.class'
-
     inputs.files("${rootDir}/tests/minimal")
+
+    include '**/NullSpecTest$Regression.class'
+    inputs.files("${rootDir}/tests/regression")
 }
 
 tasks.register('jspecifySamplesTest', Test) {
@@ -217,24 +298,28 @@ tasks.register('demoTest', Exec)  {
  See https://github.com/jspecify/jspecify-reference-checker/issues/81
  */
 
-def cfQualJar =
-        checkerFramework.projectDir.toPath()
-        .resolve("checker-qual/build/libs/checker-qual-${libs.versions.checkerFramework.get()}.jar")
-
-if (!cfQualJar.toFile().exists()) {
-    mkdir(cfQualJar.parent)
-    exec {
-        executable 'jar'
-        args = [
-            'cf',
-            cfQualJar,
-            buildFile.path // Use this build script file!
-        ]
+if (checkerFramework != null) {
+    def cfQualJar =
+            checkerFramework.projectDir.toPath()
+            .resolve("checker-qual/build/libs/checker-qual-${libs.versions.checkerFramework.get()}.jar")
+    def injected = project.objects.newInstance(InjectedExecOps)
+
+    if (!cfQualJar.toFile().exists()) {
+        mkdir(cfQualJar.parent)
+        injected.execOps.exec {
+            executable 'jar'
+            args = [
+                'cf',
+                cfQualJar,
+                buildFile.path // Use this build script file!
+            ]
+        }
     }
 }
 
 spotless {
     java {
+        target '**/*.java'
         googleJavaFormat()
         formatAnnotations()
     }
@@ -260,3 +345,47 @@ eclipse.classpath {
         }
     }
 }
+
+publishing {
+    publications {
+        jspecifyReferenceChecker(MavenPublication) {
+            pom {
+                groupId = 'org.jspecify.reference'
+                artifactId = 'checker'
+                version = project.version
+                name = 'JSpecify Reference Checker'
+                description = 'The JSpecify Reference Checker'
+                url = 'http://jspecify.org/'
+                from components.java
+                licenses {
+                    license {
+                        name = 'The Apache License, Version 2.0'
+                        url = 'http://www.apache.org/licenses/LICENSE-2.0.txt'
+                    }
+                }
+                scm {
+                    connection = 'scm:git:[email protected]:jspecify/jspecify-reference-checker.git'
+                    developerConnection = 'scm:git:[email protected]:jspecify/jspecify-reference-checker.git'
+                    url = 'https://github.com/jspecify/jspecify-reference-checker'
+                }
+                developers {
+                    developer {
+                        id = 'cpovirk'
+                        name = 'Chris Povirk'
+                        email = '[email protected]'
+                    }
+                    developer {
+                        id = 'netdpb'
+                        name = 'David P. Baker'
+                        email = '[email protected]'
+                    }
+                    developer {
+                        id = 'wmdietl'
+                        name = 'Werner M. Dietl'
+                        email = '[email protected]'
+                    }
+                }
+            }
+        }
+    }
+}

conformance-test-framework/build.gradle

@@ -2,8 +2,8 @@ plugins {
     id 'java-library'
 }
 
-group 'org.jspecify.conformance'
-version '0.0.0-SNAPSHOT'
+group = 'org.jspecify.conformance'
+version = '0.0.0-SNAPSHOT'
 
 repositories {
     mavenCentral()

demo

@@ -15,6 +15,20 @@ if [ ! -e "${jspecify}" ]; then
       -DoutputDirectory="$(dirname "${jspecify}")"
   fi
 fi
+
+checkerFrameworkDir="${dir}/../checker-framework/"
+checkerFrameworkJar="${checkerFrameworkDir}/checker/dist/checker.jar"
+if [ ! -e "${checkerFrameworkJar}" ]; then
+  cfVersion="3.42.0-eisop4"
+  checkerFrameworkJar="${dir}/build/checker-${cfVersion}-all.jar"
+  if [ ! -e "${checkerFrameworkJar}" ]; then
+    echo "Downloading $(basename "${checkerFrameworkJar}") from Maven central"
+    mvn -q org.apache.maven.plugins:maven-dependency-plugin:3.7.1:copy \
+      -Dartifact="io.github.eisop:checker:${cfVersion}:jar:all" \
+      -DoutputDirectory="$(dirname "${checkerFrameworkJar}")"
+  fi
+fi
+
 jspecify_reference_checker="${dir}/build/libs/jspecify-reference-checker-0.0.0-SNAPSHOT.jar"
 if [ ! -e "${jspecify_reference_checker}" ]; then
   echo "Assembling jspecify-reference-checker"
@@ -25,9 +39,11 @@ ourclasspath="${jspecify}:${jspecify_reference_checker}"
 
 export CLASSPATH="${ourclasspath}:$CLASSPATH"
 
-$dir/../checker-framework/checker/bin/javac \
+java -jar "${checkerFrameworkJar}" \
   -processorpath "${ourclasspath}" \
   -processor com.google.jspecify.nullness.NullSpecChecker \
+  -checkerQualJar "${checkerFrameworkJar}" \
+  -checkerUtilJar "${checkerFrameworkJar}" \
   -AcheckImpl \
   -AassumePure \
   -AsuppressWarnings=contracts.conditional.postcondition.false.methodref,contracts.conditional.postcondition.false.override,contracts.conditional.postcondition.true.methodref,contracts.conditional.postcondition.true.override,purity.methodref,purity.overriding,type.anno.before.decl.anno,type.anno.before.modifier \