1.0.47

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "test.ts",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "test/test.ts"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

README.md

@@ -21,22 +21,13 @@ unofficial docker engine api abstraction package written in TypeScript
 Use TypeScript for best in class instellisense.
 
 ```typescript
-import {Dockersock} from "dockersock"; // require Dockersock class
+import { DockerHost } from '@mojoio/docker'; // require Dockersock class
 
-let myDockersock = new Dockersock(); // optional: you can pass a domain to the contructor, defaults to  /var/run/docker.sock
+const run = async () => {
+  const myDockerHost = new DockerHost(); // optional: you can pass a domain to the contructor, defaults to  /var/run/docker.sock
 
-myDockersock.listContainers() // promise, resolve gets container data
-myDockersock.listContainersDetailed() // promise, resolve gets more detailed container data (by combining several requests internally)
-myDockersock.listContainersRunning() // promise, resolve gets container data for currently running containers
-myDockersock.listContainersStopped() // promise, resolve gets container data for stopped containers
-
-myDockersock.startContainer({ // starts a already present container
-    name: "somecontainername"
-})
-
-myDockersock.newContainer({ // start new Container, equals "docker run" shell command
-    image: "someimagetag"
-})
+  const containers = await myDockerHost.getContainers(); // promise, resolve with an array of DockerContainers
+};
 ```
 
 For further information read the linked docs at the top of this readme.

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojoio/docker",
-  "version": "1.0.35",
+  "version": "1.0.47",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojoio/docker",
-  "version": "1.0.35",
+  "version": "1.0.47",
   "description": "easy communication with docker remote api from node, TypeScript ready",
   "private": false,
   "main": "dist/index.js",

test/test.ts

@@ -1,23 +1,50 @@
 import { expect, tap } from '@pushrocks/tapbundle';
-import { DockerHost } from '../ts/index';
+import * as docker from '../ts/index';
+import { DockerService } from '../ts/index';
 
-let testDockerHost: DockerHost;
+let testDockerHost: docker.DockerHost;
 
 tap.test('should create a new Dockersock instance', async () => {
-  testDockerHost = new DockerHost();
-  return expect(testDockerHost).to.be.instanceof(DockerHost);
+  testDockerHost = new docker.DockerHost();
+  return expect(testDockerHost).to.be.instanceof(docker.DockerHost);
 });
 
+// Containers
 tap.test('should list containers', async () => {
   const containers = await testDockerHost.getContainers();
   console.log(containers);
 });
 
