check for attribute and print out all default command and it's import reference if any

Signed-off-by: Stephanie <[email protected]>

Author: yangcao77

pkg/validation/commands.go

@@ -25,7 +25,7 @@ func ValidateCommands(commands []v1alpha2.Command, components []v1alpha2.Compone
 		parentCommands := make(map[string]string)
 		err = validateCommand(command, parentCommands, commandMap, components)
 		if err != nil {
-			return resolveErrorMessageWithImportArrtibutes(err, command.Attributes)
+			return resolveErrorMessageWithImportAttributes(err, command.Attributes)
 		}
 
 		commandGroup := getGroup(command)
@@ -68,11 +68,12 @@ func validateCommand(command v1alpha2.Command, parentCommands map[string]string,
 // 2. with more than one default, err out
 func validateGroup(commands []v1alpha2.Command) error {
 	defaultCommandCount := 0
-
+	var defaultCommands []v1alpha2.Command
 	if len(commands) > 1 {
 		for _, command := range commands {
 			if getGroup(command).IsDefault {
 				defaultCommandCount++
+				defaultCommands = append(defaultCommands, command)
 			}
 		}
 	} else {
@@ -82,7 +83,13 @@ func validateGroup(commands []v1alpha2.Command) error {
 	if defaultCommandCount == 0 {
 		return fmt.Errorf("there should be exactly one default command, currently there is no default command")
 	} else if defaultCommandCount > 1 {
-		return fmt.Errorf("there should be exactly one default command, currently there is more than one default command")
+		var commandsReference string
+		for _, command := range defaultCommands {
+			commandsReference += resolveErrorMessageWithImportAttributes(fmt.Errorf("; command: %s", command.Id), command.Attributes).Error()
+		}
+		// example: there should be exactly one default command, currently there is more than one default command;
+		// command: <id1>; command: <id2>, imported from uri: http://127.0.0.1:8080, in parent overrides from main devfile"
+		return fmt.Errorf("there should be exactly one default command, currently there is more than one default command%s", commandsReference)
 	}
 
 	return nil

pkg/validation/commands_test.go

@@ -332,7 +332,10 @@ func TestValidateGroup(t *testing.T) {
 	component := "alias1"
 
 	noDefaultCmdErr := ".*there should be exactly one default command, currently there is no default command"
-	multipleDefaultCmdErr := ".*there should be exactly one default command, currently there is more than one default command"
+	multipleDefaultError := ".*there should be exactly one default command, currently there is more than one default command"
+	multipleDefaultCmdErr := multipleDefaultError + "; command: run command; command: customcommand"
+	invalidCmdErrWithImportAttributes := multipleDefaultError +
+		"; command: run command; command: customcommand, imported from uri: http://127.0.0.1:8080, in parent overrides from main devfile"
 
 	tests := []struct {
 		name     string
@@ -347,6 +350,30 @@ func TestValidateGroup(t *testing.T) {
 			},
 			wantErr: &multipleDefaultCmdErr,
 		},
+		{
+			name: "Two default run commands with import source attribute",
+			commands: []v1alpha2.Command{
+				generateDummyExecCommand("run command", component, &v1alpha2.CommandGroup{Kind: runGroup, IsDefault: true}),
+				{
+					Attributes: attributes.Attributes{}.PutString(ImportSourceAttribute,
+						"uri: http://127.0.0.1:8080").PutString(ParentOverrideAttribute, "main devfile"),
+					Id: "customcommand",
+					CommandUnion: v1alpha2.CommandUnion{
+						Exec: &v1alpha2.ExecCommand{
+							LabeledCommand: v1alpha2.LabeledCommand{
+								BaseCommand: v1alpha2.BaseCommand{
+									Group: &v1alpha2.CommandGroup{Kind: runGroup, IsDefault: true},
+								},
+							},
+							CommandLine: "command",
+							Component:   component,
+							WorkingDir:  "workDir",
+						},
+					},
+				},
+			},
+			wantErr: &invalidCmdErrWithImportAttributes,
+		},
 		{
 			name: "No default for more than one build commands",
 			commands: []v1alpha2.Command{

pkg/validation/components.go

@@ -54,7 +54,7 @@ func ValidateComponents(components []v1alpha2.Component) error {
 
 			err := validateEndpoints(component.Container.Endpoints, processedEndPointPort, processedEndPointName)
 			if err != nil {
-				return resolveErrorMessageWithImportArrtibutes(err, component.Attributes)
+				return resolveErrorMessageWithImportAttributes(err, component.Attributes)
 			}
 		case component.Volume != nil:
 			processedVolumes[component.Name] = true
@@ -64,37 +64,37 @@ func ValidateComponents(components []v1alpha2.Component) error {
 				// https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 				if _, err := resource.ParseQuantity(component.Volume.Size); err != nil {
 					invalidVolErr := &InvalidVolumeError{name: component.Name, reason: fmt.Sprintf("size %s for volume component is invalid, %v. Example - 2Gi, 1024Mi", component.Volume.Size, err)}
-					return resolveErrorMessageWithImportArrtibutes(invalidVolErr, component.Attributes)
+					return resolveErrorMessageWithImportAttributes(invalidVolErr, component.Attributes)
 				}
 			}
 		case component.Openshift != nil:
 			if component.Openshift.Uri != "" {
 				err := ValidateURI(component.Openshift.Uri)
 				if err != nil {
-					return resolveErrorMessageWithImportArrtibutes(err, component.Attributes)
+					return resolveErrorMessageWithImportAttributes(err, component.Attributes)
 				}
 			}
 
 			err := validateEndpoints(component.Openshift.Endpoints, processedEndPointPort, processedEndPointName)
 			if err != nil {
-				return resolveErrorMessageWithImportArrtibutes(err, component.Attributes)
+				return resolveErrorMessageWithImportAttributes(err, component.Attributes)
 			}
 		case component.Kubernetes != nil:
 			if component.Kubernetes.Uri != "" {
 				err := ValidateURI(component.Kubernetes.Uri)
 				if err != nil {
-					return resolveErrorMessageWithImportArrtibutes(err, component.Attributes)
+					return resolveErrorMessageWithImportAttributes(err, component.Attributes)
 				}
 			}
 			err := validateEndpoints(component.Kubernetes.Endpoints, processedEndPointPort, processedEndPointName)
 			if err != nil {
-				return resolveErrorMessageWithImportArrtibutes(err, component.Attributes)
+				return resolveErrorMessageWithImportAttributes(err, component.Attributes)
 			}
 		case component.Plugin != nil:
 			if component.Plugin.RegistryUrl != "" {
 				err := ValidateURI(component.Plugin.RegistryUrl)
 				if err != nil {
-					return resolveErrorMessageWithImportArrtibutes(err, component.Attributes)
+					return resolveErrorMessageWithImportAttributes(err, component.Attributes)
 				}
 			}
 		}
@@ -107,7 +107,7 @@ func ValidateComponents(components []v1alpha2.Component) error {
 		for _, volumeMountName := range volumeMountNames {
 			if !processedVolumes[volumeMountName] {
 				missingVolumeMountErr := fmt.Errorf("\nvolume mount %s belonging to the container component %s", volumeMountName, componentName)
-				newErr := resolveErrorMessageWithImportArrtibutes(missingVolumeMountErr, processedComponentWithVolumeMounts[componentName].Attributes)
+				newErr := resolveErrorMessageWithImportAttributes(missingVolumeMountErr, processedComponentWithVolumeMounts[componentName].Attributes)
 				invalidVolumeMountsErr += newErr.Error()
 			}
 		}

pkg/validation/errors.go

@@ -90,11 +90,11 @@ func (e *InvalidComponentError) Error() string {
 	return fmt.Sprintf("the component %q is invalid - %s", e.componentName, e.reason)
 }
 
-// resolveErrorMessageWithImportArrtibutes returns an updated error message
+// resolveErrorMessageWithImportAttributes returns an updated error message
 // with detailed information on the imported and overriden resource.
 // example:
 // "the component <compName> is invalid - <reason>, imported from Uri: http://example.com/devfile.yaml, in parent overrides from main devfile"
-func resolveErrorMessageWithImportArrtibutes(validationErr error, attributes attributesAPI.Attributes) error {
+func resolveErrorMessageWithImportAttributes(validationErr error, attributes attributesAPI.Attributes) error {
 	var findKeyErr error
 	importReference := attributes.Get(ImportSourceAttribute, &findKeyErr)
 

pkg/validation/projects.go

@@ -24,19 +24,19 @@ func ValidateStarterProjects(starterProjects []v1alpha2.StarterProject) error {
 		switch len(gitSource.Remotes) {
 		case 0:
 			starterProjectErr := fmt.Errorf("\nstarterProject %s should have at least one remote", starterProject.Name)
-			newErr := resolveErrorMessageWithImportArrtibutes(starterProjectErr, starterProject.Attributes)
+			newErr := resolveErrorMessageWithImportAttributes(starterProjectErr, starterProject.Attributes)
 			errString += newErr.Error()
 		case 1:
 			if gitSource.CheckoutFrom != nil && gitSource.CheckoutFrom.Remote != "" {
 				err := validateRemoteMap(gitSource.Remotes, gitSource.CheckoutFrom.Remote, starterProject.Name)
 				if err != nil {
-					newErr := resolveErrorMessageWithImportArrtibutes(err, starterProject.Attributes)
+					newErr := resolveErrorMessageWithImportAttributes(err, starterProject.Attributes)
 					errString += fmt.Sprintf("\n%s", newErr.Error())
 				}
 			}
 		default: // len(gitSource.Remotes) >= 2
 			starterProjectErr := fmt.Errorf("\nstarterProject %s should have one remote only", starterProject.Name)
-			newErr := resolveErrorMessageWithImportArrtibutes(starterProjectErr, starterProject.Attributes)
+			newErr := resolveErrorMessageWithImportAttributes(starterProjectErr, starterProject.Attributes)
 			errString += newErr.Error()
 		}
 	}
@@ -67,24 +67,24 @@ func ValidateProjects(projects []v1alpha2.Project) error {
 		switch len(gitSource.Remotes) {
 		case 0:
 			projectErr := fmt.Errorf("\nprojects %s should have at least one remote", project.Name)
-			newErr := resolveErrorMessageWithImportArrtibutes(projectErr, project.Attributes)
+			newErr := resolveErrorMessageWithImportAttributes(projectErr, project.Attributes)
 			errString += newErr.Error()
 		case 1:
 			if gitSource.CheckoutFrom != nil && gitSource.CheckoutFrom.Remote != "" {
 				if err := validateRemoteMap(gitSource.Remotes, gitSource.CheckoutFrom.Remote, project.Name); err != nil {
-					newErr := resolveErrorMessageWithImportArrtibutes(err, project.Attributes)
+					newErr := resolveErrorMessageWithImportAttributes(err, project.Attributes)
 					errString += fmt.Sprintf("\n%s", newErr.Error())
 				}
 			}
 		default: // len(gitSource.Remotes) >= 2
 			if gitSource.CheckoutFrom == nil || gitSource.CheckoutFrom.Remote == "" {
 				projectErr := fmt.Errorf("\nproject %s has more than one remote defined, but has no checkoutfrom remote defined", project.Name)
-				newErr := resolveErrorMessageWithImportArrtibutes(projectErr, project.Attributes)
+				newErr := resolveErrorMessageWithImportAttributes(projectErr, project.Attributes)
 				errString += newErr.Error()
 				continue
 			}
 			if err := validateRemoteMap(gitSource.Remotes, gitSource.CheckoutFrom.Remote, project.Name); err != nil {
-				newErr := resolveErrorMessageWithImportArrtibutes(err, project.Attributes)
+				newErr := resolveErrorMessageWithImportAttributes(err, project.Attributes)
 				errString += fmt.Sprintf("\n%s", newErr.Error())
 			}
 		}