|
| 1 | +package scan |
| 2 | + |
| 3 | +import ( |
| 4 | + "bytes" |
| 5 | + "context" |
| 6 | + "crypto/sha1" |
| 7 | + "encoding/json" |
| 8 | + "fmt" |
| 9 | + "os" |
| 10 | + "testing" |
| 11 | + |
| 12 | + "github.com/brianvoe/gofakeit/v6" |
| 13 | + "github.com/golang/mock/gomock" |
| 14 | + "github.com/google/uuid" |
| 15 | + mockarchiver "github.com/guardrailsio/guardrails-cli/internal/archiver/mock" |
| 16 | + grclient "github.com/guardrailsio/guardrails-cli/internal/client/guardrails" |
| 17 | + mockgrclient "github.com/guardrailsio/guardrails-cli/internal/client/guardrails/mock" |
| 18 | + "github.com/guardrailsio/guardrails-cli/internal/config" |
| 19 | + "github.com/guardrailsio/guardrails-cli/internal/repository" |
| 20 | + mockrepository "github.com/guardrailsio/guardrails-cli/internal/repository/mock" |
| 21 | + "github.com/guardrailsio/guardrails-cli/internal/tools/spinner" |
| 22 | + "github.com/stretchr/testify/assert" |
| 23 | + "github.com/stretchr/testify/require" |
| 24 | +) |
| 25 | + |
| 26 | +func TestScanCommandExecuteSuccess(t *testing.T) { |
| 27 | + ctx := context.Background() |
| 28 | + args := &Args{ |
| 29 | + Token: "test-token", |
| 30 | + Path: "/var/www/guardrails-cli", |
| 31 | + Format: "pretty", |
| 32 | + Output: "", |
| 33 | + Quiet: true, |
| 34 | + } |
| 35 | + cfg := config.New() |
| 36 | + spinner := spinner.New() |
| 37 | + |
| 38 | + mockCtrl := gomock.NewController(t) |
| 39 | + defer mockCtrl.Finish() |
| 40 | + |
| 41 | + mockRepo := mockrepository.NewMockRepository(mockCtrl) |
| 42 | + mockArc := mockarchiver.NewMockArchiver(mockCtrl) |
| 43 | + mockGrClient := mockgrclient.NewMockGuardRailsClient(mockCtrl) |
| 44 | + |
| 45 | + commitMessage := gofakeit.Sentence(5) |
| 46 | + sha := sha1.New() |
| 47 | + sha.Write([]byte(commitMessage)) |
| 48 | + encrypted := sha.Sum(nil) |
| 49 | + commitHash := fmt.Sprintf("%x", encrypted) |
| 50 | + |
| 51 | + repoMetadata := &repository.Metadata{ |
| 52 | + Path: args.Path, |
| 53 | + Protocol: "https", |
| 54 | + Provider: "github", |
| 55 | + Name: gofakeit.AppName(), |
| 56 | + Branch: gofakeit.Word(), |
| 57 | + CommitHash: commitHash, |
| 58 | + } |
| 59 | + listOfFiles := []string{ |
| 60 | + ".gitignore", |
| 61 | + "LICENSE", |
| 62 | + "Makefile", |
| 63 | + "README.md", |
| 64 | + "bin/.gitignore", |
| 65 | + "cmd/common.go", |
| 66 | + "cmd/root.go", |
| 67 | + "cmd/scan.go", |
| 68 | + "etc/run-test.sh", |
| 69 | + "go.mod", |
| 70 | + "go.sum", |
| 71 | + "internal/archiver/archiver.go", |
| 72 | + "internal/archiver/mock/archiver.go", |
| 73 | + "internal/client/client.go", |
| 74 | + "internal/client/errors.go", |
| 75 | + "internal/client/guardrails/client.go", |
| 76 | + "internal/client/guardrails/message.go", |
| 77 | + "internal/client/guardrails/mock/client.go", |
| 78 | + "internal/command/scan/args.go", |
| 79 | + "internal/command/scan/handler.go", |
| 80 | + "internal/command/scan/message.go", |
| 81 | + "internal/config/config.go", |
| 82 | + "internal/formatter/csv/csv.go", |
| 83 | + "internal/formatter/json/json.go", |
| 84 | + "internal/formatter/pretty/pretty.go", |
| 85 | + "internal/formatter/sarif/sarif.go", |
| 86 | + "internal/outputter/outputter.go", |
| 87 | + "internal/repository/ignorelist.go", |
| 88 | + "internal/repository/mock/repository.go", |
| 89 | + "internal/repository/repository.go", |
| 90 | + "internal/tools/spinner/spinner.go", |
| 91 | + "main.go", |
| 92 | + } |
| 93 | + fileZipName := fmt.Sprintf("%s.zip", repoMetadata.Name) |
| 94 | + fileZipByte := bytes.NewReader([]byte{}) |
| 95 | + createUploadURLReq := &grclient.CreateUploadURLReq{ |
| 96 | + File: fileZipName, |
| 97 | + } |
| 98 | + createUploadURLResp := &grclient.CreateUploadURLResp{ |
| 99 | + SignedURL: gofakeit.URL(), |
| 100 | + } |
| 101 | + uploadProjectReq := &grclient.UploadProjectReq{ |
| 102 | + UploadURL: createUploadURLResp.SignedURL, |
| 103 | + File: fileZipByte, |
| 104 | + } |
| 105 | + triggerScanReq := &grclient.TriggerScanReq{ |
| 106 | + Repository: repoMetadata.Name, |
| 107 | + SHA: repoMetadata.CommitHash, |
| 108 | + Branch: repoMetadata.Branch, |
| 109 | + FileName: fileZipName, |
| 110 | + } |
| 111 | + triggerScanResp := &grclient.TriggerScanResp{ |
| 112 | + ScanID: uuid.New().String(), |
| 113 | + DashboardURL: gofakeit.URL(), |
| 114 | + } |
| 115 | + getScanDataReq := &grclient.GetScanDataReq{ |
| 116 | + ScanID: triggerScanResp.ScanID, |
| 117 | + } |
| 118 | + |
| 119 | + file, err := os.Open("../../client/guardrails/mock/get_scan_data.json") |
| 120 | + require.NoError(t, err) |
| 121 | + defer file.Close() |
| 122 | + |
| 123 | + getScanDataResp := new(grclient.GetScanDataResp) |
| 124 | + err = json.NewDecoder(file).Decode(getScanDataResp) |
| 125 | + require.NoError(t, err) |
| 126 | + |
| 127 | + gomock.InOrder( |
| 128 | + mockRepo.EXPECT().GetMetadataFromRemoteURL().Return(repoMetadata, nil), |
| 129 | + mockRepo.EXPECT().ListFiles().Return(listOfFiles, nil), |
| 130 | + mockArc.EXPECT().OutputZipToIOReader(repoMetadata.Path, listOfFiles).Return(fileZipByte, nil), |
| 131 | + mockGrClient.EXPECT().CreateUploadURL(ctx, createUploadURLReq).Return(createUploadURLResp, nil), |
| 132 | + mockGrClient.EXPECT().UploadProject(ctx, uploadProjectReq).Return(nil), |
| 133 | + mockGrClient.EXPECT().TriggerScan(ctx, triggerScanReq).Return(triggerScanResp, nil), |
| 134 | + mockGrClient.EXPECT().GetScanData(ctx, getScanDataReq).Return(getScanDataResp, nil), |
| 135 | + ) |
| 136 | + |
| 137 | + cmd := New(args, spinner, cfg, mockRepo, mockArc, mockGrClient) |
| 138 | + err = cmd.Execute(ctx) |
| 139 | + assert.Nil(t, err) |
| 140 | +} |
0 commit comments