Use draft.Planner from packit

Author: joshuatcasey

build.go

@@ -8,6 +8,7 @@ import (
 
 	"github.com/paketo-buildpacks/packit/v2"
 	"github.com/paketo-buildpacks/packit/v2/chronos"
+	"github.com/paketo-buildpacks/packit/v2/draft"
 	"github.com/paketo-buildpacks/packit/v2/postal"
 	"github.com/paketo-buildpacks/packit/v2/sbom"
 	"github.com/paketo-buildpacks/packit/v2/scribe"
@@ -22,15 +23,6 @@ type FileManager interface {
 	WriteConfig(layerRoot, cnbPath string, data PhpIniConfig) (defaultConfig string, buildpackConfig string, err error)
 }
 
-//go:generate faux --interface EntryResolver --output fakes/entry_resolver.go
-
-// EntryResolver defines the interface for picking the most relevant entry from
-// the Buildpack Plan entries.
-type EntryResolver interface {
-	Resolve(name string, entries []packit.BuildpackPlanEntry, priorities []interface{}) (packit.BuildpackPlanEntry, []packit.BuildpackPlanEntry)
-	MergeLayerTypes(name string, entries []packit.BuildpackPlanEntry) (launch, build bool)
-}
-
 //go:generate faux --interface DependencyManager --output fakes/dependency_manager.go
 
 // DependencyManager defines the interface for picking the best matching
@@ -61,8 +53,7 @@ type SBOMGenerator interface {
 // and generate a Bill-of-Materials. On rebuilds, it reuses the cached
 // dependency if the SHA256 of the requested version matches the SHA256 of the
 // cached version. Build also sets up a default php.ini configuration.
-func Build(entryResolver EntryResolver,
-	dependencies DependencyManager,
+func Build(dependencies DependencyManager,
 	files FileManager,
 	environment EnvironmentConfiguration,
 	sbomGenerator SBOMGenerator,
@@ -74,7 +65,8 @@ func Build(entryResolver EntryResolver,
 		logger.Title("%s %s", context.BuildpackInfo.Name, context.BuildpackInfo.Version)
 		logger.Process("Resolving PHP version")
 
-		entry, entries := entryResolver.Resolve(PHPDependency, context.Plan.Entries, EntryPriorities)
+		planner := draft.NewPlanner()
+		entry, entries := planner.Resolve(PHPDependency, context.Plan.Entries, EntryPriorities)
 		logger.Candidates(entries)
 
 		version, _ := entry.Metadata["version"].(string)
@@ -95,7 +87,7 @@ func Build(entryResolver EntryResolver,
 		logger.Debug.Break()
 
 		legacyBOM := dependencies.GenerateBillOfMaterials(dependency)
-		launch, build := entryResolver.MergeLayerTypes(PHPDependency, context.Plan.Entries)
+		launch, build := planner.MergeLayerTypes(PHPDependency, context.Plan.Entries)
 
 		phpLayer.Launch, phpLayer.Build, phpLayer.Cache = launch, build, build
 

build_test.go

@@ -30,7 +30,6 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 		layersDir         string
 		workingDir        string
 		cnbDir            string
-		entryResolver     *fakes.EntryResolver
 		dependencyManager *fakes.DependencyManager
 		sbomGenerator     *fakes.SBOMGenerator
 		files             *fakes.FileManager
@@ -49,18 +48,6 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 		cnbDir, err = os.MkdirTemp("", "cnb")
 		Expect(err).NotTo(HaveOccurred())
 
-		entryResolver = &fakes.EntryResolver{}
-		entryResolver.ResolveCall.Returns.BuildpackPlanEntry = packit.BuildpackPlanEntry{
-			Name: "php",
-			Metadata: map[string]interface{}{
-				"version":        "7.2.*",
-				"version-source": "some-source",
-			},
-		}
-
-		entryResolver.MergeLayerTypesCall.Returns.Launch = false
-		entryResolver.MergeLayerTypesCall.Returns.Build = false
-
 		dependencyManager = &fakes.DependencyManager{}
 		dependencyManager.ResolveCall.Returns.Dependency = postal.Dependency{Name: "PHP"}
 		dependencyManager.GenerateBillOfMaterialsCall.Returns.BOMEntrySlice = []packit.BOMEntry{
@@ -95,7 +82,7 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 		buffer = bytes.NewBuffer(nil)
 		logEmitter := scribe.NewEmitter(buffer)
 
-		build = phpdist.Build(entryResolver, dependencyManager, files, environment, sbomGenerator, logEmitter, clock)
+		build = phpdist.Build(dependencyManager, files, environment, sbomGenerator, logEmitter, clock)
 	})
 
 	it.After(func() {
@@ -147,23 +134,6 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 			},
 		}))
 
-		Expect(entryResolver.ResolveCall.Receives.Name).To(Equal(phpdist.PHPDependency))
-		Expect(entryResolver.ResolveCall.Receives.Entries).To(Equal([]packit.BuildpackPlanEntry{
-			{
-				Name: "php",
-				Metadata: map[string]interface{}{
-					"version":        "7.2.*",
-					"version-source": "some-source",
-				},
-			},
-		}))
-		Expect(entryResolver.ResolveCall.Receives.Priorities).To(Equal([]interface{}{
-			"BP_PHP_VERSION",
-			"composer.lock",
-			"composer.json",
-			"default-versions",
-		}))
-
 		Expect(dependencyManager.ResolveCall.Receives.Path).To(Equal(filepath.Join(cnbDir, "buildpack.toml")))
 		Expect(dependencyManager.ResolveCall.Receives.Id).To(Equal("php"))
 		Expect(dependencyManager.ResolveCall.Receives.Version).To(Equal("7.2.*"))
@@ -246,30 +216,6 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 	})
 
 	context("when the build plan entry includes the build, launch flags", func() {
-		var workingDir string
-
-		it.Before(func() {
-			var err error
-			workingDir, err = os.MkdirTemp("", "working-dir")
-			Expect(err).NotTo(HaveOccurred())
-
-			entryResolver.ResolveCall.Returns.BuildpackPlanEntry = packit.BuildpackPlanEntry{
-				Name: "php",
-				Metadata: map[string]interface{}{
-					"version":        "7.2.*",
-					"version-source": "some-source",
-					"launch":         true,
-					"build":          true,
-				},
-			}
-			entryResolver.MergeLayerTypesCall.Returns.Launch = true
-			entryResolver.MergeLayerTypesCall.Returns.Build = true
-		})
-
-		it.After(func() {
-			Expect(os.RemoveAll(workingDir)).To(Succeed())
-		})
-
 		it("marks the php layer as build, cache and launch", func() {
 			result, err := build(packit.BuildContext{
 				CNBPath:    cnbDir,
@@ -329,6 +275,53 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 		})
 	})
 
+	context("when the build plan entry includes multiples version-sources", func() {
+		it("has a priority list", func() {
+			Expect(phpdist.EntryPriorities).To(Equal([]interface{}{
+				"BP_PHP_VERSION",
+				"composer.lock",
+				"composer.json",
+				"default-versions",
+			}))
+		})
+
+		it("prioritizes BP_PHP_VERSION", func() {
+			_, err := build(packit.BuildContext{
+				CNBPath:    cnbDir,
+				Stack:      "some-stack",
+				WorkingDir: workingDir,
+				Plan: packit.BuildpackPlan{
+					Entries: []packit.BuildpackPlanEntry{
+						{
+							Name: "php",
+							Metadata: map[string]interface{}{
+								"version":        "version-from-composer.lock",
+								"version-source": "composer.lock",
+							},
+						},
+						{
+							Name: "php",
+							Metadata: map[string]interface{}{
+								"version":        "version-from-BP_PHP_VERSION",
+								"version-source": "BP_PHP_VERSION",
+							},
+						},
+						{
+							Name: "php",
+							Metadata: map[string]interface{}{
+								"version":        "version-from-something-else",
+								"version-source": "something-else",
+							},
+						},
+					},
+				},
+				Layers: packit.Layers{Path: layersDir},
+			})
+			Expect(err).NotTo(HaveOccurred())
+			Expect(dependencyManager.ResolveCall.Receives.Version).To(Equal("version-from-BP_PHP_VERSION"))
+		})
+	})
+
 	context("when there is a dependency cache match", func() {
 		it.Before(func() {
 			err := os.WriteFile(filepath.Join(layersDir, "php.toml"), []byte("[metadata]\ndependency-sha = \"some-sha\"\n"), 0644)
@@ -338,8 +331,6 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 				Name:   "PHP",
 				SHA256: "some-sha",
 			}
-			entryResolver.MergeLayerTypesCall.Returns.Launch = true
-			entryResolver.MergeLayerTypesCall.Returns.Build = true
 		})
 
 		it("exits build process early", func() {

fakes/entry_resolver.go

@@ -3,10 +3,9 @@ package main
 import (
 	"os"
 
-	packit "github.com/paketo-buildpacks/packit/v2"
+	"github.com/paketo-buildpacks/packit/v2"
 	"github.com/paketo-buildpacks/packit/v2/cargo"
 	"github.com/paketo-buildpacks/packit/v2/chronos"
-	"github.com/paketo-buildpacks/packit/v2/draft"
 	"github.com/paketo-buildpacks/packit/v2/postal"
 	"github.com/paketo-buildpacks/packit/v2/sbom"
 	"github.com/paketo-buildpacks/packit/v2/scribe"
@@ -21,15 +20,13 @@ func (f Generator) GenerateFromDependency(dependency postal.Dependency, path str
 
 func main() {
 	logEmitter := scribe.NewEmitter(os.Stdout).WithLevel(os.Getenv("BP_LOG_LEVEL"))
-	entryResolver := draft.NewPlanner()
 	dependencyManager := postal.NewService(cargo.NewTransport())
 	environment := phpdist.NewEnvironment()
 	sbomGenerator := Generator{}
 
 	packit.Run(
 		phpdist.Detect(),
 		phpdist.Build(
-			entryResolver,
 			dependencyManager,
 			phpdist.NewPHPFileManager(),
 			environment,