Add option to simulate docker-compose down

- Adds option for down
- Adds option to add labels for volumes, networks and services so it can be properly identified by Docker Desktop

Co-Authored-By: Jairo Leon <[email protected]>

Author: userlerueda

.gitignore

@@ -104,3 +104,4 @@ dist
 
 # TernJS port file
 .tern-port
+.DS_Store

.prettierrc.json

@@ -0,0 +1,3 @@
+{
+    "singleQuote": true
+  }

compose.js

@@ -27,15 +27,32 @@ class Compose {
     }
   }
 
+  async down(options) {
+    var output = {};
+    try { 
+      output.file = this.file;
+      output.services = await services.down(this.docker, this.projectName, this.recipe, output, options);
+      output.networks = await networks.down(this.docker, this.projectName, this.recipe, output);
+      if (options !== undefined) {
+        if (options.volumes) {
+          output.volumes = await volumes.down(this.docker, this.projectName, this.recipe, output);
+        }
+      }
+      return output;
+    } catch (e) {
+      throw e;
+    }
+  }
+
   async up(options) {
     var output = {};
     try {
       output.file = this.file;
       output.secrets = await secrets(this.docker, this.projectName, this.recipe, output);
-      output.volumes = await volumes(this.docker, this.projectName, this.recipe, output);
+      output.volumes = await volumes.up(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, options);
+      output.networks = await networks.up(this.docker, this.projectName, this.recipe, output);
+      output.services = await services.up(this.docker, this.projectName, this.recipe, output, options);
       return output;
     } catch (e) {
       throw e;

examples/down.js

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

lib/networks.js

@@ -1,64 +1,121 @@
-module.exports = async function (docker, projectName, recipe, output) {
+async function down(docker, projectName, recipe) {
+  var networks = [];
+  var networkNames = Object.keys(recipe.networks || { default: null });
+  for (var networkName of networkNames) {
+    try {
+      var network = await docker.getNetwork(projectName + '_' + networkName);
+    } catch (e) {}
+
+    try {
+      await network.remove();
+    } catch (e) {}
+  }
+  return networks;
+}
+
+async function up(docker, projectName, recipe, output) {
   var networks = [];
   var networkNames = Object.keys(recipe.networks || []);
   for (var networkName of networkNames) {
     var network = recipe.networks[networkName];
     if (network === null) {
       try {
-        networks.push({ 'name': projectName + '_' + networkName, 'network': await docker.createNetwork({ 'Name': projectName + '_' + networkName, 'CheckDuplicate': true }) });
+        networks.push({
+          name: projectName + '_' + networkName,
+          network: await docker.createNetwork({
+            Name: projectName + '_' + networkName,
+            CheckDuplicate: true,
+          }),
+        });
       } catch (err) {
-        if (err.statusCode == 409 && err.json.message.includes('already exists')) {
-          let returnedNetwork = await docker.listNetworks({ 'filters': { 'name': [projectName + '_' + networkName] } });
-          networks.push({ 'name': projectName + '_' + networkName, 'network': await docker.getNetwork(returnedNetwork[0].Id) });
+        if (
+          err.statusCode == 409 &&
+          err.json.message.includes('already exists')
+        ) {
+          let returnedNetwork = await docker.listNetworks({
+            filters: { name: [projectName + '_' + networkName] },
+          });
+          networks.push({
+            name: projectName + '_' + networkName,
+            network: await docker.getNetwork(returnedNetwork[0].Id),
+          });
         } else {
           throw err;
         }
       }
-      continue
+      continue;
     }
     if (network.external === true) continue;
     var opts = {
-      'Name': projectName + '_' + networkName,
-      'Driver': network.driver,
-      'DriverOpts': network.driver_opts,
-      'Labels': network.labels,
-      'Attachable': network.attachable,
-      'EnableIPv6': network.enable_ipv6,
-      'Internal': network.internal,
-      'CheckDuplicate': true
+      Name: projectName + '_' + networkName,
+      Driver: network.driver,
+      DriverOpts: network.driver_opts,
+      Labels: {
+        ...network.labels,
+        ...{
+          'com.docker.compose.network': 'default',
+          'com.docker.compose.project': projectName,
+        },
+      },
+      Attachable: network.attachable,
+      EnableIPv6: network.enable_ipv6,
+      Internal: network.internal,
+      CheckDuplicate: true,
     };
     if (network.name !== undefined) {
       opts.Name = networkName;
     }
     if (network.ipam !== undefined) {
       opts.IPAM = {
-        'Driver': network.ipam.driver,
-        'Options': network.ipam.options
+        Driver: network.ipam.driver,
+        Options: network.ipam.options,
       };
       if (network.ipam.config !== undefined) {
         opts.IPAM['Config'] = {
-          'Subnet': network.ipam.config.subnet,
-          'IPRange': network.ipam.config.ip_range,
-          'Gateway': network.ipam.config.gateway,
-          'AuxAddress': network.ipam.config.aux_addresses
+          Subnet: network.ipam.config.subnet,
+          IPRange: network.ipam.config.ip_range,
+          Gateway: network.ipam.config.gateway,
+          AuxAddress: network.ipam.config.aux_addresses,
         };
       }
     }
     //if exists we have to compare with the existing network
-    networks.push({ 'name': projectName + '_' + networkName, 'network': await docker.createNetwork(opts) });
+    networks.push({
+      name: projectName + '_' + networkName,
+      network: await docker.createNetwork(opts),
+    });
   }
 
   if (networks.length === 0) {
     try {
-      networks.push({ 'name': projectName + '_default', 'network': await docker.createNetwork({ 'Name': projectName + '_default', 'CheckDuplicate': true }) });
+      networks.push({
+        name: projectName + '_default',
+        network: await docker.createNetwork({
+          Name: projectName + '_default',
+          CheckDuplicate: true,
+        }),
+      });
     } catch (err) {
-      if (err.statusCode == 409 && err.json.message.includes('already exists')) {
-        let returnedNetwork = await docker.listNetworks({ 'filters': { 'name': [projectName + '_default'] } });
-        networks.push({ 'name': projectName + '_' + networkName, 'network': await docker.getNetwork(returnedNetwork[0].Id) });
+      if (
+        err.statusCode == 409 &&
+        err.json.message.includes('already exists')
+      ) {
+        let returnedNetwork = await docker.listNetworks({
+          filters: { name: [projectName + '_default'] },
+        });
+        networks.push({
+          name: projectName + '_' + networkName,
+          network: await docker.getNetwork(returnedNetwork[0].Id),
+        });
       } else {
         throw err;
       }
     }
   }
   return networks;
 }
+
+module.exports = {
+  down,
+  up,
+};