Make SA implicit in TestPropagatedParams #6185

concaf · 2023-02-17T11:18:07Z

Changes

Make SA implicit in TestPropagatedParams

Currently, `serviceAccountName: default` is added to some PipelineRuns
in the test `TestPropagatedParams` and not the others. This commit
removes it from all TaskRuns and PipelineRuns defined in the test.

While this may seem inconsequential, making the service account
implicit fixes running this test in OpenShift Pipelines where the
default service account is not `default`.

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)
Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
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

concaf · 2023-02-17T11:20:30Z

/kind misc

concaf · 2023-02-17T11:21:12Z

/test check-pr-has-kind-label

tekton-robot · 2023-02-17T11:21:13Z

@concaf: The specified target(s) for /test were not found.
The following commands are available to trigger required jobs:

/test pull-tekton-pipeline-alpha-integration-tests
/test pull-tekton-pipeline-beta-integration-tests
/test pull-tekton-pipeline-build-tests
/test pull-tekton-pipeline-integration-tests
/test tekton-pipeline-unit-tests

The following commands are available to trigger optional jobs:

/test pull-tekton-pipeline-go-coverage

Use /test all to run all jobs.

In response to this:

/test check-pr-has-kind-label

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

lbernick

Instead of adding a serviceAccountName to the test input (for tests that don't actually rely on the service account name at all), where it could be removed without breaking tests, I think it would be better to exclude the serviceaccountname from the want/got comparison for this set of tests.

concaf · 2023-02-20T10:11:50Z

@lbernick thanks for the quick response, it makes sense :) i've updated the PR

vdemeester · 2023-02-20T11:37:01Z

propagated_params_test.go:113: The resolved spec does not match the expected spec. Here is the diff:   &v1beta1.PipelineRun{
          }

That logs is not that usefull 🙃

vdemeester

Because the "defaulting" mechanism will do its job, the expected TaskRun or PipelineRun will have a default serviceAccountName set. We need to make sure we ignore this as well, using the same pattern as ignoreTypeMeta and other cmpopts.IgnoreFields.

test/propagated_params_test.go

lbernick · 2023-02-28T15:10:53Z

test/propagated_params_test.go

