• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

go-playground / webhooks / 12449836259

22 Dec 2024 12:49AM CUT coverage: 88.933%. Remained the same
12449836259

Pull #202

github

rjepstein
[bitbucket-server] Add Draft to PullRequest payload

Adds `Draft` to `PullRequest`

Object details:
https://confluence.atlassian.com/bitbucketserver/draft-pull-requests-1354498120.html
Support added in:
https://jira.atlassian.com/browse/BSERV-4262
Pull Request #202: [bitbucket-server] Add Draft to PullRequest payload

900 of 1012 relevant lines covered (88.93%)

8.8 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

94.96
/github/github.go
1
package github
2

3
import (
4
        "crypto/hmac"
5
        "crypto/sha256"
6
        "encoding/hex"
7
        "encoding/json"
8
        "errors"
9
        "fmt"
10
        "io"
11
        "net/http"
12
        "strings"
13
)
14

15
// parse errors
16
var (
17
        ErrEventNotSpecifiedToParse  = errors.New("no Event specified to parse")
18
        ErrInvalidHTTPMethod         = errors.New("invalid HTTP Method")
19
        ErrMissingGithubEventHeader  = errors.New("missing X-GitHub-Event Header")
20
        ErrMissingHubSignatureHeader = errors.New("missing X-Hub-Signature-256 Header")
21
        ErrEventNotFound             = errors.New("event not defined to be parsed")
22
        ErrParsingPayload            = errors.New("error parsing payload")
23
        ErrHMACVerificationFailed    = errors.New("HMAC verification failed")
24
)
25

26
// Event defines a GitHub hook event type
27
type Event string
28

29
// GitHub hook types
30
const (
31
        CheckRunEvent                            Event = "check_run"
32
        CheckSuiteEvent                          Event = "check_suite"
33
        CommitCommentEvent                       Event = "commit_comment"
34
        CreateEvent                              Event = "create"
35
        DeleteEvent                              Event = "delete"
36
        DependabotAlertEvent                     Event = "dependabot_alert"
37
        DeployKeyEvent                           Event = "deploy_key"
38
        DeploymentEvent                          Event = "deployment"
39
        DeploymentStatusEvent                    Event = "deployment_status"
40
        ForkEvent                                Event = "fork"
41
        GollumEvent                              Event = "gollum"
42
        InstallationEvent                        Event = "installation"
43
        InstallationRepositoriesEvent            Event = "installation_repositories"
44
        IntegrationInstallationEvent             Event = "integration_installation"
45
        IntegrationInstallationRepositoriesEvent Event = "integration_installation_repositories"
46
        IssueCommentEvent                        Event = "issue_comment"
47
        IssuesEvent                              Event = "issues"
48
        LabelEvent                               Event = "label"
49
        MemberEvent                              Event = "member"
50
        MembershipEvent                          Event = "membership"
51
        MilestoneEvent                           Event = "milestone"
52
        MetaEvent                                Event = "meta"
53
        OrganizationEvent                        Event = "organization"
54
        OrgBlockEvent                            Event = "org_block"
55
        PageBuildEvent                           Event = "page_build"
56
        PingEvent                                Event = "ping"
57
        ProjectCardEvent                         Event = "project_card"
58
        ProjectColumnEvent                       Event = "project_column"
59
        ProjectEvent                             Event = "project"
60
        PublicEvent                              Event = "public"
61
        PullRequestEvent                         Event = "pull_request"
62
        PullRequestReviewEvent                   Event = "pull_request_review"
63
        PullRequestReviewCommentEvent            Event = "pull_request_review_comment"
64
        PushEvent                                Event = "push"
65
        ReleaseEvent                             Event = "release"
66
        RepositoryEvent                          Event = "repository"
67
        RepositoryVulnerabilityAlertEvent        Event = "repository_vulnerability_alert"
68
        SecurityAdvisoryEvent                    Event = "security_advisory"
69
        StatusEvent                              Event = "status"
70
        TeamEvent                                Event = "team"
71
        TeamAddEvent                             Event = "team_add"
72
        WatchEvent                               Event = "watch"
73
        WorkflowDispatchEvent                    Event = "workflow_dispatch"
74
        WorkflowJobEvent                         Event = "workflow_job"
75
        WorkflowRunEvent                         Event = "workflow_run"
76
        GitHubAppAuthorizationEvent              Event = "github_app_authorization"
77
        CodeScanningAlertEvent                   Event = "code_scanning_alert"
78
)
79

