Allow package cache dir to be overriden for create/delete env commands

When the bosh cli deploys a bosh director, it typically has a cache
under "$HOME/.bosh/installations/<GUID>/packages".  This works fine if
you are compiling the CPI releases locally, as the same CPI release is
used both for creating the Director VM and for the Director VM to use to
create other VMs.

We want to be able to shorten the create-env time by using compiled CPI
releases.  For Ruby-based CPIs, the location on the filesystem of their
packages when they are invoked matters.  Since the CPI release is
compiled on stemcell, and is intended to be used on a Director VM, also
based on a stemcell, the Ruby-based CPIs NEED to be located in a
particular directory ("/var/vcap/packges") to function.

By allowing the bosh cli to use "/var/vcap/packages" as the package
cache directory, the create-env command can use the same compiled CPI as
the Director VM itself, with no modifications to the CPI.

[TPCF-9087]

Co-authored-by: Ming Xiao <ming.xiao@broadcom.com>
Co-authored-by: Nitin Ravindran <nitin.ravindran@broadcom.com>

Author: 3 people

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)

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{

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{}

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)

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
 }
 

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"`,

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)

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{},

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 {

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
 }