Add debug with breakpoint onFailure to TaskRun Spec #3857

waveywaves · 2021-03-25T21:24:33Z

Changes

Add debug with breakpoint onFailure to TaskRun Spec

Add -breakpoint_on_failure to entrypointer which disables exit of container upon failure
If debug is enabled (as shown below) mount /tekton/debug/scripts and /tekton/debug/info/<step-no> to TaskRun Pod.

spec:
  debug:
    breakpoint: ["onFailure"]

Add debug helper scripts to /tekton/debug/scripts
Add /tekton/debug/info/ mount which is used by helper scripts to understand which step they are running in where denotes the step number. First step = 0, Second step = 1 and so on.

In addition, categorize the changes you're making using the "/kind" Prow command, example:

/kind feature

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

Includes tests (if functionality changed/added)
Includes docs (if user facing)
Commit messages follow commit message best practices
Release notes block has been filled in or deleted (only if no user facing changes)

See the contribution guide for more details.

Double check this list of stuff that's easy to miss:

If you are adding a new binary/image to the cmd dir, please update
the release Task to build and release this image.

Reviewer Notes

If API changes are included, additive changes must be approved by at least two OWNERS and backwards incompatible changes must be approved by more than 50% of the OWNERS, and they must first be added in a backwards compatible way.

Release Notes

Add -breakpoint_on_failure to entrypointer which disables exit of container upon failure
Add debug helper scripts to /tekton/debug/scripts
Add /tekton/debug/info/ mount which is used by helper scripts to understand which step they are running in where denotes the step number. First step = 0, Second step = 1 and so on.

tekton-robot · 2021-03-25T21:26:16Z

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
pkg/entrypoint/entrypointer.go	64.0%	64.2%	0.2

tekton-robot · 2021-03-25T21:40:55Z

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
pkg/entrypoint/entrypointer.go	64.0%	64.2%	0.2
pkg/pod/entrypoint.go	84.8%	80.3%	-4.6
pkg/pod/pod.go	87.4%	86.7%	-0.7
pkg/pod/script.go	100.0%	60.7%	-39.3

waveywaves · 2021-03-25T21:41:02Z

/kind feature

tekton-robot · 2021-03-25T21:54:22Z

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
pkg/entrypoint/entrypointer.go	64.0%	64.2%	0.2

tekton-robot · 2021-03-25T22:01:16Z

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
pkg/entrypoint/entrypointer.go	64.0%	64.2%	0.2
pkg/pod/entrypoint.go	84.8%	80.3%	-4.6
pkg/pod/pod.go	87.4%	86.7%	-0.7
pkg/pod/script.go	100.0%	61.4%	-38.6

tekton-robot · 2021-03-25T22:06:17Z

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
pkg/entrypoint/entrypointer.go	64.0%	64.2%	0.2
pkg/pod/entrypoint.go	84.8%	80.3%	-4.6
pkg/pod/pod.go	87.4%	86.7%	-0.7
pkg/pod/script.go	100.0%	61.0%	-39.0

imjasonh · 2021-03-25T22:12:27Z

/assign

tekton-robot · 2021-03-25T22:14:53Z

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
pkg/entrypoint/entrypointer.go	64.0%	64.2%	0.2
pkg/pod/entrypoint.go	84.8%	80.3%	-4.6
pkg/pod/pod.go	87.4%	86.7%	-0.7
pkg/pod/script.go	100.0%	59.3%	-40.7

tekton-robot · 2021-03-25T22:18:17Z

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
pkg/entrypoint/entrypointer.go	64.0%	64.2%	0.2
pkg/pod/entrypoint.go	84.8%	80.3%	-4.6
pkg/pod/pod.go	87.4%	86.7%	-0.7
pkg/pod/script.go	100.0%	59.3%	-40.7

tekton-robot · 2021-03-25T22:20:40Z

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
pkg/entrypoint/entrypointer.go	64.0%	64.2%	0.2
pkg/pod/entrypoint.go	84.8%	80.3%	-4.6
pkg/pod/pod.go	87.4%	86.7%	-0.7
pkg/pod/script.go	100.0%	59.3%	-40.7

