Integrated CheckRequiredToolsAreInstalled() function into checkDepend…

…enciesForExport() function (#2071)

yb-voyager/cmd/export.go

@@ -43,7 +43,7 @@ var useDebezium bool
 var runId string
 var excludeTableListFilePath string
 var tableListFilePath string
-var pgExportDependencies = []string{"pg_dump", "pg_restore", "psql"}
+var pgExportCommands = []string{"pg_dump", "pg_restore", "psql"}
 
 var exportCmd = &cobra.Command{
 	Use:   "export",
@@ -392,18 +392,38 @@ func saveExportTypeInMSR() {
 }
 
 func checkDependenciesForExport() (binaryCheckIssues []string, err error) {
-	if source.DBType == POSTGRESQL {
+	var missingTools []string
+	switch source.DBType {
+	case POSTGRESQL:
 		sourceDBVersion := source.DB().GetVersion()
-		for _, binary := range pgExportDependencies {
+		for _, binary := range pgExportCommands {
 			_, binaryCheckIssue, err := srcdb.GetAbsPathOfPGCommandAboveVersion(binary, sourceDBVersion)
 			if err != nil {
 				return nil, err
 			} else if binaryCheckIssue != "" {
 				binaryCheckIssues = append(binaryCheckIssues, binaryCheckIssue)
 			}
 		}
+
+		missingTools = utils.CheckTools("strings")
+
+	case MYSQL:
+		// TODO: For mysql and oracle, we can probably remove the ora2pg check in case it is a live migration
+		// Issue Link: https://github.com/yugabyte/yb-voyager/issues/2102
+		missingTools = utils.CheckTools("ora2pg")
+
+	case ORACLE:
+		missingTools = utils.CheckTools("ora2pg", "sqlplus")
+
+	case YUGABYTEDB:
+		missingTools = utils.CheckTools("strings")
+
+	default:
+		return nil, fmt.Errorf("unknown source database type %q", source.DBType)
 	}
 
+	binaryCheckIssues = append(binaryCheckIssues, missingTools...)
+
 	if changeStreamingIsEnabled(exportType) || useDebezium {
 		// Check for java
 		javaIssue, err := checkJavaVersion()
@@ -489,7 +509,7 @@ func checkJavaVersion() (binaryCheckIssue string, err error) {
 	}
 
 	if majorVersion < MIN_REQUIRED_JAVA_VERSION {
-		return fmt.Sprintf("Java version %s is not supported. Please install Java version %d or higher", version, MIN_REQUIRED_JAVA_VERSION), nil
+		return fmt.Sprintf("java: required version >= %d; current version: %s", MIN_REQUIRED_JAVA_VERSION, version), nil
 	}
 
 	return "", nil

yb-voyager/cmd/exportData.go

@@ -222,8 +222,8 @@ func exportData() bool {
 		if err != nil {
 			utils.ErrExit("check dependencies for export: %v", err)
 		} else if len(binaryCheckIssues) > 0 {
-			color.Red("\nMissing dependencies for export data:")
-			utils.PrintAndLog("\n%s", strings.Join(binaryCheckIssues, "\n"))
+			headerStmt := color.RedString("Missing dependencies for export data:")
+			utils.PrintAndLog("\n%s\n%s", headerStmt, strings.Join(binaryCheckIssues, "\n"))
 			utils.ErrExit("")
 		}
 	}
@@ -245,7 +245,6 @@ func exportData() bool {
 
 	clearMigrationStateIfRequired()
 	checkSourceDBCharset()
-	source.DB().CheckRequiredToolsAreInstalled()
 	saveSourceDBConfInMSR()
 	saveExportTypeInMSR()
 	err = InitNameRegistry(exportDir, exporterRole, &source, source.DB(), nil, nil, false)

yb-voyager/cmd/exportSchema.go

@@ -118,7 +118,6 @@ func exportSchema() error {
 	}
 
 	checkSourceDBCharset()
-	source.DB().CheckRequiredToolsAreInstalled()
 	sourceDBVersion := source.DB().GetVersion()
 	source.DBVersion = sourceDBVersion
 	source.DBSize, err = source.DB().GetDatabaseSize()

yb-voyager/src/srcdb/mysql.go

@@ -71,10 +71,6 @@ func (ms *MySQL) CheckSchemaExists() bool {
 	return true
 }
 
-func (ms *MySQL) CheckRequiredToolsAreInstalled() {
-	checkTools("ora2pg")
-}
-
 func (ms *MySQL) GetTableRowCount(tableName sqlname.NameTuple) (int64, error) {
 	var rowCount int64
 	query := fmt.Sprintf("select count(*) from %s", tableName.AsQualifiedCatalogName())

yb-voyager/src/srcdb/oracle.go

@@ -78,10 +78,6 @@ func (ora *Oracle) CheckSchemaExists() bool {
 	return true
 }
 
-func (ora *Oracle) CheckRequiredToolsAreInstalled() {
-	checkTools("ora2pg", "sqlplus")
-}
-
 func (ora *Oracle) GetTableRowCount(tableName sqlname.NameTuple) (int64, error) {
 	var rowCount int64
 	query := fmt.Sprintf("select count(*) from %s", tableName.ForUserQuery())

yb-voyager/src/srcdb/postgres.go

@@ -140,10 +140,6 @@ func (pg *PostgreSQL) getTrimmedSchemaList() []string {
 	return trimmedList
 }
 
-func (pg *PostgreSQL) CheckRequiredToolsAreInstalled() {
-	checkTools("strings")
-}
-
 func (pg *PostgreSQL) GetTableRowCount(tableName sqlname.NameTuple) (int64, error) {
 	var rowCount int64
 	query := fmt.Sprintf("select count(*) from %s", tableName.ForUserQuery())

yb-voyager/src/srcdb/srcdb.go

@@ -33,7 +33,6 @@ type SourceDB interface {
 	GetConnectionUriWithoutPassword() string
 	GetTableRowCount(tableName sqlname.NameTuple) (int64, error)
 	GetTableApproxRowCount(tableName sqlname.NameTuple) int64
-	CheckRequiredToolsAreInstalled()
 	GetVersion() string
 	GetAllTableNames() []*sqlname.SourceName
 	GetAllTableNamesRaw(schemaName string) ([]string, error)

yb-voyager/src/srcdb/utils.go

@@ -17,25 +17,10 @@ limitations under the License.
 import (
 	"fmt"
 	"os"
-	"os/exec"
 	"path"
 	"strings"
-
-	log "github.com/sirupsen/logrus"
-
-	"github.com/yugabyte/yb-voyager/yb-voyager/src/utils"
 )
 
-func checkTools(tools ...string) {
-	for _, tool := range tools {
-		execPath, err := exec.LookPath(tool)
-		if err != nil {
-			utils.ErrExit("%q not found. Check if it is installed and included in the path.", tool)
-		}
-		log.Infof("Found %q", execPath)
-	}
-}
-
 func findAllExecutablesInPath(executableName string) ([]string, error) {
 	pathString := os.Getenv("PATH")
 	if pathString == "" {

yb-voyager/src/srcdb/yugabytedb.go

@@ -70,10 +70,6 @@ func (yb *YugabyteDB) Disconnect() {
 	}
 }
 
-func (yb *YugabyteDB) CheckRequiredToolsAreInstalled() {
-	checkTools("strings")
-}
-
 func (yb *YugabyteDB) GetTableRowCount(tableName sqlname.NameTuple) (int64, error) {
 	var rowCount int64
 	query := fmt.Sprintf("select count(*) from %s", tableName.ForUserQuery())

yb-voyager/src/utils/utils.go

@@ -24,6 +24,7 @@ import (
 	"net"
 	"net/url"
 	"os"
+	"os/exec"
 	"path/filepath"
 	"regexp"
 	"sort"
@@ -724,3 +725,18 @@ func GetFinalReleaseVersionFromRCVersion(msrVoyagerFinalVersion string) (string,
 	}
 	return msrVoyagerFinalVersion, nil
 }
+
+// Return list of missing tools from the provided list of tools
+func CheckTools(tools ...string) []string {
+	var missingTools []string
+	for _, tool := range tools {
+		execPath, err := exec.LookPath(tool)
+		if err != nil {
+			missingTools = append(missingTools, tool)
+		} else {
+			log.Infof("Found %s at %s", tool, execPath)
+		}
+	}
+
+	return missingTools
+}