project.toml path can be overriden

Signed-off-by: David Gageot <[email protected]>
GoogleContainerTools · May 27, 2020 · 5d0581e · 5d0581e
1 parent 2b699f9
commit 5d0581e
Show file tree

Hide file tree

Showing 7 changed files with 21 additions and 5 deletions.
diff --git a/docs/content/en/schemas/v2beta5.json b/docs/content/en/schemas/v2beta5.json
@@ -524,6 +524,12 @@
             "[\"key1=value1\", \"key2=value2\", \"key3={{.ENV_VARIABLE}}\"]"
           ]
         },
+        "projectDescriptor": {
+          "type": "string",
+          "description": "path to the toml project descriptor.",
+          "x-intellij-html-description": "path to the toml project descriptor.",
+          "default": "project.toml"
+        },
         "runImage": {
           "type": "string",
           "description": "overrides the stack's default run image.",
@@ -535,6 +541,7 @@
         "runImage",
         "env",
         "buildpacks",
+        "projectDescriptor",
         "dependencies"
       ],
       "additionalProperties": false,

diff --git a/pkg/skaffold/build/buildpacks/build_test.go b/pkg/skaffold/build/buildpacks/build_test.go
@@ -237,8 +237,9 @@ func buildpacksArtifact(builder, runImage string) *latest.Artifact {
 		Workspace: ".",
 		ArtifactType: latest.ArtifactType{
 			BuildpackArtifact: &latest.BuildpackArtifact{
-				Builder:  builder,
-				RunImage: runImage,
+				Builder:           builder,
+				RunImage:          runImage,
+				ProjectDescriptor: "project.toml",
 				Dependencies: &latest.BuildpackDependencies{
 					Paths: []string{"."},
 				},

diff --git a/pkg/skaffold/build/buildpacks/lifecycle.go b/pkg/skaffold/build/buildpacks/lifecycle.go
@@ -34,8 +34,6 @@ import (
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/latest"
 )
 
-const projectTOML = "project.toml"
-
 // For testing
 var (
 	runPackBuildFunc = runPackBuild
@@ -51,7 +49,7 @@ func (b *Builder) build(ctx context.Context, out io.Writer, a *latest.Artifact,
 	workspace := a.Workspace
 
 	// Read `project.toml` if it exists.
-	path := filepath.Join(a.Workspace, projectTOML)
+	path := filepath.Join(workspace, artifact.ProjectDescriptor)
 	projectDescriptor, err := ReadProjectDescriptor(path)
 	if err != nil && !os.IsNotExist(err) {
 		return "", fmt.Errorf("failed to read project descriptor %q: %w", path, err)

diff --git a/pkg/skaffold/constants/constants.go b/pkg/skaffold/constants/constants.go
@@ -64,6 +64,8 @@ const (
 	DefaultPortForwardNamespace = "default"
 	DefaultPortForwardAddress   = "127.0.0.1"
 
+	DefaultProjectDescriptor = "project.toml"
+
 	LeeroyAppResponse = "leeroooooy app!!\n"
 )
 

diff --git a/pkg/skaffold/schema/defaults/defaults.go b/pkg/skaffold/schema/defaults/defaults.go
@@ -200,6 +200,9 @@ func setCustomArtifactDefaults(a *latest.CustomArtifact) {
 }
 
 func setBuildpackArtifactDefaults(a *latest.BuildpackArtifact) {
+	if a.ProjectDescriptor == "" {
+		a.ProjectDescriptor = constants.DefaultProjectDescriptor
+	}
 	if a.Dependencies == nil {
 		a.Dependencies = &latest.BuildpackDependencies{
 			Paths: []string{"."},

diff --git a/pkg/skaffold/schema/defaults/defaults_test.go b/pkg/skaffold/schema/defaults/defaults_test.go
@@ -89,6 +89,7 @@ func TestSetDefaults(t *testing.T) {
 	testutil.CheckDeepEqual(t, "fourth", cfg.Build.Artifacts[3].ImageName)
 	testutil.CheckDeepEqual(t, []string{"."}, cfg.Build.Artifacts[3].BuildpackArtifact.Dependencies.Paths)
 	testutil.CheckDeepEqual(t, []string(nil), cfg.Build.Artifacts[3].BuildpackArtifact.Dependencies.Ignore)
+	testutil.CheckDeepEqual(t, "project.toml", cfg.Build.Artifacts[3].BuildpackArtifact.ProjectDescriptor)
 	testutil.CheckDeepEqual(t, &latest.Auto{}, cfg.Build.Artifacts[3].Sync.Auto)
 
 	testutil.CheckDeepEqual(t, "fifth", cfg.Build.Artifacts[4].ImageName)

diff --git a/pkg/skaffold/schema/latest/config.go b/pkg/skaffold/schema/latest/config.go
@@ -750,6 +750,10 @@ type BuildpackArtifact struct {
 	// Order matters.
 	Buildpacks []string `yaml:"buildpacks,omitempty"`
 
+	// ProjectDescriptor is the path to the toml project descriptor.
+	// Defaults to `project.toml`.
+	ProjectDescriptor string `yaml:"projectDescriptor,omitempty"`
+
 	// Dependencies are the file dependencies that skaffold should watch for both rebuilding and file syncing for this artifact.
 	Dependencies *BuildpackDependencies `yaml:"dependencies,omitempty"`
 }