Merge pull request #641 from mesg-foundation/feature/passing-env

Configure services with envs

api/deploy.go

@@ -25,25 +25,27 @@ func DeployServiceStatusOption(statuses chan DeployStatus) DeployServiceOption {
 }
 
 // DeployService deploys a service from a gzipped tarball.
-func (a *API) DeployService(r io.Reader, options ...DeployServiceOption) (*service.Service,
+func (a *API) DeployService(r io.Reader, env map[string]string, options ...DeployServiceOption) (*service.Service,
 	*importer.ValidationError, error) {
-	return newServiceDeployer(a, options...).FromGzippedTar(r)
+	return newServiceDeployer(a, env, options...).FromGzippedTar(r)
 }
 
 // DeployServiceFromURL deploys a service living at a Git host.
 // Supported URL types:
 // - https://github.com/mesg-foundation/service-ethereum
 // - https://github.com/mesg-foundation/service-ethereum#branchName
-func (a *API) DeployServiceFromURL(url string, options ...DeployServiceOption) (*service.Service,
+func (a *API) DeployServiceFromURL(url string, env map[string]string, options ...DeployServiceOption) (*service.Service,
 	*importer.ValidationError, error) {
-	return newServiceDeployer(a, options...).FromGitURL(url)
+	return newServiceDeployer(a, env, options...).FromGitURL(url)
 }
 
 // serviceDeployer provides functionalities to deploy a MESG service.
 type serviceDeployer struct {
 	// statuses receives status messages produced during deployment.
 	statuses chan DeployStatus
 
+	env map[string]string
+
 	api *API
 }
 
@@ -70,9 +72,10 @@ type DeployStatus struct {
 }
 
 // newServiceDeployer creates a new serviceDeployer with given api and options.
-func newServiceDeployer(api *API, options ...DeployServiceOption) *serviceDeployer {
+func newServiceDeployer(api *API, env map[string]string, options ...DeployServiceOption) *serviceDeployer {
 	d := &serviceDeployer{
 		api: api,
+		env: env,
 	}
 	for _, option := range options {
 		option(d)
@@ -126,7 +129,7 @@ func (d *serviceDeployer) deploy(r io.Reader) (*service.Service, *importer.Valid
 		d.forwardDeployStatuses(statuses)
 	}()
 
-	s, err := service.New(r,
+	s, err := service.New(r, d.env,
 		service.ContainerOption(d.api.container),
 		service.DeployStatusOption(statuses),
 	)

api/deploy_test.go

@@ -30,7 +30,7 @@ func TestDeployService(t *testing.T) {
 		archive, err := xarchive.GzippedTar(path)
 		require.NoError(t, err)
 
-		service, validationError, err := a.DeployService(archive, DeployServiceStatusOption(statuses))
+		service, validationError, err := a.DeployService(archive, nil, DeployServiceStatusOption(statuses))
 		require.Nil(t, validationError)
 		require.NoError(t, err)
 		require.Len(t, service.Hash, 40)
@@ -76,7 +76,7 @@ func TestDeployInvalidService(t *testing.T) {
 		archive, err := xarchive.GzippedTar(path)
 		require.NoError(t, err)
 
-		service, validationError, err := a.DeployService(archive, DeployServiceStatusOption(statuses))
+		service, validationError, err := a.DeployService(archive, nil, DeployServiceStatusOption(statuses))
 		require.Nil(t, service)
 		require.NoError(t, err)
 		require.Equal(t, (&importer.ValidationError{}).Error(), validationError.Error())
@@ -114,7 +114,7 @@ func TestDeployServiceFromURL(t *testing.T) {
 	wg.Add(1)
 	go func() {
 		defer wg.Done()
-		service, validationError, err := a.DeployServiceFromURL(url, DeployServiceStatusOption(statuses))
+		service, validationError, err := a.DeployServiceFromURL(url, nil, DeployServiceStatusOption(statuses))
 		require.Nil(t, validationError)
 		require.NoError(t, err)
 		require.Len(t, service.Hash, 40)
@@ -156,7 +156,7 @@ func TestDeployServiceFromURL(t *testing.T) {
 func TestCreateTempFolder(t *testing.T) {
 	a, _, closer := newAPIAndDockerTest(t)
 	defer closer()
-	deployer := newServiceDeployer(a)
+	deployer := newServiceDeployer(a, nil)
 
 	path, err := deployer.createTempDir()
 	defer os.RemoveAll(path)
@@ -167,7 +167,7 @@ func TestCreateTempFolder(t *testing.T) {
 func TestRemoveTempFolder(t *testing.T) {
 	a, _, closer := newAPIAndDockerTest(t)
 	defer closer()
-	deployer := newServiceDeployer(a)
+	deployer := newServiceDeployer(a, nil)
 
 	path, _ := deployer.createTempDir()
 	err := os.RemoveAll(path)

commands/commands.go

@@ -24,7 +24,7 @@ type ServiceExecutor interface {
 	ServiceByID(id string) (*coreapi.Service, error)
 	ServiceDeleteAll(deleteData bool) error
 	ServiceDelete(deleteData bool, ids ...string) error
-	ServiceDeploy(path string, statuses chan provider.DeployStatus) (id string, validationError, err error)
+	ServiceDeploy(path string, env map[string]string, statuses chan provider.DeployStatus) (id string, validationError, err error)
 	ServiceListenEvents(id, eventFilter string) (chan *coreapi.EventData, chan error, error)
 	ServiceListenResults(id, taskFilter, outputFilter string, tagFilters []string) (chan *coreapi.ResultData, chan error, error)
 	ServiceLogs(id string, dependencies ...string) (logs []*provider.Log, closer func(), err error)

commands/provider/service_deployer.go

@@ -40,7 +40,7 @@ type deploymentResult struct {
 }
 
 // ServiceDeploy deploys service from given path.
-func (p *ServiceProvider) ServiceDeploy(path string, statuses chan DeployStatus) (id string,
+func (p *ServiceProvider) ServiceDeploy(path string, env map[string]string, statuses chan DeployStatus) (id string,
 	validationError, err error) {
 	stream, err := p.client.DeployService(context.Background())
 	if err != nil {
@@ -53,11 +53,12 @@ func (p *ServiceProvider) ServiceDeploy(path string, statuses chan DeployStatus)
 	if govalidator.IsURL(path) {
 		if err := stream.Send(&coreapi.DeployServiceRequest{
 			Value: &coreapi.DeployServiceRequest_Url{Url: path},
+			Env:   env,
 		}); err != nil {
 			return "", nil, err
 		}
 	} else {
-		if err := deployServiceSendServiceContext(path, stream); err != nil {
+		if err := deployServiceSendServiceContext(path, env, stream); err != nil {
 			return "", nil, err
 		}
 	}
@@ -71,14 +72,20 @@ func (p *ServiceProvider) ServiceDeploy(path string, statuses chan DeployStatus)
 	return result.serviceID, result.validationError, result.err
 }
 
-func deployServiceSendServiceContext(path string, stream coreapi.Core_DeployServiceClient) error {
+func deployServiceSendServiceContext(path string, env map[string]string, stream coreapi.Core_DeployServiceClient) error {
 	archive, err := archive.TarWithOptions(path, &archive.TarOptions{
 		Compression: archive.Gzip,
 	})
 	if err != nil {
 		return err
 	}
 
+	if len(env) > 0 {
+		if err := stream.Send(&coreapi.DeployServiceRequest{Env: env}); err != nil {
+			return err
+		}
+	}
+
 	buf := make([]byte, 1024)
 	for {
 		n, err := archive.Read(buf)

commands/service_deploy.go

@@ -8,13 +8,15 @@ import (
 	"github.com/mesg-foundation/core/commands/provider"
 	"github.com/mesg-foundation/core/utils/pretty"
 	"github.com/mesg-foundation/core/x/xerrors"
+	"github.com/mesg-foundation/core/x/xpflag"
 	"github.com/spf13/cobra"
 )
 
 type serviceDeployCmd struct {
 	baseCmd
 
 	path string
+	env  map[string]string
 
 	e ServiceExecutor
 }
@@ -27,11 +29,12 @@ func newServiceDeployCmd(e ServiceExecutor) *serviceDeployCmd {
 		Long: `Deploy a service.
 
 To get more information, see the [deploy page from the documentation](https://docs.mesg.com/guide/service/deploy-a-service.html)`,
-		Example: `mesg-core service deploy PATH_TO_SERVICE`,
+		Example: `mesg-core service deploy [PATH_TO_SERVICE|URL_TO_SERVICE]`,
 		PreRunE: c.preRunE,
 		RunE:    c.runE,
 		Args:    cobra.MaximumNArgs(1),
 	})
+	c.cmd.Flags().Var(xpflag.NewStringToStringValue(&c.env, nil), "env", "set env defined in mesg.yml (configuration.env)")
 	return c
 }
 
@@ -52,7 +55,7 @@ func (c *serviceDeployCmd) runE(cmd *cobra.Command, args []string) error {
 		printDeployStatuses(statuses)
 	}()
 
-	id, validationError, err := c.e.ServiceDeploy(c.path, statuses)
+	id, validationError, err := c.e.ServiceDeploy(c.path, c.env, statuses)
 	wg.Wait()
 
 	pretty.DestroySpinner()

commands/service_deploy_test.go

@@ -0,0 +1,15 @@
+package commands
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestServiceDeployCmdFlags(t *testing.T) {
+	c := newServiceDeployCmd(nil)
+
+	flags := c.cmd.Flags()
+	flags.Set("env", "a=1,b=2")
+	require.Equal(t, map[string]string{"a": "1", "b": "2"}, c.env)
+}

commands/service_dev.go

@@ -10,6 +10,7 @@ import (
 	"github.com/mesg-foundation/core/commands/provider"
 	"github.com/mesg-foundation/core/utils/pretty"
 	"github.com/mesg-foundation/core/x/xerrors"
+	"github.com/mesg-foundation/core/x/xpflag"
 	"github.com/mesg-foundation/core/x/xsignal"
 	"github.com/spf13/cobra"
 )
@@ -21,6 +22,7 @@ type serviceDevCmd struct {
 	taskFilter   string
 	outputFilter string
 	path         string
+	env          map[string]string
 
 	e ServiceExecutor
 }
@@ -42,6 +44,7 @@ func newServiceDevCmd(e ServiceExecutor) *serviceDevCmd {
 	c.cmd.Flags().StringVarP(&c.eventFilter, "event-filter", "e", c.eventFilter, "Only log the data of the given event")
 	c.cmd.Flags().StringVarP(&c.taskFilter, "task-filter", "t", "", "Only log the result of the given task")
 	c.cmd.Flags().StringVarP(&c.outputFilter, "output-filter", "o", "", "Only log the data of the given output of a task result. If set, you also need to set the task in --task-filter")
+	c.cmd.Flags().Var(xpflag.NewStringToStringValue(&c.env, nil), "env", "set env defined in mesg.yml (configuration.env)")
 	return c
 }
 
@@ -62,7 +65,7 @@ func (c *serviceDevCmd) runE(cmd *cobra.Command, args []string) error {
 		printDeployStatuses(statuses)
 	}()
 
-	id, validationError, err := c.e.ServiceDeploy(c.path, statuses)
+	id, validationError, err := c.e.ServiceDeploy(c.path, c.env, statuses)
 	wg.Wait()
 
 	pretty.DestroySpinner()

container/service_options.go

@@ -1,9 +1,7 @@
 package container
 
 import (
-	"fmt"
 	"os"
-	"sort"
 	"strconv"
 	"strings"
 
@@ -137,15 +135,3 @@ func mergeLabels(l1 map[string]string, l2 map[string]string) map[string]string {
 	}
 	return l1
 }
-
-// MapToEnv transform a map of key value to a array of env string.
-// env vars sorted by names to get an accurate order while testing, otherwise
-// comparing a string slice with different orders will fail.
-func MapToEnv(data map[string]string) []string {
-	env := make([]string, 0, len(data))
-	for key, value := range data {
-		env = append(env, fmt.Sprintf("%s=%s", key, value))
-	}
-	sort.Strings(env)
-	return env
-}

container/service_options_test.go

@@ -123,21 +123,3 @@ func TestServiceOptionNetworks(t *testing.T) {
 	require.Equal(t, 1, len(networks[1].Aliases))
 	require.Equal(t, "test", networks[1].Aliases[0])
 }
-
-func contains(list []string, item string) bool {
-	for _, itemInList := range list {
-		if itemInList == item {
-			return true
-		}
-	}
-	return false
-}
-
-func TestMapToEnv(t *testing.T) {
-	env := MapToEnv(map[string]string{
-		"first":  "first_value",
-		"second": "second_value",
-	})
-	require.True(t, contains(env, "first=first_value"))
-	require.True(t, contains(env, "second=second_value"))
-}

daemon/daemon.go

@@ -7,6 +7,7 @@ import (
 	"github.com/mesg-foundation/core/config"
 	"github.com/mesg-foundation/core/container"
 	"github.com/mesg-foundation/core/x/xnet"
+	"github.com/mesg-foundation/core/x/xos"
 )
 
 // Daemon is an interface that start, stop etc core as daemon.
@@ -61,7 +62,7 @@ func (d *ContainerDaemon) buildServiceOptions(sharedNetworkID string) container.
 	return container.ServiceOptions{
 		Namespace: []string{},
 		Image:     d.cfg.Core.Image,
-		Env:       container.MapToEnv(d.cfg.DaemonEnv()),
+		Env:       xos.EnvMapToSlice(d.cfg.DaemonEnv()),
 		Mounts: []container.Mount{
 			{
 				Source: d.cfg.Docker.Socket,