Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#6481] improve(CLI): Refactor table output format #6483

Merged
merged 3 commits into from
Feb 21, 2025
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ public class CommandContext {
private final boolean quiet;
private final CommandLine line;
private final String auth;
private final int outputLimit;

private String ignoreEnv;
private boolean ignoreSet = false;
Expand All @@ -55,6 +56,8 @@ public CommandContext(CommandLine line) {
? line.getOptionValue(GravitinoOptions.OUTPUT)
: Command.OUTPUT_FORMAT_PLAIN;
this.quiet = line.hasOption(GravitinoOptions.QUIET);
// TODO add limit option to CLI
this.outputLimit = -1;

this.url = getUrl();
this.ignoreVersions = getIgnore();
Expand Down Expand Up @@ -115,6 +118,15 @@ public String auth() {
return auth;
}

/**
* 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 @@ -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 @@ -226,14 +237,14 @@ protected <T extends GravitinoClientBase> Builder<T> constructClient(Builder<T>
*/
protected <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 @@ -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
@@ -0,0 +1,100 @@
/*
* 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, message: " + message + ", os: " + os);
}
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