-
Notifications
You must be signed in to change notification settings - Fork 3.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(cli): Retry workflows by label selector and field selector (#5795)
- Loading branch information
Showing
3 changed files
with
254 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| package commands | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/mock" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
|
|
||
| workflowpkg "github.com/argoproj/argo-workflows/v3/pkg/apiclient/workflow" | ||
| workflowmocks "github.com/argoproj/argo-workflows/v3/pkg/apiclient/workflow/mocks" | ||
| wfv1 "github.com/argoproj/argo-workflows/v3/pkg/apis/workflow/v1alpha1" | ||
| ) | ||
|
|
||
| func Test_retryWorkflows(t *testing.T) { | ||
| t.Run("Retry workflow by names", func(t *testing.T) { | ||
| c := &workflowmocks.WorkflowServiceClient{} | ||
| retryOpts := retryOps{ | ||
| namespace: "argo", | ||
| } | ||
| cliSubmitOpts := cliSubmitOpts{} | ||
|
|
||
| c.On("RetryWorkflow", mock.Anything, mock.Anything).Return(&wfv1.Workflow{}, nil) | ||
|
|
||
| err := retryWorkflows(context.Background(), c, retryOpts, cliSubmitOpts, []string{"foo", "bar"}) | ||
| c.AssertNumberOfCalls(t, "RetryWorkflow", 2) | ||
|
|
||
| assert.NoError(t, err) | ||
| }) | ||
|
|
||
| t.Run("Retry workflow by selector", func(t *testing.T) { | ||
| c := &workflowmocks.WorkflowServiceClient{} | ||
| retryOpts := retryOps{ | ||
| namespace: "argo", | ||
| labelSelector: "custom-label=true", | ||
| } | ||
| cliSubmitOpts := cliSubmitOpts{} | ||
|
|
||
| wfListReq := &workflowpkg.WorkflowListRequest{ | ||
| Namespace: "argo", | ||
| ListOptions: &metav1.ListOptions{ | ||
| LabelSelector: retryOpts.labelSelector, | ||
| }, | ||
| } | ||
|
|
||
| wfList := &wfv1.WorkflowList{Items: wfv1.Workflows{ | ||
| {ObjectMeta: metav1.ObjectMeta{Name: "foo", Namespace: "argo"}}, | ||
| {ObjectMeta: metav1.ObjectMeta{Name: "bar", Namespace: "argo"}}, | ||
| {ObjectMeta: metav1.ObjectMeta{Name: "baz", Namespace: "argo"}}, | ||
| }} | ||
|
|
||
| c.On("ListWorkflows", mock.Anything, wfListReq).Return(wfList, nil) | ||
| c.On("RetryWorkflow", mock.Anything, mock.Anything).Return(&wfv1.Workflow{}, nil) | ||
|
|
||
| err := retryWorkflows(context.Background(), c, retryOpts, cliSubmitOpts, []string{}) | ||
|
|
||
| c.AssertNumberOfCalls(t, "RetryWorkflow", 3) | ||
| for _, wf := range wfList.Items { | ||
| retryReq := &workflowpkg.WorkflowRetryRequest{ | ||
| Name: wf.Name, | ||
| Namespace: wf.Namespace, | ||
| RestartSuccessful: retryOpts.restartSuccessful, | ||
| NodeFieldSelector: "", | ||
| } | ||
| c.AssertCalled(t, "RetryWorkflow", mock.Anything, retryReq) | ||
| } | ||
|
|
||
| assert.NoError(t, err) | ||
| }) | ||
|
|
||
| t.Run("Retry workflow by selector and name", func(t *testing.T) { | ||
| c := &workflowmocks.WorkflowServiceClient{} | ||
| retryOpts := retryOps{ | ||
| namespace: "argo", | ||
| labelSelector: "custom-label=true", | ||
| } | ||
| cliSubmitOpts := cliSubmitOpts{} | ||
|
|
||
| wfListReq := &workflowpkg.WorkflowListRequest{ | ||
| Namespace: "argo", | ||
| ListOptions: &metav1.ListOptions{ | ||
| LabelSelector: retryOpts.labelSelector, | ||
| }, | ||
| } | ||
|
|
||
| wfList := &wfv1.WorkflowList{Items: wfv1.Workflows{ | ||
| {ObjectMeta: metav1.ObjectMeta{Name: "foo"}}, | ||
| {ObjectMeta: metav1.ObjectMeta{Name: "bar"}}, | ||
| {ObjectMeta: metav1.ObjectMeta{Name: "baz"}}, | ||
| }} | ||
|
|
||
| c.On("ListWorkflows", mock.Anything, wfListReq).Return(wfList, nil) | ||
|
|
||
| c.On("RetryWorkflow", mock.Anything, mock.Anything).Return(&wfv1.Workflow{}, nil) | ||
|
|
||
| err := retryWorkflows(context.Background(), c, retryOpts, cliSubmitOpts, []string{"foo", "qux"}) | ||
| // after de-duplication, there will be 4 workflows to retry | ||
| c.AssertNumberOfCalls(t, "RetryWorkflow", 4) | ||
|
|
||
| // the 3 workflows from the selectors: "foo", "bar", "baz" | ||
| for _, wf := range wfList.Items { | ||
| retryReq := &workflowpkg.WorkflowRetryRequest{ | ||
| Name: wf.Name, | ||
| Namespace: wf.Namespace, | ||
| RestartSuccessful: retryOpts.restartSuccessful, | ||
| NodeFieldSelector: "", | ||
| } | ||
| c.AssertCalled(t, "RetryWorkflow", mock.Anything, retryReq) | ||
| } | ||
|
|
||
| // the 1 workflow by the given name "qux | ||
| c.AssertCalled(t, "RetryWorkflow", mock.Anything, &workflowpkg.WorkflowRetryRequest{ | ||
| Name: "qux", | ||
| Namespace: "argo", | ||
| RestartSuccessful: retryOpts.restartSuccessful, | ||
| NodeFieldSelector: "", | ||
| }) | ||
|
|
||
| assert.NoError(t, err) | ||
| }) | ||
|
|
||
| t.Run("Retry workflow list error", func(t *testing.T) { | ||
| c := &workflowmocks.WorkflowServiceClient{} | ||
| retryOpts := retryOps{ | ||
| namespace: "argo", | ||
| labelSelector: "custom-label=true", | ||
| } | ||
| cliSubmitOpts := cliSubmitOpts{} | ||
| c.On("ListWorkflows", mock.Anything, mock.Anything).Return(nil, fmt.Errorf("mock error")) | ||
| err := retryWorkflows(context.Background(), c, retryOpts, cliSubmitOpts, []string{}) | ||
| assert.Errorf(t, err, "mock error") | ||
| }) | ||
|
|
||
| t.Run("Retry workflow error", func(t *testing.T) { | ||
| c := &workflowmocks.WorkflowServiceClient{} | ||
| retryOpts := retryOps{ | ||
| namespace: "argo", | ||
| } | ||
| cliSubmitOpts := cliSubmitOpts{} | ||
| c.On("RetryWorkflow", mock.Anything, mock.Anything).Return(nil, fmt.Errorf("mock error")) | ||
| err := retryWorkflows(context.Background(), c, retryOpts, cliSubmitOpts, []string{"foo"}) | ||
| assert.Errorf(t, err, "mock error") | ||
| }) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters