Move Service and Context to their own package.

vdemeester · vdemeester · commit b42d13926e22 · 2016-08-19T20:21:38.000+02:00
- `service` package holds service related struct and methods. It's just
  a move, stuff like `Namer` should be moved away from this package and
  refactor in a way they don't call the docker API (e.g).
- `ctx` holds the `Context` struct used to pass factory and stuff :)

Signed-off-by: Vincent Demeester &lt;vincent@sbr.pm&gt;
diff --git a/cli/docker/app/commands.go b/cli/docker/app/commands.go
@@ -3,8 +3,8 @@ package app
 import (
 	"github.com/Sirupsen/logrus"
 	"github.com/docker/libcompose/cli/command"
-	"github.com/docker/libcompose/docker"
 	"github.com/docker/libcompose/docker/client"
+	"github.com/docker/libcompose/docker/ctx"
 	"github.com/urfave/cli"
 )
 
@@ -41,7 +41,7 @@ func DockerClientFlags() []cli.Flag {
 }
 
 // Populate updates the specified docker context based on command line arguments and subcommands.
-func Populate(context *docker.Context, c *cli.Context) {
+func Populate(context *ctx.Context, c *cli.Context) {
 	command.Populate(&context.Context, c)
 
 	context.ConfigDir = c.String("configdir")
diff --git a/cli/docker/app/factory.go b/cli/docker/app/factory.go
@@ -3,6 +3,7 @@ package app
 import (
 	"github.com/docker/libcompose/cli/logger"
 	"github.com/docker/libcompose/docker"
+	"github.com/docker/libcompose/docker/ctx"
 	"github.com/docker/libcompose/project"
 	"github.com/urfave/cli"
 )
@@ -13,7 +14,7 @@ type ProjectFactory struct {
 
 // Create implements ProjectFactory.Create using docker client.
 func (p *ProjectFactory) Create(c *cli.Context) (project.APIProject, error) {
-	context := &docker.Context{}
+	context := &ctx.Context{}
 	context.LoggerFactory = logger.NewColorLoggerFactory()
 	Populate(context, c)
 	return docker.NewProject(context, nil)
diff --git a/docker/ctx/context.go b/docker/ctx/context.go
@@ -1,4 +1,4 @@
-package docker
+package ctx
 
 import (
 	"github.com/docker/docker/cliconfig"
@@ -18,10 +18,6 @@ type Context struct {
 	AuthLookup    auth.Lookup
 }
 
-func (c *Context) open() error {
-	return c.LookupConfig()
-}
-
 // LookupConfig tries to load the docker configuration files, if any.
 func (c *Context) LookupConfig() error {
 	if c.ConfigFile != nil {
diff --git a/docker/project.go b/docker/project.go
@@ -12,18 +12,17 @@ import (
 	"github.com/docker/libcompose/config"
 	"github.com/docker/libcompose/docker/auth"
 	"github.com/docker/libcompose/docker/client"
+	"github.com/docker/libcompose/docker/ctx"
 	"github.com/docker/libcompose/docker/network"
+	"github.com/docker/libcompose/docker/service"
 	"github.com/docker/libcompose/docker/volume"
 	"github.com/docker/libcompose/labels"
 	"github.com/docker/libcompose/lookup"
 	"github.com/docker/libcompose/project"
 )
 
-// ComposeVersion is name of docker-compose.yml file syntax supported version
-const ComposeVersion = "1.5.0"
-
 // NewProject creates a Project with the specified context.
-func NewProject(context *Context, parseOptions *config.ParseOptions) (project.APIProject, error) {
+func NewProject(context *ctx.Context, parseOptions *config.ParseOptions) (project.APIProject, error) {
 	if context.ResourceLookup == nil {
 		context.ResourceLookup = &lookup.FileResourceLookup{}
 	}
@@ -48,9 +47,7 @@ func NewProject(context *Context, parseOptions *config.ParseOptions) (project.AP
 	}
 
 	if context.ServiceFactory == nil {
-		context.ServiceFactory = &ServiceFactory{
-			context: context,
-		}
+		context.ServiceFactory = service.NewFactory(context)
 	}
 
 	if context.ClientFactory == nil {
@@ -86,7 +83,7 @@ func NewProject(context *Context, parseOptions *config.ParseOptions) (project.AP
 		return nil, err
 	}
 
-	if err = context.open(); err != nil {
+	if err = context.LookupConfig(); err != nil {
 		logrus.Errorf("Failed to open project %s: %v", p.Name, err)
 		return nil, err
 	}
diff --git a/docker/service/convert.go b/docker/service/convert.go
@@ -1,4 +1,4 @@
-package docker
+package service
 
 import (
 	"fmt"
diff --git a/docker/service/convert_test.go b/docker/service/convert_test.go
@@ -1,10 +1,11 @@
-package docker
+package service
 
 import (
 	"path/filepath"
 	"testing"
 
 	"github.com/docker/libcompose/config"
+	"github.com/docker/libcompose/docker/ctx"
 	"github.com/docker/libcompose/lookup"
 	"github.com/docker/libcompose/yaml"
 	shlex "github.com/flynn/go-shlex"
@@ -19,7 +20,7 @@ func TestParseCommand(t *testing.T) {
 }
 
 func TestParseBindsAndVolumes(t *testing.T) {
-	ctx := &Context{}
+	ctx := &ctx.Context{}
 	ctx.ComposeFiles = []string{"foo/docker-compose.yml"}
 	ctx.ResourceLookup = &lookup.FileResourceLookup{}
 
@@ -56,7 +57,7 @@ func TestParseBindsAndVolumes(t *testing.T) {
 }
 
 func TestParseLabels(t *testing.T) {
-	ctx := &Context{}
+	ctx := &ctx.Context{}
 	ctx.ComposeFiles = []string{"foo/docker-compose.yml"}
 	ctx.ResourceLookup = &lookup.FileResourceLookup{}
 	bashCmd := "bash"
diff --git a/docker/service/name.go b/docker/service/name.go
@@ -1,4 +1,4 @@
-package docker
+package service
 
 import (
 	"fmt"
diff --git a/docker/service/name_test.go b/docker/service/name_test.go
@@ -1,4 +1,4 @@
-package docker
+package service
 
 import (
 	"fmt"
diff --git a/docker/service/service.go b/docker/service/service.go
@@ -1,4 +1,4 @@
-package docker
+package service
 
 import (
 	"fmt"
@@ -19,6 +19,7 @@ import (
 	"github.com/docker/libcompose/docker/builder"
 	composeclient "github.com/docker/libcompose/docker/client"
 	"github.com/docker/libcompose/docker/container"
+	"github.com/docker/libcompose/docker/ctx"
 	"github.com/docker/libcompose/docker/image"
 	"github.com/docker/libcompose/labels"
 	"github.com/docker/libcompose/project"
@@ -38,11 +39,11 @@ type Service struct {
 	authLookup    auth.Lookup
 
 	// FIXME(vdemeester) remove this at some point
-	context *Context
+	context *ctx.Context
 }
 
 // NewService creates a service
-func NewService(name string, serviceConfig *config.ServiceConfig, context *Context) *Service {
+func NewService(name string, serviceConfig *config.ServiceConfig, context *ctx.Context) *Service {
 	return &Service{
 		name:          name,
 		project:       context.Project,
diff --git a/docker/service/service_create.go b/docker/service/service_create.go
@@ -1,4 +1,4 @@
-package docker
+package service
 
 import (
 	"fmt"
@@ -38,7 +38,7 @@ func (s *Service) createContainer(ctx context.Context, namer Namer, oldContainer
 	configWrapper.Config.Labels[labels.HASH.Str()] = config.GetServiceHash(s.name, serviceConfig)
 	configWrapper.Config.Labels[labels.ONEOFF.Str()] = strings.Title(strconv.FormatBool(oneOff))
 	configWrapper.Config.Labels[labels.NUMBER.Str()] = fmt.Sprintf("%d", containerNumber)
-	configWrapper.Config.Labels[labels.VERSION.Str()] = ComposeVersion
+	configWrapper.Config.Labels[labels.VERSION.Str()] = project.ComposeVersion
 
 	err = s.populateAdditionalHostConfig(configWrapper.HostConfig)
 	if err != nil {
diff --git a/docker/service/service_factory.go b/docker/service/service_factory.go
@@ -0,0 +1,24 @@
+package service
+
+import (
+	"github.com/docker/libcompose/config"
+	"github.com/docker/libcompose/docker/ctx"
+	"github.com/docker/libcompose/project"
+)
+
+// Factory is an implementation of project.ServiceFactory.
+type Factory struct {
+	context *ctx.Context
+}
+
+// NewFactory creates a new service factory for the given context
+func NewFactory(context *ctx.Context) *Factory {
+	return &Factory{
+		context: context,
+	}
+}
+
+// Create creates a Service based on the specified project, name and service configuration.
+func (s *Factory) Create(project *project.Project, name string, serviceConfig *config.ServiceConfig) (project.Service, error) {
+	return NewService(name, serviceConfig, s.context), nil
+}
diff --git a/docker/service/service_test.go b/docker/service/service_test.go
@@ -1,4 +1,4 @@
-package docker
+package service
 
 import (
 	"testing"
diff --git a/docker/service/utils.go b/docker/service/utils.go
@@ -1,4 +1,4 @@
-package docker
+package service
 
 import (
 	"github.com/docker/engine-api/types/container"
diff --git a/docker/service_factory.go b/docker/service_factory.go
diff --git a/integration/api_event_test.go b/integration/api_event_test.go
@@ -7,6 +7,7 @@ import (
 	check "gopkg.in/check.v1"
 
 	"github.com/docker/libcompose/docker"
+	"github.com/docker/libcompose/docker/ctx"
 	"github.com/docker/libcompose/project"
 	"github.com/docker/libcompose/project/events"
 	"github.com/docker/libcompose/project/options"
@@ -22,7 +23,7 @@ another:
   image: busybox:latest
   command: top
 `
-	project, err := docker.NewProject(&docker.Context{
+	project, err := docker.NewProject(&ctx.Context{
 		Context: project.Context{
 			ComposeBytes: [][]byte{[]byte(composeFile)},
 			ProjectName:  "test-api-events",
diff --git a/integration/api_test.go b/integration/api_test.go
@@ -6,6 +6,7 @@ import (
 	"golang.org/x/net/context"
 
 	"github.com/docker/libcompose/docker"
+	"github.com/docker/libcompose/docker/ctx"
 	"github.com/docker/libcompose/project"
 	"github.com/docker/libcompose/project/options"
 )
@@ -24,7 +25,7 @@ service:
   volumes:
     - /etc/selinux:/etc/selinux`
 
-	project, err := docker.NewProject(&docker.Context{
+	project, err := docker.NewProject(&ctx.Context{
 		Context: project.Context{
 			ComposeBytes: [][]byte{[]byte(service)},
 			ProjectName:  "test-volume-without-compose-file",
diff --git a/project/project.go b/project/project.go
@@ -15,6 +15,9 @@ import (
 	"github.com/docker/libcompose/yaml"
 )
 
+// ComposeVersion is name of docker-compose.yml file syntax supported version
+const ComposeVersion = "1.5.0"
+
 type wrapperAction func(*serviceWrapper, map[string]*serviceWrapper)
 type serviceAction func(service Service) error
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package docker`
	`1`	`+package service`
`2`	`2`
`3`	`3`	`import (`
`4`	`4`	`"fmt"`