Add getExternalDocumentationLink

Author: psainics

database-commons/src/main/java/io/cdap/plugin/db/DBErrorDetailsProvider.java

@@ -16,6 +16,7 @@
 
 package io.cdap.plugin.db;
 
+import com.google.common.base.Strings;
 import com.google.common.base.Throwables;
 import io.cdap.cdap.api.exception.ErrorCategory;
 import io.cdap.cdap.api.exception.ErrorType;
@@ -48,7 +49,6 @@ public ProgramFailureException getExceptionDetails(Exception e, ErrorContext err
       if (t instanceof IllegalStateException) {
         return getProgramFailureException((IllegalStateException) t, errorContext);
       }
-
     }
     return null;
   }
@@ -67,6 +67,14 @@ private ProgramFailureException getProgramFailureException(SQLException e, Error
     String errorMessageWithDetails = String.format(
       "Error occurred in the phase: '%s'. Error message: '%s'. Error code: '%s'. sqlState: '%s'",
       errorContext.getPhase(), errorMessage, errorCode, sqlState);
+    String externalDocumentationLink = getExternalDocumentationLink();
+    if (!Strings.isNullOrEmpty(externalDocumentationLink)) {
+      if (!errorMessageWithDetails.endsWith(".")) {
+        errorMessageWithDetails = errorMessageWithDetails + ".";
+      }
+      errorMessageWithDetails = String.format("%s For more details, see %s", errorMessageWithDetails,
+        externalDocumentationLink);
+    }
     return ErrorUtils.getProgramFailureException(new ErrorCategory(ErrorCategory.ErrorCategoryEnum.PLUGIN),
       errorMessage, errorMessageWithDetails, getErrorTypeFromErrorCode(errorCode), false, e);
   }
@@ -99,7 +107,6 @@ private ProgramFailureException getProgramFailureException(IllegalStateException
     return ErrorUtils.getProgramFailureException(new ErrorCategory(ErrorCategory.ErrorCategoryEnum.PLUGIN),
       errorMessage,
       String.format(errorMessageFormat, errorContext.getPhase(), errorMessage), ErrorType.SYSTEM, false, e);
-
   }
 
   /**

mysql-plugin/src/e2e-test/features/mysqlsink/RunTimeWithMacros.feature

@@ -99,7 +99,9 @@ Feature: MySQL Sink - Run time scenarios (macro)
     And Run the Pipeline in Runtime with runtime arguments
     Then Wait till pipeline is in running state
     Then Open and capture logs
+    And Open and capture logs
     And Verify the pipeline status is "Failed"
+    And Close the pipeline logs
 
   @BQ_SOURCE_TEST @MYSQL_TARGET_TABLE @Mysql_Required
   Scenario: Verify that the pipeline fails when user provides invalid Credentials for connection with Macros
@@ -135,4 +137,6 @@ Feature: MySQL Sink - Run time scenarios (macro)
     And Enter runtime argument value "invalid.password" for key "password"
     And Run the Pipeline in Runtime with runtime arguments
     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

mysql-plugin/src/e2e-test/features/mysqlsource/RunTimeWithMacros.feature

@@ -201,7 +201,9 @@ Feature: MySQL Source - Run time scenarios (macro)
     And Enter runtime argument value "invalid.query" for key "importQuery"
     And Run the Pipeline in Runtime with runtime arguments
     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
 
   @MYSQL_SOURCE_TEST @MYSQL_TARGET_TEST @Mysql_Required
   Scenario: Verify that pipeline fails when user provides invalid Credentials for connection with Macros
@@ -241,4 +243,6 @@ Feature: MySQL Source - Run time scenarios (macro)
     And Enter runtime argument value "invalid.password" for key "Password"
     And Run the Pipeline in Runtime with runtime arguments
     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