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.

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

Add support to list custom roles for organizations #2336

Merged
merged 4 commits into from Apr 26, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
38 changes: 38 additions & 0 deletions github/org_custom_roles.go
@@ -0,0 +1,38 @@
package github
gmlewis marked this conversation as resolved.
Show resolved Hide resolved

import (
"context"
"fmt"
)

// OrginizationCustomRoles represents custom repository roles available in specified organization
gmlewis marked this conversation as resolved.
Show resolved Hide resolved
type OrginizationCustomRoles struct {
gmlewis marked this conversation as resolved.
Show resolved Hide resolved
TotalCount *int `json:"total_count,omitempty"`
CustomRoles []*CustomRoles `json:"custom_roles,omitempty"`
gmlewis marked this conversation as resolved.
Show resolved Hide resolved
}

// CustomRoles represents information of custom roles
gmlewis marked this conversation as resolved.
Show resolved Hide resolved
type CustomRoles struct {
gmlewis marked this conversation as resolved.
Show resolved Hide resolved
ID *int64 `json:"id,omitempty"`
Name *string `json:"name,omitempty"`
}

// List Custome Roles in Org
gmlewis marked this conversation as resolved.
Show resolved Hide resolved
//
// GitHub API docs: https://docs.github.com/en/rest/reference/orgs#custom-repository-roles
gmlewis marked this conversation as resolved.
Show resolved Hide resolved
func (s *OrganizationsService) ListCustomRoles(ctx context.Context, organization_id string) (*OrginizationCustomRoles, *Response, error) {
gmlewis marked this conversation as resolved.
Show resolved Hide resolved
u := fmt.Sprintf("organizations/%v/custom_roles", organization_id)

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

custom_roles := new(OrginizationCustomRoles)
resp, err := s.client.Do(ctx, req, custom_roles)
if err != nil {
return nil, resp, err
}

return custom_roles, resp, nil
}
45 changes: 45 additions & 0 deletions github/org_custom_roles_test.go
@@ -0,0 +1,45 @@
package github
gmlewis marked this conversation as resolved.
Show resolved Hide resolved

import (
"context"
"fmt"
"net/http"
"testing"

"github.com/google/go-cmp/cmp"
)

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

mux.HandleFunc("/organizations/o/custom_roles", func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "GET")
fmt.Fprint(w, `{"total_count": 1, "custom_roles": [{ "id": 1, "name": "Developer"}]}`)
})

ctx := context.Background()
apps, _, err := client.Organizations.ListCustomRoles(ctx, "o")
if err != nil {
t.Errorf("Organizations.ListCustomRoles returned error: %v", err)
}

want := &OrginizationCustomRoles{TotalCount: Int(1), CustomRoles: []*CustomRoles{{ID: Int64(1), Name: String("Developer")}}}
if !cmp.Equal(apps, want) {
t.Errorf("Organizations.ListCustomRoles returned %+v, want %+v", apps, want)
}

const methodName = "ListCustomRoles"
testBadOptions(t, methodName, func() (err error) {
_, _, err = client.Organizations.ListCustomRoles(ctx, "\no")
return err
})

testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
got, resp, err := client.Organizations.ListCustomRoles(ctx, "o")
if got != nil {
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
}
return resp, err
})
}