Merge pull request #434 from simonferquel/image-map-support

Image map support

Author: silvin-lubecki

Gopkg.lock

@@ -31,11 +31,9 @@ required = ["github.com/wadey/gocovmerge"]
   name = "github.com/docker/cli"
   revision = "f95ca8e1ba6c22c9abcdbf65e8dcc39c53958bba"
 
-# Waiting for https://github.com/deislabs/duffle/pull/617 to be merged
 [[override]]
   name = "github.com/deislabs/duffle"
-  branch = "master-docker-app"
-  source = "github.com/silvin-lubecki/duffle"
+  branch = "master"
 
 [[constraint]]
   name = "github.com/sirupsen/logrus"

Gopkg.toml

@@ -1,8 +1,11 @@
 package main
 
 import (
+	"encoding/json"
+	"io/ioutil"
 	"os"
 
+	"github.com/deislabs/duffle/pkg/bundle"
 	"github.com/docker/app/internal/packager"
 	"github.com/docker/app/render"
 	"github.com/docker/cli/cli/command"
@@ -13,6 +16,12 @@ import (
 	"github.com/spf13/pflag"
 )
 
+const (
+	// imageMapFilePath is the path where the CNAB runtime will put the actual
+	// service to image mapping to use
+	imageMapFilePath = "/cnab/app/image-map.json"
+)
+
 func install(instanceName string) error {
 	cli, err := setupDockerContext()
 	if err != nil {
@@ -30,8 +39,12 @@ func install(instanceName string) error {
 	if err != nil {
 		return err
 	}
+	imageMap, err := getBundleImageMap()
+	if err != nil {
+		return err
+	}
 	parameters := packager.ExtractCNABParametersValues(packager.ExtractCNABParameterMapping(app.Parameters()), os.Environ())
-	rendered, err := render.Render(app, parameters)
+	rendered, err := render.Render(app, parameters, imageMap)
 	if err != nil {
 		return err
 	}
@@ -53,3 +66,15 @@ func getFlagset(orchestrator command.Orchestrator) *pflag.FlagSet {
 	}
 	return result
 }
+
+func getBundleImageMap() (map[string]bundle.Image, error) {
+	mapJSON, err := ioutil.ReadFile(imageMapFilePath)
+	if err != nil {
+		return nil, err
+	}
+	var result map[string]bundle.Image
+	if err := json.Unmarshal(mapJSON, &result); err != nil {
+		return nil, err
+	}
+	return result, nil
+}

cmd/cnab-run/install.go

@@ -99,7 +99,7 @@ func makeBundleFromApp(dockerCli command.Cli, app *types.App, namespace, invocat
 	if err := jsonmessage.DisplayJSONMessagesStream(buildResp.Body, ioutil.Discard, 0, false, func(jsonmessage.JSONMessage) {}); err != nil {
 		return nil, err
 	}
-	return packager.ToCNAB(app, invocationImageName), nil
+	return packager.ToCNAB(app, invocationImageName)
 }
 
 func makeImageName(meta metadata.AppMetadata, namespace, name, suffix string) (string, error) {

cmd/docker-app/bundle.go

@@ -29,7 +29,7 @@ func inspectCmd(dockerCli command.Cli) *cobra.Command {
 			}
 			defer app.Cleanup()
 			argParameters := cliopts.ConvertKVStringsToMap(inspectEnv)
-			return inspect.Inspect(dockerCli.Out(), app, argParameters)
+			return inspect.Inspect(dockerCli.Out(), app, argParameters, nil)
 		},
 	}
 	cmd.Flags().StringArrayVarP(&inspectParametersFile, "parameters-files", "f", []string{}, "Override with parameters from files")

cmd/docker-app/inspect.go

@@ -39,7 +39,7 @@ func renderCmd(dockerCli command.Cli) *cobra.Command {
 			}
 			defer app.Cleanup()
 			d := cliopts.ConvertKVStringsToMap(renderEnv)
-			rendered, err := render.Render(app, d)
+			rendered, err := render.Render(app, d, nil)
 			if err != nil {
 				return err
 			}

cmd/docker-app/render.go

@@ -28,7 +28,7 @@ func validateCmd() *cobra.Command {
 			}
 			defer app.Cleanup()
 			argParameters := cliopts.ConvertKVStringsToMap(validateEnv)
-			_, err = render.Render(app, argParameters)
+			_, err = render.Render(app, argParameters, nil)
 			return err
 		},
 	}

