fix: modified SearchArtifact to return ArtifactSearchResults. Fixes

#8543 (#8557) Signed-off-by: Rohan Kumar <[email protected]>
argoproj · Apr 30, 2022 · 5b8638f · 5b8638f
1 parent 9398b07
commit 5b8638f
Show file tree

Hide file tree

Showing 7 changed files with 1,053 additions and 740 deletions.
diff --git a/pkg/apis/api-rules/violation_exceptions.list b/pkg/apis/api-rules/violation_exceptions.list
@@ -38,5 +38,7 @@ API rule violation: list_type_missing,github.com/argoproj/argo-workflows/v3/pkg/
 API rule violation: list_type_missing,github.com/argoproj/argo-workflows/v3/pkg/apis/workflow/v1alpha1,WorkflowSpec,Volumes
 API rule violation: list_type_missing,github.com/argoproj/argo-workflows/v3/pkg/apis/workflow/v1alpha1,WorkflowStatus,PersistentVolumeClaims
 API rule violation: list_type_missing,github.com/argoproj/argo-workflows/v3/pkg/apis/workflow/v1alpha1,WorkflowStep,WithItems
+API rule violation: names_match,github.com/argoproj/argo-workflows/v3/pkg/apis/workflow/v1alpha1,ArtifactSearchResult,Artifact
+API rule violation: names_match,github.com/argoproj/argo-workflows/v3/pkg/apis/workflow/v1alpha1,ArtifactSearchResult,NodeID
 API rule violation: names_match,github.com/argoproj/argo-workflows/v3/pkg/apis/workflow/v1alpha1,SubmitOpts,Entrypoint
 API rule violation: names_match,github.com/argoproj/argo-workflows/v3/pkg/apis/workflow/v1alpha1,WorkflowStatus,StoredWorkflowSpec
diff --git a/pkg/apis/workflow/v1alpha1/generated.pb.go b/pkg/apis/workflow/v1alpha1/generated.pb.go
diff --git a/pkg/apis/workflow/v1alpha1/generated.proto b/pkg/apis/workflow/v1alpha1/generated.proto
diff --git a/pkg/apis/workflow/v1alpha1/openapi_generated.go b/pkg/apis/workflow/v1alpha1/openapi_generated.go
diff --git a/pkg/apis/workflow/v1alpha1/workflow_types.go b/pkg/apis/workflow/v1alpha1/workflow_types.go
@@ -1257,6 +1257,13 @@ type ArtifactSearchQuery struct {
  NodeId string `json:"nodeId,omitempty" protobuf:"bytes,4,rep,name=nodeId"`
 }
 
