Skip to content

Commit

Permalink
show cancelled instead of failed for pr and tr desc
Browse files Browse the repository at this point in the history
  • Loading branch information
danielhelfand authored and tekton-robot committed Dec 19, 2019
1 parent b44bd46 commit b04e006
Show file tree
Hide file tree
Showing 11 changed files with 167 additions and 21 deletions.
2 changes: 1 addition & 1 deletion docs/cmd/tkn_pipelinerun.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Manage pipelineruns
### SEE ALSO

* [tkn](tkn.md) - CLI for tekton pipelines
* [tkn pipelinerun cancel](tkn_pipelinerun_cancel.md) - Cancel the PipelineRun
* [tkn pipelinerun cancel](tkn_pipelinerun_cancel.md) - Cancel a PipelineRun in a namespace
* [tkn pipelinerun delete](tkn_pipelinerun_delete.md) - Delete a pipelinerun in a namespace
* [tkn pipelinerun describe](tkn_pipelinerun_describe.md) - Describe a pipelinerun in a namespace
* [tkn pipelinerun list](tkn_pipelinerun_list.md) - Lists pipelineruns in a namespace
Expand Down
6 changes: 3 additions & 3 deletions docs/cmd/tkn_pipelinerun_cancel.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
## tkn pipelinerun cancel

Cancel the PipelineRun
Cancel a PipelineRun in a namespace

### Usage

```
tkn pipelinerun cancel pipelinerunName
tkn pipelinerun cancel
```

### Synopsis

Cancel the PipelineRun
Cancel a PipelineRun in a namespace

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tkn_taskrun.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Manage taskruns
### SEE ALSO

* [tkn](tkn.md) - CLI for tekton pipelines
* [tkn taskrun cancel](tkn_taskrun_cancel.md) - Cancel a taskrun in a namespace
* [tkn taskrun cancel](tkn_taskrun_cancel.md) - Cancel a TaskRun in a namespace
* [tkn taskrun delete](tkn_taskrun_delete.md) - Delete a taskrun in a namespace
* [tkn taskrun describe](tkn_taskrun_describe.md) - Describe a taskrun in a namespace
* [tkn taskrun list](tkn_taskrun_list.md) - Lists TaskRuns in a namespace
Expand Down
6 changes: 3 additions & 3 deletions docs/cmd/tkn_taskrun_cancel.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## tkn taskrun cancel

Cancel a taskrun in a namespace
Cancel a TaskRun in a namespace

### Usage

Expand All @@ -10,11 +10,11 @@ tkn taskrun cancel

### Synopsis

Cancel a taskrun in a namespace
Cancel a TaskRun in a namespace

### Examples

Cancel the TaskRun named 'foo' from the namespace 'bar':
Cancel the TaskRun named 'foo' from namespace 'bar':

tkn taskrun cancel foo -n bar

Expand Down
6 changes: 3 additions & 3 deletions docs/man/man1/tkn-pipelinerun-cancel.1
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@

.SH NAME
.PP
tkn\-pipelinerun\-cancel \- Cancel the PipelineRun
tkn\-pipelinerun\-cancel \- Cancel a PipelineRun in a namespace


.SH SYNOPSIS
.PP
\fBtkn pipelinerun cancel pipelinerunName\fP
\fBtkn pipelinerun cancel\fP


.SH DESCRIPTION
.PP
Cancel the PipelineRun
Cancel a PipelineRun in a namespace


.SH OPTIONS
Expand Down
6 changes: 3 additions & 3 deletions docs/man/man1/tkn-taskrun-cancel.1
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

.SH NAME
.PP
tkn\-taskrun\-cancel \- Cancel a taskrun in a namespace
tkn\-taskrun\-cancel \- Cancel a TaskRun in a namespace


.SH SYNOPSIS
Expand All @@ -15,7 +15,7 @@ tkn\-taskrun\-cancel \- Cancel a taskrun in a namespace

.SH DESCRIPTION
.PP
Cancel a taskrun in a namespace
Cancel a TaskRun in a namespace


.SH OPTIONS
Expand Down Expand Up @@ -44,7 +44,7 @@ Cancel a taskrun in a namespace

.SH EXAMPLE
.PP
Cancel the TaskRun named 'foo' from the namespace 'bar':
Cancel the TaskRun named 'foo' from namespace 'bar':

