Add Support for Devfile V2 (#3216)

* Add Devfile Parser V2, Update Common Structs (#3188) * Add Devfile Parser for Version 2.0.0 Added Devfile V2 Go Structures Added converter for v2 ro common types Signed-off-by: adisky <adsharma@redhat.com> * Add example V2 devfile added example nodejs V2 devfile * Add Common Types as V2 Add common types as v2 Add Converter from common to v1 * Updated example devfile with group * Fixes command.go and kubernetes adapter (#3194) Signed-off-by: mik-dass <mrinald7@gmail.com> * Fixes utils of k8s adapter (#3195) * Update Command Logic to use groups (#3196) * Updates create logic to v2 (#3200) * Fixes utils of docker docker adapter (#3198) Signed-off-by: mik-dass <mrinald7@gmail.com> * Update Docker and Kubernetes adapter to use groups (#3206) * Update Docker and Kubernetes adapter to use groups * Update Some Validation Incorporate some review comments for commands Map Update Some Validation logic * Updated Logs for V2 (#3208) Fixed interface implementation for v2 Updated logs refactored commands.go * Avoid String Pointers (#3209) While converting v1 to v2 types, string pointers are prone to cause null pointer error. This PR updates struct fields from string pointers to string * Update commands check * Fixes lower and upper case for commands (#3219) * Fixes type of project and components for devfile v1 (#3228) * Update testing utils (#3220) * Update command tests Updated Command tests to v2 Removed some cases like command type validation, that will be validated by schema only. * Fix common adapters tests All devfile.adapters.common unit tests are fixed * Add tests for Mismatched type Fix devfile.adapters.Kubernetes.Component unit tests * Add TestCase for default command * Design proposal: Event notification support for build and application status for IDE integration for devfile scenarios (#2550) (#3177) * Add event notification proposal [skip ci] * Update event-notification.md * Update event-notification.md * Update event-notification.md * Update event-notification.md * Update event-notification.md * Update event-notification.md * Update event-notification.md * Update event-notification.md * Fix Integration tests for devfile v2 (#3236) * Fix Integration tests Correct volume structure Fix supervisord binary insertion for docker Insert command and args in build container fr docker * Fix Integration tests Revert commands, args removal Add commands, args in v2 common structs Fix duplicate volume error * Fixes unit tests (#3240) Signed-off-by: mik-dass <mrinald7@gmail.com> * Add devfiles V2 examples (#3253) Add devfiles v2 examples for springboot and nodejs * Fix regression by sparse checkout dir PR (#3258) fix regression caused by rebase to master. Also add github, zip as supported project types. * Address review comments (#3267) * Address review comments part 2 fix log levels to v4 fix error formatting add case no's in test cases update some comments * Address review comments part 2 Remove validation for group Co-authored-by: Mrinal Das <mrinald7@gmail.com> Co-authored-by: Jonathan West <jgwest@users.noreply.github.com>
redhat-developer · Jun 2, 2020 · 5f71123 · 5f71123
1 parent 1f70c1b
commit 5f71123
Show file tree

Hide file tree

Showing 47 changed files with 3,961 additions and 1,609 deletions.
diff --git a/docs/proposals/event-notification.md b/docs/proposals/event-notification.md
diff --git a/pkg/devfile/adapters/common/command.go b/pkg/devfile/adapters/common/command.go
@@ -7,140 +7,145 @@ import (
 	"github.com/openshift/odo/pkg/devfile/parser/data"
 	"github.com/openshift/odo/pkg/devfile/parser/data/common"
 	"k8s.io/klog"
-
-	"github.com/pkg/errors"
 )
 
 // GetCommand iterates through the devfile commands and returns the associated devfile command
-func getCommand(data data.DevfileData, commandName string, required bool) (supportedCommand common.DevfileCommand, err error) {
-	for _, command := range data.GetCommands() {
-		if command.Name == commandName {
-
-			// Get the supported actions
-			supportedCommandActions, err := getSupportedCommandActions(data, command)
-
-			// None of the actions are supported so the command cannot be run
-			if len(supportedCommandActions) == 0 {
-				return supportedCommand, errors.Wrapf(err, "\nThe command \"%v\" was found but its actions are not supported", commandName)
-			} else if err != nil {
-				klog.Warning(errors.Wrapf(err, "The command \"%v\" was found but some of its actions are not supported", commandName))
+func getCommand(data data.DevfileData, commandName string, groupType common.DevfileCommandGroupType) (supportedCommand common.DevfileCommand, err error) {
+
+	commands := data.GetCommands()
+
+	for _, command := range commands {
+
+		// validate command
+		err = validateCommand(data, command)
+
+		if err != nil {
+			return common.DevfileCommand{}, err
+		}
+
+		// if command is specified via flags, it has the highest priority
+		// search through all commands to find the specified command name
+		// if not found fallback to error.
+		if commandName != "" {
+
+			// Update Group only custom commands (specified by odo flags)
+			command = updateGroupforCommand(groupType, command)
+
+			if command.Exec.Id == commandName {
+
+				// we have found the command with name, its groupType Should match to the flag
+				// e.g --build-command "mybuild"
+				// exec:
+				//   id: mybuild
+				//   group:
+				//     kind: build
+				if command.Exec.Group.Kind != groupType {
+					return supportedCommand, fmt.Errorf("command group mismatched, command %s is of group %v in devfile.yaml", commandName, command.Exec.Group.Kind)
+				}
+				supportedCommand = command
+				return supportedCommand, nil
 			}
+			continue
+		}
 
-			// The command is supported, use it
-			supportedCommand.Name = command.Name
-			supportedCommand.Actions = supportedCommandActions
-			supportedCommand.Attributes = command.Attributes
+		// if no command specified via flag, default command has the highest priority
+		// We need to scan all the commands to find default command
+		// exec.Group is a pointer, to avoid null pointer
+		if command.Exec.Group != nil && command.Exec.Group.Kind == groupType && command.Exec.Group.IsDefault {
+			supportedCommand = command
 			return supportedCommand, nil
 		}
 	}
 
-	// The command was not found
-	msg := fmt.Sprintf("The command \"%v\" was not found in the devfile", commandName)
-	if required {
-		// Not found and required, return an error
-		err = fmt.Errorf(msg)
-	} else {
-		// Not found and optional, so just log it
-		klog.V(3).Info(msg)
-	}
+	if commandName == "" {
+		// if default command is not found return the first command found for the matching type.
+		for _, command := range commands {
 
-	return
-}
-
-// getSupportedCommandActions returns the supported actions for a given command and any errors
-// If some actions are supported and others have errors both the supported actions and an aggregated error will be returned.
-func getSupportedCommandActions(data data.DevfileData, command common.DevfileCommand) (supportedCommandActions []common.DevfileCommandAction, err error) {
-	klog.V(3).Infof("Validating actions for command: %v ", command.Name)
-
-	problemMsg := ""
-	for i, action := range command.Actions {
-		// Check if the command action is of type exec
-		err := validateAction(data, action)
-		if err == nil {
-			klog.V(3).Infof("Action %d maps to component %v", i+1, *action.Component)
-			supportedCommandActions = append(supportedCommandActions, action)
-		} else {
-			problemMsg += fmt.Sprintf("Problem with command \"%v\" action #%d: %v", command.Name, i+1, err)
+			if command.Exec.Group != nil && command.Exec.Group.Kind == groupType {
+				supportedCommand = command
+				return supportedCommand, nil
+			}
 		}
 	}
 
-	if len(problemMsg) > 0 {
-		err = fmt.Errorf(problemMsg)
+	// if any command specified via flag is not found in devfile then it is an error.
+	if commandName != "" {
+		err = fmt.Errorf("the command \"%v\" is not found in the devfile", commandName)
+	} else {
+		msg := fmt.Sprintf("the command type \"%v\" is not found in the devfile", groupType)
+		// if run command is not found in devfile then it is an error
+		if groupType == common.RunCommandGroupType {
+			err = fmt.Errorf(msg)
+		} else {
+			klog.V(4).Info(msg)
+		}
 	}
 
 	return
 }
 
-// validateAction validates the given action
-// 1. action has to be of type exec
+// validateCommand validates the given command
+// 1. command has to be of type exec
 // 2. component should be present
-// 3. command should be present
-func validateAction(data data.DevfileData, action common.DevfileCommandAction) (err error) {
+// 4. command must have group
+func validateCommand(data data.DevfileData, command common.DevfileCommand) (err error) {
 
 	// type must be exec
-	if *action.Type != common.DevfileCommandTypeExec {
-		return fmt.Errorf("Actions must be of type \"exec\"")
+	if command.Exec == nil {
+		return fmt.Errorf("command must be of type \"exec\"")
 	}
 
 	// component must be specified
-	if action.Component == nil || *action.Component == "" {
-		return fmt.Errorf("Actions must reference a component")
+	if command.Exec.Component == "" {
+		return fmt.Errorf("exec commands must reference a component")
 	}
 
 	// must specify a command
-	if action.Command == nil || *action.Command == "" {
-		return fmt.Errorf("Actions must have a command")
+	if command.Exec.CommandLine == "" {
+		return fmt.Errorf("exec commands must have a command")
 	}
 
 	// must map to a supported component
 	components := GetSupportedComponents(data)
 
-	isActionValid := false
+	isComponentValid := false
 	for _, component := range components {
-		if *action.Component == *component.Alias && isComponentSupported(component) {
-			isActionValid = true
+		if command.Exec.Component == component.Container.Name {
+			isComponentValid = true
 		}
 	}
-	if !isActionValid {
-		return fmt.Errorf("The action does not map to a supported component")
+	if !isComponentValid {
+		return fmt.Errorf("the command does not map to a supported component")
 	}
 
 	return
 }
 
 // GetInitCommand iterates through the components in the devfile and returns the init command
 func GetInitCommand(data data.DevfileData, devfileInitCmd string) (initCommand common.DevfileCommand, err error) {
-	if devfileInitCmd != "" {
-		// a init command was specified so if it is not found then it is an error
-		return getCommand(data, devfileInitCmd, true)
-	}
-	// a init command was not specified so if it is not found then it is not an error
-	return getCommand(data, string(DefaultDevfileInitCommand), false)
+
+	return getCommand(data, devfileInitCmd, common.InitCommandGroupType)
 }
 
 // GetBuildCommand iterates through the components in the devfile and returns the build command
 func GetBuildCommand(data data.DevfileData, devfileBuildCmd string) (buildCommand common.DevfileCommand, err error) {
-	if devfileBuildCmd != "" {
-		// a build command was specified so if it is not found then it is an error
-		return getCommand(data, devfileBuildCmd, true)
-	}
-	// a build command was not specified so if it is not found then it is not an error
-	return getCommand(data, string(DefaultDevfileBuildCommand), false)
+
+	return getCommand(data, devfileBuildCmd, common.BuildCommandGroupType)
 }
 
 // GetRunCommand iterates through the components in the devfile and returns the run command
 func GetRunCommand(data data.DevfileData, devfileRunCmd string) (runCommand common.DevfileCommand, err error) {
-	if devfileRunCmd != "" {
-		return getCommand(data, devfileRunCmd, true)
-	}
-	return getCommand(data, string(DefaultDevfileRunCommand), true)
+
+	return getCommand(data, devfileRunCmd, common.RunCommandGroupType)
 }
 
 // ValidateAndGetPushDevfileCommands validates the build and the run command,
 // if provided through odo push or else checks the devfile for devBuild and devRun.
 // It returns the build and run commands if its validated successfully, error otherwise.
-func ValidateAndGetPushDevfileCommands(data data.DevfileData, devfileInitCmd, devfileBuildCmd, devfileRunCmd string) (pushDevfileCommands []common.DevfileCommand, err error) {
+func ValidateAndGetPushDevfileCommands(data data.DevfileData, devfileInitCmd, devfileBuildCmd, devfileRunCmd string) (commandMap PushCommandsMap, err error) {
 	var emptyCommand common.DevfileCommand
+	commandMap = NewPushCommandMap()
+
 	isInitCommandValid, isBuildCommandValid, isRunCommandValid := false, false, false
 
 	initCommand, initCmdErr := GetInitCommand(data, devfileInitCmd)
@@ -149,11 +154,11 @@ func ValidateAndGetPushDevfileCommands(data data.DevfileData, devfileInitCmd, de
 	if isInitCmdEmpty && initCmdErr == nil {
 		// If there was no init command specified through odo push and no default init command in the devfile, default validate to true since the init command is optional
 		isInitCommandValid = true
-		klog.V(3).Infof("No init command was provided")
+		klog.V(4).Infof("No init command was provided")
 	} else if !isInitCmdEmpty && initCmdErr == nil {
 		isInitCommandValid = true
-		pushDevfileCommands = append(pushDevfileCommands, initCommand)
-		klog.V(3).Infof("Init command: %v", initCommand.Name)
+		commandMap[common.InitCommandGroupType] = initCommand
+		klog.V(4).Infof("Init command: %v", initCommand.Exec.Id)
 	}
 
 	buildCommand, buildCmdErr := GetBuildCommand(data, devfileBuildCmd)
@@ -162,18 +167,18 @@ func ValidateAndGetPushDevfileCommands(data data.DevfileData, devfileInitCmd, de
 	if isBuildCmdEmpty && buildCmdErr == nil {
 		// If there was no build command specified through odo push and no default build command in the devfile, default validate to true since the build command is optional
 		isBuildCommandValid = true
-		klog.V(3).Infof("No build command was provided")
+		klog.V(4).Infof("No build command was provided")
 	} else if !reflect.DeepEqual(emptyCommand, buildCommand) && buildCmdErr == nil {
 		isBuildCommandValid = true
-		pushDevfileCommands = append(pushDevfileCommands, buildCommand)
-		klog.V(3).Infof("Build command: %v", buildCommand.Name)
+		commandMap[common.BuildCommandGroupType] = buildCommand
+		klog.V(4).Infof("Build command: %v", buildCommand.Exec.Id)
 	}
 
 	runCommand, runCmdErr := GetRunCommand(data, devfileRunCmd)
 	if runCmdErr == nil && !reflect.DeepEqual(emptyCommand, runCommand) {
-		pushDevfileCommands = append(pushDevfileCommands, runCommand)
 		isRunCommandValid = true
-		klog.V(3).Infof("Run command: %v", runCommand.Name)
+		commandMap[common.RunCommandGroupType] = runCommand
+		klog.V(4).Infof("Run command: %v", runCommand.Exec.Id)
 	}
 
 	// If either command had a problem, return an empty list of commands and an error
@@ -188,8 +193,19 @@ func ValidateAndGetPushDevfileCommands(data data.DevfileData, devfileInitCmd, de
 		if runCmdErr != nil {
 			commandErrors += fmt.Sprintf(runCmdErr.Error(), "\n")
 		}
-		return []common.DevfileCommand{}, fmt.Errorf(commandErrors)
+		return commandMap, fmt.Errorf(commandErrors)
 	}
 
-	return pushDevfileCommands, nil
+	return commandMap, nil
+}
+
+// Need to update group on custom commands specified by odo flags
+func updateGroupforCommand(groupType common.DevfileCommandGroupType, command common.DevfileCommand) common.DevfileCommand {
+	// Update Group only for exec commands
+	// Update Group only when Group is not nil, devfile v2 might contain group for custom commands.
+	if command.Exec != nil && command.Exec.Group == nil {
+		command.Exec.Group = &common.Group{Kind: groupType}
+		return command
+	}
+	return command
 }