+type ArtifactSearchResult struct {
+ Artifact `protobuf:"bytes,1,opt,name=artifact"`
+ NodeID string `protobuf:"bytes,2,opt,name=nodeID"`
+}
+
+type ArtifactSearchResults []ArtifactSearchResult
+
 func NewArtifactSearchQuery() *ArtifactSearchQuery {
  var q ArtifactSearchQuery
  q.ArtifactGCStrategies = make(map[ArtifactGCStrategy]bool)
@@ -1272,9 +1279,9 @@ func (q *ArtifactSearchQuery) anyArtifactGCStrategy() bool {
  return false
 }
 
-func (w *Workflow) SearchArtifacts(q *ArtifactSearchQuery) Artifacts {
+func (w *Workflow) SearchArtifacts(q *ArtifactSearchQuery) ArtifactSearchResults {
 
- var artifacts Artifacts
+ var results ArtifactSearchResults
 
  for _, n := range w.Status.Nodes {
  t := w.GetTemplateByName(n.TemplateName)
@@ -1301,11 +1308,11 @@ func (w *Workflow) SearchArtifacts(q *ArtifactSearchQuery) Artifacts {
  match = false
  }
  if match == true {
- artifacts = append(artifacts, a)
+ results = append(results, ArtifactSearchResult{Artifact: a, NodeID: n.ID})
  }
  }
  }
- return artifacts
+ return results
 }
 
 // Outputs hold parameters, artifacts, and results from a step

diff --git a/pkg/apis/workflow/v1alpha1/workflow_types_test.go b/pkg/apis/workflow/v1alpha1/workflow_types_test.go
@@ -826,51 +826,73 @@ func TestWorkflow_SearchArtifacts(t *testing.T) {
  query := NewArtifactSearchQuery()
 
  // no filters
- queriedArtifacts := wf.SearchArtifacts(query)
- assert.NotNil(t, queriedArtifacts)
- assert.Len(t, queriedArtifacts, 3)
+ queriedArtifactSearchResults := wf.SearchArtifacts(query)
+ assert.NotNil(t, queriedArtifactSearchResults)
+ assert.Len(t, queriedArtifactSearchResults, 3)
+ assert.Equal(t, "artifact-foo", queriedArtifactSearchResults[0].Artifact.Name)
+ assert.Equal(t, "artifact-bar", queriedArtifactSearchResults[1].Artifact.Name)
+ assert.Equal(t, "artifact-foobar", queriedArtifactSearchResults[2].Artifact.Name)
+ assert.Equal(t, "node-foo", queriedArtifactSearchResults[0].NodeID)
+ assert.Equal(t, "node-foo", queriedArtifactSearchResults[1].NodeID)
+ assert.Equal(t, "node-bar", queriedArtifactSearchResults[2].NodeID)
 
  // artifact GC strategy
  query.ArtifactGCStrategies[ArtifactGCOnWorkflowCompletion] = true
- queriedArtifacts = wf.SearchArtifacts(query)
- assert.NotNil(t, queriedArtifacts)
- assert.Len(t, queriedArtifacts, 3)
+ queriedArtifactSearchResults = wf.SearchArtifacts(query)
+ assert.NotNil(t, queriedArtifactSearchResults)
+ assert.Len(t, queriedArtifactSearchResults, 3)
+ assert.Equal(t, "artifact-foo", queriedArtifactSearchResults[0].Artifact.Name)
+ assert.Equal(t, "artifact-bar", queriedArtifactSearchResults[1].Artifact.Name)
+ assert.Equal(t, "artifact-foobar", queriedArtifactSearchResults[2].Artifact.Name)
+ assert.Equal(t, "node-foo", queriedArtifactSearchResults[0].NodeID)
+ assert.Equal(t, "node-foo", queriedArtifactSearchResults[1].NodeID)
+ assert.Equal(t, "node-bar", queriedArtifactSearchResults[2].NodeID)
 
  // template name
  query = NewArtifactSearchQuery()
  query.TemplateName = "template-bar"
- queriedArtifacts = wf.SearchArtifacts(query)
- assert.NotNil(t, queriedArtifacts)
- assert.Len(t, queriedArtifacts, 1)
+ queriedArtifactSearchResults = wf.SearchArtifacts(query)
+ assert.NotNil(t, queriedArtifactSearchResults)
+ assert.Len(t, queriedArtifactSearchResults, 1)
+ assert.Equal(t, "artifact-foobar", queriedArtifactSearchResults[0].Artifact.Name)
+ assert.Equal(t, "node-bar", queriedArtifactSearchResults[0].NodeID)
 
  // artifact name
  query = NewArtifactSearchQuery()
  query.ArtifactName = "artifact-foo"
- queriedArtifacts = wf.SearchArtifacts(query)
- assert.NotNil(t, queriedArtifacts)
- assert.Len(t, queriedArtifacts, 1)
+ queriedArtifactSearchResults = wf.SearchArtifacts(query)
+ assert.NotNil(t, queriedArtifactSearchResults)
+ assert.Len(t, queriedArtifactSearchResults, 1)
+ assert.Equal(t, "artifact-foo", queriedArtifactSearchResults[0].Artifact.Name)
+ assert.Equal(t, "node-foo", queriedArtifactSearchResults[0].NodeID)
 
  // node id
  query = NewArtifactSearchQuery()
  query.NodeId = "node-foo"
- queriedArtifacts = wf.SearchArtifacts(query)
- assert.NotNil(t, queriedArtifacts)
- assert.Len(t, queriedArtifacts, 2)
+ queriedArtifactSearchResults = wf.SearchArtifacts(query)
+ assert.NotNil(t, queriedArtifactSearchResults)
+ assert.Len(t, queriedArtifactSearchResults, 2)
+ assert.Equal(t, "artifact-foo", queriedArtifactSearchResults[0].Artifact.Name)
+ assert.Equal(t, "artifact-bar", queriedArtifactSearchResults[1].Artifact.Name)
+ assert.Equal(t, "node-foo", queriedArtifactSearchResults[0].NodeID)
+ assert.Equal(t, "node-foo", queriedArtifactSearchResults[1].NodeID)
 
  // bad query
  query = NewArtifactSearchQuery()
  query.NodeId = "node-foobar"
- queriedArtifacts = wf.SearchArtifacts(query)
- assert.Nil(t, queriedArtifacts)
- assert.Len(t, queriedArtifacts, 0)
+ queriedArtifactSearchResults = wf.SearchArtifacts(query)
+ assert.Nil(t, queriedArtifactSearchResults)
+ assert.Len(t, queriedArtifactSearchResults, 0)
 
  // template and artifact name
  query = NewArtifactSearchQuery()
  query.TemplateName = "template-foo"
  query.ArtifactName = "artifact-foo"
- queriedArtifacts = wf.SearchArtifacts(query)
- assert.NotNil(t, queriedArtifacts)
- assert.Len(t, queriedArtifacts, 1)
+ queriedArtifactSearchResults = wf.SearchArtifacts(query)
+ assert.NotNil(t, queriedArtifactSearchResults)
+ assert.Len(t, queriedArtifactSearchResults, 1)
+ assert.Equal(t, "artifact-foo", queriedArtifactSearchResults[0].Artifact.Name)
+ assert.Equal(t, "node-foo", queriedArtifactSearchResults[0].NodeID)
 }
 
 func TestWorkflowSpec_GetArtifactGC(t *testing.T) {

diff --git a/pkg/apis/workflow/v1alpha1/zz_generated.deepcopy.go b/pkg/apis/workflow/v1alpha1/zz_generated.deepcopy.go