* implement analyzer interface for mysql * add integration test for mysql analyzer * linked detectors with analyzers for jdbc and mysql validation for connection string in analyzer * refactored secretInfoToAnalyzerResult func * generated permissions for mysql analyzer * [chore] - optimization in execution flow - use test-container library for analyze test. * added host in secret info struct simplified the mysql test due to huge structure --------- Co-authored-by: Abdul Basit <[email protected]>
105 lines
2.6 KiB
Go
105 lines
2.6 KiB
Go
package mysql
|
|
|
|
import (
|
|
_ "embed"
|
|
"encoding/json"
|
|
"fmt"
|
|
"testing"
|
|
|
|
"github.com/brianvoe/gofakeit/v7"
|
|
"github.com/google/go-cmp/cmp"
|
|
"github.com/testcontainers/testcontainers-go/modules/mysql"
|
|
"github.com/trufflesecurity/trufflehog/v3/pkg/analyzer/analyzers"
|
|
"github.com/trufflesecurity/trufflehog/v3/pkg/analyzer/config"
|
|
"github.com/trufflesecurity/trufflehog/v3/pkg/context"
|
|
)
|
|
|
|
//go:embed expected_output.json
|
|
var expectedOutput []byte
|
|
|
|
func TestAnalyzer_Analyze(t *testing.T) {
|
|
mysqlUser := "root"
|
|
mysqlPass := gofakeit.Password(true, true, true, false, false, 10)
|
|
mysqlDatabase := "mysql"
|
|
|
|
ctx := context.Background()
|
|
|
|
mysqlC, err := mysql.Run(ctx, "mysql",
|
|
mysql.WithDatabase(mysqlDatabase),
|
|
mysql.WithUsername(mysqlUser),
|
|
mysql.WithPassword(mysqlPass),
|
|
)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
defer func() { _ = mysqlC.Terminate(ctx) }()
|
|
|
|
host, err := mysqlC.Host(ctx)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
port, err := mysqlC.MappedPort(ctx, "3306")
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
tests := []struct {
|
|
name string
|
|
connectionString string
|
|
want []byte // JSON string
|
|
wantErr bool
|
|
}{
|
|
{
|
|
name: "valid Mysql connection",
|
|
connectionString: fmt.Sprintf(`root:%s@%s:%s/%s`, mysqlPass, host, port.Port(), mysqlDatabase),
|
|
want: expectedOutput,
|
|
wantErr: false,
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
a := Analyzer{Cfg: &config.Config{}}
|
|
got, err := a.Analyze(context.Background(), map[string]string{"connection_string": tt.connectionString})
|
|
if (err != nil) != tt.wantErr {
|
|
t.Errorf("Analyzer.Analyze() error = %v, wantErr %v", err, tt.wantErr)
|
|
return
|
|
}
|
|
|
|
// Marshal the actual result to JSON
|
|
gotJSON, err := json.Marshal(got)
|
|
if err != nil {
|
|
t.Fatalf("could not marshal got to JSON: %s", err)
|
|
}
|
|
|
|
// Parse the expected JSON string
|
|
var wantObj analyzers.AnalyzerResult
|
|
if err := json.Unmarshal(tt.want, &wantObj); err != nil {
|
|
t.Fatalf("could not unmarshal want JSON string: %s", err)
|
|
}
|
|
|
|
// Marshal the expected result to JSON (to normalize)
|
|
wantJSON, err := json.Marshal(wantObj)
|
|
if err != nil {
|
|
t.Fatalf("could not marshal want to JSON: %s", err)
|
|
}
|
|
|
|
// Compare bindings separately because they are not guaranteed to be in the same order
|
|
if len(got.Bindings) != len(wantObj.Bindings) {
|
|
t.Errorf("Analyzer.Analyze() = %s, want %s", gotJSON, wantJSON)
|
|
return
|
|
}
|
|
|
|
got.Bindings = nil
|
|
wantObj.Bindings = nil
|
|
|
|
// Compare the rest of the Object
|
|
if diff := cmp.Diff(&wantObj, got); diff != "" {
|
|
t.Errorf("%s: (-want +got)\n%s", tt.name, diff)
|
|
return
|
|
}
|
|
})
|
|
}
|
|
}
|