fix: Fix inconsistent ordering of workflows with the list command. Fixes

argoproj#7581 Signed-off-by: Peixuan Ding <[email protected]>
dinever · Jan 20, 2022 · 9d69279 · 9d69279
1 parent f1fe3be
commit 9d69279
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/cmd/argo/commands/list.go b/cmd/argo/commands/list.go
@@ -38,7 +38,8 @@ type listFlags struct {
 }
 
 var (
- nameFields = "metadata,items.metadata.name"
+ // finishedAt and creationTimestamp must be included to have a consistent display order of workflows
+ nameFields = "metadata,items.metadata.name,items.metadata.creationTimestamp,items.status.finishedAt"
  defaultFields = "metadata,items.metadata,items.spec,items.status.phase,items.status.message,items.status.finishedAt,items.status.startedAt,items.status.estimatedDuration,items.status.progress"
 )
 

diff --git a/cmd/argo/commands/list_test.go b/cmd/argo/commands/list_test.go
@@ -76,11 +76,21 @@ func Test_listWorkflows(t *testing.T) {
  assert.Len(t, workflows, 1)
  }
  })
+ t.Run("Names", func(t *testing.T) {
+ workflows, err := list(&metav1.ListOptions{FieldSelector: nameFields}, listFlags{fields: nameFields})
+ if assert.NoError(t, err) {
+ assert.Len(t, workflows, 3)
+ // most recent workflow will be shown first
+ assert.Equal(t, "bar-", workflows[0].Name)
+ assert.Equal(t, "baz-", workflows[1].Name)
+ assert.Equal(t, "foo-", workflows[2].Name)
+ }
+ })
 }
 
 func list(listOptions *metav1.ListOptions, flags listFlags) (wfv1.Workflows, error) {
  c := &workflowmocks.WorkflowServiceClient{}
- c.On("ListWorkflows", mock.Anything, &workflow.WorkflowListRequest{ListOptions: listOptions, Fields: defaultFields}).Return(&wfv1.WorkflowList{Items: wfv1.Workflows{
+ c.On("ListWorkflows", mock.Anything, &workflow.WorkflowListRequest{ListOptions: listOptions, Fields: flags.displayFields()}).Return(&wfv1.WorkflowList{Items: wfv1.Workflows{
  {ObjectMeta: metav1.ObjectMeta{Name: "foo-", CreationTimestamp: metav1.Time{Time: time.Now().Add(-2 * time.Hour)}}, Status: wfv1.WorkflowStatus{FinishedAt: metav1.Time{Time: time.Now().Add(-2 * time.Hour)}}},
  {ObjectMeta: metav1.ObjectMeta{Name: "bar-", CreationTimestamp: metav1.Time{Time: time.Now()}}},
  {ObjectMeta: metav1.ObjectMeta{