docs

Author: siloenix

command/BaseCommand.js

@@ -14,6 +14,10 @@ module.exports = class Command {
     }
   }
 
+  /**
+   * Runs all the dependencies first, then _runInternal()
+   * @returns singleton promise for previous operations
+   * */
   run() {
     if (!this.executable) {
       this.executable = Promise.all(this.dependencies.map(command => command.run()))
@@ -22,13 +26,19 @@ module.exports = class Command {
     return this.executable;
   }
 
+  /**
+   * Must be implemented by child classes
+   * */
   _runInternal() {
-    log.warn('Command run on base class. Please define "_runInternal()" on the child class');
-    return Promise.reject();
+    const message = 'Command run on base class. Please define "_runInternal()" on the child class';
+    return Promise.reject(new Error(message));
   }
 
+  /**
+   * Must be implemented by child classes
+   * */
   cleanUp() {
-    log.warn('method "cleanUp()" not defined. Please define "cleanUp()" on the child class');
-    return Promise.reject();
+    const message = 'Method "cleanUp()" not defined. Please define "cleanUp()" on the child class';
+    return Promise.reject(new Error(message));
   }
 };

command/NetworkCommand.js

@@ -2,6 +2,9 @@ const log = require('../logger');
 const timer = require('../helpers/timer');
 const BaseCommand = require('./BaseCommand');
 
+/**
+ * simulated network creation
+ * */
 module.exports = class NetworkCommand extends BaseCommand {
   constructor(name, options) {
     super(name, options)

command/ServiceCommand.js

@@ -9,6 +9,11 @@ module.exports = class ServiceCommand extends BaseCommand {
     super(name, options)
   }
 
+  /**
+   * 1) pulls image
+   * 2) creates container
+   * 3) runs container
+   * */
   async _runInternal() {
     const {image} = this.options;
     await docker.pull(image);

command/VolumeCommand.js

@@ -2,6 +2,9 @@ const log = require('../logger');
 const timer = require('../helpers/timer');
 const BaseCommand = require('./BaseCommand');
 
+/**
+ * simulated volume creation
+ * */
 module.exports = class VolumeCommand extends BaseCommand {
   constructor(name, options) {
     super(name, options)

controllers/DockerController.js

@@ -20,6 +20,10 @@ module.exports = class DockerController {
 };
 
 const mimetype = 'text/yaml';
+
+/**
+ * extract first yaml from request
+ * */
 function extractYaml(files) {
   for (const name in files) {
     if (files.hasOwnProperty(name) && files[name].mimetype === mimetype) {

docker/client.js

@@ -7,6 +7,11 @@ class DockerClient extends Docker {
     super(options)
   }
 
+  /**
+   * promise wrapper for docker.pull() with some improvements:
+   * 1) adds tag to image name, if not exists
+   * 2) "streams" the pulling process and returns promise
+   * */
   async pull(image) {
     if (!image.includes(':')) {
       image = `${image}:latest`;

services/DockerService.js

@@ -5,12 +5,22 @@ const ServiceCommand = require('../command/ServiceCommand');
 const NetworkCommand = require('../command/NetworkCommand');
 const VolumeCommand = require('../command/VolumeCommand');
 
+/**
+ * Service for applying "docker-compose" files.
+ * */
 module.exports = class DockerService {
   static applyYaml(fileContent) {
     const directives = yaml.parseSync(fileContent);
     return this.applyDirectives(directives);
   }
 
+  /**
+   * Creates and runs containers for "services".
+   * Runs dependencies before its` dependants.
+   * Removes all created containers after 5 sec.
+   *
+   * volumes and networks are yet simulated
+   * */
   static async applyDirectives({services, volumes = {}, networks = {}}) {
     const commands = {};