[OCTRL-701] Make the variable names and error messages more readable.

Author: claireguyot

coconut/control/control.go

@@ -263,64 +263,64 @@ 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) {
-	configPayload, err := cmd.Flags().GetString("configuration")
+	configPayloadPath, err := cmd.Flags().GetString("configuration")
 	if err != nil {
-		return fmt.Errorf("cannot get configuration payload value: %w", err)
+		return fmt.Errorf("cannot get configuration payload path value: %w", err)
 	}
 	userWfPath, err := cmd.Flags().GetString("workflow-template")
 	if err != nil {
-		return fmt.Errorf("cannot get workflow template value: %w", err)
+		return fmt.Errorf("cannot get workflow template path value: %w", err)
 	}
-	if cmd.Flags().Changed("configuration") && len(configPayload) == 0 && cmd.Flags().Changed("workflow-template") && len(userWfPath) == 0 {
-		return fmt.Errorf("no configuration payload or workflow template provided: %w", err)
+	if cmd.Flags().Changed("configuration") && len(configPayloadPath) == 0 && cmd.Flags().Changed("workflow-template") && len(userWfPath) == 0 {
+		return fmt.Errorf("no configuration payload path or workflow template path provided: %w", err)
 	}
 
 	payloadData := new(ConfigurationPayload)
 	var wfPath string
-	if cmd.Flags().Changed("configuration") && len(configPayload) > 0 {
-		if strings.HasSuffix(strings.ToLower(configPayload), ".json") {
-			configPayloadDoc, err := os.ReadFile(configPayload)
+	if cmd.Flags().Changed("configuration") && len(configPayloadPath) > 0 {
+		if strings.HasSuffix(strings.ToLower(configPayloadPath), ".json") {
+			configPayloadDoc, err := os.ReadFile(configPayloadPath)
 			if err != nil {
-				return fmt.Errorf("cannot read local configuration payload: %w", err)
+				return fmt.Errorf("cannot read local configuration file %v: %w", configPayloadPath, err)
 			}
 			err = json.Unmarshal(configPayloadDoc, &payloadData)
 			if err != nil {
-				return fmt.Errorf("cannot unmarshal local configuration payload: %w", err)
+				return fmt.Errorf("cannot unmarshal local configuration file %v: %w", configPayloadPath, err)
 			}
 		} else {
-			if strings.HasPrefix(configPayload, HLCONFIG_PATH_PREFIX+HLCONFIG_COMPONENT_PREFIX) {
-				configPayload = strings.TrimPrefix(configPayload, HLCONFIG_PATH_PREFIX+HLCONFIG_COMPONENT_PREFIX)
+			if strings.HasPrefix(configPayloadPath, HLCONFIG_PATH_PREFIX+HLCONFIG_COMPONENT_PREFIX) {
+				configPayloadPath = strings.TrimPrefix(configPayloadPath, HLCONFIG_PATH_PREFIX+HLCONFIG_COMPONENT_PREFIX)
 			}
-			configPayloadDoc, err := apricot.Instance().GetRuntimeEntry(HLCONFIG_COMPONENT_PREFIX, configPayload)
+			configPayloadDoc, err := apricot.Instance().GetRuntimeEntry(HLCONFIG_COMPONENT_PREFIX, configPayloadPath)
 			if err != nil {
-				return fmt.Errorf("cannot retrieve file from "+HLCONFIG_PATH_PREFIX+HLCONFIG_COMPONENT_PREFIX+": %w", err)
+				return fmt.Errorf("cannot retrieve file %v from "+HLCONFIG_PATH_PREFIX+HLCONFIG_COMPONENT_PREFIX+": %w", configPayloadPath, err)
 			}
 			err = json.Unmarshal([]byte(configPayloadDoc), &payloadData)
 			if err != nil {
-				return fmt.Errorf("cannot unmarshal remote configuration payload: %w", err)
+				return fmt.Errorf("cannot unmarshal remote configuration payload %v: %w", configPayloadPath, err)
 			}
 		}
 
 		if cmd.Flags().Changed("workflow-template") && len(userWfPath) == 0 {
 			if len(payloadData.Workflow) > 0 {
 				wfPath = payloadData.Workflow
 			} else {
-				return errors.New("empty workflow template provided")
+				return errors.New("empty workflow template in configuration payload, and empty workflow template path provided")
 			}
 		} else if cmd.Flags().Changed("workflow-template") && len(userWfPath) > 0 {
 			wfPath = userWfPath
 		} else {
 			if len(payloadData.Workflow) > 0 {
 				wfPath = payloadData.Workflow
 			} else {
-				return errors.New("no workflow template provided in config file")
+				return errors.New("no workflow template provided in configuration payload")
 			}
 		}
 	} else {
 		if cmd.Flags().Changed("workflow-template") && len(userWfPath) > 0 {
 			wfPath = userWfPath
 		} else {
-			return errors.New("empty workflow template provided")
+			return errors.New("empty workflow template path provided")
 		}
 	}
 
@@ -345,7 +345,7 @@ func CreateEnvironment(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.C
 	for k, v := range userExtraVarsMap {
 		extraVarsMap[k] = v
 	}
-	if cmd.Flags().Changed("configuration") && len(configPayload) > 0 {
+	if cmd.Flags().Changed("configuration") && len(configPayloadPath) > 0 {
 		for k, v := range payloadData.Vars {
 			if _, exists := extraVarsMap[k]; !exists {
 				extraVarsMap[k] = v