service>deploy: return all env validation errors & add tests

service-test/env/Dockerfile

@@ -0,0 +1 @@
+FROM node

service-test/env/mesg.yml

@@ -0,0 +1,15 @@
+name: Task
+configuration:
+  env:
+    - A=1
+    - B=2
+tasks:
+  foo:
+    inputs:
+      bar:
+        type: String
+    outputs:
+      bar:
+        data:
+          baz:
+            type: Object

service/service.go

@@ -5,6 +5,7 @@ import (
 	"io"
 	"io/ioutil"
 	"os"
+	"sort"
 	"strings"
 	"time"
 
@@ -253,18 +254,33 @@ func (s *Service) getDependency(dependencyKey string) (*Dependency, error) {
 
 // validateConfigurationEnv checks presence of env variables in mesg.yml under env section.
 func (s *Service) validateConfigurationEnv(env map[string]string) error {
+	var nonDefined []string
 	for key := range env {
-		exist := false
-		// check if "key=" exists in configuration
+		// check if "key=" exists in configuration.
+		exists := false
 		for _, env := range s.configuration.Env {
 			if strings.HasPrefix(env, key+"=") {
-				exist = true
-				break
+				exists = true
 			}
 		}
-		if !exist {
-			return fmt.Errorf("service environment variable %q dosen't exist in mesg.yml (under configuration.env key)", key)
+		if !exists {
+			nonDefined = append(nonDefined, key)
 		}
 	}
+	if len(nonDefined) > 0 {
+		sort.Strings(nonDefined)
+		return ErrNotDefinedEnv{nonDefined}
+	}
 	return nil
 }
+
+// ErrNotDefinedEnv error returned when optionally given env variables
+// are not defined in the mesg.yml file.
+type ErrNotDefinedEnv struct {
+	env []string
+}
+
+func (e ErrNotDefinedEnv) Error() string {
+	return fmt.Sprintf("environment variable(s) %q not defined in mesg.yml (under configuration.env key)",
+		strings.Join(e.env, ", "))
+}

service/service_test.go

@@ -6,6 +6,7 @@ import (
 	"github.com/mesg-foundation/core/container/mocks"
 	"github.com/mesg-foundation/core/service/importer"
 	"github.com/mesg-foundation/core/x/xdocker/xarchive"
+	"github.com/mesg-foundation/core/x/xos"
 	"github.com/stretchr/testify/mock"
 	"github.com/stretchr/testify/require"
 )
@@ -58,6 +59,7 @@ func TestNew(t *testing.T) {
 	require.NoError(t, err)
 	require.Equal(t, "service", s.Dependencies[0].Key)
 	require.Equal(t, hash, s.Dependencies[0].Image)
+	require.Len(t, s.Dependencies[0].Env, 0)
 
 	require.Equal(t, DeployStatus{
 		Message: "Receiving service context...",
@@ -82,6 +84,77 @@ func TestNew(t *testing.T) {
 	mc.AssertExpectations(t)
 }
 
+func TestNewWithDefaultEnv(t *testing.T) {
+	var (
+		path = "../service-test/env"
+		hash = "1"
+		env  = []string{"A=1", "B=2"}
+	)
+
+	mc := &mocks.Container{}
+	mc.On("Build", mock.Anything).Once().Return(hash, nil)
+
+	archive, err := xarchive.GzippedTar(path)
+	require.NoError(t, err)
+
+	s, err := New(archive, nil,
+		ContainerOption(mc),
+	)
+	require.NoError(t, err)
+	require.Equal(t, "service", s.Dependencies[0].Key)
+	require.Equal(t, hash, s.Dependencies[0].Image)
+	require.Equal(t, env, s.Dependencies[0].Env)
+
+	mc.AssertExpectations(t)
+}
+
+func TestNewWithOverwrittenEnv(t *testing.T) {
+	var (
+		path = "../service-test/env"
+		hash = "1"
+		env  = []string{"A=3", "B=4"}
+	)
+
+	mc := &mocks.Container{}
+	mc.On("Build", mock.Anything).Once().Return(hash, nil)
+
+	archive, err := xarchive.GzippedTar(path)
+	require.NoError(t, err)
+
+	s, err := New(archive, xos.EnvSliceToMap(env),
+		ContainerOption(mc),
+	)
+	require.NoError(t, err)
+	require.Equal(t, "service", s.Dependencies[0].Key)
+	require.Equal(t, hash, s.Dependencies[0].Image)
+	require.Equal(t, env, s.Dependencies[0].Env)
+
+	mc.AssertExpectations(t)
+}
+
+func TestNewWitNotDefinedEnv(t *testing.T) {
+	var (
+		path = "../service-test/task"
+	)
+
+	mc := &mocks.Container{}
+
+	archive, err := xarchive.GzippedTar(path)
+	require.NoError(t, err)
+
+	_, err = New(archive, xos.EnvSliceToMap([]string{"A=1", "B=2"}),
+		ContainerOption(mc),
+	)
+	require.Equal(t, ErrNotDefinedEnv{[]string{"A", "B"}}, err)
+
+	mc.AssertExpectations(t)
+}
+
+func TestErrNotDefinedEnv(t *testing.T) {
+	require.Equal(t, ErrNotDefinedEnv{[]string{"A", "B"}}.Error(),
+		`environment variable(s) "A, B" not defined in mesg.yml (under configuration.env key)`)
+}
+
 func TestInjectDefinitionWithConfig(t *testing.T) {
 	command := "xxx"
 	s := &Service{}