80
// EventSubtype defines a GitHub Hook Event subtype
81
type EventSubtype string
82

83
// GitHub hook event subtypes
84
const (
85
        NoSubtype     EventSubtype = ""
86
        BranchSubtype EventSubtype = "branch"
87
        TagSubtype    EventSubtype = "tag"
88
        PullSubtype   EventSubtype = "pull"
89
        IssueSubtype  EventSubtype = "issues"
90
)
91

92
// Option is a configuration option for the webhook
93
type Option func(*Webhook) error
94

95
// Options is a namespace var for configuration options
96
var Options = WebhookOptions{}
97

98
// WebhookOptions is a namespace for configuration option methods
99
type WebhookOptions struct{}
100

101
// Secret registers the GitHub secret
102
func (WebhookOptions) Secret(secret string) Option {
1✔
103
        return func(hook *Webhook) error {
2✔
104
                hook.secret = secret
1✔
105
                return nil
1✔
106
        }
1✔
107
}
108

109
// Webhook instance contains all methods needed to process events
110
type Webhook struct {
111
        secret string
112
}
113

114
// New creates and returns a WebHook instance denoted by the Provider type
115
func New(options ...Option) (*Webhook, error) {
1✔
116
        hook := new(Webhook)
1✔
117
        for _, opt := range options {
2✔
118
                if err := opt(hook); err != nil {
1✔
119
                        return nil, errors.New("Error applying Option")
×
120
                }
×
121
        }
122
        return hook, nil
1✔
123
}
124

