Add CloudSQLPostgreSQLErrorDetailsProvider

Author: psainics

cloudsql-postgresql-plugin/src/e2e-test/features/source/RunTime.feature

@@ -147,7 +147,9 @@ Feature: CloudSQL-PostGreSQL Source - Run Time scenarios
     And Save and Deploy Pipeline
     And Run the Pipeline in Runtime
     And Wait till pipeline is in running state
+    And Open and capture logs
     And Verify the pipeline status is "Failed"
+    And Close the pipeline logs
     Then Open Pipeline logs and verify Log entries having below listed Level and Message:
       | Level | Message                                  |
       | ERROR | errorLogsMessageInvalidBoundingQuery     |
@@ -189,6 +191,7 @@ Feature: CloudSQL-PostGreSQL Source - Run Time scenarios
     Then Save the pipeline
     Then Preview and run the pipeline
     Then Wait till pipeline preview is in running state
+    Then Open and capture pipeline preview logs
     Then Verify the preview run status of pipeline in the logs is "failed"
 
   @CLOUDSQLPOSTGRESQL_SOURCE_TEST @CLOUDSQLPOSTGRESQL_TARGET_TEST

cloudsql-postgresql-plugin/src/main/java/io/cdap/plugin/cloudsql/postgres/CloudSQLPostgreSQLErrorDetailsProvider.java

@@ -0,0 +1,29 @@
+/*
+ * Copyright © 2024 Cask Data, Inc.
+ *
+ * Licensed 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 io.cdap.plugin.cloudsql.postgres;
+
+import io.cdap.plugin.db.DBErrorDetailsProvider;
+
+/**
+ * A custom ErrorDetailsProvider for CloudSQL PostgreSQL plugin.
+ */
+public class CloudSQLPostgreSQLErrorDetailsProvider  extends DBErrorDetailsProvider {
+  @Override
+  protected String getExternalDocumentationLink() {
+    return "https://www.postgresql.org/docs/current/errcodes-appendix.html";
+  }
+}

cloudsql-postgresql-plugin/src/main/java/io/cdap/plugin/cloudsql/postgres/CloudSQLPostgreSQLSink.java

@@ -147,6 +147,11 @@ protected LineageRecorder getLineageRecorder(BatchSinkContext context) {
     return new LineageRecorder(context, assetBuilder.build());
   }
 
+  @Override
+  protected String getErrorDetailsProviderClassName() {
+    return CloudSQLPostgreSQLErrorDetailsProvider.class.getName();
+  }
+
   /** CloudSQL PostgreSQL sink config. */
   public static class CloudSQLPostgreSQLSinkConfig extends AbstractDBSpecificSinkConfig {
 

cloudsql-postgresql-plugin/src/main/java/io/cdap/plugin/cloudsql/postgres/CloudSQLPostgreSQLSource.java

@@ -60,7 +60,7 @@ public CloudSQLPostgreSQLSource(CloudSQLPostgreSQLSourceConfig cloudsqlPostgresq
     super(cloudsqlPostgresqlSourceConfig);
     this.cloudsqlPostgresqlSourceConfig = cloudsqlPostgresqlSourceConfig;
   }
-  
+
   @Override
   public void configurePipeline(PipelineConfigurer pipelineConfigurer) {
     FailureCollector failureCollector = pipelineConfigurer.getStageConfigurer().getFailureCollector();
@@ -86,6 +86,11 @@ protected Class<? extends DBWritable> getDBRecordType() {
     return PostgresDBRecord.class;
   }
 
+  @Override
+  protected String getErrorDetailsProviderClassName() {
+    return CloudSQLPostgreSQLErrorDetailsProvider.class.getName();
+  }
+
   @Override
   protected String createConnectionString() {
     if (CloudSQLUtil.PRIVATE_INSTANCE.equalsIgnoreCase(

postgresql-plugin/src/e2e-test/resources/errorMessage.properties

@@ -8,12 +8,12 @@ errorMessageInvalidNumberOfSplits=Invalid value for Number of Splits '0'. Must b
 errorMessageNumberOfSplitNotNumber=Unable to create config for batchsource Postgres 'numSplits' is invalid: Value of \
   field class io.cdap.plugin.db.config.AbstractDBSpecificSourceConfig.numSplits is expected to be a number.
 errorMessageInvalidFetchSize=Invalid fetch size. Fetch size must be a positive integer.
-errorMessageInvalidSourceDatabase=SQL error while getting query schema: FATAL: database "invalidDatabase" does not exist
+errorMessageInvalidSourceDatabase=SQL error while getting query schema: Error: FATAL: database "invalidDatabase" does not exist
 errorMessageInvalidImportQuery=Import Query select must contain the string '$CONDITIONS'. if Number of Splits is not set\
   \ to 1. Include '$CONDITIONS' in the Import Query
 errorMessageBlankUsername=Username is required when password is given.
 errorMessageBlankPassword=SQL error while getting query schema: The server requested SCRAM-based authentication, but no password was provided.
-errorMessageInvalidPassword=SQL error while getting query schema: FATAL: password authentication failed for user
+errorMessageInvalidPassword=SQL error while getting query schema: Error: FATAL: password authentication failed for user
 errorMessageInvalidSourceHost=SQL error while getting query schema: The connection attempt failed.
 errorMessageInvalidTableName=Table 'table' does not exist. Ensure table '"table"' is set correctly and that the
 errorMessageInvalidSinkDatabase=Exception while trying to validate schema of database table '"targettable_