Migrate to new lifecycle spec

[#167920584]

Co-authored-by: Mark DeLillo <mdelillo@pivotal.io>

Author: Zander Mackie

cmd/build/main.go

@@ -4,11 +4,9 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/cloudfoundry/python-cnb/python"
-
-	"github.com/buildpack/libbuildpack/buildplan"
-
 	"github.com/cloudfoundry/libcfbuildpack/build"
+	"github.com/cloudfoundry/libcfbuildpack/buildpackplan"
+	"github.com/cloudfoundry/python-cnb/python"
 )
 
 func main() {
@@ -41,5 +39,5 @@ func runBuild(context build.Build) (int, error) {
 		}
 	}
 
-	return context.Success(buildplan.BuildPlan{})
+	return context.Success(buildpackplan.Plan{})
 }

cmd/detect/main.go

@@ -19,11 +19,6 @@ func main() {
 		os.Exit(100)
 	}
 
-	if err := context.BuildPlan.Init(); err != nil {
-		_, _ = fmt.Fprintf(os.Stderr, "Failed to initialize Build Plan: %s\n", err)
-		os.Exit(101)
-	}
-
 	code, err := runDetect(context)
 	if err != nil {
 		context.Logger.Info(err.Error())
@@ -41,28 +36,38 @@ type BuildpackYAML struct {
 }
 
 func runDetect(context detect.Detect) (int, error) {
+	var version string
+
 	buildpackYAMLPath := filepath.Join(context.Application.Root, "buildpack.yml")
-	exists, err := helper.FileExists(buildpackYAMLPath)
+	buildpackYAMLExists, err := helper.FileExists(buildpackYAMLPath)
 	if err != nil {
 		return detect.FailStatusCode, err
 	}
-	buildpackYAML := BuildpackYAML{}
 
-	version := context.BuildPlan[python.Dependency].Version
-	if exists {
+	if buildpackYAMLExists {
+		buildpackYAML := BuildpackYAML{}
 		err = helper.ReadBuildpackYaml(buildpackYAMLPath, &buildpackYAML)
 		if err != nil {
 			return detect.FailStatusCode, err
 		}
+
 		if buildpackYAML.Config.Version != "" {
 			version = buildpackYAML.Config.Version
 		}
 	}
 
-	return context.Pass(buildplan.BuildPlan{
-		python.Dependency: buildplan.Dependency{
-			Version:  version,
-			Metadata: buildplan.Metadata{"build": true, "launch": true},
-		},
+	if version != "" {
+		return context.Pass(buildplan.Plan{
+			Provides: []buildplan.Provided{{Name: python.Dependency}},
+			Requires: []buildplan.Required{{
+				Name:     python.Dependency,
+				Version:  version,
+				Metadata: buildplan.Metadata{"launch": true},
+			}},
+		})
+	}
+
+	return context.Pass(buildplan.Plan{
+		Provides: []buildplan.Provided{{Name: python.Dependency}},
 	})
 }

cmd/detect/main_test.go

@@ -11,7 +11,6 @@ import (
 
 	"github.com/cloudfoundry/libcfbuildpack/detect"
 	"github.com/cloudfoundry/libcfbuildpack/test"
-	"github.com/google/go-cmp/cmp"
 	. "github.com/onsi/gomega"
 	"github.com/sclevine/spec"
 	"github.com/sclevine/spec/report"
@@ -29,31 +28,12 @@ func testDetect(t *testing.T, when spec.G, it spec.S) {
 		factory = test.NewDetectFactory(t)
 	})
 
-	it("always passes", func() {
-		code, err := runDetect(factory.Detect)
-		if err != nil {
-			t.Error("Err in detect : ", err)
-		}
-
-		if diff := cmp.Diff(code, detect.PassStatusCode); diff != "" {
-			t.Error("Problem : ", diff)
-		}
-	})
-
 	when("testing versions", func() {
-
 		when("there is no buildpack.yml", func() {
 			it("shouldn't set the version in the buildplan", func() {
-				code, err := runDetect(factory.Detect)
-				Expect(err).NotTo(HaveOccurred())
-				Expect(code).To(Equal(detect.PassStatusCode))
-
-				Expect(factory.Output).To(Equal(buildplan.BuildPlan{
-					python.Dependency: buildplan.Dependency{
-						Version:  "",
-						Metadata: buildplan.Metadata{"build": true, "launch": true},
-					},
-				}))
+				runDetectAndExpectBuildplan(factory, buildplan.Plan{
+					Provides: []buildplan.Provided{{Name: python.Dependency}},
+				}, t)
 			})
 		})
 
@@ -66,44 +46,25 @@ func testDetect(t *testing.T, when spec.G, it spec.S) {
 			})
 
 			it("should pass with the requested version of python", func() {
-				code, err := runDetect(factory.Detect)
-				Expect(err).NotTo(HaveOccurred())
-				Expect(code).To(Equal(detect.PassStatusCode))
-
-				Expect(factory.Output).To(Equal(buildplan.BuildPlan{
-					python.Dependency: buildplan.Dependency{
+				runDetectAndExpectBuildplan(factory, buildplan.Plan{
+					Provides: []buildplan.Provided{{Name: python.Dependency}},
+					Requires: []buildplan.Required{{Name: python.Dependency,
 						Version:  version,
-						Metadata: buildplan.Metadata{"build": true, "launch": true},
-					},
-				}))
+						Metadata: buildplan.Metadata{"launch": true},
+					}},
+				}, t)
 			})
 		})
+	})
+}
 
