This is an automated email from the ASF dual-hosted git repository.
jmclean pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/gravitino.git
The following commit(s) were added to refs/heads/main by this push:
new 08f47ad455 [#6139] Refactor metalake command in Gravitino CLI (#6140)
08f47ad455 is described below
commit 08f47ad4551913e7c05d2c5b08572cc342b78a5f
Author: Justin Mclean <[email protected]>
AuthorDate: Tue Jan 14 10:34:27 2025 +1100
[#6139] Refactor metalake command in Gravitino CLI (#6140)
### What changes were proposed in this pull request?
The Gravitino command line class is a little large and could be broken
up.
### Why are the changes needed?
For readability and maintainability.
Fix: #6139
### Does this PR introduce _any_ user-facing change?
None.
### How was this patch tested?
Tested locally.
---------
Co-authored-by: Shaofeng Shi <[email protected]>
---
.../apache/gravitino/cli/GravitinoCommandLine.java | 87 +--------
.../gravitino/cli/MetalakeCommandHandler.java | 201 +++++++++++++++++++++
2 files changed, 202 insertions(+), 86 deletions(-)
diff --git
a/clients/cli/src/main/java/org/apache/gravitino/cli/GravitinoCommandLine.java
b/clients/cli/src/main/java/org/apache/gravitino/cli/GravitinoCommandLine.java
index 21d3ed176c..cb8663ef37 100644
---
a/clients/cli/src/main/java/org/apache/gravitino/cli/GravitinoCommandLine.java
+++
b/clients/cli/src/main/java/org/apache/gravitino/cli/GravitinoCommandLine.java
@@ -137,7 +137,7 @@ public class GravitinoCommandLine extends
TestableCommandLine {
} else if (entity.equals(CommandEntities.CATALOG)) {
new CatalogCommandHandler(this, line, command, ignore).handle();
} else if (entity.equals(CommandEntities.METALAKE)) {
- handleMetalakeCommand();
+ new MetalakeCommandHandler(this, line, command, ignore).handle();
} else if (entity.equals(CommandEntities.TOPIC)) {
new TopicCommandHandler(this, line, command, ignore).handle();
} else if (entity.equals(CommandEntities.FILESET)) {
@@ -155,91 +155,6 @@ public class GravitinoCommandLine extends
TestableCommandLine {
}
}
- /**
- * Handles the command execution for Metalakes based on command type and the
command line options.
- */
- private void handleMetalakeCommand() {
- String url = getUrl();
- String auth = getAuth();
- String userName = line.getOptionValue(GravitinoOptions.LOGIN);
- FullName name = new FullName(line);
- String outputFormat = line.getOptionValue(GravitinoOptions.OUTPUT);
-
- Command.setAuthenticationMode(auth, userName);
-
- if (CommandActions.LIST.equals(command)) {
- newListMetalakes(url, ignore, outputFormat).validate().handle();
- return;
- }
-
- String metalake = name.getMetalakeName();
-
- switch (command) {
- case CommandActions.DETAILS:
- if (line.hasOption(GravitinoOptions.AUDIT)) {
- newMetalakeAudit(url, ignore, metalake).validate().handle();
- } else {
- newMetalakeDetails(url, ignore, outputFormat,
metalake).validate().handle();
- }
- break;
-
- case CommandActions.CREATE:
- String comment = line.getOptionValue(GravitinoOptions.COMMENT);
- newCreateMetalake(url, ignore, metalake, comment).validate().handle();
- break;
-
- case CommandActions.DELETE:
- boolean force = line.hasOption(GravitinoOptions.FORCE);
- newDeleteMetalake(url, ignore, force, metalake).validate().handle();
- break;
-
- case CommandActions.SET:
- String property = line.getOptionValue(GravitinoOptions.PROPERTY);
- String value = line.getOptionValue(GravitinoOptions.VALUE);
- newSetMetalakeProperty(url, ignore, metalake, property,
value).validate().handle();
- break;
-
- case CommandActions.REMOVE:
- property = line.getOptionValue(GravitinoOptions.PROPERTY);
- newRemoveMetalakeProperty(url, ignore, metalake,
property).validate().handle();
- break;
-
- case CommandActions.PROPERTIES:
- newListMetalakeProperties(url, ignore, metalake).validate().handle();
- break;
-
- case CommandActions.UPDATE:
- if (line.hasOption(GravitinoOptions.ENABLE) &&
line.hasOption(GravitinoOptions.DISABLE)) {
- System.err.println(ErrorMessages.INVALID_ENABLE_DISABLE);
- Main.exit(-1);
- }
- if (line.hasOption(GravitinoOptions.ENABLE)) {
- boolean enableAllCatalogs = line.hasOption(GravitinoOptions.ALL);
- newMetalakeEnable(url, ignore, metalake,
enableAllCatalogs).validate().handle();
- }
- if (line.hasOption(GravitinoOptions.DISABLE)) {
- newMetalakeDisable(url, ignore, metalake).validate().handle();
- }
-
- if (line.hasOption(GravitinoOptions.COMMENT)) {
- comment = line.getOptionValue(GravitinoOptions.COMMENT);
- newUpdateMetalakeComment(url, ignore, metalake,
comment).validate().handle();
- }
- if (line.hasOption(GravitinoOptions.RENAME)) {
- String newName = line.getOptionValue(GravitinoOptions.RENAME);
- force = line.hasOption(GravitinoOptions.FORCE);
- newUpdateMetalakeName(url, ignore, force, metalake,
newName).validate().handle();
- }
-
- break;
-
- default:
- System.err.println(ErrorMessages.UNSUPPORTED_COMMAND);
- Main.exit(-1);
- break;
- }
- }
-
/** Handles the command execution for Tags based on command type and the
command line options. */
protected void handleTagCommand() {
String url = getUrl();
diff --git
a/clients/cli/src/main/java/org/apache/gravitino/cli/MetalakeCommandHandler.java
b/clients/cli/src/main/java/org/apache/gravitino/cli/MetalakeCommandHandler.java
new file mode 100644
index 0000000000..993116f19f
--- /dev/null
+++
b/clients/cli/src/main/java/org/apache/gravitino/cli/MetalakeCommandHandler.java
@@ -0,0 +1,201 @@
+/*
+ * 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.gravitino.cli;
+
+import org.apache.commons.cli.CommandLine;
+import org.apache.gravitino.cli.commands.Command;
+
+/**
+ * Handles the command execution for Metalakes based on command type and the
command line options.
+ */
+public class MetalakeCommandHandler extends CommandHandler {
+
+ private final GravitinoCommandLine gravitinoCommandLine;
+ private final CommandLine line;
+ private final String command;
+ private final boolean ignore;
+ private final String url;
+ private String metalake;
+
+ /**
+ * Constructs a MetalakeCommandHandler instance.
+ *
+ * @param gravitinoCommandLine The Gravitino command line instance.
+ * @param line The command line arguments.
+ * @param command The command to execute.
+ * @param ignore Ignore server version mismatch.
+ */
+ public MetalakeCommandHandler(
+ GravitinoCommandLine gravitinoCommandLine, CommandLine line, String
command, boolean ignore) {
+ this.gravitinoCommandLine = gravitinoCommandLine;
+ this.line = line;
+ this.command = command;
+ this.ignore = ignore;
+ this.url = getUrl(line);
+ }
+
+ /** Handles the command execution logic based on the provided command. */
+ public void handle() {
+ String userName = line.getOptionValue(GravitinoOptions.LOGIN);
+ FullName name = new FullName(line);
+ Command.setAuthenticationMode(getAuth(line), userName);
+
+ if (CommandActions.LIST.equals(command)) {
+ handleListCommand();
+ return;
+ }
+
+ metalake = name.getMetalakeName();
+
+ if (!executeCommand()) {
+ System.err.println(ErrorMessages.UNSUPPORTED_COMMAND);
+ Main.exit(-1);
+ }
+ }
+
+ /**
+ * Executes the specific command based on the command type.
+ *
+ * @return true if the command is supported, false otherwise
+ */
+ private boolean executeCommand() {
+ switch (command) {
+ case CommandActions.DETAILS:
+ handleDetailsCommand();
+ return true;
+
+ case CommandActions.CREATE:
+ handleCreateCommand();
+ return true;
+
+ case CommandActions.DELETE:
+ handleDeleteCommand();
+ return true;
+
+ case CommandActions.SET:
+ handleSetCommand();
+ return true;
+
+ case CommandActions.REMOVE:
+ handleRemoveCommand();
+ return true;
+
+ case CommandActions.PROPERTIES:
+ handlePropertiesCommand();
+ return true;
+
+ case CommandActions.UPDATE:
+ handleUpdateCommand();
+ return true;
+
+ default:
+ return false;
+ }
+ }
+
+ /** Handles the "LIST" command. */
+ private void handleListCommand() {
+ String outputFormat = line.getOptionValue(GravitinoOptions.OUTPUT);
+ gravitinoCommandLine.newListMetalakes(url, ignore,
outputFormat).validate().handle();
+ }
+
+ /** Handles the "DETAILS" command. */
+ private void handleDetailsCommand() {
+ if (line.hasOption(GravitinoOptions.AUDIT)) {
+ gravitinoCommandLine.newMetalakeAudit(url, ignore,
metalake).validate().handle();
+ } else {
+ String outputFormat = line.getOptionValue(GravitinoOptions.OUTPUT);
+ gravitinoCommandLine
+ .newMetalakeDetails(url, ignore, outputFormat, metalake)
+ .validate()
+ .handle();
+ }
+ }
+
+ /** Handles the "CREATE" command. */
+ private void handleCreateCommand() {
+ String comment = line.getOptionValue(GravitinoOptions.COMMENT);
+ gravitinoCommandLine.newCreateMetalake(url, ignore, metalake,
comment).validate().handle();
+ }
+
+ /** Handles the "DELETE" command. */
+ private void handleDeleteCommand() {
+ boolean force = line.hasOption(GravitinoOptions.FORCE);
+ gravitinoCommandLine.newDeleteMetalake(url, ignore, force,
metalake).validate().handle();
+ }
+
+ /** Handles the "SET" command. */
+ private void handleSetCommand() {
+ String property = line.getOptionValue(GravitinoOptions.PROPERTY);
+ String value = line.getOptionValue(GravitinoOptions.VALUE);
+ gravitinoCommandLine
+ .newSetMetalakeProperty(url, ignore, metalake, property, value)
+ .validate()
+ .handle();
+ }
+
+ /** Handles the "REMOVE" command. */
+ private void handleRemoveCommand() {
+ String property = line.getOptionValue(GravitinoOptions.PROPERTY);
+ gravitinoCommandLine
+ .newRemoveMetalakeProperty(url, ignore, metalake, property)
+ .validate()
+ .handle();
+ }
+
+ /** Handles the "PROPERTIES" command. */
+ private void handlePropertiesCommand() {
+ gravitinoCommandLine.newListMetalakeProperties(url, ignore,
metalake).validate().handle();
+ }
+
+ /** Handles the "UPDATE" command. */
+ private void handleUpdateCommand() {
+ if (line.hasOption(GravitinoOptions.ENABLE) &&
line.hasOption(GravitinoOptions.DISABLE)) {
+ System.err.println(ErrorMessages.INVALID_ENABLE_DISABLE);
+ Main.exit(-1);
+ }
+ if (line.hasOption(GravitinoOptions.ENABLE)) {
+ boolean enableAllCatalogs = line.hasOption(GravitinoOptions.ALL);
+ gravitinoCommandLine
+ .newMetalakeEnable(url, ignore, metalake, enableAllCatalogs)
+ .validate()
+ .handle();
+ }
+ if (line.hasOption(GravitinoOptions.DISABLE)) {
+ gravitinoCommandLine.newMetalakeDisable(url, ignore,
metalake).validate().handle();
+ }
+
+ if (line.hasOption(GravitinoOptions.COMMENT)) {
+ String comment = line.getOptionValue(GravitinoOptions.COMMENT);
+ gravitinoCommandLine
+ .newUpdateMetalakeComment(url, ignore, metalake, comment)
+ .validate()
+ .handle();
+ }
+ if (line.hasOption(GravitinoOptions.RENAME)) {
+ String newName = line.getOptionValue(GravitinoOptions.RENAME);
+ boolean force = line.hasOption(GravitinoOptions.FORCE);
+ gravitinoCommandLine
+ .newUpdateMetalakeName(url, ignore, force, metalake, newName)
+ .validate()
+ .handle();
+ }
+ }
+}
