Skip to content
This repository was archived by the owner on Dec 10, 2024. It is now read-only.

Commit 038237c

Browse files
GreyeyeGreyeye
committed
new api for service account and personal access tokens handler.
1 parent 3e35f87 commit 038237c

File tree

2 files changed

+271
-0
lines changed

2 files changed

+271
-0
lines changed

‎group_serviceaccounts.go

+131
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
//
2+
// Copyright 2023, James Hong
3+
//
4+
// Licensed under the Apache License, Version 2.0 (the "License");
5+
// you may not use this file except in compliance with the License.
6+
// You may obtain a copy of the License at
7+
//
8+
// http://www.apache.org/licenses/LICENSE-2.0
9+
//
10+
// Unless required by applicable law or agreed to in writing, software
11+
// distributed under the License is distributed on an "AS IS" BASIS,
12+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
// See the License for the specific language governing permissions and
14+
// limitations under the License.
15+
//
16+
17+
package gitlab
18+
19+
import (
20+
"fmt"
21+
"net/http"
22+
"time"
23+
)
24+
25+
// GroupServiceAccount represents a GitLab service account user.
26+
//
27+
// GitLab API docs: https://docs.gitlab.com/ee/api/groups.html#create-service-account-user
28+
type GroupServiceAccount struct {
29+
ID int `json:"id"`
30+
Name string `json:"name"`
31+
UserName string `json:"username"`
32+
}
33+
34+
// CreateServiceAccount create a new service account user for a group.
35+
//
36+
// GitLab API docs: https://docs.gitlab.com/ee/api/groups.html#create-service-account-user
37+
func (s *GroupsService) CreateServiceAccount(gid interface{}, options ...RequestOptionFunc) (*GroupServiceAccount, *Response, error) {
38+
group, err := parseID(gid)
39+
if err != nil {
40+
return nil, nil, err
41+
}
42+
u := fmt.Sprintf("groups/%s/service_accounts", PathEscape(group))
43+
44+
req, err := s.client.NewRequest(http.MethodPost, u, nil, options)
45+
if err != nil {
46+
return nil, nil, err
47+
}
48+
49+
sa := new(GroupServiceAccount)
50+
resp, err := s.client.Do(req, sa)
51+
if err != nil {
52+
return nil, resp, err
53+
}
54+
55+
return sa, resp, nil
56+
}
57+
58+
// GroupServiceAccountPAT represents a GitLab service account Personal Access Token.
59+
//
60+
// GitLab API docs: https://docs.gitlab.com/ee/api/groups.html#create-personal-access-token-for-service-account-user
61+
type GroupServiceAccountPAT struct {
62+
ID int `json:"id"`
63+
Name string `json:"name"`
64+
Revoked bool `json:"revoked"`
65+
CreatedAt *time.Time `json:"created_at"`
66+
Scopes []string `json:"scopes"`
67+
UserID int `json:"user_id"`
68+
LastUsedAt interface{} `json:"last_used_at"`
69+
Active bool `json:"active"`
70+
ExpiresAt string `json:"expires_at"`
71+
Token string `json:"token"`
72+
}
73+
74+
// AddServiceAccountsPATOptions represents the available AddServiceAccountsPAT() options.
75+
//
76+
// GitLab API docs: https://docs.gitlab.com/ee/api/groups.html#create-personal-access-token-for-service-account-user
77+
type AddServiceAccountsPATOptions struct {
78+
// Scopes cover the ranges of permission sets.
79+
// https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#personal-access-token-scopes
80+
// e.g. api, read_user, read_api, read_repository, read_registry
81+
Scopes []string `json:"scopes,omitempty"`
82+
Name string `json:"name,omitempty"`
83+
}
84+
85+
// AddServiceAccountsPAT add a new PAT for a service account user for a group.
86+
//
87+
// GitLab API docs: https://docs.gitlab.com/ee/api/groups.html#add-group-hook
88+
func (s *GroupsService) AddServiceAccountsPAT(gid interface{}, saID int, opt *AddServiceAccountsPATOptions, options ...RequestOptionFunc) (*GroupServiceAccountPAT, *Response, error) {
89+
group, err := parseID(gid)
90+
if err != nil {
91+
return nil, nil, err
92+
}
93+
u := fmt.Sprintf("groups/%s/service_accounts/%d/personal_access_tokens", PathEscape(group), saID)
94+
95+
req, err := s.client.NewRequest(http.MethodPost, u, opt, options)
96+
if err != nil {
97+
return nil, nil, err
98+
}
99+
100+
pat := new(GroupServiceAccountPAT)
101+
resp, err := s.client.Do(req, pat)
102+
if err != nil {
103+
return nil, resp, err
104+
}
105+
106+
return pat, resp, nil
107+
}
108+
109+
// RotateServiceAccountsPAT rotate a PAT for a service account user for a group.
110+
//
111+
// GitLab API docs: https://docs.gitlab.com/ee/api/groups.html#create-personal-access-token-for-service-account-user
112+
func (s *GroupsService) RotateServiceAccountsPAT(gid interface{}, saID, tokenID int, options ...RequestOptionFunc) (*GroupServiceAccountPAT, *Response, error) {
113+
group, err := parseID(gid)
114+
if err != nil {
115+
return nil, nil, err
116+
}
117+
u := fmt.Sprintf("groups/%s/service_accounts/%d/personal_access_tokens/%d/rotate", PathEscape(group), saID, tokenID)
118+
119+
req, err := s.client.NewRequest(http.MethodPost, u, nil, options)
120+
if err != nil {
121+
return nil, nil, err
122+
}
123+
124+
pat := new(GroupServiceAccountPAT)
125+
resp, err := s.client.Do(req, pat)
126+
if err != nil {
127+
return nil, resp, err
128+
}
129+
130+
return pat, resp, nil
131+
}

