[RFC0028] Support for Cloud Native Buildpacks lifecycle (#2871)

Co-authored-by: Johannes Dillmann <[email protected]>
Co-authored-by: Nicolas Bender <[email protected]>
Co-authored-by: Pavel Busko <[email protected]>
Co-authored-by: Ralf Pannemans <[email protected]>
Co-authored-by: Al Berez <[email protected]>
Co-authored-by: João Pereira <[email protected]>

Author: 6 people

.github/workflows/tests-integration-reusable.yml

@@ -207,6 +207,7 @@ jobs:
           "include_container_networking": true,
           "include_detect": true,
           "include_docker": true,
+          "include_cnb": true,
           "include_internet_dependent": true,
           "include_isolation_segments": true,
           "isolation_segment_name": "persistent_isolation_segment",
@@ -237,6 +238,7 @@ jobs:
         cf api ${API} --skip-ssl-validation
         cf auth
         cf enable-feature-flag diego_docker
+        cf enable-feature-flag diego_cnb
         cf enable-feature-flag service_instance_sharing
 
     - name: Run CATS Tests

actor/v7action/application.go

@@ -162,6 +162,7 @@ func (actor Actor) CreateApplicationInSpace(app resources.Application, spaceGUID
 			LifecycleBuildpacks: app.LifecycleBuildpacks,
 			StackName:           app.StackName,
 			Name:                app.Name,
+			Credentials:         app.Credentials,
 			SpaceGUID:           spaceGUID,
 		})
 

actor/v7pushaction/actor.go

