feat(run): add Cloud Run + Filestore sample

.github/workflows/run-filesystem.yaml

@@ -0,0 +1,62 @@
+# Copyright 2023 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
+#
+#      http://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.
+
+name: run-filesystem
+on:
+  push:
+    branches:
+    - main
+    paths:
+    - 'run/filesystem/**'
+    - '.github/workflows/run-filesystem.yaml'
+  pull_request:
+    paths:
+    - 'run/filesystem/**'
+    - '.github/workflows/run-filesystem.yaml'
+  pull_request_target:
+    types: [labeled]
+    paths:
+    - 'run/filesystem/**'
+    - '.github/workflows/run-filesystem.yaml'
+  schedule:
+  - cron:  '0 0 * * 0'
+jobs:
+  test:
+    # Ref: https://github.com/google-github-actions/auth#usage
+    permissions:
+      contents: 'read'
+      id-token: 'write'
+    if: github.event.action != 'labeled' || github.event.label.name == 'actions:force-run'
+    uses: ./.github/workflows/test.yaml
+    with:
+      name: 'run-filesystem'
+      path: 'run/filesystem'
+  remove_label:
+    # Ref: https://github.com/google-github-actions/auth#usage
+    permissions:
+      contents: 'read'
+      id-token: 'write'
+    if: |
+      github.event.action == 'labeled' &&
+      github.event.label.name == 'actions:force-run' &&
+      always()
+    uses: ./.github/workflows/remove-label.yaml
+  flakybot:
+    # Ref: https://github.com/google-github-actions/auth#usage
+    permissions:
+      contents: 'read'
+      id-token: 'write'
+    if: github.event_name == 'schedule' && always() # always() submits logs even if tests fail
+    uses: ./.github/workflows/flakybot.yaml
+    needs: [test]

.github/workflows/utils/workflows.json

@@ -83,6 +83,7 @@
   "monitoring/snippets",
   "opencensus",
   "retail",
+  "run/filesystem",
   "scheduler",
   "secret-manager",
   "service-directory/snippets",

run/filesystem/Dockerfile

@@ -0,0 +1,50 @@
+# Copyright 2023 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
+#
+#    http://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.
+
+# [START cloudrun_fs_dockerfile]
+
+# Use the official Node.js image.
+# https://hub.docker.com/_/node
+FROM node:20
+
+# Install system dependencies
+RUN apt-get update -y && apt-get install -y \
+    tini \
+    nfs-common \
+    && apt-get clean
+
+# Set fallback mount directory
+ENV MNT_DIR /mnt/nfs/filestore
+
+# Copy local code to the container image.
+ENV APP_HOME /app
+WORKDIR $APP_HOME
+COPY package*.json ./
+
+# Install production dependencies.
+RUN npm install --only=production
+
+# Copy local code to the container image.
+COPY . ./
+
+# Ensure the script is executable
+RUN chmod +x /app/wrapper.sh
+
+# Use tini to manage zombie processes and signal forwarding
+# https://github.com/krallin/tini
+ENTRYPOINT ["/usr/bin/tini", "--"]
+
+# Pass the wrapper script as arguments to tini
+CMD ["/app/wrapper.sh"]
+# [END cloudrun_fs_dockerfile]

run/filesystem/index.js

@@ -0,0 +1,69 @@
+// Copyright 2023 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 express = require('express');
+const rateLimit = require('express-rate-limit');
+const fs = require('fs');
+const serveIndex = require('serve-index');
+
+const app = express();
+const limit = rateLimit({
+  windowMs: 15 * 60 * 1000,
+  max: 100,
+  message: 'Rate limit exceeded',
+  headers: true,
+});
+const mntDir = process.env.MNT_DIR || '/mnt/nfs/filestore';
+const filePrefix = process.env.FILENAME || 'test';
+const port = parseInt(process.env.PORT) || 8080;
+
+app.use(limit);
+app.use('/filesystem', express.static(mntDir));
+app.use('/filesystem', serveIndex(mntDir));
+
+app.get('/', async (req, res) => {
+  await writeFile(mntDir);
+  let html =
+    '<html><body>A new file is generated each time this page is reloaded.<p>Files created on filesystem:<p>';
+  fs.readdirSync(mntDir).forEach(filename => {
+    html += `<a href="${req.protocol}://${req.get(
+      'host'
+    )}/filesystem/${filename}">${filename}</a><br>`;
+  });
+  html += '</body></html>';
+  res.send(html);
+});
+
+app.all('*', (req, res) => {
+  res.redirect('/');
+});
+
+app.listen(port, () => {
+  console.log(`Listening on port ${port}`);
+});
+
+async function writeFile(path) {
+  let date = new Date();
+  date = date.toString().split(' ').join('-');
+  const filename = `${filePrefix}-${date}.txt`;
+  const contents = `This test file was created on ${date}\n`;
+
+  fs.writeFile(`${path}/${filename}`, contents, err => {
+    if (err) {
+      console.error(`could not write to file system:\n${err}`);
+    }
+  });
+}
+
+module.exports = app;

