forked from openshift-pipelines/pipelines-as-code
-
Notifications
You must be signed in to change notification settings - Fork 0
/
acl.go
179 lines (157 loc) · 5.12 KB
/
acl.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
package github
import (
"context"
"fmt"
"net/http"
"strings"
"github.com/google/go-github/v42/github"
"github.com/openshift-pipelines/pipelines-as-code/pkg/acl"
"github.com/openshift-pipelines/pipelines-as-code/pkg/params/info"
)
func (v *Provider) IsAllowed(ctx context.Context, event *info.Event) (bool, error) {
// Do most of the checks first, if user is a owner or in a organisation
allowed, err := v.aclCheckAll(ctx, event)
if err != nil {
return false, err
}
if allowed {
return true, nil
}
// Finally try to parse all comments
return v.aclAllowedOkToTestFromAnOwner(ctx, event)
}
// allowedOkToTestFromAnOwner Go over every comments in a pull request and check
// if there is a /ok-to-test in there running an aclCheck again on the comment
// Sender if she is an OWNER and then allow it to run CI.
// TODO: pull out the github logic from there in an agnostic way.
func (v *Provider) aclAllowedOkToTestFromAnOwner(ctx context.Context, event *info.Event) (bool, error) {
revent := &info.Event{}
event.DeepCopyInto(revent)
revent.EventType = ""
revent.TriggerTarget = ""
if revent.Event == nil {
return false, nil
}
switch event := revent.Event.(type) {
case *github.IssueCommentEvent:
revent.URL = event.Issue.GetPullRequestLinks().GetHTMLURL()
case *github.PullRequestEvent:
revent.URL = event.GetPullRequest().GetHTMLURL()
default:
return false, nil
}
comments, err := v.GetStringPullRequestComment(ctx, revent, acl.OKToTestCommentRegexp)
if err != nil {
return false, err
}
for _, comment := range comments {
revent.Sender = comment.User.GetLogin()
allowed, err := v.aclCheckAll(ctx, revent)
if err != nil {
return false, err
}
if allowed {
return true, nil
}
}
return false, nil
}
// aclCheck check if we are allowed to run the pipeline on that PR
func (v *Provider) aclCheckAll(ctx context.Context, rev *info.Event) (bool, error) {
if rev.Organization == rev.Sender {
return true, nil
}
// If the user who has submitted the pr is a owner on the repo then allows
// the CI to be run.
isUserMemberRepo, err := v.checkSenderOrgMembership(ctx, rev)
if err != nil {
return false, err
}
if isUserMemberRepo {
return true, nil
}
checkSenderRepoMembership, err := v.checkSenderRepoMembership(ctx, rev)
if err != nil {
return false, err
}
if checkSenderRepoMembership {
return true, nil
}
// If we have a prow OWNERS file in the defaultBranch (ie: master) then
// parse it in approvers and reviewers field and check if sender is in there.
ownerContent, err := v.getFileFromDefaultBranch(ctx, "OWNERS", rev)
if err != nil {
if strings.Contains(err.Error(), "cannot find") {
// no owner file, skipping
return false, nil
}
return false, err
}
return acl.UserInOwnerFile(ownerContent, rev.Sender)
}
// checkSenderOrgMembership Get sender user's organization. We can
// only get the one that the user sets as public 🤷
func (v *Provider) checkSenderOrgMembership(ctx context.Context, runevent *info.Event) (bool, error) {
users, resp, err := v.Client.Organizations.ListMembers(ctx, runevent.Organization,
&github.ListMembersOptions{
PublicOnly: true, // We can't list private member in a org
})
// If we are 404 it means we are checking a repo owner and not a org so let's bail out with grace
if resp != nil && resp.Response.StatusCode == http.StatusNotFound {
return false, nil
}
if err != nil {
return false, err
}
for _, v := range users {
if v.GetLogin() == runevent.Sender {
return true, nil
}
}
return false, nil
}
// checkSenderRepoMembership check if user is allowed to run CI
func (v *Provider) checkSenderRepoMembership(ctx context.Context, runevent *info.Event) (bool, error) {
users, _, err := v.Client.Repositories.ListCollaborators(ctx,
runevent.Organization,
runevent.Repository,
&github.ListCollaboratorsOptions{})
if err != nil {
return false, err
}
for _, v := range users {
if v.GetLogin() == runevent.Sender {
return true, nil
}
}
return false, nil
}
// getFileFromDefaultBranch will get a file directly from the Default BaseBranch as
// configured in runinfo which is directly set in webhook by Github
func (v *Provider) getFileFromDefaultBranch(ctx context.Context, path string, runevent *info.Event) (string, error) {
tektonyaml, err := v.GetFileInsideRepo(ctx, runevent, path, runevent.DefaultBranch)
if err != nil {
return "", fmt.Errorf("cannot find %s inside the %s branch: %w", path, runevent.DefaultBranch, err)
}
return tektonyaml, err
}
// GetStringPullRequestComment return the comment if we find a regexp in one of
// the comments text of a pull request
func (v *Provider) GetStringPullRequestComment(ctx context.Context, runevent *info.Event, reg string) ([]*github.IssueComment, error) {
var ret []*github.IssueComment
prNumber, err := convertPullRequestURLtoNumber(runevent.URL)
if err != nil {
return nil, err
}
comments, _, err := v.Client.Issues.ListComments(ctx, runevent.Organization, runevent.Repository,
prNumber, &github.IssueListCommentsOptions{})
if err != nil {
return nil, err
}
for _, v := range comments {
if acl.MatchRegexp(reg, v.GetBody()) {
ret = append(ret, v)
}
}
return ret, nil
}