[#6136] improvement(CLI): Move check for enable and disable command in Gravitino CLI to command

Abyss-lord · Abyss-lord · commit d76ace9fd594 · 2025-02-26T19:42:32.000+08:00
fix some bugs.
diff --git a/clients/cli/src/main/java/org/apache/gravitino/cli/outputs/LineUtil.java b/clients/cli/src/main/java/org/apache/gravitino/cli/outputs/LineUtil.java
@@ -25,13 +25,16 @@
 import org.apache.gravitino.rel.expressions.Expression;
 import org.apache.gravitino.rel.expressions.FunctionExpression;
 import org.apache.gravitino.rel.expressions.literals.Literal;
+import org.apache.gravitino.rel.types.Type;
 
 public class LineUtil {
   // This expression is primarily used to match characters that have a display width of
   // 2, such as characters from Korean, Chinese
   private static final Pattern FULL_WIDTH_PATTERN =
       Pattern.compile(
           "[\u1100-\u115F\u2E80-\uA4CF\uAC00-\uD7A3\uF900-\uFAFF\uFE10-\uFE19\uFE30-\uFE6F\uFF00-\uFF60\uFFE0-\uFFE6]");
+  public static final String EMPTY_DEFAULT_VALUE = "";
+  public static final String EMPTY_STRING_TYPE_DEFAULT_VALUE = "''";
 
   /**
    * Get the display width of a string.
@@ -106,25 +109,86 @@ public static String capitalize(String str) {
   }
 
   /**
-   * Get the default value of a column.
+   * Get the default value of a column. if the column has a default value, return it as a string. if
+   * the column does not set a default value, return {@link #EMPTY_DEFAULT_VALUE}. if the column is
+   * of string type and the default value is an empty string, return {@link
+   * #EMPTY_STRING_TYPE_DEFAULT_VALUE}
    *
-   * @param defaultValue the default value expression.
+   * @param column the column to get.
    * @return the default value as a string.
    */
-  public static String getDefaultValue(Expression defaultValue) {
+  public static String getDefaultValue(org.apache.gravitino.rel.Column column) {
+    Expression defaultValue = column.defaultValue();
     if (defaultValue == null
         || defaultValue == org.apache.gravitino.rel.Column.DEFAULT_VALUE_NOT_SET) {
-      return "N/A";
+      return EMPTY_DEFAULT_VALUE;
     }
 
     if (defaultValue instanceof Literal && ((Literal<?>) defaultValue).value() != null) {
-      return ((Literal<?>) defaultValue).value().toString();
+      String defaultValueStr = ((Literal<?>) defaultValue).value().toString().trim();
+      if ("".equalsIgnoreCase(defaultValueStr) && isStringType(column)) {
+        return EMPTY_STRING_TYPE_DEFAULT_VALUE;
+      }
+      return defaultValueStr;
     } else if (defaultValue instanceof FunctionExpression) {
       return defaultValue.toString();
     } else if (defaultValue.references().length == 0) {
-      return "N/A";
+      return EMPTY_DEFAULT_VALUE;
     }
 
     return Arrays.toString(defaultValue.references());
   }
+
+  /**
+   * If the column is of integer type, return whether it is auto-incremented, otherwise return an
+   * empty string.
+   *
+   * @param column the column to check.
+   * @return if the column is of integer type and auto-incremented, return "true", otherwise return
+   *     an empty string.
+   */
+  public static String getAutoIncrement(org.apache.gravitino.rel.Column column) {
+    if (isIntegerType(column)) {
+      return column.autoIncrement() ? "true" : "false";
+    }
+
+    return "";
+  }
+
+  /**
+   * Check if a column is of integer type.
+   *
+   * @param column the column to check.
+   * @return true if the column is of integer type, false otherwise.
+   */
+  public static boolean isIntegerType(org.apache.gravitino.rel.Column column) {
+    Type.Name columnTypeName = column.dataType().name();
+    return columnTypeName == Type.Name.LONG
+        || columnTypeName == Type.Name.INTEGER
+        || columnTypeName == Type.Name.SHORT
+        || columnTypeName == Type.Name.BYTE;
+  }
+
+  /**
+   * Check if a column is of string type.
+   *
+   * @param column the column to check.
+   * @return true if the column is of string type, false otherwise.
+   */
+  public static boolean isStringType(org.apache.gravitino.rel.Column column) {
+    Type.Name columnTypeName = column.dataType().name();
+    return columnTypeName == Type.Name.STRING
+        || columnTypeName == Type.Name.VARCHAR
+        || columnTypeName == Type.Name.FIXEDCHAR;
+  }
+
+  /**
+   * Get the comment of a column. If the column does not have a comment, return "N/A".
+   *
+   * @param column the column to get.
+   * @return the comment of the column.
+   */
+  public static String getComment(org.apache.gravitino.rel.Column column) {
+    return column.comment() == null ? "N/A" : column.comment();
+  }
 }
diff --git a/clients/cli/src/main/java/org/apache/gravitino/cli/outputs/PlainFormat.java b/clients/cli/src/main/java/org/apache/gravitino/cli/outputs/PlainFormat.java
@@ -261,10 +261,10 @@ public String getOutput(Column[] columns) {
       for (int i = 0; i < columns.length; i++) {
         String name = columns[i].name();
         String dataType = columns[i].dataType().simpleString();
-        String defaultValue = LineUtil.getDefaultValue(columns[i].defaultValue());
-        String comment = columns[i].comment();
+        String defaultValue = LineUtil.getDefaultValue(columns[i]);
+        String comment = LineUtil.getComment(columns[i]);
         String nullable = columns[i].nullable() ? "true" : "false";
-        String autoIncrement = columns[i].autoIncrement() ? "true" : "false";
+        String autoIncrement = LineUtil.getAutoIncrement(columns[i]);
 
         data.append(
             COMMA_JOINER.join(name, dataType, defaultValue, comment, nullable, autoIncrement));
diff --git a/clients/cli/src/main/java/org/apache/gravitino/cli/outputs/TableFormat.java b/clients/cli/src/main/java/org/apache/gravitino/cli/outputs/TableFormat.java
@@ -620,8 +620,8 @@ public String getOutput(Table table) {
       for (org.apache.gravitino.rel.Column column : columns) {
         columnName.addCell(column.name());
         columnType.addCell(column.dataType().simpleString());
-        columnDefaultValue.addCell(LineUtil.getDefaultValue(column.defaultValue()));
-        columnAutoIncrement.addCell(column.autoIncrement());
+        columnDefaultValue.addCell(LineUtil.getDefaultValue(column));
+        columnAutoIncrement.addCell(LineUtil.getAutoIncrement(column));
         columnNullable.addCell(column.nullable());
         columnComment.addCell(
             column.comment() == null || column.comment().isEmpty() ? "N/A" : column.comment());
@@ -712,11 +712,10 @@ public String getOutput(org.apache.gravitino.rel.Column[] columns) {
       for (org.apache.gravitino.rel.Column column : columns) {
         columnName.addCell(column.name());
         columnType.addCell(column.dataType().simpleString());
-        columnDefaultVal.addCell(LineUtil.getDefaultValue(column.defaultValue()));
-        columnAutoIncrement.addCell(column.autoIncrement());
+        columnDefaultVal.addCell(LineUtil.getDefaultValue(column));
+        columnAutoIncrement.addCell(LineUtil.getAutoIncrement(column));
         columnNullable.addCell(column.nullable());
-        columnComment.addCell(
-            column.comment() == null || column.comment().isEmpty() ? "N/A" : column.comment());
+        columnComment.addCell(LineUtil.getComment(column));
       }
 
       return getTableFormat(
diff --git a/clients/cli/src/test/java/org/apache/gravitino/cli/output/TestLineUtil.java b/clients/cli/src/test/java/org/apache/gravitino/cli/output/TestLineUtil.java
@@ -0,0 +1,244 @@
+/*
+ * 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.output;
+
+import static org.apache.gravitino.rel.expressions.NamedReference.field;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import org.apache.gravitino.cli.outputs.LineUtil;
+import org.apache.gravitino.rel.Column;
+import org.apache.gravitino.rel.expressions.FunctionExpression;
+import org.apache.gravitino.rel.expressions.literals.Literal;
+import org.apache.gravitino.rel.types.Type;
+import org.apache.gravitino.rel.types.Types;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+public class TestLineUtil {
+  @Test
+  void testGetDisplayWidthWithAscii() {
+    Assertions.assertEquals(13, LineUtil.getDisplayWidth("Hello, world!"));
+    Assertions.assertEquals(5, LineUtil.getDisplayWidth("Hello"));
+    Assertions.assertEquals(1, LineUtil.getDisplayWidth("H"));
+  }
+
+  @SuppressWarnings("DefaultCharset")
+  @Test
+  void testGetDisplayWidthWithNonAscii() {
+    Assertions.assertEquals(8, LineUtil.getDisplayWidth("、世界！"));
+    Assertions.assertEquals(10, LineUtil.getDisplayWidth("こんにちは"));
+    Assertions.assertEquals(2, LineUtil.getDisplayWidth("こ"));
+  }
+
+  @Test
+  void testGetSpaces() {
+    Assertions.assertEquals(" ", LineUtil.getSpaces(1));
+    Assertions.assertEquals("  ", LineUtil.getSpaces(2));
+    Assertions.assertEquals("   ", LineUtil.getSpaces(3));
+  }
+
+  @Test
+  void testGetAutoIncrementWithLong() {
+    Column mockColumn1 = mock(Column.class);
+    when(mockColumn1.dataType()).thenReturn(Types.LongType.get());
+    when(mockColumn1.autoIncrement()).thenReturn(true);
+
+    Assertions.assertEquals("true", LineUtil.getAutoIncrement(mockColumn1));
+
+    Column mockColumn2 = mock(Column.class);
+    when(mockColumn2.dataType()).thenReturn(Types.LongType.get());
+    when(mockColumn2.autoIncrement()).thenReturn(false);
+
+    Assertions.assertEquals("false", LineUtil.getAutoIncrement(mockColumn2));
+  }
+
+  @Test
+  void testGetAutoIncrementWithInteger() {
+    Column mockColumn1 = mock(Column.class);
+    when(mockColumn1.dataType()).thenReturn(Types.IntegerType.get());
+    when(mockColumn1.autoIncrement()).thenReturn(true);
+
+    Assertions.assertEquals("true", LineUtil.getAutoIncrement(mockColumn1));
+
+    Column mockColumn2 = mock(Column.class);
+    when(mockColumn2.dataType()).thenReturn(Types.IntegerType.get());
+    when(mockColumn2.autoIncrement()).thenReturn(false);
+
+    Assertions.assertEquals("false", LineUtil.getAutoIncrement(mockColumn2));
+  }
+
+  @Test
+  void testGetAutoIncrementWithShort() {
+    Column mockColumn1 = mock(Column.class);
+    when(mockColumn1.dataType()).thenReturn(Types.LongType.get());
+    when(mockColumn1.autoIncrement()).thenReturn(true);
+
+    Assertions.assertEquals("true", LineUtil.getAutoIncrement(mockColumn1));
+
+    Column mockColumn2 = mock(Column.class);
+    when(mockColumn2.dataType()).thenReturn(Types.LongType.get());
+    when(mockColumn2.autoIncrement()).thenReturn(false);
+
+    Assertions.assertEquals("false", LineUtil.getAutoIncrement(mockColumn2));
+  }
+
+  @Test
+  void testGetAutoIncrementWithByte() {
+    Column mockColumn1 = mock(Column.class);
+    when(mockColumn1.dataType()).thenReturn(Types.ByteType.get());
+    when(mockColumn1.autoIncrement()).thenReturn(true);
+
+    Assertions.assertEquals("true", LineUtil.getAutoIncrement(mockColumn1));
+
+    Column mockColumn2 = mock(Column.class);
+    when(mockColumn2.dataType()).thenReturn(Types.ByteType.get());
+    when(mockColumn2.autoIncrement()).thenReturn(false);
+
+    Assertions.assertEquals("false", LineUtil.getAutoIncrement(mockColumn2));
+  }
+
+  @Test
+  void testGetAutoIncrementWithNonInteger() {
+    Column mockColumn1 = mock(Column.class);
+    when(mockColumn1.dataType()).thenReturn(Types.StringType.get());
+    when(mockColumn1.autoIncrement()).thenReturn(true);
+
+    Assertions.assertEquals("", LineUtil.getAutoIncrement(mockColumn1));
+
+    Column mockColumn2 = mock(Column.class);
+    when(mockColumn2.dataType()).thenReturn(Types.BooleanType.get());
+    when(mockColumn2.autoIncrement()).thenReturn(false);
+
+    Assertions.assertEquals("", LineUtil.getAutoIncrement(mockColumn2));
+
+    Column mockColumn3 = mock(Column.class);
+    when(mockColumn3.dataType()).thenReturn(Types.TimeType.get());
+    when(mockColumn3.autoIncrement()).thenReturn(false);
+
+    Assertions.assertEquals("", LineUtil.getAutoIncrement(mockColumn3));
+  }
+
+  @Test
+  void testGetComment() {
+    Column mockColumn1 = mock(Column.class);
+    when(mockColumn1.comment()).thenReturn("This is a comment");
+
+    Assertions.assertEquals("This is a comment", LineUtil.getComment(mockColumn1));
+
+    Column mockColumn2 = mock(Column.class);
+    when(mockColumn2.comment()).thenReturn(null);
+
+    Assertions.assertEquals("N/A", LineUtil.getComment(mockColumn2));
+  }
+
+  @Test
+  void testGetDefaultValueWithInteger() {
+    Column mockColumn1 = mock(Column.class);
+    when(mockColumn1.dataType()).thenReturn(Types.IntegerType.get());
+    when(mockColumn1.defaultValue())
+        .thenReturn(
+            new Literal<Integer>() {
+              @Override
+              public Integer value() {
+                return 1;
+              }
+
+              @Override
+              public Type dataType() {
+                return null;
+              }
+            });
+
+    Assertions.assertEquals("1", LineUtil.getDefaultValue(mockColumn1));
+  }
+
+  @Test
+  void testGetDefaultValueWithNull() {
+    Column mockColumn1 = mock(Column.class);
+    when(mockColumn1.dataType()).thenReturn(Types.IntegerType.get());
+    when(mockColumn1.defaultValue()).thenReturn(Column.DEFAULT_VALUE_NOT_SET);
+
+    Assertions.assertEquals(LineUtil.EMPTY_DEFAULT_VALUE, LineUtil.getDefaultValue(mockColumn1));
+
+    Column mockColumn2 = mock(Column.class);
+    when(mockColumn2.dataType()).thenReturn(Types.StringType.get());
+    when(mockColumn2.defaultValue()).thenReturn(null);
+
+    Assertions.assertEquals(LineUtil.EMPTY_DEFAULT_VALUE, LineUtil.getDefaultValue(mockColumn2));
+  }
+
+  @Test
+  void testGetDefaultValueWithString() {
+    Column mockColumn1 = mock(Column.class);
+    when(mockColumn1.dataType()).thenReturn(Types.StringType.get());
+    when(mockColumn1.defaultValue())
+        .thenReturn(
+            new Literal<String>() {
+              @Override
+              public String value() {
+                return "";
+              }
+
+              @Override
+              public Type dataType() {
+                return null;
+              }
+            });
+
+    Assertions.assertEquals("''", LineUtil.getDefaultValue(mockColumn1));
+
+    Column mockColumn2 = mock(Column.class);
+    when(mockColumn2.dataType()).thenReturn(Types.StringType.get());
+    when(mockColumn2.defaultValue())
+        .thenReturn(
+            new Literal<String>() {
+              @Override
+              public String value() {
+                return "Hello, world!";
+              }
+
+              @Override
+              public Type dataType() {
+                return null;
+              }
+            });
+
+    Assertions.assertEquals("Hello, world!", LineUtil.getDefaultValue(mockColumn2));
+  }
+
+  @Test
+  void testGetDefaultValueWithFunctionAndEmptyArgs() {
+    Column mockColumn1 = mock(Column.class);
+    when(mockColumn1.dataType()).thenReturn(Types.StringType.get());
+    when(mockColumn1.defaultValue()).thenReturn(FunctionExpression.of("current_timestamp"));
+
+    Assertions.assertEquals("current_timestamp()", LineUtil.getDefaultValue(mockColumn1));
+  }
+
+  @Test
+  void testGetDefaultValueWithFunctionAndArgs() {
+    Column mockColumn1 = mock(Column.class);
+    when(mockColumn1.dataType()).thenReturn(Types.StringType.get());
+    when(mockColumn1.defaultValue()).thenReturn(FunctionExpression.of("date", field("b")));
+
+    Assertions.assertEquals("date([b])", LineUtil.getDefaultValue(mockColumn1));
+  }
+}
diff --git a/clients/cli/src/test/java/org/apache/gravitino/cli/output/TestPlainFormat.java b/clients/cli/src/test/java/org/apache/gravitino/cli/output/TestPlainFormat.java
diff --git a/clients/cli/src/test/java/org/apache/gravitino/cli/output/TestTableFormat.java b/clients/cli/src/test/java/org/apache/gravitino/cli/output/TestTableFormat.java
