fix: Fix the issue of backup failure due to complex passwords in the pg

[ssongliu]

No description provided.

[f2c-ci-robot]

Adding the "do-not-merge/release-note-label-needed" label because no release-note block was detected, please follow our release note process to remove it.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[wanghe-fit2cloud]

The code provided contains a few issues that I would suggest addressing:

Issues and Suggestions:

1. Unescaped Special Characters:

   • In both Backup and Recover functions, the environment variables include special characters (%) which need to be escaped. This is particularly true for %q format specifier in Go.

2. Variable Naming Consistency:

   • The variable names used within the commands (like imageTag, r.Password, etc.) should follow consistent naming conventions to improve readability.

3. File Path Formatting:

   • Ensure that the file paths specified in the commands are correctly formatted without any trailing slashes or spaces.

Here is an updated version of the code with these changes applied:

func (r *Remote) Backup(info BackupInfo) error {
	//
	fileNameItem := info.TargetDir + "/" + strings.TrimSuffix(info.FileName, ".gz")
	backupCommand := exec.Command(
		"bash", "-c",
		fmt.Sprintf(
			"docker run --rm --net=host -i %s /bin/bash -c 'PGPASSWORD='%[1]q' pg_dump -h %[2]s -p %[3]d --no-owner -Fc -U %[4]s %[5]' > %s",
			r.User,
			info.Name,
			r.Address,
			strconv.Itoa(r.Port),
			info.SourceDBName,
			fileNameItem)),
	})
	var stderr bytes.Buffer
	backupCommand.Stderr = &stderr
	err := backupCommand.Run()
	if err != nil && len(stderr.Bytes()) > 0 {
		return fmt.Errorf("backup failed: %w\nError output:\n%v", err, stderr.String())
	}
	return nil
}

func (r *Remote) Recover(info RecoverInfo) error {
	//
	recoverCommand := exec.Command(
		"bash", "-c",
		fmt.Sprintf(
			"docker run --rm --net=host -i %s /bin/bash -c 'PGPASSWORD='%[1]q' pg_restore -h %[2]s -p %[3]d --verbose --clean --no-privileges --no-owner -Fc -U %[4]s -d %[5]' < %s",
			r.User,
			info.Username,
			r.Address,
			strconv.Itoa(r.Port),
			info.DatabaseName,
			fileName)),
	)
	reader, writer := io.Pipe()
	defer reader.Close()

	go func() {
		writtenBytes, e := ioutil.ReadAll(writer)
		if e != nil {
			log.Printf("%s", string(writtenBytes))
		} else if e == io.EOF {
			e = errors.New(fmt.Sprintf("pg_restore exited unexpectedly after writing %d bytes.", writtenBytes.Len()))
		}
		writer.CloseWithError(e)
	}()

	stderrPipe, _ := recoverCommand.StderrPipe()
	readerErr := io.ReadAll(stderrPipe)

	recoverCommand.Stdin = reader

	cmdStart := time.Now()

	err = recoverCommand.Start()
	if err != nil {
		log.Println("\ncmd:", recoverCommand.Args)
		cmdStart.Sub(cmdStart)) // Print execution time for debugging
		log.Fatalf("error running pg_restore start: %v\nStdout/Erro:\n%s/%s"
			, err.Error(), pipe.OutReader().String(), pipe.ErrReader().String())

	}

	_, readErr := io.Copy(os.Stdout, pipe)

	for { // Wait for either recovery completion or command termination
		waitExitCode, waitErr := recoverCommand.Wait()

		if !errors.Is(waitErr, io.EOF) { // EOF means that the process was terminated by user/integrity issue
			log.Printf("%s", "Process was terminated by signal.")
			log.Printf("Waited Exit Code:%v | waited Error:[%v]", waitExitCode, waitErr)
			return errors.New("recovery interrupted due to unexpected exit.")
		}
		break
	}
	cmdEnd := time.Now()
	cmdDuration := cmdEnd.Sub(cmdStart) // Return the duration it took to execute the script
	log.Println("Recovered database successfully, Execution Duration:", cmdDuration)
}

Notes:

• Env Var Expansion: Used %[1]q for environment variable expansion to handle quotes gracefully.
• Error Handling: Added comprehensive error handling by checking the command's return code and reading all possible outputs.
• Logging Improvements: Enhanced logging to capture and display both successful and failed operations.

[sonarqubecloud]

Quality Gate failed

Failed conditions
2 Security Hotspots

See analysis details on SonarQube Cloud

[wanghe-fit2cloud]

/lgtm

[wanghe-fit2cloud]

/approve

[wanghe-fit2cloud]

/lgtm

[wanghe-fit2cloud]

/approve

[f2c-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: wanghe-fit2cloud

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [wanghe-fit2cloud]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment