Skip to content
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

Jump to bottom

approval state of merge requests #766

Merged
merged 3 commits into from Feb 6, 2020
Merged

approval state of merge requests #766

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d3b11dd
Add GetApprovalState For MergeRequestApprovalsService
granular-ryanbonham Feb 6, 2020
0d8d752
Fix Approval State
granular-ryanbonham Feb 6, 2020
adf616c
MR Comments addressed.
granular-ryanbonham Feb 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
36 changes: 36 additions & 0 deletions merge_request_approvals.go
View file
Open in desktop
Expand Up @@ -74,6 +74,17 @@ type MergeRequestApprovalRule struct {
Users []*BasicUser `json:"users"`
Groups []*Group `json:"groups"`
ContainsHiddenGroups bool `json:"contains_hidden_groups"`
ApprovedBy []*BasicUser `json:"approved_by"`
Approved bool `json:"approved"`
}

// MergeRequestApprovalState represents a GitLab merge request approval state.
//
// GitLab API docs:
// https://docs.gitlab.com/ee/api/merge_request_approvals.html#get-the-approval-state-of-merge-requests
type MergeRequestApprovalState struct {
ApprovalRulesOverwritten bool `json:"approval_rules_overwritten"`
Rules []*MergeRequestApprovalRule `json:"rules"`
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's not create a new struct, but instead add the missing fields to the MergeRequestApprovalRule struct and reuse that one here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done


// String is a stringify for MergeRequestApprovalRule
Expand Down Expand Up @@ -236,6 +247,31 @@ func (s *MergeRequestApprovalsService) GetApprovalRules(pid interface{}, mergeRe
return par, resp, err
}

// GetApprovalState requests information about a merge request’s approval state
//
// GitLab API docs:
// https://docs.gitlab.com/ee/api/merge_request_approvals.html#get-the-approval-state-of-merge-requests
func (s *MergeRequestApprovalsService) GetApprovalState(pid interface{}, mergeRequest int, options ...OptionFunc) (*MergeRequestApprovalState, *Response, error) {
project, err := parseID(pid)
if err != nil {
return nil, nil, err
}
u := fmt.Sprintf("projects/%s/merge_requests/%d/approval_state", pathEscape(project), mergeRequest)

req, err := s.client.NewRequest("GET", u, nil, options)
if err != nil {
return nil, nil, err
}

var pas *MergeRequestApprovalState
resp, err := s.client.Do(req, &pas)
if err != nil {
return nil, resp, err
}

return pas, resp, err
}

// CreateMergeRequestApprovalRuleOptions represents the available CreateApprovalRule()
// options.
//
Expand Down
154 changes: 154 additions & 0 deletions merge_request_approvals_test.go
View file
Open in desktop
Expand Up @@ -7,6 +7,160 @@ import (
"testing"
)

func TestGetApprovalState(t *testing.T) {
mux, server, client := setup()
defer teardown(server)

mux.HandleFunc("/api/v4/projects/1/merge_requests/1/approval_state", func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "GET")
fmt.Fprint(w, `{
"approval_rules_overwritten": true,
"rules": [
{
"id": 1,
"name": "security",
"rule_type": "regular",
"eligible_approvers": [
{
"id": 5,
"name": "John Doe",
"username": "jdoe",
"state": "active",
"avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
"web_url": "http://localhost/jdoe"
},
{
"id": 50,
"name": "Group Member 1",
"username": "group_member_1",
"state": "active",
"avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
"web_url": "http://localhost/group_member_1"
}
],
"approvals_required": 3,
"source_rule": null,
"users": [
{
"id": 5,
"name": "John Doe",
"username": "jdoe",
"state": "active",
"avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
"web_url": "http://localhost/jdoe"
}
],
"groups": [
{
"id": 5,
"name": "group1",
"path": "group1",
"description": "",
"visibility": "public",
"lfs_enabled": false,
"avatar_url": null,
"web_url": "http://localhost/groups/group1",
"request_access_enabled": false,
"full_name": "group1",
"full_path": "group1",
"parent_id": null,
"ldap_cn": null,
"ldap_access": null
}
],
"contains_hidden_groups": false,
"approved_by": [
{
"id": 5,
"name": "John Doe",
"username": "jdoe",
"state": "active",
"avatar_url": "https://www.gravatar.com/avatar/0?s=80&d=identicon",
"web_url": "http://localhost/jdoe"
}
],
"approved": false
}
]
}`)
})

approvals, _, err := client.MergeRequestApprovals.GetApprovalState(1, 1)
if err != nil {
t.Errorf("MergeRequestApprovals.GetApprovalState returned error: %v", err)
}

want := &MergeRequestApprovalState{
ApprovalRulesOverwritten: true,
Rules: []*MergeRequestApprovalRule{
&MergeRequestApprovalRule{
ID: 1,
Name: "security",
RuleType: "regular",
EligibleApprovers: []*BasicUser{
&BasicUser{
ID: 5,
Name: "John Doe",
Username: "jdoe",
State: "active",
AvatarURL: "https://www.gravatar.com/avatar/0?s=80&d=identicon",
WebURL: "http://localhost/jdoe",
},
&BasicUser{
ID: 50,
Name: "Group Member 1",
Username: "group_member_1",
State: "active",
AvatarURL: "https://www.gravatar.com/avatar/0?s=80&d=identicon",
WebURL: "http://localhost/group_member_1",
},
},
ApprovalsRequired: 3,
Users: []*BasicUser{
&BasicUser{
ID: 5,
Name: "John Doe",
Username: "jdoe",
State: "active",
AvatarURL: "https://www.gravatar.com/avatar/0?s=80&d=identicon",
WebURL: "http://localhost/jdoe",
},
},
Groups: []*Group{
&Group{
ID: 5,
Name: "group1",
Path: "group1",
Description: "",
Visibility: PublicVisibility,
LFSEnabled: false,
AvatarURL: "",
WebURL: "http://localhost/groups/group1",
RequestAccessEnabled: false,
FullName: "group1",
FullPath: "group1",
},
},
ApprovedBy: []*BasicUser{
&BasicUser{
ID: 5,
Name: "John Doe",
Username: "jdoe",
State: "active",
AvatarURL: "https://www.gravatar.com/avatar/0?s=80&d=identicon",
WebURL: "http://localhost/jdoe",
},
},
Approved: false,
},
},
}

if !reflect.DeepEqual(want, approvals) {
t.Errorf("MergeRequestApprovals.GetApprovalState returned %+v, want %+v", approvals, want)
}
}

func TestGetApprovalRules(t *testing.T) {
mux, server, client := setup()
defer teardown(server)
Expand Down