‎group_serviceaccounts_test.go

+140
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
//
2+
// Copyright 2023, James Hong
3+
//
4+
// Licensed under the Apache License, Version 2.0 (the "License");
5+
// you may not use this file except in compliance with the License.
6+
// You may obtain a copy of the License at
7+
//
8+
// http://www.apache.org/licenses/LICENSE-2.0
9+
//
10+
// Unless required by applicable law or agreed to in writing, software
11+
// distributed under the License is distributed on an "AS IS" BASIS,
12+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
// See the License for the specific language governing permissions and
14+
// limitations under the License.
15+
//
16+
17+
package gitlab
18+
19+
import (
20+
"fmt"
21+
"net/http"
22+
"reflect"
23+
"testing"
24+
"time"
25+
)
26+
27+
func TestCreateServiceAccount(t *testing.T) {
28+
mux, client := setup(t)
29+
30+
mux.HandleFunc("/api/v4/groups/1/service_accounts", func(w http.ResponseWriter, r *http.Request) {
31+
testMethod(t, r, http.MethodPost)
32+
fmt.Fprint(w, `
33+
{
34+
"id": 57,
35+
"username": "service_account_group_345_6018816a18e515214e0c34c2b33523fc",
36+
"name": "Service account user"
37+
}`)
38+
})
39+
40+
sa, _, err := client.Groups.CreateServiceAccount(1)
41+
if err != nil {
42+
t.Error(err)
43+
}
44+
45+
want := &GroupServiceAccount{
46+
ID: 57,
47+
UserName: "service_account_group_345_6018816a18e515214e0c34c2b33523fc",
48+
Name: "Service account user",
49+
}
50+
51+
if !reflect.DeepEqual(sa, want) {
52+
t.Errorf("CreateServiceAccount returned \ngot:\n%v\nwant:\n%v", Stringify(sa), Stringify(want))
53+
}
54+
}
55+
56+
func TestAddServiceAccountsPATServiceAccount(t *testing.T) {
57+
mux, client := setup(t)
58+
59+
mux.HandleFunc("/api/v4/groups/1/service_accounts/57/personal_access_tokens", func(w http.ResponseWriter, r *http.Request) {
60+
testMethod(t, r, http.MethodPost)
61+
fmt.Fprint(w, `
62+
{
63+
"id":6,
64+
"name":"service_accounts_token",
65+
"revoked":false,
66+
"created_at":"2023-06-13T07:47:13.000Z",
67+
"scopes":["api"],
68+
"user_id":71,
69+
"last_used_at":null,
70+
"active":true,
71+
"expires_at":"2024-06-12",
72+
"token":"random_token"
73+
}`)
74+
})
75+
datePointer := time.Date(2023, 06, 13, 07, 47, 13, 0, time.UTC)
76+
saPAT, _, err := client.Groups.AddServiceAccountsPAT(1, 57, &AddServiceAccountsPATOptions{Scopes: []string{"api"}, Name: "service_accounts_token"})
77+
if err != nil {
78+
t.Error(err)
79+
}
80+
81+
want := &GroupServiceAccountPAT{
82+
ID: 6,
83+
Name: "service_accounts_token",
84+
Revoked: false,
85+
CreatedAt: &datePointer,
86+
Scopes: []string{"api"},
87+
UserID: 71,
88+
LastUsedAt: nil,
89+
Active: true,
90+
ExpiresAt: "2024-06-12",
91+
Token: "random_token",
92+
}
93+
94+
if !reflect.DeepEqual(saPAT, want) {
95+
t.Errorf("AddServiceAccountsPAT returned \ngot:\n%v\nwant:\n%v", Stringify(saPAT), Stringify(want))
96+
}
97+
}
98+
99+
func TestRotateServiceAccountsPATServiceAccount(t *testing.T) {
100+
mux, client := setup(t)
101+
102+
mux.HandleFunc("/api/v4/groups/1/service_accounts/57/personal_access_tokens/6/rotate", func(w http.ResponseWriter, r *http.Request) {
103+
testMethod(t, r, http.MethodPost)
104+
fmt.Fprint(w, `
105+
{
106+
"id":7,
107+
"name":"service_accounts_token",
108+
"revoked":false,
109+
"created_at":"2023-06-13T07:54:49.000Z",
110+
"scopes":["api"],
111+
"user_id":71,
112+
"last_used_at":null,
113+
"active":true,
114+
"expires_at":"2025-06-20",
115+
"token":"random_token_2"
116+
}`)
117+
})
118+
datePointer := time.Date(2023, 06, 13, 07, 54, 49, 0, time.UTC)
119+
saPAT, _, err := client.Groups.RotateServiceAccountsPAT(1, 57, 6)
120+
if err != nil {
121+
t.Error(err)
122+
}
123+
124+
want := &GroupServiceAccountPAT{
125+
ID: 7,
126+
Name: "service_accounts_token",
127+
Revoked: false,
128+
CreatedAt: &datePointer,
129+
Scopes: []string{"api"},
130+
UserID: 71,
131+
LastUsedAt: nil,
132+
Active: true,
133+
ExpiresAt: "2025-06-20",
134+
Token: "random_token_2",
135+
}
136+
137+
if !reflect.DeepEqual(saPAT, want) {
138+
t.Errorf("RotateServiceAccountsPAT returned \ngot:\n%v\nwant:\n%v", Stringify(saPAT), Stringify(want))
139+
}
140+
}

0 commit comments

Comments
 (0)