driftctl/pkg/remote/github_team_scanner_test.go

121 lines
4.0 KiB
Go

package remote
import (
"errors"
"testing"
"github.com/snyk/driftctl/mocks"
"github.com/snyk/driftctl/pkg/filter"
"github.com/snyk/driftctl/pkg/remote/alerts"
"github.com/snyk/driftctl/pkg/remote/cache"
"github.com/snyk/driftctl/pkg/remote/common"
remoteerr "github.com/snyk/driftctl/pkg/remote/error"
"github.com/snyk/driftctl/pkg/remote/github"
githubres "github.com/snyk/driftctl/pkg/resource/github"
"github.com/snyk/driftctl/pkg/terraform"
testresource "github.com/snyk/driftctl/test/resource"
tftest "github.com/snyk/driftctl/test/terraform"
"github.com/stretchr/testify/mock"
"github.com/snyk/driftctl/pkg/resource"
"github.com/snyk/driftctl/test"
"github.com/snyk/driftctl/test/goldenfile"
"github.com/stretchr/testify/assert"
)
func TestScanGithubTeam(t *testing.T) {
tests := []struct {
test string
dirName string
mocks func(*github.MockGithubRepository, *mocks.AlerterInterface)
err error
}{
{
test: "no github teams",
dirName: "github_teams_empty",
mocks: func(client *github.MockGithubRepository, alerter *mocks.AlerterInterface) {
client.On("ListTeams").Return([]github.Team{}, nil)
},
err: nil,
},
{
test: "Multiple github teams with parent",
dirName: "github_teams_multiple",
mocks: func(client *github.MockGithubRepository, alerter *mocks.AlerterInterface) {
client.On("ListTeams").Return([]github.Team{
{DatabaseId: 4556811}, // github_team.team1
{DatabaseId: 4556812}, // github_team.team2
{DatabaseId: 4556814}, // github_team.with_parent
}, nil)
},
err: nil,
},
{
test: "cannot list teams",
dirName: "github_teams_empty",
mocks: func(client *github.MockGithubRepository, alerter *mocks.AlerterInterface) {
client.On("ListTeams").Return(nil, errors.New("Your token has not been granted the required scopes to execute this query."))
alerter.On("SendAlert", githubres.GithubTeamResourceType, alerts.NewRemoteAccessDeniedAlert(common.RemoteGithubTerraform, remoteerr.NewResourceListingErrorWithType(errors.New("Your token has not been granted the required scopes to execute this query."), githubres.GithubTeamResourceType, githubres.GithubTeamResourceType), alerts.EnumerationPhase)).Return()
},
err: nil,
},
}
schemaRepository := testresource.InitFakeSchemaRepository("github", "4.4.0")
githubres.InitResourcesMetadata(schemaRepository)
factory := terraform.NewTerraformResourceFactory(schemaRepository)
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 := terraform.NewProviderLibrary()
remoteLibrary := common.NewRemoteLibrary()
// Initialize mocks
alerter := &mocks.AlerterInterface{}
mockedRepo := github.MockGithubRepository{}
c.mocks(&mockedRepo, alerter)
var repo github.GithubRepository = &mockedRepo
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 = github.NewGithubRepository(realProvider.GetConfig(), cache.New(0))
}
remoteLibrary.AddEnumerator(github.NewGithubTeamEnumerator(repo, factory))
remoteLibrary.AddDetailsFetcher(githubres.GithubTeamResourceType, common.NewGenericDetailsFetcher(githubres.GithubTeamResourceType, provider, deserializer))
testFilter := &filter.MockFilter{}
testFilter.On("IsTypeIgnored", mock.Anything).Return(false)
s := NewScanner(remoteLibrary, alerter, scanOptions, testFilter)
got, err := s.Resources()
assert.Equal(tt, err, c.err)
if err != nil {
return
}
test.TestAgainstGoldenFile(got, githubres.GithubTeamResourceType, c.dirName, provider, deserializer, shouldUpdate, tt)
mockedRepo.AssertExpectations(tt)
alerter.AssertExpectations(tt)
})
}
}