125
// Parse verifies and parses the events specified and returns the payload object or an error
126
func (hook Webhook) Parse(r *http.Request, events ...Event) (interface{}, error) {
53✔
127
        defer func() {
106✔
128
                _, _ = io.Copy(io.Discard, r.Body)
53✔
129
                _ = r.Body.Close()
53✔
130
        }()
53✔
131

132
        if len(events) == 0 {
53✔
133
                return nil, ErrEventNotSpecifiedToParse
×
134
        }
×
135
        if r.Method != http.MethodPost {
53✔
136
                return nil, ErrInvalidHTTPMethod
×
137
        }
×
138

139
        event := r.Header.Get("X-GitHub-Event")
53✔
140
        if event == "" {
54✔
141
                return nil, ErrMissingGithubEventHeader
1✔
142
        }
1✔
143
        gitHubEvent := Event(event)
52✔
144

52✔
145
        var found bool
52✔
146
        for _, evt := range events {
104✔
147
                if evt == gitHubEvent {
103✔
148
                        found = true
51✔
149
                        break
51✔
150
                }
151
        }
152
        // event not defined to be parsed
153
        if !found {
53✔
154
                return nil, ErrEventNotFound
1✔
155
        }
1✔
156

157
        payload, err := io.ReadAll(r.Body)
51✔
158
        if err != nil || len(payload) == 0 {
52✔
159
                return nil, ErrParsingPayload
1✔
160
        }
1✔
161

162
        // If we have a Secret set, we should check the MAC
163
        if len(hook.secret) > 0 {
100✔
164
                signature := r.Header.Get("X-Hub-Signature-256")
50✔
165
                if len(signature) == 0 {
51✔
166
                        return nil, ErrMissingHubSignatureHeader
1✔
167
                }
1✔
168

169
                signature = strings.TrimPrefix(signature, "sha256=")
49✔
170

49✔
171
                mac := hmac.New(sha256.New, []byte(hook.secret))
49✔
172
                _, _ = mac.Write(payload)
49✔
173
                expectedMAC := hex.EncodeToString(mac.Sum(nil))
49✔
174

49✔
175
                if !hmac.Equal([]byte(signature), []byte(expectedMAC)) {
50✔
176
                        return nil, ErrHMACVerificationFailed
1✔
177
                }
1✔
178
        }
179

180
        switch gitHubEvent {
48✔
181
        case CheckRunEvent:
1✔
182
                var pl CheckRunPayload
1✔
183
                err = json.Unmarshal([]byte(payload), &pl)
1✔
184
                return pl, err
1✔
185
        case CheckSuiteEvent:
1✔
186
                var pl CheckSuitePayload
1✔
187
                err = json.Unmarshal([]byte(payload), &pl)
1✔
188
                return pl, err
1✔
189
        case CommitCommentEvent:
1✔
190
                var pl CommitCommentPayload
1✔
191
                err = json.Unmarshal([]byte(payload), &pl)
1✔
192
                return pl, err
1✔
193
        case CreateEvent:
1✔
194
                var pl CreatePayload
1✔
195
                err = json.Unmarshal([]byte(payload), &pl)
1✔
196
                return pl, err
1✔
197
        case DeployKeyEvent:
1✔
198
                var pl DeployKeyPayload
1✔
199
                err = json.Unmarshal([]byte(payload), &pl)
1✔
200
                return pl, err
1✔
201
        case DeleteEvent:
1✔
202
                var pl DeletePayload
1✔
203
                err = json.Unmarshal([]byte(payload), &pl)
1✔
204
                return pl, err
1✔
205
        case DependabotAlertEvent:
1✔
206
                var pl DependabotAlertPayload
1✔
207
                err = json.Unmarshal([]byte(payload), &pl)
1✔
208
                return pl, err
1✔
209
        case DeploymentEvent:
1✔
210
                var pl DeploymentPayload
1✔
211
                err = json.Unmarshal([]byte(payload), &pl)
1✔
212
                return pl, err
1✔
213
        case DeploymentStatusEvent:
1✔
214
                var pl DeploymentStatusPayload
1✔
215
                err = json.Unmarshal([]byte(payload), &pl)
1✔
216
                return pl, err
1✔
217
        case ForkEvent:
1✔
218
                var pl ForkPayload
1✔
219
                err = json.Unmarshal([]byte(payload), &pl)
1✔
220
                return pl, err
1✔
221
        case GollumEvent:
1✔
222
                var pl GollumPayload
1✔
223
                err = json.Unmarshal([]byte(payload), &pl)
1✔
224
                return pl, err
1✔
225
        case InstallationEvent, IntegrationInstallationEvent:
2✔
226
                var pl InstallationPayload
2✔
227
                err = json.Unmarshal([]byte(payload), &pl)
2✔
228
                return pl, err
2✔
229
        case InstallationRepositoriesEvent, IntegrationInstallationRepositoriesEvent:
2✔
230
                var pl InstallationRepositoriesPayload
2✔
231
                err = json.Unmarshal([]byte(payload), &pl)
2✔
232
                return pl, err
2✔
233
        case IssueCommentEvent:
2✔
234
                var pl IssueCommentPayload
2✔
235
                err = json.Unmarshal([]byte(payload), &pl)
2✔
236
                return pl, err
2✔
237
        case IssuesEvent:
1✔
238
                var pl IssuesPayload
1✔
239
                err = json.Unmarshal([]byte(payload), &pl)
1✔
240
                return pl, err
1✔
241
        case LabelEvent:
1✔
242
                var pl LabelPayload
1✔
243
                err = json.Unmarshal([]byte(payload), &pl)
1✔
244
                return pl, err
1✔
245
        case MemberEvent:
1✔
246
                var pl MemberPayload
1✔
247
                err = json.Unmarshal([]byte(payload), &pl)
1✔
248
                return pl, err
1✔
249
        case MembershipEvent:
1✔
250
                var pl MembershipPayload
1✔
251
                err = json.Unmarshal([]byte(payload), &pl)
1✔
252
                return pl, err
1✔
253
        case MetaEvent:
×
254
                var pl MetaPayload
×
255
                err = json.Unmarshal([]byte(payload), &pl)
×
256
                return pl, err
×
257
        case MilestoneEvent:
1✔
258
                var pl MilestonePayload
1✔
259
                err = json.Unmarshal([]byte(payload), &pl)
1✔
260
                return pl, err
1✔
261
        case OrganizationEvent:
1✔
262
                var pl OrganizationPayload
1✔
263
                err = json.Unmarshal([]byte(payload), &pl)
1✔
264
                return pl, err
1✔
265
        case OrgBlockEvent:
1✔
266
                var pl OrgBlockPayload
1✔
267
                err = json.Unmarshal([]byte(payload), &pl)
1✔
268
                return pl, err
1✔
269
        case PageBuildEvent:
1✔
270
                var pl PageBuildPayload
1✔
271
                err = json.Unmarshal([]byte(payload), &pl)
1✔
272
                return pl, err
1✔
273
        case PingEvent:
1✔
274
                var pl PingPayload
1✔
275
                err = json.Unmarshal([]byte(payload), &pl)
1✔
276
                return pl, err
1✔
277
        case ProjectCardEvent:
1✔
278
                var pl ProjectCardPayload
1✔
279
                err = json.Unmarshal([]byte(payload), &pl)
1✔
280
                return pl, err
1✔
281
        case ProjectColumnEvent:
1✔
282
                var pl ProjectColumnPayload
1✔
283
                err = json.Unmarshal([]byte(payload), &pl)
1✔
284
                return pl, err
1✔
285
        case ProjectEvent:
1✔
286
                var pl ProjectPayload
1✔
287
                err = json.Unmarshal([]byte(payload), &pl)
1✔
288
                return pl, err
1✔
289
        case PublicEvent:
1✔
290
                var pl PublicPayload
1✔
291
                err = json.Unmarshal([]byte(payload), &pl)
1✔
292
                return pl, err
1✔
293
        case PullRequestEvent:
1✔
294
                var pl PullRequestPayload
1✔
295
                err = json.Unmarshal([]byte(payload), &pl)
1✔
296
                return pl, err
1✔
297
        case PullRequestReviewEvent:
1✔
298
                var pl PullRequestReviewPayload
1✔
299
                err = json.Unmarshal([]byte(payload), &pl)
1✔
300
                return pl, err
1✔
301
        case PullRequestReviewCommentEvent:
1✔
302
                var pl PullRequestReviewCommentPayload
1✔
303
                err = json.Unmarshal([]byte(payload), &pl)
1✔
304
                return pl, err
1✔
305
        case PushEvent:
1✔
306
                var pl PushPayload
1✔
307
                err = json.Unmarshal([]byte(payload), &pl)
1✔
308
                return pl, err
1✔
309
        case ReleaseEvent:
1✔
310
                var pl ReleasePayload
1✔
311
                err = json.Unmarshal([]byte(payload), &pl)
1✔
312
                return pl, err
1✔
313
        case RepositoryEvent:
2✔
314
                var pl RepositoryPayload
2✔
315
                err = json.Unmarshal([]byte(payload), &pl)
2✔
316
                return pl, err
2✔
317
        case RepositoryVulnerabilityAlertEvent:
1✔
318
                var pl RepositoryVulnerabilityAlertPayload
1✔
319
                err = json.Unmarshal([]byte(payload), &pl)
1✔
320
                return pl, err
1✔
321
        case SecurityAdvisoryEvent:
1✔
322
                var pl SecurityAdvisoryPayload
1✔
323
                err = json.Unmarshal([]byte(payload), &pl)
1✔
324
                return pl, err
1✔
325
        case StatusEvent:
1✔
326
                var pl StatusPayload
1✔
327
                err = json.Unmarshal([]byte(payload), &pl)
1✔
328
                return pl, err
1✔
329
        case TeamEvent:
1✔
330
                var pl TeamPayload
1✔
331
                err = json.Unmarshal([]byte(payload), &pl)
1✔
332
                return pl, err
1✔
333
        case TeamAddEvent:
1✔
334
                var pl TeamAddPayload
1✔
335
                err = json.Unmarshal([]byte(payload), &pl)
1✔
336
                return pl, err
1✔
337
        case WatchEvent:
1✔
338
                var pl WatchPayload
1✔
339
                err = json.Unmarshal([]byte(payload), &pl)
1✔
340
                return pl, err
1✔
341
        case WorkflowDispatchEvent:
1✔
342
                var pl WorkflowDispatchPayload
1✔
343
                err = json.Unmarshal([]byte(payload), &pl)
1✔
344
                return pl, err
1✔
345
        case WorkflowJobEvent:
1✔
346
                var pl WorkflowJobPayload
1✔
347
                err = json.Unmarshal([]byte(payload), &pl)
1✔
348
                return pl, err
1✔
349
        case WorkflowRunEvent:
1✔
350
                var pl WorkflowRunPayload
1✔
351
                err = json.Unmarshal([]byte(payload), &pl)
1✔
352
                return pl, err
1✔
353
        case GitHubAppAuthorizationEvent:
1✔
354
                var pl GitHubAppAuthorizationPayload
1✔
355
                err = json.Unmarshal([]byte(payload), &pl)
1✔
356
                return pl, err
1✔
357
        case CodeScanningAlertEvent:
1✔
358
                var pl CodeScanningAlertPayload
1✔
359
                err = json.Unmarshal([]byte(payload), &pl)
1✔
360
                return pl, err
1✔
361
        default:
×
362
                return nil, fmt.Errorf("unknown event %s", gitHubEvent)
×
363
        }
364
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc