Ensures deprecation notice for buildpacks.yml picks the next major

build.go

@@ -53,7 +53,7 @@ func Build(
 
 		// Parse the BuildConfiguration from the environment again since a prior
 		// step may have augmented the configuration.
-		configuration, err := parser.Parse(context.WorkingDir)
+		configuration, err := parser.Parse(context.BuildpackInfo.Version, context.WorkingDir)
 		if err != nil {
 			return packit.BuildResult{}, packit.Fail.WithMessage("failed to parse build configuration: %w", err)
 		}

build_configuration_parser.go

@@ -16,7 +16,7 @@ type TargetManager interface {
 
 //go:generate faux --interface BuildpackYMLParser --output fakes/buildpack_yml_parser.go
 type BuildpackYMLParser interface {
-	Parse(workingDir string) (BuildConfiguration, error)
+	Parse(buildpackVersion, workingDir string) (BuildConfiguration, error)
 }
 
 type BuildConfiguration struct {
@@ -37,7 +37,7 @@ func NewBuildConfigurationParser(targetManager TargetManager, buildpackYMLParser
 	}
 }
 
-func (p BuildConfigurationParser) Parse(workingDir string) (BuildConfiguration, error) {
+func (p BuildConfigurationParser) Parse(buildpackVersion, workingDir string) (BuildConfiguration, error) {
 	var buildConfiguration BuildConfiguration
 
 	_, err := os.Stat(filepath.Join(workingDir, "buildpack.yml"))
@@ -46,7 +46,7 @@ func (p BuildConfigurationParser) Parse(workingDir string) (BuildConfiguration,
 			return BuildConfiguration{}, err
 		}
 	} else {
-		buildConfiguration, err = p.buildpackYMLParser.Parse(workingDir)
+		buildConfiguration, err = p.buildpackYMLParser.Parse(buildpackVersion, workingDir)
 		if err != nil {
 			return BuildConfiguration{}, err
 		}

build_configuration_parser_test.go

@@ -61,7 +61,7 @@ func testBuildConfigurationParser(t *testing.T, context spec.G, it spec.S) {
 		})
 
 		it("uses the values in the env var", func() {
-			configuration, err := parser.Parse(workingDir)
+			configuration, err := parser.Parse("1.2.3", workingDir)
 			Expect(err).NotTo(HaveOccurred())
 			Expect(configuration).To(Equal(gobuild.BuildConfiguration{
 				Targets: []string{"./some/target1", "./some/target2"},
@@ -86,7 +86,7 @@ func testBuildConfigurationParser(t *testing.T, context spec.G, it spec.S) {
 		})
 
 		it("uses the values in the env var", func() {
-			configuration, err := parser.Parse(workingDir)
+			configuration, err := parser.Parse("1.2.3", workingDir)
 			Expect(err).NotTo(HaveOccurred())
 			Expect(configuration).To(Equal(gobuild.BuildConfiguration{
 				Targets: []string{"."},
@@ -113,7 +113,7 @@ func testBuildConfigurationParser(t *testing.T, context spec.G, it spec.S) {
 		})
 
 		it("uses the values in the env var", func() {
-			configuration, err := parser.Parse(workingDir)
+			configuration, err := parser.Parse("1.2.3", workingDir)
 			Expect(err).NotTo(HaveOccurred())
 			Expect(configuration).To(Equal(gobuild.BuildConfiguration{
 				Targets:    []string{"."},
@@ -133,7 +133,7 @@ func testBuildConfigurationParser(t *testing.T, context spec.G, it spec.S) {
 		})
 
 		it("parses the targets and flags from a buildpack.yml", func() {
-			configuration, err := parser.Parse(workingDir)
+			configuration, err := parser.Parse("1.2.3", workingDir)
 			Expect(err).NotTo(HaveOccurred())
 			Expect(configuration).To(Equal(gobuild.BuildConfiguration{
 				Targets: []string{"./first", "./second"},
@@ -169,7 +169,7 @@ func testBuildConfigurationParser(t *testing.T, context spec.G, it spec.S) {
 		})
 
 		it("parses the targets and flags from a buildpack.yml but uses the values from the environment variables", func() {
-			configuration, err := parser.Parse(workingDir)
+			configuration, err := parser.Parse("1.2.3", workingDir)
 			Expect(err).NotTo(HaveOccurred())
 			Expect(configuration).To(Equal(gobuild.BuildConfiguration{
 				Targets: []string{"./some/target1", "./some/target2"},
@@ -196,7 +196,7 @@ func testBuildConfigurationParser(t *testing.T, context spec.G, it spec.S) {
 			})
 
 			it("returns an error", func() {
-				_, err := parser.Parse(workingDir)
+				_, err := parser.Parse("1.2.3", workingDir)
 				Expect(err).To(MatchError(ContainSubstring("permission denied")))
 			})
 		})
@@ -210,7 +210,7 @@ func testBuildConfigurationParser(t *testing.T, context spec.G, it spec.S) {
 			})
 
 			it("returns an error", func() {
-				_, err := parser.Parse(workingDir)
+				_, err := parser.Parse("1.2.3", workingDir)
 				Expect(err).To(MatchError("failed to parse buildpack.yml"))
 			})
 		})
@@ -228,7 +228,7 @@ func testBuildConfigurationParser(t *testing.T, context spec.G, it spec.S) {
 			})
 
 			it("returns an error", func() {
-				_, err := parser.Parse(workingDir)
+				_, err := parser.Parse("1.2.3", workingDir)
 				Expect(err).To(MatchError("failed to clean and validate targets"))
 			})
 		}, spec.Sequential())
@@ -239,7 +239,7 @@ func testBuildConfigurationParser(t *testing.T, context spec.G, it spec.S) {
 			})
 
 			it("returns an error", func() {
-				_, err := parser.Parse(workingDir)
+				_, err := parser.Parse("1.2.3", workingDir)
 				Expect(err).To(MatchError("failed to default target found"))
 			})
 		})
@@ -254,7 +254,7 @@ func testBuildConfigurationParser(t *testing.T, context spec.G, it spec.S) {
 			})
 
 			it("returns an error", func() {
-				_, err := parser.Parse(workingDir)
+				_, err := parser.Parse("1.2.3", workingDir)
 				Expect(err).To(MatchError(ContainSubstring("invalid command line string")))
 			})
 		}, spec.Sequential())

build_test.go

@@ -137,6 +137,9 @@ func testBuild(t *testing.T, context spec.G, it spec.S) {
 			},
 		}))
 
+		Expect(parser.ParseCall.Receives.BuildpackVersion).To(Equal("some-version"))
+		Expect(parser.ParseCall.Receives.WorkingDir).To(Equal(workingDir))
+
 		Expect(pathManager.SetupCall.Receives.Workspace).To(Equal(workingDir))
 		Expect(pathManager.SetupCall.Receives.ImportPath).To(Equal("some-import-path"))
 

detect.go

@@ -6,12 +6,12 @@ import (
 
 //go:generate faux --interface ConfigurationParser --output fakes/configuration_parser.go
 type ConfigurationParser interface {
-	Parse(workingDir string) (BuildConfiguration, error)
+	Parse(buildpackVersion, workingDir string) (BuildConfiguration, error)
 }
 
 func Detect(parser ConfigurationParser) packit.DetectFunc {
 	return func(context packit.DetectContext) (packit.DetectResult, error) {
-		if _, err := parser.Parse(context.WorkingDir); err != nil {
+		if _, err := parser.Parse(context.BuildpackInfo.Version, context.WorkingDir); err != nil {
 			return packit.DetectResult{}, packit.Fail.WithMessage("failed to parse build configuration: %w", err)
 		}
 

detect_test.go

@@ -35,6 +35,9 @@ func testDetect(t *testing.T, context spec.G, it spec.S) {
 	it("detects", func() {
 		result, err := detect(packit.DetectContext{
 			WorkingDir: workingDir,
+			BuildpackInfo: packit.BuildpackInfo{
+				Version: "some-buildpack-version",
+			},
 		})
 		Expect(err).NotTo(HaveOccurred())
 		Expect(result.Plan).To(Equal(packit.BuildPlan{
@@ -46,6 +49,7 @@ func testDetect(t *testing.T, context spec.G, it spec.S) {
 			}},
 		}))
 
+		Expect(parser.ParseCall.Receives.BuildpackVersion).To(Equal("some-buildpack-version"))
 		Expect(parser.ParseCall.Receives.WorkingDir).To(Equal(workingDir))
 	})
 
@@ -67,8 +71,6 @@ func testDetect(t *testing.T, context spec.G, it spec.S) {
 					},
 				}},
 			}))
-
-			Expect(parser.ParseCall.Receives.WorkingDir).To(Equal(workingDir))
 		})
 	})
 
@@ -90,8 +92,6 @@ func testDetect(t *testing.T, context spec.G, it spec.S) {
 					},
 				}},
 			}))
-
-			Expect(parser.ParseCall.Receives.WorkingDir).To(Equal(workingDir))
 		})
 	})
 
@@ -116,8 +116,6 @@ func testDetect(t *testing.T, context spec.G, it spec.S) {
 					},
 				}},
 			}))
-
-			Expect(parser.ParseCall.Receives.WorkingDir).To(Equal(workingDir))
 		})
 	})
 

fakes/buildpack_yml_parser.go

@@ -11,23 +11,25 @@ type BuildpackYMLParser struct {
 		sync.Mutex
 		CallCount int
 		Receives  struct {
-			WorkingDir string
+			BuildpackVersion string
+			WorkingDir       string
 		}
 		Returns struct {
 			BuildConfiguration gobuild.BuildConfiguration
 			Error              error
 		}
-		Stub func(string) (gobuild.BuildConfiguration, error)
+		Stub func(string, string) (gobuild.BuildConfiguration, error)
 	}
 }
 
-func (f *BuildpackYMLParser) Parse(param1 string) (gobuild.BuildConfiguration, error) {
+func (f *BuildpackYMLParser) Parse(param1 string, param2 string) (gobuild.BuildConfiguration, error) {
 	f.ParseCall.Lock()
 	defer f.ParseCall.Unlock()
 	f.ParseCall.CallCount++
-	f.ParseCall.Receives.WorkingDir = param1
+	f.ParseCall.Receives.BuildpackVersion = param1
+	f.ParseCall.Receives.WorkingDir = param2
 	if f.ParseCall.Stub != nil {
-		return f.ParseCall.Stub(param1)
+		return f.ParseCall.Stub(param1, param2)
 	}
 	return f.ParseCall.Returns.BuildConfiguration, f.ParseCall.Returns.Error
 }

fakes/configuration_parser.go

@@ -11,23 +11,25 @@ type ConfigurationParser struct {
 		sync.Mutex
 		CallCount int
 		Receives  struct {
-			WorkingDir string
+			BuildpackVersion string
+			WorkingDir       string
 		}
 		Returns struct {
 			BuildConfiguration gobuild.BuildConfiguration
 			Error              error
 		}
-		Stub func(string) (gobuild.BuildConfiguration, error)
+		Stub func(string, string) (gobuild.BuildConfiguration, error)
 	}
 }
 
