Add parameter summaries to derivative connectors

Author: misolt

dumper/app/src/main/java/com/google/edwmigration/dumper/application/dumper/connector/snowflake/AbstractSnowflakeConnector.java

@@ -31,6 +31,7 @@
 import com.google.edwmigration.dumper.application.dumper.annotations.RespectsInput;
 import com.google.edwmigration.dumper.application.dumper.annotations.RespectsInputs;
 import com.google.edwmigration.dumper.application.dumper.connector.AbstractJdbcConnector;
+import com.google.edwmigration.dumper.application.dumper.connector.Connector;
 import com.google.edwmigration.dumper.application.dumper.handle.Handle;
 import com.google.edwmigration.dumper.application.dumper.handle.JdbcHandle;
 import com.google.edwmigration.dumper.application.dumper.task.AbstractJdbcTask;
@@ -244,4 +245,10 @@ String sanitizeDatabaseName(@Nonnull String databaseName) throws MetadataDumperU
     }
     return trimmedName;
   }
+
+  static String describeAsDelegate(Connector connector, String baseName) {
+    String summary = String.format("* %s - %s\n", connector.getName(), connector.getDescription());
+    String details = String.format("%8s[same options as '%s']\n", "", baseName);
+    return summary + details;
+  }
 }

dumper/app/src/main/java/com/google/edwmigration/dumper/application/dumper/connector/snowflake/SnowflakeAccountUsageLogsConnector.java

@@ -20,11 +20,12 @@
 
 import com.google.auto.service.AutoService;
 import com.google.edwmigration.dumper.application.dumper.connector.Connector;
+import java.io.IOException;
 import javax.annotation.Nonnull;
 
 /** @author shevek */
 @AutoService(Connector.class)
-public class SnowflakeAccountUsageLogsConnector extends SnowflakeLogsConnector {
+public final class SnowflakeAccountUsageLogsConnector extends SnowflakeLogsConnector {
 
   public SnowflakeAccountUsageLogsConnector() {
     super("snowflake-account-usage-logs", USAGE_ONLY_SOURCE);
@@ -35,4 +36,9 @@ public SnowflakeAccountUsageLogsConnector() {
   public String getDescription() {
     return "Dumps logs from Snowflake, using ACCOUNT_USAGE only.";
   }
+
+  @Override
+  public void printHelp(@Nonnull Appendable out) throws IOException {
+    out.append(AbstractSnowflakeConnector.describeAsDelegate(this, "snowflake-logs"));
+  }
 }

dumper/app/src/main/java/com/google/edwmigration/dumper/application/dumper/connector/snowflake/SnowflakeAccountUsageMetadataConnector.java

@@ -20,6 +20,7 @@
 
 import com.google.auto.service.AutoService;
 import com.google.edwmigration.dumper.application.dumper.connector.Connector;
+import java.io.IOException;
 import javax.annotation.Nonnull;
 
 /** @author shevek */
@@ -35,4 +36,9 @@ public SnowflakeAccountUsageMetadataConnector() {
   public String getDescription() {
     return "Dumps metadata from Snowflake, using ACCOUNT_USAGE only.";
   }
+
+  @Override
+  public void printHelp(@Nonnull Appendable out) throws IOException {
+    out.append(AbstractSnowflakeConnector.describeAsDelegate(this, "snowflake"));
+  }
 }

dumper/app/src/main/java/com/google/edwmigration/dumper/application/dumper/connector/snowflake/SnowflakeInformationSchemaLogsConnector.java

@@ -20,6 +20,7 @@
 
 import com.google.auto.service.AutoService;
 import com.google.edwmigration.dumper.application.dumper.connector.Connector;
+import java.io.IOException;
 import javax.annotation.Nonnull;
 
 /**
@@ -39,4 +40,9 @@ public SnowflakeInformationSchemaLogsConnector() {
   public String getDescription() {
     return "Dumps logs from Snowflake, using INFORMATION_SCHEMA only.";
   }
+
+  @Override
+  public void printHelp(@Nonnull Appendable out) throws IOException {
+    out.append(AbstractSnowflakeConnector.describeAsDelegate(this, "snowflake-logs"));
+  }
 }

dumper/app/src/main/java/com/google/edwmigration/dumper/application/dumper/connector/snowflake/SnowflakeInformationSchemaMetadataConnector.java

@@ -20,6 +20,7 @@
 
 import com.google.auto.service.AutoService;
 import com.google.edwmigration.dumper.application.dumper.connector.Connector;
+import java.io.IOException;
 import javax.annotation.Nonnull;
 
 /** @author shevek */
@@ -35,4 +36,9 @@ public SnowflakeInformationSchemaMetadataConnector() {
   public String getDescription() {
     return "Dumps metadata from Snowflake, using INFORMATION_SCHEMA only.";
   }
+
+  @Override
+  public void printHelp(@Nonnull Appendable out) throws IOException {
+    out.append(AbstractSnowflakeConnector.describeAsDelegate(this, "snowflake"));
+  }
 }

dumper/app/src/test/java/com/google/edwmigration/dumper/application/dumper/connector/snowflake/AbstractSnowflakeConnectorTest.java

@@ -28,10 +28,11 @@
 import java.util.stream.IntStream;
 import org.junit.Assert;
 import org.junit.Test;
+import org.junit.experimental.theories.Theories;
+import org.junit.experimental.theories.Theory;
 import org.junit.runner.RunWith;
-import org.junit.runners.JUnit4;
 
-@RunWith(JUnit4.class)
+@RunWith(Theories.class)
 public class AbstractSnowflakeConnectorTest extends AbstractConnectorTest {
   private static final ImmutableList<String> ARGS =
       ImmutableList.of(
@@ -43,6 +44,33 @@ public class AbstractSnowflakeConnectorTest extends AbstractConnectorTest {
 
   private final SnowflakeMetadataConnector metadataConnector = new SnowflakeMetadataConnector();
 
+  public enum TestCase {
+    LOGS(SnowflakeLogsConnector.class),
+    LOGS_AU(SnowflakeAccountUsageLogsConnector.class),
+    LOGS_IS(SnowflakeInformationSchemaLogsConnector.class),
+    META(SnowflakeMetadataConnector.class),
+    META_AU(SnowflakeAccountUsageMetadataConnector.class),
+    META_IS(SnowflakeInformationSchemaMetadataConnector.class);
+
+    final Class<? extends AbstractSnowflakeConnector> subclass;
+
+    TestCase(Class<? extends AbstractSnowflakeConnector> subclass) {
+      this.subclass = subclass;
+    }
+  }
+
+  @Theory
+  public void describeAsDelegate_success(TestCase testCase) throws Exception {
+    AbstractSnowflakeConnector connector = testCase.subclass.newInstance();
+
+    String description = AbstractSnowflakeConnector.describeAsDelegate(connector, "test-connector");
+
+    assertTrue(description, description.contains(connector.getName()));
+    assertTrue(description, description.contains(connector.getDescription()));
+    assertTrue(description, description.contains("[same options as 'test-connector']"));
+    assertTrue(description, description.endsWith("\n"));
+  }
+
   @Test
   public void openConnection_failsForVeryLongInput() throws IOException {
     // 262 characters