Skip to content

[v10] improve semaphore retries and tests #14475

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fspmarshall merged 2 commits into from
Jul 29, 2022
Merged

[v10] improve semaphore retries and tests #14475

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eec189f
Refactor tests under services package.
russjones Jul 6, 2022
88e0d9a
improve semaphore retries and tests
fspmarshall Jul 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 65 additions & 51 deletions lib/auth/github_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,96 +33,107 @@ import (

"github.com/gravitational/trace"

"github.com/google/go-cmp/cmp"
"github.com/google/uuid"
"github.com/jonboulle/clockwork"
"gopkg.in/check.v1"
)

func TestAPI(t *testing.T) { check.TestingT(t) }

type GithubSuite struct {
type githubContext struct {
a *Server
mockEmitter *eventstest.MockEmitter
b backend.Backend
c clockwork.FakeClock
}

var _ = check.Suite(&GithubSuite{})
func setupGithubContext(ctx context.Context, t *testing.T) *githubContext {
var tt githubContext
t.Cleanup(func() { tt.Close() })

func (s *GithubSuite) SetUpSuite(c *check.C) {
s.c = clockwork.NewFakeClockAt(time.Now())
tt.c = clockwork.NewFakeClockAt(time.Now())

var err error
s.b, err = lite.NewWithConfig(context.Background(), lite.Config{
Path: c.MkDir(),
tt.b, err = lite.NewWithConfig(context.Background(), lite.Config{
Path: t.TempDir(),
PollStreamPeriod: 200 * time.Millisecond,
Clock: s.c,
Clock: tt.c,
})
c.Assert(err, check.IsNil)
require.NoError(t, err)

clusterName, err := services.NewClusterNameWithRandomID(types.ClusterNameSpecV2{
ClusterName: "me.localhost",
})
c.Assert(err, check.IsNil)
require.NoError(t, err)

authConfig := &InitConfig{
ClusterName: clusterName,
Backend: s.b,
Backend: tt.b,
Authority: authority.New(),
SkipPeriodicOperations: true,
}
s.a, err = NewServer(authConfig)
c.Assert(err, check.IsNil)
tt.a, err = NewServer(authConfig)
require.NoError(t, err)

s.mockEmitter = &eventstest.MockEmitter{}
s.a.emitter = s.mockEmitter
tt.mockEmitter = &eventstest.MockEmitter{}
tt.a.emitter = tt.mockEmitter

return &tt
}

func (tt *githubContext) Close() error {
return trace.NewAggregate(
tt.a.Close(),
tt.b.Close())
}

func (s *GithubSuite) TestPopulateClaims(c *check.C) {
func TestPopulateClaims(t *testing.T) {
claims, err := populateGithubClaims(&testGithubAPIClient{})
c.Assert(err, check.IsNil)
c.Assert(claims, check.DeepEquals, &types.GithubClaims{
require.NoError(t, err)
require.Empty(t, cmp.Diff(claims, &types.GithubClaims{
Username: "octocat",
OrganizationToTeams: map[string][]string{
"org1": {"team1", "team2"},
"org2": {"team1"},
},
Teams: []string{"team1", "team2", "team1"},
})
}))

}

func (s *GithubSuite) TestCreateGithubUser(c *check.C) {
func TestCreateGithubUser(t *testing.T) {
ctx := context.Background()
tt := setupGithubContext(ctx, t)

// Dry-run creation of Github user.
user, err := s.a.createGithubUser(context.Background(), &createUserParams{
user, err := tt.a.createGithubUser(context.Background(), &createUserParams{
connectorName: "github",
username: "foo@example.com",
roles: []string{"admin"},
sessionTTL: 1 * time.Minute,
}, true)
c.Assert(err, check.IsNil)
c.Assert(user.GetName(), check.Equals, "foo@example.com")
require.NoError(t, err)
require.Equal(t, user.GetName(), "foo@example.com")

// Dry-run must not create a user.
_, err = s.a.GetUser("foo@example.com", false)
c.Assert(err, check.NotNil)
_, err = tt.a.GetUser("foo@example.com", false)
require.Error(t, err)

// Create GitHub user with 1 minute expiry.
_, err = s.a.createGithubUser(context.Background(), &createUserParams{
_, err = tt.a.createGithubUser(context.Background(), &createUserParams{
connectorName: "github",
username: "foo",
roles: []string{"admin"},
sessionTTL: 1 * time.Minute,
}, false)
c.Assert(err, check.IsNil)
require.NoError(t, err)

// Within that 1 minute period the user should still exist.
_, err = s.a.GetUser("foo", false)
c.Assert(err, check.IsNil)
_, err = tt.a.GetUser("foo", false)
require.NoError(t, err)

// Advance time 2 minutes, the user should be gone.
s.c.Advance(2 * time.Minute)
_, err = s.a.GetUser("foo", false)
c.Assert(err, check.NotNil)
tt.c.Advance(2 * time.Minute)
_, err = tt.a.GetUser("foo", false)
require.Error(t, err)
}

type testGithubAPIClient struct{}
Expand Down Expand Up @@ -151,7 +162,10 @@ func (c *testGithubAPIClient) getTeams() ([]teamResponse, error) {
}, nil
}

func (s *GithubSuite) TestValidateGithubAuthCallbackEventsEmitted(c *check.C) {
func TestValidateGithubAuthCallbackEventsEmitted(t *testing.T) {
ctx := context.Background()
tt := setupGithubContext(ctx, t)

auth := &GithubAuthResponse{
Username: "test-name",
}
Expand All @@ -178,20 +192,20 @@ func (s *GithubSuite) TestValidateGithubAuthCallbackEventsEmitted(c *check.C) {
diagCtx.info.GithubClaims = claims
return auth, nil
}
_, _ = validateGithubAuthCallbackHelper(context.Background(), m, nil, s.a.emitter)
c.Assert(s.mockEmitter.LastEvent().GetType(), check.Equals, events.UserLoginEvent)
c.Assert(s.mockEmitter.LastEvent().GetCode(), check.Equals, events.UserSSOLoginCode)
c.Assert(ssoDiagInfoCalls, check.Equals, 0)
s.mockEmitter.Reset()
_, _ = validateGithubAuthCallbackHelper(context.Background(), m, nil, tt.a.emitter)
require.Equal(t, tt.mockEmitter.LastEvent().GetType(), events.UserLoginEvent)
require.Equal(t, tt.mockEmitter.LastEvent().GetCode(), events.UserSSOLoginCode)
require.Equal(t, ssoDiagInfoCalls, 0)
tt.mockEmitter.Reset()

// Test failure event.
m.mockValidateGithubAuthCallback = func(ctx context.Context, diagCtx *ssoDiagContext, q url.Values) (*GithubAuthResponse, error) {
diagCtx.info.GithubClaims = claims
return auth, trace.BadParameter("")
}
_, _ = validateGithubAuthCallbackHelper(context.Background(), m, nil, s.a.emitter)
c.Assert(s.mockEmitter.LastEvent().GetCode(), check.Equals, events.UserSSOLoginFailureCode)
c.Assert(ssoDiagInfoCalls, check.Equals, 0)
_, _ = validateGithubAuthCallbackHelper(context.Background(), m, nil, tt.a.emitter)
require.Equal(t, tt.mockEmitter.LastEvent().GetCode(), events.UserSSOLoginFailureCode)
require.Equal(t, ssoDiagInfoCalls, 0)

// TestFlow: true
m.testFlow = true
Expand All @@ -201,20 +215,20 @@ func (s *GithubSuite) TestValidateGithubAuthCallbackEventsEmitted(c *check.C) {
diagCtx.info.GithubClaims = claims
return auth, nil
}
_, _ = validateGithubAuthCallbackHelper(context.Background(), m, nil, s.a.emitter)
c.Assert(s.mockEmitter.LastEvent().GetType(), check.Equals, events.UserLoginEvent)
c.Assert(s.mockEmitter.LastEvent().GetCode(), check.Equals, events.UserSSOTestFlowLoginCode)
c.Assert(ssoDiagInfoCalls, check.Equals, 1)
s.mockEmitter.Reset()
_, _ = validateGithubAuthCallbackHelper(context.Background(), m, nil, tt.a.emitter)
require.Equal(t, tt.mockEmitter.LastEvent().GetType(), events.UserLoginEvent)
require.Equal(t, tt.mockEmitter.LastEvent().GetCode(), events.UserSSOTestFlowLoginCode)
require.Equal(t, ssoDiagInfoCalls, 1)
tt.mockEmitter.Reset()

// Test failure event.
m.mockValidateGithubAuthCallback = func(ctx context.Context, diagCtx *ssoDiagContext, q url.Values) (*GithubAuthResponse, error) {
diagCtx.info.GithubClaims = claims
return auth, trace.BadParameter("")
}
_, _ = validateGithubAuthCallbackHelper(context.Background(), m, nil, s.a.emitter)
c.Assert(s.mockEmitter.LastEvent().GetCode(), check.Equals, events.UserSSOTestFlowLoginFailureCode)
c.Assert(ssoDiagInfoCalls, check.Equals, 2)
_, _ = validateGithubAuthCallbackHelper(context.Background(), m, nil, tt.a.emitter)
require.Equal(t, tt.mockEmitter.LastEvent().GetCode(), events.UserSSOTestFlowLoginFailureCode)
require.Equal(t, ssoDiagInfoCalls, 2)
}

type mockedGithubManager struct {
Expand Down
Loading