✨ checks: add GitHub Webhook check #1675

cpanato · 2022-02-24T08:54:28Z

Please check if the PR fulfills these requirements

Tests for the changes have been added (for bug fixes / features)
PR title follows the guidelines defined in https://github.com/ossf/scorecard/blob/main/CONTRIBUTING.md#pr-process

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
This adds a new check to validate the GitHub repositories Webhooks if the webhook has a secret configured.
Tested with a token with public_repo permission only and worked.

Fixes #1655

TODO:

create a repo with webhooks configured to set up the e2e tests (@laurentsimon this is something that you can help with?)

What is the current behavior? (You can also link to an open issue here)
NONE
What is the new behavior (if this is a feature change)?
Add a new check to validate GitHub Webhook
Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
No
Other information:

codecov · 2022-02-24T08:56:50Z

Codecov Report

Merging #1675 (77236bf) into main (d10ac0d) will increase coverage by 2.91%.
The diff coverage is 44.91%.

❗ Current head 77236bf differs from pull request most recent head 36076d8. Consider uploading reports for the commit 36076d8 to get more accurate results

@@            Coverage Diff             @@
##             main    #1675      +/-   ##
==========================================
+ Coverage   54.71%   57.62%   +2.91%     
==========================================
  Files          67       71       +4     
  Lines        6521     6639     +118     
==========================================
+ Hits         3568     3826     +258     
+ Misses       2713     2563     -150     
- Partials      240      250      +10

github-actions · 2022-02-24T09:00:19Z

