github.com/BarDweller/libpak@v0.0.0-20230630201634-8dd5cfc15ec9/layer_test.go

/*
 * Copyright 2018-2023 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package libpak_test

import (
	"bytes"
	"fmt"
	"net/http"
	"os"
	"path/filepath"
	"testing"
	"time"

	"github.com/buildpacks/libcnb"
	. "github.com/onsi/gomega"
	"github.com/onsi/gomega/ghttp"
	"github.com/sclevine/spec"

	"github.com/BarDweller/libpak"
	"github.com/BarDweller/libpak/bard"
)

func testLayer(t *testing.T, context spec.G, it spec.S) {
	var (
		Expect = NewWithT(t).Expect

		layersDir string
		layer     libcnb.Layer
	)

	it.Before(func() {
		layersDir = t.TempDir()
		layer.Path = filepath.Join(layersDir, "test-layer")

		layer.Exec.Path = layer.Path
		layer.Metadata = map[string]interface{}{}
		layer.Profile = libcnb.Profile{}
	})

	it.After(func() {
		Expect(os.RemoveAll(layersDir)).To(Succeed())
	})

	context("LayerContributor", func() {
		var (
			lc libpak.LayerContributor
		)

		it.Before(func() {
			lc.Logger = bard.NewLogger(bytes.NewBuffer(nil))
			lc.ExpectedMetadata = map[string]interface{}{
				"alpha": "test-alpha",
				"bravo": map[string]interface{}{
					"bravo-1": "test-bravo-1",
					"bravo-2": "test-bravo-2",
				},
			}
		})

		it("calls function with no existing metadata", func() {
			var called bool

			_, err := lc.Contribute(layer, func() (libcnb.Layer, error) {
				called = true
				return layer, nil
			})
			Expect(err).NotTo(HaveOccurred())

			Expect(called).To(BeTrue())
		})

		it("calls function with non-matching metadata", func() {

			layer.Metadata["alpha"] = "test-alpha"

			var called bool

			_, err := lc.Contribute(layer, func() (libcnb.Layer, error) {
				called = true
				return layer, nil
			})
			Expect(err).NotTo(HaveOccurred())

			Expect(called).To(BeTrue())
		})

		context("reloads layers not restored", func() {
			var called bool

			it.Before(func() {
				layer.Metadata = map[string]interface{}{
					"alpha": "test-alpha",
					"bravo": map[string]interface{}{
						"bravo-1": "test-bravo-1",
						"bravo-2": "test-bravo-2",
					},
				}
				called = false
			})

			it("calls function with matching metadata but no layer directory on cache layer", func() {
				Expect(os.WriteFile(fmt.Sprintf("%s.toml", layer.Path), []byte{}, 0644)).To(Succeed())
				Expect(os.RemoveAll(layer.Path)).To(Succeed())
				lc.ExpectedTypes.Cache = true

				_, err := lc.Contribute(layer, func() (libcnb.Layer, error) {
					called = true
					return layer, nil
				})
				Expect(err).NotTo(HaveOccurred())

				Expect(called).To(BeTrue())
			})

			it("calls function with matching metadata but no layer directory on build layer", func() {
				Expect(os.WriteFile(fmt.Sprintf("%s.toml", layer.Path), []byte{}, 0644)).To(Succeed())
				Expect(os.RemoveAll(layer.Path)).To(Succeed())
				lc.ExpectedTypes.Build = true

				_, err := lc.Contribute(layer, func() (libcnb.Layer, error) {
					called = true
					return layer, nil
				})
				Expect(err).NotTo(HaveOccurred())

				Expect(called).To(BeTrue())
			})

			it("calls function with matching metadata but an empty layer directory on build layer", func() {
				Expect(os.WriteFile(fmt.Sprintf("%s.toml", layer.Path), []byte{}, 0644)).To(Succeed())
				Expect(os.MkdirAll(layer.Path, 0755)).To(Succeed())
				lc.ExpectedTypes.Build = true

				_, err := lc.Contribute(layer, func() (libcnb.Layer, error) {
					called = true
					return layer, nil
				})
				Expect(err).NotTo(HaveOccurred())

				Expect(called).To(BeTrue())
			})

			it("does not call function with matching metadata when layer directory exists and has a file in it", func() {
				Expect(os.WriteFile(fmt.Sprintf("%s.toml", layer.Path), []byte{}, 0644)).To(Succeed())
				Expect(os.MkdirAll(layer.Path, 0755)).To(Succeed())
				Expect(os.WriteFile(filepath.Join(layer.Path, "foo"), []byte{}, 0644)).To(Succeed())
				lc.ExpectedTypes.Build = true

				_, err := lc.Contribute(layer, func() (libcnb.Layer, error) {
					called = true
					return layer, nil
				})
				Expect(err).NotTo(HaveOccurred())

				Expect(called).To(BeFalse())
			})

			it("does not call function with matching metadata when layer TOML missing", func() {
				Expect(os.MkdirAll(layer.Path, 0755)).To(Succeed())
				layer.Build = true

				_, err := lc.Contribute(layer, func() (libcnb.Layer, error) {
					called = true
					return layer, nil
				})
				Expect(err).NotTo(HaveOccurred())

				Expect(called).To(BeFalse())
			})
		})

		it("does not call function with matching metadata", func() {
			layer.Metadata = map[string]interface{}{
				"alpha": "test-alpha",
				"bravo": map[string]interface{}{
					"bravo-1": "test-bravo-1",
					"bravo-2": "test-bravo-2",
				},
			}

			var called bool

			_, err := lc.Contribute(layer, func() (libcnb.Layer, error) {
				called = true
				return layer, nil
			})
			Expect(err).NotTo(HaveOccurred())

			Expect(called).To(BeFalse())
		})

		it("returns function error", func() {
			_, err := lc.Contribute(layer, func() (libcnb.Layer, error) {
				return libcnb.Layer{}, fmt.Errorf("test-error")
			})
			Expect(err).To(MatchError("test-error"))
		})

		it("adds expected metadata to layer", func() {
			layer, err := lc.Contribute(layer, func() (libcnb.Layer, error) {
				return layer, nil
			})
			Expect(err).NotTo(HaveOccurred())

			Expect(layer.Metadata).To(Equal(map[string]interface{}{
				"alpha": "test-alpha",
				"bravo": map[string]interface{}{
					"bravo-1": "test-bravo-1",
					"bravo-2": "test-bravo-2",
				},
			}))
		})

		it("sets build layer flag", func() {
			lc.ExpectedTypes.Build = true
			layer, err := lc.Contribute(layer, func() (libcnb.Layer, error) {
				return layer, nil
			})
			Expect(err).NotTo(HaveOccurred())

			Expect(layer.LayerTypes.Build).To(BeTrue())
		})

		it("sets cache layer flag", func() {
			lc.ExpectedTypes.Cache = true
			layer, err := lc.Contribute(layer, func() (libcnb.Layer, error) {
				return layer, nil
			})
			Expect(err).NotTo(HaveOccurred())

			Expect(layer.LayerTypes.Cache).To(BeTrue())
		})

		it("sets launch layer flag", func() {
			lc.ExpectedTypes.Launch = true
			layer, err := lc.Contribute(layer, func() (libcnb.Layer, error) {
				return layer, nil
			})
			Expect(err).NotTo(HaveOccurred())

			Expect(layer.LayerTypes.Launch).To(BeTrue())
		})

		it("sets layer flags regardless of caching behavior (required for 0.6 API)", func() {
			lc.ExpectedTypes.Launch = true
			lc.ExpectedTypes.Cache = true
			lc.ExpectedTypes.Build = true

			layer.Metadata = map[string]interface{}{
				"alpha": "test-alpha",
				"bravo": map[string]interface{}{
					"bravo-1": "test-bravo-1",
					"bravo-2": "test-bravo-2",
				},
			}

			var called bool

			layer, err := lc.Contribute(layer, func() (libcnb.Layer, error) {
				called = true
				return layer, nil
			})
			Expect(err).NotTo(HaveOccurred())
			Expect(called).To(BeFalse())

			Expect(layer.LayerTypes.Launch).To(BeTrue())
			Expect(layer.LayerTypes.Cache).To(BeTrue())
			Expect(layer.LayerTypes.Build).To(BeTrue())
		})
	})

	context("DependencyLayerContributor", func() {
		var (
			dependency libpak.BuildModuleDependency
			dlc        libpak.DependencyLayerContributor
			server     *ghttp.Server
		)

		it.Before(func() {
			RegisterTestingT(t)
			server = ghttp.NewServer()

			deprecationDate, err := time.Parse(time.RFC3339, "2021-04-01T00:00:00Z")
			Expect(err).ToNot(HaveOccurred())

			dependency = libpak.BuildModuleDependency{
				ID:      "test-id",
				Name:    "test-name",
				Version: "1.1.1",
				URI:     fmt.Sprintf("%s/test-path", server.URL()),
				SHA256:  "576dd8416de5619ea001d9662291d62444d1292a38e96956bc4651c01f14bca1",
				Stacks:  []string{"test-stack"},
				Licenses: []libpak.BuildModuleDependencyLicense{
					{
						Type: "test-type",
						URI:  "test-uri",
					},
				},
				CPEs:            []string{"cpe:2.3:a:some:jre:11.0.2:*:*:*:*:*:*:*"},
				PURL:            "pkg:generic/some-java11@11.0.2?arch=amd64",
				DeprecationDate: deprecationDate,
			}

			layer.Metadata = map[string]interface{}{}

			dlc.Logger = bard.NewLogger(bytes.NewBuffer(nil))
			dlc.ExpectedMetadata = dependency
			dlc.Dependency = dependency
			dlc.DependencyCache.CachePath = layer.Path
			dlc.DependencyCache.DownloadPath = layer.Path
		})

		it.After(func() {
			server.Close()
		})

		it("calls function with no existing metadata", func() {
			server.AppendHandlers(ghttp.RespondWith(http.StatusOK, "test-fixture"))

			var called bool

			_, err := dlc.Contribute(layer, func(artifact *os.File) (libcnb.Layer, error) {
				defer artifact.Close()

				called = true
				return layer, nil
			})
			Expect(err).NotTo(HaveOccurred())

			Expect(called).To(BeTrue())
		})

		it("modifies request", func() {
			server.AppendHandlers(ghttp.CombineHandlers(
				ghttp.VerifyHeaderKV("Test-Key", "test-value"),
				ghttp.RespondWith(http.StatusOK, "test-fixture"),
			))

			dlc.RequestModifierFuncs = append(dlc.RequestModifierFuncs, func(request *http.Request) (*http.Request, error) {
				request.Header.Add("Test-Key", "test-value")
				return request, nil
			})

			_, err := dlc.Contribute(layer, func(artifact *os.File) (libcnb.Layer, error) {
				defer artifact.Close()
				return layer, nil
			})
			Expect(err).NotTo(HaveOccurred())
		})

		it("calls function with non-matching metadata", func() {
			layer.Metadata["alpha"] = "test-alpha"

			server.AppendHandlers(ghttp.RespondWith(http.StatusOK, "test-fixture"))

			var called bool

			_, err := dlc.Contribute(layer, func(artifact *os.File) (libcnb.Layer, error) {
				defer artifact.Close()

				called = true
				return layer, nil
			})
			Expect(err).NotTo(HaveOccurred())

			Expect(called).To(BeTrue())
		})

		it("does not call function with matching metadata", func() {
			layer.Metadata = map[string]interface{}{
				"id":      dependency.ID,
				"name":    dependency.Name,
				"version": dependency.Version,
				"uri":     dependency.URI,
				"sha256":  dependency.SHA256,
				"stacks":  []interface{}{dependency.Stacks[0]},
				"licenses": []map[string]interface{}{
					{
						"type": dependency.Licenses[0].Type,
						"uri":  dependency.Licenses[0].URI,
					},
				},
				"cpes":             []interface{}{"cpe:2.3:a:some:jre:11.0.2:*:*:*:*:*:*:*"},
				"purl":             "pkg:generic/some-java11@11.0.2?arch=amd64",
				"deprecation_date": dependency.DeprecationDate,
			}

			var called bool

			_, err := dlc.Contribute(layer, func(artifact *os.File) (libcnb.Layer, error) {
				defer artifact.Close()

				called = true
				return layer, nil
			})
			Expect(err).NotTo(HaveOccurred())

			Expect(called).To(BeFalse())
		})

		it("returns function error", func() {
			server.AppendHandlers(ghttp.RespondWith(http.StatusOK, "test-fixture"))

			_, err := dlc.Contribute(layer, func(artifact *os.File) (libcnb.Layer, error) {
				defer artifact.Close()

				return libcnb.Layer{}, fmt.Errorf("test-error")
			})
			Expect(err).To(MatchError("test-error"))
		})

		it("adds expected metadata to layer", func() {
			server.AppendHandlers(ghttp.RespondWith(http.StatusOK, "test-fixture"))

			layer, err := dlc.Contribute(layer, func(artifact *os.File) (libcnb.Layer, error) {
				defer artifact.Close()
				return layer, nil
			})
			Expect(err).NotTo(HaveOccurred())

			Expect(layer.Metadata).To(Equal(map[string]interface{}{
				"id":      dependency.ID,
				"name":    dependency.Name,
				"version": dependency.Version,
				"uri":     dependency.URI,
				"sha256":  dependency.SHA256,
				"stacks":  []interface{}{dependency.Stacks[0]},
				"licenses": []map[string]interface{}{
					{
						"type": dependency.Licenses[0].Type,
						"uri":  dependency.Licenses[0].URI,
					},
				},
				"cpes":             []interface{}{"cpe:2.3:a:some:jre:11.0.2:*:*:*:*:*:*:*"},
				"purl":             "pkg:generic/some-java11@11.0.2?arch=amd64",
				"deprecation_date": dependency.DeprecationDate,
			}))
		})

		it("sets layer flags regardless of caching behavior (required for 0.6 API)", func() {
			layer.Metadata = map[string]interface{}{
				"id":      dependency.ID,
				"name":    dependency.Name,
				"version": dependency.Version,
				"uri":     dependency.URI,
				"sha256":  dependency.SHA256,
				"stacks":  []interface{}{dependency.Stacks[0]},
				"licenses": []map[string]interface{}{
					{
						"type": dependency.Licenses[0].Type,
						"uri":  dependency.Licenses[0].URI,
					},
				},
				"cpes":             []interface{}{"cpe:2.3:a:some:jre:11.0.2:*:*:*:*:*:*:*"},
				"purl":             "pkg:generic/some-java11@11.0.2?arch=amd64",
				"deprecation_date": dependency.DeprecationDate,
			}
			dlc.ExpectedTypes.Launch = true
			dlc.ExpectedTypes.Cache = true
			dlc.ExpectedTypes.Build = true

			var called bool

			layer, err := dlc.Contribute(layer, func(artifact *os.File) (libcnb.Layer, error) {
				defer artifact.Close()

				called = true
				return layer, nil
			})
			Expect(err).NotTo(HaveOccurred())

			Expect(called).To(BeFalse())

			Expect(layer.LayerTypes.Launch).To(BeTrue())
			Expect(layer.LayerTypes.Cache).To(BeTrue())
			Expect(layer.LayerTypes.Build).To(BeTrue())
		})

		it("adds expected Syft SBOM file", func() {
			server.AppendHandlers(ghttp.RespondWith(http.StatusOK, "test-fixture"))

			layer, err := dlc.Contribute(layer, func(artifact *os.File) (libcnb.Layer, error) {
				defer artifact.Close()
				return layer, nil
			})
			Expect(err).NotTo(HaveOccurred())

			outputFile := layer.SBOMPath(libcnb.SyftJSON)
			Expect(outputFile).To(BeARegularFile())

			data, err := os.ReadFile(outputFile)
			Expect(err).ToNot(HaveOccurred())
			Expect(string(data)).To(ContainSubstring(`"Artifacts":[`))
			Expect(string(data)).To(ContainSubstring(`"FoundBy":"libpak",`))
			Expect(string(data)).To(ContainSubstring(`"PURL":"pkg:generic/some-java11@11.0.2?arch=amd64"`))
			Expect(string(data)).To(ContainSubstring(`"Schema":{`))
			Expect(string(data)).To(ContainSubstring(`"Descriptor":{`))
			Expect(string(data)).To(ContainSubstring(`"Source":{`))
		})
	})

	context("HelperLayerContributor", func() {
		var (
			buildpack libcnb.Buildpack
			hlc       libpak.HelperLayerContributor
		)

		it.Before(func() {
			buildpack.Info = libcnb.BuildpackInfo{
				ID:       "test-id",
				Name:     "test-name",
				Version:  "test-version",
				Homepage: "test-homepage",
			}

			buildpack.Path = t.TempDir()
			file := filepath.Join(buildpack.Path, "bin")
			Expect(os.MkdirAll(file, 0755)).To(Succeed())

			file = filepath.Join(file, "helper")
			Expect(os.WriteFile(file, []byte{}, 0755)).To(Succeed())

			hlc = libpak.HelperLayerContributor{
				Path:          file,
				BuildpackInfo: buildpack.Info,
				Logger:        bard.NewLogger(bytes.NewBuffer(nil)),
				Names:         []string{"test-name-1", "test-name-2"},
			}
		})

		it.After(func() {
			Expect(os.RemoveAll(buildpack.Path)).To(Succeed())
		})

		it("calls function with no existing metadata", func() {
			_, err := hlc.Contribute(layer)
			Expect(err).NotTo(HaveOccurred())

			Expect(filepath.Join(layer.Exec.FilePath("test-name-1"))).To(BeAnExistingFile())
		})

		it("calls function with non-matching metadata", func() {
			layer.Metadata["alpha"] = "other-alpha"

			_, err := hlc.Contribute(layer)
			Expect(err).NotTo(HaveOccurred())

			file := filepath.Join(layer.Exec.FilePath("test-name-1"))
			Expect(file).To(BeAnExistingFile())
			Expect(os.Readlink(file)).To(Equal(filepath.Join(layer.Path, "helper")))

			file = filepath.Join(layer.Exec.FilePath("test-name-2"))
			Expect(file).To(BeAnExistingFile())
			Expect(os.Readlink(file)).To(Equal(filepath.Join(layer.Path, "helper")))
		})

		it("does not call function with matching metadata", func() {
			buildpackInfo := map[string]interface{}{
				"id":          buildpack.Info.ID,
				"name":        buildpack.Info.Name,
				"version":     buildpack.Info.Version,
				"homepage":    buildpack.Info.Homepage,
				"clear-env":   buildpack.Info.ClearEnvironment,
				"description": "",
			}
			layer.Metadata["buildpackInfo"] = buildpackInfo
			layer.Metadata["helperNames"] = []interface{}{hlc.Names[0], hlc.Names[1]}

			_, err := hlc.Contribute(layer)

			Expect(err).NotTo(HaveOccurred())

			Expect(filepath.Join(layer.Exec.FilePath("test-name-1"))).NotTo(BeAnExistingFile())
			Expect(filepath.Join(layer.Exec.FilePath("test-name-2"))).NotTo(BeAnExistingFile())
		})

		it("adds expected metadata to layer", func() {
			layer, err := hlc.Contribute(layer)
			Expect(err).NotTo(HaveOccurred())

			buildpackInfo := map[string]interface{}{
				"id":          buildpack.Info.ID,
				"name":        buildpack.Info.Name,
				"version":     buildpack.Info.Version,
				"homepage":    buildpack.Info.Homepage,
				"clear-env":   buildpack.Info.ClearEnvironment,
				"description": "",
			}
			Expect(layer.Metadata).To(Equal(map[string]interface{}{"buildpackInfo": buildpackInfo, "helperNames": []interface{}{hlc.Names[0], hlc.Names[1]}}))
		})

		it("sets layer flags regardless of caching behavior (required for 0.6 API)", func() {
			buildpackInfo := map[string]interface{}{
				"id":          buildpack.Info.ID,
				"name":        buildpack.Info.Name,
				"version":     buildpack.Info.Version,
				"homepage":    buildpack.Info.Homepage,
				"clear-env":   buildpack.Info.ClearEnvironment,
				"description": "",
			}
			layer.Metadata["buildpackInfo"] = buildpackInfo
			layer.Metadata["helperNames"] = []interface{}{hlc.Names[0], hlc.Names[1]}

			// Launch is the only one set & always true

			layer, err := hlc.Contribute(layer)
			Expect(err).NotTo(HaveOccurred())

			Expect(filepath.Join(layer.Exec.FilePath("test-name-1"))).NotTo(BeAnExistingFile())
			Expect(filepath.Join(layer.Exec.FilePath("test-name-2"))).NotTo(BeAnExistingFile())

			Expect(layer.LayerTypes.Launch).To(BeTrue())
			Expect(layer.LayerTypes.Cache).To(BeFalse())
			Expect(layer.LayerTypes.Build).To(BeFalse())
		})

		it("adds expected Syft SBOM file", func() {
			layer.Metadata = map[string]interface{}{}

			_, err := hlc.Contribute(layer)
			Expect(err).NotTo(HaveOccurred())

			Expect(filepath.Join(layer.Exec.FilePath("test-name-1"))).To(BeAnExistingFile())
			Expect(filepath.Join(layer.Exec.FilePath("test-name-2"))).To(BeAnExistingFile())

			outputFile := layer.SBOMPath(libcnb.SyftJSON)
			Expect(outputFile).To(BeARegularFile())

			data, err := os.ReadFile(outputFile)
			Expect(err).ToNot(HaveOccurred())
			Expect(string(data)).To(ContainSubstring(`"Artifacts":[`))
			Expect(string(data)).To(ContainSubstring(`"FoundBy":"libpak",`))
			Expect(string(data)).To(ContainSubstring(`"PURL":"pkg:generic/test-id@test-version"`))
			Expect(string(data)).To(ContainSubstring(`"CPEs":["cpe:2.3:a:test-id:test-name-1:test-version:*:*:*:*:*:*:*","cpe:2.3:a:test-id:test-name-2:test-version:*:*:*:*:*:*:*"]`))
			Expect(string(data)).To(ContainSubstring(`"Schema":{`))
			Expect(string(data)).To(ContainSubstring(`"Descriptor":{`))
			Expect(string(data)).To(ContainSubstring(`"Source":{`))
		})
	})
}