Merge pull request #2 from jkyberneees/env-vars

supporting environment variables

Author: jkyberneees

README.md

@@ -19,6 +19,23 @@ The `/restana-static/config` directory should be populated/overwritten during im
 ```
 > File location : `/restana-static/config/default.json`
 
+### Environment configuration
+Optionally, you can overwrite each configuration entry using corresponding environment variables.
+```bash
+# port
+PORT 
+# cacheEnabled
+CACHE_ENABLED
+# cacheControlHeaderValue
+CACHE_CONTROL_HEADER_VALUE
+# distDirectory
+DIST_DIRECTORY
+# defaultFile
+DEFALUT_FILE
+# logsFormat
+LOGS_FORMAT
+```
+
 ## Adding static files
 The `/restana-static/dist` directory should be populated/overwritten during image creation. 
 > Please consider that default path will change if you overwrite the `distDirectory` config.

server.js

@@ -4,25 +4,39 @@ const path = require('path')
 const cache = require('http-cache-middleware')
 const morgan = require('morgan')
 
-// configuration
-const distDirectory = config.get('distDirectory') || 'dist/'
-const port = config.get('port') || 3000
-const cacheEnabled = config.get('cacheEnabled') || true
-const cacheControlHeaderValue = config.get('cacheControlHeaderValue') || 'public, no-cache, max-age=604800'
-const defaultFile = config.get('defaultFile') || 'index.html'
-const logsFormat = config.get('logsFormat') || 'tiny'
+module.exports = () => {
+  // configuration
+  const {
+    DIST_DIRECTORY,
+    PORT,
+    CACHE_ENABLED,
+    CACHE_CONTROL_HEADER_VALUE,
+    DEFALUT_FILE,
+    LOGS_FORMAT
+  } = process.env
+
+  const distDirectory = DIST_DIRECTORY || config.get('distDirectory') ||
+    'dist/'
+  const port = PORT || config.get('port') ||
+    3000
+  const cacheEnabled = isCacheEnabled(CACHE_ENABLED, config)
+  const cacheControlHeaderValue = CACHE_CONTROL_HEADER_VALUE || config.get('cacheControlHeaderValue') ||
+    'public, no-cache, max-age=604800'
+  const defaultFile = DEFALUT_FILE || config.get('defaultFile') ||
+    'index.html'
+  const logsFormat = LOGS_FORMAT || config.get('logsFormat') ||
+    'tiny'
 
-// middleware for serving static files
-const serve = files(path.join(__dirname, distDirectory), {
-  lastModified: false,
-  setHeaders: (res) => {
-    if (cacheEnabled) {
-      res.setHeader('cache-control', cacheControlHeaderValue)
+  // middleware for serving static files
+  const serve = files(path.join(__dirname, distDirectory), {
+    lastModified: false,
+    setHeaders: (res) => {
+      if (cacheEnabled) {
+        res.setHeader('cache-control', cacheControlHeaderValue)
+      }
     }
-  }
-})
+  })
 
-module.exports = () => {
   // server bootstrap
   const server = require('restana')({})
   server.use(morgan(logsFormat))
@@ -43,3 +57,12 @@ module.exports = () => {
     port
   }
 }
+
+function isCacheEnabled (env, config) {
+  if (env !== undefined) {
+    if (env === 'true') return true
+    else return false
+  } else {
+    return config.get('cacheEnabled') || true
+  }
+}

tests/smoke.test.js renamed to tests/1.config-files.test.js

@@ -4,7 +4,7 @@
 const expect = require('chai').expect
 const request = require('supertest')
 
-describe('Restana Web Framework - Smoke', () => {
+describe('Smoke - Config files', () => {
   let server
 
   it('should successfully start server', async () => {

tests/2.environment-configuration.test.js

@@ -0,0 +1,32 @@
+'use strict'
+
+/* global describe, it */
+const expect = require('chai').expect
+const request = require('supertest')
+
+describe('Smoke - Environment based configuration', () => {
+  let server
+
+  it('should successfully start server - env based config', async () => {
+    process.env.PORT = 5000
+    process.env.CACHE_ENABLED = false
+
+    const { server: service, port } = require('../server')()
+
+    server = await service.start(port)
+  })
+
+  it('should GET index.html', async () => {
+    await request(server)
+      .get('/')
+      .expect(200)
+      .then((res) => {
+        expect(res.text).to.equal('<h1>Hello from restana-static!</h1>')
+        expect(res.headers['cache-control']).to.equal('public, max-age=0')
+      })
+  })
+
+  it('should successfully terminate the server', async () => {
+    await server.close()
+  })
+})