Merge remote-tracking branch 'upstream/main' into main

Author: nunokisc

README.md

@@ -29,14 +29,18 @@ var docker = new Dockerode();
 var compose = new DockerodeCompose(docker);
 
 (async () => {
-  var state = await compose.compose('./test/wordpress.yml', 'wordpress');
+  var state = await compose.up('./test/wordpress.yml', 'wordpress');
   console.log(state);
 })();
 ```
 
+## Documentation
+
+- compose.up(file, project_name)
+- compose.pull(service) 
+
 ## Tests
 
- * `docker pull ubuntu:latest` to prepare your system for the tests.
  * Tests are implemented using `mocha` and `chai`. Run them with `npm test`.
 
 ## Examples

compose.js

@@ -0,0 +1,59 @@
+const yaml = require('js-yaml');
+const fs = require('fs');
+
+const secrets = require('./lib/secrets');
+const volumes = require('./lib/volumes');
+const configs = require('./lib/configs');
+const networks = require('./lib/networks');
+const services = require('./lib/services');
+const tools = require('./lib/tools');
+
+class Compose {
+  constructor(dockerode, file, projectName) {
+    this.docker = dockerode;
+
+    if (file === undefined || projectName === undefined) {
+      throw new Error('please specify a file and a project name');
+    }
+
+    this.file = file;
+    this.projectName = projectName;
+
+    try {
+      this.recipe = yaml.load(fs.readFileSync(file, 'utf8'));
+    } catch (e) {
+      throw e;
+    }
+  }
+
+  async up() {
+    var output = {};
+    try {
+      output.secrets = await secrets(this.docker, this.projectName, this.recipe, output);
+      output.volumes = await volumes(this.docker, this.projectName, this.recipe, output);
+      output.configs = await configs(this.docker, this.projectName, this.recipe, output);
+      output.networks = await networks(this.docker, this.projectName, this.recipe, output);
+      output.services = await services(this.docker, this.projectName, this.recipe, output);
+      return output;
+    } catch (e) {
+      throw e;
+    }
+  }
+
+  //ToDo: create a version with followprogress with onFinished
+  async pull(serviceN) {
+    var streams = [];
+    var serviceNames = (serviceN !== undefined) ? [serviceN] : tools.sortServices(this.recipe);
+    for (var serviceName of serviceNames) {
+      var service = this.recipe.services[serviceName];
+      try {
+        streams.push(await this.docker.pull(service.image));
+      } catch (e) {
+        throw e;
+      }
+    }
+    return streams;
+  }
+}
+
+module.exports = Compose;

examples/compose.js

@@ -0,0 +1,9 @@
+var Dockerode = require('dockerode');
+var DockerodeCompose = require('../compose');
+
+var docker = new Dockerode();
+var compose = new DockerodeCompose(docker, './test/assets/wordpress.yml', 'wordpress');
+
+(async () => {
+  console.log(await compose.pull());
+})();

examples/pull.js

@@ -0,0 +1,10 @@
+var Dockerode = require('dockerode');
+var DockerodeCompose = require('../compose');
+
+var docker = new Dockerode();
+var compose = new DockerodeCompose(docker, './test/assets/wordpress.yml', 'wordpress');
+
+(async () => {
+  var state = await compose.up();
+  console.log(state);
+})();

examples/up.js

@@ -1,4 +1,4 @@
-module.exports = async function (docker, projectName, recipe) {
+module.exports = async function (docker, projectName, recipe, output) {
   var configs = [];
   var configNames = Object.keys(recipe.configs || []);
   for (var configName of configNames) {

lib/compose.js

@@ -1,4 +1,4 @@
-module.exports = async function (docker, projectName, recipe) {
+module.exports = async function (docker, projectName, recipe, output) {
   var networks = [];
   var networkNames = Object.keys(recipe.networks || []);
   for (var networkName of networkNames) {

lib/configs.js

@@ -1,6 +1,6 @@
 const fs = require('fs');
 
-module.exports = async function(docker, projectName, recipe) {
+module.exports = async function(docker, projectName, recipe, output) {
   var secrets = [];
   var secretNames = Object.keys(recipe.secrets || []);
   for (var secretName of secretNames) {

lib/networks.js

@@ -1,6 +1,8 @@
-module.exports = async function (docker, projectName, recipe) {
+const tools = require('./tools');
+
+module.exports = async function (docker, projectName, recipe, output) {
   var services = [];
-  var serviceNames = Object.keys(recipe.services || []);
+  var serviceNames = tools.sortServices(recipe);
   for (var serviceName of serviceNames) {
     var networksToAttach = [];
     var service = recipe.services[serviceName];