feat: Surface artifacts through sidecar container logs.

[ericzzzzzzz]

Changes

• This Pr uses the similar approach as TEP-0142: Surface step results via sidecar logs #7414 to surface large artifacts to TaskRun.status.steps.
• The flag result-from:sidecar-logs is used to guard this feature, it is also the same as surfacing step results through sidecar logs.
• As we don't have a API to allow users to declare if a step is going to produce artifacts, we check if a step env, command, args, script contains artifacts path to determine if we should create an artifact sidecar container should be created for a task.

Fixes: #7869

Submitter Checklist

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

• Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps
• Has Tests included if any functionality added or changed
• pre-commit Passed
• 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). See some examples of good release notes.
• Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

Surface artifacts through sidecar container logs.

[tekton-robot]

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

[tekton-robot]

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

File	Old Coverage	New Coverage	Delta
cmd/sidecarlogartifacts/main.go	Do not exist	0.0%
pkg/apis/pipeline/images.go	100.0%	87.5%	-12.5
pkg/apis/pipeline/v1/task_validation.go	98.6%	98.3%	-0.3
pkg/entrypoint/entrypointer.go	86.8%	86.9%	0.0
pkg/pod/entrypoint.go	94.1%	93.2%	-0.9
pkg/pod/pod.go	93.6%	92.6%	-1.0
pkg/pod/status.go	94.7%	94.2%	-0.5

[ericzzzzzzz]

/kind feat

[tekton-robot]

@ericzzzzzzz: The label(s) kind/feat cannot be applied, because the repository doesn't have them.

In response to this:

/kind feat

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.

[ericzzzzzzz]

/kind feature

[tekton-robot]

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

File	Old Coverage	New Coverage	Delta
cmd/sidecarlogartifacts/main.go	Do not exist	0.0%
pkg/apis/pipeline/images.go	100.0%	87.5%	-12.5
pkg/apis/pipeline/v1/task_validation.go	98.6%	98.3%	-0.3
pkg/entrypoint/entrypointer.go	86.8%	86.9%	0.0
pkg/pod/entrypoint.go	94.1%	93.2%	-0.9
pkg/pod/pod.go	93.6%	92.6%	-1.0
pkg/pod/status.go	94.7%	94.2%	-0.5

[tekton-robot]

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

File	Old Coverage	New Coverage	Delta
cmd/sidecarlogartifacts/main.go	Do not exist	0.0%
internal/sidecarlogartifacts/sidecarlogartifacts.go	Do not exist	65.1%
pkg/apis/pipeline/images.go	100.0%	87.5%	-12.5
pkg/apis/pipeline/v1/task_validation.go	98.6%	98.3%	-0.3
pkg/entrypoint/entrypointer.go	86.8%	86.9%	0.0
pkg/pod/entrypoint.go	94.1%	93.2%	-0.9
pkg/pod/pod.go	93.6%	92.6%	-1.0
pkg/pod/status.go	94.7%	94.2%	-0.5

[tekton-robot]

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

File	Old Coverage	New Coverage	Delta
cmd/sidecarlogartifacts/main.go	Do not exist	0.0%
internal/sidecarlogartifacts/sidecarlogartifacts.go	Do not exist	65.1%
pkg/apis/pipeline/images.go	100.0%	87.5%	-12.5
pkg/apis/pipeline/v1/task_validation.go	98.6%	98.3%	-0.3
pkg/entrypoint/entrypointer.go	86.8%	86.9%	0.0
pkg/pod/entrypoint.go	94.1%	93.2%	-0.9
pkg/pod/pod.go	93.6%	92.6%	-1.0
pkg/pod/status.go	94.7%	94.2%	-0.5

[tekton-robot]

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

File	Old Coverage	New Coverage	Delta
cmd/sidecarlogartifacts/main.go	Do not exist	0.0%
internal/sidecarlogartifacts/sidecarlogartifacts.go	Do not exist	65.1%
pkg/apis/pipeline/images.go	100.0%	87.5%	-12.5
pkg/apis/pipeline/v1/task_validation.go	98.6%	98.3%	-0.3
pkg/entrypoint/entrypointer.go	86.8%	86.9%	0.0
pkg/pod/entrypoint.go	94.1%	93.2%	-0.9
pkg/pod/pod.go	93.6%	92.6%	-1.0
pkg/pod/status.go	94.7%	94.2%	-0.5

[tekton-robot]

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

