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 0b9d89bba [#6150] improve(CLI): Refactor user commands in Gavitino CLI
(#6193)
0b9d89bba is described below
commit 0b9d89bba96527037f4bbf76c6fc9f814d5e3660
Author: SekiXu <[email protected]>
AuthorDate: Mon Jan 13 06:55:42 2025 +0800
[#6150] improve(CLI): Refactor user commands in Gavitino CLI (#6193)
### What changes were proposed in this pull request?
Refactor user commands and Base class in Gavitino CLI.
### Why are the changes needed?
Fix: #6150
### Does this PR introduce any user-facing change?
No
### How was this patch tested?
local test.
---
.../apache/gravitino/cli/GravitinoCommandLine.java | 63 +-------
.../apache/gravitino/cli/UserCommandHandler.java | 174 +++++++++++++++++++++
2 files changed, 175 insertions(+), 62 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 b883502e8..21d3ed176 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
@@ -143,7 +143,7 @@ public class GravitinoCommandLine extends
TestableCommandLine {
} else if (entity.equals(CommandEntities.FILESET)) {
handleFilesetCommand();
} else if (entity.equals(CommandEntities.USER)) {
- handleUserCommand();
+ new UserCommandHandler(this, line, command, ignore).handle();
} else if (entity.equals(CommandEntities.GROUP)) {
new GroupCommandHandler(this, line, command, ignore).handle();
} else if (entity.equals(CommandEntities.TAG)) {
@@ -240,67 +240,6 @@ public class GravitinoCommandLine extends
TestableCommandLine {
}
}
- /** Handles the command execution for Users based on command type and the
command line options. */
- protected void handleUserCommand() {
- String url = getUrl();
- String auth = getAuth();
- String userName = line.getOptionValue(GravitinoOptions.LOGIN);
- FullName name = new FullName(line);
- String metalake = name.getMetalakeName();
- String user = line.getOptionValue(GravitinoOptions.USER);
-
- Command.setAuthenticationMode(auth, userName);
-
- if (user == null && !CommandActions.LIST.equals(command)) {
- System.err.println(ErrorMessages.MISSING_USER);
- Main.exit(-1);
- }
-
- switch (command) {
- case CommandActions.DETAILS:
- if (line.hasOption(GravitinoOptions.AUDIT)) {
- newUserAudit(url, ignore, metalake, user).validate().handle();
- } else {
- newUserDetails(url, ignore, metalake, user).validate().handle();
- }
- break;
-
- case CommandActions.LIST:
- newListUsers(url, ignore, metalake).validate().handle();
- break;
-
- case CommandActions.CREATE:
- newCreateUser(url, ignore, metalake, user).validate().handle();
- break;
-
- case CommandActions.DELETE:
- boolean force = line.hasOption(GravitinoOptions.FORCE);
- newDeleteUser(url, ignore, force, metalake, user).validate().handle();
- break;
-
- case CommandActions.REVOKE:
- String[] revokeRoles = line.getOptionValues(GravitinoOptions.ROLE);
- for (String role : revokeRoles) {
- newRemoveRoleFromUser(url, ignore, metalake, user,
role).validate().handle();
- }
- System.out.printf("Remove roles %s from user %s%n",
COMMA_JOINER.join(revokeRoles), user);
- break;
-
- case CommandActions.GRANT:
- String[] grantRoles = line.getOptionValues(GravitinoOptions.ROLE);
- for (String role : grantRoles) {
- newAddRoleToUser(url, ignore, metalake, user,
role).validate().handle();
- }
- System.out.printf("Grant roles %s to user %s%n",
COMMA_JOINER.join(grantRoles), user);
- 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/UserCommandHandler.java
b/clients/cli/src/main/java/org/apache/gravitino/cli/UserCommandHandler.java
new file mode 100644
index 000000000..9a8374ec3
--- /dev/null
+++ b/clients/cli/src/main/java/org/apache/gravitino/cli/UserCommandHandler.java
@@ -0,0 +1,174 @@
+/*
+ * 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 Users based on command type and the
command line options. */
+public class UserCommandHandler extends CommandHandler {
+ private final GravitinoCommandLine gravitinoCommandLine;
+ private final CommandLine line;
+ private final String command;
+ private final boolean ignore;
+ private final String url;
+ private final FullName name;
+ private final String metalake;
+ private String user;
+
+ /**
+ * Constructs a {@link UserCommandHandler} 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 UserCommandHandler(
+ GravitinoCommandLine gravitinoCommandLine, CommandLine line, String
command, boolean ignore) {
+ this.gravitinoCommandLine = gravitinoCommandLine;
+ this.line = line;
+ this.command = command;
+ this.ignore = ignore;
+
+ this.url = getUrl(line);
+ this.name = new FullName(line);
+ this.metalake = name.getMetalakeName();
+ }
+
+ /** Handles the command execution logic based on the provided command. */
+ @Override
+ protected void handle() {
+ String userName = line.getOptionValue(GravitinoOptions.LOGIN);
+ Command.setAuthenticationMode(getAuth(line), userName);
+
+ user = line.getOptionValue(GravitinoOptions.USER);
+
+ if (user == null && !CommandActions.LIST.equals(command)) {
+ System.err.println(ErrorMessages.MISSING_USER);
+ Main.exit(-1);
+ }
+
+ 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.LIST:
+ handleListCommand();
+ return true;
+
+ case CommandActions.CREATE:
+ handleCreateCommand();
+ return true;
+
+ case CommandActions.DELETE:
+ handleDeleteCommand();
+ return true;
+
+ case CommandActions.REVOKE:
+ handleRevokeCommand();
+ return true;
+
+ case CommandActions.GRANT:
+ handleGrantCommand();
+ return true;
+
+ default:
+ return false;
+ }
+ }
+
+ /** Handles the "LIST" command. */
+ private void handleListCommand() {
+ this.gravitinoCommandLine
+ .newListUsers(this.url, this.ignore, this.metalake)
+ .validate()
+ .handle();
+ }
+
+ /** Handles the "DETAILS" command. */
+ private void handleDetailsCommand() {
+ if (line.hasOption(GravitinoOptions.AUDIT)) {
+ this.gravitinoCommandLine
+ .newUserAudit(this.url, this.ignore, this.metalake, user)
+ .validate()
+ .handle();
+ } else {
+ this.gravitinoCommandLine
+ .newUserDetails(this.url, this.ignore, this.metalake, user)
+ .validate()
+ .handle();
+ }
+ }
+
+ /** Handles the "CREATE" command. */
+ private void handleCreateCommand() {
+ this.gravitinoCommandLine
+ .newCreateUser(this.url, this.ignore, this.metalake, user)
+ .validate()
+ .handle();
+ }
+
+ /** Handles the "DELETE" command. */
+ private void handleDeleteCommand() {
+ boolean force = line.hasOption(GravitinoOptions.FORCE);
+ this.gravitinoCommandLine
+ .newDeleteUser(this.url, this.ignore, force, this.metalake, user)
+ .validate()
+ .handle();
+ }
+
+ /** Handles the "REVOKE" command. */
+ private void handleRevokeCommand() {
+ String[] revokeRoles = line.getOptionValues(GravitinoOptions.ROLE);
+ for (String role : revokeRoles) {
+ this.gravitinoCommandLine
+ .newRemoveRoleFromUser(this.url, this.ignore, this.metalake, user,
role)
+ .validate()
+ .handle();
+ }
+ System.out.printf("Remove roles %s from user %s%n",
COMMA_JOINER.join(revokeRoles), user);
+ }
+
+ /** Handles the "GRANT" command. */
+ private void handleGrantCommand() {
+ String[] grantRoles = line.getOptionValues(GravitinoOptions.ROLE);
+ for (String role : grantRoles) {
+ this.gravitinoCommandLine
+ .newAddRoleToUser(this.url, this.ignore, this.metalake, user, role)
+ .validate()
+ .handle();
+ }
+ System.out.printf("Add roles %s to user %s%n",
COMMA_JOINER.join(grantRoles), user);
+ }
+}