use function in libnodejs to get project path

Signed-off-by: Michael Dawson <[email protected]>

Author: mhdawson

build.go

@@ -5,6 +5,7 @@ import (
 	"path/filepath"
 	"time"
 
+	"github.com/paketo-buildpacks/libnodejs"
 	"github.com/paketo-buildpacks/packit/v2/sbom"
 
 	"github.com/paketo-buildpacks/packit/v2"
@@ -50,8 +51,7 @@ type SymlinkResolver interface {
 	Resolve(lockfilePath, layerPath string) error
 }
 
-func Build(projectPathParser PathParser,
-	entryResolver EntryResolver,
+func Build(entryResolver EntryResolver,
 	configurationManager ConfigurationManager,
 	buildManager BuildManager,
 	pruneProcess PruneProcess,
@@ -72,13 +72,11 @@ func Build(projectPathParser PathParser,
 
 		logger.Process("Resolving installation process")
 
-		projectPath, err := projectPathParser.Get(context.WorkingDir)
+		projectPath, err := libnodejs.FindProjectPath(context.WorkingDir)
 		if err != nil {
 			return packit.BuildResult{}, err
 		}
 
-		projectPath = filepath.Join(context.WorkingDir, projectPath)
-
 		npmCacheLayer, err := context.Layers.Get(LayerNameCache)
 		if err != nil {
 			return packit.BuildResult{}, err

build_test.go

@@ -3,6 +3,7 @@ package npminstall_test
 import (
 	"bytes"
 	"errors"
+	"fmt"
 	"io"
 	"os"
 	"path/filepath"
@@ -33,7 +34,6 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 		processCacheDir   string
 		processNpmrcPath  string
 
-		projectPathParser    *fakes.PathParser
 		buildProcess         *fakes.BuildProcess
 		buildManager         *fakes.BuildManager
 		configurationManager *fakes.ConfigurationManager
@@ -60,8 +60,7 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 		cnbDir, err = os.MkdirTemp("", "cnb")
 		Expect(err).NotTo(HaveOccurred())
 
-		projectPathParser = &fakes.PathParser{}
-		projectPathParser.GetCall.Returns.ProjectPath = ""
+		t.Setenv("BP_NODE_PROJECT_PATH", "")
 
 		buildProcess = &fakes.BuildProcess{}
 		buildProcess.ShouldRunCall.Returns.Run = true
@@ -107,7 +106,6 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 		symlinkResolver = &fakes.SymlinkResolver{}
 
 		build = npminstall.Build(
-			projectPathParser,
 			entryResolver,
 			configurationManager,
 			buildManager,
@@ -255,8 +253,6 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 			Expect(cacheLayer.Launch).To(BeFalse())
 			Expect(cacheLayer.Cache).To(BeTrue())
 
-			Expect(projectPathParser.GetCall.Receives.Path).To(Equal(workingDir))
-
 			Expect(configurationManager.DeterminePathCall.Receives.Typ).To(Equal("npmrc"))
 			Expect(configurationManager.DeterminePathCall.Receives.PlatformDir).To(Equal("some-platform-path"))
 			Expect(configurationManager.DeterminePathCall.Receives.Entry).To(Equal(".npmrc"))
@@ -406,8 +402,6 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 			Expect(cacheLayer.Launch).To(BeFalse())
 			Expect(cacheLayer.Cache).To(BeTrue())
 
-			Expect(projectPathParser.GetCall.Receives.Path).To(Equal(workingDir))
-
 			Expect(configurationManager.DeterminePathCall.Receives.Typ).To(Equal("npmrc"))
 			Expect(configurationManager.DeterminePathCall.Receives.PlatformDir).To(Equal("some-platform-path"))
 			Expect(configurationManager.DeterminePathCall.Receives.Entry).To(Equal(".npmrc"))
@@ -715,7 +709,6 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 			})
 			Expect(err).NotTo(HaveOccurred())
 
-			Expect(projectPathParser.GetCall.Receives.Path).To(Equal(workingDir))
 			Expect(buildManager.ResolveCall.Receives.WorkingDir).To(Equal(workingDir))
 			Expect(buildProcess.RunCall.CallCount).To(Equal(0))
 
@@ -726,7 +719,7 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 		context("when BP_NODE_PROJECT_PATH is set", func() {
 			it.Before(func() {
 				buildProcess.ShouldRunCall.Returns.Run = true
-				projectPathParser.GetCall.Returns.ProjectPath = "some-dir"
+				t.Setenv("BP_NODE_PROJECT_PATH", "some-dir")
 				Expect(os.MkdirAll(filepath.Join(workingDir, "some-dir", "node_modules"), os.ModePerm))
 			})
 
@@ -746,8 +739,6 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 				})
 				Expect(err).NotTo(HaveOccurred())
 
-				Expect(projectPathParser.GetCall.Receives.Path).To(Equal(workingDir))
-
 				Expect(buildManager.ResolveCall.Receives.WorkingDir).To(Equal(filepath.Join(workingDir, "some-dir")))
 
 				Expect(processLayerDir).To(Equal(filepath.Join(layersDir, "launch-modules")))
@@ -852,7 +843,7 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 
 		context("when the project path parser provided fails", func() {
 			it.Before(func() {
-				projectPathParser.GetCall.Returns.Err = errors.New("failed to parse project path")
+				t.Setenv("BP_NODE_PROJECT_PATH", "does_not_exist")
 			})
 
 			it("returns an error", func() {
@@ -866,7 +857,7 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 						},
 					},
 				})
-				Expect(err).To(MatchError("failed to parse project path"))
+				Expect(err).To(MatchError(ContainSubstring(fmt.Sprintf("could not find project path \"%s/does_not_exist\": stat %s/does_not_exist: no such file or directory", workingDir, workingDir))))
 			})
 		})
 

detect.go

@@ -5,6 +5,7 @@ import (
 	"os"
 	"path/filepath"
 
+	"github.com/paketo-buildpacks/libnodejs"
 	"github.com/paketo-buildpacks/packit/v2"
 )
 
@@ -20,23 +21,18 @@ type VersionParser interface {
 	ParseVersion(path string) (version string, err error)
 }
 
-//go:generate faux --interface PathParser --output fakes/path_parser.go
-type PathParser interface {
-	Get(path string) (projectPath string, err error)
-}
-
-func Detect(projectPathParser PathParser, packageJSONParser VersionParser) packit.DetectFunc {
+func Detect(packageJSONParser VersionParser) packit.DetectFunc {
 	return func(context packit.DetectContext) (packit.DetectResult, error) {
 
-		projectPath, err := projectPathParser.Get(context.WorkingDir)
+		projectPath, err := libnodejs.FindProjectPath(context.WorkingDir)
 		if err != nil {
 			return packit.DetectResult{}, err
 		}
 
-		version, err := packageJSONParser.ParseVersion(filepath.Join(context.WorkingDir, projectPath, "package.json"))
+		version, err := packageJSONParser.ParseVersion(filepath.Join(projectPath, "package.json"))
 		if err != nil {
 			if errors.Is(err, os.ErrNotExist) {
-				return packit.DetectResult{}, packit.Fail.WithMessage("no 'package.json' found in project path %s", filepath.Join(context.WorkingDir, projectPath))
+				return packit.DetectResult{}, packit.Fail.WithMessage("no 'package.json' found in project path %s", filepath.Join(projectPath))
 			}
 
 			return packit.DetectResult{}, err

detect_test.go

@@ -18,18 +18,16 @@ func testDetect(t *testing.T, context spec.G, it spec.S) {
 		Expect = NewWithT(t).Expect
 
 		packageJSONParser *fakes.VersionParser
-		projectPathParser *fakes.PathParser
 		detect            packit.DetectFunc
 	)
 
 	it.Before(func() {
 		packageJSONParser = &fakes.VersionParser{}
 		packageJSONParser.ParseVersionCall.Returns.Version = "1.2.3"
 
-		projectPathParser = &fakes.PathParser{}
-		projectPathParser.GetCall.Returns.ProjectPath = ""
+		t.Setenv("BP_NODE_PROJECT_PATH", "")
 
-		detect = npminstall.Detect(projectPathParser, packageJSONParser)
+		detect = npminstall.Detect(packageJSONParser)
 	})
 
 	it("returns a plan that provides node_modules", func() {
@@ -60,7 +58,6 @@ func testDetect(t *testing.T, context spec.G, it spec.S) {
 		}))
 
 		Expect(packageJSONParser.ParseVersionCall.Receives.Path).To(Equal("/working-dir/package.json"))
-		Expect(projectPathParser.GetCall.Receives.Path).To(Equal("/working-dir"))
 	})
 
 	context("when the package.json does not declare a node engine version", func() {
@@ -94,7 +91,6 @@ func testDetect(t *testing.T, context spec.G, it spec.S) {
 			}))
 
 			Expect(packageJSONParser.ParseVersionCall.Receives.Path).To(Equal("/working-dir/package.json"))
-			Expect(projectPathParser.GetCall.Receives.Path).To(Equal("/working-dir"))
 		})
 	})
 
