refactor: code cleanup (#89)

* refactor: cleanup SBOMGenerator

* refactor: move sbom to own package

* refactor: move build related types in own module

And removed common.go file

* chore: move sbom generate comment to correct file

* refactor: moved DependencyManager in own package

This also unifies the various implementations.

* refactor: move Executable to own package

* refactor: move common content into pkg

Since the content is indeed used by all the installers,
make it accessible at the pkg level rather that having
the indirection of common.

* chore: remove stray print in tests

* refactor: cleanup Executable

Use the new dedicated module

Author: sgaist

build.go

@@ -18,15 +18,15 @@ import (
 	poetry "github.com/paketo-buildpacks/python-installers/pkg/installers/poetry"
 	uv "github.com/paketo-buildpacks/python-installers/pkg/installers/uv"
 
-	pythoninstallers "github.com/paketo-buildpacks/python-installers/pkg/installers/common"
+	"github.com/paketo-buildpacks/python-installers/pkg/build"
 )
 
 type PackagerParameters interface {
 }
 
 func Build(
 	logger scribe.Emitter,
-	commonBuildParameters pythoninstallers.CommonBuildParameters,
+	commonBuildParameters build.CommonBuildParameters,
 	buildParameters map[string]PackagerParameters,
 ) packit.BuildFunc {
 	return func(context packit.BuildContext) (packit.BuildResult, error) {

build_test.go

@@ -22,7 +22,8 @@ import (
 	"github.com/paketo-buildpacks/packit/v2/scribe"
 
 	pythoninstallers "github.com/paketo-buildpacks/python-installers"
-	pkgcommon "github.com/paketo-buildpacks/python-installers/pkg/installers/common"
+	"github.com/paketo-buildpacks/python-installers/pkg/build"
+	dependencyfakes "github.com/paketo-buildpacks/python-installers/pkg/dependency/fakes"
 	miniconda "github.com/paketo-buildpacks/python-installers/pkg/installers/miniconda"
 	minicondafakes "github.com/paketo-buildpacks/python-installers/pkg/installers/miniconda/fakes"
 	pip "github.com/paketo-buildpacks/python-installers/pkg/installers/pip"
@@ -35,6 +36,7 @@ import (
 	poetryfakes "github.com/paketo-buildpacks/python-installers/pkg/installers/poetry/fakes"
 	uv "github.com/paketo-buildpacks/python-installers/pkg/installers/uv"
 	uvfakes "github.com/paketo-buildpacks/python-installers/pkg/installers/uv/fakes"
+	sbomfakes "github.com/paketo-buildpacks/python-installers/pkg/sbom/fakes"
 
 	. "github.com/onsi/gomega"
 	"github.com/sclevine/spec"
@@ -55,41 +57,41 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 
 		buffer       *bytes.Buffer
 		logger       scribe.Emitter
-		build        packit.BuildFunc
+		buildFunc    packit.BuildFunc
 		buildContext packit.BuildContext
 
 		// common
-		sbomGenerator *pipfakes.SBOMGenerator
-		// dependencyManager *pipfakes.DependencyManager
+		sbomGenerator *sbomfakes.SBOMGenerator
+		// dependencyManager *dependencyfakes.DependencyManager
 
 		// conda
-		minicondaDependencyManager *minicondafakes.DependencyManager
+		minicondaDependencyManager *dependencyfakes.DependencyManager
 		runner                     *minicondafakes.Runner
 
 		// pip
-		pipDependencyManager  *pipfakes.DependencyManager
+		pipDependencyManager  *dependencyfakes.DependencyManager
 		pipInstallProcess     *pipfakes.InstallProcess
 		pipSitePackageProcess *pipfakes.SitePackageProcess
 
 		// pipenv
-		pipenvDependencyManager  *pipenvfakes.DependencyManager
+		pipenvDependencyManager  *dependencyfakes.DependencyManager
 		pipenvProcess            *pipenvfakes.InstallProcess
 		pipenvSitePackageProcess *pipenvfakes.SitePackageProcess
 
 		// poetry
-		poetryDependencyManager  *poetryfakes.DependencyManager
+		poetryDependencyManager  *dependencyfakes.DependencyManager
 		poetryProcess            *poetryfakes.InstallProcess
 		poetrySitePackageProcess *poetryfakes.SitePackageProcess
 
 		// uv
-		uvDependencyManager *uvfakes.DependencyManager
+		uvDependencyManager *dependencyfakes.DependencyManager
 		uvInstallProcess    *uvfakes.InstallProcess
 
 		// pixi
-		pixiDependencyManager *pixifakes.DependencyManager
+		pixiDependencyManager *dependencyfakes.DependencyManager
 		pixiInstallProcess    *pixifakes.InstallProcess
 
-		buildParameters pkgcommon.CommonBuildParameters
+		buildParameters build.CommonBuildParameters
 
 		testPlans []TestPlan
 	)
@@ -102,11 +104,11 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 		buffer = bytes.NewBuffer(nil)
 		logger = scribe.NewEmitter(buffer)
 
-		sbomGenerator = &pipfakes.SBOMGenerator{}
+		sbomGenerator = &sbomfakes.SBOMGenerator{}
 		sbomGenerator.GenerateFromDependencyCall.Returns.SBOM = sbom.SBOM{}
 
 		// miniconda
-		minicondaDependencyManager = &minicondafakes.DependencyManager{}
+		minicondaDependencyManager = &dependencyfakes.DependencyManager{}
 		minicondaDependencyManager.ResolveCall.Returns.Dependency = postal.Dependency{
 			ID:       "miniconda3",
 			Name:     "miniconda3-dependency-name",
@@ -134,7 +136,7 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 		runner = &minicondafakes.Runner{}
 
 		// pip
-		pipDependencyManager = &pipfakes.DependencyManager{}
+		pipDependencyManager = &dependencyfakes.DependencyManager{}
 		pipDependencyManager.ResolveCall.Returns.Dependency = postal.Dependency{
 			ID:       "pip",
 			Name:     "Pip",
@@ -171,7 +173,7 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 		pipSitePackageProcess.ExecuteCall.Returns.String = filepath.Join(layersDir, "pip", "lib", "python1.23", "site-packages")
 
 		// pipenv
-		pipenvDependencyManager = &pipenvfakes.DependencyManager{}
+		pipenvDependencyManager = &dependencyfakes.DependencyManager{}
 		pipenvDependencyManager.ResolveCall.Returns.Dependency = postal.Dependency{
 			ID:       "pipenv",
 			Name:     "pipenv-dependency-name",
@@ -201,7 +203,7 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 		pipenvSitePackageProcess.ExecuteCall.Returns.String = filepath.Join(layersDir, "pipenv", "lib", "python3.8", "site-packages")
 
 		// poetry
-		poetryDependencyManager = &poetryfakes.DependencyManager{}
+		poetryDependencyManager = &dependencyfakes.DependencyManager{}
 		poetryDependencyManager.ResolveCall.Returns.Dependency = postal.Dependency{
 			ID:       "poetry",
 			Name:     "poetry-dependency-name",
@@ -230,7 +232,7 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 		poetrySitePackageProcess.ExecuteCall.Returns.String = filepath.Join(layersDir, "poetry", "lib", "python3.8", "site-packages")
 
 		// uv
-		uvDependencyManager = &uvfakes.DependencyManager{}
+		uvDependencyManager = &dependencyfakes.DependencyManager{}
 		uvDependencyManager.ResolveCall.Returns.Dependency = postal.Dependency{
 			ID:       "uv",
 			Name:     "uv-dependency-name",
@@ -258,7 +260,7 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 		uvInstallProcess = &uvfakes.InstallProcess{}
 
 		// pixi
-		pixiDependencyManager = &pixifakes.DependencyManager{}
+		pixiDependencyManager = &dependencyfakes.DependencyManager{}
 		pixiDependencyManager.ResolveCall.Returns.Dependency = postal.Dependency{
 			ID:       "pixi",
 			Name:     "pixi-dependency-name",
@@ -285,8 +287,8 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 
 		pixiInstallProcess = &pixifakes.InstallProcess{}
 
-		buildParameters = pkgcommon.CommonBuildParameters{
-			SbomGenerator: pkgcommon.Generator{},
+		buildParameters = build.CommonBuildParameters{
+			SbomGenerator: sbomGenerator,
 			Clock:         chronos.DefaultClock,
 			Logger:        logger,
 		}
@@ -321,7 +323,7 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 			},
 		}
 
-		build = pythoninstallers.Build(logger, buildParameters, packagerParameters)
+		buildFunc = pythoninstallers.Build(logger, buildParameters, packagerParameters)
 
 		buildContext = packit.BuildContext{
 			BuildpackInfo: packit.BuildpackInfo{
@@ -435,7 +437,7 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 		for _, testPlan := range testPlans {
 			logger.Detail("Doing: %s", testPlan)
 			buildContext.Plan = testPlan.Plan
-			result, err := build(buildContext)
+			result, err := buildFunc(buildContext)
 			Expect(err).NotTo(HaveOccurred())
 
 			layers := result.Layers
@@ -469,7 +471,7 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 		for _, testPlan := range orderTestPlans {
 			logger.Detail("Doing: %s", testPlan)
 			buildContext.Plan = testPlan
-			result, err := build(buildContext)
+			result, err := buildFunc(buildContext)
 			Expect(err).NotTo(HaveOccurred())
 
 			layers := result.Layers
@@ -482,11 +484,11 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 	it("fails if packager parameters is missing", func() {
 		packagerParameters := map[string]pythoninstallers.PackagerParameters{}
 
-		build = pythoninstallers.Build(logger, buildParameters, packagerParameters)
+		buildFunc = pythoninstallers.Build(logger, buildParameters, packagerParameters)
 
 		for _, testPlan := range testPlans {
 			buildContext.Plan = testPlan.Plan
-			_, err := build(buildContext)
+			_, err := buildFunc(buildContext)
 			Expect(err).To(HaveOccurred())
 		}
 	})

detect_test.go

@@ -15,7 +15,7 @@ import (
 	"github.com/paketo-buildpacks/packit/v2/scribe"
 
 	pythoninstallers "github.com/paketo-buildpacks/python-installers"
-	common "github.com/paketo-buildpacks/python-installers/pkg/installers/common"
+	"github.com/paketo-buildpacks/python-installers/pkg/build"
 
 	miniconda "github.com/paketo-buildpacks/python-installers/pkg/installers/miniconda"
 	pip "github.com/paketo-buildpacks/python-installers/pkg/installers/pip"
@@ -65,7 +65,7 @@ func testDetect(t *testing.T, context spec.G, it spec.S) {
 			Requires: []packit.BuildPlanRequirement{
 				{
 					Name: pip.CPython,
-					Metadata: common.BuildPlanMetadata{
+					Metadata: build.BuildPlanMetadata{
 						Build: true,
 					},
 				},
@@ -88,14 +88,14 @@ func testDetect(t *testing.T, context spec.G, it spec.S) {
 			Requires: []packit.BuildPlanRequirement{
 				{
 					Name: pipenv.CPython,
-					Metadata: common.BuildPlanMetadata{
+					Metadata: build.BuildPlanMetadata{
 						Build:  true,
 						Launch: false,
 					},
 				},
 				{
 					Name: pipenv.Pip,
-					Metadata: common.BuildPlanMetadata{
+					Metadata: build.BuildPlanMetadata{
 						Build:  true,
 						Launch: false,
 					},
@@ -141,15 +141,15 @@ func testDetect(t *testing.T, context spec.G, it spec.S) {
 							Requires: []packit.BuildPlanRequirement{
 								{
 									Name: poetry.CPython,
-									Metadata: common.BuildPlanMetadata{
+									Metadata: build.BuildPlanMetadata{
 										Build:         true,
 										Version:       "1.2.3",
 										VersionSource: "pyproject.toml",
 									},
 								},
 								{
 									Name: poetry.Pip,
-									Metadata: common.BuildPlanMetadata{
+									Metadata: build.BuildPlanMetadata{
 										Build: true,
 									},
 								},
@@ -187,15 +187,15 @@ func testDetect(t *testing.T, context spec.G, it spec.S) {
 							Requires: []packit.BuildPlanRequirement{
 								{
 									Name: poetry.CPython,
-									Metadata: common.BuildPlanMetadata{
+									Metadata: build.BuildPlanMetadata{
 										Build:         true,
 										Version:       "1.2.3",
 										VersionSource: "pyproject.toml",
 									},
 								},
 								{
 									Name: poetry.Pip,
-									Metadata: common.BuildPlanMetadata{
+									Metadata: build.BuildPlanMetadata{
 										Build: true,
 									},
 								},

integration/installers/miniconda_default_test.go

@@ -64,7 +64,6 @@ func minicondaTestDefault(t *testing.T, context spec.G, it spec.S) {
 				err  error
 			)
 
-			fmt.Printf("Settings are: %s", settings)
 			image, logs, err = pack.WithNoColor().Build.
 				WithPullPolicy("never").
 				WithBuildpacks(

pkg/installers/common/common.go pkg/build/build.gopkg/installers/common/common.go renamed to pkg/build/build.go

@@ -3,29 +3,19 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-package pythoninstallers
+package build
 
 import (
 	"github.com/paketo-buildpacks/packit/v2/chronos"
-	"github.com/paketo-buildpacks/packit/v2/postal"
-	"github.com/paketo-buildpacks/packit/v2/sbom"
 	"github.com/paketo-buildpacks/packit/v2/scribe"
-)
-
-type SBOMGenerator interface {
-	GenerateFromDependency(dependency postal.Dependency, path string) (sbom.SBOM, error)
-}
 
-type Generator struct{}
-
-func (f Generator) GenerateFromDependency(dependency postal.Dependency, path string) (sbom.SBOM, error) {
-	return sbom.GenerateFromDependency(dependency, path)
-}
+	"github.com/paketo-buildpacks/python-installers/pkg/sbom"
+)
 
 // CommonBuildParameters are the parameters shared
 // by all packager build function implementation
 type CommonBuildParameters struct {
-	SbomGenerator SBOMGenerator
+	SbomGenerator sbom.SBOMGenerator
 	Clock         chronos.Clock
 	Logger        scribe.Emitter
 }

pkg/dependency/dependency.go

@@ -0,0 +1,19 @@
+// SPDX-FileCopyrightText: © 2026 Idiap Research Institute <contact@idiap.ch>
+// SPDX-FileContributor: Samuel Gaist <samuel.gaist@idiap.ch>
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package dependency
+
+import (
+	"github.com/paketo-buildpacks/packit/v2"
+	"github.com/paketo-buildpacks/packit/v2/postal"
+)
+
+// DependencyManager defines the interface for picking the best matching
+// dependency and installing it.
+type DependencyManager interface {
+	Resolve(path, id, version, stack string) (postal.Dependency, error)
+	Deliver(dependency postal.Dependency, cnbPath, destinationPath, platformPath string) error
+	GenerateBillOfMaterials(dependencies ...postal.Dependency) []packit.BOMEntry
+}

…rs/miniconda/fakes/dependency_manager.go …g/dependency/fakes/dependency_manager.gopkg/installers/miniconda/fakes/dependency_manager.go renamed to pkg/dependency/fakes/dependency_manager.go pkg/installers/miniconda/fakes/dependency_manager.go renamed to pkg/dependency/fakes/dependency_manager.go

@@ -0,0 +1,16 @@
+// SPDX-FileCopyrightText: Copyright (c) 2013-Present CloudFoundry.org Foundation, Inc. All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package executable
+
+import (
+	"github.com/paketo-buildpacks/packit/v2/pexec"
+)
+
+//go:generate faux --interface Executable --output fakes/executable.go
+
+// Executable defines the interface for invoking an executable.
+type Executable interface {
+	Execute(pexec.Execution) error
+}