mirror of
https://github.com/trufflesecurity/trufflehog.git
synced 2026-06-15 13:24:37 +00:00
* implement analyzer interface for sourcegraph * created permission for sourcegraph test for sourcegraph. added email in resource metadata. * handling of missing keys in map * linked sourcegraph detector to analyzer * update the fullyqualidied name of resource to make it unique. updated the test. * add current user email in metadata --------- Co-authored-by: Abdul Basit <abasit@folio3.com>
104 lines
2.7 KiB
Go
104 lines
2.7 KiB
Go
package sourcegraph
|
|
|
|
import (
|
|
"encoding/json"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/trufflesecurity/trufflehog/v3/pkg/analyzer/analyzers"
|
|
"github.com/trufflesecurity/trufflehog/v3/pkg/analyzer/config"
|
|
"github.com/trufflesecurity/trufflehog/v3/pkg/common"
|
|
"github.com/trufflesecurity/trufflehog/v3/pkg/context"
|
|
)
|
|
|
|
func TestAnalyzer_Analyze(t *testing.T) {
|
|
ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)
|
|
defer cancel()
|
|
testSecrets, err := common.GetSecret(ctx, "trufflehog-testing", "detectors4")
|
|
if err != nil {
|
|
t.Fatalf("could not get test secrets from GCP: %s", err)
|
|
}
|
|
|
|
secret := testSecrets.MustGetField("SOURCEGRAPH")
|
|
|
|
tests := []struct {
|
|
name string
|
|
key string
|
|
want string // JSON string
|
|
wantErr bool
|
|
}{
|
|
{
|
|
name: "valid SourceGraph key",
|
|
key: secret,
|
|
want: `{
|
|
"AnalyzerType": 17,
|
|
"Bindings": [
|
|
{
|
|
"Resource": {
|
|
"Name": "ahrav",
|
|
"FullyQualifiedName": "sourcegraph/ahravdutta02@gmail.com",
|
|
"Type": "user",
|
|
"Metadata": {
|
|
"created_at": "2023-07-23T04:16:31Z",
|
|
"email": "ahravdutta02@gmail.com"
|
|
},
|
|
"Parent": null
|
|
},
|
|
"Permission": {
|
|
"Value": "user:read",
|
|
"Parent": null
|
|
}
|
|
}
|
|
],
|
|
"UnboundedResources": null,
|
|
"Metadata": null
|
|
}`,
|
|
wantErr: false,
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
a := Analyzer{Cfg: &config.Config{}}
|
|
got, err := a.Analyze(ctx, map[string]string{"key": tt.key})
|
|
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([]byte(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 the JSON strings
|
|
if string(gotJSON) != string(wantJSON) {
|
|
// Pretty-print both JSON strings for easier comparison
|
|
var gotIndented, wantIndented []byte
|
|
gotIndented, err = json.MarshalIndent(got, "", " ")
|
|
if err != nil {
|
|
t.Fatalf("could not marshal got to indented JSON: %s", err)
|
|
}
|
|
wantIndented, err = json.MarshalIndent(wantObj, "", " ")
|
|
if err != nil {
|
|
t.Fatalf("could not marshal want to indented JSON: %s", err)
|
|
}
|
|
t.Errorf("Analyzer.Analyze() = %s, want %s", gotIndented, wantIndented)
|
|
}
|
|
})
|
|
}
|
|
}
|