Create a Golang-based entrypoint for scorecard-action (1/n) #122

justaugustus · 2022-02-27T17:39:33Z

Part of #107.

Signed-off-by: Stephen Augustus foo@auggie.dev

codecov · 2022-02-27T18:50:55Z

Codecov Report

Merging #122 (29e94f2) into main (d6456f6) will increase coverage by 2.62%.
The diff coverage is 69.02%.

@@            Coverage Diff             @@
##             main     #122      +/-   ##
==========================================
+ Coverage   66.39%   69.02%   +2.62%     
==========================================
  Files           1        2       +1     
  Lines         247      113     -134     
==========================================
- Hits          164       78      -86     
+ Misses         77       27      -50     
- Partials        6        8       +2

Impacted Files	Coverage Δ
options/options.go	`68.46% <68.46%> (ø)`
options/env.go	`100.00% <100.00%> (ø)`
main.go

laurentsimon · 2022-02-28T17:30:04Z

cc @rohankh532

naveensrinivasan

Looks good. Thank you!, I didn't approve it because I would like @laurentsimon also to review it.

azeemshaikh38

This is awesome @justaugustus, thanks! Same comment as @naveensrinivasan, will wait for @laurentsimon review.

options/options.go

github/github.go

justaugustus · 2022-03-04T18:21:54Z

I want to call out the test failures here:

