run: add System Package sample and align ignore files (GoogleCloudPlatform#1487)

grayside · fhinkel · commit 6ab38b17fc2d · 2019-10-01T13:54:49.000-04:00
* run: add System Package sample and align ignore files

* run/system-package: add full license headers

* improved readability and package.json correctness
diff --git a/.kokoro/run/system-package.cfg b/.kokoro/run/system-package.cfg
@@ -0,0 +1,7 @@
+# Format: //devtools/kokoro/config/proto/build.proto
+
+# Set the folder in which the tests are run
+env_vars: {
+    key: "PROJECT"
+    value: "run/system-package"
+}
diff --git a/run/README.md b/run/README.md
@@ -9,10 +9,11 @@
 |                 Sample                  |        Description       |     Deploy    |
 | --------------------------------------- | ------------------------ | ------------- |
 |[Hello World][helloworld]&nbsp;&#10149;  | Quickstart | [<img src="https://storage.googleapis.com/cloudrun/button.svg" alt="Run on Google Cloud" height="30"/>][run_button_helloworld] |
-|[Hello Broken][hello_broken]             | Something is wrong, how do you fix it? | [<img src="https://storage.googleapis.com/cloudrun/button.svg" alt="Run on Google Cloud" height="30"/>][run_button_hello_broken] |
+|[System Packages][system_package]       | Use system-installed binaries in your service. | [<img src="https://storage.googleapis.com/cloudrun/button.svg" alt="Run on Google Cloud" height="30">][run_button_system_package] |
 |[Pub/Sub][pubsub]                        | Event-driven service with a Pub/Sub push subscription | [<img src="https://storage.googleapis.com/cloudrun/button.svg" alt="Run on Google Cloud" height="30"/>][run_button_pubsub] |
 |[Image Processing][image_processing]     | Event-driven image analysis & transformation | [<img src="https://storage.googleapis.com/cloudrun/button.svg" alt="Run on Google Cloud" height="30"/>][run_button_image_processing] |
 |[Manual Logging][manual_logging]         | Structured logging without client library | [<img src="https://storage.googleapis.com/cloudrun/button.svg" alt="Run on Google Cloud" height="30"/>][run_button_manual_logging] |
+|[Hello Broken][hello_broken]             | Something is wrong, how do you fix it? | [<img src="https://storage.googleapis.com/cloudrun/button.svg" alt="Run on Google Cloud" height="30"/>][run_button_hello_broken] |
 
 For more Cloud Run samples beyond Node.js, see the main list in the [Cloud Run Samples repository](https://github.com/GoogleCloudPlatform/cloud-run-samples).
 
@@ -111,12 +112,14 @@ for more information.
 [run_build]: https://cloud.google.com/run/docs/building/containers
 [run_deploy]: https://cloud.google.com/run/docs/deploying
 [helloworld]: https://github.com/knative/docs/tree/master/docs/serving/samples/hello-world/helloworld-nodejs
-[hello_broken]: hello-broken/
+[system_package]: system-package/
 [pubsub]: pubsub/
 [image_processing]: image-processing/
 [manual_logging]: logging-manual/
+[hello_broken]: hello-broken/
 [run_button_helloworld]: https://console.cloud.google.com/cloudshell/editor?shellonly=true&cloudshell_image=gcr.io/cloudrun/button&cloudshell_git_repo=https://github.com/knative/docs&cloudshell_working_dir=docs/serving/samples/hello-world/helloworld-nodejs
-[run_button_hello_broken]: https://console.cloud.google.com/cloudshell/editor?shellonly=true&cloudshell_image=gcr.io/cloudrun/button&cloudshell_git_repo=https://github.com/GoogleCloudPlatform/nodejs-docs-samples&cloudshell_working_dir=run/hello-broken
+[run_button_system_package]: https://console.cloud.google.com/cloudshell/editor?shellonly=true&cloudshell_image=gcr.io/cloudrun/button&cloudshell_git_repo=https://github.com/GoogleCloudPlatform/nodejs-docs-samples&cloudshell_working_dir=run/system-package
 [run_button_pubsub]: https://console.cloud.google.com/cloudshell/editor?shellonly=true&cloudshell_image=gcr.io/cloudrun/button&cloudshell_git_repo=https://github.com/GoogleCloudPlatform/nodejs-docs-samples&cloudshell_working_dir=run/pubsub
 [run_button_image_processing]: https://console.cloud.google.com/cloudshell/editor?shellonly=true&cloudshell_image=gcr.io/cloudrun/button&cloudshell_git_repo=https://github.com/GoogleCloudPlatform/nodejs-docs-samples&cloudshell_working_dir=run/image-processing
 [run_button_manual_logging]: https://console.cloud.google.com/cloudshell/editor?shellonly=true&cloudshell_image=gcr.io/cloudrun/button&cloudshell_git_repo=https://github.com/GoogleCloudPlatform/nodejs-docs-samples&cloudshell_working_dir=run/logging-manual
+[run_button_hello_broken]: https://console.cloud.google.com/cloudshell/editor?shellonly=true&cloudshell_image=gcr.io/cloudrun/button&cloudshell_git_repo=https://github.com/GoogleCloudPlatform/nodejs-docs-samples&cloudshell_working_dir=run/hello-broken
diff --git a/run/image-processing/.gcloudignore b/run/image-processing/.gcloudignore
@@ -1,3 +1,3 @@
-.gcloudignore
+.git
 node_modules
 npm-debug.log
diff --git a/run/logging-manual/.dockerignore b/run/logging-manual/.dockerignore
@@ -1,3 +1,4 @@
 Dockerfile
 .dockerignore
 node_modules
+npm-debug.log
diff --git a/run/logging-manual/.gcloudignore b/run/logging-manual/.gcloudignore
@@ -1,2 +1,3 @@
 .git
 node_modules
+npm-debug.log
diff --git a/run/logging-manual/package.json b/run/logging-manual/package.json
@@ -1,8 +1,8 @@
 {
   "name": "logging-manual",
-  "version": "1.0.0",
   "description": "Demonstrates logging on Cloud Run",
   "main": "index.js",
+  "private": true,
   "repository": {
     "type": "git",
     "url": "https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git"
diff --git a/run/pubsub/.gcloudignore b/run/pubsub/.gcloudignore
@@ -1,3 +1,3 @@
-.gcloudignore
+.git
 node_modules
 npm-debug.log
diff --git a/run/pubsub/README.md b/run/pubsub/README.md
@@ -9,4 +9,6 @@ For more details on how to work with this sample read the [Google Cloud Run Node
 ## Dependencies
 
 * **express**: Web server framework.
-* **body-parser**: express middleware for request payload processing.
+* **body-parser**: express middleware for request payload processing.
+* **mocha**: [development] Test running framework.
+* **supertest**: [development] HTTP assertion test client.
diff --git a/run/system-package/.dockerignore b/run/system-package/.dockerignore
@@ -0,0 +1,4 @@
+Dockerfile
+.dockerignore
+node_modules
+npm-debug.log
diff --git a/run/system-package/.gcloudignore b/run/system-package/.gcloudignore
@@ -0,0 +1,3 @@
+.git
+node_modules
+npm-debug.log
diff --git a/run/system-package/Dockerfile b/run/system-package/Dockerfile
@@ -0,0 +1,40 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Use the official super-lightweight Node image.
+# https://hub.docker.com/_/node
+FROM node:10-alpine
+
+# Create and change to the app directory.
+WORKDIR /usr/src/app
+
+# [START run_system_package_alpine]
+RUN apk --no-cache add graphviz ttf-ubuntu-font-family
+# [END run_system_package_alpine]
+
+# Copy application dependency manifests to the container image.
+# A wildcard is used to ensure both package.json AND package-lock.json are copied.
+# Copying this separately prevents re-running npm install on every code change.
+COPY package*.json ./
+
+# Install dependencies.
+# If you add a package-lock.json speed your build by switching to 'npm ci'.
+# RUN npm ci --only=production
+RUN npm install --only=production
+
+# Copy local code to the container image.
+COPY . .
+
+# Run the web service on container startup.
+CMD [ "npm", "start" ]
diff --git a/run/system-package/README.md b/run/system-package/README.md
@@ -0,0 +1,13 @@
+# Cloud Run System Package Sample
+
+This sample shows how to use a CLI tool installed as a system package as part of a web service.
+
+Use it with the [Using system packages tutorial](https://cloud.google.com/run/docs/tutorials/system-packages).
+
+For more details on how to work with this sample read the [Google Cloud Run Node.js Samples README](https://github.com/GoogleCloudPlatform/nodejs-docs-samples/run).
+
+## Dependencies
+
+* **express**: Web server framework.
+* **mocha**: [development] Test running framework.
+* **supertest**: [development] HTTP assertion test client.
diff --git a/run/system-package/app.js b/run/system-package/app.js
@@ -0,0 +1,68 @@
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+const {execSync} = require('child_process');
+const fs = require('fs');
+
+const express = require('express');
+const app = express();
+
+// Verify the the dot utility is available at startup
+// instead of waiting for a first request.
+fs.accessSync('/usr/bin/dot', fs.constants.X_OK);
+
+// [START run_system_package_handler]
+app.get('/diagram.png', (req, res) => {
+  try {
+    const image = createDiagram(req.query.dot);
+    res.setHeader('Content-Type', 'image/png');
+    res.setHeader('Content-Length', image.length);
+    res.setHeader('Cache-Control', 'public, max-age=86400');
+    res.send(image);
+  } catch (err) {
+    console.error(`error: ${err.message}`);
+    const errDetails = (err.stderr || err.message).toString();
+    if (errDetails.includes('syntax')) {
+      res.status(400).send(`Bad Request: ${err.message}`);
+    } else {
+      res.status(500).send('Internal Server Error');
+    }
+  }
+});
+// [END run_system_package_handler]
+
+// [START run_system_package_exec]
+// Generate a diagram based on a graphviz DOT diagram description.
+const createDiagram = dot => {
+  if (!dot) {
+    throw new Error('syntax: no graphviz definition provided');
+  }
+
+  // Adds a watermark to the dot graphic.
+  const dotFlags = [
+    '-Glabel="Made on Cloud Run"',
+    '-Gfontsize=10',
+    '-Glabeljust=right',
+    '-Glabelloc=bottom',
+    '-Gfontcolor=gray',
+  ].join(' ');
+
+  const image = execSync(`/usr/bin/dot ${dotFlags} -Tpng`, {
+    input: dot,
+  });
+  return image;
+};
+// [END run_system_package_exec]
+
+module.exports = app;
diff --git a/run/system-package/index.js b/run/system-package/index.js
@@ -0,0 +1,18 @@
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+const app = require('./app.js');
+const PORT = process.env.PORT || 8080;
+
+app.listen(PORT, () => console.log(`graphviz-web listening on port ${PORT}`));
diff --git a/run/system-package/package.json b/run/system-package/package.json
@@ -0,0 +1,18 @@
+{
+  "name": "graphviz-web",
+  "version": "1.0.0",
+  "description": "Demonstrates a Cloud Run service which provides a CLI tool over HTTP.",
+  "main": "index.js",
+  "private": true,
+  "scripts": {
+    "start": "node index.js",
+    "test": "mocha test/app.test.js"
+  },
+  "dependencies": {
+    "express": "^4.17.1"
+  },
+  "devDependencies": {
+    "mocha": "^6.2.0",
+    "supertest": "^4.0.2"
+  }
+}
diff --git a/run/system-package/test/app.test.js b/run/system-package/test/app.test.js
@@ -0,0 +1,80 @@
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+'use strict';
+
+const path = require('path');
+const supertest = require('supertest');
+
+describe('Unit Tests', () => {
+  const app = require(path.join(__dirname, '..', 'app'));
+  const request = supertest(app);
+
+  describe('should fail', () => {
+    const errorContentType = 'text/html; charset=utf-8';
+
+    it(`should fail on a Bad Request with an empty query string`, async () => {
+      await request
+        .get('/diagram.png')
+        .type('text')
+        .expect(400)
+        .expect('Content-Type', errorContentType)
+        .expect(res => {
+          if (res.headers['cache-control']) {
+            throw new Error('Found cache header on uncached response');
+          }
+        });
+    });
+
+    it(`should fail on a Bad Request with an empty dot parameter`, async () => {
+      await request
+        .get('/diagram.png')
+        .type('text')
+        .query({dot: ''})
+        .expect(400)
+        .expect('Content-Type', errorContentType)
+        .expect(res => {
+          if (res.headers['cache-control']) {
+            throw new Error('Found cache header on uncached response');
+          }
+        });
+    });
+
+    it(`should fail on a Bad Request with an invalid payload`, async () => {
+      await request
+        .get(`/diagram.png`)
+        .type('text')
+        .query({dot: `digraph`})
+        .expect(400)
+        .expect('Content-Type', errorContentType)
+        .expect(res => {
+          if (res.headers['cache-control']) {
+            throw new Error('Found cache header on uncached response');
+          }
+        });
+    });
+  });
+
+  describe('should succeed', () => {
+    it(`should succeed with a valid DOT description`, async () => {
+      await request
+        .get(`/diagram.png`)
+        .type(`text`)
+        .query({dot: `digraph G { A -> {B, C, D} -> {F} }`})
+        .expect(200)
+        .expect('Content-Type', 'image/png')
+        .expect('Cache-Control', 'public, max-age=86400');
+    });
+  });
+});

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`.git`
`2`	`2`	`node_modules`
	`3`	`+npm-debug.log`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+.git`
	`2`	`+node_modules`
	`3`	`+npm-debug.log`