Skip to content

Unconditionally add agent in Gradle plugin, add protobuf codegen test #630

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
keynmol merged 3 commits into from
Aug 8, 2023
Merged

Unconditionally add agent in Gradle plugin, add protobuf codegen test #630

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c7ee7d8
Add a protobuf generator testcase to gradle auto-indexing
keynmol Aug 8, 2023
3f91aad
Unconditionally add agent and deduplicate arguments if necessary
keynmol Aug 8, 2023
6bdfed3
Add a detailed comment for the workaround
keynmol Aug 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 46 additions & 38 deletions semanticdb-agent/src/main/java/com/sourcegraph/semanticdb_javac/SemanticdbAgent.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,20 @@ public class SemanticdbAgent {

public static void premain(String agentArgs, Instrumentation inst) {
// NOTE(olafur): Uncoment below if you want see all the loaded classes.
// PrintStream logger = newLogger();
// inst.addTransformer(
// new ClassFileTransformer() {
// @Override
// public byte[] transform(
// ClassLoader loader,
// String className,
// Class<?> classBeingRedefined,
// ProtectionDomain protectionDomain,
// byte[] classfileBuffer) {
// logger.println(className);
// return classfileBuffer;
// }
// });
// PrintStream logger = newLogger();
// inst.addTransformer(
// new ClassFileTransformer() {
// @Override
// public byte[] transform(
// ClassLoader loader,
// String className,
// Class<?> classBeingRedefined,
// ProtectionDomain protectionDomain,
// byte[] classfileBuffer) {
// logger.println(className);
// return classfileBuffer;
// }
// });
new AgentBuilder.Default()
.disableClassFormatChanges()
.type(
Expand Down Expand Up @@ -156,6 +156,7 @@ public static void build(
}

boolean isProcessorpathUpdated = false;
boolean semanticdbAlreadyAdded = false;
String previousOption = "";

ArrayList<String> newOptions = new ArrayList<>();
Expand All @@ -172,6 +173,10 @@ public static void build(
case "-Xlint":
break;
default:
if (option.startsWith("-Xplugin:semanticdb")) {
semanticdbAlreadyAdded = true;
break;
}
if (option.startsWith("-Xplugin:ErrorProne")) {
break;
}
Expand All @@ -180,33 +185,36 @@ public static void build(
}
previousOption = option;
}
if (!isProcessorpathUpdated) {
newOptions.add("-classpath");
newOptions.add(PLUGINPATH);
}
newOptions.add(
String.format(
"-Xplugin:semanticdb -sourceroot:%s -targetroot:%s", SOURCEROOT, TARGETROOT));

if (DEBUGPATH != null) {
ArrayList<String> debuglines = new ArrayList<>();
debuglines.add("============== Java Home: " + System.getProperty("java.home"));
debuglines.add("============== Old Options");
debuglines.addAll(arguments);
debuglines.add("============== New Options");
debuglines.addAll(newOptions);
if (!semanticdbAlreadyAdded) {

try {
Files.write(
Paths.get(DEBUGPATH),
debuglines,
StandardOpenOption.CREATE,
StandardOpenOption.APPEND);
} catch (IOException e) {
if (!isProcessorpathUpdated) {
newOptions.add("-classpath");
newOptions.add(PLUGINPATH);
}
}
newOptions.add(
String.format(
"-Xplugin:semanticdb -sourceroot:%s -targetroot:%s", SOURCEROOT, TARGETROOT));

if (DEBUGPATH != null) {
ArrayList<String> debuglines = new ArrayList<>();
debuglines.add("============== Java Home: " + System.getProperty("java.home"));
debuglines.add("============== Old Options");
debuglines.addAll(arguments);
debuglines.add("============== New Options");
debuglines.addAll(newOptions);

arguments = newOptions;
try {
Files.write(
Paths.get(DEBUGPATH),
debuglines,
StandardOpenOption.CREATE,
StandardOpenOption.APPEND);
} catch (IOException e) {
}
}

arguments = newOptions;
}
}
}
}
41 changes: 26 additions & 15 deletions semanticdb-gradle-plugin/src/main/scala/SemanticdbGradlePlugin.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ class SemanticdbGradlePlugin extends Plugin[Project] {
task.getOptions().setFork(true)
task.getOptions().setIncremental(false)

if (compilerPluginAdded)
if (compilerPluginAdded) {
task
.getOptions()
.getCompilerArgs()
Expand All @@ -169,21 +169,32 @@ class SemanticdbGradlePlugin extends Plugin[Project] {
s"-Xplugin:semanticdb -targetroot:$targetRoot -sourceroot:$sourceRoot"
).asJava
)
else
agentJar.foreach { agentpath =>
javacPluginJar.foreach { pluginpath =>
val jvmArgs = task.getOptions.getForkOptions.getJvmArgs

jvmArgs.addAll(
List(
s"-javaagent:$agentpath",
s"-Dsemanticdb.pluginpath=$pluginpath",
s"-Dsemanticdb.sourceroot=$sourceRoot",
s"-Dsemanticdb.targetroot=$targetRoot"
).asJava
)
}
}

/**
* In some yet to be understood cases we see that compiler plugin
* can be added successfully, but the correct flags are still not
* propagated.
*
* To work around it, we enable the agent unconditionally, and then
* if necessary deduplicate the arguments.
*
* TODO: figure out why this is necessary
*/
agentJar.foreach { agentpath =>
javacPluginJar.foreach { pluginpath =>
val jvmArgs = task.getOptions.getForkOptions.getJvmArgs

jvmArgs.addAll(
List(
s"-javaagent:$agentpath",
s"-Dsemanticdb.pluginpath=$pluginpath",
s"-Dsemanticdb.sourceroot=$sourceRoot",
s"-Dsemanticdb.targetroot=$targetRoot"
).asJava
)
}
}

}
}
Expand Down
38 changes: 38 additions & 0 deletions tests/buildTools/src/test/scala/tests/GradleBuildToolSuite.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,44 @@ abstract class GradleBuildToolSuite(allGradle: List[String])
)
}

checkGradleBuild(
"protobuf-generator",
"""|/build.gradle
|plugins {
| id "java"
| id "com.google.protobuf" version "0.9.4"
|}
|dependencies {
| implementation 'com.google.protobuf:protobuf-javalite:3.8.0'
|}
|protobuf {
| protoc {
| artifact = 'com.google.protobuf:protoc:3.23.4'
| }
| generateProtoTasks {
| all().configureEach { task ->
| task.builtins {
| java {
| option "lite"
| }
| }
| }
| }
|}
|/src/main/proto/message.proto
|syntax = "proto3";
|message SearchRequest {
| string query = 1;
| int32 page_number = 2;
| int32 results_per_page = 3;
|}
|/src/main/java/Example.java
|public class Example {}
|""".stripMargin,
expectedSemanticdbFiles = 2,
gradleVersions = List(Gradle8, Gradle7, Gradle67)
)

checkGradleBuild(
"explicit",
"""|/build.gradle
Expand Down