tekton-robot · 2021-03-25T22:49:00Z

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
pkg/entrypoint/entrypointer.go	64.0%	64.2%	0.2
pkg/pod/entrypoint.go	84.8%	80.3%	-4.6
pkg/pod/pod.go	87.4%	86.7%	-0.7
pkg/pod/script.go	100.0%	59.3%	-40.7

tekton-robot · 2021-06-28T16:18:27Z

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/entrypoint/waiter.go	69.2%	80.0%	10.8
pkg/entrypoint/entrypointer.go	64.0%	66.1%	2.1
pkg/pod/entrypoint.go	84.8%	85.9%	1.1
pkg/pod/pod.go	87.2%	87.6%	0.4

tekton-robot · 2021-06-30T10:37:22Z

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/entrypoint/waiter.go	69.2%	80.0%	10.8
pkg/entrypoint/entrypointer.go	64.0%	66.1%	2.1
pkg/pod/entrypoint.go	84.8%	85.9%	1.1
pkg/pod/pod.go	87.2%	87.6%	0.4

waveywaves · 2021-06-30T10:40:55Z

/test tekton-pipeline-unit-tests

tekton-robot · 2021-06-30T11:28:53Z

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/entrypoint/waiter.go	69.2%	80.0%	10.8
pkg/entrypoint/entrypointer.go	64.0%	66.1%	2.1
pkg/pod/entrypoint.go	84.8%	85.9%	1.1
pkg/pod/pod.go	87.2%	87.6%	0.4

waveywaves · 2021-06-30T11:32:05Z

/test tekton-pipeline-unit-tests

waveywaves · 2021-06-30T11:34:07Z

/test pull-tekton-pipeline-alpha-integration-tests

waveywaves · 2021-07-01T01:17:50Z

/test pull-tekton-pipeline-build-tests

waveywaves · 2021-07-01T08:00:39Z

/test pull-tekton-pipeline-integration-tests

waveywaves · 2021-07-01T08:26:16Z

/test pull-tekton-pipeline-alpha-integration-tests

waveywaves · 2021-07-01T09:01:31Z

/test pull-tekton-pipeline-alpha-integration-tests

docs/taskruns.md

cmd/entrypoint/main.go

pkg/entrypoint/entrypointer.go

pkg/pod/script.go

Based on TEP-0042, this commit adds the ability for the user to debug TaskRuns with the spec.debug delaration where the user can provide breakpoints in spec.debug.breakpoint. With this commit the only breakpoint supported right now is the "onFailure" breakpoint which pauses the TaskRun during a step failure so the user can get shell access to the failed step container and debug. The following additions have been done. - Add -breakpoint_on_failure to entrypointer which disables exit of container upon failure - Add debug helper scripts to /tekton/debug/scripts which contains continuing the TaskRun and marking the step as a success or a failure by writing <n>.breakpointexit file to /tekton/tools - Add /tekton/debug/info/<n> mount which is used by helper scripts to understand which step they are running in where <n> denotes the step number eg: First step = 0, Second step = 1 and so on. - Exit code is propogated from .breakpointexit to end of TaskRun - Disable step skipError if breakpoint enabled - Add webhook validation for debug - Add Debug as a alpha feature Signed-off-by: Vincent Demeester <vdemeest@redhat.com> Signed-off-by: Vibhav Bobade <vibhav.bobde@gmail.com>

tekton-robot · 2021-07-05T09:08:56Z

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/entrypoint/waiter.go	69.2%	80.0%	10.8
pkg/entrypoint/entrypointer.go	64.0%	66.1%	2.1
pkg/pod/entrypoint.go	84.8%	85.9%	1.1
pkg/pod/pod.go	87.2%	87.6%	0.4

waveywaves · 2021-07-06T11:01:00Z

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

waveywaves · 2021-07-06T11:52:38Z

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