-		when("there is a is an existing version from the build plan and a buildpack.yml", func() {
-			const buildpackYAMLVersion string = "1.2.3"
-			const existingVersion string = "4.5.6"
-
-			it.Before(func() {
-				factory.AddBuildPlan(python.Dependency, buildplan.Dependency{
-					Version: existingVersion,
-				})
+func runDetectAndExpectBuildplan(factory *test.DetectFactory, buildplan buildplan.Plan, t *testing.T) {
+	Expect := NewWithT(t).Expect
 
-				buildpackYAMLString := fmt.Sprintf("python:\n  version: %s", buildpackYAMLVersion)
-				Expect(helper.WriteFile(filepath.Join(factory.Detect.Application.Root, "buildpack.yml"), 0666, buildpackYAMLString)).To(Succeed())
-			})
+	code, err := runDetect(factory.Detect)
+	Expect(err).NotTo(HaveOccurred())
 
-			it("should pass with the requested version of python defined in buildpack.yml", func() {
-				code, err := runDetect(factory.Detect)
-				Expect(err).NotTo(HaveOccurred())
-				Expect(code).To(Equal(detect.PassStatusCode))
+	Expect(code).To(Equal(detect.PassStatusCode))
 
-				Expect(factory.Output).To(Equal(buildplan.BuildPlan{
-					python.Dependency: buildplan.Dependency{
-						Version:  buildpackYAMLVersion,
-						Metadata: buildplan.Metadata{"build": true, "launch": true},
-					},
-				}))
-			})
-		})
-	})
+	Expect(factory.Plans.Plan).To(Equal(buildplan))
 }

go.mod

