-
Notifications
You must be signed in to change notification settings - Fork 511
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
HDDS-11878. Use CommandSpec to find top-level command. (#7575)
- Loading branch information
1 parent
f34cf34
commit f125363
Showing
22 changed files
with
149 additions
and
177 deletions.
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
44 changes: 44 additions & 0 deletions
44
hadoop-hdds/tools/src/main/java/org/apache/hadoop/hdds/cli/AbstractMixin.java
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,44 @@ | ||
| /* | ||
| * 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.hadoop.hdds.cli; | ||
|
|
||
| import org.apache.hadoop.hdds.conf.OzoneConfiguration; | ||
| import picocli.CommandLine; | ||
|
|
||
| import static picocli.CommandLine.Spec.Target.MIXEE; | ||
|
|
||
| /** Base functionality for all Ozone CLI mixins. */ | ||
| @CommandLine.Command | ||
| public abstract class AbstractMixin { | ||
|
|
||
| @CommandLine.Spec(MIXEE) | ||
| private CommandLine.Model.CommandSpec spec; | ||
|
|
||
| protected CommandLine.Model.CommandSpec spec() { | ||
| return spec; | ||
| } | ||
|
|
||
| protected GenericParentCommand rootCommand() { | ||
| return AbstractSubcommand.findRootCommand(spec); | ||
| } | ||
|
|
||
| protected OzoneConfiguration getOzoneConf() { | ||
| return rootCommand().getOzoneConf(); | ||
| } | ||
|
|
||
| } |
80 changes: 80 additions & 0 deletions
80
hadoop-hdds/tools/src/main/java/org/apache/hadoop/hdds/cli/AbstractSubcommand.java
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,80 @@ | ||
| /* | ||
| * 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.hadoop.hdds.cli; | ||
|
|
||
| import org.apache.hadoop.hdds.conf.OzoneConfiguration; | ||
| import org.apache.ratis.util.MemoizedSupplier; | ||
| import picocli.CommandLine; | ||
|
|
||
| import java.util.function.Supplier; | ||
|
|
||
| /** Base functionality for all Ozone subcommands. */ | ||
| @CommandLine.Command( | ||
| mixinStandardHelpOptions = true, | ||
| versionProvider = HddsVersionProvider.class | ||
| ) | ||
| public abstract class AbstractSubcommand { | ||
|
|
||
| @CommandLine.Spec | ||
| private CommandLine.Model.CommandSpec spec; | ||
|
|
||
| private final Supplier<GenericParentCommand> rootSupplier = | ||
| MemoizedSupplier.valueOf(() -> findRootCommand(spec)); | ||
|
|
||
| protected CommandLine.Model.CommandSpec spec() { | ||
| return spec; | ||
| } | ||
|
|
||
| /** Get the Ozone object annotated with {@link CommandLine.Command}) that was used to run this command. | ||
| * Usually this is some subclass of {@link GenericCli}, but in unit tests it could be any subcommand. */ | ||
| protected GenericParentCommand rootCommand() { | ||
| return rootSupplier.get(); | ||
| } | ||
|
|
||
| protected boolean isVerbose() { | ||
| return rootCommand().isVerbose(); | ||
| } | ||
|
|
||
| /** @see GenericParentCommand#getOzoneConf() */ | ||
| protected OzoneConfiguration getOzoneConf() { | ||
| return rootCommand().getOzoneConf(); | ||
| } | ||
|
|
||
| static GenericParentCommand findRootCommand(CommandLine.Model.CommandSpec spec) { | ||
| Object root = spec.root().userObject(); | ||
| return root instanceof GenericParentCommand | ||
| ? (GenericParentCommand) root | ||
| : new NoParentCommand(); | ||
| } | ||
|
|
||
| /** No-op implementation for unit tests, which may bypass creation of GenericCli object. */ | ||
| private static class NoParentCommand implements GenericParentCommand { | ||
|
|
||
| private final OzoneConfiguration conf = new OzoneConfiguration(); | ||
|
|
||
| @Override | ||
| public boolean isVerbose() { | ||
| return false; | ||
| } | ||
|
|
||
| @Override | ||
| public OzoneConfiguration getOzoneConf() { | ||
| return conf; | ||
| } | ||
| } | ||
| } |
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
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 |
|---|---|---|
|
|
@@ -84,9 +84,4 @@ public Void call() throws Exception { | |
| } | ||
| return null; | ||
| } | ||
|
|
||
| protected QuotaRepair getParent() { | ||
| return parent; | ||
| } | ||
|
|
||
| } | ||
Oops, something went wrong.