Consolidate Result spec/status types across Pipeline/Task

[mattmoor]

This is relevant to duck typed tasks, but I hit this in the context of trying to write some library code that deals with results (both spec/status) in a common way.

Right now the result types are identical, and the spec types only differ in this Value field:

// PipelineResult used to describe the results of a pipeline
type PipelineResult struct {
	// Name the given name
	Name string `json:"name"`
	// Description is a human-readable description of the result
	// +optional
	Description string `json:"description"`
	// Value the expression used to retrieve the value
	Value string `json:"value"`
}

We will want a common type for these to live in our duck type anyways, so we should think about consolidating these shapes.

/assign @imjasonh

[imjasonh]

Some context I didn't have before this bug: PipelineResult's Value field exists to be able to express some derived result value of the Pipeline, as derived from some of its constituent Tasks' results.

This example for instance:

  ...
  results:
    - name: sum
      description: the sum of all three operands
      value: $(tasks.second-add.results.sum)
    - name: partial-sum
      description: the sum of first two operands
      value: $(tasks.first-add.results.sum)
    - name: all-sum
      description: the sum of everything
      value: $(tasks.second-add.results.sum)-$(tasks.first-add.results.sum)

So when this Pipeline is run, its PipelineRunResults will have values derived from the values of some of its TaskRuns.

[mattmoor]

One thing you can do there is to expose the same shape, but vary the validation.

This is a pretty common pattern for PodSpec, and ObjectReference (as widespread examples)

[bobcatfish]

I wonder if it would make sense to separate how a pipeline declares it will have results from how the results are set

[vdemeester]

/kind cleanup

[tekton-robot]

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
If this issue is safe to close now please do so with /close.

/lifecycle rotten

Send feedback to tektoncd/plumbing.

[tekton-robot]

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

/close

Send feedback to tektoncd/plumbing.

[tekton-robot]

@tekton-robot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

/close

Send feedback to tektoncd/plumbing.

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.

[vdemeester]

/remove-lifecycle rotten
/remove-lifecycle stale
/reopen

[tekton-robot]

@vdemeester: Reopened this issue.

In response to this:

/remove-lifecycle rotten
/remove-lifecycle stale
/reopen

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.

[tekton-robot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with /close.

/lifecycle stale

Send feedback to tektoncd/plumbing.

[mattmoor]

/lifecycle frozen

[abayer]

This is probably worth resurrecting in the context of the various results work that's been underway recently - cc @lbernick @jerop

[Yongxuanzhang]

Hi @mattmoor, I just want to confirm what we want to do with is issue. Those are the current result types, do we want to merge all of them into 1 type? Or 1 type for pipelinerun&taskrun, and 1 for pipeline&task?

type PipelineResult struct {
	Name string `json:"name"`
	Type ResultsType `json:"type,omitempty"`
	Description string `json:"description"`
	Value ArrayOrString `json:"value"`
}

type PipelineRunResult struct {
	Name string `json:"name"`
	Value ArrayOrString `json:"value"`
}

type TaskResult struct {
	Name string `json:"name"`
	Type ResultsType `json:"type,omitempty"`
	Properties map[string]PropertySpec `json:"properties,omitempty"`
	Description string `json:"description,omitempty"`
}

// TaskRunResult used to describe the results of a task
type TaskRunResult struct {
	Name string `json:"name"`
	Type ResultsType `json:"type,omitempty"`
	Value ArrayOrString `json:"value"`
}

[Yongxuanzhang]

I can take this if needed. /assign @Yongxuanzhang