Merge pull request #327 from silvin-lubecki/validate-multi-errors

Validate command now returns every errors it can find

Author: Vincent Demeester

internal/validator/validate.go

@@ -6,6 +6,7 @@ import (
 	"io/ioutil"
 	"os"
 	"path/filepath"
+	"strings"
 
 	"github.com/docker/app/internal"
 	"github.com/docker/app/internal/render"
@@ -15,29 +16,31 @@ import (
 
 // Validate checks an application definition meets the specifications (metadata and rendered compose file)
 func Validate(appname string, settingsFiles []string, env map[string]string) error {
+	var errs []string
 	if err := checkExistingFiles(appname); err != nil {
-		return err
+		errs = append(errs, err.Error())
 	}
 	if err := validateMetadata(appname); err != nil {
-		return err
+		errs = append(errs, err.Error())
 	}
 	if _, err := render.Render(appname, nil, settingsFiles, env); err != nil {
-		return err
+		errs = append(errs, err.Error())
 	}
-	return nil
+	return concatenateErrors(errs)
 }
 
 func checkExistingFiles(appname string) error {
+	var errs []string
 	if _, err := os.Stat(filepath.Join(appname, internal.SettingsFileName)); err != nil {
-		return errors.New("failed to read application settings")
+		errs = append(errs, "failed to read application settings")
 	}
 	if _, err := os.Stat(filepath.Join(appname, internal.MetadataFileName)); err != nil {
-		return errors.New("failed to read application metadata")
+		errs = append(errs, "failed to read application metadata")
 	}
 	if _, err := os.Stat(filepath.Join(appname, internal.ComposeFileName)); err != nil {
-		return errors.New("failed to read application compose")
+		errs = append(errs, "failed to read application compose")
 	}
-	return nil
+	return concatenateErrors(errs)
 }
 
 func validateMetadata(appname string) error {
@@ -54,3 +57,10 @@ func validateMetadata(appname string) error {
 	}
 	return nil
 }
+
+func concatenateErrors(errs []string) error {
+	if len(errs) > 0 {
+		return errors.New(strings.Join(errs, "\n"))
+	}
+	return nil
+}

internal/validator/validate_test.go

@@ -11,15 +11,13 @@ import (
 
 func TestValidateMissingFileApplication(t *testing.T) {
 	dir := fs.NewDir(t, t.Name(),
-		fs.WithDir("no-settings-app", fs.WithFile(internal.MetadataFileName, ""), fs.WithFile(internal.ComposeFileName, "")),
-		fs.WithDir("no-metadata-app", fs.WithFile(internal.SettingsFileName, ""), fs.WithFile(internal.ComposeFileName, "")),
-		fs.WithDir("no-compose-app", fs.WithFile(internal.MetadataFileName, ""), fs.WithFile(internal.SettingsFileName, "")),
+		fs.WithDir("bad-app"),
 	)
 	defer dir.Remove()
-
-	assert.ErrorContains(t, Validate(dir.Join("no-settings-app"), nil, nil), "failed to read application settings")
-	assert.ErrorContains(t, Validate(dir.Join("no-metadata-app"), nil, nil), "failed to read application metadata")
-	assert.ErrorContains(t, Validate(dir.Join("no-compose-app"), nil, nil), "failed to read application compose")
+	errs := Validate(dir.Join("bad-app"), nil, nil)
+	assert.ErrorContains(t, errs, "failed to read application settings")
+	assert.ErrorContains(t, errs, "failed to read application metadata")
+	assert.ErrorContains(t, errs, "failed to read application compose")
 }
 
 func TestValidateBrokenMetadata(t *testing.T) {
@@ -33,9 +31,10 @@ maintainers:
     - name: bad-user
       email: bad-email
 unknown: property`
+	composeFile := `version: "3.6"`
 	dir := fs.NewDir(t, t.Name(),
 		fs.WithFile(internal.MetadataFileName, brokenMetadata),
-		fs.WithFile(internal.ComposeFileName, ""),
+		fs.WithFile(internal.ComposeFileName, composeFile),
 		fs.WithFile(internal.SettingsFileName, ""))
 	defer dir.Remove()
 	err := Validate(dir.Path(), nil, nil)