Merge pull request #658 from cloudfoundry/override-package-dir

selzoc · web-flow · commit 73b420221fb8 · 2024-08-13T13:56:50.000-07:00
Allow package cache dir to be overriden for create/delete env commands
diff --git a/cmd/cmd.go b/cmd/cmd.go
@@ -72,31 +72,31 @@ func (c Cmd) Execute() (cmdErr error) {
 
 	case *CreateEnvOpts:
 		envProvider := func(manifestPath string, statePath string, vars boshtpl.Variables, op patch.Op) DeploymentPreparer {
-			return NewEnvFactory(deps, manifestPath, statePath, vars, op, opts.RecreatePersistentDisks).Preparer()
+			return NewEnvFactory(deps, manifestPath, statePath, vars, op, opts.RecreatePersistentDisks, opts.PackageDir).Preparer()
 		}
 
 		stage := boshui.NewStage(deps.UI, deps.Time, deps.Logger)
 		return NewCreateEnvCmd(deps.UI, envProvider).Run(stage, *opts)
 
 	case *DeleteEnvOpts:
 		envProvider := func(manifestPath string, statePath string, vars boshtpl.Variables, op patch.Op) DeploymentDeleter {
-			return NewEnvFactory(deps, manifestPath, statePath, vars, op, false).Deleter()
+			return NewEnvFactory(deps, manifestPath, statePath, vars, op, false, opts.PackageDir).Deleter()
 		}
 
 		stage := boshui.NewStage(deps.UI, deps.Time, deps.Logger)
 		return NewDeleteEnvCmd(deps.UI, envProvider).Run(stage, *opts)
 
 	case *StopEnvOpts:
 		envProvider := func(manifestPath string, statePath string, vars boshtpl.Variables, op patch.Op) DeploymentStateManager {
-			return NewEnvFactory(deps, manifestPath, statePath, vars, op, false).StateManager()
+			return NewEnvFactory(deps, manifestPath, statePath, vars, op, false, "").StateManager()
 		}
 
 		stage := boshui.NewStage(deps.UI, deps.Time, deps.Logger)
 		return NewStopEnvCmd(deps.UI, envProvider).Run(stage, *opts)
 
 	case *StartEnvOpts:
 		envProvider := func(manifestPath string, statePath string, vars boshtpl.Variables, op patch.Op) DeploymentStateManager {
-			return NewEnvFactory(deps, manifestPath, statePath, vars, op, false).StateManager()
+			return NewEnvFactory(deps, manifestPath, statePath, vars, op, false, "").StateManager()
 		}
 
 		stage := boshui.NewStage(deps.UI, deps.Time, deps.Logger)
diff --git a/cmd/create_env_test.go b/cmd/create_env_test.go
@@ -347,6 +347,7 @@ var _ = Describe("CreateEnvCmd", func() {
 					deploymentStateService,
 					fakeInstallationUUIDGenerator,
 					filepath.Join("fake-install-dir"),
+					"",
 				)
 				tempRootConfigurator := cmd.NewTempRootConfigurator(fs)
 
@@ -418,7 +419,7 @@ var _ = Describe("CreateEnvCmd", func() {
 			fakeInstallationParser.ParseManifest = installationManifest
 
 			installationPath := filepath.Join("fake-install-dir", "fake-installation-id")
-			target := biinstall.NewTarget(installationPath)
+			target := biinstall.NewTarget(installationPath, "")
 
 			installedJob := biinstall.NewInstalledJob(
 				biinstall.RenderedJobRef{
diff --git a/cmd/deployment_deleter_test.go b/cmd/deployment_deleter_test.go
@@ -193,7 +193,7 @@ cloud_provider:
 				},
 			}
 
-			target := biinstall.NewTarget(filepath.Join("fake-install-dir", "fake-installation-id"))
+			target := biinstall.NewTarget(filepath.Join("fake-install-dir", "fake-installation-id"), "")
 			mockInstallerFactory.EXPECT().NewInstaller(target).Return(mockCpiInstaller).AnyTimes()
 
 			expectCPIInstall = mockCpiInstaller.EXPECT().Install(installationManifest, gomock.Any()).Do(func(_ biinstallmanifest.Manifest, stage boshui.Stage) {
@@ -229,6 +229,7 @@ cloud_provider:
 				deploymentStateService,
 				fakeInstallationUUIDGenerator,
 				filepath.Join("fake-install-dir"),
+				"",
 			)
 
 			tempRootConfigurator := cmd.NewTempRootConfigurator(fs)
@@ -536,7 +537,7 @@ cloud_provider:
 					},
 				}
 
-				target := biinstall.NewTarget(filepath.Join("fake-install-dir", "fake-installation-id"))
+				target := biinstall.NewTarget(filepath.Join("fake-install-dir", "fake-installation-id"), "")
 				mockInstallerFactory.EXPECT().NewInstaller(target).Return(mockCpiInstaller).AnyTimes()
 
 				fakeInstallation := &fakecmd.FakeInstallation{}
diff --git a/cmd/env_factory.go b/cmd/env_factory.go
@@ -71,6 +71,7 @@ func NewEnvFactory(
 	manifestVars boshtpl.Variables,
 	manifestOp patch.Op,
 	recreatePersistentDisks bool,
+	packageDir string,
 ) *envFactory {
 	f := envFactory{
 		deps:         deps,
@@ -126,7 +127,7 @@ func NewEnvFactory(
 	}
 
 	f.targetProvider = boshinst.NewTargetProvider(
-		f.deploymentStateService, deps.UUIDGen, filepath.Join(workspaceRootPath, "installations"))
+		f.deploymentStateService, deps.UUIDGen, filepath.Join(workspaceRootPath, "installations"), packageDir)
 
 	{
 		diskRepo := biconfig.NewDiskRepo(f.deploymentStateService, deps.UUIDGen)
diff --git a/cmd/opts/opts.go b/cmd/opts/opts.go
@@ -197,6 +197,7 @@ type CreateEnvOpts struct {
 	StatePath               string `long:"state" value-name:"PATH" description:"State file path"`
 	Recreate                bool   `long:"recreate" description:"Recreate VM in deployment"`
 	RecreatePersistentDisks bool   `long:"recreate-persistent-disks" description:"Recreate persistent disks in the deployment"`
+	PackageDir              string `long:"package-dir" value-name:"DIR" description:"Package cache location override"`
 	cmd
 }
 
@@ -208,8 +209,9 @@ type DeleteEnvOpts struct {
 	Args DeleteEnvArgs `positional-args:"true" required:"true"`
 	VarFlags
 	OpsFlags
-	SkipDrain bool   `long:"skip-drain" description:"Skip running drain and pre-stop scripts"`
-	StatePath string `long:"state" value-name:"PATH" description:"State file path"`
+	SkipDrain  bool   `long:"skip-drain" description:"Skip running drain and pre-stop scripts"`
+	StatePath  string `long:"state" value-name:"PATH" description:"State file path"`
+	PackageDir string `long:"package-dir" value-name:"DIR" description:"Package cache location override"`
 	cmd
 }
 
diff --git a/cmd/opts/opts_test.go b/cmd/opts/opts_test.go
@@ -845,6 +845,12 @@ var _ = Describe("Opts", func() {
 			))
 		})
 
+		It("has --package-dir", func() {
+			Expect(getStructTagForName("PackageDir", opts)).To(Equal(
+				`long:"package-dir" value-name:"DIR" description:"Package cache location override"`,
+			))
+		})
+
 		It("has --recreate", func() {
 			Expect(getStructTagForName("Recreate", opts)).To(Equal(
 				`long:"recreate" description:"Recreate VM in deployment"`,
@@ -899,6 +905,12 @@ var _ = Describe("Opts", func() {
 			))
 		})
 
+		It("has --package-dir", func() {
+			Expect(getStructTagForName("PackageDir", opts)).To(Equal(
+				`long:"package-dir" value-name:"DIR" description:"Package cache location override"`,
+			))
+		})
+
 		It("has --skip-drain", func() {
 			Expect(getStructTagForName("SkipDrain", opts)).To(Equal(
 				`long:"skip-drain" description:"Skip running drain and pre-stop scripts"`,
diff --git a/cpi/release/installer_test.go b/cpi/release/installer_test.go
@@ -46,7 +46,7 @@ var _ = Describe("Installer", func() {
 			installStage = fakeui.NewFakeStage()
 			installation = mocks.NewMockInstallation(mockCtrl)
 
-			target = biinstallation.NewTarget("fake-installation-path")
+			target = biinstallation.NewTarget("fake-installation-path", "")
 			mockInstallerFactory.EXPECT().NewInstaller(target).Return(mockInstaller).AnyTimes()
 			expectInstall = mockInstaller.EXPECT().Install(installationManifest, gomock.Any())
 			expectCleanup = mockInstaller.EXPECT().Cleanup(installation).Return(nil)
diff --git a/installation/installer_test.go b/installation/installer_test.go
@@ -50,7 +50,7 @@ var _ = Describe("Installer", func() {
 		mockPackageCompiler = mock_install.NewMockPackageCompiler(mockCtrl)
 		fakeExtractor = &blobextractfakes.FakeExtractor{}
 
-		target = NewTarget("fake-installation-path")
+		target = NewTarget("fake-installation-path", "")
 		installationManifest = biinstallmanifest.Manifest{
 			Name:       "fake-installation-name",
 			Properties: biproperty.Map{},
diff --git a/installation/target.go b/installation/target.go
@@ -5,12 +5,14 @@ import (
 )
 
 type Target struct {
-	path string
+	path       string
+	packageDir string
 }
 
-func NewTarget(path string) Target {
+func NewTarget(path string, packageDir string) Target {
 	return Target{
 		path,
+		packageDir,
 	}
 }
 
@@ -31,7 +33,11 @@ func (t Target) TemplatesIndexPath() string {
 }
 
 func (t Target) PackagesPath() string {
-	return filepath.Join(t.path, "packages")
+	if t.packageDir != "" {
+		return t.packageDir
+	} else {
+		return filepath.Join(t.path, "packages")
+	}
 }
 
 func (t Target) JobsPath() string {
diff --git a/installation/target_provider.go b/installation/target_provider.go
@@ -17,17 +17,20 @@ type targetProvider struct {
 	deploymentStateService biconfig.DeploymentStateService
 	uuidGenerator          boshuuid.Generator
 	installationsRootPath  string
+	packageDir             string
 }
 
 func NewTargetProvider(
 	deploymentStateService biconfig.DeploymentStateService,
 	uuidGenerator boshuuid.Generator,
 	installationsRootPath string,
+	packageDir string,
 ) TargetProvider {
 	return &targetProvider{
 		deploymentStateService: deploymentStateService,
 		uuidGenerator:          uuidGenerator,
 		installationsRootPath:  installationsRootPath,
+		packageDir:             packageDir,
 	}
 }
 
@@ -51,5 +54,5 @@ func (p *targetProvider) NewTarget() (Target, error) {
 		}
 	}
 
-	return NewTarget(filepath.Join(p.installationsRootPath, installationID)), nil
+	return NewTarget(filepath.Join(p.installationsRootPath, installationID), p.packageDir), nil
 }
diff --git a/installation/target_provider_test.go b/installation/target_provider_test.go
@@ -36,7 +36,24 @@ var _ = Describe("TargetProvider", func() {
 			logger,
 			configPath,
 		)
-		targetProvider = NewTargetProvider(deploymentStateService, fakeUUIDGenerator, installationsRootPath)
+		targetProvider = NewTargetProvider(deploymentStateService, fakeUUIDGenerator, installationsRootPath, "")
+	})
+
+	Context("when a packageDir is passed in", func() {
+		var packageDir string
+
+		BeforeEach(func() {
+			packageDir = "/some/good/dir"
+
+			targetProvider = NewTargetProvider(deploymentStateService, fakeUUIDGenerator, installationsRootPath, packageDir)
+		})
+
+		It("is passed through to the target", func() {
+			target, err := targetProvider.NewTarget()
+			Expect(err).ToNot(HaveOccurred())
+
+			Expect(target.PackagesPath()).To(Equal(packageDir))
+		})
 	})
 
 	Context("when the installation_id exists in the deployment state", func() {
diff --git a/installation/target_test.go b/installation/target_test.go
@@ -13,7 +13,7 @@ var _ = Describe("Target", func() {
 	Describe("Paths", func() {
 		var target Target
 		BeforeEach(func() {
-			target = NewTarget("/home/fake/madcow")
+			target = NewTarget("/home/fake/madcow", "")
 		})
 
 		It("returns the blobstore path", func() {
@@ -28,8 +28,22 @@ var _ = Describe("Target", func() {
 			Expect(target.TemplatesIndexPath()).To(Equal(filepath.Join("/", "home", "fake", "madcow", "templates.json")))
 		})
 
-		It("returns the packages path", func() {
-			Expect(target.PackagesPath()).To(Equal(filepath.Join("/", "home", "fake", "madcow", "packages")))
+		Context("packageDir is NOT provided", func() {
+			It("returns the packages path as a subdirectory of the path", func() {
+				Expect(target.PackagesPath()).To(Equal(filepath.Join("/", "home", "fake", "madcow", "packages")))
+			})
+		})
+
+		Context("packageDir is provided", func() {
+			var packagesDir string
+			BeforeEach(func() {
+				packagesDir = "/some/good/path"
+				target = NewTarget("/home/fake/madcow", packagesDir)
+			})
+
+			It("returns the provided packages path", func() {
+				Expect(target.PackagesPath()).To(Equal(packagesDir))
+			})
 		})
 
 		It("returns the temp path", func() {
diff --git a/installation/uninstaller_test.go b/installation/uninstaller_test.go
@@ -30,7 +30,7 @@ var _ = Describe("Uninstaller", func() {
 			err = fs.WriteFileString(filepath.Join(installationPath, "some-installation-artifact"), "something-blah")
 			Expect(err).ToNot(HaveOccurred())
 
-			installationTarget := installation.NewTarget(installationPath)
+			installationTarget := installation.NewTarget(installationPath, "")
 
 			uninstaller := installation.NewUninstaller(fs, boshlogger)
 
@@ -53,7 +53,7 @@ var _ = Describe("Uninstaller", func() {
 				return errors.New("can't remove that")
 			}
 
-			installationTarget := installation.NewTarget("/not/a/path")
+			installationTarget := installation.NewTarget("/not/a/path", "")
 
 			uninstaller := installation.NewUninstaller(fs, boshlogger)
 
diff --git a/integration/create_env_test.go b/integration/create_env_test.go
@@ -302,7 +302,7 @@ cloud_provider:
 				Properties: biproperty.Map{},
 			}
 			installationPath := filepath.Join("fake-install-dir", "fake-installation-id")
-			target := biinstall.NewTarget(installationPath)
+			target := biinstall.NewTarget(installationPath, "")
 
 			installedJob := biinstall.InstalledJob{}
 			installedJob.Name = "fake-cpi-release-job-name"
@@ -450,6 +450,7 @@ cloud_provider:
 					deploymentStateService,
 					installationUuidGenerator,
 					filepath.Join("fake-install-dir"),
+					"",
 				)
 
 				tempRootConfigurator := cmd.NewTempRootConfigurator(fs)

Original file line number	Diff line number	Diff line change
`@@ -193,7 +193,7 @@ cloud_provider:`
`193`	`193`	`},`
`194`	`194`	`}`
`195`	`195`
`196`		`- target := biinstall.NewTarget(filepath.Join("fake-install-dir", "fake-installation-id"))`
	`196`	`+ target := biinstall.NewTarget(filepath.Join("fake-install-dir", "fake-installation-id"), "")`
`197`	`197`	`mockInstallerFactory.EXPECT().NewInstaller(target).Return(mockCpiInstaller).AnyTimes()`
`198`	`198`
`199`	`199`	`expectCPIInstall = mockCpiInstaller.EXPECT().Install(installationManifest, gomock.Any()).Do(func(_ biinstallmanifest.Manifest, stage boshui.Stage) {`
`@@ -229,6 +229,7 @@ cloud_provider:`
`229`	`229`	`deploymentStateService,`
`230`	`230`	`fakeInstallationUUIDGenerator,`
`231`	`231`	`filepath.Join("fake-install-dir"),`
	`232`	`+ "",`
`232`	`233`	`)`
`233`	`234`
`234`	`235`	`tempRootConfigurator := cmd.NewTempRootConfigurator(fs)`
`@@ -536,7 +537,7 @@ cloud_provider:`
`536`	`537`	`},`
`537`	`538`	`}`
`538`	`539`
`539`		`- target := biinstall.NewTarget(filepath.Join("fake-install-dir", "fake-installation-id"))`
	`540`	`+ target := biinstall.NewTarget(filepath.Join("fake-install-dir", "fake-installation-id"), "")`
`540`	`541`	`mockInstallerFactory.EXPECT().NewInstaller(target).Return(mockCpiInstaller).AnyTimes()`
`541`	`542`
`542`	`543`	`fakeInstallation := &fakecmd.FakeInstallation{}`
Original file line number	Diff line number	Diff line change
`@@ -71,6 +71,7 @@ func NewEnvFactory(`
`71`	`71`	`manifestVars boshtpl.Variables,`
`72`	`72`	`manifestOp patch.Op,`
`73`	`73`	`recreatePersistentDisks bool,`
	`74`	`+ packageDir string,`
`74`	`75`	`) *envFactory {`
`75`	`76`	`f := envFactory{`
`76`	`77`	`deps: deps,`
`@@ -126,7 +127,7 @@ func NewEnvFactory(`
`126`	`127`	`}`
`127`	`128`
`128`	`129`	`f.targetProvider = boshinst.NewTargetProvider(`
`129`		`- f.deploymentStateService, deps.UUIDGen, filepath.Join(workspaceRootPath, "installations"))`
	`130`	`+ f.deploymentStateService, deps.UUIDGen, filepath.Join(workspaceRootPath, "installations"), packageDir)`
`130`	`131`
`131`	`132`	`{`
`132`	`133`	`diskRepo := biconfig.NewDiskRepo(f.deploymentStateService, deps.UUIDGen)`
Original file line number	Diff line number	Diff line change
`@@ -5,12 +5,14 @@ import (`
`5`	`5`	`)`
`6`	`6`
`7`	`7`	`type Target struct {`
`8`		`- path string`
	`8`	`+ path string`
	`9`	`+ packageDir string`
`9`	`10`	`}`
`10`	`11`
`11`		`-func NewTarget(path string) Target {`
	`12`	`+func NewTarget(path string, packageDir string) Target {`
`12`	`13`	`return Target{`
`13`	`14`	`path,`
	`15`	`+ packageDir,`
`14`	`16`	`}`
`15`	`17`	`}`
`16`	`18`
`@@ -31,7 +33,11 @@ func (t Target) TemplatesIndexPath() string {`
`31`	`33`	`}`
`32`	`34`
`33`	`35`	`func (t Target) PackagesPath() string {`
`34`		`- return filepath.Join(t.path, "packages")`
	`36`	`+ if t.packageDir != "" {`
	`37`	`+ return t.packageDir`
	`38`	`+ } else {`
	`39`	`+ return filepath.Join(t.path, "packages")`
	`40`	`+ }`
`35`	`41`	`}`
`36`	`42`
`37`	`43`	`func (t Target) JobsPath() string {`
Original file line number	Diff line number	Diff line change
`@@ -17,17 +17,20 @@ type targetProvider struct {`
`17`	`17`	`deploymentStateService biconfig.DeploymentStateService`
`18`	`18`	`uuidGenerator boshuuid.Generator`
`19`	`19`	`installationsRootPath string`
	`20`	`+ packageDir string`
`20`	`21`	`}`
`21`	`22`
`22`	`23`	`func NewTargetProvider(`
`23`	`24`	`deploymentStateService biconfig.DeploymentStateService,`
`24`	`25`	`uuidGenerator boshuuid.Generator,`
`25`	`26`	`installationsRootPath string,`
	`27`	`+ packageDir string,`
`26`	`28`	`) TargetProvider {`
`27`	`29`	`return &targetProvider{`
`28`	`30`	`deploymentStateService: deploymentStateService,`
`29`	`31`	`uuidGenerator: uuidGenerator,`
`30`	`32`	`installationsRootPath: installationsRootPath,`
	`33`	`+ packageDir: packageDir,`
`31`	`34`	`}`
`32`	`35`	`}`
`33`	`36`
`@@ -51,5 +54,5 @@ func (p *targetProvider) NewTarget() (Target, error) {`
`51`	`54`	`}`
`52`	`55`	`}`
`53`	`56`
`54`		`- return NewTarget(filepath.Join(p.installationsRootPath, installationID)), nil`
	`57`	`+ return NewTarget(filepath.Join(p.installationsRootPath, installationID), p.packageDir), nil`
`55`	`58`	`}`