Skip to content

Commit

Permalink
Rename the new structs and functions
Browse files Browse the repository at this point in the history
  • Loading branch information
@svanharmelen
svanharmelen committed Mar 10, 2024
1 parent 7c17faf commit b6e96f9
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 34 deletions.
32 changes: 16 additions & 16 deletions job_token_scope.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -185,29 +185,29 @@ func (j *JobTokenScopeService) RemoveProjectFromJobScopeAllowList(pid interface{
return j.client.Do(req, nil)
}

// JobTokenInboundGroupsAllowItem represents a single job token inbound group allowlist item.
// JobTokenAllowlistItem represents a single job token allowlist item.
//
// GitLab API docs: https://docs.gitlab.com/ee/api/project_job_token_scopes.html
type JobTokenInboundGroupsAllowItem struct {
type JobTokenAllowlistItem struct {
SourceProjectID int `json:"source_project_id"`
TargetGroupID int `json:"target_group_id"`
}

// GetJobTokenInboundGroupsAllowListOptions represents the available
// GetJobTokenInboundGroupsAllowList() options.
// GetJobTokenAllowlistGroupsOptions represents the available
// GetJobTokenAllowlistGroups() options.
//
// GitLab API docs:
// https://docs.gitlab.com/ee/api/project_job_token_scopes.html#get-a-projects-cicd-job-token-inbound-allowlist
type GetJobTokenInboundGroupsAllowListOptions struct {
// https://docs.gitlab.com/ee/api/project_job_token_scopes.html#get-a-projects-cicd-job-token-allowlist-of-groups
type GetJobTokenAllowlistGroupsOptions struct {
ListOptions
}

// GetProjectJobTokenInboundGroupsAllowList fetches the CI/CD job token inbound
// groups allowlist (job token scope) of a project.
// GetJobTokenAllowListGroups fetches the CI/CD job token allowlist groups
// (job token scopes) of a project.
//
// GitLab API docs:
// https://docs.gitlab.com/ee/api/project_job_token_scopes.html#get-a-projects-cicd-job-token-allowlist-of-groups
func (j *JobTokenScopeService) GetProjectJobTokenInboundGroupsAllowList(pid interface{}, opt *GetJobTokenInboundGroupsAllowListOptions, options ...RequestOptionFunc) ([]*Group, *Response, error) {
func (j *JobTokenScopeService) GetJobTokenAllowlistGroups(pid interface{}, opt *GetJobTokenAllowlistGroupsOptions, options ...RequestOptionFunc) ([]*Group, *Response, error) {
project, err := parseID(pid)
if err != nil {
return nil, nil, err
Expand All @@ -228,12 +228,12 @@ func (j *JobTokenScopeService) GetProjectJobTokenInboundGroupsAllowList(pid inte
return ps, resp, nil
}

// AddProjectToJobScopeGroupsAllowListOptions represents the available
// AddProjectToJobScopeGroupsAllowList() options.
// AddGroupToJobTokenAllowlistOptions represents the available
// AddGroupToJobTokenAllowlist() options.
//
// GitLab API docs:
// https://docs.gitlab.com/ee/api/project_job_token_scopes.html#add-a-group-to-a-cicd-job-token-allowlist
type JobTokenInboundGroupsAllowOptions struct {
type AddGroupToJobTokenAllowlistOptions struct {
TargetGroupID *int `url:"target_group_id,omitempty" json:"target_group_id,omitempty"`
}

Expand All @@ -242,7 +242,7 @@ type JobTokenInboundGroupsAllowOptions struct {
//
// GitLab API docs:
// https://docs.gitlab.com/ee/api/project_job_token_scopes.html#add-a-group-to-a-cicd-job-token-allowlist
func (j *JobTokenScopeService) AddGroupToJobScopeGroupsAllowList(pid interface{}, opt *JobTokenInboundGroupsAllowOptions, options ...RequestOptionFunc) (*JobTokenInboundGroupsAllowItem, *Response, error) {
func (j *JobTokenScopeService) AddGroupToJobTokenAllowlist(pid interface{}, opt *AddGroupToJobTokenAllowlistOptions, options ...RequestOptionFunc) (*JobTokenAllowlistItem, *Response, error) {
project, err := parseID(pid)
if err != nil {
return nil, nil, err
Expand All @@ -254,7 +254,7 @@ func (j *JobTokenScopeService) AddGroupToJobScopeGroupsAllowList(pid interface{}
return nil, nil, err
}

jt := new(JobTokenInboundGroupsAllowItem)
jt := new(JobTokenAllowlistItem)
resp, err := j.client.Do(req, jt)
if err != nil {
return nil, resp, err
Expand All @@ -263,12 +263,12 @@ func (j *JobTokenScopeService) AddGroupToJobScopeGroupsAllowList(pid interface{}
return jt, resp, nil
}

// RemoveGroupFromJobScopeAllowList removes a group from a project's job
// RemoveGroupFromJopTokenAllowlist removes a group from a project's job
// token inbound groups allow list.
//
// GitLab API docs:
// https://docs.gitlab.com/ee/api/project_job_token_scopes.html#remove-a-group-from-a-cicd-job-token-allowlist
func (j *JobTokenScopeService) RemoveGroupFromJobScopeGroupsAllowList(pid interface{}, targetGroup int, options ...RequestOptionFunc) (*Response, error) {
func (j *JobTokenScopeService) RemoveGroupFromJobTokenAllowlist(pid interface{}, targetGroup int, options ...RequestOptionFunc) (*Response, error) {
project, err := parseID(pid)
if err != nil {
return nil, err
Expand Down
36 changes: 18 additions & 18 deletions job_token_scope_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -178,11 +178,11 @@ func TestRemoveProjectFromJobScopeAllowList(t *testing.T) {
assert.Equal(t, 204, resp.StatusCode)
}

// This tests that when calling the GetProjectJobTokenInboundGroupsAllowList, we
// get a list of groups back properly. There isn't a "deep" test with every
// attribute specified, because the object returned is a *Group object, which
// is already tested in groups.go.
func TestGetProjectJobTokenInboundGroupsAllowList(t *testing.T) {
// This tests that when calling the GetJobTokenAllowlistGroups, we get a list
// of groups back. There isn't a "deep" test with every attribute specified,
// because the object returned is a *Group object, which is already tested in
// groups.go.
func TestGetJobTokenAllowlistGroups(t *testing.T) {
mux, client := setup(t)

// Handle project ID 1, and print a result of two groups
Expand All @@ -194,16 +194,16 @@ func TestGetProjectJobTokenInboundGroupsAllowList(t *testing.T) {
})

want := []*Group{{ID: 1}, {ID: 2}}
groups, _, err := client.JobTokenScope.GetProjectJobTokenInboundGroupsAllowList(
groups, _, err := client.JobTokenScope.GetJobTokenAllowlistGroups(
1,
&GetJobTokenInboundGroupsAllowListOptions{},
&GetJobTokenAllowlistGroupsOptions{},
)

assert.NoError(t, err)
assert.Equal(t, want, groups)
}

func TestAddGroupToJobScopeGroupsAllowList(t *testing.T) {
func TestAddGroupToJobTokenAllowlist(t *testing.T) {
mux, client := setup(t)

mux.HandleFunc("/api/v4/projects/1/job_token_scope/groups_allowlist", func(w http.ResponseWriter, r *http.Request) {
Expand All @@ -212,14 +212,14 @@ func TestAddGroupToJobScopeGroupsAllowList(t *testing.T) {
// Read the request to determine which target group is passed in
body, err := io.ReadAll(r.Body)
if err != nil {
t.Fatalf("JobTokenScope.AddGroupToJobScopeGroupsAllowList failed to read body")
t.Fatalf("JobTokenScope.AddGroupToJobTokenAllowlist failed to read body")
}

// Parse to object to ensure it's sent on the request appropriately.
var createTokenRequest JobTokenInboundGroupsAllowOptions
var createTokenRequest AddGroupToJobTokenAllowlistOptions
err = json.Unmarshal(body, &createTokenRequest)
if err != nil {
t.Fatalf("JobTokenScope.AddGroupToJobScopeGroupsAllowList failed to unmarshal body: %v", err)
t.Fatalf("JobTokenScope.AddGroupToJobTokenAllowlist failed to unmarshal body: %v", err)
}

// Ensure we provide the proper response
Expand All @@ -232,21 +232,21 @@ func TestAddGroupToJobScopeGroupsAllowList(t *testing.T) {
}`, *createTokenRequest.TargetGroupID)
})

want := &JobTokenInboundGroupsAllowItem{
want := &JobTokenAllowlistItem{
SourceProjectID: 1,
TargetGroupID: 2,
}

addTokenResponse, resp, err := client.JobTokenScope.AddGroupToJobScopeGroupsAllowList(
addTokenResponse, resp, err := client.JobTokenScope.AddGroupToJobTokenAllowlist(
1,
&JobTokenInboundGroupsAllowOptions{TargetGroupID: Ptr(2)},
&AddGroupToJobTokenAllowlistOptions{TargetGroupID: Ptr(2)},
)
assert.NoError(t, err)
assert.Equal(t, want, addTokenResponse)
assert.Equal(t, 201, resp.StatusCode)
}

func TestRemoveGroupFromJobScopeGroupsAllowList(t *testing.T) {
func TestRemoveGroupFromJobTokenAllowlist(t *testing.T) {
mux, client := setup(t)

mux.HandleFunc("/api/v4/projects/1/job_token_scope/groups_allowlist/2", func(w http.ResponseWriter, r *http.Request) {
Expand All @@ -255,12 +255,12 @@ func TestRemoveGroupFromJobScopeGroupsAllowList(t *testing.T) {
// Read the request to determine which target group is passed in
body, err := io.ReadAll(r.Body)
if err != nil {
t.Fatalf("JobTokenScope.RemoveGroupFromJobScopeGroupsAllowList failed to read body")
t.Fatalf("JobTokenScope.RemoveGroupFromJobTokenAllowlist failed to read body")
}

// The body should be empty since all attributes are passed in the path
if body != nil && string(body) != "" {
t.Fatalf("JobTokenScope.RemoveGroupFromJobScopeGroupsAllowList failed to unmarshal body: %v", err)
t.Fatalf("JobTokenScope.RemoveGroupFromJobTokenAllowlist failed to unmarshal body: %v", err)
}

// Ensure we provide the proper response
Expand All @@ -270,7 +270,7 @@ func TestRemoveGroupFromJobScopeGroupsAllowList(t *testing.T) {
fmt.Fprint(w, "")
})

resp, err := client.JobTokenScope.RemoveGroupFromJobScopeGroupsAllowList(1, 2)
resp, err := client.JobTokenScope.RemoveGroupFromJobTokenAllowlist(1, 2)
assert.NoError(t, err)
assert.Equal(t, 204, resp.StatusCode)
}

0 comments on commit b6e96f9

Please sign in to comment.