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

go-playground / webhooks / 11185386857

04 Oct 2024 06:52PM UTC coverage: 88.583% (-0.4%) from 88.933%
11185386857

Pull #199

github

j2nullify
Autofix for finding 01J0HQ0A7GG1STVT9074R18TMZ
Pull Request #199: Autofix/01 j0 hq0 a7 gg1 stvt9074 r18 tmz

249 of 270 new or added lines in 9 files covered. (92.22%)

64 existing lines in 7 files now uncovered.

900 of 1016 relevant lines covered (88.58%)

8.77 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
)
78

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1✔
168
                signature = strings.TrimPrefix(signature, "sha256=")
169

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

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

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