Sets node-start to optional

Modifies buildpack.toml to have node-start optional in npm and yarn
build groups.

Adds integration test to cover various cases for npm and yarn.

buildpack.toml

@@ -49,6 +49,7 @@ api = "0.6"
  [[order.group]]
  id = "paketo-buildpacks/node-start"
  version = "0.8.0"
+ optional = true
 
  [[order.group]]
  id = "paketo-buildpacks/yarn-start"
@@ -103,6 +104,7 @@ api = "0.6"
  [[order.group]]
  id = "paketo-buildpacks/node-start"
  version = "0.8.0"
+ optional = true
 
  [[order.group]]
  id = "paketo-buildpacks/npm-start"

integration/npm_test.go

@@ -32,7 +32,139 @@ func testNPM(t *testing.T, context spec.G, it spec.S) {
  docker = occam.NewDocker()
  })
 
- context("when building a node app that uses npm", func() {
+ context("when building a node app that uses npm and has no start script", func() {
+ var (
+ image occam.Image
+ container occam.Container
+
+ name string
+ source string
+ )
+
+ it.Before(func() {
+ var err error
+ name, err = occam.RandomName()
+ Expect(err).NotTo(HaveOccurred())
+ source, err = occam.Source(filepath.Join("testdata", "npm_no_start_script"))
+ Expect(err).NotTo(HaveOccurred())
+ })
+
+ it.After(func() {
+ Expect(docker.Container.Remove.Execute(container.ID)).To(Succeed())
+ Expect(docker.Image.Remove.Execute(image.ID)).To(Succeed())
+ Expect(docker.Volume.Remove.Execute(occam.CacheVolumeNames(name))).To(Succeed())
+ Expect(os.RemoveAll(source)).To(Succeed())
+ })
+
+ it("builds a working OCI image for a simple app using node-start exclusively", func() {
+ var err error
+ var logs fmt.Stringer
+ image, logs, _ = pack.WithNoColor().Build.
+ WithBuildpacks(nodeBuildpack).
+ WithPullPolicy("never").
+ Execute(name, source)
+ Expect(err).NotTo(HaveOccurred())
+
+ Expect(logs).To(ContainLines(ContainSubstring("Node Engine Buildpack")))
+ Expect(logs).To(ContainLines(ContainSubstring("NPM Install Buildpack")))
+ Expect(logs).To(ContainLines(ContainSubstring("Node Module Bill of Materials Generator Buildpack")))
+ Expect(logs).To(ContainLines(ContainSubstring("Node Start Buildpack")))
+ Expect(logs).NotTo(ContainLines(ContainSubstring("NPM Start Buildpack")))
+ Expect(logs).NotTo(ContainLines(ContainSubstring("Procfile Buildpack")))
+ Expect(logs).NotTo(ContainLines(ContainSubstring("Environment Variables Buildpack")))
+ Expect(logs).NotTo(ContainLines(ContainSubstring("Image Labels Buildpack")))
+
+ Expect(image.Buildpacks[3].Key).To(Equal("paketo-buildpacks/node-module-bom"))
+
+ container, err = docker.Container.Run.
+ WithEnv(map[string]string{"PORT": "8080"}).
+ WithPublish("8080").
+ WithPublishAll().
+ Execute(image.ID)
+ Expect(err).NotTo(HaveOccurred())
+
+ Eventually(container, "5s").Should(BeAvailable())
+
+ response, err := http.Get(fmt.Sprintf("http://localhost:%s/env", container.HostPort("8080")))
+ Expect(err).NotTo(HaveOccurred())
+ Expect(response.StatusCode).To(Equal(http.StatusOK))
+
+ var env struct {
+ NpmConfigLoglevel string `json:"NPM_CONFIG_LOGLEVEL"`
+ }
+ Expect(json.NewDecoder(response.Body).Decode(&env)).To(Succeed())
+ Expect(env.NpmConfigLoglevel).To(Equal("error"))
+
+ })
+ })
+
+ context("when building a node app that uses npm, has a start script and a src folder", func() {
+ var (
+ image occam.Image
+ container occam.Container
+
+ name string
+ source string
+ )
+
+ it.Before(func() {
+ var err error
+ name, err = occam.RandomName()
+ Expect(err).NotTo(HaveOccurred())
+ source, err = occam.Source(filepath.Join("testdata", "npm_with_src_dir"))
+ Expect(err).NotTo(HaveOccurred())
+ })
+
+ it.After(func() {
+ Expect(docker.Container.Remove.Execute(container.ID)).To(Succeed())
+ Expect(docker.Image.Remove.Execute(image.ID)).To(Succeed())
+ Expect(docker.Volume.Remove.Execute(occam.CacheVolumeNames(name))).To(Succeed())
+ Expect(os.RemoveAll(source)).To(Succeed())
+ })
+
+ it("builds a working OCI image for a simple app using npm-start exclusively", func() {
+ var err error
+ var logs fmt.Stringer
+ image, logs, _ = pack.WithNoColor().Build.
+ WithBuildpacks(nodeBuildpack).
+ WithPullPolicy("never").
+ Execute(name, source)
+ Expect(err).NotTo(HaveOccurred())
+
+ Expect(logs).To(ContainLines(ContainSubstring("Node Engine Buildpack")))
+ Expect(logs).To(ContainLines(ContainSubstring("NPM Install Buildpack")))
+ Expect(logs).To(ContainLines(ContainSubstring("Node Module Bill of Materials Generator Buildpack")))
+ Expect(logs).To(ContainLines(ContainSubstring("NPM Start Buildpack")))
+ Expect(logs).NotTo(ContainLines(ContainSubstring("Node Start Buildpack")))
+ Expect(logs).NotTo(ContainLines(ContainSubstring("Procfile Buildpack")))
+ Expect(logs).NotTo(ContainLines(ContainSubstring("Environment Variables Buildpack")))
+ Expect(logs).NotTo(ContainLines(ContainSubstring("Image Labels Buildpack")))
+
+ Expect(image.Buildpacks[3].Key).To(Equal("paketo-buildpacks/node-module-bom"))
+
+ container, err = docker.Container.Run.
+ WithEnv(map[string]string{"PORT": "8080"}).
+ WithPublish("8080").
+ WithPublishAll().
+ Execute(image.ID)
+ Expect(err).NotTo(HaveOccurred())
+
+ Eventually(container, "5s").Should(BeAvailable())
+
+ response, err := http.Get(fmt.Sprintf("http://localhost:%s/env", container.HostPort("8080")))
+ Expect(err).NotTo(HaveOccurred())
+ Expect(response.StatusCode).To(Equal(http.StatusOK))
+
+ var env struct {
+ NpmConfigLoglevel string `json:"NPM_CONFIG_LOGLEVEL"`
+ }
+ Expect(json.NewDecoder(response.Body).Decode(&env)).To(Succeed())
+ Expect(env.NpmConfigLoglevel).To(Equal("error"))
+
+ })
+ })
+
+ context("when building a node app that uses npm, has a start script and flat working directory", func() {
  var (
  image occam.Image
  container occam.Container
@@ -56,7 +188,7 @@ func testNPM(t *testing.T, context spec.G, it spec.S) {
  Expect(os.RemoveAll(source)).To(Succeed())
  })
 
- it("builds a working OCI image for a simple app", func() {
+ it("builds a working OCI image for a simple app using node-start and npm-start", func() {
  var err error
  var logs fmt.Stringer
  image, logs, err = pack.WithNoColor().Build.

integration/testdata/npm_no_start_script/.gitignore

@@ -0,0 +1 @@
+node_modules/

integration/testdata/npm_no_start_script/README.md

@@ -0,0 +1 @@
+This file here to suppress "npm WARN package.json [email protected] No README data"

integration/testdata/npm_no_start_script/package.json

@@ -0,0 +1,21 @@
+{
+ "name": "simple_app_no_start_script",
+ "version": "0.0.0",
+ "description": "some app",
+ "scripts": {
+ "some-script": "echo \"npm scripts running!\"",
+ "test": "echo \"Error: no test specified\" && exit 1"
+ },
+ "author": "",
+ "license": "",
+ "dependencies": {
+ "leftpad": "~0.0.1"
+ },
+ "repository": {
+ "type": "git",
+ "url": ""
+ },
+ "engines": {
+ "node": "~14"
+ }
+}

integration/testdata/npm_no_start_script/server.js

@@ -0,0 +1,16 @@
+const http = require('http');
+const leftpad = require('leftpad');
+
+const port = process.env.PORT || 8080;
+
+const server = http.createServer((request, response) => {
+ response.end(JSON.stringify(process.env))
+});
+
+server.listen(port, (err) => {
+ if (err) {
+ return console.log('something bad happened', err);
+ }
+
+ console.log(`NOT vendored server is listening on ${port}`);
+});

integration/testdata/npm_with_src_dir/.gitignore

@@ -0,0 +1 @@
+node_modules/

integration/testdata/npm_with_src_dir/README.md

@@ -0,0 +1 @@
+This file here to suppress "npm WARN package.json [email protected] No README data"

integration/testdata/npm_with_src_dir/package.json

@@ -0,0 +1,22 @@
+{
+ "name": "simple_app_with_src_dir",
+ "version": "0.0.0",
+ "description": "some app",
+ "scripts": {
+ "start": "node src/server.js",
+ "some-script": "echo \"npm scripts running!\"",
+ "test": "echo \"Error: no test specified\" && exit 1"
+ },
+ "author": "",
+ "license": "",
+ "dependencies": {
+ "leftpad": "~0.0.1"
+ },
+ "repository": {
+ "type": "git",
+ "url": ""
+ },
+ "engines": {
+ "node": "~14"
+ }
+}

integration/testdata/npm_with_src_dir/src/server.js

@@ -0,0 +1,16 @@
+const http = require('http');
+const leftpad = require('leftpad');
+
+const port = process.env.PORT || 8080;
+
+const server = http.createServer((request, response) => {
+ response.end(JSON.stringify(process.env))
+});
+
+server.listen(port, (err) => {
+ if (err) {
+ return console.log('something bad happened', err);
+ }
+
+ console.log(`NOT vendored server is listening on ${port}`);
+});

integration/testdata/yarn_no_start_script/.gitignore

@@ -0,0 +1 @@
+node_modules/

integration/testdata/yarn_no_start_script/README.md

@@ -0,0 +1 @@
+This file here to suppress "npm WARN package.json [email protected] No README data"

integration/testdata/yarn_no_start_script/package.json

@@ -0,0 +1,18 @@
+{
+ "name": "simple",
+ "version": "0.0.0",
+ "description": "some app",
+ "scripts": {
+ "some-script": "echo \"yarn scripts running!\"",
+ "test": "echo \"Error: no test specified\" && exit 1"
+ },
+ "author": "",
+ "license": "MIT",
+ "dependencies": {
+ "leftpad": "~0.0.1"
+ },
+ "repository": {
+ "type": "git",
+ "url": ""
+ }
+}

integration/testdata/yarn_no_start_script/server.js

@@ -0,0 +1,17 @@
+const http = require('http')
+const leftpad = require('leftpad')
+const port = process.env.PORT || 8080
+
+const requestHandler = (request, response) => {
+ response.end("Hello, World!")
+}
+
+const server = http.createServer(requestHandler)
+
+server.listen(port, (err) => {
+ if (err) {
+ return console.log('something bad happened', err)
+ }
+
+ console.log(`server is listening on ${port}`)
+})

integration/testdata/yarn_no_start_script/yarn.lock

@@ -0,0 +1,8 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+leftpad@~0.0.1:
+ version "0.0.1"
+ resolved "https://registry.yarnpkg.com/leftpad/-/leftpad-0.0.1.tgz#86b1a4de4face180ac545a83f1503523d8fed115"
+ integrity sha1-hrGk3k+s4YCsVFqD8VA1I9j+0RU=

integration/testdata/yarn_with_src_dir/.gitignore

@@ -0,0 +1 @@
+node_modules/

integration/testdata/yarn_with_src_dir/README.md

@@ -0,0 +1 @@
+This file here to suppress "npm WARN package.json [email protected] No README data"

integration/testdata/yarn_with_src_dir/package.json

@@ -0,0 +1,19 @@
+{
+ "name": "simple_app",
+ "version": "0.0.0",
+ "description": "some app",
+ "scripts": {
+ "start": "node src/server.js",
+ "some-script": "echo \"yarn scripts running!\"",
+ "test": "echo \"Error: no test specified\" && exit 1"
+ },
+ "author": "",
+ "license": "MIT",
+ "dependencies": {
+ "leftpad": "~0.0.1"
+ },
+ "repository": {
+ "type": "git",
+ "url": ""
+ }
+}

integration/testdata/yarn_with_src_dir/src/server.js

@@ -0,0 +1,17 @@
+const http = require('http')
+const leftpad = require('leftpad')
+const port = process.env.PORT || 8080
+
+const requestHandler = (request, response) => {
+ response.end("Hello, World!")
+}
+
+const server = http.createServer(requestHandler)
+
+server.listen(port, (err) => {
+ if (err) {
+ return console.log('something bad happened', err)
+ }
+
+ console.log(`server is listening on ${port}`)
+})

integration/testdata/yarn_with_src_dir/yarn.lock

@@ -0,0 +1,8 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+leftpad@~0.0.1:
+ version "0.0.1"
+ resolved "https://registry.yarnpkg.com/leftpad/-/leftpad-0.0.1.tgz#86b1a4de4face180ac545a83f1503523d8fed115"
+ integrity sha1-hrGk3k+s4YCsVFqD8VA1I9j+0RU=