File	Old Coverage	New Coverage	Delta
cmd/sidecarlogartifacts/main.go	Do not exist	0.0%
internal/sidecarlogartifacts/sidecarlogartifacts.go	Do not exist	65.1%
pkg/apis/pipeline/images.go	100.0%	87.5%	-12.5
pkg/apis/pipeline/v1/task_validation.go	98.6%	98.3%	-0.3
pkg/entrypoint/entrypointer.go	86.8%	86.9%	0.0
pkg/pod/entrypoint.go	94.1%	93.2%	-0.9
pkg/pod/pod.go	93.6%	92.6%	-1.0
pkg/pod/status.go	94.7%	94.2%	-0.5

[tekton-robot]

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

File	Old Coverage	New Coverage	Delta
cmd/sidecarlogartifacts/main.go	Do not exist	0.0%
internal/sidecarlogartifacts/sidecarlogartifacts.go	Do not exist	65.1%
pkg/apis/pipeline/v1/task_validation.go	98.6%	98.3%	-0.3
pkg/entrypoint/entrypointer.go	86.8%	86.9%	0.0
pkg/pod/entrypoint.go	94.1%	93.2%	-0.9
pkg/pod/pod.go	93.6%	93.7%	0.1
pkg/pod/status.go	94.7%	94.2%	-0.5

[tekton-robot]

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

File	Old Coverage	New Coverage	Delta
cmd/sidecarlogartifacts/main.go	Do not exist	0.0%
internal/sidecarlogartifacts/sidecarlogartifacts.go	Do not exist	65.1%
pkg/apis/pipeline/v1/task_validation.go	98.6%	98.3%	-0.3
pkg/entrypoint/entrypointer.go	86.8%	86.9%	0.0
pkg/pod/entrypoint.go	94.1%	93.2%	-0.9
pkg/pod/pod.go	93.6%	93.7%	0.1
pkg/pod/status.go	94.7%	94.2%	-0.5

[tekton-robot]

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

File	Old Coverage	New Coverage	Delta
cmd/sidecarlogartifacts/main.go	Do not exist	0.0%
internal/sidecarlogartifacts/sidecarlogartifacts.go	Do not exist	67.2%
pkg/entrypoint/entrypointer.go	86.8%	86.9%	0.0
pkg/pod/entrypoint.go	94.1%	94.2%	0.1
pkg/pod/pod.go	93.6%	93.7%	0.1
pkg/pod/status.go	94.7%	94.0%	-0.7

[tekton-robot]

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

File	Old Coverage	New Coverage	Delta
cmd/sidecarlogartifacts/main.go	Do not exist	0.0%
internal/sidecarlogartifacts/sidecarlogartifacts.go	Do not exist	67.2%
pkg/entrypoint/entrypointer.go	86.8%	86.9%	0.0
pkg/pod/entrypoint.go	94.1%	94.2%	0.1
pkg/pod/pod.go	93.6%	93.7%	0.1
pkg/pod/status.go	94.7%	94.0%	-0.7

[tekton-robot]

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

File	Old Coverage	New Coverage	Delta
cmd/sidecarlogartifacts/main.go	Do not exist	0.0%
internal/sidecarlogartifacts/sidecarlogartifacts.go	Do not exist	86.4%
pkg/pod/entrypoint.go	94.1%	94.2%	0.1
pkg/pod/pod.go	93.6%	93.7%	0.1
pkg/pod/status.go	94.7%	94.0%	-0.7

[tekton-robot]

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

File	Old Coverage	New Coverage	Delta
cmd/sidecarlogartifacts/main.go	Do not exist	0.0%
internal/sidecarlogartifacts/sidecarlogartifacts.go	Do not exist	86.4%
pkg/pod/entrypoint.go	94.1%	94.2%	0.1
pkg/pod/pod.go	93.6%	93.7%	0.1
pkg/pod/status.go	94.7%	94.0%	-0.7

[tekton-robot]

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

File	Old Coverage	New Coverage	Delta
cmd/sidecarlogartifacts/main.go	Do not exist	0.0%
internal/sidecarlogartifacts/sidecarlogartifacts.go	Do not exist	86.4%
pkg/pod/entrypoint.go	94.1%	94.2%	0.1
pkg/pod/pod.go	93.6%	93.7%	0.1
pkg/pod/status.go	94.7%	94.0%	-0.7

[tekton-robot]

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

File	Old Coverage	New Coverage	Delta
cmd/sidecarlogartifacts/main.go	Do not exist	0.0%
internal/sidecarlogartifacts/sidecarlogartifacts.go	Do not exist	86.4%
pkg/pod/entrypoint.go	94.1%	94.2%	0.1
pkg/pod/pod.go	93.6%	93.7%	0.1
pkg/pod/status.go	94.7%	94.0%	-0.7

