Added support for Docker, GitHub Actions and graceful shutdown

.dockerignore

@@ -0,0 +1,2 @@
+node_modules
+.git

.github/workflows/javascript.yaml

@@ -0,0 +1,26 @@
+name: JavaScript files
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: [ '10.x', '12.x', '14.x' ]
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Node
+      uses: actions/setup-node@v1
+      with:
+        node-version: '${{ matrix.node }}'
+    - name: Install
+      run: npm install
+    - name: Lint via prettier
+      run: npm run prettier
+    - name: Lint via eslint
+      run: npm run eslint
+    - name: Test
+      run: npm run test

Dockerfile

@@ -0,0 +1,9 @@
+FROM node:12-alpine
+WORKDIR /src
+COPY package* ./
+ENV NODE_ENV=production
+RUN npm install
+EXPOSE 8080
+VOLUME /data
+COPY . .
+CMD ["node","bin/s3rver.js", "-p", "8080", "-d", "/data"]

README.md

@@ -3,12 +3,13 @@
 [![NPM](https://nodei.co/npm/s3rver.png)](https://nodei.co/npm/s3rver/)
 
 [![Build Status](https://api.travis-ci.org/jamhall/s3rver.png)](https://travis-ci.org/jamhall/s3rver)
+![JavaScript files](https://github.com/jamhall/s3rver/workflows/JavaScript%20files/badge.svg)
 [![Dependency Status](https://david-dm.org/jamhall/s3rver/status.svg)](https://david-dm.org/jamhall/s3rver)
 [![Devdependency Status](https://david-dm.org/jamhall/s3rver/dev-status.svg)](https://david-dm.org/jamhall/s3rver?type=dev)
 
 S3rver is a lightweight server that responds to **some** of the same calls [Amazon S3](http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html) responds to. It is extremely useful for testing S3 in a sandbox environment without actually making calls to Amazon.
 
-The goal of S3rver is to minimise runtime dependencies and be more of a development tool to test S3 calls in your code rather than a production server looking to duplicate S3 functionality.
+The goal of S3rver is to minimize runtime dependencies and be more of a development tool to test S3 calls in your code rather than a production server looking to duplicate S3 functionality.
 
 ## Supported methods
 
@@ -31,6 +32,8 @@ The goal of S3rver is to minimise runtime dependencies and be more of a developm
 
 ## Quick Start
 
+### NodeJS
+
 Install s3rver:
 
 ```bash
@@ -45,6 +48,24 @@ Executing this command for the various options:
 $ s3rver --help
 ```
 
+### Docker
+
+Build image
+
+```bash
+$ npm run docker:build
+```
+
+You will now have a image `jamhall/s3rver:latest` available.
+
+Executing this command to start server:
+
+```bash
+$ npm run docker:start
+```
+
+Server will listen on port `8080`.
+
 ## Supported clients
 
 Please see [Fake S3's wiki page](https://github.com/jubos/fake-s3/wiki/Supported-Clients) for a list of supported clients.

bin/s3rver.js

@@ -91,7 +91,20 @@ program.on('--help', () => {
 program.action(async command => {
   const { configureBucket, ...opts } = command.opts();
   opts.configureBuckets = configureBucket;
-  const { address, port } = await new S3rver(opts).run();
+
+  const server = new S3rver(opts);
+  const { address, port } = await server.run();
+
+  process.on('SIGINT', async function onSigint() {
+    console.info('Got SIGINT. Graceful shutdown ', new Date().toISOString());
+    await server.stop();
+  });
+
+  process.on('SIGTERM', async function onSigterm() {
+    console.info('Got SIGTERM. Graceful shutdown ', new Date().toISOString());
+    await server.stop();
+  });
+
   console.log();
   console.log('S3rver listening on %s:%d', address, port);
 });

lib/s3rver.js

@@ -9,6 +9,7 @@ const https = require('https');
 const os = require('os');
 const path = require('path');
 const { callbackify, format, promisify } = require('util');
+const stoppable = require('stoppable');
 
 const loggerMiddleware = require('./middleware/logger');
 const vhostMiddleware = require('./middleware/vhost');
@@ -132,6 +133,21 @@ class S3rver extends Koa {
     this.store.reset();
   }
 
+  /**
+   * Gracefully stops the S3rver server.
+   *
+   * @param {Function} [callback] Function called with (err, addressObj) as arguments.
+   * @returns {this|Promise} The S3rver instance. If no callback function is supplied, a Promise
+   *   is returned.
+   */
+  stop(callback) {
+    if (typeof callback === 'function') {
+      return this.httpServer.stop(callback);
+    } else {
+      return new Promise(resolve => this.httpServer.stop(resolve));
+    }
+  }
+
   /**
    * Starts the HTTP server.
    *
@@ -145,6 +161,8 @@ class S3rver extends Koa {
 
       const { address, port, ...listenOptions } = this.serverOptions;
       this.httpServer = await this.listen(port, address, listenOptions);
+      stoppable(this.httpServer);
+
       return this.httpServer.address();
     };
 

package.json

@@ -28,7 +28,10 @@
     "test": "mocha",
     "eslint": "eslint --ignore-path .gitignore .",
     "prettier": "prettier --ignore-path .gitignore \"**/*.{js,json,md}\"",
-    "format": "npm run eslint -- --fix && npm run prettier -- --write"
+    "format": "npm run eslint -- --fix && npm run prettier -- --write",
+    "docker:build": "docker build -t jamhall/s3rver:latest .",
+    "docker:push":"docker build -t jamhall/s3rver:latest .",
+    "docker:start": "docker run -v $(pwd)/data:/data -p 8080:8080 jamhall/s3rver:latest"
   },
   "main": "lib/s3rver.js",
   "files": [
@@ -58,6 +61,7 @@
     "koa-logger": "^3.2.0",
     "lodash": "^4.17.5",
     "statuses": "^2.0.0",
+    "stoppable": "^1.1.0",
     "winston": "^3.0.0"
   },
   "devDependencies": {