Unit tests (https://github.com/ossf/scorecard-action/runs/5426123389?check_suite_focus=true):

Run go test -covermode=atomic  -coverprofile=unit-coverage.out ./...
  go test -covermode=atomic  -coverprofile=unit-coverage.out ./...
  shell: /usr/bin/bash -e {0}
  env:
    GOROOT: /opt/hostedtoolcache/go/1.17.7/x64
?   	github.com/ossf/scorecard-action	[no test files]
ok  	github.com/ossf/scorecard-action/entrypoint	0.009s	coverage: 0.0% of statements [no tests to run]
?   	github.com/ossf/scorecard-action/github	[no test files]
--- FAIL: TestNew (0.00s)
    --- FAIL: TestNew/SuccessFormatSARIF (0.00s)
        options_test.go:107: New() error = validating scorecard options: some options could not be validated: [commit option is not supported yet], wantErr false
    --- FAIL: TestNew/SuccessFormatJSON (0.00s)
        options_test.go:107: New() error = validating scorecard options: some options could not be validated: [commit option is not supported yet], wantErr false
FAIL
coverage: 43.9% of statements
FAIL	github.com/ossf/scorecard-action/options	0.012s
FAIL
Error: Process completed with exit code 1.

golangci-lint (https://github.com/ossf/scorecard-action/runs/5426123392?check_suite_focus=true):

Run golangci/golangci-lint-action@b517f99ae23d86ecc4c0dec08dcf48d2336abc29
prepare environment
run golangci-lint
  Running [/home/runner/golangci-lint-1.44.0-linux-amd64/golangci-lint run --out-format=github-actions --new-from-patch=/tmp/tmp-1656-d52rcyaL5U29/pull.patch --new=false --new-from-rev=] in [] ...
  Error: File is not `gci`-ed (gci)
  Error: File is not `gci`-ed (gci)
  Error: File is not `gci`-ed (gci)
  
  Error: issues found
  Ran golangci-lint in 3505ms

VS what happens locally...

❯ time go test -v -covermode=atomic  -coverprofile=unit-coverage.out ./...
?   	github.com/ossf/scorecard-action	[no test files]
testing: warning: no tests to run
PASS
coverage: 0.0% of statements
ok  	github.com/ossf/scorecard-action/entrypoint	0.354s	coverage: 0.0% of statements [no tests to run]
?   	github.com/ossf/scorecard-action/github	[no test files]
=== RUN   TestNew
=== RUN   TestNew/SuccessFormatSARIF
=== RUN   TestNew/SuccessFormatJSON
--- PASS: TestNew (0.00s)
    --- PASS: TestNew/SuccessFormatSARIF (0.00s)
    --- PASS: TestNew/SuccessFormatJSON (0.00s)
=== RUN   TestInitialize
=== RUN   TestInitialize/Success
=== RUN   TestInitialize/FailureNoFieldsSet
=== RUN   TestInitialize/FailureBadEventPath
=== RUN   TestInitialize/FailureBadEventData
--- PASS: TestInitialize (0.00s)
    --- PASS: TestInitialize/Success (0.00s)
    --- PASS: TestInitialize/FailureNoFieldsSet (0.00s)
    --- PASS: TestInitialize/FailureBadEventPath (0.00s)
    --- PASS: TestInitialize/FailureBadEventData (0.00s)
PASS
coverage: 54.4% of statements
ok  	github.com/ossf/scorecard-action/options	0.226s	coverage: 54.4% of statements
go test -v -covermode=atomic -coverprofile=unit-coverage.out ./...  1.86s user 1.12s system 165% cpu 1.798 total

❯ time golangci-lint run -c .golangci.yml
golangci-lint run -c .golangci.yml  1.33s user 1.01s system 210% cpu 1.116 total

Something is up with CI tests; will check it out.

azeemshaikh38 · 2022-03-04T20:31:59Z

Something is up with CI tests; will check it out.

A wild guess, the golangci-lint that is being downloaded by CI (through make install) is probably pulling some version that's broken (or atleast different than your local instance).

justaugustus · 2022-03-04T20:34:36Z

A wild guess, the golangci-lint that is being downloaded by CI (through make install) is probably pulling some version that's broken (or atleast different than your local instance).

Yep! I'm checking out https://github.com/nektos/act locally to see if I can mimic the GitHub Action env.

azeemshaikh38 · 2022-03-04T20:40:09Z

A wild guess, the golangci-lint that is being downloaded by CI (through make install) is probably pulling some version that's broken (or atleast different than your local instance).

Yep! I'm checking out https://github.com/nektos/act locally to see if I can mimic the GitHub Action env.

Nice! That's a pretty cool tool. @laurentsimon might help in testing scorecard-action locally.

justaugustus · 2022-03-04T20:42:32Z

Nice! That's a pretty cool tool. @laurentsimon might help in testing scorecard-action locally.

Exactly what I was thinking!

justaugustus · 2022-03-06T22:46:11Z

Something is up with CI tests; will check it out.

A wild guess, the golangci-lint that is being downloaded by CI (through make install) is probably pulling some version that's broken (or atleast different than your local instance).

@azeemshaikh38 @naveensrinivasan -- Can you take a peek at #126? That PR fixes the lint config.

Signed-off-by: Stephen Augustus <foo@auggie.dev>

justaugustus · 2022-03-07T05:42:01Z

@laurentsimon @azeemshaikh38 @naveensrinivasan -- I think this is a good stopping point. There's a bunch more to do, but all of the tests are passing and I'd to unblock the work happening in #120 (cc: @rohankh532).

azeemshaikh38

LGTM, thanks!

azeemshaikh38 · 2022-03-07T16:42:06Z

github/github.go

+	method := "GET"
+	req, err := http.NewRequestWithContext(
+		c.ctx,
+		method,


Can use http.MethodGet here instead.

…recard-action#122) * Move entrypoint logic to separate package * options: env var-mapped structs via github.com/caarlos0/env/v6 * go.mod: Update scorecard to v4.1.1-0.20220306220811-4b9f0389c6f6 * entrypoint: Wrap scorecard with additional flags and hide unused * entrypoint: Add `print-config` command * options: Process GitHub info together * options: Cleanups and defaulting for action-specific settings * github: Move GitHub logic to a separate package * entrypoint: Support outputting to file * Rewrite unit tests * Allow options tests to pass in GitHub Actions environments Signed-off-by: Stephen Augustus <foo@auggie.dev>

justaugustus mentioned this pull request Feb 27, 2022

Use Scorecard's Go APIs #107

Closed

justaugustus force-pushed the go-ify branch from a7175ab to 137045c Compare February 27, 2022 18:50

justaugustus force-pushed the go-ify branch 2 times, most recently from 595b3e6 to af32bc2 Compare February 28, 2022 10:23

justaugustus force-pushed the go-ify branch from 7e5e342 to 38aea8f Compare March 1, 2022 01:05

This was referenced Mar 2, 2022

✨ cmd: Refactor to make importable ossf/scorecard#1696

Merged

✨ cmd: Allow new scorecard to be instantiated with options ossf/scorecard#1703

Merged

justaugustus force-pushed the go-ify branch from 38aea8f to 8bd7f24 Compare March 3, 2022 10:15

justaugustus added this to In progress in Scorecard via automation Mar 3, 2022

justaugustus force-pushed the go-ify branch from 1a57cb7 to 3aa7fa9 Compare March 4, 2022 00:42

naveensrinivasan reviewed Mar 4, 2022

View reviewed changes

azeemshaikh38 reviewed Mar 4, 2022

View reviewed changes

options/options.go Show resolved Hide resolved

github/github.go Show resolved Hide resolved

justaugustus force-pushed the go-ify branch from feae4b9 to 5a92233 Compare March 4, 2022 17:50

justaugustus changed the title ~~[WIP] Refactor entrypoint logic~~ [WIP] Create a Golang-based entrypoint for scorecard-action (1/n) Mar 4, 2022

justaugustus mentioned this pull request Mar 4, 2022

Feature: Create a scorecard API ossf/scorecard#1683

Open

7 tasks

justaugustus force-pushed the go-ify branch 2 times, most recently from e1eaf42 to 467b2e6 Compare March 6, 2022 22:02

justaugustus mentioned this pull request Mar 6, 2022

golangci-lint: Fix GCI warnings #126

Merged

justaugustus force-pushed the go-ify branch from 467b2e6 to 02d84a5 Compare March 6, 2022 23:22

justaugustus added 3 commits March 6, 2022 20:11

Move entrypoint logic to separate package

8058c45

Signed-off-by: Stephen Augustus <foo@auggie.dev>

options: env var-mapped structs via github.com/caarlos0/env/v6

c8e1a44

Signed-off-by: Stephen Augustus <foo@auggie.dev>

options: Start deleting extraneous env var logic

45104fa

Signed-off-by: Stephen Augustus <foo@auggie.dev>

justaugustus added 13 commits March 6, 2022 20:11

Start test cleanups

132dd01

Signed-off-by: Stephen Augustus <foo@auggie.dev>

go.mod: Update scorecard to v4.1.1-0.20220306220811-4b9f0389c6f6

d9cf246

Signed-off-by: Stephen Augustus <foo@auggie.dev>

entrypoint: Wrap scorecard with additional flags and hide unused

85658fb

Signed-off-by: Stephen Augustus <foo@auggie.dev>

entrypoint: Add print-config command

325a936

Signed-off-by: Stephen Augustus <foo@auggie.dev>

options: Process GitHub info together

da582e8

Signed-off-by: Stephen Augustus <foo@auggie.dev>

options: Cleanups and defaulting for action-specific settings

25dd5d4

Signed-off-by: Stephen Augustus <foo@auggie.dev>

Remove/comment out extraneous code/tests

216f6fa

Signed-off-by: Stephen Augustus <foo@auggie.dev>

github: Move GitHub logic to a separate package

c52ccc7

Signed-off-by: Stephen Augustus <foo@auggie.dev>

entrypoint: Support outputting to file

be9f91c

Signed-off-by: Stephen Augustus <foo@auggie.dev>

Remove more unnecessary code and fixup lint warnings

203bcdf

Signed-off-by: Stephen Augustus <foo@auggie.dev>

Rewrite unit tests (1/n)

ca3a9ff

Signed-off-by: Stephen Augustus <foo@auggie.dev>

Rewrite unit tests (2/n)

1f478f4

Signed-off-by: Stephen Augustus <foo@auggie.dev>

Allow options tests to pass in GitHub Actions environments

1c1e257

Signed-off-by: Stephen Augustus <foo@auggie.dev>

justaugustus force-pushed the go-ify branch from 02d84a5 to 1c1e257 Compare March 7, 2022 03:25

Rewrite unit tests (3/n)

29e94f2

Signed-off-by: Stephen Augustus <foo@auggie.dev>

justaugustus force-pushed the go-ify branch from 425a569 to 29e94f2 Compare March 7, 2022 04:52

justaugustus changed the title ~~[WIP] Create a Golang-based entrypoint for scorecard-action (1/n)~~ Create a Golang-based entrypoint for scorecard-action (1/n) Mar 7, 2022

justaugustus requested a review from laurentsimon March 7, 2022 05:37

justaugustus enabled auto-merge (squash) March 7, 2022 05:39

justaugustus requested review from naveensrinivasan and azeemshaikh38 March 7, 2022 05:42

azeemshaikh38 approved these changes Mar 7, 2022

View reviewed changes

Scorecard automation moved this from In progress to Reviewer approved Mar 7, 2022

justaugustus merged commit 874d26c into ossf:main Mar 7, 2022

Scorecard automation moved this from Reviewer approved to Done Mar 7, 2022

jeffmendoza mentioned this pull request Mar 21, 2022

Update Scorecard Interface ossf/allstar#21

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create a Golang-based entrypoint for scorecard-action (1/n) #122

Create a Golang-based entrypoint for scorecard-action (1/n) #122

justaugustus commented Feb 27, 2022

codecov bot commented Feb 27, 2022 •

edited

laurentsimon commented Feb 28, 2022

naveensrinivasan left a comment

azeemshaikh38 left a comment

justaugustus commented Mar 4, 2022

azeemshaikh38 commented Mar 4, 2022

justaugustus commented Mar 4, 2022

azeemshaikh38 commented Mar 4, 2022

justaugustus commented Mar 4, 2022

justaugustus commented Mar 6, 2022

justaugustus commented Mar 7, 2022

azeemshaikh38 left a comment

azeemshaikh38 Mar 7, 2022

Create a Golang-based entrypoint for scorecard-action (1/n) #122

Create a Golang-based entrypoint for scorecard-action (1/n) #122

Conversation

justaugustus commented Feb 27, 2022

codecov bot commented Feb 27, 2022 • edited

Codecov Report

laurentsimon commented Feb 28, 2022

naveensrinivasan left a comment

Choose a reason for hiding this comment

azeemshaikh38 left a comment

Choose a reason for hiding this comment

justaugustus commented Mar 4, 2022

azeemshaikh38 commented Mar 4, 2022

justaugustus commented Mar 4, 2022

azeemshaikh38 commented Mar 4, 2022

justaugustus commented Mar 4, 2022

justaugustus commented Mar 6, 2022

justaugustus commented Mar 7, 2022

azeemshaikh38 left a comment

Choose a reason for hiding this comment

azeemshaikh38 Mar 7, 2022

Choose a reason for hiding this comment

codecov bot commented Feb 27, 2022 •

edited