[OCTRL-701] High-level configuration files are accepted as parameter for the creation of an environment with coconut.

Author: claireguyot

coconut/cmd/environment_create.go

@@ -34,9 +34,9 @@ import (
 
 // environmentCreateCmd represents the environment list command
 var environmentCreateCmd = &cobra.Command{
-	Use:   "create",
+	Use:     "create",
 	Aliases: []string{"new", "c", "n"},
-	Short: "create a new environment",
+	Short:   "create a new environment",
 	Long: fmt.Sprintf(`The environment create command requests from %s the
 creation of a new environment.
 
@@ -46,21 +46,21 @@ A valid workflow template (sometimes called simply "workflow" for brevity) must
 
 Workflows and tasks are managed with a git based configuration system, so the workflow template may be provided simply by name or with repository and branch/tag/hash constraints.
 Examples:
- * ` + "`coconut env create -w myworkflow`" + ` - loads workflow ` + "`myworkflow`" + ` from default configuration repository at HEAD of master branch
- * ` + "`coconut env create -w github.com/AliceO2Group/MyConfRepo/myworkflow`" + ` - loads a workflow from a specific git repository, HEAD of master branch
- * ` + "`coconut env create -w myworkflow@rev`" + ` - loads a workflow from default repository, on branch, tag or revision ` + "`rev`" + `
- * ` + "`coconut env create -w github.com/AliceO2Group/MyConfRepo/myworkflow@rev`" + ` - loads a workflow from a specific git repository, on branch, tag or revision ` + "`rev`" + `
-
-For more information on the %s workflow configuration system, see documentation for the ` + "`coconut repository`" + ` command.`, product.PRETTY_SHORTNAME, product.PRETTY_SHORTNAME),
-	Run:   control.WrapCall(control.CreateEnvironment),
+ * `+"`coconut env create -w myworkflow`"+` - loads workflow `+"`myworkflow`"+` from default configuration repository at HEAD of master branch
+ * `+"`coconut env create -w github.com/AliceO2Group/MyConfRepo/myworkflow`"+` - loads a workflow from a specific git repository, HEAD of master branch
+ * `+"`coconut env create -w myworkflow@rev`"+` - loads a workflow from default repository, on branch, tag or revision `+"`rev`"+`
+ * `+"`coconut env create -w github.com/AliceO2Group/MyConfRepo/myworkflow@rev`"+` - loads a workflow from a specific git repository, on branch, tag or revision `+"`rev`"+`
 
+For more information on the %s workflow configuration system, see documentation for the `+"`coconut repository`"+` command.`, product.PRETTY_SHORTNAME, product.PRETTY_SHORTNAME),
+	Run: control.WrapCall(control.CreateEnvironment),
 }
 
 func init() {
 	environmentCmd.AddCommand(environmentCreateCmd)
 
+	environmentCreateCmd.Flags().StringP("configuration", "c", "", "high-level configuration payload to be loaded for the new environment")
+	environmentCreateCmd.MarkFlagRequired("configuration")
 	environmentCreateCmd.Flags().StringP("workflow-template", "w", "", "workflow to be loaded in the new environment")
-	environmentCreateCmd.MarkFlagRequired("workflow-template")
 	environmentCreateCmd.Flags().BoolP("auto", "a", false, "create an autorun environment")
 	environmentCreateCmd.Flags().BoolP("public", "p", true, "control public rights of the environment")
 

coconut/control/control.go

@@ -28,6 +28,7 @@ package control
 
 import (
 	"context"
+	"encoding/json"
 	"errors"
 	"fmt"
 	"io"
@@ -67,6 +68,15 @@ type RunFunc func(*cobra.Command, []string)
 
 type ControlCall func(context.Context, *coconut.RpcClient, *cobra.Command, []string, io.Writer) error
 
+type ConfigurationPayload struct {
+	Name       string            `json:"name"`
+	Workflow   string            `json:"workflow"`
+	Revision   string            `json:"revision"`
+	Repository string            `json:"repository"`
+	Vars       map[string]string `json:"variables"`
+	Detectors  []string          `json:"detectors"`
+}
+
 func WrapCall(call ControlCall) RunFunc {
 	return func(cmd *cobra.Command, args []string) {
 		endpoint := viper.GetString("endpoint")
@@ -250,14 +260,49 @@ func GetEnvironments(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Com
 }
 
 func CreateEnvironment(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, o io.Writer) (err error) {
-	wfPath, err := cmd.Flags().GetString("workflow-template")
+	configPayload, err := cmd.Flags().GetString("configuration")
+	if err != nil {
+		err = errors.New("cannot get configuration payload value")
+		return
+	}
+	if len(configPayload) == 0 {
+		err = errors.New("cannot create environment with empty configuration payload")
+		return
+	}
+	configPayloadDoc, err := os.ReadFile(configPayload)
+	if err != nil {
+		err = errors.New("cannot read configuration payload file")
+		return
+	}
+	payloadData := new(ConfigurationPayload)
+	err = json.Unmarshal(configPayloadDoc, &payloadData)
 	if err != nil {
+		err = errors.New("cannot unmarshal configuration payload")
 		return
 	}
-	if len(wfPath) == 0 {
-		err = errors.New("cannot create empty environment")
+
+	var wfPath string
+	userWfPath, err := cmd.Flags().GetString("workflow-template")
+	if err != nil {
 		return
 	}
+	if cmd.Flags().Changed("workflow-template") && len(userWfPath) == 0 {
+		if len(payloadData.Workflow) > 0 {
+			wfPath = payloadData.Workflow
+		} else {
+			err = errors.New("empty workflow template provided")
+			return
+		}
+	} else if cmd.Flags().Changed("workflow-template") && len(userWfPath) > 0 {
+		wfPath = userWfPath
+	} else {
+		if len(payloadData.Workflow) > 0 {
+			wfPath = payloadData.Workflow
+		} else {
+			err = errors.New("no workflow template provided in config file")
+			return
+		}
+	}
 
 	var extraVars string
 	extraVars, err = cmd.Flags().GetString("extra-vars")
@@ -271,11 +316,21 @@ func CreateEnvironment(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.C
 		return
 	}
 
-	extraVarsMap, err := utils.ParseExtraVars(extraVars)
+	userExtraVarsMap, err := utils.ParseExtraVars(extraVars)
 	if err != nil {
 		return
 	}
 
+	extraVarsMap := make(map[string]string, 0)
+	for k, v := range userExtraVarsMap {
+		extraVarsMap[k] = v
+	}
+	for k, v := range payloadData.Vars {
+		if _, exists := extraVarsMap[k]; !exists {
+			extraVarsMap[k] = v
+		}
+	}
+
 	public, _ := cmd.Flags().GetBool("public")
 
 	auto, _ := cmd.Flags().GetBool("auto")