@@ -128,14 +124,14 @@ func testDetect(t *testing.T, context spec.G, it spec.S) {
 
 		context("when the project path parser fails", func() {
 			it.Before(func() {
-				projectPathParser.GetCall.Returns.Err = errors.New("some-error")
+				t.Setenv("BP_NODE_PROJECT_PATH", "does_not_exist")
 			})
 
 			it("returns an error", func() {
 				_, err := detect(packit.DetectContext{
 					WorkingDir: "/working-dir",
 				})
-				Expect(err).To(MatchError("some-error"))
+				Expect(err).To(MatchError("could not find project path \"/working-dir/does_not_exist\": stat /working-dir/does_not_exist: no such file or directory"))
 			})
 		})
 	})

fakes/path_parser.go

@@ -90,6 +90,7 @@ require (
 	github.com/opencontainers/go-digest v1.0.0 // indirect
 	github.com/opencontainers/image-spec v1.1.0-rc3 // indirect
 	github.com/opencontainers/runc v1.1.5 // indirect
+	github.com/paketo-buildpacks/libnodejs v0.0.2 // indirect
 	github.com/pelletier/go-toml v1.9.5 // indirect
 	github.com/pierrec/lz4/v4 v4.1.17 // indirect
 	github.com/pjbgf/sha1cd v0.3.0 // indirect

go.mod

@@ -2556,6 +2556,8 @@ github.com/otiai10/curr v1.0.0/go.mod h1:LskTG5wDwr8Rs+nNQ+1LlxRjAtTZZjtJW4rMXl6
 github.com/otiai10/mint v1.3.0/go.mod h1:F5AjcsTsWUqX+Na9fpHb52P8pcRX2CI6A3ctIT91xUo=
 github.com/otiai10/mint v1.3.1/go.mod h1:/yxELlJQ0ufhjUwhshSj+wFjZ78CnZ48/1wtmBH1OTc=
 github.com/pact-foundation/pact-go v1.0.4/go.mod h1:uExwJY4kCzNPcHRj+hCR/HBbOOIwwtUjcrb0b5/5kLM=
+github.com/paketo-buildpacks/libnodejs v0.0.2 h1:3pPWg0b2uzaPkKNqVRT3dCGJ6XheuMZpJw8mBp/bYLc=
+github.com/paketo-buildpacks/libnodejs v0.0.2/go.mod h1:D69iwG2Uu9Y0VHOrs2xDk9Oy91qMo9j+gLaRwP2jINw=
 github.com/paketo-buildpacks/occam v0.16.0 h1:NZ206CO4HWX735PM8WrqM+8DvMhb05P7RELVovRKb/E=
 github.com/paketo-buildpacks/occam v0.16.0/go.mod h1:1EO702a0MwsDB9VFYi2oZ7weIL/eRO9SHPu1bNc+t/k=
 github.com/paketo-buildpacks/packit/v2 v2.6.1/go.mod h1:iBArWOfC5xZQF01o+zwnVKS+/hUBuFG+O1jCvzqBujs=

go.sum

@@ -22,7 +22,6 @@ func TestUnitNPMInstall(t *testing.T) {
 	suite("Linker", testLinker)
 	suite("PackageJSONParser", testPackageJSONParser)
 	suite("PackageManangerConfigurationManager", testPackageManagerConfigurationManager)
-	suite("ProjectPathParser", testProjectPathParser)
 	suite("PruneBuildProcess", testPruneBuildProcess)
 	suite("RebuildBuildProcess", testRebuildBuildProcess)
 	suite("UpdateNpmCacheLayer", testUpdateNpmCache)