driftctl/enumeration/remote/github_repository_scanner_t...

122 lines
4.1 KiB
Go
Raw Normal View History

2021-07-02 13:55:38 +00:00
package remote
import (
2021-08-20 13:15:51 +00:00
"errors"
2021-07-02 13:55:38 +00:00
"testing"
"github.com/snyk/driftctl/enumeration"
"github.com/snyk/driftctl/enumeration/remote/alerts"
"github.com/snyk/driftctl/enumeration/remote/cache"
common2 "github.com/snyk/driftctl/enumeration/remote/common"
remoteerr "github.com/snyk/driftctl/enumeration/remote/error"
github2 "github.com/snyk/driftctl/enumeration/remote/github"
terraform2 "github.com/snyk/driftctl/enumeration/terraform"
githubres "github.com/snyk/driftctl/enumeration/resource/github"
2021-12-06 13:29:39 +00:00
"github.com/snyk/driftctl/mocks"
2021-12-06 13:29:39 +00:00
testresource "github.com/snyk/driftctl/test/resource"
tftest "github.com/snyk/driftctl/test/terraform"
2021-07-26 09:55:59 +00:00
"github.com/stretchr/testify/mock"
2021-07-02 13:55:38 +00:00
"github.com/snyk/driftctl/enumeration/resource"
2021-12-06 13:29:39 +00:00
"github.com/snyk/driftctl/test"
"github.com/snyk/driftctl/test/goldenfile"
2021-07-02 13:55:38 +00:00
"github.com/stretchr/testify/assert"
)
func TestScanGithubRepository(t *testing.T) {
tests := []struct {
test string
dirName string
mocks func(*github2.MockGithubRepository, *mocks.AlerterInterface)
2021-07-02 13:55:38 +00:00
err error
}{
{
test: "no github repos",
dirName: "github_repository_empty",
mocks: func(client *github2.MockGithubRepository, alerter *mocks.AlerterInterface) {
2021-07-02 13:55:38 +00:00
client.On("ListRepositories").Return([]string{}, nil)
},
err: nil,
},
{
test: "Multiple github repos Table",
dirName: "github_repository_multiple",
mocks: func(client *github2.MockGithubRepository, alerter *mocks.AlerterInterface) {
2021-07-02 13:55:38 +00:00
client.On("ListRepositories").Return([]string{
"driftctl",
"driftctl-demos",
}, nil)
},
err: nil,
},
2021-08-20 13:15:51 +00:00
{
test: "cannot list repositories",
dirName: "github_repository_empty",
mocks: func(client *github2.MockGithubRepository, alerter *mocks.AlerterInterface) {
2021-08-20 13:15:51 +00:00
client.On("ListRepositories").Return(nil, errors.New("Your token has not been granted the required scopes to execute this query."))
alerter.On("SendAlert", githubres.GithubRepositoryResourceType, alerts.NewRemoteAccessDeniedAlert(common2.RemoteGithubTerraform, remoteerr.NewResourceListingErrorWithType(errors.New("Your token has not been granted the required scopes to execute this query."), githubres.GithubRepositoryResourceType, githubres.GithubRepositoryResourceType), alerts.EnumerationPhase)).Return()
2021-08-20 13:15:51 +00:00
},
err: nil,
},
2021-07-02 13:55:38 +00:00
}
schemaRepository := testresource.InitFakeSchemaRepository("github", "4.4.0")
githubres.InitResourcesMetadata(schemaRepository)
factory := terraform2.NewTerraformResourceFactory(schemaRepository)
2021-07-02 13:55:38 +00:00
deserializer := resource.NewDeserializer(factory)
for _, c := range tests {
t.Run(c.test, func(tt *testing.T) {
shouldUpdate := c.dirName == *goldenfile.Update
scanOptions := ScannerOptions{Deep: true}
providerLibrary := terraform2.NewProviderLibrary()
remoteLibrary := common2.NewRemoteLibrary()
2021-07-02 13:55:38 +00:00
2021-08-20 13:15:51 +00:00
// Initialize mocks
alerter := &mocks.AlerterInterface{}
mockedRepo := github2.MockGithubRepository{}
2021-08-20 13:15:51 +00:00
c.mocks(&mockedRepo, alerter)
var repo github2.GithubRepository = &mockedRepo
2021-07-02 13:55:38 +00:00
realProvider, err := tftest.InitTestGithubProvider(providerLibrary, "4.4.0")
if err != nil {
t.Fatal(err)
}
provider := tftest.NewFakeTerraformProvider(realProvider)
provider.WithResponse(c.dirName)
if shouldUpdate {
err := realProvider.Init()
if err != nil {
t.Fatal(err)
}
provider.ShouldUpdate()
repo = github2.NewGithubRepository(realProvider.GetConfig(), cache.New(0))
2021-07-02 13:55:38 +00:00
}
remoteLibrary.AddEnumerator(github2.NewGithubRepositoryEnumerator(repo, factory))
remoteLibrary.AddDetailsFetcher(githubres.GithubRepositoryResourceType, common2.NewGenericDetailsFetcher(githubres.GithubRepositoryResourceType, provider, deserializer))
2021-07-02 13:55:38 +00:00
testFilter := &enumeration.MockFilter{}
2021-07-26 09:55:59 +00:00
testFilter.On("IsTypeIgnored", mock.Anything).Return(false)
s := NewScanner(remoteLibrary, alerter, scanOptions, testFilter)
2021-07-02 13:55:38 +00:00
got, err := s.Resources()
assert.Equal(tt, err, c.err)
if err != nil {
return
}
test.TestAgainstGoldenFile(got, githubres.GithubRepositoryResourceType, c.dirName, provider, deserializer, shouldUpdate, tt)
2021-08-20 13:15:51 +00:00
mockedRepo.AssertExpectations(tt)
alerter.AssertExpectations(tt)
2021-07-02 13:55:38 +00:00
})
}
}