[chitrangpatel]

Thanks for the changes. I would love to see a test where we extract both results and artifacts from sidecar logs so that we can validate that they both work at the same time.

[chitrangpatel]

Otherwise lgtm

[tekton-robot]

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

File	Old Coverage	New Coverage	Delta
internal/sidecarlogresults/sidecarlogresults.go	89.6%	87.2%	-2.3
pkg/pod/pod.go	93.6%	93.8%	0.2
pkg/pod/status.go	94.7%	92.9%	-1.8

[tekton-robot]

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

File	Old Coverage	New Coverage	Delta
internal/sidecarlogresults/sidecarlogresults.go	89.6%	87.2%	-2.3
pkg/pod/pod.go	93.6%	93.8%	0.2
pkg/pod/status.go	94.7%	92.9%	-1.8

[tekton-robot]

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

File	Old Coverage	New Coverage	Delta
internal/sidecarlogresults/sidecarlogresults.go	89.6%	87.2%	-2.3
pkg/pod/pod.go	93.6%	93.8%	0.2
pkg/pod/status.go	94.7%	93.4%	-1.3

[tekton-robot]

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

File	Old Coverage	New Coverage	Delta
internal/sidecarlogresults/sidecarlogresults.go	89.6%	87.2%	-2.3
pkg/pod/pod.go	93.6%	93.8%	0.2
pkg/pod/status.go	94.7%	93.4%	-1.3

[JeromeJu]

Thanks @ericzzzzzzz ! This generally looks good. Just some nit picking and do we have any failure test cases for the coverage?

[tekton-robot]

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

File	Old Coverage	New Coverage	Delta
internal/sidecarlogresults/sidecarlogresults.go	89.6%	87.2%	-2.3
pkg/pod/pod.go	93.6%	93.9%	0.3
pkg/pod/status.go	94.7%	93.4%	-1.3

[tekton-robot]

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

File	Old Coverage	New Coverage	Delta
internal/sidecarlogresults/sidecarlogresults.go	89.6%	87.2%	-2.3
pkg/pod/pod.go	93.6%	93.9%	0.3
pkg/pod/status.go	94.7%	93.4%	-1.3

[tekton-robot]

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

File	Old Coverage	New Coverage	Delta
internal/sidecarlogresults/sidecarlogresults.go	89.6%	87.9%	-1.6
pkg/pod/pod.go	93.6%	93.9%	0.3
pkg/pod/status.go	94.7%	93.4%	-1.3

[tekton-robot]

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

File	Old Coverage	New Coverage	Delta
internal/sidecarlogresults/sidecarlogresults.go	89.6%	87.9%	-1.6
pkg/pod/pod.go	93.6%	93.9%	0.3
pkg/pod/status.go	94.7%	93.4%	-1.3

[tekton-robot]

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

File	Old Coverage	New Coverage	Delta
internal/sidecarlogresults/sidecarlogresults.go	89.6%	87.9%	-1.6
pkg/pod/pod.go	93.6%	93.9%	0.3
pkg/pod/status.go	94.7%	93.6%	-1.1

[tekton-robot]

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

File	Old Coverage	New Coverage	Delta
internal/sidecarlogresults/sidecarlogresults.go	89.6%	87.9%	-1.6
pkg/pod/pod.go	93.6%	93.9%	0.3
pkg/pod/status.go	94.7%	93.6%	-1.1

[ericzzzzzzz]

Thanks @ericzzzzzzz ! This generally looks good. Just some nit picking and do we have any failure test cases for the coverage?

Thanks for the review! I added some tests, the some failure cases are related to file operations and we don't have established pattern to mock those, others are related to json marshal operation, it shouldn't happen as we are passing a struct with all tagged public fields

[tekton-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: chitrangpatel, JeromeJu

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 [JeromeJu,chitrangpatel]

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

[JeromeJu]

Thanks @ericzzzzzzz ! This generally looks good. Just some nit picking and do we have any failure test cases for the coverage?

Thanks for the review! I added some tests, the some failure cases are related to file operations and we don't have established pattern to mock those, others are related to json marshal operation, it shouldn't happen as we are passing a struct with all tagged public fields

Understood - then maybe wrapping the errors with the appropriate context might be the way to go.

[chitrangpatel]

I'm merging this PR since it is basically taking the exact same approach as for larger results to extract artifacts. This has been open for a while and blocking other work. The same functionality has already been implemented for surfacing the information via TerminationMessages. There is nothing novel here.

/lgtm