adoroszlai commented on code in PR #10891: URL: https://github.com/apache/ozone/pull/10891#discussion_r3680401696
########## hadoop-hdds/annotations/src/main/java/org/apache/ozone/annotations/CliOptionStyleProcessor.java: ########## @@ -0,0 +1,175 @@ +/* + * 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 + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * 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 java.util.Arrays; +import java.util.HashSet; +import java.util.List; +import java.util.Map.Entry; +import java.util.Set; +import java.util.regex.Pattern; +import javax.annotation.processing.AbstractProcessor; +import javax.annotation.processing.RoundEnvironment; +import javax.annotation.processing.SupportedAnnotationTypes; +import javax.lang.model.SourceVersion; +import javax.lang.model.element.AnnotationMirror; +import javax.lang.model.element.AnnotationValue; +import javax.lang.model.element.Element; +import javax.lang.model.element.ExecutableElement; +import javax.lang.model.element.TypeElement; +import javax.lang.model.util.SimpleAnnotationValueVisitor8; +import javax.tools.Diagnostic; + +/** + * Validates that picocli options use the preferred Ozone CLI option style. + */ +@SupportedAnnotationTypes(CliOptionStyleProcessor.OPTION_ANNOTATION) +public class CliOptionStyleProcessor extends AbstractProcessor { + + static final String OPTION_ANNOTATION = "picocli.CommandLine.Option"; + private static final String NAMES_ATTRIBUTE = "names"; + private static final Pattern CAMEL_CASE = Pattern.compile("--.*[A-Z].*"); + private static final Pattern UNDER_SCORE = Pattern.compile("--.*_.*"); + + // Keep this in sync with DeprecatedCliOption in hdds-cli-common. This module + // cannot depend on CLI common, as CLI common runs this processor at compile + // time. + private static final Set<String> KNOWN_DEPRECATED_OPTIONS = Review Comment: We can remove `KNOWN_DEPRECATED_OPTIONS` and `isKnownDeprecatedOption`, since deprecated options are expected to be hidden, which is achieved by handling them programmatically, not in `@Option(names)` (see HDDS-15596). Removing this reveals that some explicit usage of known deprecated options was introduced on the `HDDS-8342-ttl-branch` feature branch, recently merged to `master`. We can remove these: ```diff --- hadoop-ozone/cli-admin/src/main/java/org/apache/hadoop/ozone/admin/om/LifecycleResumeSubCommand.java +++ hadoop-ozone/cli-admin/src/main/java/org/apache/hadoop/ozone/admin/om/LifecycleResumeSubCommand.java @@ -38,13 +38,13 @@ public class LifecycleResumeSubCommand implements Callable<Void> { private LifecycleSubCommand parent; @CommandLine.Option( - names = {"-id", "--service-id"}, + names = {"--service-id"}, description = "Ozone Manager Service ID" ) private String omServiceId; @CommandLine.Option( - names = {"-host", "--service-host"}, + names = {"--service-host"}, description = "Ozone Manager Host" ) private String omHost; ``` and also from: ``` hadoop-ozone/cli-admin/src/main/java/org/apache/hadoop/ozone/admin/om/LifecycleStatusSubCommand.java hadoop-ozone/cli-admin/src/main/java/org/apache/hadoop/ozone/admin/om/LifecycleSuspendSubCommand.java ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
