Add --dry-run option to argo submit (argoproj#1506)

cmd/argo/commands/common.go

@@ -21,6 +21,7 @@ var (
 	restConfig       *rest.Config
 	clientConfig     clientcmd.ClientConfig
 	clientset        *kubernetes.Clientset
+	wfClientset      *wfclientset.Clientset // wfClientset is used for the server-dry-run submit option
 	wfClient         v1alpha1.WorkflowInterface
 	jobStatusIconMap map[wfv1.NodePhase]string
 	noColor          bool
@@ -94,8 +95,8 @@ func InitWorkflowClient(ns ...string) v1alpha1.WorkflowInterface {
 			log.Fatal(err)
 		}
 	}
-	wfcs := wfclientset.NewForConfigOrDie(restConfig)
-	wfClient = wfcs.ArgoprojV1alpha1().Workflows(namespace)
+	wfClientset = wfclientset.NewForConfigOrDie(restConfig)
+	wfClient = wfClientset.ArgoprojV1alpha1().Workflows(namespace)
 	return wfClient
 }
 

cmd/argo/commands/resubmit.go

@@ -28,7 +28,7 @@ func NewResubmitCommand() *cobra.Command {
 			errors.CheckError(err)
 			newWF, err := util.FormulateResubmitWorkflow(wf, memoized)
 			errors.CheckError(err)
-			created, err := util.SubmitWorkflow(wfClient, newWF, nil)
+			created, err := util.SubmitWorkflow(wfClient, wfClientset, newWF, nil)
 			errors.CheckError(err)
 			printWorkflow(created, cliSubmitOpts.output, DefaultStatus)
 			waitOrWatch([]string{created.Name}, cliSubmitOpts)

cmd/argo/commands/submit.go

@@ -6,10 +6,13 @@ import (
 	"log"
 	"net/http"
 	"os"
+	"strconv"
 
 	"github.com/argoproj/pkg/json"
 	"github.com/spf13/cobra"
 
+	apimachineryversion "k8s.io/apimachinery/pkg/version"
+
 	wfv1 "github.com/argoproj/argo/pkg/apis/workflow/v1alpha1"
 	cmdutil "github.com/argoproj/argo/util/cmd"
 	"github.com/argoproj/argo/workflow/common"
@@ -52,6 +55,8 @@ func NewSubmitCommand() *cobra.Command {
 	command.Flags().StringArrayVarP(&submitOpts.Parameters, "parameter", "p", []string{}, "pass an input parameter")
 	command.Flags().StringVar(&submitOpts.ServiceAccount, "serviceaccount", "", "run all pods in the workflow using specified serviceaccount")
 	command.Flags().StringVar(&submitOpts.InstanceID, "instanceid", "", "submit with a specific controller's instance id label")
+	command.Flags().BoolVar(&submitOpts.DryRun, "dry-run", false, "modify the workflow on the client-side without creating it")
+	command.Flags().BoolVar(&submitOpts.ServerDryRun, "server-dry-run", false, "send request to server with dry-run flag which will modify the workflow without creating it")
 	command.Flags().StringVarP(&cliSubmitOpts.output, "output", "o", "", "Output format. One of: name|json|yaml|wide")
 	command.Flags().BoolVarP(&cliSubmitOpts.wait, "wait", "w", false, "wait for the workflow to complete")
 	command.Flags().BoolVar(&cliSubmitOpts.watch, "watch", false, "watch the workflow until it completes")
@@ -116,6 +121,47 @@ func SubmitWorkflows(filePaths []string, submitOpts *util.SubmitOpts, cliOpts *c
 		if cliOpts.wait {
 			log.Fatalf("--wait cannot be combined with --watch")
 		}
+		if submitOpts.DryRun {
+			log.Fatalf("--watch cannot be combined with --dry-run")
+		}
+		if submitOpts.ServerDryRun {
+			log.Fatalf("--watch cannot be combined with --server-dry-run")
+		}
+	}
+
+	if cliOpts.wait {
+		if submitOpts.DryRun {
+			log.Fatalf("--wait cannot be combined with --dry-run")
+		}
+		if submitOpts.ServerDryRun {
+			log.Fatalf("--wait cannot be combined with --server-dry-run")
+		}
+	}
+
+	if submitOpts.DryRun {
+		if cliOpts.output == "" {
+			log.Fatalf("--dry-run should have an output option")
+		}
+		if submitOpts.ServerDryRun {
+			log.Fatalf("--dry-run cannot be combined with --server-dry-run")
+		}
+	}
+
+	if submitOpts.ServerDryRun {
+		if cliOpts.output == "" {
+			log.Fatalf("--server-dry-run should have an output option")
+		}
+		serverVersion, err := wfClientset.Discovery().ServerVersion()
+		if err != nil {
+			log.Fatalf("Unexpected error while getting the server's api version")
+		}
+		isCompatible, err := checkServerVersionForDryRun(serverVersion)
+		if err != nil {
+			log.Fatalf("Unexpected error while checking the server's api version compatibility with --server-dry-run")
+		}
+		if !isCompatible {
+			log.Fatalf("--server-dry-run is not available for server api versions older than v1.12")
+		}
 	}
 
 	if len(workflows) == 0 {
@@ -124,13 +170,21 @@ func SubmitWorkflows(filePaths []string, submitOpts *util.SubmitOpts, cliOpts *c
 	}
 
 	var workflowNames []string
+
 	for _, wf := range workflows {
 		wf.Spec.Priority = cliOpts.priority
 		wfClient := defaultWFClient
 		if wf.Namespace != "" {
 			wfClient = InitWorkflowClient(wf.Namespace)
+		} else {
+			// This is here to avoid passing an empty namespace when using --server-dry-run
+			namespace, _, err := clientConfig.Namespace()
+			if err != nil {
+				log.Fatal(err)
+			}
+			wf.Namespace = namespace
 		}
-		created, err := util.SubmitWorkflow(wfClient, &wf, submitOpts)
+		created, err := util.SubmitWorkflow(wfClient, wfClientset, &wf, submitOpts)
 		if err != nil {
 			log.Fatalf("Failed to submit workflow: %v", err)
 		}
@@ -140,6 +194,24 @@ func SubmitWorkflows(filePaths []string, submitOpts *util.SubmitOpts, cliOpts *c
 	waitOrWatch(workflowNames, *cliOpts)
 }
 
+// Checks whether the server has support for the dry-run option
+func checkServerVersionForDryRun(serverVersion *apimachineryversion.Info) (bool, error) {
+	majorVersion, err := strconv.Atoi(serverVersion.Major)
+	if err != nil {
+		return false, err
+	}
+	minorVersion, err := strconv.Atoi(serverVersion.Minor)
+	if err != nil {
+		return false, err
+	}
+	if majorVersion < 1 {
+		return false, nil
+	} else if majorVersion == 1 && minorVersion < 12 {
+		return false, nil
+	}
+	return true, nil
+}
+
 // unmarshalWorkflows unmarshals the input bytes as either json or yaml
 func unmarshalWorkflows(wfBytes []byte, strict bool) []wfv1.Workflow {
 	var wf wfv1.Workflow

workflow/artifacts/raw/raw_test.go

@@ -1,13 +1,14 @@
 package raw_test
 
 import (
-	wfv1 "github.com/argoproj/argo/pkg/apis/workflow/v1alpha1"
-	"github.com/argoproj/argo/workflow/artifacts/raw"
-	"github.com/stretchr/testify/assert"
 	"io/ioutil"
 	"os"
 	"testing"
 	"time"
+
+	wfv1 "github.com/argoproj/argo/pkg/apis/workflow/v1alpha1"
+	"github.com/argoproj/argo/workflow/artifacts/raw"
+	"github.com/stretchr/testify/assert"
 )
 
 const (

workflow/controller/controller_test.go

@@ -3,11 +3,12 @@ package controller
 import (
 	"bytes"
 	"encoding/json"
-	"github.com/argoproj/argo/workflow/config"
 	"io"
 	"io/ioutil"
 	"testing"
 
+	"github.com/argoproj/argo/workflow/config"
+
 	wfv1 "github.com/argoproj/argo/pkg/apis/workflow/v1alpha1"
 	fakewfclientset "github.com/argoproj/argo/pkg/client/clientset/versioned/fake"
 	"github.com/ghodss/yaml"

workflow/controller/operator_test.go

@@ -3,10 +3,11 @@ package controller
 import (
 	"encoding/json"
 	"fmt"
-	"github.com/argoproj/argo/workflow/config"
 	"strings"
 	"testing"
 
+	"github.com/argoproj/argo/workflow/config"
+
 	wfv1 "github.com/argoproj/argo/pkg/apis/workflow/v1alpha1"
 	"github.com/argoproj/argo/test"
 	"github.com/argoproj/argo/workflow/common"

workflow/util/util.go

@@ -31,6 +31,7 @@ import (
 	"github.com/argoproj/argo/errors"
 	"github.com/argoproj/argo/pkg/apis/workflow"
 	wfv1 "github.com/argoproj/argo/pkg/apis/workflow/v1alpha1"
+	wfclientset "github.com/argoproj/argo/pkg/client/clientset/versioned"
 	"github.com/argoproj/argo/pkg/client/clientset/versioned/typed/workflow/v1alpha1"
 	cmdutil "github.com/argoproj/argo/util/cmd"
 	"github.com/argoproj/argo/util/file"
@@ -141,12 +142,14 @@ type SubmitOpts struct {
 	Parameters     []string               // --parameter
 	ParameterFile  string                 // --parameter-file
 	ServiceAccount string                 // --serviceaccount
+	DryRun         bool                   // --dry-run
+	ServerDryRun   bool                   // --server-dry-run
 	Labels         string                 // --labels
 	OwnerReference *metav1.OwnerReference // useful if your custom controller creates argo workflow resources
 }
 
 // SubmitWorkflow validates and submit a single workflow and override some of the fields of the workflow
-func SubmitWorkflow(wfIf v1alpha1.WorkflowInterface, wf *wfv1.Workflow, opts *SubmitOpts) (*wfv1.Workflow, error) {
+func SubmitWorkflow(wfIf v1alpha1.WorkflowInterface, wfClientset wfclientset.Interface, wf *wfv1.Workflow, opts *SubmitOpts) (*wfv1.Workflow, error) {
 	if opts == nil {
 		opts = &SubmitOpts{}
 	}
@@ -254,7 +257,33 @@ func SubmitWorkflow(wfIf v1alpha1.WorkflowInterface, wf *wfv1.Workflow, opts *Su
 	if err != nil {
 		return nil, err
 	}
-	return wfIf.Create(wf)
+
+	if opts.ServerDryRun {
+		wf, err := CreateServerDryRun(wf, wfClientset)
+		if err != nil {
+			return nil, err
+		}
+		return wf, err
+	} else if opts.DryRun {
+		return wf, nil
+	} else {
+		return wfIf.Create(wf)
+	}
+}
+
+// CreateServerDryRun fills the workflow struct with the server's representation without creating it and returns an error, if there is any
+func CreateServerDryRun(wf *wfv1.Workflow, wfClientset wfclientset.Interface) (*wfv1.Workflow, error) {
+	// Keep the workflow metadata because it will be overwritten by the Post request
+	workflowTypeMeta := wf.TypeMeta
+	err := wfClientset.ArgoprojV1alpha1().RESTClient().Post().
+		Namespace(wf.Namespace).
+		Resource("workflows").
+		Body(wf).
+		Param("dryRun", "All").
+		Do().
+		Into(wf)
+	wf.TypeMeta = workflowTypeMeta
+	return wf, err
 }
 
 // SuspendWorkflow suspends a workflow by setting spec.suspend to true. Retries conflict errors