Inline scip-gradle-plugin BuildInfo and Logging helpers

Author: jupblb

build.sbt

@@ -99,19 +99,7 @@ lazy val gradlePlugin = project
       List(
         "dev.gradleplugins" % "gradle-api" % V.gradle % Provided,
         "dev.gradleplugins" % "gradle-test-kit" % V.gradle % Provided
-      ),
-    // The plugin's BuildInfo.version (the scip-javac Maven coordinate used as a
-    // fallback when no jar is provided) is read at runtime from this generated
-    // properties resource, mirroring the scip-java CLI's scip-java.properties.
-    (Compile / resourceGenerators) +=
-      Def.task {
-        val file = (Compile / resourceManaged).value / "scip-gradle.properties"
-        IO.createDirectory(file.getParentFile)
-        val props = new Properties()
-        props.put("version", version.value)
-        IO.write(props, "scip-gradle", file)
-        Seq(file)
-      }.taskValue
+      )
   )
 
 lazy val javacPlugin = project

scip-gradle-plugin/src/main/java/com/sourcegraph/gradle/scip/BuildInfo.java

@@ -15,6 +15,17 @@
 
 public class ScipGradlePlugin implements Plugin<Project> {
 
+  // `--add-exports` flags required so our compiler plugin can access javac
+  // internals. Required on JDK 17+ (JEP 403), no-op on 11-16. Kept in sync with
+  // `javacModuleOptions` in build.sbt.
+  private static final List<String> JAVAC_MODULE_OPTIONS =
+      List.of(
+          "-J--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED",
+          "-J--add-exports=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED",
+          "-J--add-exports=jdk.compiler/com.sun.tools.javac.model=ALL-UNNAMED",
+          "-J--add-exports=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED",
+          "-J--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED");
+
   @Override
   public void apply(Project project) {
     project.afterEvaluate(this::configureProject);
@@ -29,17 +40,6 @@ private void configureProject(Project project) {
 
     Object targetRoot = extraProperties.getOrDefault("scipTarget", project.getBuildDir());
 
-    String javacPluginVersion = BuildInfo.version;
-
-    Object javacPluginJar = extraProperties.get("javacPluginJar");
-
-    // We fall back to the javac plugin published to Maven if there is no jar
-    // specified. The JAR would usually be provided by the auto-indexer.
-    Object javacPluginDep =
-        javacPluginJar != null
-            ? project.files(javacPluginJar)
-            : "com.sourcegraph:scip-javac:" + javacPluginVersion;
-
     File sourceRoot = project.getRootDir();
 
     // List of compilation commands that we will need to trigger to index all
@@ -61,6 +61,16 @@ private void configureProject(Project project) {
 
       boolean compilerPluginAdded;
       try {
+        // The CLI's init script writes the absolute path of the embedded
+        // scip-javac jar into the `javacPluginJar` extra property.
+        Object javacPluginJar = extraProperties.get("javacPluginJar");
+        if (javacPluginJar == null) {
+          throw new IllegalStateException(
+              "javacPluginJar extra property must be set by the "
+                  + "scip-java init script when indexing Java sources");
+        }
+        Object javacPluginDep = project.files(javacPluginJar);
+
         project.getDependencies().add("compileOnly", javacPluginDep);
 
         if (hasAnnotationPath) {
@@ -76,14 +86,16 @@ private void configureProject(Project project) {
         // dependencies to it. The project will be skipped (no SCIP output) and
         // the post-build check in `GradleBuildTool` will surface a clearer
         // error.
-        Logging.warn(
-            "scip-java: failed to attach SCIP compiler plugin to project '"
-                + project.getName()
-                + "' ("
-                + exc.getClass().getSimpleName()
-                + ": "
-                + exc.getMessage()
-                + "). This subproject will not be indexed.");
+        project
+            .getLogger()
+            .warn(
+                "scip-java: failed to attach SCIP compiler plugin to project '"
+                    + project.getName()
+                    + "' ("
+                    + exc.getClass().getSimpleName()
+                    + ": "
+                    + exc.getMessage()
+                    + "). This subproject will not be indexed.");
         compilerPluginAdded = false;
       }
 
@@ -98,7 +110,7 @@ private void configureProject(Project project) {
                 // 11-16.
                 ForkOptions forkOptions = task.getOptions().getForkOptions();
                 List<String> jvmArgs =
-                    BuildInfo.javacModuleOptions.stream()
+                    JAVAC_MODULE_OPTIONS.stream()
                         .map(arg -> arg.startsWith("-J") ? arg.substring(2) : arg)
                         .collect(Collectors.toList());
                 if (forkOptions.getJvmArgs() == null) {

scip-gradle-plugin/src/main/java/com/sourcegraph/gradle/scip/Logging.java

@@ -87,29 +87,31 @@ public void printResolvedDependencies() throws IOException {
                   publication.getGroupId(),
                   publication.getArtifactId(),
                   publication.getVersion());
-          Logging.warn(
-              "Failed to extract `main` source set from publication `"
-                  + publicationName
-                  + "` in project `"
+          getLogger()
+              .warn(
+                  "Failed to extract `main` source set from publication `"
+                      + publicationName
+                      + "` in project `"
+                      + projectName
+                      + "`.\n"
+                      + CROSS_REPO_BANNER
+                      + "\nHere's the raw error message:\n  \""
+                      + exception.getMessage()
+                      + "\"\nContinuing without cross-repository support.");
+        }
+      }
+    } catch (Exception exception) {
+      getLogger()
+          .warn(
+              "Failed to extract Maven publication from the project `"
                   + projectName
                   + "`.\n"
                   + CROSS_REPO_BANNER
-                  + "\nHere's the raw error message:\n  \""
+                  + "\nHere's the raw error message ("
+                  + exception.getClass()
+                  + "):\n  \""
                   + exception.getMessage()
                   + "\"\nContinuing without cross-repository support.");
-        }
-      }
-    } catch (Exception exception) {
-      Logging.warn(
-          "Failed to extract Maven publication from the project `"
-              + projectName
-              + "`.\n"
-              + CROSS_REPO_BANNER
-              + "\nHere's the raw error message ("
-              + exception.getClass()
-              + "):\n  \""
-              + exception.getMessage()
-              + "\"\nContinuing without cross-repository support.");
     }
 
     project