@@ -2,7 +2,8 @@ module github.com/cloudfoundry/python-cnb
 
 require (
 	github.com/buildpack/libbuildpack v1.21.0
-	github.com/cloudfoundry/libcfbuildpack v1.82.0
+	github.com/cloudfoundry/dagger v0.0.0-20190813205748-e53989179538
+	github.com/cloudfoundry/libcfbuildpack v1.83.0
 	github.com/google/go-cmp v0.2.0
 	github.com/onsi/gomega v1.5.0
 	github.com/sclevine/spec v1.2.0

go.sum

@@ -1,18 +1,29 @@
+cloud.google.com/go v0.34.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw=
 github.com/BurntSushi/toml v0.3.1 h1:WXkYYl6Yr3qBf1K79EBnL4mak0OimBfB0XUf9Vl28OQ=
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
 github.com/Masterminds/semver v1.4.2 h1:WBLTQ37jOCzSLtXNdoo8bNM8876KhNqOKvrlGITgsTc=
 github.com/Masterminds/semver v1.4.2/go.mod h1:MB6lktGJrhw8PrUyiEoblNEGEQ+RzHPF078ddwwvV3Y=
+github.com/buildpack/libbuildpack v1.19.0/go.mod h1:oxgSTzPbWscHs27iuYrctEZpSak2m/qPThA+9JM0Boo=
 github.com/buildpack/libbuildpack v1.21.0 h1:94d0/8Xv8Pp2dwFHSKNrFyXYHM01IHpuRE0N0ezWrr4=
 github.com/buildpack/libbuildpack v1.21.0/go.mod h1:dEDd9Dbp681Gcb39omBAZdsuHZ5YFMgurKGkgxEVzVo=
-github.com/cloudfoundry/libcfbuildpack v1.82.0 h1:bqwzRtZp3Be/AB8B4lsMv6PQgvEH64N4UvRvlNtacCc=
-github.com/cloudfoundry/libcfbuildpack v1.82.0/go.mod h1:c3ag+OHs0rnwh7C7kMXw3xsGRVLDvm9LfdoRR5tAnko=
+github.com/cloudfoundry/dagger v0.0.0-20190813205748-e53989179538 h1:pZZp1l6Z+mudaj7xiuSsK2on/Hy5sXnml9KLfwY+D+M=
+github.com/cloudfoundry/dagger v0.0.0-20190813205748-e53989179538/go.mod h1:PXeUHc4d2vAVO/31jFE6uD09w/yFfzs4kcayAVEvnEI=
+github.com/cloudfoundry/libcfbuildpack v1.76.0/go.mod h1:QGm+nzixn579dvQNlS7ZQET541y2hEpZ0/5uNxkQ04Y=
+github.com/cloudfoundry/libcfbuildpack v1.83.0 h1:rlr5jQcyAIOF2s29HFp2ooS1d8fAfqWt/UwOWsUncqY=
+github.com/cloudfoundry/libcfbuildpack v1.83.0/go.mod h1:c3ag+OHs0rnwh7C7kMXw3xsGRVLDvm9LfdoRR5tAnko=
 github.com/fatih/color v1.7.0 h1:DkWD4oS2D8LGGgTQ6IvwJJXSL5Vp2ffcQg58nFV38Ys=
 github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4=
 github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
 github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
+github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
+github.com/golang/protobuf v1.3.2 h1:6nsPYzhq5kReh6QImI3k5qWzO4PEbvbIW2cwSfR/6xs=
 github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
 github.com/google/go-cmp v0.2.0 h1:+dTQ8DZQJz0Mb/HjFlkptS1FeQ4cWSnN941F8aEG4SQ=
 github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M=
+github.com/google/go-github v17.0.0+incompatible h1:N0LgJ1j65A7kfXrZnUDaYCs/Sf4rEjNlfyDHW9dolSY=
+github.com/google/go-github v17.0.0+incompatible/go.mod h1:zLgOLi98H3fifZn+44m+umXrS52loVEgC2AApnigrVQ=
+github.com/google/go-querystring v1.0.0 h1:Xkwi/a1rcvNg1PPYe5vI8GbeBY/jrVuDX5ASuANWTrk=
+github.com/google/go-querystring v1.0.0/go.mod h1:odCYkC5MyYFN7vkCjXpyrEuKhc/BUO6wN/zVPAxq5ck=
 github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU=
 github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
@@ -28,25 +39,37 @@ github.com/onsi/ginkgo v1.6.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+W
 github.com/onsi/ginkgo v1.8.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE=
 github.com/onsi/gomega v1.5.0 h1:izbySO9zDPmjJ8rDjLvkA2zJHIo+HkYXHnf7eN7SSyo=
 github.com/onsi/gomega v1.5.0/go.mod h1:ex+gbHU/CVuBBDIJjb2X0qEXbFg53c61hWP/1CpauHY=
+github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I=
+github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/sclevine/spec v1.2.0 h1:1Jwdf9jSfDl9NVmt8ndHqbTZ7XCCPbh1jI3hkDBHVYA=
 github.com/sclevine/spec v1.2.0/go.mod h1:W4J29eT/Kzv7/b9IWLB055Z+qvVC9vt0Arko24q7p+U=
 github.com/xi2/xz v0.0.0-20171230120015-48954b6210f8 h1:nIPpBwaJSVYIxUFsDv3M8ofmx9yWTog9BfvIu0q41lo=
 github.com/xi2/xz v0.0.0-20171230120015-48954b6210f8/go.mod h1:HUYIGzjTL3rfEspMxjDjgmT5uz5wzYJKVo23qUhYTos=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
+golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
 golang.org/x/net v0.0.0-20180906233101-161cd47e91fd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
+golang.org/x/net v0.0.0-20190108225652-1e06a53dbb7e/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
+golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
+golang.org/x/net v0.0.0-20190628185345-da137c7871d7/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/net v0.0.0-20190724013045-ca1201d0de80 h1:Ao/3l156eZf2AW5wK8a7/smtodRU+gha3+BeqJ69lRk=
 golang.org/x/net v0.0.0-20190724013045-ca1201d0de80/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
+golang.org/x/oauth2 v0.0.0-20190319182350-c85d3e98c914 h1:jIOcLT9BZzyJ9ce+IwwZ+aF9yeCqzrR+NrD68a/SHKw=
+golang.org/x/oauth2 v0.0.0-20190319182350-c85d3e98c914/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
 golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sys v0.0.0-20180909124046-d0be0721c37e/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20190626221950-04f50cda93cb/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20190801041406-cbf593c0f2f3/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20190804053845-51ab0e2deafa h1:KIDDMLT1O0Nr7TSxp8xM5tJcdn8tgyAONntO829og1M=
 golang.org/x/sys v0.0.0-20190804053845-51ab0e2deafa/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.2 h1:tW2bmiBqwgJj/UpqtC8EpXEZVYOwU0yG4iWbprSVAcs=
 golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+google.golang.org/appengine v1.4.0 h1:/wp5JvzpHIxhs/dumFmF7BXTf3Z+dd4uXta4kVyO508=
+google.golang.org/appengine v1.4.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/fsnotify.v1 v1.4.7/go.mod h1:Tz8NjZHkW78fSQdbUxIjBTcgA1z1m8ZHf0WmKUhAMys=

integration/integration_test.go

@@ -0,0 +1,47 @@
+package integration
+
+import (
+	"path/filepath"
+	"testing"
+
+	"github.com/cloudfoundry/dagger"
+	. "github.com/onsi/gomega"
+	"github.com/sclevine/spec"
+	"github.com/sclevine/spec/report"
+)
+
+var (
+	bp string
+)
+
+func TestIntegration(t *testing.T) {
+	RegisterTestingT(t)
+	root, err := dagger.FindBPRoot()
+	Expect(err).ToNot(HaveOccurred())
+	bp, err = dagger.PackageBuildpack(root)
+	Expect(err).NotTo(HaveOccurred())
+	defer func() {
+		dagger.DeleteBuildpack(bp)
+	}()
+
+	spec.Run(t, "Integration", testIntegration, spec.Report(report.Terminal{}))
+}
+
+func testIntegration(t *testing.T, _ spec.G, it spec.S) {
+	it.Before(func() {
+		RegisterTestingT(t)
+	})
+
+	it("can run a python app", func() {
+		app, err := dagger.PackBuild(filepath.Join("testdata", "app"), bp)
+		Expect(err).ToNot(HaveOccurred())
+		app.Memory = "128m"
+		defer app.Destroy()
+
+		Expect(app.StartWithCommand("python3 server.py")).To(Succeed())
+
+		body, _, err := app.HTTPGet("/")
+		Expect(err).NotTo(HaveOccurred())
+		Expect(body).To(ContainSubstring("hello world"))
+	})
+}

integration/testdata/app/buildpack.yml

@@ -0,0 +1,3 @@
+---
+python:
+  version: ~3

integration/testdata/app/server.py

@@ -0,0 +1,21 @@
+from http.server import BaseHTTPRequestHandler, HTTPServer
+import os
+
+class Server(BaseHTTPRequestHandler):
+  def do_GET(self):
+        self.send_response(200)
+        self.send_header("Content-type","text/plain")
+        self.end_headers()
+        self.wfile.write(bytes("hello world", "utf8"))
+        return
+  def do_HEAD(self):
+        self.send_response(200)
+        self.send_header("Content-type","text/plain")
+        self.end_headers()
+        return
+
+port = int(os.getenv("PORT", "8080"))
+server_address = ("", port)
+httpd = HTTPServer(server_address, Server)
+print("server is listening on port " + str(port))
+httpd.serve_forever()

python/python.go

@@ -15,9 +15,9 @@ type Contributor struct {
 }
 
 func NewContributor(context build.Build) (Contributor, bool, error) {
-	plan, wantDependency := context.BuildPlan[Dependency]
-	if !wantDependency {
-		return Contributor{}, false, nil
+	plan, wantDependency, err := context.Plans.GetShallowMerged(Dependency)
+	if err != nil || !wantDependency {
+		return Contributor{}, false, err
 	}
 
 	dep, err := context.Buildpack.RuntimeDependency(Dependency, plan.Version, context.Stack)