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 3 commits
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
24 changes: 24 additions & 0 deletions github/github-accessors.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

30 changes: 30 additions & 0 deletions github/github-accessors_test.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

46 changes: 46 additions & 0 deletions github/org_custom_roles.go
@@ -0,0 +1,46 @@
// Copyright 2022 The go-github AUTHORS. All rights reserved.
//
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package github
gmlewis marked this conversation as resolved.
Show resolved Hide resolved

import (
"context"
"fmt"
)

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

// CustomRepoRoles represents custom repository roles for an organization.
// See https://docs.github.com/en/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization
// for more information.
type CustomRepoRoles struct {
ID *int64 `json:"id,omitempty"`
Name *string `json:"name,omitempty"`
}

// ListCustomRepoRoles lists the custom repository roles available in this organization.
// In order to see custom repository roles in an organization, the authenticated user must be an organization owner.
//
// GitHub API docs: https://docs.github.com/en/rest/orgs/custom-roles
func (s *OrganizationsService) ListCustomRepoRoles(ctx context.Context, org string) (*OrgainizationCustomRepoRoles, *Response, error) {
gmlewis marked this conversation as resolved.
Show resolved Hide resolved
gmlewis marked this conversation as resolved.
Show resolved Hide resolved
u := fmt.Sprintf("organizations/%v/custom_roles", org)

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

customRepoRoles := new(OrgainizationCustomRepoRoles)
gmlewis marked this conversation as resolved.
Show resolved Hide resolved
gmlewis marked this conversation as resolved.
Show resolved Hide resolved
resp, err := s.client.Do(ctx, req, customRepoRoles)
gmlewis marked this conversation as resolved.
Show resolved Hide resolved
if err != nil {
return nil, resp, err
}

return customRepoRoles, resp, nil
}
50 changes: 50 additions & 0 deletions github/org_custom_roles_test.go
@@ -0,0 +1,50 @@
// Copyright 2022 The go-github AUTHORS. All rights reserved.
//
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

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_ListCustomRepoRoles(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.ListCustomRepoRoles(ctx, "o")
if err != nil {
t.Errorf("Organizations.ListCustomRepoRoles returned error: %v", err)
}

want := &OrgainizationCustomRepoRoles{TotalCount: Int(1), CustomRepoRoles: []*CustomRepoRoles{{ID: Int64(1), Name: String("Developer")}}}
gmlewis marked this conversation as resolved.
Show resolved Hide resolved
if !cmp.Equal(apps, want) {
t.Errorf("Organizations.ListCustomRepoRoles returned %+v, want %+v", apps, want)
}

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

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