.PP
.RS
Expand Down
6 changes: 3 additions & 3 deletions pkg/cmd/pipelinerun/cancel.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import (
const (
succeeded = "Succeeded"
failed = "Failed"
prCancelled = "Failed(PipelineRunCancelled)"
prCancelled = "Cancelled(PipelineRunCancelled)"
)

func cancelCommand(p cli.Params) *cobra.Command {
Expand All @@ -38,8 +38,8 @@ func cancelCommand(p cli.Params) *cobra.Command {
`

c := &cobra.Command{
Use: "cancel pipelinerunName",
Short: "Cancel the PipelineRun",
Use: "cancel",
Short: "Cancel a PipelineRun in a namespace",
Example: eg,
SilenceUsage: true,
Annotations: map[string]string{
Expand Down
79 changes: 79 additions & 0 deletions pkg/cmd/pipelinerun/describe_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -730,3 +730,82 @@ tr-1 t-1 8 minutes ago 3 minutes Succeeded

test.AssertOutput(t, expected, actual)
}

func TestPipelineRunDescribe_cancelled_pipelinerun(t *testing.T) {
clock := clockwork.NewFakeClock()

trs := []*v1alpha1.TaskRun{
tb.TaskRun("tr-1", "ns",
tb.TaskRunStatus(
tb.TaskRunStartTime(clock.Now().Add(2*time.Minute)),
cb.TaskRunCompletionTime(clock.Now().Add(5*time.Minute)),
tb.StatusCondition(apis.Condition{
Type: apis.ConditionSucceeded,
Status: corev1.ConditionTrue,
}),
),
),
}

cs, _ := test.SeedTestData(t, pipelinetest.Data{
PipelineRuns: []*v1alpha1.PipelineRun{
tb.PipelineRun("pipeline-run", "ns",
cb.PipelineRunCreationTimestamp(clock.Now()),
tb.PipelineRunLabel("tekton.dev/pipeline", "pipeline"),
tb.PipelineRunSpec("pipeline"),
tb.PipelineRunStatus(
tb.PipelineRunTaskRunsStatus("tr-1", &v1alpha1.PipelineRunTaskRunStatus{
PipelineTaskName: "t-1",
Status: &trs[0].Status,
}),
tb.PipelineRunStatusCondition(apis.Condition{
Status: corev1.ConditionFalse,
Reason: "PipelineRunCancelled",
Message: "PipelineRun \"pipeline-run\" was cancelled",
}),
tb.PipelineRunStartTime(clock.Now()),
cb.PipelineRunCompletionTime(clock.Now().Add(5*time.Minute)),
),
),
},
Namespaces: []*corev1.Namespace{
{
ObjectMeta: metav1.ObjectMeta{
Name: "ns",
},
},
},
})

p := &test.Params{Tekton: cs.Pipeline, Clock: clock, Kube: cs.Kube}

pipelinerun := Command(p)
clock.Advance(10 * time.Minute)
actual, err := test.ExecuteCommand(pipelinerun, "desc", "pipeline-run", "-n", "ns")
if err != nil {
t.Errorf("Unexpected error: %v", err)
}
expected := `Name: pipeline-run
Namespace: ns
Pipeline Ref: pipeline
Status
STARTED DURATION STATUS
10 minutes ago 5 minutes Cancelled(PipelineRunCancelled)
Message
PipelineRun "pipeline-run" was cancelled
Resources
No resources
Params
No params
Taskruns
NAME TASK NAME STARTED DURATION STATUS
tr-1 t-1 8 minutes ago 3 minutes Succeeded
`

test.AssertOutput(t, expected, actual)
}
6 changes: 3 additions & 3 deletions pkg/cmd/taskrun/cancel.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,18 @@ import (
const (
succeeded = "Succeeded"
failed = "Failed"
taskCancelled = "Failed(TaskRunCancelled)"
taskCancelled = "Cancelled(TaskRunCancelled)"
)

func cancelCommand(p cli.Params) *cobra.Command {
eg := `Cancel the TaskRun named 'foo' from the namespace 'bar':
eg := `Cancel the TaskRun named 'foo' from namespace 'bar':
tkn taskrun cancel foo -n bar
`

c := &cobra.Command{
Use: "cancel",
Short: "Cancel a taskrun in a namespace",
Short: "Cancel a TaskRun in a namespace",
Example: eg,
Args: cobra.ExactArgs(1),
SilenceUsage: true,
Expand Down
62 changes: 62 additions & 0 deletions pkg/cmd/taskrun/describe_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -714,3 +714,65 @@ step2 Running

test.AssertOutput(t, expected, actual)
}

func TestTaskRunDescribe_cancel_taskrun(t *testing.T) {
clock := clockwork.NewFakeClock()

trs := []*v1alpha1.TaskRun{
tb.TaskRun("tr-1", "ns",
tb.TaskRunStatus(
tb.TaskRunStartTime(clock.Now().Add(2*time.Minute)),
cb.TaskRunCompletionTime(clock.Now().Add(5*time.Minute)),
tb.StatusCondition(apis.Condition{
Status: corev1.ConditionFalse,
Reason: "TaskRunCancelled",
Message: "TaskRun \"tr-1\" was cancelled",
}),
),
),
}

cs, _ := test.SeedTestData(t, pipelinetest.Data{
TaskRuns: trs,
Namespaces: []*corev1.Namespace{
{
ObjectMeta: metav1.ObjectMeta{
Name: "ns",
},
},
},
})

p := &test.Params{Tekton: cs.Pipeline, Clock: clock, Kube: cs.Kube}

taskrun := Command(p)
clock.Advance(10 * time.Minute)
actual, err := test.ExecuteCommand(taskrun, "desc", "tr-1", "-n", "ns")
if err != nil {
t.Errorf("Unexpected error: %v", err)
}
expected := `Name: tr-1
Namespace: ns
Status
STARTED DURATION STATUS
8 minutes ago 3 minutes Cancelled(TaskRunCancelled)
Message
TaskRun "tr-1" was cancelled
Input Resources
No resources
Output Resources
No resources
Params
No params
Steps
No steps
`

test.AssertOutput(t, expected, actual)
}
7 changes: 6 additions & 1 deletion pkg/formatted/k8s.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,12 @@ func Condition(c v1beta1.Conditions) string {
}

if c[0].Reason != "" && c[0].Reason != status {
status = status + "(" + c[0].Reason + ")"

if c[0].Reason == "PipelineRunCancelled" || c[0].Reason == "TaskRunCancelled" {
status = "Cancelled" + "(" + c[0].Reason + ")"
} else {
status = status + "(" + c[0].Reason + ")"
}
}

return status
Expand Down

0 comments on commit b04e006

Please sign in to comment.