test: Integration test with mocked GitHub (#37)

* Extract organizationResource() to a function

* Test provisioning team membership

* Build out CRUD operations

* Mock graphQL

* Add a suite of tests for every resource

* lint

* fix tests

* go mod

Author: mgaeta

go.mod

@@ -5,11 +5,14 @@ go 1.21
 toolchain go1.22.3
 
 require (
-	github.com/conductorone/baton-sdk v0.2.7
+	github.com/conductorone/baton-sdk v0.2.8
+	github.com/deckarep/golang-set/v2 v2.6.0
 	github.com/google/go-github/v63 v63.0.0
 	github.com/grpc-ecosystem/go-grpc-middleware v1.4.0
+	github.com/migueleliasweb/go-github-mock v0.0.23
 	github.com/shurcooL/githubv4 v0.0.0-20240120211514-18a1ae0e79dc
 	github.com/spf13/viper v1.18.2
+	github.com/stretchr/testify v1.9.0
 	go.uber.org/zap v1.27.0
 	golang.org/x/oauth2 v0.20.0
 	golang.org/x/text v0.16.0
@@ -40,7 +43,7 @@ require (
 	github.com/aws/aws-sdk-go-v2/service/sts v1.28.6 // indirect
 	github.com/aws/smithy-go v1.20.2 // indirect
 	github.com/benbjohnson/clock v1.3.5 // indirect
-	github.com/deckarep/golang-set/v2 v2.6.0 // indirect
+	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
 	github.com/doug-martin/goqu/v9 v9.19.0 // indirect
 	github.com/dustin/go-humanize v1.0.1 // indirect
 	github.com/envoyproxy/protoc-gen-validate v1.0.4 // indirect
@@ -49,8 +52,10 @@ require (
 	github.com/go-jose/go-jose/v3 v3.0.3 // indirect
 	github.com/go-ole/go-ole v1.3.0 // indirect
 	github.com/golang/protobuf v1.5.4 // indirect
+	github.com/google/go-github/v59 v59.0.0 // indirect
 	github.com/google/go-querystring v1.1.0 // indirect
 	github.com/google/uuid v1.6.0 // indirect
+	github.com/gorilla/mux v1.8.0 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/jmespath/go-jmespath v0.4.0 // indirect
@@ -61,6 +66,7 @@ require (
 	github.com/mitchellh/mapstructure v1.5.0 // indirect
 	github.com/ncruces/go-strftime v0.1.9 // indirect
 	github.com/pelletier/go-toml/v2 v2.2.2 // indirect
+	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
 	github.com/power-devops/perfstat v0.0.0-20240221224432-82ca36839d55 // indirect
 	github.com/pquerna/xjwt v0.2.0 // indirect
 	github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec // indirect
@@ -88,6 +94,7 @@ require (
 	golang.org/x/net v0.26.0 // indirect
 	golang.org/x/sync v0.7.0 // indirect
 	golang.org/x/sys v0.21.0 // indirect
+	golang.org/x/time v0.5.0 // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20240506185236-b8a5c65736ae // indirect
 	gopkg.in/ini.v1 v1.67.0 // indirect
 	gopkg.in/square/go-jose.v2 v2.6.0 // indirect

go.sum

@@ -50,8 +50,8 @@ github.com/benbjohnson/clock v1.3.5/go.mod h1:J11/hYXuz8f4ySSvYwY0FKfm+ezbsZBKZx
 github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
 github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw=
 github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc=
-github.com/conductorone/baton-sdk v0.2.7 h1:mzp7H0zVeZLMvdGj3Yx31mpzM6ytNKI6QmpzRuiPlVE=
-github.com/conductorone/baton-sdk v0.2.7/go.mod h1:cg5FyUcJnD7xK5SPbHe/KNpwUVVlpHJ9rnmd3UwxSkU=
+github.com/conductorone/baton-sdk v0.2.8 h1:DLHTQXhl50A5AB0cbSoMOmzrUwwbpP7poCXI69Lcdtw=
+github.com/conductorone/baton-sdk v0.2.8/go.mod h1:cg5FyUcJnD7xK5SPbHe/KNpwUVVlpHJ9rnmd3UwxSkU=
 github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -105,6 +105,8 @@ github.com/google/go-cmp v0.5.6/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/
 github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
 github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/google/go-github/v59 v59.0.0 h1:7h6bgpF5as0YQLLkEiVqpgtJqjimMYhBkD4jT5aN3VA=
+github.com/google/go-github/v59 v59.0.0/go.mod h1:rJU4R0rQHFVFDOkqGWxfLNo6vEk4dv40oDjhV/gH6wM=
 github.com/google/go-github/v63 v63.0.0 h1:13xwK/wk9alSokujB9lJkuzdmQuVn2QCPeck76wR3nE=
 github.com/google/go-github/v63 v63.0.0/go.mod h1:IqbcrgUmIcEaioWrGYei/09o+ge5vhffGOcxrO0AfmA=
 github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8=
@@ -113,6 +115,8 @@ github.com/google/pprof v0.0.0-20240409012703-83162a5b38cd h1:gbpYu9NMq8jhDVbvlG
 github.com/google/pprof v0.0.0-20240409012703-83162a5b38cd/go.mod h1:kf6iHlnVGwgKolg33glAes7Yg/8iWP8ukqeldJSO7jw=
 github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
 github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI=
+github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So=
 github.com/grpc-ecosystem/go-grpc-middleware v1.4.0 h1:UH//fgunKIs4JdUbpDl1VZCDaL56wXCB/5+wF6uHfaI=
 github.com/grpc-ecosystem/go-grpc-middleware v1.4.0/go.mod h1:g5qyo/la0ALbONm6Vbp88Yd8NsDy6rZz+RcrMPxvld8=
 github.com/hashicorp/hcl v1.0.0 h1:0Anlzjpi4vEasTeNFn2mLJgTSwt0+6sfsiTG8qcWGx4=
@@ -146,6 +150,8 @@ github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWE
 github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
 github.com/mattn/go-sqlite3 v1.14.7 h1:fxWBnXkxfM6sRiuH3bqJ4CfzZojMOLVc0UTsTglEghA=
 github.com/mattn/go-sqlite3 v1.14.7/go.mod h1:NyWgC/yNuGj7Q9rpYnZvas74GogHl5/Z4A/KQRfk6bU=
+github.com/migueleliasweb/go-github-mock v0.0.23 h1:GOi9oX/+Seu9JQ19V8bPDLqDI7M9iEOjo3g8v1k6L2c=
+github.com/migueleliasweb/go-github-mock v0.0.23/go.mod h1:NsT8FGbkvIZQtDu38+295sZEX8snaUiiQgsGxi6GUxk=
 github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY=
 github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
 github.com/ncruces/go-strftime v0.1.9 h1:bY0MQC28UADQmHmaF5dgpLmImcShSi2kHU9XLdhx/f4=
@@ -335,6 +341,8 @@ golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
 golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
 golang.org/x/text v0.16.0 h1:a94ExnEXNtEwYLGJSIUxnWoxoRz/ZcCsV63ROupILh4=
 golang.org/x/text v0.16.0/go.mod h1:GhwF1Be+LQoKShO3cGOHzqOgRrGaYc9AvblQOmPVHnI=
+golang.org/x/time v0.5.0 h1:o7cqy6amK/52YcAKIPlM3a+Fpj35zvRj2TP+e1xFSfk=
+golang.org/x/time v0.5.0/go.mod h1:3BpzKBy/shNhVucY/MWOyx10tF3SFh9QdLuxbVysPQM=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
 golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
 golang.org/x/tools v0.0.0-20190226205152-f727befe758c/go.mod h1:9Yl7xja0Znq3iFh3HoIrodX9oNMXvdceNzlUR8zjMvY=

pkg/connector/org.go

@@ -36,6 +36,26 @@ type orgResourceType struct {
 	orgCache     *orgNameCache
 }
 
+func organizationResource(
+	ctx context.Context,
+	org *github.Organization,
+	parentResourceID *v2.ResourceId,
+) (*v2.Resource, error) {
+	return resource.NewResource(
+		org.GetLogin(),
+		resourceTypeOrg,
+		org.GetID(),
+		resource.WithParentResourceID(parentResourceID),
+		resource.WithAnnotation(
+			&v2.ExternalLink{Url: org.GetHTMLURL()},
+			&v2.V1Identifier{Id: fmt.Sprintf("org:%d", org.GetID())},
+			&v2.ChildResourceType{ResourceTypeId: resourceTypeUser.Id},
+			&v2.ChildResourceType{ResourceTypeId: resourceTypeTeam.Id},
+			&v2.ChildResourceType{ResourceTypeId: resourceTypeRepository.Id},
+		),
+	)
+}
+
 func (o *orgResourceType) ResourceType(_ context.Context) *v2.ResourceType {
 	return o.resourceType
 }
@@ -91,19 +111,7 @@ func (o *orgResourceType) List(
 			continue
 		}
 
-		orgResource, err := resource.NewResource(
-			org.GetLogin(),
-			resourceTypeOrg,
-			org.GetID(),
-			resource.WithParentResourceID(parentResourceID),
-			resource.WithAnnotation(
-				&v2.ExternalLink{Url: org.GetHTMLURL()},
-				&v2.V1Identifier{Id: fmt.Sprintf("org:%d", org.GetID())},
-				&v2.ChildResourceType{ResourceTypeId: resourceTypeUser.Id},
-				&v2.ChildResourceType{ResourceTypeId: resourceTypeTeam.Id},
-				&v2.ChildResourceType{ResourceTypeId: resourceTypeRepository.Id},
-			),
-		)
+		orgResource, err := organizationResource(ctx, org, parentResourceID)
 		if err != nil {
 			return nil, "", nil, err
 		}

pkg/connector/org_test.go

@@ -0,0 +1,55 @@
+package connector
+
+import (
+	"context"
+	"testing"
+
+	"github.com/conductorone/baton-github/test"
+	"github.com/conductorone/baton-github/test/mocks"
+	v2 "github.com/conductorone/baton-sdk/pb/c1/connector/v2"
+	"github.com/conductorone/baton-sdk/pkg/pagination"
+	"github.com/conductorone/baton-sdk/pkg/types/entitlement"
+	"github.com/google/go-github/v63/github"
+	"github.com/stretchr/testify/require"
+)
+
+func TestOrganization(t *testing.T) {
+	ctx := context.Background()
+
+	t.Run("should grant and revoke entitlements", func(t *testing.T) {
+		mgh := mocks.NewMockGitHub()
+
+		githubOrganization, _, _, githubUser, _ := mgh.Seed()
+
+		githubClient := github.NewClient(mgh.Server())
+		cache := newOrgNameCache(githubClient)
+		client := orgBuilder(githubClient, cache, nil)
+
+		organization, _ := organizationResource(ctx, githubOrganization, nil)
+		user, _ := userResource(ctx, githubUser, *githubUser.Email, nil)
+
+		entitlement := v2.Entitlement{
+			Id:       entitlement.NewEntitlementID(organization, orgRoleMember),
+			Resource: organization,
+		}
+
+		grantAnnotations, err := client.Grant(ctx, user, &entitlement)
+		require.Nil(t, err)
+		require.Empty(t, grantAnnotations)
+
+		grants, nextToken, grantsAnnotations, err := client.Grants(ctx, organization, &pagination.Token{})
+		require.Nil(t, err)
+		test.AssertNoRatelimitAnnotations(t, grantsAnnotations)
+		require.Equal(t, "", nextToken)
+		require.Len(t, grants, 2)
+
+		grant := v2.Grant{
+			Entitlement: &entitlement,
+			Principal:   user,
+		}
+
+		revokeAnnotations, err := client.Revoke(ctx, &grant)
+		require.Nil(t, err)
+		require.Empty(t, revokeAnnotations)
+	})
+}

pkg/connector/repository_test.go

@@ -0,0 +1,73 @@
+package connector
+
+import (
+	"context"
+	"testing"
+
+	"github.com/conductorone/baton-github/test"
+	"github.com/conductorone/baton-github/test/mocks"
+	v2 "github.com/conductorone/baton-sdk/pb/c1/connector/v2"
+	"github.com/conductorone/baton-sdk/pkg/pagination"
+	"github.com/google/go-github/v63/github"
+	"github.com/stretchr/testify/require"
+)
+
+func TestRepository(t *testing.T) {
+	ctx := context.Background()
+
+	t.Run("should grant and revoke entitlements", func(t *testing.T) {
+		mgh := mocks.NewMockGitHub()
+
+		githubOrganization, githubRepository, _, githubUser, _ := mgh.Seed()
+
+		githubClient := github.NewClient(mgh.Server())
+		cache := newOrgNameCache(githubClient)
+		client := repositoryBuilder(githubClient, cache)
+
+		organization, _ := organizationResource(ctx, githubOrganization, nil)
+		repository, _ := repositoryResource(ctx, githubRepository, organization.Id)
+		user, _ := userResource(ctx, githubUser, *githubUser.Email, nil)
+
+		entitlement := v2.Entitlement{Resource: repository}
+
+		grantAnnotations, err := client.Grant(ctx, user, &entitlement)
+		require.Nil(t, err)
+		require.Empty(t, grantAnnotations)
+
+		grants := make([]*v2.Grant, 0)
+		bag := &pagination.Bag{}
+		for {
+			pToken := pagination.Token{}
+			state := bag.Current()
+			if state != nil {
+				token, _ := bag.Marshal()
+				pToken.Token = token
+			}
+
+			nextGrants, nextToken, grantsAnnotations, err := client.Grants(ctx, repository, &pToken)
+			grants = append(grants, nextGrants...)
+
+			require.Nil(t, err)
+			test.AssertNoRatelimitAnnotations(t, grantsAnnotations)
+			if nextToken == "" {
+				break
+			}
+
+			err = bag.Unmarshal(nextToken)
+			if err != nil {
+				t.Error(err)
+			}
+		}
+
+		require.Len(t, grants, 1)
+
+		grant := v2.Grant{
+			Entitlement: &entitlement,
+			Principal:   user,
+		}
+
+		revokeAnnotations, err := client.Revoke(ctx, &grant)
+		require.Nil(t, err)
+		require.Empty(t, revokeAnnotations)
+	})
+}

pkg/connector/team_test.go

@@ -0,0 +1,52 @@
+package connector
+
+import (
+	"context"
+	"testing"
+
+	"github.com/conductorone/baton-github/test"
+	"github.com/conductorone/baton-github/test/mocks"
+	v2 "github.com/conductorone/baton-sdk/pb/c1/connector/v2"
+	"github.com/conductorone/baton-sdk/pkg/pagination"
+	"github.com/google/go-github/v63/github"
+	"github.com/stretchr/testify/require"
+)
+
+func TestTeam(t *testing.T) {
+	ctx := context.Background()
+
+	t.Run("should grant and revoke entitlements", func(t *testing.T) {
+		mgh := mocks.NewMockGitHub()
+
+		githubOrganization, _, githubTeam, githubUser, _ := mgh.Seed()
+
+		githubClient := github.NewClient(mgh.Server())
+		cache := newOrgNameCache(githubClient)
+		client := teamBuilder(githubClient, cache)
+
+		organization, _ := organizationResource(ctx, githubOrganization, nil)
+		team, _ := teamResource(githubTeam, organization.Id)
+		user, _ := userResource(ctx, githubUser, *githubUser.Email, nil)
+
+		entitlement := v2.Entitlement{Resource: team}
+
+		grantAnnotations, err := client.Grant(ctx, user, &entitlement)
+		require.Nil(t, err)
+		require.Empty(t, grantAnnotations)
+
+		grants, nextToken, grantsAnnotations, err := client.Grants(ctx, team, &pagination.Token{})
+		require.Nil(t, err)
+		test.AssertNoRatelimitAnnotations(t, grantsAnnotations)
+		require.Equal(t, "", nextToken)
+		require.Len(t, grants, 1)
+
+		grant := v2.Grant{
+			Entitlement: &entitlement,
+			Principal:   user,
+		}
+
+		revokeAnnotations, err := client.Revoke(ctx, &grant)
+		require.Nil(t, err)
+		require.Empty(t, revokeAnnotations)
+	})
+}

pkg/connector/user_test.go

@@ -0,0 +1,65 @@
+package connector
+
+import (
+	"context"
+	"fmt"
+	"testing"
+
+	"github.com/conductorone/baton-github/test"
+	"github.com/conductorone/baton-github/test/mocks"
+	"github.com/conductorone/baton-sdk/pkg/pagination"
+	"github.com/google/go-github/v63/github"
+	"github.com/stretchr/testify/require"
+)
+
+func TestUsersList(t *testing.T) {
+	ctx := context.Background()
+
+	trueBool, falseBool := true, false
+
+	testCases := []struct {
+		hasSamlEnabled *bool
+		message        string
+	}{
+		{&trueBool, "true"},
+		{&falseBool, "false"},
+		{nil, "nil"},
+	}
+	for _, testCase := range testCases {
+		t.Run(fmt.Sprintf("should get a list of users (SAML:%s)", testCase.message), func(t *testing.T) {
+			mgh := mocks.NewMockGitHub()
+
+			githubOrganization, _, _, githubUser, _ := mgh.Seed()
+
+			organization, err := organizationResource(
+				ctx,
+				githubOrganization,
+				nil,
+			)
+			if err != nil {
+				t.Error(err)
+			}
+
+			githubClient := github.NewClient(mgh.Server())
+			graphQLClient := mocks.MockGraphQL()
+			cache := newOrgNameCache(githubClient)
+			client := userBuilder(
+				githubClient,
+				testCase.hasSamlEnabled,
+				graphQLClient,
+				cache,
+			)
+
+			users, nextToken, annotations, err := client.List(
+				ctx,
+				organization.Id,
+				&pagination.Token{},
+			)
+			require.Nil(t, err)
+			test.AssertNoRatelimitAnnotations(t, annotations)
+			require.Equal(t, "", nextToken)
+			require.Len(t, users, 1)
+			require.Equal(t, *githubUser.Login, users[0].Id.Resource)
+		})
+	}
+}