[#5057] Added first part of CLI code

build.gradle.kts

@@ -349,7 +349,7 @@ subprojects {
     options.locale = "en_US"
 
     val projectName = project.name
-    if (projectName == "common" || projectName == "api" || projectName == "client-java" || projectName == "filesystem-hadoop3") {
+    if (projectName == "common" || projectName == "api" || projectName == "client-java" || projectName == "client-cli" || projectName == "filesystem-hadoop3") {
       options {
         (this as CoreJavadocOptions).addStringOption("Xwerror", "-quiet")
         isFailOnError = true
@@ -757,6 +757,7 @@ tasks {
     subprojects.forEach() {
       if (!it.name.startsWith("catalog") &&
         !it.name.startsWith("client") &&
+        !it.name.startsWith("cli") &&
         !it.name.startsWith("authorization") &&
         !it.name.startsWith("filesystem") &&
         !it.name.startsWith("spark") &&

clients/cli/README.md

@@ -0,0 +1,78 @@
+<!--
+  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.
+-->
+
+# Apache Gravitino Command Line Interface
+
+Apache Gravitino CLI is a command-line tool that interacts with the Gravitino server to manage and query entities like metalakes, catalogs, schemas, and tables. The tool provides options for listing information about Gravitino entities and in future versions support creating, deleting, and updating these entities.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Running Tests](#running-tests)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+### Prerequisites
+
+Before you can build and run this project, it is suggested you have the following installed:
+
+- Java 8 or higher
+
+### Build the Project
+
+1. Clone the entire Gravitino repository:
+
+    ```bash
+    git clone https://github.com/apache/gravitino
+    ```
+
+2. Build the CLI sub-project using Gradle:
+
+    ```bash
+    ./gradlew :clients:cli:build
+    ```
+3. Create an alias:
+
+    ```bash
+    alias gcli='java -jar clients/cli/build/libs/gravitino-cli-*-incubating-SNAPSHOT.jar'
+    ```
+3. Test the command:
+    ```bash
+    gcli --help
+    ```
+
+## Running Tests
+
+This project includes a suite of unit tests to verify its functionality.
+
+To run the tests, execute the following command:
+
+```bash
+./gradlew :clients:cli:test
+```
+
+## Contributing
+
+We welcome contributions to the Gravitino CLI!
+
+## License
+
+This project is licensed under the Apache License 2.0.

clients/cli/bin/gcli.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+#
+# 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.
+#
+
+java -jar ../../cli/build/libs/gravitino-cli-*-incubating-SNAPSHOT.jar "$@"

clients/cli/build.gradle.kts

@@ -0,0 +1,60 @@
+/*
+ * 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.
+ */
+plugins {
+  `maven-publish`
+  id("java")
+  id("idea")
+}
+
+dependencies {
+  implementation(libs.commons.cli.new)
+  implementation(libs.guava)
+  implementation(libs.slf4j.api)
+  implementation(libs.slf4j.simple)
+  implementation(project(":api"))
+  implementation(project(":clients:client-java"))
+  implementation(project(":common"))
+
+  testImplementation(libs.junit.jupiter.api)
+  testImplementation(libs.junit.jupiter.params)
+  testImplementation(libs.mockito.core)
+
+  testRuntimeOnly(libs.junit.jupiter.engine)
+}
+
+tasks.build {
+  dependsOn("javadoc")
+}
+
+tasks.clean {
+  delete("target")
+  delete("tmp")
+}
+
+tasks.jar {
+  manifest {
+    attributes["Main-Class"] = "org.apache.gravitino.cli.Main"
+  }
+  val dependencies = configurations
+    .runtimeClasspath
+    .get()
+    .map(::zipTree)
+  from(dependencies)
+  duplicatesStrategy = DuplicatesStrategy.EXCLUDE
+}

clients/cli/src/main/java/org/apache/gravitino/cli/CommandActions.java

@@ -0,0 +1,54 @@
+/*
+ * 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 java.util.HashSet;
+
+/**
+ * The {@code CommandActions} class defines a set of standard commands that can be used in the
+ * Gravitino CLI. It also can validate if a given command is a valid commands.
+ */
+public class CommandActions {
+  public static final String DETAILS = "details";
+  public static final String LIST = "list";
+  public static final String UPDATE = "update";
+  public static final String CREATE = "create";
+  public static final String DELETE = "delete";
+
+  private static final HashSet<String> VALID_COMMANDS = new HashSet<>();
+
+  static {
+    VALID_COMMANDS.add(DETAILS);
+    VALID_COMMANDS.add(LIST);
+    VALID_COMMANDS.add(UPDATE);
+    VALID_COMMANDS.add(CREATE);
+    VALID_COMMANDS.add(DELETE);
+  }
+
+  /**
+   * Checks if a given command is a valid command type.
+   *
+   * @param command The command to check.
+   * @return true if the command is valid, false otherwise.
+   */
+  public static boolean isValidCommand(String command) {
+    return VALID_COMMANDS.contains(command);
+  }
+}

clients/cli/src/main/java/org/apache/gravitino/cli/CommandEntities.java

@@ -0,0 +1,54 @@
+/*
+ * 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 java.util.HashSet;
+
+/**
+ * The {@code CommandEntities} class defines a set of standard entities that can be used in the
+ * Gravitino CLI. It also can validate if a given entity is a valid entity.
+ */
+public class CommandEntities {
+  public static final String METALAKE = "metalake";
+  public static final String CATALOG = "catalog";
+  public static final String SCHEMA = "schema";
+  public static final String TABLE = "table";
+  public static final String COLUMN = "column";
+
+  private static final HashSet<String> VALID_ENTITIES = new HashSet<>();
+
+  static {
+    VALID_ENTITIES.add(METALAKE);
+    VALID_ENTITIES.add(CATALOG);
+    VALID_ENTITIES.add(SCHEMA);
+    VALID_ENTITIES.add(TABLE);
+    VALID_ENTITIES.add(COLUMN);
+  }
+
+  /**
+   * Checks if a given command is a valid entity.
+   *
+   * @param entity The entity to check.
+   * @return true if the command is valid, false otherwise.
+   */
+  public static boolean isValidEntity(String entity) {
+    return VALID_ENTITIES.contains(entity);
+  }
+}

clients/cli/src/main/java/org/apache/gravitino/cli/ErrorMessages.java

@@ -0,0 +1,32 @@
+/*
+ * 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;
+
+/* User friendly error messages. */
+public class ErrorMessages {
+  public static final String UNSUPPORTED_COMMAND = "Unsupported or unknown command.";
+  public static final String UNKNOWN_ENTITY = "Unknown entity.";
+  public static final String UNKNOWN_METALAKE = "Unknown metalake name.";
+  public static final String UNKNOWN_CATALOG = "Unknown catalog name.";
+  public static final String UNKNOWN_SCHEMA = "Unknown schema name.";
+  public static final String UNKNOWN_TABLE = "Unknown table name.";
+  public static final String MALFORMED_NAME = "Malformed entity name.";
+  public static final String MISSING_NAME = "Missing name.";
+}