-tap.skip.test('should pull an image from imagetag', async () => {
-  // await testDockerHost.pullImage('hosttoday/ht-docker-node:npmci');
+// Networks
+tap.test('should list networks', async () => {
+  const networks = await testDockerHost.getNetworks();
+  console.log(networks);
 });
 
-tap.test('should return a change Objservable', async tools => {
+tap.test('should create a network', async () => {
+  const newNetwork = await docker.DockerNetwork.createNetwork(testDockerHost, {
+    Name: 'webgateway'
+  });
+  expect(newNetwork).to.be.instanceOf(docker.DockerNetwork);
+  expect(newNetwork.Name).to.equal('webgateway');
+});
+
+tap.test('should remove a network', async () => {
+  const webgateway = await docker.DockerNetwork.getNetworkByName(testDockerHost, 'webgateway');
+  await webgateway.remove();
+});
+
+// Images
+tap.test('should pull an image from imagetag', async () => {
+  const image = await docker.DockerImage.createFromRegistry(testDockerHost, {
+    imageUrl: 'hosttoday/ht-docker-node',
+    imageTag: 'alpine'
+  });
+  expect(image).to.be.instanceOf(docker.DockerImage);
+  console.log(image);
+});
+
+tap.test('should return a change Observable', async tools => {
   const testObservable = await testDockerHost.getEventObservable();
   const subscription = testObservable.subscribe(changeObject => {
     console.log(changeObject);
@@ -26,4 +53,29 @@ tap.test('should return a change Objservable', 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 docker.DockerService.getServices(testDockerHost);
+  console.log(services);
+});
+
+tap.test('should create a service', async () => {
+  const testNetwork = await docker.DockerNetwork.createNetwork(testDockerHost, {
+    Name: 'testNetwork'
+  });
+  await DockerService.createService(testDockerHost, {
+    Image: 'nginx:latest',
+    Labels: {    
+      'testlabel': 'hi'
+    },
+    Name: 'testService',
+    networks: [testNetwork],
+    networkAlias: 'testService'
+  });
+});
+
 tap.start();

ts/docker.changes.ts

@@ -1 +0,0 @@
-import * as plugins from './dockersock.plugins';

ts/docker.classes.container.ts

@@ -1,12 +1,10 @@
-import * as plugins from './dockersock.plugins';
+import * as plugins from './docker.plugins';
 import * as interfaces from './interfaces';
 
 import { DockerHost } from './docker.classes.host';
 
 export class DockerContainer {
-  // ======
   // STATIC
-  // ======
 
   /**
    * get all containers
@@ -17,7 +15,7 @@ export class DockerContainer {
 
     // TODO: Think about getting the config by inpsecting the container
     for (const containerResult of response.body) {
-      result.push(new DockerContainer(containerResult));
+      result.push(new DockerContainer(dockerHostArg, containerResult));
     }
     return result;
   }
@@ -26,35 +24,55 @@ export class DockerContainer {
    * gets an container by Id
    * @param containerId
    */
-  public static async getContainerById(containerId: string) {}
+  public static async getContainerById(containerId: string) {
+    // TODO: implement get container by id
+  }
 
   /**
    * create a container
    */
-  public static async create(creationSpecifier: interfaces.IContainerCreationSpecifier) {}
-
-  // ========
-  // INSTANCE
-  // ========
-
-  constructor(dockerContainerObjectArg: any) {
-    Object.keys(dockerContainerObjectArg).forEach(keyArg => {
-      this[keyArg] = dockerContainerObjectArg[keyArg];
+  public static async create(
+    dockerHost: DockerHost,
+    containerCreationDescriptor: interfaces.IContainerCreationDescriptor
+  ) {
+    // check for unique hostname
+    const existingContainers = await DockerContainer.getContainers(dockerHost);
+    const sameHostNameContainer = existingContainers.find(container => {
+      // TODO implement HostName Detection;
+      return false;
     });
+    const response = await dockerHost.request('POST', '/containers/create', {
+      Hostname: containerCreationDescriptor.Hostname,
+      Domainname: containerCreationDescriptor.Domainname,
+      User: 'root'
+    });
+    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'
+      );
+    }
   }
 
-  Id: string;
-  Names: string[];
-  Image: string;
-  ImageID: string;
-  Command: string;
-  Created: number;
-  Ports: interfaces.TPorts;
-  Labels: interfaces.TLabels;
-  State: string;
-  Status: string;
-  HostConfig: any;
-  NetworkSettings: {
+  // INSTANCE
+  // references
+  public dockerHost: DockerHost;
+
+  // properties
+  public Id: string;
+  public Names: string[];
+  public Image: string;
+  public ImageID: string;
+  public Command: string;
+  public Created: number;
+  public Ports: interfaces.TPorts;
+  public Labels: interfaces.TLabels;
+  public State: string;
+  public Status: string;
+  public HostConfig: any;
+  public NetworkSettings: {
     Networks: {
       [key: string]: {
         IPAMConfig: any;
@@ -73,5 +91,11 @@ export class DockerContainer {
       };
     };
   };
-  Mounts: any;
+  public Mounts: any;
+  constructor(dockerHostArg: DockerHost, dockerContainerObjectArg: any) {
+    this.dockerHost = dockerHostArg;
+    Object.keys(dockerContainerObjectArg).forEach(keyArg => {
+      this[keyArg] = dockerContainerObjectArg[keyArg];
+    });
+  }
 }

ts/docker.classes.host.ts

@@ -1,23 +1,19 @@
-import * as plugins from './dockersock.plugins';
+import * as plugins from './docker.plugins';
 import { DockerContainer } from './docker.classes.container';
+import { DockerNetwork } from './docker.classes.network';
 
 export class DockerHost {
   /**
    * the path where the docker sock can be found
    */
-  sockPath: string;
-
-  /**
-   * keeping track of currently active requests to safely end this module at any time
-   */
-  requestObjectmap = new plugins.lik.Objectmap<any>();
+  public socketPath: string;
 
   /**
    * the constructor to instantiate a new docker sock instance
    * @param pathArg
    */
   constructor(pathArg: string = 'http://unix:/var/run/docker.sock:') {
-    this.sockPath = pathArg;
+    this.socketPath = pathArg;
   }
 
   /**
@@ -25,21 +21,30 @@ export class DockerHost {
    * @param userArg
    * @param passArg
    */
-  auth(registryArg: string, userArg: string, passArg: string) {
-    let done = plugins.smartpromise.defer();
-    this.request('POST', '');
-    return done.promise;
+  public async auth(registryArg: string, userArg: string, passArg: string) {
+    // TODO: implement Docker Registry authentication
+    await this.request('POST', '');
+  }
+
+  /**
+   * gets all networks
+   */
+  public async getNetworks() {
+    return await DockerNetwork.getNetworks(this);
+  }
+
+  /**
+   * gets all containers
+   */
+  public async getContainers() {
+    const containerArray = await DockerContainer.getContainers(this);
+    return containerArray;
   }
 
   /**
    *
    */
-  async getContainers() {
-    const containerArray = await DockerContainer.getContainers(this);
-    return containerArray;
-  }
-
-  async getEventObservable(): Promise<plugins.rxjs.Observable<any>> {
+  public async getEventObservable(): Promise<plugins.rxjs.Observable<any>> {
     const response = await this.requestStreaming('GET', '/events');
     return plugins.rxjs.Observable.create(observer => {
       response.on('data', data => {
@@ -57,11 +62,30 @@ export class DockerHost {
     });
   }
 
+  /**
+   * activates docker swarm
+   */
+  public async activateSwarm(addvertisementIpArg?: string) {
+    const response = await this.request('POST', '/swarm/init', {
+      ListenAddr: '0.0.0.0:2377',
+      AdvertiseAddr: addvertisementIpArg ? `${addvertisementIpArg}:2377` : undefined,
+      DataPathPort: 4789,
+      DefaultAddrPool: ['10.10.0.0/8', '20.20.0.0/8'],
+      SubnetSize: 24,
+      ForceNewCluster: false
+    });
+    if (response.statusCode === 200) {
+      plugins.smartlog.defaultLogger.log('info', 'created Swam succesfully');
+    } else {
+      plugins.smartlog.defaultLogger.log('error', 'could not initiate swarm');
+    }
+  }
+
   /**
    * fire a request
    */
-  async request(methodArg: string, routeArg: string, dataArg = {}) {
-    const requestUrl = `${this.sockPath}${routeArg}`;
+  public async request(methodArg: string, routeArg: string, dataArg = {}) {
+    const requestUrl = `${this.socketPath}${routeArg}`;
     const response = await plugins.smartrequest.request(requestUrl, {
       method: methodArg,
       headers: {
@@ -70,11 +94,14 @@ export class DockerHost {
       },
       requestBody: dataArg
     });
+    if (response.statusCode !== 200) {
+      console.log(response.body);
+    }
     return response;
   }
 
-  async requestStreaming(methodArg: string, routeArg: string, dataArg = {}) {
-    const requestUrl = `${this.sockPath}${routeArg}`;
+  public async requestStreaming(methodArg: string, routeArg: string, dataArg = {}) {
+    const requestUrl = `${this.socketPath}${routeArg}`;
     const response = await plugins.smartrequest.request(
       requestUrl,
       {

ts/docker.classes.image.ts

@@ -1,38 +1,128 @@
-import * as plugins from './dockersock.plugins';
+import * as plugins from './docker.plugins';
+import * as interfaces from './interfaces';
 import { DockerHost } from './docker.classes.host';
 
 export class DockerImage {
   // STATIC
-  public static async createFromRegistry(
-    dockerHostArg: DockerHost,
-    dockerImageTag
-  ): Promise<DockerImage> {
-    const resultingImage = new DockerImage();
-
-    return resultingImage;
+  public static async getImages(dockerHost: DockerHost) {
+    const images: DockerImage[] = [];
+    const response = await dockerHost.request('GET', '/images/json');
+    for (const imageObject of response.body) {
+      images.push(new DockerImage(dockerHost, imageObject));
+    }
+    return images;
   }
 
-  public static async createFromExistingImage(dockerHostArg: DockerHost, dockerImageTag) {}
+  public static async findImageByName(dockerHost: DockerHost, imageNameArg: string) {
+    const images = await this.getImages(dockerHost);
+    return images.find(image => {
+      return image.RepoTags.includes(imageNameArg);
+    });
+  }
+
+  public static async createFromRegistry(
+    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(
+        imageUrlObject.imageUrl
+      )}&tag=${encodeURIComponent(imageUrlObject.imageTag)}`
+    );
+    if (response.statusCode < 300) {
+      plugins.smartlog.defaultLogger.log(
+        'info',
+        `Successfully pulled image ${imageUrlObject.imageUrl} from the registry`
+      );
+      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`);
+    }
+  }
+
+  public static async tagImageByIdOrName(
+    dockerHost: DockerHost,
+    idOrNameArg: string,
+    newTagArg: string
+  ) {
+    const response = await dockerHost.request(
+      'POST',
+      `/images/${encodeURIComponent(idOrNameArg)}/${encodeURIComponent(newTagArg)}`
+    );
+  }
+
+  public static async buildImage(dockerHostArg: DockerHost, dockerImageTag) {
+    // TODO: implement building an image
+  }
 
   // INSTANCE
+  // references
+  public dockerHost: DockerHost;
+
+  // properties
   /**
    * the tags for an image
    */
-  public tags: string[] = [];
+  public Containers: number;
+  public Created: number;
+  public Id: string;
+  public Labels: interfaces.TLabels;
+  public ParentId: string;
+  public RepoDigests: string[];
+  public RepoTags: string[];
+  public SharedSize: number;
+  public Size: number;
+  public VirtualSize: number;
 
-  /**
-   * returns a boolean wether the image has a upstream image
-   */
-  public isUpstreamImage(): boolean {
-    // TODO: implement isUpastreamImage
-    return true;
+  constructor(dockerHostArg, dockerImageObjectArg: any) {
+    this.dockerHost = dockerHostArg;
+    Object.keys(dockerImageObjectArg).forEach(keyArg => {
+      this[keyArg] = dockerImageObjectArg[keyArg];
+    });
   }
 
+  public tagImage(newTag) {}
+
   /**
-   *
+   * pulls the latest version from the registry
    */
   public async pullLatestImageFromRegistry(): Promise<boolean> {
-    // TODO: implement pullLatestImageFromRegistry
+    const updatedImage = await DockerImage.createFromRegistry(this.dockerHost, {
+      imageUrl: this.RepoTags[0]
+    });
+    Object.assign(this, updatedImage);
+    // TODO: Compare image digists before and after
     return true;
   }
 }

ts/docker.classes.network.ts

@@ -1,6 +1,94 @@
-import * as plugins from './dockersock.plugins';
+import * as plugins from './docker.plugins';
 import * as interfaces from './interfaces';
 
 import { DockerHost } from './docker.classes.host';
 
-export class DockerNetwork {}
+export class DockerNetwork {
+  public static async getNetworks(dockerHost: DockerHost): Promise<DockerNetwork[]> {
+    const dockerNetworks: DockerNetwork[] = [];
+    const response = await dockerHost.request('GET', '/networks');
+    for (const networkObject of response.body) {
+      dockerNetworks.push(new DockerNetwork(dockerHost, networkObject));
+    }
+    return dockerNetworks;
+  }
+
+  public static async getNetworkByName(dockerHost: DockerHost, dockerNetworkNameArg: string) {
+    const networks = await DockerNetwork.getNetworks(dockerHost);
+    return networks.find(dockerNetwork => dockerNetwork.Name === dockerNetworkNameArg);
+  }
+
+  public static async createNetwork(
+    dockerHost: DockerHost,
+    networkCreationDescriptor: interfaces.INetworkCreationDescriptor
+  ): Promise<DockerNetwork> {
+    const response = await dockerHost.request('POST', '/networks/create', {
+      Name: networkCreationDescriptor.Name,
+      CheckDuplicate: true,
+      Driver: 'overlay',
+      EnableIPv6: false,
+      IPAM: {
+        Driver: 'default',
+        Config: [
+          {
+            Subnet: '172.20.10.0/16',
+            IPRange: '172.20.10.0/24',
+            Gateway: '172.20.10.11'
+          }
+        ]
+      },
+      Internal: true,
+      Attachable: true,
+      Ingress: false
+    });
+    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;
+    }
+  }
+
+  // INSTANCE
+  // references
+  public dockerHost: DockerHost;
+
+  // properties
+  public Name: string;
+  public Id: string;
+  public Created: string;
+  public Scope: string;
+  public Driver: string;
+  public EnableIPv6: boolean;
+  public Internal: boolean;
+  public Attachable: boolean;
+  public Ingress: false;
+  public IPAM: {
+    Driver: 'default' | 'bridge' | 'overlay';
+    Config: [
+      {
+        Subnet: string;
+        IPRange: string;
+        Gateway: string;
+      }
+    ];
+  };
+
+  constructor(dockerHostArg: DockerHost, dockerNetworkObjectArg: any) {
+    this.dockerHost = dockerHostArg;
+    Object.keys(dockerNetworkObjectArg).forEach(keyArg => {
+      this[keyArg] = dockerNetworkObjectArg[keyArg];
+    });
+  }
+
+  /**
+   * removes the network
+   */
+  public async remove() {
+    const response = await this.dockerHost.request('DELETE', `/networks/${this.Id}`);
+  }
+}

ts/docker.classes.service.ts

@@ -1,6 +1,63 @@
-import * as plugins from './dockersock.plugins';
+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) {
+      services.push(new DockerService(dockerHost, serviceObject));
+    }
+    return services;
+  }
+
+  /**
+   * creates a service
+   */
+  public static async createService(
+    dockerHost: DockerHost,
+    serviceCreationDescriptor: interfaces.IServiceCreationDescriptor
+  ) {
+    // 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]
+      });
+    }
+
+    dockerHost.request('POST', '/services/create', {
+      Name: serviceCreationDescriptor.Name,
+      TaskTemplate: {
+        ContainerSpec: {
+          Image: serviceCreationDescriptor.Image,
+          Labels: serviceCreationDescriptor.Labels
+        }
+      },
+      Labels: serviceCreationDescriptor.Labels,
+      Networks: networkArray
+    });
+  }
+
+  // INSTANCE
+  public dockerHost: DockerHost;
+
+  constructor(dockerHostArg: DockerHost, serviceObject) {
+    this.dockerHost = dockerHostArg;
+    Object.assign(this, serviceObject);
+  }
+
+  update() {
+    // TODO: implemnt updating service
+  }
+}

ts/docker.plugins.ts

@@ -4,6 +4,8 @@ import * as smartlog from '@pushrocks/smartlog';
 import * as smartpromise from '@pushrocks/smartpromise';
 import * as smartrequest from '@pushrocks/smartrequest';
 
+smartlog.defaultLogger.enableConsole();
+
 export { lik, smartlog, smartpromise, smartrequest };
 
 // third party

ts/interfaces/container.ts

@@ -1,7 +1,7 @@
 import { DockerNetwork } from '../docker.classes.network';
 
-export interface IContainerCreationSpecifier {
-  hostname: string;
-  domainName: string;
+export interface IContainerCreationDescriptor {
+  Hostname: string;
+  Domainname: string;
   networks?: DockerNetwork[];
 }

ts/interfaces/image.ts

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

ts/interfaces/index.ts

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

ts/interfaces/network.ts

@@ -0,0 +1,6 @@
+/**
+ * creates a new Network
+ */
+export interface INetworkCreationDescriptor {
+  Name: string;
+}

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;
+}