HDDS-11149. Have a generic version Validator for validating Requests #6932
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * <p> | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * <p> | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.apache.ozone.annotations; | ||
|
|
||
| import javax.annotation.processing.AbstractProcessor; | ||
| import javax.annotation.processing.RoundEnvironment; | ||
| import javax.annotation.processing.SupportedAnnotationTypes; | ||
| import javax.annotation.processing.SupportedSourceVersion; | ||
| import javax.lang.model.SourceVersion; | ||
| import javax.lang.model.element.Element; | ||
| import javax.lang.model.element.ElementKind; | ||
| import javax.lang.model.element.ExecutableElement; | ||
| import javax.lang.model.element.TypeElement; | ||
| import javax.lang.model.util.Elements; | ||
| import javax.lang.model.util.Types; | ||
| import javax.tools.Diagnostic; | ||
| import java.util.Set; | ||
|
|
||
| /** | ||
| * This class is an annotation processor that is hooked into the java compiler | ||
| * and is used to validate the RegisterValidator annotations in the | ||
| * codebase, to ensure that the annotated classes have the proper methods returning appropriate object types. | ||
| * | ||
| * The module is compiled in a different execution via Maven before anything | ||
| * else is compiled, and then javac picks this class up as an annotation | ||
| * processor from the classpath via a ServiceLoader, based on the | ||
| * META-INF/services/javax.annotation.processing.Processor file in the module's | ||
| * resources folder. | ||
| */ | ||
| @SupportedAnnotationTypes("org.apache.hadoop.ozone.om.request.validation.RegisterValidator") | ||
| @SupportedSourceVersion(SourceVersion.RELEASE_8) | ||
| public class RegisterValidatorProcessor extends AbstractProcessor { | ||
|
|
||
| public static final String ANNOTATION_SIMPLE_NAME = "RegisterValidator"; | ||
| public static final String VERSION_CLASS_NAME = "org.apache.hadoop.ozone.Version"; | ||
| public static final String REQUEST_PROCESSING_PHASE_CLASS_NAME = "org.apache.hadoop.ozone.om.request.validation" + | ||
| ".RequestProcessingPhase"; | ||
| public static final String MAX_VERSION_METHOD_NAME = "maxVersion"; | ||
| public static final String REQUEST_TYPE_METHOD_NAME = "requestType"; | ||
| public static final String PROCESSING_PHASE_METHOD_NAME = "processingPhase"; | ||
|
|
||
| public static final String MAX_VERSION_NOT_FOUND_ERROR_MESSAGE = "Method " + MAX_VERSION_METHOD_NAME + | ||
| " returning an enum implementing " + VERSION_CLASS_NAME + " not found"; | ||
| public static final String REQUEST_TYPE_NOT_FOUND_ERROR_MESSAGE = "Method " + REQUEST_TYPE_METHOD_NAME + | ||
| " returning an enum not found"; | ||
| public static final String PROCESSING_PHASE_NOT_FOUND_ERROR_MESSAGE = "Method " + PROCESSING_PHASE_METHOD_NAME | ||
| + " returning an enum implementing " + REQUEST_PROCESSING_PHASE_CLASS_NAME + " not found"; | ||
|
|
||
| @Override | ||
| public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) { | ||
| for (TypeElement annotation : annotations) { | ||
| if (!annotation.getSimpleName().contentEquals(ANNOTATION_SIMPLE_NAME)) { | ||
| continue; | ||
| } | ||
| processElements(roundEnv.getElementsAnnotatedWith(annotation)); | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| private boolean validateMethod(ExecutableElement method, String expectedMethodName, ElementKind expectedReturnType, | ||
| String expectedReturnClass) { | ||
| Elements elementUtils = processingEnv.getElementUtils(); | ||
| Types types = processingEnv.getTypeUtils(); | ||
| TypeElement expectedReturnInterface = expectedReturnClass == null || expectedReturnClass.equals("") ? null : | ||
| elementUtils.getTypeElement(expectedReturnClass); | ||
| return method.getSimpleName().toString().equals(expectedMethodName) && (expectedReturnType == null || | ||
| types.asElement(method.getReturnType()) != null && | ||
| types.asElement(method.getReturnType()).getKind() == expectedReturnType) && | ||
| (expectedReturnInterface == null || | ||
| types.isAssignable(types.asElement(method.getReturnType()).asType(), expectedReturnInterface.asType())); | ||
| } | ||
|
|
||
| private void processElements(Set<? extends Element> annotatedElements) { | ||
| for (Element element : annotatedElements) { | ||
| if (element.getKind().equals(ElementKind.ANNOTATION_TYPE)) { | ||
| boolean hasMaxVersion = false; | ||
| boolean hasRequestType = false; | ||
| boolean hasRequestProcessPhase = false; | ||
| for (Element enclosedElement : element.getEnclosedElements()) { | ||
| // Check if the annotation has a method called "validatorName" returning a String | ||
| if (enclosedElement instanceof ExecutableElement) { | ||
| ExecutableElement method = (ExecutableElement) enclosedElement; | ||
| hasMaxVersion = hasMaxVersion || validateMethod(method, MAX_VERSION_METHOD_NAME, ElementKind.ENUM, | ||
| VERSION_CLASS_NAME); | ||
| hasRequestType = hasRequestType || validateMethod(method, REQUEST_TYPE_METHOD_NAME, ElementKind.ENUM, | ||
| null); | ||
| hasRequestProcessPhase = hasRequestProcessPhase || validateMethod(method, PROCESSING_PHASE_METHOD_NAME, | ||
| ElementKind.ENUM, REQUEST_PROCESSING_PHASE_CLASS_NAME); | ||
| } | ||
| } | ||
| if (!hasMaxVersion) { | ||
|
There was a problem hiding this comment. I am wondering if it has any value to limit the number of elements in these annotations to exactly this 3 value, and check that there aren't any additional methods defined for it? There was a problem hiding this comment. I don't think we should put a restriction on any other method. Since the annotation could be used for some other purpose as well on a later basis. It doesn't make sense to just restrict the annotation definition to just have 3 methods and making it a minimum requirement is good enough. |
||
| emitErrorMsg(MAX_VERSION_NOT_FOUND_ERROR_MESSAGE + " for " + | ||
| element.getSimpleName().toString()); | ||
| } | ||
| if (!hasRequestType) { | ||
| emitErrorMsg(REQUEST_TYPE_NOT_FOUND_ERROR_MESSAGE + " for " + | ||
| element.getSimpleName().toString()); | ||
| } | ||
| if (!hasRequestProcessPhase) { | ||
| emitErrorMsg(PROCESSING_PHASE_NOT_FOUND_ERROR_MESSAGE + " for " + | ||
| element.getSimpleName().toString()); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
||
| private void emitErrorMsg(String s) { | ||
| processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, s); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * <p> | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * <p> | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.apache.hadoop.ozone; | ||
|
|
||
|
|
||
| /** | ||
| * Base class defining the version in the entire system. | ||
| */ | ||
| public interface Version { | ||
| int getVersion(); | ||
|
There was a problem hiding this comment. In order to conform all the method naming in the implementing interfaces/classes, can we call this method simply as version? There was a problem hiding this comment. sure makes sense |
||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems that you have added the methods to validate the max version, but those methods are not used anywhere in the processor itself, therefore if an invalid value is present (FUTURE_VERSION), the processor does not emit an error message in this case.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we want the annotation processor to validate all that? I would rather put this check someplace else. Probably in a place like https://github.com/swamirishi/ozone/blob/fc57929908cbb05a6304366e67f64317dbf9505d/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/request/validation/ValidatorRegistry.java#L85-L88 where instead of just a set of allowedVersionTypes. I would pass a Map of version class to the allowed values. What do you think of that?