pritidesai · 2021-07-06T18:21:59Z

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

tekton-robot · 2021-07-09T14:23:37Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vdemeester

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~~ [vdemeester]

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

ghost · 2021-07-09T16:02:53Z

docs/debug.md

+  - [Debug Scripts](#debug-scripts)
+
+
+## Overview


Not a blocker but it might be worth mentioning here that debug is behind a feature flag.

ghost · 2021-07-09T16:04:30Z

docs/debug.md

+
+## Debugging TaskRuns
+
+The following provides explanation on how Debugging TaskRuns is possible through Tekton. To understand how to use 


This seems like it's developer-focused to me. Wonder if it should live under docs/developers/debug.md?

ghost · 2021-07-09T16:04:56Z

docs/taskruns.md

@@ -447,6 +449,43 @@ spec:
  status: "TaskRunCancelled"
 ```

+
+### Debugging a `TaskRun`


Again probably worth mentioning that this is an alpha feature, with a link to the "Alpha Features" section of docs/install.md.

ghost · 2021-07-09T16:07:40Z

Adding lgtm since the remaining changes I've suggested are small doc fixes.

Suggest also adding an entry about debug to the "Alpha Features" section of install.md..

/lgtm

waveywaves · 2021-07-10T06:00:46Z

@sbwsg I will create a separate PR for the doc changes. Thank you for taking time to review this.

tekton-robot added the release-note Denotes a PR that will be considered when it comes time to generate release notes. label Mar 25, 2021

tekton-robot requested review from bobcatfish and jerop March 25, 2021 21:24

tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Mar 25, 2021

waveywaves changed the title ~~Add breakpoint to TaskRun Spec~~ Add debug with breakpoint onFailure to TaskRun Spec Mar 25, 2021

waveywaves changed the title ~~Add debug with breakpoint onFailure to TaskRun Spec~~ WIP: Add debug with breakpoint onFailure to TaskRun Spec Mar 25, 2021

tekton-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 25, 2021

waveywaves marked this pull request as draft March 25, 2021 21:31

waveywaves force-pushed the api/debug branch from 656502e to 1eca59f Compare March 25, 2021 21:38

tekton-robot added the kind/feature Categorizes issue or PR as related to a new feature. label Mar 25, 2021

waveywaves force-pushed the api/debug branch from 1eca59f to c42df10 Compare March 25, 2021 21:52

waveywaves force-pushed the api/debug branch from c42df10 to 5636cf3 Compare March 25, 2021 21:59

waveywaves force-pushed the api/debug branch from 5636cf3 to af29cd7 Compare March 25, 2021 22:04

tekton-robot assigned imjasonh Mar 25, 2021

waveywaves force-pushed the api/debug branch from af29cd7 to 0aa2fdc Compare March 25, 2021 22:12

waveywaves force-pushed the api/debug branch 2 times, most recently from 143690e to 0390f18 Compare March 25, 2021 22:17

waveywaves force-pushed the api/debug branch from 0390f18 to 9d5a003 Compare March 25, 2021 22:47

waveywaves force-pushed the api/debug branch from 9d5a003 to dfdf894 Compare March 25, 2021 23:04

waveywaves force-pushed the api/debug branch from cc382fc to 067aed7 Compare June 28, 2021 16:16

vdemeester mentioned this pull request Jun 29, 2021

proposal for TEP 0040 - ignore step error with a new section exit tektoncd/community#463

Merged

waveywaves force-pushed the api/debug branch from 067aed7 to 297b7e1 Compare June 30, 2021 10:35

waveywaves force-pushed the api/debug branch from 297b7e1 to d00e45b Compare June 30, 2021 11:26

ghost reviewed Jul 1, 2021

View reviewed changes

docs/taskruns.md Outdated Show resolved Hide resolved

cmd/entrypoint/main.go Outdated Show resolved Hide resolved

pkg/entrypoint/entrypointer.go Outdated Show resolved Hide resolved

pkg/pod/script.go Outdated Show resolved Hide resolved

pkg/pod/script.go Outdated Show resolved Hide resolved

waveywaves force-pushed the api/debug branch from d00e45b to 0e7fce2 Compare July 5, 2021 09:06

vdemeester approved these changes Jul 9, 2021

View reviewed changes

tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 9, 2021

ghost reviewed Jul 9, 2021

View reviewed changes

tekton-robot assigned ghost Jul 9, 2021

tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 9, 2021

tekton-robot merged commit 5a4d1f9 into tektoncd:main Jul 9, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add debug with breakpoint onFailure to TaskRun Spec #3857

Add debug with breakpoint onFailure to TaskRun Spec #3857

waveywaves commented Mar 25, 2021 •

edited

tekton-robot commented Mar 25, 2021

tekton-robot commented Mar 25, 2021

waveywaves commented Mar 25, 2021

tekton-robot commented Mar 25, 2021

tekton-robot commented Mar 25, 2021

tekton-robot commented Mar 25, 2021

imjasonh commented Mar 25, 2021

tekton-robot commented Mar 25, 2021

tekton-robot commented Mar 25, 2021

tekton-robot commented Mar 25, 2021

tekton-robot commented Mar 25, 2021

tekton-robot commented Jun 28, 2021

tekton-robot commented Jun 30, 2021

waveywaves commented Jun 30, 2021

tekton-robot commented Jun 30, 2021

waveywaves commented Jun 30, 2021

waveywaves commented Jun 30, 2021

waveywaves commented Jul 1, 2021

waveywaves commented Jul 1, 2021

waveywaves commented Jul 1, 2021

waveywaves commented Jul 1, 2021

tekton-robot commented Jul 5, 2021

waveywaves commented Jul 6, 2021

waveywaves commented Jul 6, 2021

pritidesai commented Jul 6, 2021

tekton-robot commented Jul 9, 2021

ghost Jul 9, 2021

ghost Jul 9, 2021

ghost Jul 9, 2021

ghost commented Jul 9, 2021

waveywaves commented Jul 10, 2021


		## Debugging TaskRuns

		The following provides explanation on how Debugging TaskRuns is possible through Tekton. To understand how to use

Add debug with breakpoint onFailure to TaskRun Spec #3857

Add debug with breakpoint onFailure to TaskRun Spec #3857

Conversation

waveywaves commented Mar 25, 2021 • edited

Changes

Submitter Checklist

Reviewer Notes

Release Notes

tekton-robot commented Mar 25, 2021

tekton-robot commented Mar 25, 2021

waveywaves commented Mar 25, 2021

tekton-robot commented Mar 25, 2021

tekton-robot commented Mar 25, 2021

tekton-robot commented Mar 25, 2021

imjasonh commented Mar 25, 2021

tekton-robot commented Mar 25, 2021

tekton-robot commented Mar 25, 2021

tekton-robot commented Mar 25, 2021

tekton-robot commented Mar 25, 2021

tekton-robot commented Jun 28, 2021

tekton-robot commented Jun 30, 2021

waveywaves commented Jun 30, 2021

tekton-robot commented Jun 30, 2021

waveywaves commented Jun 30, 2021

waveywaves commented Jun 30, 2021

waveywaves commented Jul 1, 2021

waveywaves commented Jul 1, 2021

waveywaves commented Jul 1, 2021

waveywaves commented Jul 1, 2021

tekton-robot commented Jul 5, 2021

waveywaves commented Jul 6, 2021

waveywaves commented Jul 6, 2021

pritidesai commented Jul 6, 2021

tekton-robot commented Jul 9, 2021

ghost Jul 9, 2021

Choose a reason for hiding this comment

ghost Jul 9, 2021

Choose a reason for hiding this comment

ghost Jul 9, 2021

Choose a reason for hiding this comment

ghost commented Jul 9, 2021

waveywaves commented Jul 10, 2021

waveywaves commented Mar 25, 2021 •

edited