Merge pull request docker-archive-public#507 from silvin-lubecki/claimstore-per-context

Introduce Claim and Credential stores per context

Author: silvin-lubecki

Gopkg.lock

@@ -41,7 +41,6 @@ func TestCallCustomStatusAction(t *testing.T) {
 			tmpDir := fs.NewDir(t, t.Name())
 			defer tmpDir.Remove()
 			testDir := path.Join("testdata", testCase.cnab)
-			cmd.Env = append(cmd.Env, "DUFFLE_HOME="+tmpDir.Path())
 
 			// We need to explicitly set the SYSTEMROOT on windows
 			// otherwise we get the error:

e2e/cnab_test.go

@@ -307,7 +307,6 @@ func testDockerAppLifecycle(t *testing.T, useBindMount bool) {
 	tmpDir := fs.NewDir(t, appName)
 	defer tmpDir.Remove()
 
-	cmd.Env = append(cmd.Env, "DUFFLE_HOME="+tmpDir.Path())
 	cmd.Env = append(cmd.Env, "DOCKER_TARGET_CONTEXT=swarm-target-context")
 
 	// Running a swarm using docker in docker to install the application

e2e/commands_test.go

@@ -31,7 +31,6 @@ func runWithDindSwarmAndRegistry(t *testing.T, todo func(dindSwarmAndRegistryInf
 	tmpDir := fs.NewDir(t, t.Name())
 	defer tmpDir.Remove()
 
-	cmd.Env = append(cmd.Env, "DUFFLE_HOME="+tmpDir.Path())
 	cmd.Env = append(cmd.Env, "DOCKER_TARGET_CONTEXT=swarm-target-context")
 
 	// The dind doesn't have the cnab-app-base image so we save it in order to load it later

e2e/pushpull_test.go

@@ -8,22 +8,22 @@ import (
 	"io"
 	"io/ioutil"
 	"os"
-	"path/filepath"
 	"strings"
 
 	"github.com/deislabs/duffle/pkg/action"
 	"github.com/deislabs/duffle/pkg/bundle"
 	"github.com/deislabs/duffle/pkg/claim"
 	"github.com/deislabs/duffle/pkg/credentials"
 	"github.com/deislabs/duffle/pkg/driver"
-	"github.com/deislabs/duffle/pkg/duffle/home"
 	"github.com/deislabs/duffle/pkg/loader"
 	"github.com/docker/app/internal"
 	"github.com/docker/app/internal/packager"
-	bundlestore "github.com/docker/app/internal/store"
+	appstore "github.com/docker/app/internal/store"
 	"github.com/docker/cli/cli/command"
+	"github.com/docker/cli/cli/config"
 	"github.com/docker/cli/cli/context/docker"
 	"github.com/docker/cli/cli/context/store"
+	contextstore "github.com/docker/cli/cli/context/store"
 	"github.com/docker/distribution/reference"
 	"github.com/docker/docker/api/types"
 	"github.com/docker/docker/api/types/container"
@@ -41,13 +41,10 @@ const defaultSocketPath string = "/var/run/docker.sock"
 
 type credentialSetOpt func(b *bundle.Bundle, creds credentials.Set) error
 
-func addNamedCredentialSets(namedCredentialsets []string) credentialSetOpt {
+func addNamedCredentialSets(credStore appstore.CredentialStore, namedCredentialsets []string) credentialSetOpt {
 	return func(_ *bundle.Bundle, creds credentials.Set) error {
 		for _, file := range namedCredentialsets {
-			if _, err := os.Stat(file); err != nil {
-				file = filepath.Join(duffleHome().Credentials(), file+".yaml")
-			}
-			c, err := credentials.Load(file)
+			c, err := credStore.Read(file)
 			if err != nil {
 				return err
 			}
@@ -63,12 +60,12 @@ func addNamedCredentialSets(namedCredentialsets []string) credentialSetOpt {
 	}
 }
 
-func addDockerCredentials(contextName string, contextStore store.Store) credentialSetOpt {
+func addDockerCredentials(contextName string, store contextstore.Store) credentialSetOpt {
 	// docker desktop contexts require some rewriting for being used within a container
-	contextStore = dockerDesktopAwareStore{Store: contextStore}
+	store = dockerDesktopAwareStore{Store: store}
 	return func(_ *bundle.Bundle, creds credentials.Set) error {
 		if contextName != "" {
-			data, err := ioutil.ReadAll(store.Export(contextName, contextStore))
+			data, err := ioutil.ReadAll(contextstore.Export(contextName, store))
 			if err != nil {
 				return err
 			}
@@ -141,10 +138,6 @@ func getTargetContext(optstargetContext, currentContext string) string {
 	return targetContext
 }
 
-func duffleHome() home.Home {
-	return home.Home(home.DefaultHome())
-}
-
 // prepareDriver prepares a driver per the user's request.
 func prepareDriver(dockerCli command.Cli, bindMount bindMount, stdout io.Writer) (driver.Driver, *bytes.Buffer, error) {
 	driverImpl, err := driver.Lookup("docker")
@@ -217,11 +210,11 @@ func extractAndLoadAppBasedBundle(dockerCli command.Cli, name string) (*bundle.B
 	return makeBundleFromApp(dockerCli, app)
 }
 
-func resolveBundle(dockerCli command.Cli, name string, pullRef bool, insecureRegistries []string) (*bundle.Bundle, error) {
+func resolveBundle(dockerCli command.Cli, bundleStore appstore.BundleStore, name string, pullRef bool, insecureRegistries []string) (*bundle.Bundle, error) {
 	// resolution logic:
 	// - if there is a docker-app package in working directory, or an http:// / https:// prefix, use packager.Extract result
 	// - the name has a .json or .cnab extension and refers to an existing file or web resource: load the bundle
-	// - name matches a bundle name:version stored in duffle bundle store: use it
+	// - name matches a bundle name:version stored in the bundle store: use it
 	// - pull the bundle from the registry and add it to the bundle store
 	name, kind := getAppNameKind(name)
 	switch kind {
@@ -246,7 +239,7 @@ func resolveBundle(dockerCli command.Cli, name string, pullRef bool, insecureReg
 		if err != nil {
 			return nil, errors.Wrap(err, name)
 		}
-		return bundlestore.LookupOrPullBundle(dockerCli, reference.TagNameOnly(ref), pullRef, insecureRegistries)
+		return bundleStore.LookupOrPullBundle(reference.TagNameOnly(ref), pullRef, dockerCli.ConfigFile(), insecureRegistries)
 	}
 	return nil, fmt.Errorf("could not resolve bundle %q", name)
 }
@@ -306,6 +299,14 @@ func isDockerHostLocal(host string) bool {
 
 func prepareCustomAction(actionName string, dockerCli command.Cli, appname string, stdout io.Writer,
 	registryOpts registryOptions, pullOpts pullOptions, paramsOpts parametersOptions) (*action.RunCustom, *claim.Claim, *bytes.Buffer, error) {
+	s, err := appstore.NewApplicationStore(config.Dir())
+	if err != nil {
+		return nil, nil, nil, err
+	}
+	bundleStore, err := s.BundleStore()
+	if err != nil {
+		return nil, nil, nil, err
+	}
 
 	c, err := claim.New("custom-action")
 	if err != nil {
@@ -315,7 +316,7 @@ func prepareCustomAction(actionName string, dockerCli command.Cli, appname strin
 	if err != nil {
 		return nil, nil, nil, err
 	}
-	bundle, err := resolveBundle(dockerCli, appname, pullOpts.pull, registryOpts.insecureRegistries)
+	bundle, err := resolveBundle(dockerCli, bundleStore, appname, pullOpts.pull, registryOpts.insecureRegistries)
 	if err != nil {
 		return nil, nil, nil, err
 	}

internal/commands/cnab.go

@@ -218,7 +218,7 @@ func TestShareRegistryCreds(t *testing.T) {
 					Credentials: map[string]bundle.Location{internal.CredentialRegistryName: {}},
 					Images:      c.images,
 				},
-				addNamedCredentialSets(nil),
+				addNamedCredentialSets(nil, nil),
 				addDockerCredentials("", nil),
 				addRegistryCredentials(c.shareCreds, &registryConfigMock{configFile: &configfile.ConfigFile{
 					AuthConfigs: c.stored,

internal/commands/cnab_test.go

@@ -6,7 +6,6 @@ import (
 	"github.com/deislabs/duffle/pkg/action"
 	"github.com/deislabs/duffle/pkg/claim"
 	"github.com/deislabs/duffle/pkg/credentials"
-	"github.com/deislabs/duffle/pkg/utils/crud"
 	"github.com/docker/cli/cli"
 	"github.com/docker/cli/cli/command"
 	"github.com/spf13/cobra"
@@ -36,7 +35,7 @@ const longDescription = `Install the application on either Swarm or Kubernetes.
 Bundle name is optional, and can:
 - be empty and resolve to any *.dockerapp in working directory
 - be a BUNDLE file path and resolve to any *.dockerapp file or dir, or any CNAB file (signed or unsigned)
-- match a bundle name in the local duffle bundle repository
+- match a bundle name in the local bundle repository
 - refer to a CNAB in a container registry
 `
 
@@ -67,27 +66,31 @@ func installCmd(dockerCli command.Cli) *cobra.Command {
 func runInstall(dockerCli command.Cli, appname string, opts installOptions) error {
 	defer muteDockerCli(dockerCli)()
 	opts.SetDefaultTargetContext(dockerCli)
+
 	bind, err := requiredBindMount(opts.targetContext, opts.orchestrator, dockerCli.ContextStore())
 	if err != nil {
 		return err
 	}
-	bndl, err := resolveBundle(dockerCli, appname, opts.pull, opts.insecureRegistries)
+	bundleStore, installationStore, credentialStore, err := prepareStores(opts.targetContext)
+	if err != nil {
+		return err
+	}
+
+	bndl, err := resolveBundle(dockerCli, bundleStore, appname, opts.pull, opts.insecureRegistries)
 	if err != nil {
 		return err
 	}
 	if err := bndl.Validate(); err != nil {
 		return err
 	}
-	h := duffleHome()
-	claimName := opts.stackName
-	if claimName == "" {
-		claimName = bndl.Name
+	installationName := opts.stackName
+	if installationName == "" {
+		installationName = bndl.Name
 	}
-	claimStore := claim.NewClaimStore(crud.NewFileSystemStore(h.Claims(), "json"))
-	if _, err = claimStore.Read(claimName); err == nil {
-		return fmt.Errorf("installation %q already exists", claimName)
+	if _, err = installationStore.Read(installationName); err == nil {
+		return fmt.Errorf("installation %q already exists", installationName)
 	}
-	c, err := claim.New(claimName)
+	c, err := claim.New(installationName)
 	if err != nil {
 		return err
 	}
@@ -106,7 +109,7 @@ func runInstall(dockerCli command.Cli, appname string, opts installOptions) erro
 	); err != nil {
 		return err
 	}
-	creds, err := prepareCredentialSet(bndl, opts.CredentialSetOpts(dockerCli)...)
+	creds, err := prepareCredentialSet(bndl, opts.CredentialSetOpts(dockerCli, credentialStore)...)
 	if err != nil {
 		return err
 	}
@@ -118,9 +121,9 @@ func runInstall(dockerCli command.Cli, appname string, opts installOptions) erro
 		Driver: driverImpl,
 	}
 	err = inst.Run(c, creds, dockerCli.Out())
-	// Even if the installation failed, the claim is persisted with its failure status,
+	// Even if the installation failed, the installation is persisted with its failure status,
 	// so any installation needs a clean uninstallation.
-	err2 := claimStore.Store(*c)
+	err2 := installationStore.Store(*c)
 	if err != nil {
 		return fmt.Errorf("install failed: %s", errBuf)
 	}

internal/commands/install.go

@@ -3,9 +3,10 @@ package commands
 import (
 	"fmt"
 
-	bundlestore "github.com/docker/app/internal/store"
+	"github.com/docker/app/internal/store"
 	"github.com/docker/cli/cli"
 	"github.com/docker/cli/cli/command"
+	"github.com/docker/cli/cli/config"
 	"github.com/docker/distribution/reference"
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
@@ -26,11 +27,20 @@ func pullCmd(dockerCli command.Cli) *cobra.Command {
 }
 
 func runPull(dockerCli command.Cli, name string, opts registryOptions) error {
+	appstore, err := store.NewApplicationStore(config.Dir())
+	if err != nil {
+		return err
+	}
+	bundleStore, err := appstore.BundleStore()
+	if err != nil {
+		return err
+	}
+
 	ref, err := reference.ParseNormalizedNamed(name)
 	if err != nil {
 		return errors.Wrap(err, name)
 	}
-	bndl, err := bundlestore.LookupOrPullBundle(dockerCli, reference.TagNameOnly(ref), true, opts.insecureRegistries)
+	bndl, err := bundleStore.LookupOrPullBundle(reference.TagNameOnly(ref), true, dockerCli.ConfigFile(), opts.insecureRegistries)
 	if err != nil {
 		return errors.Wrap(err, name)
 	}

internal/commands/pull.go

@@ -3,7 +3,9 @@ package commands
 import (
 	"io/ioutil"
 
+	"github.com/docker/app/internal/store"
 	"github.com/docker/cli/cli/command"
+	"github.com/docker/cli/cli/config"
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 )
@@ -55,6 +57,26 @@ func muteDockerCli(dockerCli command.Cli) func() {
 	}
 }
 
+func prepareStores(targetContext string) (store.BundleStore, store.InstallationStore, store.CredentialStore, error) {
+	appstore, err := store.NewApplicationStore(config.Dir())
+	if err != nil {
+		return nil, nil, nil, err
+	}
+	installationStore, err := appstore.InstallationStore(targetContext)
+	if err != nil {
+		return nil, nil, nil, err
+	}
+	bundleStore, err := appstore.BundleStore()
+	if err != nil {
+		return nil, nil, nil, err
+	}
+	credentialStore, err := appstore.CredentialStore(targetContext)
+	if err != nil {
+		return nil, nil, nil, err
+	}
+	return bundleStore, installationStore, credentialStore, nil
+}
+
 type parametersOptions struct {
 	parametersFiles []string
 	overrides       []string
@@ -73,17 +95,17 @@ type credentialOptions struct {
 
 func (o *credentialOptions) addFlags(flags *pflag.FlagSet) {
 	flags.StringVar(&o.targetContext, "target-context", "", "Context on which the application is executed")
-	flags.StringArrayVarP(&o.credentialsets, "credential-set", "c", []string{}, "Use a duffle credentialset (either a YAML file, or a credential set present in the duffle credential store)")
+	flags.StringArrayVarP(&o.credentialsets, "credential-set", "c", []string{}, "Use a credentialset (either a YAML file, or a credential set present in the credential store)")
 	flags.BoolVar(&o.sendRegistryAuth, "with-registry-auth", false, "Sends registry auth")
 }
 
 func (o *credentialOptions) SetDefaultTargetContext(dockerCli command.Cli) {
 	o.targetContext = getTargetContext(o.targetContext, dockerCli.CurrentContext())
 }
 
-func (o *credentialOptions) CredentialSetOpts(dockerCli command.Cli) []credentialSetOpt {
+func (o *credentialOptions) CredentialSetOpts(dockerCli command.Cli, credentialStore store.CredentialStore) []credentialSetOpt {
 	return []credentialSetOpt{
-		addNamedCredentialSets(o.credentialsets),
+		addNamedCredentialSets(credentialStore, o.credentialsets),
 		addDockerCredentials(o.targetContext, dockerCli.ContextStore()),
 		addRegistryCredentials(o.sendRegistryAuth, dockerCli),
 	}

internal/commands/root.go

@@ -4,9 +4,7 @@ import (
 	"fmt"
 
 	"github.com/deislabs/duffle/pkg/action"
-	"github.com/deislabs/duffle/pkg/claim"
 	"github.com/deislabs/duffle/pkg/credentials"
-	"github.com/deislabs/duffle/pkg/utils/crud"
 	"github.com/docker/app/internal"
 	"github.com/docker/cli/cli"
 	"github.com/docker/cli/cli/command"
@@ -29,16 +27,19 @@ func statusCmd(dockerCli command.Cli) *cobra.Command {
 	return cmd
 }
 
-func runStatus(dockerCli command.Cli, claimName string, opts credentialOptions) error {
+func runStatus(dockerCli command.Cli, installationName string, opts credentialOptions) error {
 	defer muteDockerCli(dockerCli)()
-	h := duffleHome()
+	opts.SetDefaultTargetContext(dockerCli)
 
-	claimStore := claim.NewClaimStore(crud.NewFileSystemStore(h.Claims(), "json"))
-	c, err := claimStore.Read(claimName)
+	_, installationStore, credentialStore, err := prepareStores(opts.targetContext)
+	if err != nil {
+		return err
+	}
+
+	c, err := installationStore.Read(installationName)
 	if err != nil {
 		return err
 	}
-	opts.SetDefaultTargetContext(dockerCli)
 	bind, err := requiredClaimBindMount(c, opts.targetContext, dockerCli)
 	if err != nil {
 		return err
@@ -52,7 +53,7 @@ func runStatus(dockerCli command.Cli, claimName string, opts credentialOptions)
 	); err != nil {
 		return err
 	}
-	creds, err := prepareCredentialSet(c.Bundle, opts.CredentialSetOpts(dockerCli)...)
+	creds, err := prepareCredentialSet(c.Bundle, opts.CredentialSetOpts(dockerCli, credentialStore)...)
 	if err != nil {
 		return err
 	}