-func (f *ConfigurationParser) Parse(param1 string) (gobuild.BuildConfiguration, error) {
+func (f *ConfigurationParser) Parse(param1 string, param2 string) (gobuild.BuildConfiguration, error) {
 	f.ParseCall.Lock()
 	defer f.ParseCall.Unlock()
 	f.ParseCall.CallCount++
-	f.ParseCall.Receives.WorkingDir = param1
+	f.ParseCall.Receives.BuildpackVersion = param1
+	f.ParseCall.Receives.WorkingDir = param2
 	if f.ParseCall.Stub != nil {
-		return f.ParseCall.Stub(param1)
+		return f.ParseCall.Stub(param1, param2)
 	}
 	return f.ParseCall.Returns.BuildConfiguration, f.ParseCall.Returns.Error
 }

go.mod

@@ -4,6 +4,7 @@ go 1.14
 
 require (
 	github.com/BurntSushi/toml v0.3.1
+	github.com/Masterminds/semver v1.5.0
 	github.com/buildkite/interpolate v0.0.0-20200526001904-07f35b4ae251
 	github.com/mattn/go-shellwords v1.0.11-0.20201201010856-2c8720de5e83
 	github.com/onsi/gomega v1.10.5

go_buildpack_yml_parser.go

@@ -8,6 +8,7 @@ import (
 
 	"github.com/buildkite/interpolate"
 	"gopkg.in/yaml.v2"
+	"github.com/Masterminds/semver"
 )
 
 type GoBuildpackYMLParser struct {
@@ -20,7 +21,7 @@ func NewGoBuildpackYMLParser(logger LogEmitter) GoBuildpackYMLParser {
 	}
 }
 
-func (p GoBuildpackYMLParser) Parse(workingDir string) (BuildConfiguration, error) {
+func (p GoBuildpackYMLParser) Parse(buildpackVersion, workingDir string) (BuildConfiguration, error) {
 	file, err := os.Open(filepath.Join(workingDir, "buildpack.yml"))
 	if err != nil {
 		return BuildConfiguration{}, fmt.Errorf("failed to read buildpack.yml: %w", err)
@@ -60,7 +61,8 @@ func (p GoBuildpackYMLParser) Parse(workingDir string) (BuildConfiguration, erro
 	}
 
 	if buildConfiguration.Targets != nil || buildConfiguration.Flags != nil || buildConfiguration.ImportPath != "" {
-		p.logger.Process("WARNING: Setting the Go Build configurations such as targets, build flags, and import path through buildpack.yml will be deprecated soon in Go Build Buildpack v1.0.0.")
+		nextMajorVersion := semver.MustParse(buildpackVersion).IncMajor()
+		p.logger.Process("WARNING: Setting the Go Build configurations such as targets, build flags, and import path through buildpack.yml will be deprecated soon in Go Build Buildpack v%s.", nextMajorVersion.String())
 		p.logger.Process("Please specify these configuration options through environment variables instead. See README.md or the documentation on paketo.io for more information.")
 		p.logger.Break()
 	}

go_buildpack_yml_parser_test.go

@@ -51,7 +51,7 @@ go:
 
 	context("Parse", func() {
 		it("parses the buildpack and returns a build configuration", func() {
-			config, err := goBuildpackYMLParser.Parse(workingDir)
+			config, err := goBuildpackYMLParser.Parse("1.2.3", workingDir)
 			Expect(err).NotTo(HaveOccurred())
 
 			Expect(config).To(Equal(gobuild.BuildConfiguration{
@@ -64,7 +64,7 @@ go:
 				},
 				ImportPath: "some-import-path",
 			}))
-			Expect(logs.String()).To(ContainSubstring("WARNING: Setting the Go Build configurations such as targets, build flags, and import path through buildpack.yml will be deprecated soon in Go Build Buildpack v1.0.0."))
+			Expect(logs.String()).To(ContainSubstring("WARNING: Setting the Go Build configurations such as targets, build flags, and import path through buildpack.yml will be deprecated soon in Go Build Buildpack v2.0.0."))
 			Expect(logs.String()).To(ContainSubstring("Please specify these configuration options through environment variables instead. See README.md or the documentation on paketo.io for more information."))
 		})
 
@@ -88,7 +88,7 @@ go:
 			})
 
 			it("interpolates the env vars those into the flags", func() {
-				config, err := goBuildpackYMLParser.Parse(workingDir)
+				config, err := goBuildpackYMLParser.Parse("1.2.3", workingDir)
 				Expect(err).NotTo(HaveOccurred())
 
 				Expect(config).To(Equal(gobuild.BuildConfiguration{
@@ -113,7 +113,7 @@ not-go:
 			})
 
 			it("does not return a deprecation message", func() {
-				config, err := goBuildpackYMLParser.Parse(workingDir)
+				config, err := goBuildpackYMLParser.Parse("1.2.3", workingDir)
 				Expect(err).NotTo(HaveOccurred())
 
 				Expect(config).To(Equal(gobuild.BuildConfiguration{}))
@@ -128,7 +128,7 @@ not-go:
 				})
 
 				it("returns an error", func() {
-					_, err := goBuildpackYMLParser.Parse(workingDir)
+					_, err := goBuildpackYMLParser.Parse("1.2.3", workingDir)
 					Expect(err).To(MatchError(ContainSubstring("failed to read buildpack.yml")))
 					Expect(err).To(MatchError(ContainSubstring("permission denied")))
 				})
@@ -140,7 +140,7 @@ not-go:
 				})
 
 				it("returns an error", func() {
-					_, err := goBuildpackYMLParser.Parse(workingDir)
+					_, err := goBuildpackYMLParser.Parse("1.2.3", workingDir)
 					Expect(err).To(MatchError(ContainSubstring("failed to decode buildpack.yml")))
 					Expect(err).To(MatchError(ContainSubstring("could not find expected directive name")))
 				})
@@ -157,7 +157,7 @@ go:
 				})
 
 				it("returns an error", func() {
-					_, err := goBuildpackYMLParser.Parse(workingDir)
+					_, err := goBuildpackYMLParser.Parse("1.2.3", workingDir)
 					Expect(err).To(MatchError(ContainSubstring("environment variable expansion failed:")))
 				})
 			})

integration/buildpack_yml_test.go

@@ -93,7 +93,7 @@ go:
 
 			Expect(logs).To(ContainLines(
 				MatchRegexp(fmt.Sprintf(`%s \d+\.\d+\.\d+`, settings.Buildpack.Name)),
-				"  WARNING: Setting the Go Build configurations such as targets, build flags, and import path through buildpack.yml will be deprecated soon in Go Build Buildpack v1.0.0.",
+				"  WARNING: Setting the Go Build configurations such as targets, build flags, and import path through buildpack.yml will be deprecated soon in Go Build Buildpack v2.0.0.",
 				"  Please specify these configuration options through environment variables instead. See README.md or the documentation on paketo.io for more information.",
 				"",
 				"  Executing build process",
@@ -138,7 +138,7 @@ go:
 
 				Expect(logs).To(ContainLines(
 					MatchRegexp(fmt.Sprintf(`%s \d+\.\d+\.\d+`, settings.Buildpack.Name)),
-					"  WARNING: Setting the Go Build configurations such as targets, build flags, and import path through buildpack.yml will be deprecated soon in Go Build Buildpack v1.0.0.",
+					"  WARNING: Setting the Go Build configurations such as targets, build flags, and import path through buildpack.yml will be deprecated soon in Go Build Buildpack v2.0.0.",
 					"  Please specify these configuration options through environment variables instead. See README.md or the documentation on paketo.io for more information.",
 					"",
 					"  Executing build process",