Add BP_DOTNET_RUNTIME_VERSION (#603)

* Add BP_DOTNET_RUNTIME_VERSION

* Add env vars metadata

Author: ZephireNZ

README.md

@@ -56,15 +56,15 @@ file that looks like the following:
 
 ## Configuration
 
-### `BP_DOTNET_FRAMEWORK_VERSION`
-The `BP_DOTNET_FRAMEWORK_VERSION` variable allows you to specify the version of
+### `BP_DOTNET_RUNTIME_VERSION`
+The `BP_DOTNET_RUNTIME_VERSION` variable allows you to specify the version of
 ASP.NET Core Runtime that is installed. The environment variable can be
 set at build-time either directly  (ex. `pack build my-app --env
 BP_ENVIRONMENT_VARIABLE=some-value`) or through a [`project.toml`
 file](https://github.com/buildpacks/spec/blob/main/extensions/project-descriptor.md)
 
 ```shell
-BP_DOTNET_FRAMEWORK_VERSION=6.0.5
+BP_DOTNET_RUNTIME_VERSION=6.0.5
 ```
 
 ### `BP_LOG_LEVEL`

build.go

@@ -86,6 +86,7 @@ func Build(
 		logger.Process("Resolving ASP.NET Core Runtime version")
 
 		priorities := []interface{}{
+			"BP_DOTNET_RUNTIME_VERSION",
 			"BP_DOTNET_FRAMEWORK_VERSION",
 			"runtimeconfig.json",
 			regexp.MustCompile(`.*\.(cs)|(fs)|(vb)proj`),

buildpack.toml

@@ -15,6 +15,16 @@ api = "0.8"
   include-files = ["buildpack.toml", "linux/amd64/bin/build", "linux/amd64/bin/detect", "linux/amd64/bin/run", "linux/arm64/bin/build", "linux/arm64/bin/detect", "linux/arm64/bin/run"]
   pre-package = "./scripts/build.sh --target linux/amd64 --target linux/arm64"
 
+  [[metadata.configurations]]
+    name        = "BP_DOTNET_RUNTIME_VERSION"
+    description = "specify a version of ASP.NET Runtime to use"
+    build       = true
+
+  [[metadata.configurations]]
+    name        = "BP_DOTNET_ROLL_FORWARD"
+    description = "set to 'Disable' to prevent ASP.NET version roll-forward"
+    build       = true
+
   [[metadata.dependencies]]
     arch = "amd64"
     checksum = "sha512:4aa9458d3de7b4ff960adcc4a655e4d7e4e6570e97791919113b8c9a55883964a60241daf3a70c60494cde1a61155d802339ec03b046466eac67298f0acc7289"

detect.go

@@ -2,23 +2,36 @@ package dotnetcoreaspnetruntime
 
 import (
 	"github.com/paketo-buildpacks/packit/v2"
+	"github.com/paketo-buildpacks/packit/v2/scribe"
 )
 
 type Environment struct {
-	DotnetRollForward      string `env:"BP_DOTNET_ROLL_FORWARD"`
-	DotnetFrameworkVersion string `env:"BP_DOTNET_FRAMEWORK_VERSION"`
+	DotnetRollForward                string `env:"BP_DOTNET_ROLL_FORWARD"`
+	DotnetRuntimeVersion             string `env:"BP_DOTNET_RUNTIME_VERSION"`
+	DeprecatedDotnetFrameworkVersion string `env:"BP_DOTNET_FRAMEWORK_VERSION"`
 }
 
-func Detect(environment Environment) packit.DetectFunc {
+func Detect(environment Environment, logger scribe.Emitter) packit.DetectFunc {
 	return func(context packit.DetectContext) (packit.DetectResult, error) {
 		var requirements []packit.BuildPlanRequirement
 
-		if environment.DotnetFrameworkVersion != "" {
+		if environment.DotnetRuntimeVersion != "" {
+			requirements = append(requirements, packit.BuildPlanRequirement{
+				Name: "dotnet-core-aspnet-runtime",
+				Metadata: map[string]interface{}{
+					"version-source": "BP_DOTNET_RUNTIME_VERSION",
+					"version":        environment.DotnetRuntimeVersion,
+				},
+			})
+		}
+
+		if environment.DeprecatedDotnetFrameworkVersion != "" {
+			logger.Subprocess(scribe.YellowColor("WARNING: BP_DOTNET_FRAMEWORK_VERSION is deprecated and will be removed in a future version. Please use BP_DOTNET_RUNTIME_VERSION instead."))
 			requirements = append(requirements, packit.BuildPlanRequirement{
 				Name: "dotnet-core-aspnet-runtime",
 				Metadata: map[string]interface{}{
 					"version-source": "BP_DOTNET_FRAMEWORK_VERSION",
-					"version":        environment.DotnetFrameworkVersion,
+					"version":        environment.DeprecatedDotnetFrameworkVersion,
 				},
 			})
 		}

detect_test.go

@@ -1,11 +1,13 @@
 package dotnetcoreaspnetruntime_test
 
 import (
+	"bytes"
 	"os"
 	"testing"
 
 	dotnetcoreaspnetruntime "github.com/paketo-buildpacks/dotnet-core-aspnet-runtime"
 	"github.com/paketo-buildpacks/packit/v2"
+	"github.com/paketo-buildpacks/packit/v2/scribe"
 	"github.com/sclevine/spec"
 
 	. "github.com/onsi/gomega"
@@ -17,14 +19,19 @@ func testDetect(t *testing.T, context spec.G, it spec.S) {
 
 		workingDir string
 		detect     packit.DetectFunc
+		buffer     *bytes.Buffer
 	)
 
 	it.Before(func() {
 		var err error
 		workingDir, err = os.MkdirTemp("", "working-dir")
 		Expect(err).NotTo(HaveOccurred())
 
-		detect = dotnetcoreaspnetruntime.Detect(dotnetcoreaspnetruntime.Environment{})
+		buffer = bytes.NewBuffer(nil)
+		detect = dotnetcoreaspnetruntime.Detect(
+			dotnetcoreaspnetruntime.Environment{},
+			scribe.NewEmitter(buffer),
+		)
 	})
 
 	it.After(func() {
@@ -58,11 +65,59 @@ func testDetect(t *testing.T, context spec.G, it spec.S) {
 		}))
 	})
 
-	context("when BP_DOTNET_FRAMEWORK_VERSION is set", func() {
+	context("when BP_DOTNET_RUNTIME_VERSION is set", func() {
 		it.Before(func() {
-			detect = dotnetcoreaspnetruntime.Detect(dotnetcoreaspnetruntime.Environment{
-				DotnetFrameworkVersion: "1.2.3",
+			detect = dotnetcoreaspnetruntime.Detect(
+				dotnetcoreaspnetruntime.Environment{
+					DotnetRuntimeVersion: "1.2.3",
+				},
+				scribe.NewEmitter(buffer))
+		})
+
+		it("provides and requires dotnet core runtime", func() {
+			result, err := detect(packit.DetectContext{
+				WorkingDir: workingDir,
 			})
+			Expect(err).NotTo(HaveOccurred())
+			Expect(result.Plan).To(Equal(packit.BuildPlan{
+				Provides: []packit.BuildPlanProvision{
+					{
+						Name: "dotnet-core-aspnet-runtime",
+					},
+				},
+				Requires: []packit.BuildPlanRequirement{
+					{
+						Name: "dotnet-core-aspnet-runtime",
+						Metadata: map[string]interface{}{
+							"version-source": "BP_DOTNET_RUNTIME_VERSION",
+							"version":        "1.2.3",
+						},
+					},
+				},
+				Or: []packit.BuildPlan{
+					{
+						Provides: []packit.BuildPlanProvision{
+							{Name: "dotnet-runtime"},
+						},
+					},
+					{
+						Provides: []packit.BuildPlanProvision{
+							{Name: "dotnet-runtime"},
+							{Name: "dotnet-aspnetcore"},
+						},
+					},
+				},
+			}))
+		})
+	})
+
+	context("when BP_DOTNET_FRAMEWORK_VERSION is set", func() {
+		it.Before(func() {
+			detect = dotnetcoreaspnetruntime.Detect(
+				dotnetcoreaspnetruntime.Environment{
+					DeprecatedDotnetFrameworkVersion: "1.2.3",
+				},
+				scribe.NewEmitter(buffer))
 		})
 
 		it("provides and requires dotnet core runtime", func() {

run/main.go

@@ -44,6 +44,7 @@ func main() {
 	packit.Run(
 		dotnetcoreaspnetruntime.Detect(
 			environment,
+			logEmitter,
 		),
 		dotnetcoreaspnetruntime.Build(
 			entryResolver,