Skip to content

Commit

Permalink
*: additional marker tests for error redaction (#52157)
Browse files Browse the repository at this point in the history 
ref #51306
  • Loading branch information
@xhebox
xhebox authored Mar 27, 2024
1 parent dde0a54 commit 7a2f1cc
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 42 deletions.
7 changes: 7 additions & 0 deletions pkg/store/driver/txn/driver_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,4 +76,11 @@ func TestWriteConflictPrettyFormat(t *testing.T) {
"txnStartTS=399402937522847774, conflictStartTS=399402937719455772, conflictCommitTS=399402937719455773, " +
"key=????, reason=Optimistic " + kv.TxnRetryableMark
require.EqualError(t, newWriteConflictError(conflict), expectedStr)

errors.RedactLogEnabled.Store(errors.RedactLogMarker)
defer func() { errors.RedactLogEnabled.Store(original) }()
expectedStr = "[kv:9007]Write conflict, " +
"txnStartTS=399402937522847774, conflictStartTS=399402937719455772, conflictCommitTS=399402937719455773, " +
"key=‹›‹{metaKey=true, key=DB:56, field=TID:108}, originalKey=6d44423a3536000000fc00000000000000685449443a31303800fe, primary=›‹›‹{metaKey=true, key=DB:56, field=TID:108}, originalPrimaryKey=6d44423a3536000000fc00000000000000685449443a31303800fe›, reason=Optimistic " + kv.TxnRetryableMark
require.EqualError(t, newWriteConflictError(conflict), expectedStr)
}
97 changes: 55 additions & 42 deletions pkg/util/dbterror/terror_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,28 @@ package dbterror

import (
"fmt"
"regexp"
"testing"

"github.com/pingcap/errors"
"github.com/pingcap/tidb/pkg/errno"
"github.com/stretchr/testify/require"
)

func genErrMsg(pattern string, a ...any) string {
return fmt.Sprintf(pattern, a...)
var (
markerRegexp = regexp.MustCompile("‹sensitive_data›")
)

func checkErrMsg(t *testing.T, isMarker bool, err error, pattern string, a ...any) {
if !isMarker {
require.Contains(t, err.Error(), fmt.Sprintf(pattern, a...))
} else {
markerRegexp.MatchString(err.Error())
}
}

func TestErrorRedact(t *testing.T) {
original := errors.RedactLogEnabled.Load()
errors.RedactLogEnabled.Store(errors.RedactLogEnable)
defer func() { errors.RedactLogEnabled.Store(original) }()

class := ErrClass{}
Expand All @@ -38,45 +46,50 @@ func TestErrorRedact(t *testing.T) {
sensitiveData := "sensitive_data"
questionMark := "?"

err := class.NewStd(errno.ErrDupEntry).GenWithStackByArgs(sensitiveData, noSensitiveValue)
require.Contains(t, err.Error(), genErrMsg(errno.MySQLErrName[errno.ErrDupEntry].Raw, questionMark, noSensitiveValue))
err = class.NewStd(errno.ErrCutValueGroupConcat).GenWithStackByArgs(sensitiveData)
require.Contains(t, err.Error(), genErrMsg(errno.MySQLErrName[errno.ErrCutValueGroupConcat].Raw, questionMark))
err = class.NewStd(errno.ErrDuplicatedValueInType).GenWithStackByArgs(noSensitiveValue, sensitiveData)
require.Contains(t, err.Error(), genErrMsg(errno.MySQLErrName[errno.ErrDuplicatedValueInType].Raw, noSensitiveValue, questionMark))
err = class.NewStd(errno.ErrTruncatedWrongValue).GenWithStackByArgs(noSensitiveValue, sensitiveData)
require.Contains(t, err.Error(), genErrMsg(errno.MySQLErrName[errno.ErrTruncatedWrongValue].Raw, noSensitiveValue, questionMark))
err = class.NewStd(errno.ErrInvalidCharacterString).FastGenByArgs(noSensitiveValue, sensitiveData)
require.Contains(t, err.Error(), genErrMsg(errno.MySQLErrName[errno.ErrInvalidCharacterString].Raw, noSensitiveValue, questionMark))
err = class.NewStd(errno.ErrTruncatedWrongValueForField).FastGenByArgs(sensitiveData, sensitiveData)
require.Contains(t, err.Error(), genErrMsg(errno.MySQLErrName[errno.ErrTruncatedWrongValueForField].Raw, questionMark, questionMark))
err = class.NewStd(errno.ErrIllegalValueForType).FastGenByArgs(noSensitiveValue, sensitiveData)
require.Contains(t, err.Error(), genErrMsg(errno.MySQLErrName[errno.ErrIllegalValueForType].Raw, noSensitiveValue, questionMark))
for _, c := range []string{errors.RedactLogEnable, errors.RedactLogMarker} {
isMarker := c == errors.RedactLogMarker
errors.RedactLogEnabled.Store(c)

err := class.NewStd(errno.ErrDupEntry).GenWithStackByArgs(sensitiveData, noSensitiveValue)
checkErrMsg(t, isMarker, err, errno.MySQLErrName[errno.ErrDupEntry].Raw, questionMark, noSensitiveValue)
err = class.NewStd(errno.ErrCutValueGroupConcat).GenWithStackByArgs(sensitiveData)
checkErrMsg(t, isMarker, err, errno.MySQLErrName[errno.ErrCutValueGroupConcat].Raw, questionMark)
err = class.NewStd(errno.ErrDuplicatedValueInType).GenWithStackByArgs(noSensitiveValue, sensitiveData)
checkErrMsg(t, isMarker, err, errno.MySQLErrName[errno.ErrDuplicatedValueInType].Raw, noSensitiveValue, questionMark)
err = class.NewStd(errno.ErrTruncatedWrongValue).GenWithStackByArgs(noSensitiveValue, sensitiveData)
checkErrMsg(t, isMarker, err, errno.MySQLErrName[errno.ErrTruncatedWrongValue].Raw, noSensitiveValue, questionMark)
err = class.NewStd(errno.ErrInvalidCharacterString).FastGenByArgs(noSensitiveValue, sensitiveData)
checkErrMsg(t, isMarker, err, errno.MySQLErrName[errno.ErrInvalidCharacterString].Raw, noSensitiveValue, questionMark)
err = class.NewStd(errno.ErrTruncatedWrongValueForField).FastGenByArgs(sensitiveData, sensitiveData)
checkErrMsg(t, isMarker, err, errno.MySQLErrName[errno.ErrTruncatedWrongValueForField].Raw, questionMark, questionMark)
err = class.NewStd(errno.ErrIllegalValueForType).FastGenByArgs(noSensitiveValue, sensitiveData)
checkErrMsg(t, isMarker, err, errno.MySQLErrName[errno.ErrIllegalValueForType].Raw, noSensitiveValue, questionMark)

err = class.NewStd(errno.ErrPartitionWrongValues).GenWithStackByArgs(noSensitiveValue, sensitiveData)
require.Contains(t, err.Error(), genErrMsg(errno.MySQLErrName[errno.ErrPartitionWrongValues].Raw, noSensitiveValue, questionMark))
err = class.NewStd(errno.ErrNoParts).GenWithStackByArgs(sensitiveData)
require.Contains(t, err.Error(), genErrMsg(errno.MySQLErrName[errno.ErrNoParts].Raw, questionMark))
err = class.NewStd(errno.ErrWrongValue).GenWithStackByArgs(noSensitiveValue, sensitiveData)
require.Contains(t, err.Error(), genErrMsg(errno.MySQLErrName[errno.ErrWrongValue].Raw, noSensitiveValue, questionMark))
err = class.NewStd(errno.ErrNoPartitionForGivenValue).GenWithStackByArgs(sensitiveData)
require.Contains(t, err.Error(), genErrMsg(errno.MySQLErrName[errno.ErrNoPartitionForGivenValue].Raw, questionMark))
err = class.NewStd(errno.ErrDataOutOfRange).GenWithStackByArgs(noSensitiveValue, sensitiveData)
require.Contains(t, err.Error(), genErrMsg(errno.MySQLErrName[errno.ErrDataOutOfRange].Raw, noSensitiveValue, questionMark))
err = class.NewStd(errno.ErrPartitionWrongValues).GenWithStackByArgs(noSensitiveValue, sensitiveData)
checkErrMsg(t, isMarker, err, errno.MySQLErrName[errno.ErrPartitionWrongValues].Raw, noSensitiveValue, questionMark)
err = class.NewStd(errno.ErrNoParts).GenWithStackByArgs(sensitiveData)
checkErrMsg(t, isMarker, err, errno.MySQLErrName[errno.ErrNoParts].Raw, questionMark)
err = class.NewStd(errno.ErrWrongValue).GenWithStackByArgs(noSensitiveValue, sensitiveData)
checkErrMsg(t, isMarker, err, errno.MySQLErrName[errno.ErrWrongValue].Raw, noSensitiveValue, questionMark)
err = class.NewStd(errno.ErrNoPartitionForGivenValue).GenWithStackByArgs(sensitiveData)
checkErrMsg(t, isMarker, err, errno.MySQLErrName[errno.ErrNoPartitionForGivenValue].Raw, questionMark)
err = class.NewStd(errno.ErrDataOutOfRange).GenWithStackByArgs(noSensitiveValue, sensitiveData)
checkErrMsg(t, isMarker, err, errno.MySQLErrName[errno.ErrDataOutOfRange].Raw, noSensitiveValue, questionMark)

err = class.NewStd(errno.ErrRowInWrongPartition).GenWithStackByArgs(sensitiveData)
require.Contains(t, err.Error(), genErrMsg(errno.MySQLErrName[errno.ErrRowInWrongPartition].Raw, questionMark))
err = class.NewStd(errno.ErrInvalidJSONText).GenWithStackByArgs(sensitiveData)
require.Contains(t, err.Error(), genErrMsg(errno.MySQLErrName[errno.ErrInvalidJSONText].Raw, questionMark))
err = class.NewStd(errno.ErrTxnRetryable).GenWithStackByArgs(sensitiveData)
require.Contains(t, err.Error(), genErrMsg(errno.MySQLErrName[errno.ErrTxnRetryable].Raw, questionMark))
require.Contains(t, err.Error(), genErrMsg(errno.MySQLErrName[errno.ErrTxnRetryable].Raw, questionMark))
err = class.NewStd(errno.ErrIncorrectDatetimeValue).GenWithStackByArgs(sensitiveData)
require.Contains(t, err.Error(), genErrMsg(errno.MySQLErrName[errno.ErrIncorrectDatetimeValue].Raw, questionMark))
err = class.NewStd(errno.ErrInvalidTimeFormat).GenWithStackByArgs(sensitiveData)
require.Contains(t, err.Error(), genErrMsg(errno.MySQLErrName[errno.ErrInvalidTimeFormat].Raw, questionMark))
err = class.NewStd(errno.ErrRowNotFound).GenWithStackByArgs(sensitiveData)
require.Contains(t, err.Error(), genErrMsg(errno.MySQLErrName[errno.ErrRowNotFound].Raw, questionMark))
err = class.NewStd(errno.ErrWriteConflict).GenWithStackByArgs(noSensitiveValue, noSensitiveValue, noSensitiveValue, sensitiveData)
require.Contains(t, err.Error(), genErrMsg(errno.MySQLErrName[errno.ErrWriteConflict].Raw, noSensitiveValue, noSensitiveValue, noSensitiveValue, questionMark))
err = class.NewStd(errno.ErrRowInWrongPartition).GenWithStackByArgs(sensitiveData)
checkErrMsg(t, isMarker, err, errno.MySQLErrName[errno.ErrRowInWrongPartition].Raw, questionMark)
err = class.NewStd(errno.ErrInvalidJSONText).GenWithStackByArgs(sensitiveData)
checkErrMsg(t, isMarker, err, errno.MySQLErrName[errno.ErrInvalidJSONText].Raw, questionMark)
err = class.NewStd(errno.ErrTxnRetryable).GenWithStackByArgs(sensitiveData)
checkErrMsg(t, isMarker, err, errno.MySQLErrName[errno.ErrTxnRetryable].Raw, questionMark)
checkErrMsg(t, isMarker, err, errno.MySQLErrName[errno.ErrTxnRetryable].Raw, questionMark)
err = class.NewStd(errno.ErrIncorrectDatetimeValue).GenWithStackByArgs(sensitiveData)
checkErrMsg(t, isMarker, err, errno.MySQLErrName[errno.ErrIncorrectDatetimeValue].Raw, questionMark)
err = class.NewStd(errno.ErrInvalidTimeFormat).GenWithStackByArgs(sensitiveData)
checkErrMsg(t, isMarker, err, errno.MySQLErrName[errno.ErrInvalidTimeFormat].Raw, questionMark)
err = class.NewStd(errno.ErrRowNotFound).GenWithStackByArgs(sensitiveData)
checkErrMsg(t, isMarker, err, errno.MySQLErrName[errno.ErrRowNotFound].Raw, questionMark)
err = class.NewStd(errno.ErrWriteConflict).GenWithStackByArgs(noSensitiveValue, noSensitiveValue, noSensitiveValue, sensitiveData)
checkErrMsg(t, isMarker, err, errno.MySQLErrName[errno.ErrWriteConflict].Raw, noSensitiveValue, noSensitiveValue, noSensitiveValue, questionMark)
}
}

0 comments on commit 7a2f1cc

Please sign in to comment.