Move rootfs spec from garden-shed to guardian

So that it lives next to its interface method that depends on it. An example of the dependency inversion principle: high level interface modules should not depend on low-level implementation modules. This also helps us get rid of garden-shed eventually. [#154766812] Signed-off-by: Danail Branekov <[email protected]>
hpcloud · Feb 21, 2018 · f7e17c5 · f7e17c5
1 parent a65ff10
commit f7e17c5
Show file tree

Hide file tree

Showing 13 changed files with 41 additions and 40 deletions.
diff --git a/gardener/gardenerfakes/fake_volume_creator.go b/gardener/gardenerfakes/fake_volume_creator.go
diff --git a/gardener/noop_volumizer.go b/gardener/noop_volumizer.go
@@ -6,15 +6,14 @@ import (
 	specs "github.com/opencontainers/runtime-spec/specs-go"
 
 	"code.cloudfoundry.org/garden"
-	"code.cloudfoundry.org/garden-shed/rootfs_spec"
 	"code.cloudfoundry.org/lager"
 )
 
 type NoopVolumizer struct{}
 
 var ErrGraphDisabled = errors.New("volume graph is disabled")
 
-func (NoopVolumizer) Create(lager.Logger, string, rootfs_spec.Spec) (specs.Spec, error) {
+func (NoopVolumizer) Create(lager.Logger, string, RootfsSpec) (specs.Spec, error) {
 	return specs.Spec{}, ErrGraphDisabled
 }
 

diff --git a/gardener/noop_volumizer_test.go b/gardener/noop_volumizer_test.go
@@ -2,7 +2,6 @@ package gardener_test
 
 import (
 	"code.cloudfoundry.org/garden"
-	"code.cloudfoundry.org/garden-shed/rootfs_spec"
 	"code.cloudfoundry.org/guardian/gardener"
 	"code.cloudfoundry.org/lager/lagertest"
 
@@ -23,7 +22,7 @@ var _ = Describe("NoopVolumizer", func() {
 
 	Describe("Create", func() {
 		It("returns ErrGraphDisabled", func() {
-			_, err := volumizer.Create(logger, "some-handle", rootfs_spec.Spec{})
+			_, err := volumizer.Create(logger, "some-handle", gardener.RootfsSpec{})
 			Expect(err).To(Equal(gardener.ErrGraphDisabled))
 		})
 	})

diff --git a/gardener/volume_provider.go b/gardener/volume_provider.go
@@ -8,7 +8,6 @@ import (
 
 	"code.cloudfoundry.org/commandrunner"
 	"code.cloudfoundry.org/garden"
-	"code.cloudfoundry.org/garden-shed/rootfs_spec"
 	"code.cloudfoundry.org/lager"
 	specs "github.com/opencontainers/runtime-spec/specs-go"
 )
@@ -38,7 +37,17 @@ func NewVolumeProvider(creator VolumeCreator, manager VolumeDestroyMetricsGC, pr
 }
 
 type VolumeCreator interface {
-	Create(log lager.Logger, handle string, spec rootfs_spec.Spec) (specs.Spec, error)
+	Create(log lager.Logger, handle string, spec RootfsSpec) (specs.Spec, error)
+}
+
+// TODO GoRename RootfsSpec
+type RootfsSpec struct {
+	RootFS     *url.URL
+	Username   string `json:"-"`
+	Password   string `json:"-"`
+	Namespaced bool
+	QuotaSize  int64
+	QuotaScope garden.DiskLimitScope
 }
 
 func (v *VolumeProvider) Create(log lager.Logger, spec garden.ContainerSpec) (specs.Spec, error) {
@@ -60,7 +69,7 @@ func (v *VolumeProvider) Create(log lager.Logger, spec garden.ContainerSpec) (sp
 		baseConfig.Process = &specs.Process{}
 	} else {
 		var err error
-		baseConfig, err = v.VolumeCreator.Create(log.Session("volume-creator"), spec.Handle, rootfs_spec.Spec{
+		baseConfig, err = v.VolumeCreator.Create(log.Session("volume-creator"), spec.Handle, RootfsSpec{
 			RootFS:     rootFSURL,
 			Username:   spec.Image.Username,
 			Password:   spec.Image.Password,

diff --git a/gardener/volume_provider_test.go b/gardener/volume_provider_test.go
@@ -9,7 +9,6 @@ import (
 
 	"code.cloudfoundry.org/commandrunner/fake_command_runner"
 	"code.cloudfoundry.org/garden"
-	"code.cloudfoundry.org/garden-shed/rootfs_spec"
 	"code.cloudfoundry.org/guardian/gardener"
 	fakes "code.cloudfoundry.org/guardian/gardener/gardenerfakes"
 	"code.cloudfoundry.org/lager"
@@ -107,7 +106,7 @@ var _ = Describe("VolumeProvider", func() {
 
 					parsedRootFS, err := url.Parse("docker:///alpine")
 					Expect(err).NotTo(HaveOccurred())
-					Expect(rootfsSpec).To(Equal(rootfs_spec.Spec{
+					Expect(rootfsSpec).To(Equal(gardener.RootfsSpec{
 						RootFS:     parsedRootFS,
 						Username:   "cakeuser",
 						Password:   "cakepassword",

diff --git a/imageplugin/default_command_creator.go b/imageplugin/default_command_creator.go
@@ -9,7 +9,7 @@ import (
 	specs "github.com/opencontainers/runtime-spec/specs-go"
 
 	"code.cloudfoundry.org/garden"
-	"code.cloudfoundry.org/garden-shed/rootfs_spec"
+	"code.cloudfoundry.org/guardian/gardener"
 	"code.cloudfoundry.org/lager"
 )
 
@@ -18,7 +18,7 @@ type DefaultCommandCreator struct {
 	ExtraArgs []string
 }
 
-func (cc *DefaultCommandCreator) CreateCommand(log lager.Logger, handle string, spec rootfs_spec.Spec) (*exec.Cmd, error) {
+func (cc *DefaultCommandCreator) CreateCommand(log lager.Logger, handle string, spec gardener.RootfsSpec) (*exec.Cmd, error) {
 	args := append(cc.ExtraArgs, "create")
 
 	if spec.QuotaSize > 0 {

diff --git a/imageplugin/default_command_creator_test.go b/imageplugin/default_command_creator_test.go
@@ -5,7 +5,7 @@ import (
 	"os/exec"
 
 	"code.cloudfoundry.org/garden"
-	"code.cloudfoundry.org/garden-shed/rootfs_spec"
+	"code.cloudfoundry.org/guardian/gardener"
 	"code.cloudfoundry.org/guardian/imageplugin"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
@@ -33,13 +33,13 @@ var _ = Describe("DefaultCommandCreator", func() {
 	Describe("CreateCommand", func() {
 		var (
 			createCmd *exec.Cmd
-			spec      rootfs_spec.Spec
+			spec      gardener.RootfsSpec
 		)
 
 		BeforeEach(func() {
 			rootfsURL, err := url.Parse("/fake-registry/image")
 			Expect(err).NotTo(HaveOccurred())
-			spec = rootfs_spec.Spec{RootFS: rootfsURL}
+			spec = gardener.RootfsSpec{RootFS: rootfsURL}
 		})
 
 		JustBeforeEach(func() {

diff --git a/imageplugin/image_plugin.go b/imageplugin/image_plugin.go
@@ -11,7 +11,7 @@ import (
 
 	"code.cloudfoundry.org/commandrunner"
 	"code.cloudfoundry.org/garden"
-	"code.cloudfoundry.org/garden-shed/rootfs_spec"
+	"code.cloudfoundry.org/guardian/gardener"
 	"code.cloudfoundry.org/lager"
 	specs "github.com/opencontainers/runtime-spec/specs-go"
 	errorwrapper "github.com/pkg/errors"
@@ -22,7 +22,7 @@ const PreloadedPlusLayerScheme = "preloaded+layer"
 
 //go:generate counterfeiter . CommandCreator
 type CommandCreator interface {
-	CreateCommand(log lager.Logger, handle string, spec rootfs_spec.Spec) (*exec.Cmd, error)
+	CreateCommand(log lager.Logger, handle string, spec gardener.RootfsSpec) (*exec.Cmd, error)
 	DestroyCommand(log lager.Logger, handle string) *exec.Cmd
 	MetricsCommand(log lager.Logger, handle string) *exec.Cmd
 }
@@ -40,7 +40,7 @@ type ImagePlugin struct {
 	DefaultRootfs              string
 }
 
-func (p *ImagePlugin) Create(log lager.Logger, handle string, spec rootfs_spec.Spec) (specs.Spec, error) {
+func (p *ImagePlugin) Create(log lager.Logger, handle string, spec gardener.RootfsSpec) (specs.Spec, error) {
 	errs := func(err error, action string) (specs.Spec, error) {
 		return specs.Spec{}, errorwrapper.Wrap(err, action)
 	}

diff --git a/imageplugin/image_plugin_test.go b/imageplugin/image_plugin_test.go
@@ -9,7 +9,7 @@ import (
 
 	"code.cloudfoundry.org/commandrunner/fake_command_runner"
 	"code.cloudfoundry.org/garden"
-	"code.cloudfoundry.org/garden-shed/rootfs_spec"
+	"code.cloudfoundry.org/guardian/gardener"
 	"code.cloudfoundry.org/guardian/imageplugin"
 	fakes "code.cloudfoundry.org/guardian/imageplugin/imagepluginfakes"
 	"code.cloudfoundry.org/lager"
@@ -61,7 +61,7 @@ var _ = Describe("ImagePlugin", func() {
 			cmd *exec.Cmd
 
 			handle             string
-			rootfsProviderSpec rootfs_spec.Spec
+			rootfsProviderSpec gardener.RootfsSpec
 			rootfs             string
 			namespaced         bool
 
@@ -116,7 +116,7 @@ var _ = Describe("ImagePlugin", func() {
 
 			rootfsURL, err := url.Parse(rootfs)
 			Expect(err).NotTo(HaveOccurred())
-			rootfsProviderSpec = rootfs_spec.Spec{RootFS: rootfsURL, Namespaced: namespaced}
+			rootfsProviderSpec = gardener.RootfsSpec{RootFS: rootfsURL, Namespaced: namespaced}
 			baseRuntimeSpec, createErr = imagePlugin.Create(fakeLogger, handle, rootfsProviderSpec)
 		})
 

diff --git a/imageplugin/imagepluginfakes/fake_command_creator.go b/imageplugin/imagepluginfakes/fake_command_creator.go
diff --git a/imageplugin/not_implemented_command_creator.go b/imageplugin/not_implemented_command_creator.go
@@ -3,15 +3,15 @@ package imageplugin
 import (
 	"os/exec"
 
-	"code.cloudfoundry.org/garden-shed/rootfs_spec"
+	"code.cloudfoundry.org/guardian/gardener"
 	"code.cloudfoundry.org/lager"
 )
 
 type NotImplementedCommandCreator struct {
 	Err error
 }
 
-func (cc *NotImplementedCommandCreator) CreateCommand(log lager.Logger, handle string, spec rootfs_spec.Spec) (*exec.Cmd, error) {
+func (cc *NotImplementedCommandCreator) CreateCommand(log lager.Logger, handle string, spec gardener.RootfsSpec) (*exec.Cmd, error) {
 	return nil, cc.Err
 }
 

diff --git a/imageplugin/not_implemented_command_creator_test.go b/imageplugin/not_implemented_command_creator_test.go
@@ -3,7 +3,7 @@ package imageplugin_test
 import (
 	"errors"
 
-	"code.cloudfoundry.org/garden-shed/rootfs_spec"
+	"code.cloudfoundry.org/guardian/gardener"
 	"code.cloudfoundry.org/guardian/imageplugin"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
@@ -22,7 +22,7 @@ var _ = Describe("NotImplementedCommandCreator", func() {
 
 	Describe("CreateCommand", func() {
 		It("returns nil and provided error", func() {
-			cmd, err := notImplementedCommandCreator.CreateCommand(nil, "", rootfs_spec.Spec{})
+			cmd, err := notImplementedCommandCreator.CreateCommand(nil, "", gardener.RootfsSpec{})
 			Expect(cmd).To(BeNil())
 			Expect(err).To(MatchError(errors.New("NOT IMPLEMENTED")))
 		})

diff --git a/rundmc/execrunner/windows_execrunner_test.go b/rundmc/execrunner/windows_execrunner_test.go
@@ -14,12 +14,10 @@ import (
 	"code.cloudfoundry.org/commandrunner/fake_command_runner"
 	"code.cloudfoundry.org/garden"
 	"code.cloudfoundry.org/guardian/rundmc/execrunner"
-	"code.cloudfoundry.org/guardian/rundmc/runrunc"
 	"code.cloudfoundry.org/lager"
 	"code.cloudfoundry.org/lager/lagertest"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
-	specs "github.com/opencontainers/runtime-spec/specs-go"
 )
 
 var _ = Describe("DirectExecRunner", func() {
@@ -30,7 +28,6 @@ var _ = Describe("DirectExecRunner", func() {
 		runtimePath = "container-runtime-path"
 		cleanupFunc func() error
 
-		spec        *runrunc.PreparedSpec
 		process     garden.Process
 		processIO   garden.ProcessIO
 		runErr      error
@@ -60,7 +57,6 @@ var _ = Describe("DirectExecRunner", func() {
 
 	Describe("Run", func() {
 		JustBeforeEach(func() {
-			spec = &runrunc.PreparedSpec{Process: specs.Process{Cwd: "idiosyncratic-string"}}
 			process, runErr = execRunner.Run(
 				logger,
 				processID,