Merge branch 'develop', prepare 4.1.0

Author: yamalight

package.json

@@ -1,6 +1,6 @@
 {
   "name": "exoframe-server",
-  "version": "4.0.3",
+  "version": "4.0.4-dev",
   "description": "Exoframe is a self-hosted tool that allows simple one-command deployments using Docker",
   "main": "bin/server-core.js",
   "bin": "bin/exoframe-server.js",

src/docker/start.js

@@ -1,21 +1,11 @@
 // our modules
 const docker = require('./docker');
 const {initNetwork, createNetwork} = require('../docker/network');
-const {getProjectConfig, nameFromImage, projectFromConfig, writeStatus} = require('../util');
-const {getSecretsCollection} = require('../db/secrets');
+const {getProjectConfig, nameFromImage, projectFromConfig, writeStatus, getHost, getEnv} = require('../util');
 const {getConfig} = require('../config');
 const {getPlugins} = require('../plugins');
 const logger = require('../logger');
 
-// try to find secret with current value name and return secret value if present
-const valueOrSecret = (value, secrets) => {
-  const secret = secrets.find(s => `@${s.name}` === value);
-  if (secret) {
-    return secret.value;
-  }
-  return value;
-};
-
 exports.startFromParams = async ({
   image,
   deploymentName,
@@ -166,29 +156,13 @@ exports.start = async ({image, username, folder, resultStream, existing = []}) =
   // get project info
   const config = getProjectConfig(folder);
 
-  // generate host
-  // construct base domain from config, prepend with "." if it's not there
-  const baseDomain = serverConfig.baseDomain ? serverConfig.baseDomain.replace(/^(\.?)/, '.') : undefined;
-  // construc default domain using given base domain
-  const defaultDomain = baseDomain ? `${name}${baseDomain}` : undefined;
-  // construct host
-  const host = config.domain === undefined ? defaultDomain : config.domain;
   // generate project name
   const project = projectFromConfig({username, config});
 
-  // replace env vars values with secrets if needed
-  const secrets = getSecretsCollection().find({user: username});
-  // generate env vars (with secrets)
-  const userEnv = config.env
-    ? Object.keys(config.env).map(key => `${key}=${valueOrSecret(config.env[key], secrets)}`)
-    : [];
-  const exoEnv = [
-    `EXOFRAME_DEPLOYMENT=${name}`,
-    `EXOFRAME_USER=${username}`,
-    `EXOFRAME_PROJECT=${project}`,
-    `EXOFRAME_HOST=${host}`,
-  ];
-  const Env = userEnv.concat(exoEnv);
+  // generate host
+  const host = getHost({serverConfig, name, config});
+
+  const Env = getEnv({username, config, name, project, host}).map((pair) => pair.join('='));
 
   // construct restart policy
   let RestartPolicy = {};

src/docker/templates/compose.js

@@ -5,6 +5,7 @@ const path = require('path');
 const yaml = require('js-yaml');
 const uuid = require('uuid');
 const {spawn} = require('child_process');
+const {getHost, getEnv} = require('../../util');
 
 // generates new base name for deployment
 const generateBaseName = ({username, config}) =>
@@ -63,9 +64,9 @@ const updateCompose = ({username, baseName, serverConfig, composePath}) => {
 };
 
 // function to execute docker-compose file and return the output
-const executeCompose = ({cmd, resultStream, tempDockerDir, folder, writeStatus}) =>
+const executeCompose = ({cmd, resultStream, tempDockerDir, folder, writeStatus, env = {}}) =>
   new Promise(resolve => {
-    const dc = spawn('docker-compose', cmd, {cwd: path.join(tempDockerDir, folder)});
+    const dc = spawn('docker-compose', cmd, {cwd: path.join(tempDockerDir, folder), env: {...process.env, ...env}});
     const log = [];
 
     dc.stdout.on('data', data => {
@@ -137,9 +138,15 @@ exports.executeTemplate = async ({
   util.logger.debug('Compose modified:', composeConfig);
   util.writeStatus(resultStream, {message: 'Compose file modified', data: composeConfig, level: 'verbose'});
 
+  // generate host
+  const host = getHost({serverConfig, name: baseName, config});
+  const env = getEnv({username, config, name: baseName, host})
+    .reduce((merged, [key, value]) => ({...merged, [key]: value}), {});
+
   // re-build images if needed
   const {code: buildExitCode, log: buildLog} = await executeCompose({
     cmd: ['--project-name', baseName, 'build'],
+    env,
     resultStream,
     tempDockerDir,
     folder,
@@ -179,6 +186,7 @@ exports.executeTemplate = async ({
   // execute compose 'up -d'
   const exitCode = await executeCompose({
     cmd: ['--project-name', baseName, 'up', '-d'],
+    env,
     resultStream,
     tempDockerDir,
     folder,

src/util/index.js

@@ -6,10 +6,20 @@ const {spawn} = require('child_process');
 const tar = require('tar-fs');
 const rimraf = require('rimraf');
 const uuid = require('uuid');
+const {getSecretsCollection} = require('../db/secrets');
 
 // our modules
 const {tempDockerDir: tempDir} = require('../config');
 
+// try to find secret with current value name and return secret value if present
+const valueOrSecret = (value, secrets) => {
+  const secret = secrets.find(s => `@${s.name}` === value);
+  if (secret) {
+    return secret.value;
+  }
+  return value;
+};
+
 // cleanup temp folder
 exports.cleanTemp = folder => new Promise(resolve => rimraf(path.join(tempDir, folder), resolve));
 
@@ -81,3 +91,29 @@ exports.compareNames = (nameOne = '', nameTwo = '') => {
   const nameTwoClean = nameTwoParts.slice(0, nameTwoParts.length - 2).join('-');
   return nameOneClean === nameTwoClean;
 };
+
+exports.getHost = ({serverConfig, name, config}) => {
+  // construct base domain from config, prepend with "." if it's not there
+  const baseDomain = serverConfig.baseDomain ? serverConfig.baseDomain.replace(/^(\.?)/, '.') : undefined;
+  // construct default domain using given base domain
+  const defaultDomain = baseDomain ? `${name}${baseDomain}` : undefined;
+  // construct host
+  const host = config.domain === undefined ? defaultDomain : config.domain;
+  return host;
+};
+
+exports.getEnv = ({username, config, name, host, project = config.project || name}) => {
+  // replace env vars values with secrets if needed
+  const secrets = getSecretsCollection().find({ user: username });
+  // generate env vars (with secrets)
+  const userEnv = config.env
+    ? Object.entries(config.env).map(([key, value]) => [key, valueOrSecret(value, secrets)])
+    : [];
+  return [
+    ...userEnv,
+    ['EXOFRAME_DEPLOYMENT', name],
+    ['EXOFRAME_USER', username],
+    ['EXOFRAME_PROJECT', project],
+    ['EXOFRAME_HOST', host],
+  ];
+};

test/__mocks__/util.js

@@ -1,8 +1,9 @@
 /* eslint-env jest */
 // mock util module
+const {runYarn, getProjectConfig, ...actualUtil} = jest.requireActual('../../src/util/index.js');
 const util = jest.genMockFromModule('../../src/util/index.js');
 
 util.runYarn = () => new Promise(r => r());
 util.getProjectConfig = folder => folder;
 
-module.exports = util;
+module.exports = {...util, ...actualUtil};

test/deploy.test.js

@@ -15,6 +15,7 @@ const authToken = require('./fixtures/authToken');
 const {startServer} = require('../src');
 const docker = require('../src/docker/docker');
 const {initNetwork} = require('../src/docker/network');
+const {getSecretsCollection, secretsInited} = require('../src/db/secrets')
 
 // create tar streams
 const streamDockerImage = tar.pack(path.join(__dirname, 'fixtures', 'docker-image-project'));
@@ -400,7 +401,12 @@ test('Should update simple HTML project', async done => {
   done();
 });
 
+const testSecret = {user: 'admin', name: 'test-secret', value: 'custom-secret-value'};
+
 test('Should deploy simple compose project', async done => {
+  await secretsInited;
+  getSecretsCollection().insert(testSecret);
+
   const options = Object.assign(optionsBase, {
     payload: streamCompose,
   });
@@ -451,6 +457,8 @@ test('Should deploy simple compose project', async done => {
   expect(containerOne.Labels['traefik.enable']).toEqual('true');
   expect(containerTwo.Labels['traefik.enable']).toEqual('true');
   expect(containerOne.Labels['traefik.frontend.rule']).toEqual('Host:test.dev');
+  expect(containerOne.Labels['custom.envvar']).toEqual('custom-value');
+  expect(containerOne.Labels['custom.secret']).toEqual('custom-secret-value');
   expect(containerOne.NetworkSettings.Networks.exoframe).toBeDefined();
   expect(containerTwo.NetworkSettings.Networks.exoframe).toBeDefined();
 
@@ -513,6 +521,8 @@ test('Should update simple compose project', async done => {
   expect(containerOne.Labels['traefik.enable']).toEqual('true');
   expect(containerTwo.Labels['traefik.enable']).toEqual('true');
   expect(containerOne.Labels['traefik.frontend.rule']).toEqual('Host:test.dev');
+  expect(containerOne.Labels['custom.envvar']).toEqual('custom-value');
+  expect(containerOne.Labels['custom.secret']).toEqual('custom-secret-value');
   expect(containerOne.NetworkSettings.Networks.exoframe).toBeDefined();
   expect(containerTwo.NetworkSettings.Networks.exoframe).toBeDefined();
 
@@ -535,6 +545,7 @@ test('Should update simple compose project', async done => {
   await instanceOne.remove({force: true});
   const instanceTwo = docker.getContainer(containerTwo.Id);
   await instanceTwo.remove({force: true});
+  getSecretsCollection().remove(testSecret);
 
   done();
 });

test/fixtures/compose-project/docker-compose.yml

@@ -4,5 +4,7 @@ services:
     build: .
     labels:
       traefik.frontend.rule: 'Host:test.dev'
+      custom.envvar: "${CUSTOM_LABEL}"
+      custom.secret: "${CUSTOM_SECRET}"
   redis:
     image: "redis:alpine"

test/fixtures/compose-project/exoframe.json

@@ -1,4 +1,8 @@
 {
   "name": "test-compose-deploy",
-  "restart": "no"
+  "restart": "no",
+  "env": {
+    "CUSTOM_LABEL": "custom-value",
+    "CUSTOM_SECRET": "@test-secret"
+  }
 }