Integration tests success for
[bfd93e7]
(https://github.com/ossf/scorecard/actions/runs/1892072247)

github-actions · 2022-02-24T09:13:59Z

Integration tests success for
[4ac8dc5]
(https://github.com/ossf/scorecard/actions/runs/1892110248)

checks/raw/webhook.go

checks/webhook.go

clients/mockclients/repo_client.go

docs/checks.md

checks/webhook.go

github-actions · 2022-02-25T08:48:23Z

Integration tests success for
[c1d955c]
(https://github.com/ossf/scorecard/actions/runs/1897677836)

github-actions · 2022-02-25T08:51:45Z

Integration tests success for
[6ec2f92]
(https://github.com/ossf/scorecard/actions/runs/1897682442)

checks/webhook.go

azeemshaikh38

Looks good to me overall. Thanks for the awesome PR and for adding tests! Left some comments, please take a look.

checker/raw_result.go

checks/webhook.go

checks/raw/webhook.go

checks/webhook.go

laurentsimon

see comments inline

laurentsimon · 2022-02-25T15:55:22Z

UsesAuthSecret (as suggested by @azeemshaikh38) sounds good: it disambiguate the use case. HasSecret may be interpreted as a secret is stored and should be removed

docs/checks.md

laurentsimon

any update you'd like me to review?

checks/raw/webhook.go

github-actions · 2022-03-30T12:33:48Z

Integration tests success for
[ae28356]
(https://github.com/ossf/scorecard/actions/runs/2064721141)

github-actions · 2022-03-30T12:40:35Z

Integration tests success for
[54e0f3c]
(https://github.com/ossf/scorecard/actions/runs/2064756999)

azeemshaikh38

LG to submit.

checks/webhook.go

laurentsimon · 2022-03-30T23:20:15Z

protobuf compilation error, not your fault. Re-launching

github-actions · 2022-03-30T23:27:26Z

Integration tests success for
[77236bf]
(https://github.com/ossf/scorecard/actions/runs/2067935123)

cpanato · 2022-03-31T07:55:20Z

i will rebase

github-actions · 2022-03-31T08:03:10Z

Integration tests success for
[5be197f]
(https://github.com/ossf/scorecard/actions/runs/2069688157)

github-actions · 2022-03-31T10:34:19Z

Integration tests success for
[2885c3f]
(https://github.com/ossf/scorecard/actions/runs/2070405159)

Signed-off-by: Carlos Panato <[email protected]>

Signed-off-by: cpanato <[email protected]>

github-actions · 2022-03-31T13:26:45Z

Integration tests success for
[36076d8]
(https://github.com/ossf/scorecard/actions/runs/2071176374)

cpanato · 2022-03-31T14:11:17Z

all green now :)

laurentsimon · 2022-03-31T15:34:36Z

Thank you, fantastic work!

cpanato · 2022-03-31T15:39:04Z

thanks for all the reviews and feedback

cpanato requested review from olivekl, azeemshaikh38, inferno-chromium, justaugustus, laurentsimon and naveensrinivasan as code owners February 24, 2022 08:54

cpanato temporarily deployed to integration-test February 24, 2022 08:54 Inactive

cpanato force-pushed the GH-1655 branch from bfd93e7 to 4ac8dc5 Compare February 24, 2022 09:03

cpanato temporarily deployed to integration-test February 24, 2022 09:04 Inactive

laurentsimon mentioned this pull request Feb 25, 2022

Web hook secret used #1655

Closed

laurentsimon approved these changes Feb 25, 2022

View reviewed changes

checks/raw/webhook.go Show resolved Hide resolved

checks/webhook.go Outdated Show resolved Hide resolved

clients/mockclients/repo_client.go Outdated Show resolved Hide resolved

docs/checks.md Outdated Show resolved Hide resolved

docs/checks.md Show resolved Hide resolved

azeemshaikh38 reviewed Feb 25, 2022

View reviewed changes

checks/webhook.go Show resolved Hide resolved

cpanato force-pushed the GH-1655 branch from 4ac8dc5 to c1d955c Compare February 25, 2022 08:42

cpanato temporarily deployed to integration-test February 25, 2022 08:43 Inactive

cpanato force-pushed the GH-1655 branch from c1d955c to 6ec2f92 Compare February 25, 2022 08:43

cpanato temporarily deployed to integration-test February 25, 2022 08:45 Inactive

laurentsimon reviewed Feb 25, 2022

View reviewed changes

checks/webhook.go Outdated Show resolved Hide resolved

checks/webhook.go Outdated Show resolved Hide resolved

azeemshaikh38 reviewed Feb 25, 2022

View reviewed changes

checker/raw_result.go Outdated Show resolved Hide resolved

checks/webhook.go Outdated Show resolved Hide resolved

checks/raw/webhook.go Show resolved Hide resolved

checks/webhook.go Outdated Show resolved Hide resolved

checks/webhook.go Outdated Show resolved Hide resolved

laurentsimon reviewed Feb 25, 2022

View reviewed changes

olivekl reviewed Feb 25, 2022

View reviewed changes

docs/checks.md Outdated Show resolved Hide resolved

laurentsimon reviewed Mar 4, 2022

View reviewed changes

checks/raw/webhook.go Show resolved Hide resolved

cpanato force-pushed the GH-1655 branch from 6ec2f92 to ccf44ab Compare March 4, 2022 10:44

cpanato temporarily deployed to integration-test March 30, 2022 12:33 Inactive

azeemshaikh38 approved these changes Mar 30, 2022

View reviewed changes

checks/webhook.go Show resolved Hide resolved

laurentsimon enabled auto-merge (squash) March 30, 2022 23:20

laurentsimon temporarily deployed to integration-test March 30, 2022 23:20 Inactive

auto-merge was automatically disabled March 31, 2022 07:57
Head branch was pushed to by a user without write access

cpanato force-pushed the GH-1655 branch from 77236bf to 5be197f Compare March 31, 2022 07:57

cpanato temporarily deployed to integration-test March 31, 2022 07:57 Inactive

cpanato force-pushed the GH-1655 branch from 5be197f to 2885c3f Compare March 31, 2022 10:21

cpanato temporarily deployed to integration-test March 31, 2022 10:22 Inactive

cpanato added 5 commits March 31, 2022 15:01

checks: add GitHub Webhook check

33173c8

Signed-off-by: Carlos Panato <[email protected]>

update per feedback

66dcf28

Signed-off-by: cpanato <[email protected]>

add evaluation code

d70bdda

Signed-off-by: cpanato <[email protected]>

add feature gate check

af022f3

Signed-off-by: cpanato <[email protected]>

fix lint

36076d8

Signed-off-by: cpanato <[email protected]>

cpanato force-pushed the GH-1655 branch from 2885c3f to 36076d8 Compare March 31, 2022 13:01

cpanato temporarily deployed to integration-test March 31, 2022 13:09 Inactive

azeemshaikh38 merged commit 7dcb3cb into ossf:main Mar 31, 2022

cpanato deleted the GH-1655 branch March 31, 2022 15:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ checks: add GitHub Webhook check #1675

✨ checks: add GitHub Webhook check #1675

cpanato commented Feb 24, 2022 •

edited

Loading

codecov bot commented Feb 24, 2022 •

edited

Loading

github-actions bot commented Feb 24, 2022

github-actions bot commented Feb 24, 2022

github-actions bot commented Feb 25, 2022

github-actions bot commented Feb 25, 2022

azeemshaikh38 left a comment

laurentsimon left a comment

laurentsimon commented Feb 25, 2022

laurentsimon left a comment •

edited

Loading

github-actions bot commented Mar 30, 2022

github-actions bot commented Mar 30, 2022

azeemshaikh38 left a comment

laurentsimon commented Mar 30, 2022

github-actions bot commented Mar 30, 2022

cpanato commented Mar 31, 2022

github-actions bot commented Mar 31, 2022

github-actions bot commented Mar 31, 2022

github-actions bot commented Mar 31, 2022

cpanato commented Mar 31, 2022

laurentsimon commented Mar 31, 2022

cpanato commented Mar 31, 2022

✨ checks: add GitHub Webhook check #1675

✨ checks: add GitHub Webhook check #1675

Conversation

cpanato commented Feb 24, 2022 • edited Loading

TODO:

codecov bot commented Feb 24, 2022 • edited Loading

Codecov Report

github-actions bot commented Feb 24, 2022

github-actions bot commented Feb 24, 2022

github-actions bot commented Feb 25, 2022

github-actions bot commented Feb 25, 2022

azeemshaikh38 left a comment

Choose a reason for hiding this comment

laurentsimon left a comment

Choose a reason for hiding this comment

laurentsimon commented Feb 25, 2022

laurentsimon left a comment • edited Loading

Choose a reason for hiding this comment

github-actions bot commented Mar 30, 2022

github-actions bot commented Mar 30, 2022

azeemshaikh38 left a comment

Choose a reason for hiding this comment

laurentsimon commented Mar 30, 2022

github-actions bot commented Mar 30, 2022

cpanato commented Mar 31, 2022

github-actions bot commented Mar 31, 2022

github-actions bot commented Mar 31, 2022

github-actions bot commented Mar 31, 2022

cpanato commented Mar 31, 2022

laurentsimon commented Mar 31, 2022

cpanato commented Mar 31, 2022

cpanato commented Feb 24, 2022 •

edited

Loading

codecov bot commented Feb 24, 2022 •

edited

Loading

laurentsimon left a comment •

edited

Loading