1.0.53

.gitlab-ci.yml

@@ -39,6 +39,8 @@ snyk:
 # ====================
 
 testLTS:
+  services:
+    - docker:18-dind
   stage: test
   script:
   - npmci npm prepare
@@ -48,7 +50,7 @@ testLTS:
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
-  - notpriv
+  - priv
 
 testBuild:
   stage: test

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojoio/docker",
-  "version": "1.0.41",
+  "version": "1.0.53",
   "description": "easy communication with docker remote api from node, TypeScript ready",
   "private": false,
   "main": "dist/index.js",
@@ -27,19 +27,20 @@
   },
   "homepage": "https://gitlab.com/pushrocks/dockersock#README",
   "dependencies": {
-    "@pushrocks/lik": "^3.0.10",
+    "@pushrocks/lik": "^3.0.11",
     "@pushrocks/smartlog": "^2.0.19",
+    "@pushrocks/smartnetwork": "^1.1.14",
     "@pushrocks/smartpromise": "^3.0.2",
-    "@pushrocks/smartrequest": "^1.1.16",
-    "rxjs": "^6.5.2"
+    "@pushrocks/smartrequest": "^1.1.26",
+    "rxjs": "^6.5.3"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.11",
+    "@gitzone/tsbuild": "^2.1.17",
     "@gitzone/tsrun": "^1.2.8",
     "@gitzone/tstest": "^1.0.24",
-    "@pushrocks/tapbundle": "^3.0.11",
-    "@types/node": "^12.7.1",
-    "tslint": "^5.18.0",
+    "@pushrocks/tapbundle": "^3.0.13",
+    "@types/node": "^12.7.4",
+    "tslint": "^5.19.0",
     "tslint-config-prettier": "^1.18.0"
   },
   "files": [

test/test.ts

@@ -1,13 +1,18 @@
 import { expect, tap } from '@pushrocks/tapbundle';
 import * as docker from '../ts/index';
+import { DockerService } from '../ts/index';
 
 let testDockerHost: docker.DockerHost;
 
 tap.test('should create a new Dockersock instance', async () => {
-  testDockerHost = new docker.DockerHost();
+  testDockerHost = new docker.DockerHost('http://unix:/var/run/docker.sock:');
   return expect(testDockerHost).to.be.instanceof(docker.DockerHost);
 });
 
+tap.test('should create a docker swarm', async () => {
+  await testDockerHost.activateSwarm();
+});
+
 // Containers
 tap.test('should list containers', async () => {
   const containers = await testDockerHost.getContainers();
@@ -37,7 +42,7 @@ tap.test('should remove a network', async () => {
 tap.test('should pull an image from imagetag', async () => {
   const image = await docker.DockerImage.createFromRegistry(testDockerHost, {
     imageUrl: 'hosttoday/ht-docker-node',
-    tag: 'alpine'
+    imageTag: 'alpine'
   });
   expect(image).to.be.instanceOf(docker.DockerImage);
   console.log(image);
@@ -52,4 +57,31 @@ tap.test('should return a change Observable', async tools => {
   subscription.unsubscribe();
 });
 
+// SERVICES
+tap.test('should activate swarm mode', async () => {
+  await testDockerHost.activateSwarm();
+});
+
+tap.test('should list all services', async tools => {
+  const services = await testDockerHost.getServices();
+  console.log(services);
+});
+
+tap.test('should create a service', async () => {
+  const testNetwork = await docker.DockerNetwork.createNetwork(testDockerHost, {
+    Name: 'testNetwork'
+  });
+  const testService = await DockerService.createService(testDockerHost, {
+    Image: 'nginx:latest',
+    Labels: {    
+      'testlabel': 'hi'
+    },
+    Name: 'testService',
+    networks: [testNetwork],
+    networkAlias: 'testService'
+  });
+  await testService.remove();
+  await testNetwork.remove();
+});
+
 tap.start();

ts/docker.classes.container.ts

@@ -49,7 +49,10 @@ export class DockerContainer {
     if (response.statusCode < 300) {
       plugins.smartlog.defaultLogger.log('info', 'Container created successfully');
     } else {
-      plugins.smartlog.defaultLogger.log('error', 'There has been a problem when creating the container');
+      plugins.smartlog.defaultLogger.log(
+        'error',
+        'There has been a problem when creating the container'
+      );
     }
   }
 

ts/docker.classes.host.ts

@@ -1,6 +1,7 @@
 import * as plugins from './docker.plugins';
 import { DockerContainer } from './docker.classes.container';
 import { DockerNetwork } from './docker.classes.network';
+import { DockerService } from './docker.classes.service';
 
 export class DockerHost {
   /**
@@ -12,8 +13,16 @@ export class DockerHost {
    * the constructor to instantiate a new docker sock instance
    * @param pathArg
    */
-  constructor(pathArg: string = 'http://unix:/var/run/docker.sock:') {
-    this.socketPath = pathArg;
+  constructor(pathArg?: string) {
+    let pathToUse: string;
+    if (pathArg) {
+      pathToUse = pathArg;
+    } else if (process.env.CI) {
+      pathToUse = 'http://docker:2375/';
+    } else {
+      pathToUse = 'http://unix:/var/run/docker.sock:';
+    }
+    this.socketPath = pathToUse;
   }
 
   /**
@@ -21,9 +30,12 @@ export class DockerHost {
    * @param userArg
    * @param passArg
    */
-  public async auth(registryArg: string, userArg: string, passArg: string) {
-    // TODO: implement Docker Registry authentication
-    await this.request('POST', '');
+  public async auth(registryUrl: string, userArg: string, passArg: string) {
+    const response = await this.request('POST', '/auth', {
+      serveraddress: registryUrl,
+      username: userArg,
+      password: passArg,
+    });
   }
 
   /**
@@ -41,6 +53,14 @@ export class DockerHost {
     return containerArray;
   }
 
+  /**
+   * gets all services
+   */
+  public async getServices() {
+    const serviceArray = await DockerService.getServices(this);
+    return serviceArray;
+  }
+
   /**
    *
    */
@@ -65,10 +85,22 @@ export class DockerHost {
   /**
    * activates docker swarm
    */
-  public async activateSwarm(addvertisementIpArg: string) {
+  public async activateSwarm(addvertisementIpArg?: string) {
+    // determine advertisement address
+    let addvertisementIp: string;
+    if (addvertisementIpArg) {
+      addvertisementIp = addvertisementIpArg;
+    } else {
+      const smartnetworkInstance = new plugins.smartnetwork.SmartNetwork();
+      const defaultGateway = await smartnetworkInstance.getDefaultGateway();
+      if (defaultGateway) {
+        addvertisementIp = defaultGateway.ipv4.address;
+      }
+    }
+
     const response = await this.request('POST', '/swarm/init', {
       ListenAddr: '0.0.0.0:2377',
-      AdvertiseAddr: `${addvertisementIpArg}:2377`,
+      AdvertiseAddr: addvertisementIp,
       DataPathPort: 4789,
       DefaultAddrPool: ['10.10.0.0/8', '20.20.0.0/8'],
       SubnetSize: 24,
@@ -92,7 +124,8 @@ export class DockerHost {
         'Content-Type': 'application/json',
         Host: 'docker.sock'
       },
-      requestBody: dataArg
+      requestBody: dataArg,
+      keepAlive: false
     });
     if (response.statusCode !== 200) {
       console.log(response.body);
@@ -107,10 +140,11 @@ export class DockerHost {
       {
         method: methodArg,
         headers: {
-          // 'Content-Type': 'application/json',
+          'Content-Type': 'application/json',
           Host: 'docker.sock'
         },
-        requestBody: null
+        requestBody: null,
+        keepAlive: false
       },
       true
     );

ts/docker.classes.image.ts

@@ -13,7 +13,7 @@ export class DockerImage {
     return images;
   }
 
-  public static async findImageByName (dockerHost: DockerHost, imageNameArg: string) {
+  public static async findImageByName(dockerHost: DockerHost, imageNameArg: string) {
     const images = await this.getImages(dockerHost);
     return images.find(image => {
       return image.RepoTags.includes(imageNameArg);
@@ -24,20 +24,47 @@ export class DockerImage {
     dockerHostArg: DockerHost,
     creationObject: interfaces.IImageCreationDescriptor
   ): Promise<DockerImage> {
+
+    // lets create a sanatized imageUrlObject
+    const imageUrlObject: {
+      imageUrl: string;
+      imageTag: string;
+      imageOriginTag: string;
+    } = {
+      imageUrl: creationObject.imageUrl,
+      imageTag: creationObject.imageTag,
+      imageOriginTag: null
+    };
+    if (imageUrlObject.imageUrl.includes(':')) {
+      const imageUrl = imageUrlObject.imageUrl.split(':')[0];
+      const imageTag = imageUrlObject.imageUrl.split(':')[1];
+      if (imageUrlObject.imageTag) {
+        throw new Error(
+          `imageUrl ${imageUrlObject.imageUrl} can't be tagged with ${
+            imageUrlObject.imageTag
+          } because it is already tagged with ${imageTag}`
+        );
+      } else {
+        imageUrlObject.imageTag = imageTag;
+      }
+    } else if (!imageUrlObject.imageTag) {
+      imageUrlObject.imageTag = 'latest';
+    }
+    imageUrlObject.imageOriginTag = `${imageUrlObject.imageUrl}:${imageUrlObject.imageTag}`;
+
+    // lets actually create the image
     const response = await dockerHostArg.request(
       'POST',
       `/images/create?fromImage=${encodeURIComponent(
-        creationObject.imageUrl
-      )}&tag=${encodeURIComponent(creationObject.tag)}`
+        imageUrlObject.imageUrl
+      )}&tag=${encodeURIComponent(imageUrlObject.imageTag)}`
     );
     if (response.statusCode < 300) {
       plugins.smartlog.defaultLogger.log(
         'info',
-        `Successfully pulled image ${creationObject.imageUrl} from the registry`
+        `Successfully pulled image ${imageUrlObject.imageUrl} from the registry`
       );
-      const originTag = `${creationObject.imageUrl}:${creationObject.tag}`;
-      console.log(originTag)
-      const image = await DockerImage.findImageByName(dockerHostArg, originTag);
+      const image = await DockerImage.findImageByName(dockerHostArg, imageUrlObject.imageOriginTag);
       return image;
     } else {
       plugins.smartlog.defaultLogger.log('error', `Failed at the attempt of creating a new image`);
@@ -85,32 +112,17 @@ export class DockerImage {
     });
   }
 
-  /**
-   * returns a boolean wether the image has a upstream image
-   */
-  public isUpstreamImage(): boolean {
-    // TODO: implement isUpastreamImage
-    return this.RepoTags.length > 0;
-  }
-
-  public tagImage(newTag) {
-
-  }
+  public tagImage(newTag) {}
 
   /**
    * pulls the latest version from the registry
    */
   public async pullLatestImageFromRegistry(): Promise<boolean> {
-    const dockerImageUrl = this.RepoTags[0].split(':')[0];
-    const dockerImageTag = this.RepoTags[0].split(':')[1];
     const updatedImage = await DockerImage.createFromRegistry(this.dockerHost, {
-      imageUrl: dockerImageUrl,
-      tag: dockerImageTag
+      imageUrl: this.RepoTags[0]
     });
     Object.assign(this, updatedImage);
     // TODO: Compare image digists before and after
     return true;
   }
-
-
 }

ts/docker.classes.network.ts

@@ -8,7 +8,9 @@ export class DockerNetwork {
     const dockerNetworks: DockerNetwork[] = [];
     const response = await dockerHost.request('GET', '/networks');
     for (const networkObject of response.body) {
-      dockerNetworks.push(new DockerNetwork(dockerHost, networkObject));
+      const dockerNetwork = new DockerNetwork(dockerHost);
+      Object.assign(dockerNetwork, networkObject);
+      dockerNetworks.push(dockerNetwork);
     }
     return dockerNetworks;
   }
@@ -41,12 +43,15 @@ export class DockerNetwork {
       Attachable: true,
       Ingress: false
     });
-    if (response.statusCode < 300 ) {
+    if (response.statusCode < 300) {
       plugins.smartlog.defaultLogger.log('info', 'Created network successfully');
       return await DockerNetwork.getNetworkByName(dockerHost, networkCreationDescriptor.Name);
     } else {
-      plugins.smartlog.defaultLogger.log('error', 'There has been an error creating the wanted network');
-      return null
+      plugins.smartlog.defaultLogger.log(
+        'error',
+        'There has been an error creating the wanted network'
+      );
+      return null;
     }
   }
 
@@ -75,11 +80,8 @@ export class DockerNetwork {
     ];
   };
 
-  constructor(dockerHostArg: DockerHost, dockerNetworkObjectArg: any) {
+  constructor(dockerHostArg: DockerHost) {
     this.dockerHost = dockerHostArg;
-    Object.keys(dockerNetworkObjectArg).forEach(keyArg => {
-      this[keyArg] = dockerNetworkObjectArg[keyArg];
-    });
   }
 
   /**

ts/docker.classes.service.ts

@@ -2,5 +2,92 @@ import * as plugins from './docker.plugins';
 import * as interfaces from './interfaces';
 
 import { DockerHost } from './docker.classes.host';
+import { DockerImage } from './docker.classes.image';
 
-export class DockerService {}
+export class DockerService {
+  // STATIC
+  public static async getServices(dockerHost: DockerHost) {
+    const services: DockerService[] = [];
+    const response = await dockerHost.request('GET', '/services');
+    for (const serviceObject of response.body) {
+      const dockerService = new DockerService(dockerHost);
+      Object.assign(dockerService, serviceObject);
+      services.push(dockerService);
+    }
+    return services;
+  }
+
+  public static async getServiceByName(dockerHost: DockerHost, networkName: string): Promise<DockerService> {
+    const allServices = await DockerService.getServices(dockerHost);
+    const wantedService = allServices.find(service => {
+      return service.Spec.Name === networkName;
+    });
+    return wantedService;
+  }
+
+  /**
+   * creates a service
+   */
+  public static async createService(
+    dockerHost: DockerHost,
+    serviceCreationDescriptor: interfaces.IServiceCreationDescriptor
+  ): Promise<DockerService> {
+    // lets get the image
+    plugins.smartlog.defaultLogger.log('info', `downloading image for service ${serviceCreationDescriptor.Name}`);
+    const serviceImage = await DockerImage.createFromRegistry(dockerHost, {
+      imageUrl: serviceCreationDescriptor.Image
+    });
+
+    const networkArray: any[] = [];
+    for (const network of serviceCreationDescriptor.networks) {
+      networkArray.push({
+        Target: network.Name,
+        Aliases: [serviceCreationDescriptor.networkAlias]
+      });
+    }
+
+    const response = await dockerHost.request('POST', '/services/create', {
+      Name: serviceCreationDescriptor.Name,
+      TaskTemplate: {
+        ContainerSpec: {
+          Image: serviceCreationDescriptor.Image,
+          Labels: serviceCreationDescriptor.Labels
+        }
+      },
+      Labels: serviceCreationDescriptor.Labels,
+      Networks: networkArray
+    });
+
+    const createdService = await DockerService.getServiceByName(dockerHost, serviceCreationDescriptor.Name);
+    return createdService;
+  }
+
+  // INSTANCE
+  public dockerHostRef: DockerHost;
+  
+  public ID: string;
+  public Version: { Index: number };
+  public CreatedAt: string;
+  public UpdatedAt: string;
+  public Spec: {
+    Name: string;
+    Labels: [any]; // ZBD
+    TaskTemplate: [any],
+    Mode: [any];
+    Networks: [any[]]
+  };
+  public Endpoint: { Spec: {}, VirtualIPs: [any[]] };
+
+
+  constructor(dockerHostArg: DockerHost) {
+    this.dockerHostRef = dockerHostArg;
+  }
+
+  public async update() {
+    
+  }
+
+  public async remove() {
+    await this.dockerHostRef.request('DELETE', `/services/${this.ID}`);
+  }
+}

ts/docker.plugins.ts

@@ -1,12 +1,13 @@
 // @pushrocks scope
 import * as lik from '@pushrocks/lik';
 import * as smartlog from '@pushrocks/smartlog';
+import * as smartnetwork from '@pushrocks/smartnetwork';
 import * as smartpromise from '@pushrocks/smartpromise';
 import * as smartrequest from '@pushrocks/smartrequest';
 
 smartlog.defaultLogger.enableConsole();
 
-export { lik, smartlog, smartpromise, smartrequest };
+export { lik, smartlog, smartnetwork, smartpromise, smartrequest };
 
 // third party
 import * as rxjs from 'rxjs';

ts/interfaces/image.ts

@@ -1,4 +1,4 @@
 export interface IImageCreationDescriptor {
   imageUrl: string;
-  tag: string;
-}
+  imageTag?: string;
+}

ts/interfaces/index.ts

@@ -3,3 +3,4 @@ export * from './image';
 export * from './label';
 export * from './network';
 export * from './port';
+export * from './service';

ts/interfaces/service.ts

@@ -0,0 +1,10 @@
+import * as interfaces from './';
+import { DockerNetwork } from '../docker.classes.network';
+
+export interface IServiceCreationDescriptor {
+  Name: string;
+  Image: string;
+  Labels: interfaces.TLabels;
+  networks: DockerNetwork[];
+  networkAlias: string;
+}