From 9c1070d50556d7f7615b1046d1281ed2cd9c9abf Mon Sep 17 00:00:00 2001 From: Sebastian Rivera Date: Thu, 24 Feb 2022 13:30:20 -0500 Subject: [PATCH] Token generate functions renamed to Create --- helper_test.go | 2 +- mocks/team_token_mocks.go | 30 +++++++++++++++--------------- mocks/user_token_mocks.go | 30 +++++++++++++++--------------- team_token.go | 8 ++++---- team_token_integration_test.go | 8 ++++---- user_token.go | 12 ++++++------ user_token_integration_test.go | 10 +++++----- 7 files changed, 50 insertions(+), 50 deletions(-) diff --git a/helper_test.go b/helper_test.go index 652ccf781..492a4f74a 100644 --- a/helper_test.go +++ b/helper_test.go @@ -897,7 +897,7 @@ func createTeamToken(t *testing.T, client *Client, tm *Team) (*TeamToken, func() } ctx := context.Background() - tt, err := client.TeamTokens.Generate(ctx, tm.ID) + tt, err := client.TeamTokens.Create(ctx, tm.ID) if err != nil { t.Fatal(err) } diff --git a/mocks/team_token_mocks.go b/mocks/team_token_mocks.go index 2b84e5f24..c40823493 100644 --- a/mocks/team_token_mocks.go +++ b/mocks/team_token_mocks.go @@ -35,6 +35,21 @@ func (m *MockTeamTokens) EXPECT() *MockTeamTokensMockRecorder { return m.recorder } +// Create mocks base method. +func (m *MockTeamTokens) Create(ctx context.Context, teamID string) (*tfe.TeamToken, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "Create", ctx, teamID) + ret0, _ := ret[0].(*tfe.TeamToken) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// Create indicates an expected call of Create. +func (mr *MockTeamTokensMockRecorder) Create(ctx, teamID interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Create", reflect.TypeOf((*MockTeamTokens)(nil).Create), ctx, teamID) +} + // Delete mocks base method. func (m *MockTeamTokens) Delete(ctx context.Context, teamID string) error { m.ctrl.T.Helper() @@ -49,21 +64,6 @@ func (mr *MockTeamTokensMockRecorder) Delete(ctx, teamID interface{}) *gomock.Ca return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Delete", reflect.TypeOf((*MockTeamTokens)(nil).Delete), ctx, teamID) } -// Generate mocks base method. -func (m *MockTeamTokens) Generate(ctx context.Context, teamID string) (*tfe.TeamToken, error) { - m.ctrl.T.Helper() - ret := m.ctrl.Call(m, "Generate", ctx, teamID) - ret0, _ := ret[0].(*tfe.TeamToken) - ret1, _ := ret[1].(error) - return ret0, ret1 -} - -// Generate indicates an expected call of Generate. -func (mr *MockTeamTokensMockRecorder) Generate(ctx, teamID interface{}) *gomock.Call { - mr.mock.ctrl.T.Helper() - return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Generate", reflect.TypeOf((*MockTeamTokens)(nil).Generate), ctx, teamID) -} - // Read mocks base method. func (m *MockTeamTokens) Read(ctx context.Context, teamID string) (*tfe.TeamToken, error) { m.ctrl.T.Helper() diff --git a/mocks/user_token_mocks.go b/mocks/user_token_mocks.go index 241cc160e..1cb67d034 100644 --- a/mocks/user_token_mocks.go +++ b/mocks/user_token_mocks.go @@ -35,6 +35,21 @@ func (m *MockUserTokens) EXPECT() *MockUserTokensMockRecorder { return m.recorder } +// Create mocks base method. +func (m *MockUserTokens) Create(ctx context.Context, userID string, options tfe.UserTokenCreateOptions) (*tfe.UserToken, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "Create", ctx, userID, options) + ret0, _ := ret[0].(*tfe.UserToken) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// Create indicates an expected call of Create. +func (mr *MockUserTokensMockRecorder) Create(ctx, userID, options interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Create", reflect.TypeOf((*MockUserTokens)(nil).Create), ctx, userID, options) +} + // Delete mocks base method. func (m *MockUserTokens) Delete(ctx context.Context, tokenID string) error { m.ctrl.T.Helper() @@ -49,21 +64,6 @@ func (mr *MockUserTokensMockRecorder) Delete(ctx, tokenID interface{}) *gomock.C return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Delete", reflect.TypeOf((*MockUserTokens)(nil).Delete), ctx, tokenID) } -// Generate mocks base method. -func (m *MockUserTokens) Generate(ctx context.Context, userID string, options tfe.UserTokenGenerateOptions) (*tfe.UserToken, error) { - m.ctrl.T.Helper() - ret := m.ctrl.Call(m, "Generate", ctx, userID, options) - ret0, _ := ret[0].(*tfe.UserToken) - ret1, _ := ret[1].(error) - return ret0, ret1 -} - -// Generate indicates an expected call of Generate. -func (mr *MockUserTokensMockRecorder) Generate(ctx, userID, options interface{}) *gomock.Call { - mr.mock.ctrl.T.Helper() - return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Generate", reflect.TypeOf((*MockUserTokens)(nil).Generate), ctx, userID, options) -} - // List mocks base method. func (m *MockUserTokens) List(ctx context.Context, userID string) (*tfe.UserTokenList, error) { m.ctrl.T.Helper() diff --git a/team_token.go b/team_token.go index a624b9c8c..d299f93c8 100644 --- a/team_token.go +++ b/team_token.go @@ -16,8 +16,8 @@ var _ TeamTokens = (*teamTokens)(nil) // TFE API docs: // https://www.terraform.io/docs/cloud/api/team-tokens.html type TeamTokens interface { - // Generate a new team token, replacing any existing token. - Generate(ctx context.Context, teamID string) (*TeamToken, error) + // Create a new team token, replacing any existing token. + Create(ctx context.Context, teamID string) (*TeamToken, error) // Read a team token by its ID. Read(ctx context.Context, teamID string) (*TeamToken, error) @@ -40,8 +40,8 @@ type TeamToken struct { Token string `jsonapi:"attr,token"` } -// Generate a new team token, replacing any existing token. -func (s *teamTokens) Generate(ctx context.Context, teamID string) (*TeamToken, error) { +// Create a new team token, replacing any existing token. +func (s *teamTokens) Create(ctx context.Context, teamID string) (*TeamToken, error) { if !validStringID(&teamID) { return nil, ErrInvalidTeamID } diff --git a/team_token_integration_test.go b/team_token_integration_test.go index d1a22ab1d..635960a02 100644 --- a/team_token_integration_test.go +++ b/team_token_integration_test.go @@ -11,7 +11,7 @@ import ( "github.com/stretchr/testify/require" ) -func TestTeamTokensGenerate(t *testing.T) { +func TestTeamTokensCreate(t *testing.T) { skipIfFreeOnly(t) client := testClient(t) @@ -22,21 +22,21 @@ func TestTeamTokensGenerate(t *testing.T) { var tmToken string t.Run("with valid options", func(t *testing.T) { - tt, err := client.TeamTokens.Generate(ctx, tmTest.ID) + tt, err := client.TeamTokens.Create(ctx, tmTest.ID) require.NoError(t, err) require.NotEmpty(t, tt.Token) tmToken = tt.Token }) t.Run("when a token already exists", func(t *testing.T) { - tt, err := client.TeamTokens.Generate(ctx, tmTest.ID) + tt, err := client.TeamTokens.Create(ctx, tmTest.ID) require.NoError(t, err) require.NotEmpty(t, tt.Token) assert.NotEqual(t, tmToken, tt.Token) }) t.Run("without valid team ID", func(t *testing.T) { - tt, err := client.TeamTokens.Generate(ctx, badIdentifier) + tt, err := client.TeamTokens.Create(ctx, badIdentifier) assert.Nil(t, tt) assert.Equal(t, err, ErrInvalidTeamID) }) diff --git a/user_token.go b/user_token.go index bea041820..874e7bb46 100644 --- a/user_token.go +++ b/user_token.go @@ -19,8 +19,8 @@ type UserTokens interface { // List all the tokens of the given user ID. List(ctx context.Context, userID string) (*UserTokenList, error) - // Generate a new user token - Generate(ctx context.Context, userID string, options UserTokenGenerateOptions) (*UserToken, error) + // Create a new user token + Create(ctx context.Context, userID string, options UserTokenCreateOptions) (*UserToken, error) // Read a user token by its ID. Read(ctx context.Context, tokenID string) (*UserToken, error) @@ -49,14 +49,14 @@ type UserToken struct { Token string `jsonapi:"attr,token"` } -// UserTokenGenerateOptions the options for creating a user token. -type UserTokenGenerateOptions struct { +// UserTokenCreateOptions the options for creating a user token. +type UserTokenCreateOptions struct { // Description of the token Description string `jsonapi:"attr,description,omitempty"` } -// Generate a new user token -func (s *userTokens) Generate(ctx context.Context, userID string, options UserTokenGenerateOptions) (*UserToken, error) { +// Create a new user token +func (s *userTokens) Create(ctx context.Context, userID string, options UserTokenCreateOptions) (*UserToken, error) { if !validStringID(&userID) { return nil, ErrInvalidUserID } diff --git a/user_token_integration_test.go b/user_token_integration_test.go index cfb8590cb..ec84a56d7 100644 --- a/user_token_integration_test.go +++ b/user_token_integration_test.go @@ -41,8 +41,8 @@ func TestUserTokens_List(t *testing.T) { }) } -// TestUserTokens_Generate tests basic creation of user tokens -func TestUserTokens_Generate(t *testing.T) { +// TestUserTokens_Create tests basic creation of user tokens +func TestUserTokens_Create(t *testing.T) { client := testClient(t) ctx := context.Background() user, err := client.Users.ReadCurrent(ctx) @@ -62,7 +62,7 @@ func TestUserTokens_Generate(t *testing.T) { }(t) t.Run("create token with no description", func(t *testing.T) { - token, err := client.UserTokens.Generate(ctx, user.ID, UserTokenGenerateOptions{}) + token, err := client.UserTokens.Create(ctx, user.ID, UserTokenCreateOptions{}) tokens = append(tokens, token.ID) if err != nil { t.Fatal(err) @@ -70,7 +70,7 @@ func TestUserTokens_Generate(t *testing.T) { }) t.Run("create token with description", func(t *testing.T) { - token, err := client.UserTokens.Generate(ctx, user.ID, UserTokenGenerateOptions{ + token, err := client.UserTokens.Create(ctx, user.ID, UserTokenCreateOptions{ Description: fmt.Sprintf("go-tfe-user-token-test-%s", randomString(t)), }) tokens = append(tokens, token.ID) @@ -112,7 +112,7 @@ func createToken(t *testing.T, client *Client, user *User) (*UserToken, func()) if user == nil { t.Fatal("Nil user in createToken") } - token, err := client.UserTokens.Generate(ctx, user.ID, UserTokenGenerateOptions{ + token, err := client.UserTokens.Create(ctx, user.ID, UserTokenCreateOptions{ Description: fmt.Sprintf("go-tfe-user-token-test-%s", randomString(t)), }) if err != nil {