cmd/docker-app/validate.go

@@ -18,12 +18,12 @@ func Example() {
 	defer f.Close()
 	app, err := loader.LoadFromSingleFile("myApp", f)
 	if err != nil {
-		panic("cannot load application")
+		panic("cannot load application: " + err.Error())
 	}
 	// Render the app to a composefile format, using some user provided parameters
 	c, err := render.Render(app, map[string]string{
 		"text": "hello examples!",
-	})
+	}, nil)
 	if err != nil {
 		panic("cannot render application")
 	}

examples_test.go

@@ -26,29 +26,32 @@ var (
 )
 
 // Load applies the specified function when loading a slice of compose data
-func Load(composes [][]byte, apply func(string) (string, error)) ([]composetypes.ConfigFile, error) {
+func Load(composes [][]byte, apply func(string) (string, error)) ([]composetypes.ConfigFile, map[string]string, error) {
 	configFiles := []composetypes.ConfigFile{}
 	for _, data := range composes {
 		s, err := apply(string(data))
 		if err != nil {
-			return nil, err
+			return nil, nil, err
 		}
 		parsed, err := loader.ParseYAML([]byte(s))
 		if err != nil {
-			return nil, errors.Wrapf(err, "failed to parse Compose file %s", data)
+			return nil, nil, errors.Wrapf(err, "failed to parse Compose file %s", data)
 		}
 		configFiles = append(configFiles, composetypes.ConfigFile{Config: parsed})
 	}
 
-	if err := validateImageInConfigFiles(configFiles); err != nil {
-		return nil, err
+	images, err := validateImagesInConfigFiles(configFiles)
+	if err != nil {
+		return nil, nil, err
 	}
 
-	return configFiles, nil
+	return configFiles, images, nil
 }
 
-func validateImageInConfigFiles(configFiles []composetypes.ConfigFile) error {
+// validateImagesInConfigFiles validates that there is no unsupported variable expensions in service images and returns a map of service name -> image
+func validateImagesInConfigFiles(configFiles []composetypes.ConfigFile) (map[string]string, error) {
 	var errors []string
+	images := map[string]string{}
 	for _, configFile := range configFiles {
 		services, ok := configFile.Config["services"].(map[string]interface{})
 		if !ok {
@@ -63,6 +66,7 @@ func validateImageInConfigFiles(configFiles []composetypes.ConfigFile) error {
 			if !ok {
 				continue
 			}
+			images[serviceName] = imageName
 
 			if ExtrapolationPattern.MatchString(imageName) {
 				errors = append(errors,
@@ -73,10 +77,10 @@ func validateImageInConfigFiles(configFiles []composetypes.ConfigFile) error {
 	}
 
 	if len(errors) > 0 {
-		return fmt.Errorf("%s", strings.Join(errors, "\n"))
+		return nil, fmt.Errorf("%s", strings.Join(errors, "\n"))
 	}
 
-	return nil
+	return images, nil
 }
 
 // ExtractVariables extracts the variables from the specified compose data

internal/compose/compose.go

@@ -54,7 +54,8 @@ services:
 }
 
 func runLoad(composeFile []byte) ([]composetypes.ConfigFile, error) {
-	return Load([][]byte{composeFile}, func(data string) (string, error) {
+	files, _, err := Load([][]byte{composeFile}, func(data string) (string, error) {
 		return renderer.Apply(data, map[string]interface{}{"image": "nginx"})
 	})
+	return files, err
 }