@@ -42,6 +42,9 @@ func NewActor(v3Actor V7Actor, sharedActor SharedActor) *Actor {
 
 		HandleInstancesOverride,
 		HandleStartCommandOverride,
+		HandleCNBCredentialsOverride,
+
+		HandleLifecycleOverride,
 
 		// Type must come before endpoint because endpoint validates against type
 		HandleHealthCheckTypeOverride,

actor/v7pushaction/create_push_plans.go

@@ -31,6 +31,18 @@ func (actor Actor) CreatePushPlans(
 			BitsPath:    manifestApplication.Path,
 		}
 
+		if manifestApplication.Lifecycle != "" {
+			plan.Application.LifecycleType = manifestApplication.Lifecycle
+		}
+
+		if overrides.Lifecycle != "" {
+			plan.Application.LifecycleType = overrides.Lifecycle
+		}
+
+		if overrides.CNBCredentials != nil {
+			plan.Application.Credentials = overrides.CNBCredentials
+		}
+
 		if manifestApplication.Docker != nil {
 			plan.DockerImageCredentials = v7action.DockerImageCredentials{
 				Path:     manifestApplication.Docker.Image,

actor/v7pushaction/create_push_plans_test.go

@@ -41,14 +41,17 @@ var _ = Describe("CreatePushPlans", func() {
 
 		manifest = manifestparser.Manifest{
 			Applications: []manifestparser.Application{
-				{Name: "name-1", Path: "path1"},
+				{Name: "name-1", Path: "path1", Lifecycle: "cnb"},
 				{Name: "name-2", Path: "path2", Docker: &manifestparser.Docker{Image: "image", Username: "uname"}},
 			},
 		}
 		orgGUID = "org"
 		spaceGUID = "space"
 		flagOverrides = FlagOverrides{
 			DockerPassword: "passwd",
+			CNBCredentials: map[string]interface{}{
+				"foo": "bar",
+			},
 		}
 
 		testUpdatePlanCount = 0
@@ -120,6 +123,10 @@ var _ = Describe("CreatePushPlans", func() {
 			Expect(pushPlans[0].DockerImageCredentials.Username).To(Equal(""))
 			Expect(pushPlans[0].DockerImageCredentials.Password).To(Equal(""))
 			Expect(pushPlans[0].BitsPath).To(Equal("path1"))
+			Expect(pushPlans[0].Application.LifecycleType).To(BeEquivalentTo("cnb"))
+			Expect(pushPlans[0].Application.Credentials).To(Equal(map[string]interface{}{
+				"foo": "bar",
+			}))
 			Expect(pushPlans[1].Application.Name).To(Equal("name-2"))
 			Expect(pushPlans[1].Application.GUID).To(Equal("app-guid-2"))
 			Expect(pushPlans[1].SpaceGUID).To(Equal(spaceGUID))
@@ -128,7 +135,20 @@ var _ = Describe("CreatePushPlans", func() {
 			Expect(pushPlans[1].DockerImageCredentials.Username).To(Equal("uname"))
 			Expect(pushPlans[1].DockerImageCredentials.Password).To(Equal("passwd"))
 			Expect(pushPlans[1].BitsPath).To(Equal("path2"))
+			Expect(pushPlans[1].Application.LifecycleType).To(BeEquivalentTo(""))
 		})
+	})
 
+	When("lifecycle is overwritten", func() {
+		BeforeEach(func() {
+			flagOverrides = FlagOverrides{
+				Lifecycle: "buildpack",
+			}
+		})
+
+		It("uses the lifecycle from the command line", func() {
+			Expect(pushPlans[0].Application.LifecycleType).To(BeEquivalentTo("buildpack"))
+		})
 	})
+
 })

actor/v7pushaction/handle_cnb_credentials_override.go

@@ -0,0 +1,23 @@
+package v7pushaction
+
+import (
+	"code.cloudfoundry.org/cli/command/translatableerror"
+	"code.cloudfoundry.org/cli/util/manifestparser"
+)
+
+func HandleCNBCredentialsOverride(manifest manifestparser.Manifest, overrides FlagOverrides) (manifestparser.Manifest, error) {
+	if overrides.CNBCredentials != nil {
+		if manifest.ContainsMultipleApps() {
+			return manifest, translatableerror.CommandLineArgsWithMultipleAppsError{}
+		}
+
+		app := manifest.GetFirstApp()
+		if app.RemainingManifestFields == nil {
+			app.RemainingManifestFields = map[string]interface{}{}
+		}
+
+		app.RemainingManifestFields["cnb-credentials"] = overrides.CNBCredentials
+	}
+
+	return manifest, nil
+}

actor/v7pushaction/handle_cnb_credentials_override_test.go

@@ -0,0 +1,66 @@
+package v7pushaction_test
+
+import (
+	. "code.cloudfoundry.org/cli/actor/v7pushaction"
+	"code.cloudfoundry.org/cli/util/manifestparser"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+var _ = Describe("HandleCNBCredentialsOverride", func() {
+	var (
+		originalManifest    manifestparser.Manifest
+		transformedManifest manifestparser.Manifest
+		overrides           FlagOverrides
+		executeErr          error
+	)
+
+	BeforeEach(func() {
+		originalManifest = manifestparser.Manifest{
+			Applications: []manifestparser.Application{{}},
+		}
+		overrides = FlagOverrides{}
+	})
+
+	JustBeforeEach(func() {
+		transformedManifest, executeErr = HandleCNBCredentialsOverride(originalManifest, overrides)
+	})
+
+	When("the cnb credentials are present", func() {
+		BeforeEach(func() {
+			overrides.CNBCredentials = map[string]interface{}{
+				"foo": "bar",
+			}
+		})
+
+		It("add it to the raw manifest", func() {
+			Expect(executeErr).NotTo(HaveOccurred())
+			Expect(transformedManifest).To(Equal(manifestparser.Manifest{
+				Applications: []manifestparser.Application{{
+					RemainingManifestFields: map[string]interface{}{
+						"cnb-credentials": map[string]interface{}{
+							"foo": "bar",
+						},
+					},
+				}},
+			}))
+		})
+
+	})
+
+	When("the credentials are not present", func() {
+		BeforeEach(func() {
+			overrides.CNBCredentials = nil
+		})
+
+		It("does not add it to the raw manifest", func() {
+			Expect(executeErr).NotTo(HaveOccurred())
+			Expect(transformedManifest).To(Equal(manifestparser.Manifest{
+				Applications: []manifestparser.Application{{}},
+			}))
+
+		})
+
+	})
+})

actor/v7pushaction/handle_lifecycle_override.go

@@ -0,0 +1,19 @@
+package v7pushaction
+
+import (
+	"code.cloudfoundry.org/cli/command/translatableerror"
+	"code.cloudfoundry.org/cli/util/manifestparser"
+)
+
+func HandleLifecycleOverride(manifest manifestparser.Manifest, overrides FlagOverrides) (manifestparser.Manifest, error) {
+	if overrides.Lifecycle != "" {
+		if manifest.ContainsMultipleApps() {
+			return manifest, translatableerror.CommandLineArgsWithMultipleAppsError{}
+		}
+
+		app := manifest.GetFirstApp()
+		app.Lifecycle = overrides.Lifecycle
+	}
+
+	return manifest, nil
+}

actor/v7pushaction/push_plan.go

@@ -43,6 +43,7 @@ type FlagOverrides struct {
 	DockerImage         string
 	DockerPassword      string
 	DockerUsername      string
+	CNBCredentials      map[string]interface{}
 	HealthCheckEndpoint string
 	HealthCheckTimeout  int64
 	HealthCheckType     constant.HealthCheckType
@@ -62,6 +63,7 @@ type FlagOverrides struct {
 	NoManifest          bool
 	Task                bool
 	LogRateLimit        string
+	Lifecycle           constant.AppLifecycleType
 }
 
 func (state PushPlan) String() string {

api/cloudcontroller/ccv3/application_test.go

@@ -96,6 +96,17 @@ var _ = Describe("Application", func() {
 					})
 				})
 
+				When("lifecycle type cnb is provided", func() {
+					BeforeEach(func() {
+						app.LifecycleType = constant.AppLifecycleTypeCNB
+						app.LifecycleBuildpacks = []string{"docker://nodejs"}
+					})
+
+					It("sets the lifecycle buildpack to be empty in the JSON", func() {
+						Expect(string(appBytes)).To(MatchJSON(`{"lifecycle":{"data":{"buildpacks":["docker://nodejs"]},"type":"cnb"}}`))
+					})
+				})
+
 				When("null buildpack is provided", func() {
 					BeforeEach(func() {
 						app.LifecycleBuildpacks = []string{"null"}