Skip to content
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

Validate recording build steps at extension build time #20630

Merged
merged 1 commit into from
Oct 8, 2021
Merged

Validate recording build steps at extension build time #20630

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions core/processor/src/main/java/io/quarkus/annotation/processor/Constants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ final public class Constants {

public static final String ANNOTATION_TEMPLATE = "io.quarkus.runtime.annotations.Template";
public static final String ANNOTATION_RECORDER = "io.quarkus.runtime.annotations.Recorder";
public static final String ANNOTATION_RECORD = "io.quarkus.deployment.annotations.Record";

public static final String MEMORY_SIZE_TYPE = "io.quarkus.runtime.configuration.MemorySize";
public static final String ANNOTATION_CONFIG_ITEM = "io.quarkus.runtime.annotations.ConfigItem";
Expand Down
38 changes: 38 additions & 0 deletions ...processor/src/main/java/io/quarkus/annotation/processor/ExtensionAnnotationProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
import javax.lang.model.SourceVersion;
import javax.lang.model.element.AnnotationMirror;
import javax.lang.model.element.Element;
import javax.lang.model.element.ElementKind;
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.element.Modifier;
import javax.lang.model.element.PackageElement;
Expand Down Expand Up @@ -304,6 +305,7 @@ private void processBuildStep(RoundEnvironment roundEnv, TypeElement annotation)

final String binaryName = processingEnv.getElementUtils().getBinaryName(clazz).toString();
if (processorClassNames.add(binaryName)) {
validateRecordBuildSteps(clazz);
recordConfigJavadoc(clazz);
generateAccessor(clazz);
final StringBuilder rbn = getRelativeBinaryName(clazz, new StringBuilder());
Expand All @@ -322,6 +324,42 @@ private void processBuildStep(RoundEnvironment roundEnv, TypeElement annotation)
}
}

private void validateRecordBuildSteps(TypeElement clazz) {
for (Element e : clazz.getEnclosedElements()) {
if (e.getKind() != ElementKind.METHOD) {
continue;
}
ExecutableElement ex = (ExecutableElement) e;
if (!isAnnotationPresent(ex, Constants.ANNOTATION_BUILD_STEP)) {
continue;
}
if (!isAnnotationPresent(ex, Constants.ANNOTATION_RECORD)) {
continue;
}

boolean hasRecorder = false;
boolean allTypesResolvable = true;
for (VariableElement parameter : ex.getParameters()) {
String parameterClassName = parameter.asType().toString();
TypeElement parameterTypeElement = processingEnv.getElementUtils().getTypeElement(parameterClassName);
if (parameterTypeElement == null) {
allTypesResolvable = false;
} else {
if (isAnnotationPresent(parameterTypeElement, Constants.ANNOTATION_RECORDER)) {
hasRecorder = true;
break;
}
}
}

if (!hasRecorder && allTypesResolvable) {
processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Build Step '" + clazz.getQualifiedName() + "#"
+ ex.getSimpleName()
+ "' which is annotated with '@Record' does not contain a method parameter whose type is annotated with '@Recorder'.");
}
}
}

private StringBuilder getRelativeBinaryName(TypeElement te, StringBuilder b) {
final Element enclosing = te.getEnclosingElement();
if (enclosing instanceof TypeElement) {
Expand Down