Repository navigation
consolidate InfoViewer and PropEditor #6458
+238
−21
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,214 @@ | ||
| /* | ||
| * 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 | ||
| * | ||
| * https://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.accumulo.server.conf.util; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| import org.apache.accumulo.core.cli.ServerOpts; | ||
| import org.apache.accumulo.server.conf.store.impl.ReadyMonitor; | ||
| import org.apache.accumulo.server.conf.util.ZooInfoViewer.ViewerOpts; | ||
| import org.apache.accumulo.server.conf.util.ZooPropEditor.EditorOpts; | ||
| import org.apache.accumulo.server.util.ServerKeywordExecutable; | ||
| import org.apache.accumulo.start.spi.CommandGroup; | ||
| import org.apache.accumulo.start.spi.CommandGroups; | ||
| import org.apache.accumulo.start.spi.KeywordExecutable; | ||
|
|
||
| import com.beust.jcommander.JCommander; | ||
| import com.beust.jcommander.Parameter; | ||
| import com.google.auto.service.AutoService; | ||
|
|
||
| @AutoService(KeywordExecutable.class) | ||
| public class ZooProps extends ServerKeywordExecutable<ZooProps.PropsOpts> { | ||
|
|
||
| public ZooProps() { | ||
| super(new PropsOpts()); | ||
| } | ||
|
|
||
| @Override | ||
| public String keyword() { | ||
| return "props"; | ||
| } | ||
|
|
||
| @Override | ||
| public String description() { | ||
| return "Inspect and edit ZooKeeper-backed Accumulo properties. " | ||
| + "Default prints properties for the resolved scope (ZooPropEditor output). " | ||
| + "Use --get for a multi-scope report with --system/--namespaces/--tables filters " | ||
| + "(ZooInfoViewer output). Use --set or --delete to mutate."; | ||
| } | ||
|
|
||
| @Override | ||
| public CommandGroup commandGroup() { | ||
| return CommandGroups.ZOOKEEPER; | ||
| } | ||
|
|
||
| @Override | ||
| public void execute(JCommander cl, PropsOpts opts) throws Exception { | ||
|
|
||
| if (!opts.setOpt.isEmpty() && !opts.deleteOpt.isEmpty()) { | ||
| throw new IllegalArgumentException("Cannot use --set and --delete together."); | ||
| } | ||
|
|
||
| if (!opts.setOpt.isEmpty()) { | ||
| ZooPropEditor editor = buildEditor(); | ||
| var context = getServerContext(); | ||
| EditorOpts editorOpts = toEditorOpts(opts); | ||
| editorOpts.setOpt = opts.setOpt; | ||
| editor.setProperty(context, editor.getPropKey(context, editorOpts), editorOpts); | ||
|
|
||
| } else if (!opts.deleteOpt.isEmpty()) { | ||
| ZooPropEditor editor = buildEditor(); | ||
| var context = getServerContext(); | ||
| var zrw = context.getZooSession().asReaderWriter(); | ||
| EditorOpts editorOpts = toEditorOpts(opts); | ||
| editorOpts.deleteOpt = opts.deleteOpt; | ||
| var propKey = editor.getPropKey(context, editorOpts); | ||
| editor.deleteProperty(context, propKey, editor.readPropNode(propKey, zrw), editorOpts); | ||
|
|
||
| } else if (opts.getOpt) { | ||
| ZooInfoViewer viewer = buildViewer(); | ||
| ViewerOpts viewerOpts = toViewerOpts(opts); | ||
| viewerOpts.printProps = true; | ||
|
|
||
| // TODO | ||
| // Add PR #6419 Json hook | ||
|
|
||
| viewer.generateReport(getServerContext(), viewerOpts); | ||
|
|
||
| } else { | ||
| ZooPropEditor editor = buildEditor(); | ||
| var context = getServerContext(); | ||
| var zrw = context.getZooSession().asReaderWriter(); | ||
| EditorOpts editorOpts = toEditorOpts(opts); | ||
| var propKey = editor.getPropKey(context, editorOpts); | ||
| editor.printProperties(context, propKey, editor.readPropNode(propKey, zrw)); | ||
|
|
||
| // TODO | ||
| // Add PR #6419 Json hook | ||
|
|
||
| } | ||
| } | ||
|
|
||
| private ZooPropEditor buildEditor() { | ||
| ZooPropEditor editor = new ZooPropEditor(); | ||
| editor.nullWatcher = new ZooPropEditor.NullWatcher( | ||
| new ReadyMonitor(ZooPropEditor.class.getSimpleName(), 20_000L)); | ||
| return editor; | ||
| } | ||
|
|
||
| private ZooInfoViewer buildViewer() { | ||
| ZooInfoViewer viewer = new ZooInfoViewer(); | ||
| viewer.nullWatcher = new ZooInfoViewer.NullWatcher( | ||
| new ReadyMonitor(ZooInfoViewer.class.getSimpleName(), 20_000L)); | ||
| return viewer; | ||
| } | ||
|
|
||
| private EditorOpts toEditorOpts(PropsOpts opts) { | ||
| EditorOpts e = new EditorOpts(); | ||
| e.tableOpt = opts.tableOpt; | ||
| e.tableIdOpt = opts.tableIdOpt; | ||
| e.namespaceOpt = opts.namespaceOpt; | ||
| e.namespaceIdOpt = opts.namespaceIdOpt; | ||
| e.resourceGroupOpt = opts.resourceGroupOpt.isEmpty() ? "" : opts.resourceGroupOpt.get(0); | ||
| return e; | ||
| } | ||
|
|
||
| private ViewerOpts toViewerOpts(PropsOpts opts) { | ||
| ViewerOpts v = new ViewerOpts(); | ||
| v.outfile = opts.outfile; | ||
| v.printSystemOpt = opts.systemOpt; | ||
| v.tablesOpt.addAll(opts.tablesOpt); | ||
| v.namespacesOpt.addAll(opts.namespacesOpt); | ||
|
Comment on lines
+137
to
+138
Member
There was a problem hiding this comment.
Contributor
Author
There was a problem hiding this comment. The singular
Member
There was a problem hiding this comment. If the split is intentional then I agree tht we should keep them. In that case, I think the |
||
| v.resourceGroupOpt.addAll(opts.resourceGroupOpt); | ||
| return v; | ||
| } | ||
|
|
||
| static class PropsOpts extends ServerOpts { | ||
| @Parameter(names = {"-s", "--set"}, description = "set a property") | ||
| String setOpt = ""; | ||
|
|
||
| @Parameter(names = {"-d", "--delete"}, description = "delete a property") | ||
| String deleteOpt = ""; | ||
|
|
||
| // --- Singular scope options, used with --set, --delete or default | ||
| @Parameter(names = {"-t", "--table"}, | ||
| description = "table to display for --set, --delete or default display" | ||
| + "Not valid with --get") | ||
| String tableOpt = ""; | ||
|
|
||
| @Parameter(names = {"-tid", "--table-id"}, | ||
| description = "table id to display for --set, --delete or default display") | ||
| String tableIdOpt = ""; | ||
|
|
||
| @Parameter(names = {"-ns", "--namespace"}, | ||
| description = "namespace to display for --set, --delete or default display") | ||
| String namespaceOpt = ""; | ||
|
|
||
| @Parameter(names = {"-nid", "--namespace-id"}, | ||
| description = "namespace id to display for --set, --delete or default display") | ||
| String namespaceIdOpt = ""; | ||
|
|
||
| @Parameter(names = {"-r", "--resource-group"}, | ||
| description = "resource group name to display for --set, --delete or default display", | ||
| variableArity = true) | ||
| List<String> resourceGroupOpt = new ArrayList<>(); | ||
|
|
||
| // --- Multi-scope options, used with --get | ||
|
|
||
| @Parameter(names = {"--get"}, | ||
| description = "print a multi-scope property report (ZooInfoViewer output). " | ||
| + "Enables --system, --namespaces, and --tables filter flags.") | ||
| boolean getOpt = false; | ||
|
|
||
| @Parameter(names = {"--system"}, | ||
| description = "print the properties for the system config. Only valid with --get") | ||
| boolean systemOpt = false; | ||
|
|
||
| @Parameter(names = {"--namespaces"}, | ||
| description = "a list of namespace names to print properties, with none specified, print all. Only valid with --get", | ||
| variableArity = true) | ||
| List<String> namespacesOpt = new ArrayList<>(); | ||
|
|
||
| @Parameter(names = {"--tables"}, | ||
| description = "a list of table names to print properties. Only valid with --get", | ||
| variableArity = true) | ||
| List<String> tablesOpt = new ArrayList<>(); | ||
|
|
||
| @Parameter(names = {"--outfile"}, | ||
| description = "Write the output to a file, if the file exists will not be overwritten.") | ||
| String outfile = ""; | ||
|
|
||
| @Override | ||
| public void parseArgs(String programName, String[] args, Object... others) { | ||
| super.parseArgs(programName, args, others); | ||
| boolean isMutating = !setOpt.isEmpty() || !deleteOpt.isEmpty(); | ||
| if (!namespacesOpt.isEmpty() || !tablesOpt.isEmpty()) { | ||
| if (isMutating) { | ||
| throw new IllegalArgumentException( | ||
| "--namespaces and --tables are not valid with --set or --delete"); | ||
| } | ||
|
|
||
| if (!getOpt) { | ||
| throw new IllegalArgumentException("--namespaces and --tables are only valid with --get"); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
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.
#6419 has been merged so these can be added now