@@ -44,7 +44,8 @@ var (
 	ignoreConditions        = cmpopts.IgnoreFields(duckv1.Status{}, "Conditions")
 	ignoreContainerStates   = cmpopts.IgnoreFields(corev1.ContainerState{}, "Terminated")
 	ignoreStepState         = cmpopts.IgnoreFields(v1beta1.StepState{}, "ImageID")
-	ignoreTaskRunSpec       = cmpopts.IgnoreFields(v1beta1.TaskRunSpec{}, "Resources")
+	ignoreTaskRunSpec       = cmpopts.IgnoreFields(v1beta1.TaskRunSpec{}, "Resources", "ServiceAccountName")


Is this variable used?

do you mean ignoreTaskRunSpec? it's used here -

pipeline/test/propagated_params_test.go

Line 126 in f0b8c16

ignoreTaskRunSpec,

lbernick · 2023-02-28T15:11:30Z

test/propagated_params_test.go

@@ -44,7 +44,8 @@ var (
 	ignoreConditions        = cmpopts.IgnoreFields(duckv1.Status{}, "Conditions")
 	ignoreContainerStates   = cmpopts.IgnoreFields(corev1.ContainerState{}, "Terminated")
 	ignoreStepState         = cmpopts.IgnoreFields(v1beta1.StepState{}, "ImageID")
-	ignoreTaskRunSpec       = cmpopts.IgnoreFields(v1beta1.TaskRunSpec{}, "Resources")
+	ignoreTaskRunSpec       = cmpopts.IgnoreFields(v1beta1.TaskRunSpec{}, "Resources", "ServiceAccountName")
+	ignorePipelineRunSpec   = cmpopts.IgnoreFields(v1beta1.PipelineRunSpec{}, "ServiceAccountName")


suggest renaming to "ignoreServiceAccountName" and adding a comment that we're ignoring it because the default can differ between platforms

makes sense, done

Currently, `serviceAccountName: default` is added to some PipelineRuns in the test `TestPropagatedParams` and not the others. This commit removes it from all TaskRuns and PipelineRuns defined in the test. While this may seem inconsequential, making the service account implicit fixes running this test in OpenShift Pipelines where the default service account is not `default`. Further, the field `ServiceAccountName` has been configured to be ignored in both, `TaskRunSpec` and `PipelineRunSpec` as the actual output still contains the Service Account name.

tekton-robot · 2023-03-01T15:15:53Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lbernick

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

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [lbernick]

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

concaf · 2023-03-06T08:52:26Z

thanks @lbernick 😸
cc: @vdemeester good to go?

jerop

/lgtm

tekton-robot added kind/misc Categorizes issue or PR as a miscellaneuous one. release-note-none Denotes a PR that doesnt merit a release note. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 17, 2023

tekton-robot requested review from lbernick and pritidesai February 17, 2023 11:18

lbernick reviewed Feb 17, 2023

View reviewed changes

concaf force-pushed the concaf/fix/tests-serviceAccountName branch from fe775fb to d1447f7 Compare February 20, 2023 10:10

concaf changed the title ~~Add SA to PipelineRuns in TestPropagatedParams~~ Make SA implicit in TestPropagatedParams Feb 20, 2023

vdemeester reviewed Feb 20, 2023

View reviewed changes

test/propagated_params_test.go Show resolved Hide resolved

concaf force-pushed the concaf/fix/tests-serviceAccountName branch from d1447f7 to 5eafe20 Compare February 28, 2023 13:55

tekton-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 28, 2023

lbernick reviewed Feb 28, 2023

View reviewed changes

concaf force-pushed the concaf/fix/tests-serviceAccountName branch from 5eafe20 to cf9b51e Compare March 1, 2023 09:10

lbernick approved these changes Mar 1, 2023

View reviewed changes

tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 1, 2023

jerop reviewed Mar 6, 2023

View reviewed changes

tekton-robot assigned jerop Mar 6, 2023

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

tekton-robot merged commit 160b7ce into tektoncd:main Mar 6, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make SA implicit in TestPropagatedParams #6185

Make SA implicit in TestPropagatedParams #6185

concaf commented Feb 17, 2023 •

edited

concaf commented Feb 17, 2023

concaf commented Feb 17, 2023

tekton-robot commented Feb 17, 2023

lbernick left a comment

concaf commented Feb 20, 2023 •

edited

vdemeester commented Feb 20, 2023

vdemeester left a comment

lbernick Feb 28, 2023

concaf Mar 1, 2023

lbernick Feb 28, 2023

concaf Mar 1, 2023

tekton-robot commented Mar 1, 2023

concaf commented Mar 6, 2023

jerop left a comment

Make SA implicit in TestPropagatedParams #6185

Make SA implicit in TestPropagatedParams #6185

Conversation

concaf commented Feb 17, 2023 • edited

Changes

Submitter Checklist

Release Notes

concaf commented Feb 17, 2023

concaf commented Feb 17, 2023

tekton-robot commented Feb 17, 2023

lbernick left a comment

Choose a reason for hiding this comment

concaf commented Feb 20, 2023 • edited

vdemeester commented Feb 20, 2023

vdemeester left a comment

Choose a reason for hiding this comment

lbernick Feb 28, 2023

Choose a reason for hiding this comment

concaf Mar 1, 2023

Choose a reason for hiding this comment

lbernick Feb 28, 2023

Choose a reason for hiding this comment

concaf Mar 1, 2023

Choose a reason for hiding this comment

tekton-robot commented Mar 1, 2023

concaf commented Mar 6, 2023

jerop left a comment

Choose a reason for hiding this comment

concaf commented Feb 17, 2023 •

edited

concaf commented Feb 20, 2023 •

edited