Do not initialize Rekor client if transparency is not enabled. Issue #520 by EmmaMunley · Pull Request #693 · tektoncd/chains

EmmaMunley · 2023-01-27T16:34:25Z

Changes

Issue #520
Moved the initalization of rekorClient to be gated inside the shouldUploadTlog function to ensure transparency is enabled

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

Has Docs included if any changes are user facing
Has Tests included if any functionality added or changed
Follows the commit message standard
Meets the Tekton contributor standards (including
functionality, content, code)
Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

tekton-robot · 2023-01-27T16:38:51Z

The following is the coverage report on the affected files.
Say /test pull-tekton-chains-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/chains/rekor.go	29.6%	44.8%	15.2

lcarva · 2023-01-27T16:41:01Z


-// for testing
-var getRekor = func(url string, l *zap.SugaredLogger) (rekorClient, error) {
+var getRekor = func(is_enabled bool, url string, l *zap.SugaredLogger) (rekorClient, error) {


Would it be more straight forward to only call getRekor if it is enabled since the caller already has that information?

Cool! I updated the PR and moved the client initialization to be gated inside the shouldUploadTlog function. Let me know if this looks good to you. Thanks!

tekton-robot · 2023-01-27T18:55:15Z

The following is the coverage report on the affected files.
Say /test pull-tekton-chains-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/chains/signing.go	73.3%	73.6%	0.3

tekton-robot · 2023-01-27T19:02:03Z

The following is the coverage report on the affected files.
Say /test pull-tekton-chains-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/chains/signing.go	73.3%	73.6%	0.3

tekton-robot · 2023-01-27T21:31:55Z

The following is the coverage report on the affected files.
Say /test pull-tekton-chains-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/chains/signing.go	73.3%	73.6%	0.3

lcarva

Just a small nit.

lcarva · 2023-01-30T13:24:35Z

-	if err != nil {
-		return err
-	}
+	var rekorClient rekorClient


Is there a benefit to declaring this variable this far from when it's actually used?

It could be useful to only have to call getRekor once during this method, but that doesn't seem to be the case here.

lcarva

/lgtm

jagathprakash · 2023-01-30T17:15:45Z

/retest

Moved the initalization of rekorClient to be gated inside the shouldUploadTlog function to ensure transparency is enabled

EmmaMunley · 2023-01-31T18:17:40Z

FYI @lcarva: It looks like one the E2E tests is flaky and the only way to trigger retesting was to submit a new PR so I just fixed a typo in the readme and the tests are now passing.

lcarva

/lgtm

tekton-robot · 2023-01-31T18:20:17Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lcarva

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [lcarva]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

lcarva · 2023-01-31T18:20:50Z

FYI @lcarva: It looks like one the E2E tests is flaky and the only way to trigger retesting was to submit a new PR so I just fixed a type in the readme and the tests are now passing.

Bummer... If you managed to save some details about the failure, could you file an issue here? 🙏

EmmaMunley · 2023-02-02T19:22:49Z

FYI @lcarva: It looks like one the E2E tests is flaky and the only way to trigger retesting was to submit a new PR so I just fixed a type in the readme and the tests are now passing.

Bummer... If you managed to save some details about the failure, could you file an issue here? 🙏

Sure, I opened an issue for this here

tekton-robot requested review from lcarva and wlynch January 27, 2023 16:34

tekton-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jan 27, 2023

EmmaMunley changed the title ~~Do not initialize Rekor client if transparency is not enabled. #520~~ Do not initialize Rekor client if transparency is not enabled. Issue #520 Jan 27, 2023

lcarva reviewed Jan 27, 2023

View reviewed changes

tekton-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jan 27, 2023

EmmaMunley force-pushed the transparency-enabled branch from 6be786b to 1b1466e Compare January 27, 2023 18:56

EmmaMunley force-pushed the transparency-enabled branch from 1b1466e to 41e093f Compare January 27, 2023 19:16

tekton-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Jan 27, 2023

EmmaMunley force-pushed the transparency-enabled branch 2 times, most recently from 8d977e4 to 4de42ff Compare January 27, 2023 21:27

EmmaMunley requested review from lcarva and removed request for wlynch January 27, 2023 21:31

lcarva reviewed Jan 30, 2023

View reviewed changes

EmmaMunley force-pushed the transparency-enabled branch from 9fc5da7 to 9020a8d Compare January 30, 2023 14:47

lcarva approved these changes Jan 30, 2023

View reviewed changes

tekton-robot assigned lcarva Jan 30, 2023

tekton-robot added lgtm Indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Jan 30, 2023

Do not initialize Rekor client if transparency is not enabled

55975ce

Moved the initalization of rekorClient to be gated inside the shouldUploadTlog function to ensure transparency is enabled

EmmaMunley force-pushed the transparency-enabled branch from 9020a8d to 55975ce Compare January 30, 2023 22:11

tekton-robot removed the lgtm Indicates that a PR is ready to be merged. label Jan 30, 2023

EmmaMunley requested a review from lcarva January 31, 2023 18:16

lcarva approved these changes Jan 31, 2023

View reviewed changes

tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jan 31, 2023

tekton-robot merged commit 3d0e739 into tektoncd:main Jan 31, 2023

EmmaMunley mentioned this pull request Feb 2, 2023

Flaky E2E Tests v1.23.x #697

Closed

EmmaMunley deleted the transparency-enabled branch February 2, 2023 19:22

Uh oh!

Conversation

EmmaMunley commented Jan 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Submitter Checklist

Release Notes

Uh oh!

tekton-robot commented Jan 27, 2023

Uh oh!

lcarva Jan 27, 2023

Choose a reason for hiding this comment

Uh oh!

EmmaMunley Jan 27, 2023

Choose a reason for hiding this comment

Uh oh!

tekton-robot commented Jan 27, 2023

Uh oh!

tekton-robot commented Jan 27, 2023

Uh oh!

tekton-robot commented Jan 27, 2023

Uh oh!

lcarva left a comment

Choose a reason for hiding this comment

Uh oh!

lcarva Jan 30, 2023

Choose a reason for hiding this comment

Uh oh!

lcarva left a comment

Choose a reason for hiding this comment

Uh oh!

jagathprakash commented Jan 30, 2023

Uh oh!

EmmaMunley commented Jan 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lcarva left a comment

Choose a reason for hiding this comment

Uh oh!

tekton-robot commented Jan 31, 2023

Uh oh!

lcarva commented Jan 31, 2023

Uh oh!

EmmaMunley commented Feb 2, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

EmmaMunley commented Jan 27, 2023 •

edited

Loading

EmmaMunley commented Jan 31, 2023 •

edited

Loading