builder_config_test.go

package buildpackapplifecycle_test

import (
	"path/filepath"

	"code.cloudfoundry.org/buildpackapplifecycle"
	. "github.com/onsi/ginkgo/v2"
	. "github.com/onsi/gomega"
)

var _ = Describe("LifecycleBuilderConfig", func() {
	var builderConfig buildpackapplifecycle.LifecycleBuilderConfig
	var skipDetect bool

	BeforeEach(func() {
		skipDetect = false
	})

	JustBeforeEach(func() {
		builderConfig = buildpackapplifecycle.NewLifecycleBuilderConfig([]string{"ocaml-buildpack", "haskell-buildpack", "bash-buildpack"}, skipDetect, false)
	})

	Context("with defaults", func() {
		It("generates a script for running its builder", func() {
			commandFlags := []string{
				"-buildDir=/tmp/app",
				"-buildpackOrder=ocaml-buildpack,haskell-buildpack,bash-buildpack",
				"-buildpacksDir=/tmp/buildpacks",
				"-buildpacksDownloadDir=/tmp/buildpackdownloads",
				"-buildArtifactsCacheDir=/tmp/cache",
				"-outputDroplet=/tmp/droplet",
				"-outputMetadata=/tmp/result.json",
				"-outputBuildArtifactsCache=/tmp/output-cache",
				"-skipCertVerify=false",
				"-skipDetect=false",
				"-credhubConnectAttempts=3",
				"-credhubRetryDelay=1s",
			}

			Expect(builderConfig.Path()).To(Equal(filepath.Join(pathPrefix(), "tmp", "lifecycle", "builder")))
			Expect(builderConfig.Args()).To(ConsistOf(commandFlags))
		})

		It("adds the correct prefix to config paths", func() {
			Expect(builderConfig.BuildDir()).To(Equal(filepath.Join(pathPrefix(), "tmp", "app")))
			Expect(builderConfig.BuildpacksDir()).To(Equal(filepath.Join(pathPrefix(), "tmp", "buildpacks")))
			Expect(builderConfig.BuildpacksDownloadDir()).To(Equal(filepath.Join(pathPrefix(), "tmp", "buildpackdownloads")))
			Expect(builderConfig.BuildArtifactsCacheDir()).To(Equal(filepath.Join(pathPrefix(), "tmp", "cache")))
			Expect(builderConfig.OutputDroplet()).To(Equal(filepath.Join(pathPrefix(), "tmp", "droplet")))
			Expect(builderConfig.OutputMetadata()).To(Equal(filepath.Join(pathPrefix(), "tmp", "result.json")))
			Expect(builderConfig.OutputBuildArtifactsCache()).To(Equal(filepath.Join(pathPrefix(), "tmp", "output-cache")))
		})
	})

	Context("with overrides", func() {
		BeforeEach(func() {
			skipDetect = true
		})

		JustBeforeEach(func() {
			builderConfig.Set("buildDir", "/some/build/dir")
			builderConfig.Set("outputDroplet", "/some/droplet")
			builderConfig.Set("outputMetadata", "/some/result-file")
			builderConfig.Set("buildpacksDir", "/some/buildpacks/dir")
			builderConfig.Set("buildpacksDownloadDir", "/some/downloads/dir")
			builderConfig.Set("buildArtifactsCacheDir", "/some/cache/dir")
			builderConfig.Set("outputBuildArtifactsCache", "/some/cache-file")
			builderConfig.Set("skipCertVerify", "true")
			builderConfig.Set("skipDetect", "true")
			builderConfig.Set("credhubConnectAttempts", "5")
			builderConfig.Set("credhubRetryDelay", "5s")
		})

		It("generates a script for running its builder", func() {
			commandFlags := []string{
				"-buildDir=/some/build/dir",
				"-buildpackOrder=ocaml-buildpack,haskell-buildpack,bash-buildpack",
				"-buildpacksDir=/some/buildpacks/dir",
				"-buildpacksDownloadDir=/some/downloads/dir",
				"-buildArtifactsCacheDir=/some/cache/dir",
				"-outputDroplet=/some/droplet",
				"-outputMetadata=/some/result-file",
				"-outputBuildArtifactsCache=/some/cache-file",
				"-skipCertVerify=true",
				"-skipDetect=true",
				"-credhubConnectAttempts=5",
				"-credhubRetryDelay=5s",
			}

			Expect(builderConfig.Path()).To(Equal(filepath.Join(pathPrefix(), "tmp", "lifecycle", "builder")))
			Expect(builderConfig.Args()).To(ConsistOf(commandFlags))
		})

		It("prepends the working directory to each directory path", func() {
			Expect(builderConfig.BuildDir()).To(Equal(filepath.Join(pathPrefix(), "some", "build", "dir")))
			Expect(builderConfig.BuildpacksDir()).To(Equal(filepath.Join(pathPrefix(), "some", "buildpacks", "dir")))
			Expect(builderConfig.BuildpacksDownloadDir()).To(Equal(filepath.Join(pathPrefix(), "some", "downloads", "dir")))
			Expect(builderConfig.BuildArtifactsCacheDir()).To(Equal(filepath.Join(pathPrefix(), "some", "cache", "dir")))
			Expect(builderConfig.OutputDroplet()).To(Equal(filepath.Join(pathPrefix(), "some", "droplet")))
			Expect(builderConfig.OutputMetadata()).To(Equal(filepath.Join(pathPrefix(), "some", "result-file")))
			Expect(builderConfig.OutputBuildArtifactsCache()).To(Equal(filepath.Join(pathPrefix(), "some", "cache-file")))
		})
	})

	Describe("LegacyBuildpackPath", func() {
		It("returns the path to a given system buildpack using legacy md5", func() {
			key := "my-buildpack/key/::"
			Expect(builderConfig.LegacyBuildpackPath(key)).To(Equal(filepath.Join(pathPrefix(), "tmp", "buildpacks", "8b2f72a0702aed614f8b5d8f7f5b431b")))
		})

		It("returns the path to a given downloaded buildpack using legacy md5", func() {
			key := "https://github.com/cloudfoundry/ruby-buildpack"
			Expect(builderConfig.LegacyBuildpackPath(key)).To(Equal(filepath.Join(pathPrefix(), "tmp", "buildpackdownloads", "21de62d118ecb1f46d868d24f00839ef")))
		})
	})

	Describe("BuildpackPath", func() {
		It("returns the path to a given system buildpack", func() {
			key := "my-buildpack/key/::"
			Expect(builderConfig.BuildpackPath(key)).To(Equal(filepath.Join(pathPrefix(), "tmp", "buildpacks", "dc91f5556d3ae859")))
		})

		It("returns the path to a given downloaded buildpack", func() {
			key := "https://github.com/cloudfoundry/ruby-buildpack"
			Expect(builderConfig.BuildpackPath(key)).To(Equal(filepath.Join(pathPrefix(), "tmp", "buildpackdownloads", "0e1df1251578f504")))
		})

		Context("when key generates hash that start with zeros", func() {
			It("returns the path that contains 16 byte key hash", func() {
				// xxhash starts with zeros
				key := "a1b4aa82-e5ae-4736-8284-bdfb013a7121_2845c523cf4f4f1045b331982cc557ef761afde4dc9fc8777831563461309455"
				Expect(builderConfig.BuildpackPath(key)).To(Equal(filepath.Join(pathPrefix(), "tmp", "buildpacks", "00c84a1da9e0c81e")))
			})
		})
	})

	It("returns the path to the staging metadata", func() {
		Expect(builderConfig.OutputMetadata()).To(Equal(filepath.Join(pathPrefix(), "tmp", "result.json")))
	})
})