[#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
@@ -756,6 +756,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,140 @@
+<!--
+  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 CLI
+
+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
+
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Commands](#commands)
+- [Running Tests](#running-tests)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Features
+
+- Retrieve server version
+- Provide help on usage
+- Manage Gravitino entities such as Metalakes, Catalogs, Schemas, and Tables
+- List details about Graviotino entities
+
+## Installation
+
+### Prerequisites
+
+Before you can build and run this project, it is suggested you have the following installed:
+
+- Java 11 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-0.7.0-incubating-SNAPSHOT.jar'
+    ```
+3. Test the command:
+    ```bash
+    gcli --help
+    ```
+
+## Usage
+
+To run the Gravitino CLI, use the following command structure:
+
+```bash
+usage: gcli <entity> <action> [options]
+Options
+ -c,--catalog <arg>    catalog name
+ -C,--create           create an entity
+ -D,--details          list details about an entity
+ -e,--entity <arg>     entity type
+ -f,--name <arg>       full entity name (dot separated)
+ -h,--help             command help information
+ -L,--list             list entity children
+ -m,--metalake <arg>   metalake name
+ -R,--delete           delete an entity
+ -s,--schema <arg>     schema name
+ -t,--table <arg>      table name
+ -u,--url <arg>        Gravitino URL (default: http://localhost:8090)
+ -U,--update           update an entity
+ -v,--version          Gravitino version
+ -x,--command <arg>    one of: list, details, create, delete, or update
+```
+
+## Commands
+The following commands are available for entity management:
+
+list: List available entities
+details: Show detailed information about an entity
+create: Create a new entity
+delete: Delete an existing entity
+update: Update an existing entity
+
+### Examples
+List All Metalakes
+
+```bash
+gcli list
+```
+
+Get Details of a Specific Metalake
+
+```bash
+gcli metalake details -name my-metalake
+```
+
+List Tables in a Catalog
+
+```bash
+gcli metalake list -name my-metalake.my-catalog
+```
+
+## 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/build.gradle.kts

@@ -0,0 +1,59 @@
+/*
+ * 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(project(":clients:client-java"))
+  implementation(project(":api"))
+  implementation(project(":common"))
+  implementation("commons-cli:commons-cli:1.9.0")
+  implementation("org.slf4j:slf4j-api:2.0.16")
+  implementation("org.slf4j:slf4j-simple:2.0.16")
+
+  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/errors.sh

@@ -0,0 +1,51 @@
+#!/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.
+#
+
+# Some of these examples assume you have the Apache Gravitino playground running.
+
+alias gcli='java -jar clients/cli/build/libs/gravitino-cli-0.7.0-incubating-SNAPSHOT.jar'
+
+# No such command
+gcli unknown
+
+# unknown command and entiry
+gcli unknown unknown
+
+# unknown command and entiry
+gcli unknown unknown
+
+# unknown command 
+gcli metalake unknown
+
+# unknown entity 
+gcli unknown list
+
+# Name not specified 
+gcli metalake details
+
+# Unknown metalake name
+gcli metalake details --name unknown
+
+# Unknown catalog name
+gcli catalog details --name metalake_demo.unknown
+
+# Unknown catalog name
+gcli catalog details --name metalake_demo

clients/cli/examples.sh

@@ -0,0 +1,111 @@
+#
+# 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.
+#
+
+#!/bin/bash
+
+# These examples assume you have the Apache Gravitino playground running.
+
+unset GRAVITINO_METALAKE
+alias gcli='java -jar clients/cli/build/libs/gravitino-cli-0.7.0-incubating-SNAPSHOT.jar'
+
+# display help
+gcli --help
+
+# display version
+gcli --version
+
+# metalake details
+gcli details
+
+# metalake list
+gcli list
+
+# metalake details (all these command are equivalent)
+gcli metalake details --name metalake_demo
+gcli metalake details --metalake metalake_demo
+gcli --command details --metalake metalake_demo
+gcli metalake --name metalake_demo details
+gcli details --name metalake_demo
+gcli details --metalake metalake_demo
+
+# list all catalogs in a metalake 
+gcli metalake list --name metalake_demo
+
+# list catalog schema
+gcli catalog list --name metalake_demo.catalog_iceberg
+gcli catalog list --name metalake_demo.catalog_mysql
+gcli catalog list --name metalake_demo.catalog_postgres
+gcli catalog list --name metalake_demo.catalog_hive
+
+# list catalog details
+gcli catalog details --name metalake_demo.catalog_iceberg
+gcli catalog details --name metalake_demo.catalog_mysql
+gcli catalog details --name metalake_demo.catalog_postgres
+gcli catalog details --name metalake_demo.catalog_hive
+
+# list schema tables
+gcli schema list --name metalake_demo.catalog_postgres.hr
+gcli schema list --name metalake_demo.catalog_mysql.db
+gcli schema list --name metalake_demo.catalog_hive.sales
+
+# list schema details
+gcli schema details --name metalake_demo.catalog_postgres.hr
+gcli schema details --name metalake_demo.catalog_mysql.db
+gcli schema details --name metalake_demo.catalog_hive.sales
+
+# list table details
+gcli table list --name metalake_demo.catalog_postgres.hr.departments
+gcli table list --name metalake_demo.catalog_mysql.db.iceberg_tables
+gcli table list --name metalake_demo.catalog_hive.sales.products
+
+# Exmaples where metalake is set in an evironment variable
+export GRAVITINO_METALAKE=metalake_demo
+
+# metalake details
+gcli metalake details
+
+# list all catalogs in a metalake 
+gcli metalake list
+
+# list catalog schema
+gcli catalog list --name catalog_iceberg
+gcli catalog list --name catalog_mysql
+gcli catalog list --name catalog_postgres
+gcli catalog list --name catalog_hive
+
+# list catalog details
+gcli catalog details --name catalog_iceberg
+gcli catalog details --name catalog_mysql
+gcli catalog details --name catalog_postgres
+gcli catalog details --name catalog_hive
+
+# list schema tables
+gcli schema list --name catalog_postgres.hr
+gcli schema list --name catalog_mysql.db
+gcli schema list --name catalog_hive.sales
+
+# list schema details
+gcli schema details --name catalog_postgres.hr
+gcli schema details --name catalog_mysql.db
+gcli schema details --name catalog_hive.sales
+
+# list table details
+gcli table list --name catalog_postgres.hr.departments
+gcli table list --name catalog_mysql.db.iceberg_tables
+gcli table list --name catalog_hive.sales.products