Merge pull request #492 from silvin-lubecki/render-custom-action

Move Render command as a CNAB custom action

Author: chris-crone

Gopkg.lock

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

Gopkg.toml

@@ -12,7 +12,6 @@ import (
 )
 
 const (
-	envVarOchestrator = "DOCKER_STACK_ORCHESTRATOR"
 	fileDockerContext = "/cnab/app/context.dockercontext"
 )
 

cmd/cnab-run/env.go

@@ -7,7 +7,7 @@ import (
 	"github.com/docker/app/internal/packager"
 )
 
-func inspect() error {
+func inspectAction(instanceName string) error {
 	app, err := packager.Extract("")
 	// todo: merge additional compose file
 	if err != nil {

cmd/cnab-run/inspect.go

@@ -6,6 +6,7 @@ import (
 	"os"
 
 	"github.com/deislabs/duffle/pkg/bundle"
+	"github.com/docker/app/internal"
 	"github.com/docker/app/internal/packager"
 	"github.com/docker/app/render"
 	"github.com/docker/cli/cli/command"
@@ -22,7 +23,7 @@ const (
 	imageMapFilePath = "/cnab/app/image-map.json"
 )
 
-func install(instanceName string) error {
+func installAction(instanceName string) error {
 	cli, err := setupDockerContext()
 	if err != nil {
 		return errors.Wrap(err, "unable to restore docker context")
@@ -34,7 +35,7 @@ func install(instanceName string) error {
 	}
 	defer app.Cleanup()
 
-	orchestratorRaw := os.Getenv(envVarOchestrator)
+	orchestratorRaw := os.Getenv(internal.DockerStackOrchestratorEnvVar)
 	orchestrator, err := cli.StackOrchestrator(orchestratorRaw)
 	if err != nil {
 		return err
@@ -62,7 +63,7 @@ func install(instanceName string) error {
 func getFlagset(orchestrator command.Orchestrator) *pflag.FlagSet {
 	result := pflag.NewFlagSet("", pflag.ContinueOnError)
 	if orchestrator == command.OrchestratorKubernetes {
-		result.String("namespace", os.Getenv("DOCKER_KUBERNETES_NAMESPACE"), "")
+		result.String("namespace", os.Getenv(internal.DockerKubernetesNamespaceEnvVar), "")
 	}
 	return result
 }

cmd/cnab-run/install.go

@@ -8,76 +8,42 @@ import (
 	"github.com/docker/app/internal"
 )
 
-type cnabAction string
-
-const (
-	cnabActionInstall   = cnabAction("install")
-	cnabActionUninstall = cnabAction("uninstall")
-	cnabActionUpgrade   = cnabAction("upgrade")
-	cnabActionStatus    = cnabAction(internal.Namespace + "status")
-	cnabActionInspect   = cnabAction(internal.Namespace + "inspect")
-)
-
-type cnabOperation struct {
-	action       cnabAction
-	installation string
-}
-
-func getCnabAction() (cnabAction, error) {
-	action, ok := os.LookupEnv("CNAB_ACTION")
-	if !ok {
-		return "", errors.New("no CNAB action specified")
+type cnabAction func(string) error
+
+var (
+	cnabActions = map[string]cnabAction{
+		"install":                      installAction,
+		"upgrade":                      installAction,
+		"uninstall":                    uninstallAction,
+		internal.Namespace + "status":  statusAction,
+		internal.Namespace + "inspect": inspectAction,
+		internal.Namespace + "render":  renderAction,
 	}
-	return cnabAction(action), nil
-}
+)
 
-func getCnabOperation() (cnabOperation, error) {
+func getCnabAction() (cnabAction, string, error) {
 	// CNAB_ACTION should always be set. but in future we want to have
 	// claim-less actions. So we don't fail if no installation is set
-	action, err := getCnabAction()
-	if err != nil {
-		return cnabOperation{}, err
+	actionName, ok := os.LookupEnv("CNAB_ACTION")
+	if !ok {
+		return nil, "", errors.New("no CNAB action specified")
+	}
+	action, ok := cnabActions[actionName]
+	if !ok {
+		return nil, "", fmt.Errorf("action %q not supported", actionName)
 	}
-	return cnabOperation{
-		action:       action,
-		installation: os.Getenv("CNAB_INSTALLATION_NAME"),
-	}, nil
+	return action, actionName, nil
 }
 
 func main() {
-	op, err := getCnabOperation()
+	action, actionName, err := getCnabAction()
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "Error while parsing cnab operation: %s", err)
 		os.Exit(1)
 	}
-	switch op.action {
-	case cnabActionInstall:
-		if err := install(op.installation); err != nil {
-			fmt.Fprintf(os.Stderr, "Install failed: %s", err)
-			os.Exit(1)
-		}
-	case cnabActionUpgrade:
-		if err := install(op.installation); err != nil {
-			fmt.Fprintf(os.Stderr, "Upgrade failed: %s", err)
-			os.Exit(1)
-		}
-	case cnabActionUninstall:
-		if err := uninstall(op.installation); err != nil {
-			fmt.Fprintf(os.Stderr, "Uninstall failed: %s", err)
-			os.Exit(1)
-		}
-	case cnabActionStatus:
-		if err := status(op.installation); err != nil {
-			fmt.Fprintf(os.Stderr, "Status failed: %s", err)
-			os.Exit(1)
-		}
-	case cnabActionInspect:
-		if err := inspect(); err != nil {
-			fmt.Fprintf(os.Stderr, "Inspect failed: %s", err)
-			os.Exit(1)
-		}
-	default:
-		fmt.Fprintf(os.Stderr, "Action %q is not supported", op.action)
+	instanceName := os.Getenv("CNAB_INSTALLATION_NAME")
+	if err := action(instanceName); err != nil {
+		fmt.Fprintf(os.Stderr, "Action %q failed: %s", actionName, err)
 		os.Exit(1)
 	}
 }

cmd/cnab-run/main.go

@@ -0,0 +1,45 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/docker/app/internal"
+
+	"github.com/docker/app/internal/formatter"
+	"github.com/docker/app/internal/packager"
+	"github.com/docker/app/render"
+)
+
+func renderAction(instanceName string) error {
+	app, err := packager.Extract("")
+	// todo: merge additional compose file
+	if err != nil {
+		return err
+	}
+	defer app.Cleanup()
+
+	imageMap, err := getBundleImageMap()
+	if err != nil {
+		return err
+	}
+
+	formatDriver, ok := os.LookupEnv(internal.DockerRenderFormatEnvVar)
+	if !ok {
+		return fmt.Errorf("%q is undefined", internal.DockerRenderFormatEnvVar)
+	}
+
+	parameters := packager.ExtractCNABParametersValues(packager.ExtractCNABParameterMapping(app.Parameters()), os.Environ())
+
+	rendered, err := render.Render(app, parameters, imageMap)
+	if err != nil {
+		return err
+	}
+	res, err := formatter.Format(rendered, formatDriver)
+	if err != nil {
+		return err
+	}
+	fmt.Printf(res)
+
+	return nil
+}

cmd/cnab-run/render.go

@@ -3,18 +3,19 @@ package main
 import (
 	"os"
 
+	"github.com/docker/app/internal"
 	"github.com/docker/cli/cli/command/stack"
 	"github.com/docker/cli/cli/command/stack/options"
 	"github.com/docker/cli/opts"
 	"github.com/pkg/errors"
 )
 
-func status(instanceName string) error {
+func statusAction(instanceName string) error {
 	cli, err := setupDockerContext()
 	if err != nil {
 		return errors.Wrap(err, "unable to restore docker context")
 	}
-	orchestratorRaw := os.Getenv(envVarOchestrator)
+	orchestratorRaw := os.Getenv(internal.DockerStackOrchestratorEnvVar)
 	orchestrator, err := cli.StackOrchestrator(orchestratorRaw)
 	if err != nil {
 		return err

cmd/cnab-run/status.go

@@ -3,17 +3,18 @@ package main
 import (
 	"os"
 
+	"github.com/docker/app/internal"
 	"github.com/docker/cli/cli/command/stack"
 	"github.com/docker/cli/cli/command/stack/options"
 	"github.com/pkg/errors"
 )
 
-func uninstall(instanceName string) error {
+func uninstallAction(instanceName string) error {
 	cli, err := setupDockerContext()
 	if err != nil {
 		return errors.Wrap(err, "unable to restore docker context")
 	}
-	orchestratorRaw := os.Getenv(envVarOchestrator)
+	orchestratorRaw := os.Getenv(internal.DockerStackOrchestratorEnvVar)
 	orchestrator, err := cli.StackOrchestrator(orchestratorRaw)
 	if err != nil {
 		return err

cmd/cnab-run/uninstall.go

@@ -28,7 +28,7 @@ func TestCallCustomStatusAction(t *testing.T) {
 		{
 			name:           "missingCustomStatusAction",
 			exitCode:       1,
-			expectedOutput: "Status failed: action not defined for bundle",
+			expectedOutput: "status failed: action not defined for bundle",
 			cnab:           "cnab-without-status",
 		},
 	}