Skip to content

Commit

Permalink
[apache#5746] improve(CLI): Support table format output for Audit com…
Browse files Browse the repository at this point in the history
…mand

Support table format output for Audit command.
  • Loading branch information
Abyss-lord committed Feb 15, 2025
1 parent cdc5f8f commit 176eeff
Show file tree
Hide file tree
Showing 19 changed files with 2,044 additions and 232 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ public class CommandContext {
private final String url;
private final boolean quiet;
private final CommandLine line;
// TODO make it final
private int outputLimit;

private String ignoreEnv;
private boolean ignoreSet = false;
Expand All @@ -55,6 +57,8 @@ public CommandContext(CommandLine line) {

this.url = getUrl();
this.ignoreVersions = getIgnore();
// TODO add limit option to CLI
this.outputLimit = -1;
}

/**
Expand Down Expand Up @@ -102,6 +106,15 @@ public boolean quiet() {
return quiet;
}

/**
* Returns the output limit.
*
* @return The output limit.
*/
public int outputLimit() {
return outputLimit;
}

/**
* Retrieves the Gravitino URL from the command line options or the GRAVITINO_URL environment
* variable or the Gravitino config file.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,17 +39,6 @@ public void handle() {}
* @param audit from a class that implements the Auditable interface.
*/
public void displayAuditInfo(Audit audit) {
String auditInfo =
"creator,create_time,modified,modified_time"
+ System.lineSeparator()
+ audit.creator()
+ ","
+ audit.createTime()
+ ","
+ audit.lastModifier()
+ ","
+ audit.lastModifiedTime();

printResults(auditInfo);
printResults(audit);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ public void handle() {
try {
GravitinoClient client = buildClient(metalake);
result = client.loadCatalog(catalog);
output(result);
printResults(result);
} catch (NoSuchMetalakeException err) {
exitWithError(ErrorMessages.UNKNOWN_METALAKE);
} catch (NoSuchCatalogException err) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import org.apache.gravitino.cli.KerberosData;
import org.apache.gravitino.cli.Main;
import org.apache.gravitino.cli.OAuthData;
import org.apache.gravitino.cli.outputs.BaseOutputFormat;
import org.apache.gravitino.cli.outputs.PlainFormat;
import org.apache.gravitino.cli.outputs.TableFormat;
import org.apache.gravitino.client.DefaultOAuth2TokenProvider;
Expand Down Expand Up @@ -89,16 +90,26 @@ public void printInformation(String message) {
return;
}

System.out.print(message);
printResults(message);
}

/**
* Prints out an a results of a command.
* Outputs the entity result to the console.
*
* @param entity The entity to output.
* @param <T> The type of entity.
*/
public <T> void printResults(T entity) {
output(entity);
}

/**
* Prints out the string result of a command.
*
* @param results The results to display.
*/
public void printResults(String results) {
System.out.print(results);
BaseOutputFormat.output(results, System.out);
}

/**
Expand Down Expand Up @@ -218,22 +229,16 @@ protected <T extends GravitinoClientBase> Builder<T> constructClient(Builder<T>
return builder;
}

/**
* Outputs the entity to the console.
*
* @param entity The entity to output.
* @param <T> The type of entity.
*/
protected <T> void output(T entity) {
private <T> void output(T entity) {
if (outputFormat == null) {
PlainFormat.output(entity);
PlainFormat.output(entity, context);
return;
}

if (outputFormat.equals(OUTPUT_FORMAT_TABLE)) {
TableFormat.output(entity);
TableFormat.output(entity, context);
} else if (outputFormat.equals(OUTPUT_FORMAT_PLAIN)) {
PlainFormat.output(entity);
PlainFormat.output(entity, context);
} else {
throw new IllegalArgumentException("Unsupported output format");
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ public void handle() {
try {
GravitinoClient client = buildClient(metalake);
catalogs = client.listCatalogsInfo();
output(catalogs);
printResults(catalogs);
} catch (NoSuchMetalakeException err) {
exitWithError(ErrorMessages.UNKNOWN_METALAKE);
} catch (Exception exp) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public void handle() {
try {
GravitinoAdminClient client = buildAdminClient();
metalakes = client.listMetalakes();
output(metalakes);
printResults(metalakes);
} catch (Exception exp) {
exitWithError(exp.getMessage());
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,10 @@

package org.apache.gravitino.cli.commands;

import com.google.common.base.Joiner;
import com.google.common.collect.Lists;
import java.util.List;
import org.apache.gravitino.Schema;
import org.apache.gravitino.SupportsSchemas;
import org.apache.gravitino.cli.CommandContext;
import org.apache.gravitino.cli.ErrorMessages;
import org.apache.gravitino.client.GravitinoClient;
Expand Down Expand Up @@ -48,10 +51,13 @@ public ListSchema(CommandContext context, String metalake, String catalog) {
/** List all schema names in a schema. */
@Override
public void handle() {
String[] schemas = new String[0];
List<Schema> schemas = Lists.newArrayList();
try {
GravitinoClient client = buildClient(metalake);
schemas = client.loadCatalog(catalog).asSchemas().listSchemas();
SupportsSchemas gObject = client.loadCatalog(catalog).asSchemas();
for (String schemaName : gObject.listSchemas()) {
schemas.add(gObject.loadSchema(schemaName));
}
} catch (NoSuchMetalakeException err) {
exitWithError(ErrorMessages.UNKNOWN_METALAKE);
} catch (NoSuchCatalogException err) {
Expand All @@ -60,8 +66,10 @@ public void handle() {
exitWithError(exp.getMessage());
}

String all = schemas.length == 0 ? "No schemas exist." : Joiner.on(",").join(schemas);

printInformation(all);
if (schemas.isEmpty()) {
printInformation("No schemas exist.");
} else {
printResults(schemas.toArray(new Schema[0]));
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public void handle() {
try {
GravitinoClient client = buildClient(metalake);
Metalake metalakeEntity = client.loadMetalake(metalake);
output(metalakeEntity);
printResults(metalakeEntity);
} catch (NoSuchMetalakeException err) {
exitWithError(ErrorMessages.UNKNOWN_METALAKE);
} catch (Exception exp) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ public void handle() {
}

if (result != null) {
printInformation(result.name() + "," + result.comment());
printResults(result);
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
/*
* 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.outputs;

import com.google.common.base.Preconditions;
import java.io.BufferedOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.io.PrintStream;
import java.io.UncheckedIOException;
import java.nio.charset.StandardCharsets;
import org.apache.gravitino.cli.CommandContext;

/**
* Abstract base implementation of {@link OutputFormat} interface providing common functionality for
* various output format implementations. This class handles basic output operations and provides
* configurable behavior for quiet mode, output limiting.
*/
public abstract class BaseOutputFormat<T> implements OutputFormat<T> {
protected int limit;
protected CommandContext context;

/**
* Creates a new {@link BaseOutputFormat} with specified configuration.
*
* @param context the command context, must not be null;
*/
public BaseOutputFormat(CommandContext context) {
Preconditions.checkNotNull(context, "CommandContext cannot be null");
this.context = context;
this.limit = context.outputLimit();
}

/**
* Outputs a message to the specified OutputStream. This method handles both system streams
* ({@code System.out}, {@code System.err}) and regular output streams differently: - For system
* streams: Preserves the stream open after writing - For other streams: Automatically closes the
* stream after writing
*
* @param message the message to output, must not be null
* @param os the output stream to write to, must not be null If this is {@code System.out} or
* {@code System.err}, the stream will not be closed
* @throws IllegalArgumentException if either message or os is null
* @throws UncheckedIOException if an I/O error occurs during writing
*/
public static void output(String message, OutputStream os) {
if (message == null || os == null) {
throw new IllegalArgumentException("Message and OutputStream cannot be null");
}
boolean isSystemStream = (os == System.out || os == System.err);

try {
PrintStream printStream =
new PrintStream(
isSystemStream ? os : new BufferedOutputStream(os),
true,
StandardCharsets.UTF_8.name());

try {
printStream.println(message);
printStream.flush();
} finally {
if (!isSystemStream) {
printStream.close();
}
}
} catch (IOException e) {
throw new UncheckedIOException("Failed to write message to output stream", e);
}
}

/**
* {@inheritDoc} This implementation checks the quiet flag and handles null output gracefully. If
* quiet mode is enabled, no output is produced.
*/
@Override
public void output(T entity) {
String outputMessage = getOutput(entity);
String output = outputMessage == null ? "" : outputMessage;
output(output, System.out);
}
}
Loading

0 comments on commit 176eeff

Please sign in to comment.