Add test that iterates through testdata/ (#82)

## Summary
Add test that iterates through `testdata/`. If there's a `plan.json` it
uses it as a golden file, otherwise it just checks that plans succeeds
and that `devPackages` is not empty.

## How was it tested?
`go test -v ./...`

Author: loreto

devbox_test.go

@@ -0,0 +1,47 @@
+package devbox
+
+import (
+	"encoding/json"
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/bmatcuk/doublestar/v4"
+	"github.com/stretchr/testify/assert"
+	"go.jetpack.io/devbox/planner"
+)
+
+func TestPlan(t *testing.T) {
+	testPaths, err := doublestar.FilepathGlob("./testdata/**/devbox.json")
+	assert.NoError(t, err, "Reading testdata/ should not fail")
+	assert.Greater(t, len(testPaths), 0, "testdata/ should contain at least 1 test")
+
+	for _, testPath := range testPaths {
+		baseDir := filepath.Dir(testPath)
+		t.Run(baseDir, func(t *testing.T) {
+			assert := assert.New(t)
+			goldenFile := filepath.Join(baseDir, "plan.json")
+			hasGoldenFile := fileExists(goldenFile)
+
+			box, err := Open(baseDir)
+			assert.NoErrorf(err, "%s should be a valid devbox project", baseDir)
+			plan := box.Plan()
+			assert.NotEmpty(plan.DevPackages, "the plan should have dev packages")
+			if hasGoldenFile {
+				data, err := os.ReadFile(goldenFile)
+				assert.NoError(err, "plan.json should be readable")
+
+				expected := &planner.Plan{}
+				err = json.Unmarshal(data, &expected)
+				assert.NoError(err, "plan.json should parse correctly")
+
+				assert.Equal(expected, plan)
+			}
+		})
+	}
+}
+
+func fileExists(path string) bool {
+	_, err := os.Stat(path)
+	return err == nil
+}

go.mod

@@ -4,6 +4,7 @@ go 1.19
 
 require (
 	cuelang.org/go v0.4.3
+	github.com/bmatcuk/doublestar/v4 v4.2.0
 	github.com/denisbrodbeck/machineid v1.0.1
 	github.com/imdario/mergo v0.3.13
 	github.com/pelletier/go-toml/v2 v2.0.5

go.sum

@@ -1,5 +1,7 @@
 cuelang.org/go v0.4.3 h1:W3oBBjDTm7+IZfCKZAmC8uDG0eYfJL4Pp/xbbCMKaVo=
 cuelang.org/go v0.4.3/go.mod h1:7805vR9H+VoBNdWFdI7jyDR3QLUPp4+naHfbcgp55HI=
+github.com/bmatcuk/doublestar/v4 v4.2.0 h1:Qu+u9wR3Vd89LnlLMHvnZ5coJMWKQamqdz9/p5GNthA=
+github.com/bmatcuk/doublestar/v4 v4.2.0/go.mod h1:xBQ8jztBU6kakFMg+8WGxn0c6z1fTSPVIjEY1Wr7jzc=
 github.com/bmizerany/assert v0.0.0-20160611221934-b7ed37b82869 h1:DDGfHa7BWjL4YnC6+E63dPcxHo2sUxDIu8g3QgEJdRY=
 github.com/bmizerany/assert v0.0.0-20160611221934-b7ed37b82869/go.mod h1:Ekp36dRnpXw/yCqJaO+ZrUyxD+3VXMFFr56k5XYrpB4=
 github.com/cockroachdb/apd v1.1.0 h1:3LFP3629v+1aKXU5Q37mxmRxX/pIu1nijXydLShEq5I=

planner/python_poetry_planner.go

@@ -25,7 +25,8 @@ func (g *PythonPoetryPlanner) Name() string {
 }
 
 func (g *PythonPoetryPlanner) IsRelevant(srcDir string) bool {
-	return fileExists(filepath.Join(srcDir, "poetry.lock"))
+	return fileExists(filepath.Join(srcDir, "poetry.lock")) ||
+		fileExists(filepath.Join(srcDir, "pyproject.toml"))
 }
 
 func (g *PythonPoetryPlanner) GetPlan(srcDir string) *Plan {

testdata/python/poetry-no-entrypoint/devbox.json

@@ -1,5 +1,3 @@
 {
-  "packages": [
-    "poetry"
-  ]
+  "packages": []
 }

testdata/python/poetry-no-lock-file/devbox.json

@@ -1,5 +1,3 @@
 {
-  "packages": [
-    "poetry"
-  ]
+  "packages": []
 }