From bb2cdbaa67c3c74d4eb00acdfbc85c7c841c578c Mon Sep 17 00:00:00 2001 From: Jeremy Hayes Date: Tue, 25 Oct 2022 15:31:30 -0400 Subject: [PATCH 1/4] Add support for security manager endpoints Add support to List/Add/Remove security manager teams for an organization. --- github/orgs_security_managers.go | 57 ++++++++++ github/orgs_security_managers_test.go | 144 ++++++++++++++++++++++++++ 2 files changed, 201 insertions(+) create mode 100644 github/orgs_security_managers.go create mode 100644 github/orgs_security_managers_test.go diff --git a/github/orgs_security_managers.go b/github/orgs_security_managers.go new file mode 100644 index 0000000000..f3e8aff98b --- /dev/null +++ b/github/orgs_security_managers.go @@ -0,0 +1,57 @@ +// Copyright 2013 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 + +import ( + "context" + "fmt" +) + +// ListSecurityManagerTeams lists all security manager teams for an organization. +// +// GitHub API docs: https://docs.github.com/en/rest/orgs/security-managers#list-security-manager-teams +func (s *OrganizationsService) ListSecurityManagerTeams(ctx context.Context, org string) ([]*Team, *Response, error) { + u := fmt.Sprintf("orgs/%v/security-managers", org) + + req, err := s.client.NewRequest("GET", u, nil) + if err != nil { + return nil, nil, err + } + + var teams []*Team + resp, err := s.client.Do(ctx, req, &teams) + if err != nil { + return nil, resp, err + } + + return teams, resp, nil +} + +// AddSecurityManagerTeam adds a team to the list of security managers for an organization. +// +// GitHub API docs: https://docs.github.com/en/rest/orgs/security-managers#add-a-security-manager-team +func (s *OrganizationsService) AddSecurityManagerTeam(ctx context.Context, org string, team string) (*Response, error) { + u := fmt.Sprintf("orgs/%v/security-managers/teams/%v", org, team) + req, err := s.client.NewRequest("PUT", u, nil) + if err != nil { + return nil, err + } + + return s.client.Do(ctx, req, nil) +} + +// RemoveSecurityManagerTeam removes a team from the list of security managers for an organization. +// +// GitHub API docs: https://docs.github.com/en/rest/orgs/security-managers#remove-a-security-manager-team +func (s *OrganizationsService) RemoveSecurityManagerTeam(ctx context.Context, org string, team string) (*Response, error) { + u := fmt.Sprintf("orgs/%v/security-managers/teams/%v", org, team) + req, err := s.client.NewRequest("DELETE", u, nil) + if err != nil { + return nil, err + } + + return s.client.Do(ctx, req, nil) +} diff --git a/github/orgs_security_managers_test.go b/github/orgs_security_managers_test.go new file mode 100644 index 0000000000..ffc0d8c0a3 --- /dev/null +++ b/github/orgs_security_managers_test.go @@ -0,0 +1,144 @@ +// Copyright 2013 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 + +import ( + "context" + "fmt" + "net/http" + "testing" + + "github.com/google/go-cmp/cmp" +) + +func TestOrganizationsService_ListSecurityManagerTeams(t *testing.T) { + client, mux, _, teardown := setup() + defer teardown() + + mux.HandleFunc("/orgs/o/security-managers", func(w http.ResponseWriter, r *http.Request) { + testMethod(t, r, "GET") + fmt.Fprint(w, `[{"id":1}]`) + }) + + ctx := context.Background() + teams, _, err := client.Organizations.ListSecurityManagerTeams(ctx, "o") + if err != nil { + t.Errorf("Organizations.ListSecurityManagerTeams returned error: %v", err) + } + + want := []*Team{{ID: Int64(1)}} + if !cmp.Equal(teams, want) { + t.Errorf("Organizations.ListSecurityManagerTeams returned %+v, want %+v", teams, want) + } + + const methodName = "ListSecurityManagerTeams" + testBadOptions(t, methodName, func() (err error) { + _, _, err = client.Organizations.ListSecurityManagerTeams(ctx, "\n") + return err + }) + + testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) { + got, resp, err := client.Organizations.ListSecurityManagerTeams(ctx, "o") + if got != nil { + t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got) + } + return resp, err + }) +} +func TestOrganizationsService_ListSecurityManagerTeams_invalidOrg(t *testing.T) { + client, _, _, teardown := setup() + defer teardown() + + ctx := context.Background() + _, _, err := client.Organizations.ListSecurityManagerTeams(ctx, "%") + testURLParseError(t, err) +} + +func TestOrganizationsService_AddSecurityManagerTeam(t *testing.T) { + client, mux, _, teardown := setup() + defer teardown() + + mux.HandleFunc("/orgs/o/security-managers/teams/t", func(w http.ResponseWriter, r *http.Request) { + testMethod(t, r, "PUT") + }) + + ctx := context.Background() + _, err := client.Organizations.AddSecurityManagerTeam(ctx, "o", "t") + if err != nil { + t.Errorf("Organizations.AddSecurityManagerTeam returned error: %v", err) + } + + const methodName = "AddSecurityManagerTeam" + testBadOptions(t, methodName, func() (err error) { + _, err = client.Organizations.AddSecurityManagerTeam(ctx, "\n", "\n") + return err + }) + + testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) { + return client.Organizations.AddSecurityManagerTeam(ctx, "o", "t") + }) +} + +func TestOrganizationsService_AddSecurityManagerTeam_invalidOrg(t *testing.T) { + client, _, _, teardown := setup() + defer teardown() + + ctx := context.Background() + _, err := client.Organizations.AddSecurityManagerTeam(ctx, "%", "t") + testURLParseError(t, err) +} + +func TestOrganizationsService_AddSecurityManagerTeam_invalidTeam(t *testing.T) { + client, _, _, teardown := setup() + defer teardown() + + ctx := context.Background() + _, err := client.Organizations.AddSecurityManagerTeam(ctx, "%", "t") + testURLParseError(t, err) +} + +func TestOrganizationsService_RemoveSecurityManagerTeam(t *testing.T) { + client, mux, _, teardown := setup() + defer teardown() + + mux.HandleFunc("/orgs/o/security-managers/teams/t", func(w http.ResponseWriter, r *http.Request) { + testMethod(t, r, "DELETE") + }) + + ctx := context.Background() + _, err := client.Organizations.RemoveSecurityManagerTeam(ctx, "o", "t") + if err != nil { + t.Errorf("Organizations.RemoveSecurityManagerTeam returned error: %v", err) + } + + const methodName = "RemoveSecurityManagerTeam" + testBadOptions(t, methodName, func() (err error) { + _, err = client.Organizations.RemoveSecurityManagerTeam(ctx, "\n", "\n") + return err + }) + + testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) { + return client.Organizations.RemoveSecurityManagerTeam(ctx, "o", "t") + }) +} + +func TestOrganizationsService_RemoveSecurityManagerTeam_invalidOrg(t *testing.T) { + client, _, _, teardown := setup() + defer teardown() + + ctx := context.Background() + _, err := client.Organizations.RemoveSecurityManagerTeam(ctx, "%", "t") + testURLParseError(t, err) +} + +func TestOrganizationsService_RemoveSecurityManagerTeam_invalidTeam(t *testing.T) { + client, _, _, teardown := setup() + defer teardown() + + ctx := context.Background() + _, err := client.Organizations.RemoveSecurityManagerTeam(ctx, "%", "t") + testURLParseError(t, err) +} From a15b991bb02c2089b4ae883be7dd3bd96ecd38ef Mon Sep 17 00:00:00 2001 From: Jeremy Hayes Date: Tue, 25 Oct 2022 21:21:33 -0400 Subject: [PATCH 2/4] update copyright year --- github/orgs_security_managers.go | 2 +- github/orgs_security_managers_test.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/github/orgs_security_managers.go b/github/orgs_security_managers.go index f3e8aff98b..df19da49c2 100644 --- a/github/orgs_security_managers.go +++ b/github/orgs_security_managers.go @@ -1,4 +1,4 @@ -// Copyright 2013 The go-github AUTHORS. All rights reserved. +// 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. diff --git a/github/orgs_security_managers_test.go b/github/orgs_security_managers_test.go index ffc0d8c0a3..111f1ce69f 100644 --- a/github/orgs_security_managers_test.go +++ b/github/orgs_security_managers_test.go @@ -1,4 +1,4 @@ -// Copyright 2013 The go-github AUTHORS. All rights reserved. +// 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. From db5a85de13a11c13f759457421e497672d4abd9e Mon Sep 17 00:00:00 2001 From: Jeremy Hayes Date: Tue, 25 Oct 2022 21:22:58 -0400 Subject: [PATCH 3/4] consolidate same-type params --- github/orgs_security_managers.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/github/orgs_security_managers.go b/github/orgs_security_managers.go index df19da49c2..a3f002e0e1 100644 --- a/github/orgs_security_managers.go +++ b/github/orgs_security_managers.go @@ -33,7 +33,7 @@ func (s *OrganizationsService) ListSecurityManagerTeams(ctx context.Context, org // AddSecurityManagerTeam adds a team to the list of security managers for an organization. // // GitHub API docs: https://docs.github.com/en/rest/orgs/security-managers#add-a-security-manager-team -func (s *OrganizationsService) AddSecurityManagerTeam(ctx context.Context, org string, team string) (*Response, error) { +func (s *OrganizationsService) AddSecurityManagerTeam(ctx context.Context, org, team string) (*Response, error) { u := fmt.Sprintf("orgs/%v/security-managers/teams/%v", org, team) req, err := s.client.NewRequest("PUT", u, nil) if err != nil { @@ -46,7 +46,7 @@ func (s *OrganizationsService) AddSecurityManagerTeam(ctx context.Context, org s // RemoveSecurityManagerTeam removes a team from the list of security managers for an organization. // // GitHub API docs: https://docs.github.com/en/rest/orgs/security-managers#remove-a-security-manager-team -func (s *OrganizationsService) RemoveSecurityManagerTeam(ctx context.Context, org string, team string) (*Response, error) { +func (s *OrganizationsService) RemoveSecurityManagerTeam(ctx context.Context, org, team string) (*Response, error) { u := fmt.Sprintf("orgs/%v/security-managers/teams/%v", org, team) req, err := s.client.NewRequest("DELETE", u, nil) if err != nil { From 8f99c898ffa2ffe9a1aa76d4ebfa331a0e6afee7 Mon Sep 17 00:00:00 2001 From: Jeremy Hayes Date: Tue, 25 Oct 2022 21:23:23 -0400 Subject: [PATCH 4/4] add missing newline --- github/orgs_security_managers_test.go | 1 + 1 file changed, 1 insertion(+) diff --git a/github/orgs_security_managers_test.go b/github/orgs_security_managers_test.go index 111f1ce69f..87fd9c69aa 100644 --- a/github/orgs_security_managers_test.go +++ b/github/orgs_security_managers_test.go @@ -48,6 +48,7 @@ func TestOrganizationsService_ListSecurityManagerTeams(t *testing.T) { return resp, err }) } + func TestOrganizationsService_ListSecurityManagerTeams_invalidOrg(t *testing.T) { client, _, _, teardown := setup() defer teardown()