From a live coding session to get this in running different environment. (#647)

Running the test environment lead to problem with the docker network
type `host`.

Instead the redis and mongo container are not available via hostname
instad of 127.0.0.1.

On the CI server both services still needs to be used from 127.0.01

Author: mschultheiss83

.env.example

@@ -0,0 +1,2 @@
+export STEAM_API_KEY=YOUR_KEY_HERE
+export STEAM_ID=YOUR_ID_HERE

doc/Testing.md

@@ -1,8 +1,10 @@
 # Testing
 
-Following tests are automatically executed on a new PR and new commits on master.
-
+### if you want to test in a local environment:
+ - create a .env file in root see .env.example
+ 
+### Following tests are automatically executed on a new PR and new commits on master:
  - Checking Code style
  - Starting a private server and checking for controller upgrade with a certain time.
 
- Unit tests would be nice.
+Unit tests would be nice.

docker-compose-setup.yml

@@ -20,10 +20,17 @@ services:
     environment:
       - STEAM_API_KEY
       - STEAM_ID
+      - MONGO_HOST=mongo
+      - REDIS_HOST=redis
+    env_file:
+      - .env
     depends_on:
       - redis
       - mongo
-    network_mode: "host"
+    #network_mode: "host"
+    ports:
+      - 21025:21025
+      - 21026:21026
   logs:
     image: node:12
     working_dir: /mnt
@@ -37,4 +44,4 @@ services:
       - server
     network_mode: "host"
     profiles:
-      - donotstart
+      - donotstart

docker-compose.yml

@@ -20,7 +20,14 @@ services:
     environment:
       - STEAM_API_KEY
       - STEAM_ID
+      - MONGO_HOST=mongo
+      - REDIS_HOST=redis
+    env_file:
+      - .env
     depends_on:
       - redis
       - mongo
-    network_mode: "host"
+    #network_mode: "host"
+    ports:
+      - 21025:21025
+      - 21026:21026

utils/test.js

@@ -4,7 +4,7 @@ const _ = require('lodash');
 
 const {setPassword, sleep, initServer, startServer, spawnBots, helpers, logConsole, followLog} = require('./testHelpers');
 
-const {cliPort, verbose, tickDuration, playerRoom, players, rooms, milestones} = require('./testConfig');
+const {cliPort, verbose, tickDuration, waitForConnection, playerRoom, players, rooms, milestones} = require('./testConfig');
 
 const controllerRooms = {};
 const status = {};
@@ -52,7 +52,7 @@ class Tester {
    * @param {object} defer
    * @return {undefined}
    */
-  async checkForSucces(line, defer) {
+  async checkForSuccess(line, defer) {
     if (botsSpawned && line.startsWith(`'OK'`)) {
       let appendix = '';
       if (this.maxRuntime > 0) {
@@ -97,7 +97,7 @@ class Tester {
     const defer = q.defer();
     const socket = net.connect(cliPort, '127.0.0.1');
 
-    socket.on('data', async (raw) => {
+    socket.on('data', async(raw) => {
       const data = raw.toString('utf8');
       const line = data.replace(/^< /, '').replace(/\n< /, '');
       if (await spawnBots(line, socket, rooms, players, tickDuration)) {
@@ -115,11 +115,11 @@ class Tester {
         return;
       }
 
-      await this.checkForSucces(line, defer);
+      await this.checkForSuccess(line, defer);
     });
 
     socket.on('connect', () => {
-      console.log('connected');
+      console.log(new Date().toString(), `${lastTick} connected`);
     });
     socket.on('error', (error) => {
       defer.reject(error);
@@ -132,7 +132,8 @@ class Tester {
     const start = Date.now();
     await initServer();
     await startServer();
-    await sleep(5);
+    console.log(new Date().toString(), 'waiting for connection');
+    await sleep(waitForConnection);
     let exitCode = 0;
     try {
       await this.execute();

utils/testConfig.js

@@ -4,6 +4,10 @@ module.exports.verbose = false;
 
 module.exports.tickDuration = 10;
 
+// todo for local-testing
+// if your machine is slow try increment this
+module.exports.waitForConnection = 10;
+
 module.exports.playerRoom = 'W7N4';
 const players = {
   'W1N7': {x: 43, y: 35},

utils/testHelpers.js

@@ -13,6 +13,7 @@ let hostname = '127.0.0.1';
 function setHostname(newHostname) {
   hostname = newHostname;
 }
+
 module.exports.setHostname = setHostname;
 
 /**
@@ -43,14 +44,16 @@ async function followLog(rooms, logConsole, statusUpdater, restrictToRoom) {
 
     await api.auth();
 
-    api.socket.connect();
+    await api.socket.connect();
     api.socket.on('connected', ()=> {});
     api.socket.on('auth', (event)=> {});
-    api.socket.subscribe('console', logConsole(room));
-    api.socket.subscribe('room:' + room, statusUpdater);
+    await api.socket.subscribe('console', logConsole(room));
+    await api.socket.subscribe('room:' + room, statusUpdater);
   }
-  return new Promise(() => {});
+  return new Promise(() => {
+  });
 }
+
 module.exports.followLog = followLog;
 
 /**
@@ -92,6 +95,7 @@ module.exports.setPassword = setPassword;
 function sleep(seconds) {
   return new Promise((resolve) => setTimeout(resolve, seconds * 1000));
 }
+
 module.exports.sleep = sleep;
 
 async function initServer() {
@@ -107,6 +111,15 @@ async function initServer() {
   const configFilename = path.resolve(dir, '.screepsrc');
   let config = fs.readFileSync(configFilename, {encoding: 'utf8'});
   config = config.replace(/{{STEAM_KEY}}/, process.env.STEAM_API_KEY);
+  config += '\n\n';
+  if (process.env.MONGO_HOST) {
+    config += '[mongo]\n';
+    config += `host = ${process.env.MONGO_HOST}\n\n`;
+  }
+  if (process.env.REDIS_HOST) {
+    config += '[redis]\n';
+    config += `host = ${process.env.REDIS_HOST}\n\n`;
+  }
   fs.writeFileSync(configFilename, config);
   fs.chmodSync(path.resolve(dir, 'node_modules/.hooks/install'), '755');
   fs.chmodSync(path.resolve(dir, 'node_modules/.hooks/uninstall'), '755');
@@ -127,6 +140,7 @@ async function initServer() {
     console.log(e);
   }
 }
+
 module.exports.initServer = initServer;
 
 /**
@@ -139,13 +153,14 @@ async function startServer() {
   process.chdir(dir);
   return lib.start({}, process.stdout);
 }
+
 module.exports.startServer = startServer;
 
 /**
  * logs event
  *
  * @param {string} room
- * @return {void}
+ * @return {function}
  */
 const logConsole = function(room) {
   return (event) => {