Merge pull request #72 from ulyssessouza/add-aci-volumes

Add volumes to run command

Author: gtardif

azure/aci.go

@@ -9,8 +9,6 @@ import (
 	"strings"
 	"time"
 
-	"github.com/docker/api/azure/login"
-
 	"github.com/Azure/azure-sdk-for-go/profiles/2019-03-01/resources/mgmt/resources"
 	"github.com/Azure/azure-sdk-for-go/profiles/preview/preview/subscription/mgmt/subscription"
 	"github.com/Azure/azure-sdk-for-go/services/containerinstance/mgmt/2018-10-01/containerinstance"
@@ -21,6 +19,9 @@ import (
 	"github.com/gobwas/ws/wsutil"
 	"github.com/pkg/errors"
 
+	"github.com/docker/api/azure/login"
+	"github.com/docker/api/errdefs"
+
 	"github.com/docker/api/context/store"
 )
 
@@ -257,11 +258,14 @@ func getContainerClient(subscriptionID string) (containerinstance.ContainerClien
 	return containerClient, nil
 }
 
-func getSubscriptionsClient() subscription.SubscriptionsClient {
+func getSubscriptionsClient() (subscription.SubscriptionsClient, error) {
 	subc := subscription.NewSubscriptionsClient()
-	authorizer, _ := login.NewAuthorizerFromLogin()
+	authorizer, err := login.NewAuthorizerFromLogin()
+	if err != nil {
+		return subscription.SubscriptionsClient{}, errors.Wrap(errdefs.ErrLoginFailed, err.Error())
+	}
 	subc.Authorizer = authorizer
-	return subc
+	return subc, nil
 }
 
 // GetGroupsClient ...
@@ -274,7 +278,10 @@ func GetGroupsClient(subscriptionID string) resources.GroupsClient {
 
 // GetSubscriptionID ...
 func GetSubscriptionID(ctx context.Context) (string, error) {
-	c := getSubscriptionsClient()
+	c, err := getSubscriptionsClient()
+	if err != nil {
+		return "", err
+	}
 	res, err := c.List(ctx)
 	if err != nil {
 		return "", err

azure/backend.go

@@ -155,17 +155,25 @@ func (cs *aciContainerService) Run(ctx context.Context, r containers.ContainerCo
 			Published: p.HostPort,
 		})
 	}
+
+	projectVolumes, serviceConfigVolumes, err := convert.GetRunVolumes(r.Volumes)
+	if err != nil {
+		return err
+	}
+
 	project := compose.Project{
 		Name: r.ID,
 		Config: types.Config{
 			Services: []types.ServiceConfig{
 				{
-					Name:   singleContainerName,
-					Image:  r.Image,
-					Ports:  ports,
-					Labels: r.Labels,
+					Name:    singleContainerName,
+					Image:   r.Image,
+					Ports:   ports,
+					Labels:  r.Labels,
+					Volumes: serviceConfigVolumes,
 				},
 			},
+			Volumes: projectVolumes,
 		},
 	}
 

azure/convert/volume.go

@@ -0,0 +1,119 @@
+package convert
+
+import (
+	"fmt"
+	"net/url"
+	"path/filepath"
+	"strings"
+
+	"github.com/pkg/errors"
+
+	"github.com/compose-spec/compose-go/types"
+
+	"github.com/docker/api/errdefs"
+)
+
+// GetRunVolumes return volume configurations for a project and a single service
+// this is meant to be used as a compose project of a single service
+func GetRunVolumes(volumes []string) (map[string]types.VolumeConfig, []types.ServiceVolumeConfig, error) {
+	var serviceConfigVolumes []types.ServiceVolumeConfig
+	projectVolumes := make(map[string]types.VolumeConfig, len(volumes))
+	for i, v := range volumes {
+		var vi volumeInput
+		err := vi.parse(fmt.Sprintf("volume-%d", i), v)
+		if err != nil {
+			return nil, nil, err
+		}
+		projectVolumes[vi.name] = types.VolumeConfig{
+			Name:   vi.name,
+			Driver: azureFileDriverName,
+			DriverOpts: map[string]string{
+				volumeDriveroptsAccountNameKey: vi.username,
+				volumeDriveroptsAccountKeyKey:  vi.key,
+				volumeDriveroptsShareNameKey:   vi.share,
+			},
+		}
+		sv := types.ServiceVolumeConfig{
+			Type:   azureFileDriverName,
+			Source: vi.name,
+			Target: vi.target,
+		}
+		serviceConfigVolumes = append(serviceConfigVolumes, sv)
+	}
+
+	return projectVolumes, serviceConfigVolumes, nil
+}
+
+type volumeInput struct {
+	name     string
+	username string
+	key      string
+	share    string
+	target   string
+}
+
+func escapeKeySlashes(rawURL string) (string, error) {
+	urlSplit := strings.Split(rawURL, "@")
+	if len(urlSplit) < 1 {
+		return "", errors.Wrap(errdefs.ErrParsingFailed, "invalid url format "+rawURL)
+	}
+	userPasswd := strings.ReplaceAll(urlSplit[0], "/", "_")
+
+	atIndex := strings.Index(rawURL, "@")
+	if atIndex < 0 {
+		return "", errors.Wrap(errdefs.ErrParsingFailed, "no share specified in "+rawURL)
+	}
+
+	scaped := userPasswd + rawURL[atIndex:]
+
+	return scaped, nil
+}
+
+func unescapeKey(key string) string {
+	return strings.ReplaceAll(key, "_", "/")
+}
+
+// Removes the second ':' that separates the source from target
+func volumeURL(pathURL string) (*url.URL, error) {
+	scapedURL, err := escapeKeySlashes(pathURL)
+	if err != nil {
+		return nil, err
+	}
+	pathURL = "//" + scapedURL
+
+	count := strings.Count(pathURL, ":")
+	if count > 2 {
+		return nil, errors.Wrap(errdefs.ErrParsingFailed, fmt.Sprintf("unable to parse volume mount %q", pathURL))
+	}
+	if count == 2 {
+		tokens := strings.Split(pathURL, ":")
+		pathURL = fmt.Sprintf("%s:%s%s", tokens[0], tokens[1], tokens[2])
+	}
+	return url.Parse(pathURL)
+}
+
+func (v *volumeInput) parse(name string, s string) error {
+	volumeURL, err := volumeURL(s)
+	if err != nil {
+		return errors.Wrap(errdefs.ErrParsingFailed, fmt.Sprintf("volume specification %q could not be parsed %q", s, err))
+	}
+	v.username = volumeURL.User.Username()
+	if v.username == "" {
+		return errors.Wrap(errdefs.ErrParsingFailed, fmt.Sprintf("volume specification %q does not include a storage username", v))
+	}
+	key, ok := volumeURL.User.Password()
+	if !ok || key == "" {
+		return errors.Wrap(errdefs.ErrParsingFailed, fmt.Sprintf("volume specification %q does not include a storage key", v))
+	}
+	v.key = unescapeKey(key)
+	v.share = volumeURL.Host
+	if v.share == "" {
+		return errors.Wrap(errdefs.ErrParsingFailed, fmt.Sprintf("volume specification %q does not include a storage file share", v))
+	}
+	v.name = name
+	v.target = volumeURL.Path
+	if v.target == "" {
+		v.target = filepath.Join("/run/volumes/", v.share)
+	}
+	return nil
+}

azure/convert/volume_test.go

@@ -0,0 +1,134 @@
+/*
+	Copyright (c) 2020 Docker Inc.
+
+	Permission is hereby granted, free of charge, to any person
+	obtaining a copy of this software and associated documentation
+	files (the "Software"), to deal in the Software without
+	restriction, including without limitation the rights to use, copy,
+	modify, merge, publish, distribute, sublicense, and/or sell copies
+	of the Software, and to permit persons to whom the Software is
+	furnished to do so, subject to the following conditions:
+
+	The above copyright notice and this permission notice shall be
+	included in all copies or substantial portions of the Software.
+
+	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+	EXPRESS OR IMPLIED,
+	INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+	IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+	HOLDERS BE LIABLE FOR ANY CLAIM,
+	DAMAGES OR OTHER LIABILITY,
+	WHETHER IN AN ACTION OF CONTRACT,
+	TORT OR OTHERWISE,
+	ARISING FROM, OUT OF OR IN CONNECTION WITH
+	THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+
+package convert
+
+import (
+	"testing"
+
+	"github.com/compose-spec/compose-go/types"
+	"gotest.tools/assert"
+
+	"github.com/docker/api/errdefs"
+)
+
+const (
+	storageAccountNameKey = "storage_account_name"
+	storageAccountKeyKey  = "storage_account_key"
+	shareNameKey          = "share_name"
+)
+
+func TestGetRunVolumes(t *testing.T) {
+	volumeStrings := []string{
+		"myuser1:mykey1@myshare1/my/path/to/target1",
+		"myuser2:mykey2@myshare2/my/path/to/target2",
+		"myuser3:mykey3@mydefaultsharename", // Use default placement at '/run/volumes/<share_name>'
+	}
+	var goldenVolumeConfigs = map[string]types.VolumeConfig{
+		"volume-0": {
+			Name:   "volume-0",
+			Driver: "azure_file",
+			DriverOpts: map[string]string{
+				storageAccountNameKey: "myuser1",
+				storageAccountKeyKey:  "mykey1",
+				shareNameKey:          "myshare1",
+			},
+		},
+		"volume-1": {
+			Name:   "volume-1",
+			Driver: "azure_file",
+			DriverOpts: map[string]string{
+				storageAccountNameKey: "myuser2",
+				storageAccountKeyKey:  "mykey2",
+				shareNameKey:          "myshare2",
+			},
+		},
+		"volume-2": {
+			Name:   "volume-2",
+			Driver: "azure_file",
+			DriverOpts: map[string]string{
+				storageAccountNameKey: "myuser3",
+				storageAccountKeyKey:  "mykey3",
+				shareNameKey:          "mydefaultsharename",
+			},
+		},
+	}
+	goldenServiceVolumeConfigs := []types.ServiceVolumeConfig{
+		{
+			Type:   "azure_file",
+			Source: "volume-0",
+			Target: "/my/path/to/target1",
+		},
+		{
+			Type:   "azure_file",
+			Source: "volume-1",
+			Target: "/my/path/to/target2",
+		},
+		{
+			Type:   "azure_file",
+			Source: "volume-2",
+			Target: "/run/volumes/mydefaultsharename",
+		},
+	}
+
+	volumeConfigs, serviceVolumeConfigs, err := GetRunVolumes(volumeStrings)
+	assert.NilError(t, err)
+	for k, v := range volumeConfigs {
+		assert.DeepEqual(t, goldenVolumeConfigs[k], v)
+	}
+	for i, v := range serviceVolumeConfigs {
+		assert.DeepEqual(t, goldenServiceVolumeConfigs[i], v)
+	}
+}
+
+func TestGetRunVolumesMissingFileShare(t *testing.T) {
+	_, _, err := GetRunVolumes([]string{"myuser:mykey@"})
+	assert.Equal(t, true, errdefs.IsErrParsingFailed(err))
+	assert.ErrorContains(t, err, "does not include a storage file share")
+}
+
+func TestGetRunVolumesMissingUser(t *testing.T) {
+	_, _, err := GetRunVolumes([]string{":mykey@myshare"})
+	assert.Equal(t, true, errdefs.IsErrParsingFailed(err))
+	assert.ErrorContains(t, err, "does not include a storage username")
+}
+
+func TestGetRunVolumesMissingKey(t *testing.T) {
+	_, _, err := GetRunVolumes([]string{"userwithnokey:@myshare"})
+	assert.Equal(t, true, errdefs.IsErrParsingFailed(err))
+	assert.ErrorContains(t, err, "does not include a storage key")
+
+	_, _, err = GetRunVolumes([]string{"userwithnokeytoo@myshare"})
+	assert.Equal(t, true, errdefs.IsErrParsingFailed(err))
+	assert.ErrorContains(t, err, "does not include a storage key")
+}
+
+func TestGetRunVolumesNoShare(t *testing.T) {
+	_, _, err := GetRunVolumes([]string{"noshare"})
+	assert.Equal(t, true, errdefs.IsErrParsingFailed(err))
+	assert.ErrorContains(t, err, "no share specified")
+}

cli/cmd/run/run.go

@@ -54,6 +54,7 @@ func Command() *cobra.Command {
 	cmd.Flags().StringArrayVarP(&opts.Publish, "publish", "p", []string{}, "Publish a container's port(s). [HOST_PORT:]CONTAINER_PORT")
 	cmd.Flags().StringVar(&opts.Name, "name", getRandomName(), "Assign a name to the container")
 	cmd.Flags().StringArrayVarP(&opts.Labels, "label", "l", []string{}, "Set meta data on a container")
+	cmd.Flags().StringArrayVarP(&opts.Volumes, "volume", "v", []string{}, "Volume. Ex: user:key@my_share:/absolute/path/to/target")
 
 	return cmd
 }
@@ -64,18 +65,17 @@ func runRun(ctx context.Context, image string, opts run.Opts) error {
 		return err
 	}
 
-	project, err := opts.ToContainerConfig(image)
+	containerConfig, err := opts.ToContainerConfig(image)
 	if err != nil {
 		return err
 	}
 
-	if err = c.ContainerService().Run(ctx, project); err != nil {
+	if err = c.ContainerService().Run(ctx, containerConfig); err != nil {
 		return err
 	}
 	fmt.Println(opts.Name)
 
 	return nil
-
 }
 
 func getRandomName() string {

cli/options/run/opts.go

@@ -15,6 +15,7 @@ type Opts struct {
 	Name    string
 	Publish []string
 	Labels  []string
+	Volumes []string
 }
 
 // ToContainerConfig convert run options to a container configuration
@@ -30,10 +31,11 @@ func (r *Opts) ToContainerConfig(image string) (containers.ContainerConfig, erro
 	}
 
 	return containers.ContainerConfig{
-		ID:     r.Name,
-		Image:  image,
-		Ports:  publish,
-		Labels: labels,
+		ID:      r.Name,
+		Image:   image,
+		Ports:   publish,
+		Labels:  labels,
+		Volumes: r.Volumes,
 	}, nil
 }