run/filesystem/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "index.js",
+  "description": "Demonstrate accessing a mounted network filesystem from a Cloud Run service.",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {
+    "start": "node index.js",
+    "test": "c8 mocha test/index.test.js --exit",
+    "system-test": "NAME=Cloud c8 mocha test/system.test.js --timeout=180000"
+  },
+  "author": "Google LLC",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "express": "^4.18.2",
+    "express-rate-limit": "^6.7.0",
+    "fs": "0.0.1-security",
+    "serve-index": "^1.9.1"
+  },
+  "devDependencies": {
+    "c8": "^7.14.0",
+    "chai": "^4.3.7",
+    "mocha": "^10.2.0",
+    "mock-fs": "^5.2.0",
+    "supertest": "^6.3.3"
+  }
+}

run/filesystem/test/index.test.js

@@ -0,0 +1,73 @@
+// Copyright 2023 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 path = require('path');
+const supertest = require('supertest');
+const assert = require('chai').expect;
+const mock = require('mock-fs');
+const fs = require('fs');
+const mntDir = process.env.MNT_DIR || '/mnt/nfs/filestore';
+let request;
+const testFileContents = 'Test file contents.';
+describe('Unit tests', () => {
+  const defaultLogFunction = console.log;
+  let consoleOutput = '\n';
+  before(() => {
+    const app = require(path.join(__dirname, '..', 'index'));
+    console.log = msg => {
+      consoleOutput += msg + '\n';
+    };
+    mock({
+      [mntDir]: mock.directory({
+        items: {
+          'test-file.txt': `${testFileContents}`,
+        },
+      }),
+    });
+    request = supertest(app);
+  });
+  after(() => {
+    mock.restore();
+    console.log = defaultLogFunction;
+    console.log('\nconsole.log output:\n---------');
+    console.log(consoleOutput);
+    console.log('---------');
+  });
+  describe('GET /', () => {
+    it('responds with 200 Ok', async () => {
+      const response = await request.get('/');
+      assert(response.status).to.eql(200);
+    });
+    it('writes a file', async () => {
+      await request.get(mntDir);
+      fs.readdir(mntDir, (err, files) => {
+        assert(files.length).to.eql(2);
+      });
+    });
+  });
+  describe('GET nonexistant path', () => {
+    it('responds with 302 Found and redirects to /', async () => {
+      const response = await request.get('/nonexistant');
+      assert(response.header.location).to.eql('/');
+      assert(response.status).to.eql(302);
+    });
+  });
+  describe('GET file path', () => {
+    it('responds with file contents and 200 Ok', async () => {
+      const response = await request.get('/filesystem/test-file.txt');
+      assert(response.text).to.eql(`${testFileContents}`);
+      assert(response.status).to.eql(200);
+    });
+  });
+});

run/filesystem/wrapper.sh

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+# Copyright 2023 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
+#
+#    http://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.
+
+# [START cloudrun_fs_script]
+#!/usr/bin/env bash
+set -eo pipefail
+
+# Create mount directory for service.
+mkdir -p $MNT_DIR
+
+echo "Mounting Cloud Filestore."
+mount -o nolock $FILESTORE_IP_ADDRESS:/$FILE_SHARE_NAME $MNT_DIR
+echo "Mounting completed."
+
+npm start
+# [END cloudrun_fs_script]