1.0.36

.gitignore

@@ -1,4 +1,22 @@
-.yarn/
+.nogit/
-node_modules/
+
+# artifacts
 coverage/
 public/
+pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_web/
+dist_serve/
+dist_ts_web/
+
+# custom

.gitlab-ci.yml

@@ -1,62 +1,119 @@
-image: hosttoday/ht-docker-dbase:npmci
+# gitzone ci_default
-services:
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-  - docker:dind
 
 cache:
   paths:
-  - .yarn/
+  - .npmci_cache/
   key: "$CI_BUILD_STAGE"
 
 stages:
-  - test
+- security
-  - release
+- test
-  - trigger
+- release
-  - pages
+- metadata
 
-before_script:
+# ====================
-  - npmci prepare docker-gitlab
+# security stage
+# ====================
+mirror:
+  stage: security
+  script:
+  - npmci git mirror
+  tags:
+  - docker
+  - notpriv
 
-test:
+snyk:
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install -g snyk
+    - npmci command npm install --ignore-scripts
+    - npmci command snyk test
+  tags:
+  - docker
+  - notpriv
+
+# ====================
+# test stage
+# ====================
+
+testLTS:
   stage: test
   script:
-    - npmci test stable
+  - npmci npm prepare
+  - npmci node install lts
+  - npmci npm install
+  - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
+  - docker
-    - priv
+  - notpriv
+
+testBuild:
+  stage: test
+  script:
+  - npmci npm prepare
+  - npmci node install lts
+  - npmci npm install
+  - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+  - docker
+  - notpriv
 
 release:
-  image: hosttoday/ht-docker-node:npmci
   stage: release
   script:
-    - npmci publish npm
+  - npmci node install lts
+  - npmci npm publish
   only:
-    - tags
+  - tags
   tags:
-    - lossless
+  - docker
-    - priv
+  - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  allow_failure: true
+  script:
+    - npmci command npm install -g tslint typescript
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
+  tags:
+  - docker
+  - priv
 
 trigger:
-  image: hosttoday/ht-docker-node:npmci
+  stage: metadata
-  stage: trigger
   script:
-    - npmci trigger
+  - npmci trigger
   only:
-    - tags
+  - tags
   tags:
-    - lossless
+  - docker
-    - priv
+  - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
+  image: hosttoday/ht-docker-dbase:npmci
-  stage: pages
+  services:
+   - docker:18-dind
+  stage: metadata
   script:
-    - npmci command yarn global add npmpage
+    - npmci command npm install -g @gitzone/tsdoc
-    - npmci command npmpage --publish gitlab
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command tsdoc
   tags:
     - docker
+    - notpriv
   only:
     - tags
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+    - public
+  allow_failure: true

README.md

@@ -1,52 +1,41 @@
-# @mojoio/dockersock
+# @mojoio/docker
 
-easy communication with docker remote api from node, TypeScript ready
+unofficial docker engine api abstraction package written in TypeScript
 
-## Availabililty
+## Availabililty and Links
 
-[![npm](https://mojoio.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/dockersock)
+- [npmjs.org (npm package)](https://www.npmjs.com/package/@mojoio/docker)
-[![git](https://mojoio.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/mojoio/dockersock)
+- [gitlab.com (source)](https://gitlab.com/mojoio/docker)
-[![git](https://mojoio.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/mojoio/dockersock)
+- [github.com (source mirror)](https://github.com/mojoio/docker)
-[![docs](https://mojoio.gitlab.io/assets/repo-button-docs.svg)](https://mojoio.gitlab.io/dockersock/)
+- [docs (typedoc)](https://mojoio.gitlab.io/docker/)
 
 ## Status for master
 
-[![build status](https://GitLab.com/mojoio/dockersock/badges/master/build.svg)](https://GitLab.com/mojoio/dockersock/commits/master)
+[![build status](https://gitlab.com/mojoio/docker/badges/master/build.svg)](https://gitlab.com/mojoio/docker/commits/master)
-[![coverage report](https://GitLab.com/mojoio/dockersock/badges/master/coverage.svg)](https://GitLab.com/mojoio/dockersock/commits/master)
+[![coverage report](https://gitlab.com/mojoio/docker/badges/master/coverage.svg)](https://gitlab.com/mojoio/docker/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/dockersock.svg)](https://www.npmjs.com/package/dockersock)
+[![npm downloads per month](https://img.shields.io/npm/dm/@mojoio/docker.svg)](https://www.npmjs.com/package/@mojoio/docker)
-[![Dependency Status](https://david-dm.org/mojoio/dockersock.svg)](https://david-dm.org/mojoio/dockersock)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@mojoio/docker/badge.svg)](https://snyk.io/test/npm/@mojoio/docker)
-[![bitHound Dependencies](https://www.bithound.io/github/mojoio/dockersock/badges/dependencies.svg)](https://www.bithound.io/github/mojoio/dockersock/master/dependencies/npm)
+[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![bitHound Code](https://www.bithound.io/github/mojoio/dockersock/badges/code.svg)](https://www.bithound.io/github/mojoio/dockersock)
+[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
-[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
 
 ## Usage
 
 Use TypeScript for best in class instellisense.
 
-```TypeScript
+```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
+  const containers = await myDockerHost.getContainers(); // promise, resolve with an array of DockerContainers
-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"
-})
 ```
 
-For further information read the linked docs at the top of this README.
+For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
 
-[![repo-footer](https://mojoio.gitlab.io/assets/repo-footer.svg)](https://mojo.io)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

npmextra.json

@@ -1,15 +1,22 @@
 {
-  "npmts": {
-    "mode": "default",
-    "coverageTreshold": 10
-  },
   "npmdocker": {
     "baseImage": "hosttoday/ht-docker-node:npmci",
-    "command":
+    "command": "(ls -a && rm -r node_modules && yarn global add npmts && yarn install && npmts)",
-      "(ls -a && rm -r node_modules && yarn global add npmts && yarn install && npmts)",
     "dockerSock": true
   },
   "npmci": {
-    "globalNpmTools": ["npmts", "npmdocker"]
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public",
+    "npmRegistryUrl": "registry.npmjs.org"
+  },
+  "gitzone": {
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "mojoio",
+      "gitrepo": "docker",
+      "shortDescription": "unofficial docker engine api abstraction package written in TypeScript",
+      "npmPackagename": "@mojoio/docker",
+      "license": "MIT"
+    }
   }
-}
+}

package.json

@@ -1,12 +1,13 @@
 {
   "name": "@mojoio/docker",
-  "version": "1.0.24",
+  "version": "1.0.36",
   "description": "easy communication with docker remote api from node, TypeScript ready",
+  "private": false,
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "tsrun test/test.ts",
+    "test": "tstest test/",
-    "build": "(npmts --notest && npmdocker)"
+    "build": "tsbuild"
   },
   "repository": {
     "type": "git",
@@ -26,14 +27,30 @@
   },
   "homepage": "https://gitlab.com/pushrocks/dockersock#README",
   "dependencies": {
-    "@pushrocks/lik": "^3.0.1",
+    "@pushrocks/lik": "^3.0.10",
-    "@pushrocks/smartlog": "^2.0.1",
+    "@pushrocks/smartlog": "^2.0.19",
-    "@pushrocks/smartpromise": "^2.0.5",
+    "@pushrocks/smartpromise": "^3.0.2",
-    "@pushrocks/smartrequest": "^1.0.17",
+    "@pushrocks/smartrequest": "^1.1.16",
-    "rxjs": "^6.2.2"
+    "rxjs": "^6.5.2"
   },
   "devDependencies": {
-    "@pushrocks/tapbundle": "^3.0.1"
+    "@gitzone/tsbuild": "^2.1.11",
+    "@gitzone/tsrun": "^1.2.8",
+    "@gitzone/tstest": "^1.0.24",
+    "@pushrocks/tapbundle": "^3.0.11",
+    "@types/node": "^12.7.1",
+    "tslint": "^5.18.0",
+    "tslint-config-prettier": "^1.18.0"
   },
-  "private": false
+  "files": [
+    "ts/*",
+    "ts_web/*",
+    "dist/*",
+    "dist_web/*",
+    "dist_ts_web/*",
+    "assets/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

test/test.ts

@@ -13,16 +13,17 @@ tap.test('should list containers', async () => {
   console.log(containers);
 });
 
-/*
+tap.skip.test('should pull an image from imagetag', async () => {
-tap.test('should pull an image from imagetag', async () => {
+  // await testDockerHost.pullImage('hosttoday/ht-docker-node:npmci');
-  await testDockerHost.pullImage('hosttoday/ht-docker-node:npmci');
 });
 
-tap.skip.test('should return a change Objservable', async () => {
+tap.test('should return a change Objservable', async tools => {
-  let myObservable = testDockerHost.getChangeObservable();
+  const testObservable = await testDockerHost.getEventObservable();
-  testDockerHost.endRequests();
+  const subscription = testObservable.subscribe(changeObject => {
-  let testPromise = observableToPromise(myObservable);
+    console.log(changeObject);
-  return await expect(testPromise).to.eventually.be.fulfilled;
+  });
-}); */
+  await tools.delayFor(2000);
+  subscription.unsubscribe();
+});
 
 tap.start();

ts/docker.changes.ts

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

ts/docker.classes.container.ts

@@ -1,10 +1,77 @@
 import * as plugins from './dockersock.plugins';
+import * as interfaces from './interfaces';
+
 import { DockerHost } from './docker.classes.host';
 
 export class DockerContainer {
-  static async getContainers(dockerHostArg: DockerHost): Promise<DockerContainer[]> {
+  // ======
-    const result = [];
+  // STATIC
-    await dockerHostArg.request('GET', '/containers/json')
+  // ======
+
+  /**
+   * get all containers
+   */
+  public static async getContainers(dockerHostArg: DockerHost): Promise<DockerContainer[]> {
+    const result: DockerContainer[] = [];
+    const response = await dockerHostArg.request('GET', '/containers/json');
+
+    // TODO: Think about getting the config by inpsecting the container
+    for (const containerResult of response.body) {
+      result.push(new DockerContainer(containerResult));
+    }
     return result;
   }
+
+  /**
+   * gets an container by Id
+   * @param containerId
+   */
+  public static async getContainerById(containerId: string) {}
+
+  /**
+   * create a container
+   */
+  public static async create(creationSpecifier: interfaces.IContainerCreationSpecifier) {}
+
+  // ========
+  // INSTANCE
+  // ========
+
+  constructor(dockerContainerObjectArg: any) {
+    Object.keys(dockerContainerObjectArg).forEach(keyArg => {
+      this[keyArg] = dockerContainerObjectArg[keyArg];
+    });
+  }
+
+  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: {
+    Networks: {
+      [key: string]: {
+        IPAMConfig: any;
+        Links: any;
+        Aliases: any;
+        NetworkID: string;
+        EndpointID: string;
+        Gateway: string;
+        IPAddress: string;
+        IPPrefixLen: number;
+        IPv6Gateway: string;
+        GlobalIPv6Address: string;
+        GlobalIPv6PrefixLen: number;
+        MacAddress: string;
+        DriverOpts: any;
+      };
+    };
+  };
+  Mounts: any;
 }

ts/docker.classes.host.ts

@@ -1,5 +1,5 @@
-import * as plugins from "./dockersock.plugins";
+import * as plugins from './dockersock.plugins';
-import { DockerContainer } from "./docker.classes.container";
+import { DockerContainer } from './docker.classes.container';
 
 export class DockerHost {
   /**
@@ -16,7 +16,7 @@ export class DockerHost {
    * the constructor to instantiate a new docker sock instance
    * @param pathArg
    */
-  constructor(pathArg: string = "http://unix:/var/run/docker.sock:") {
+  constructor(pathArg: string = 'http://unix:/var/run/docker.sock:') {
     this.sockPath = pathArg;
   }
 
@@ -27,7 +27,7 @@ export class DockerHost {
    */
   auth(registryArg: string, userArg: string, passArg: string) {
     let done = plugins.smartpromise.defer();
-    this.request("POST", "");
+    this.request('POST', '');
     return done.promise;
   }
 
@@ -39,20 +39,56 @@ export class DockerHost {
     return containerArray;
   }
 
+  async getEventObservable(): Promise<plugins.rxjs.Observable<any>> {
+    const response = await this.requestStreaming('GET', '/events');
+    return plugins.rxjs.Observable.create(observer => {
+      response.on('data', data => {
+        const eventString = data.toString();
+        try {
+          const eventObject = JSON.parse(eventString);
+          observer.next(eventObject);
+        } catch (e) {
+          console.log(e);
+        }
+      });
+      return () => {
+        response.emit('end');
+      };
+    });
+  }
+
   /**
    * fire a request
    */
   async request(methodArg: string, routeArg: string, dataArg = {}) {
-    const requestUrl = `${this.sockPath}${routeArg}`
+    const requestUrl = `${this.sockPath}${routeArg}`;
-    console.log(requestUrl);
     const response = await plugins.smartrequest.request(requestUrl, {
       method: methodArg,
       headers: {
-        "Content-Type": "application/json",
+        'Content-Type': 'application/json',
-        "Host": "docker.sock"
+        Host: 'docker.sock'
       },
       requestBody: dataArg
     });
-    return response
+    return response;
+  }
+
+  async requestStreaming(methodArg: string, routeArg: string, dataArg = {}) {
+    const requestUrl = `${this.sockPath}${routeArg}`;
+    const response = await plugins.smartrequest.request(
+      requestUrl,
+      {
+        method: methodArg,
+        headers: {
+          // 'Content-Type': 'application/json',
+          Host: 'docker.sock'
+        },
+        requestBody: null
+      },
+      true
+    );
+    console.log(response.statusCode);
+    console.log(response.body);
+    return response;
   }
 }

ts/docker.classes.image.ts

@@ -2,13 +2,37 @@ import * as plugins from './dockersock.plugins';
 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 createFromExistingImage(dockerHostArg: DockerHost, dockerImageTag) {}
+
+  // INSTANCE
   /**
    * the tags for an image
    */
-  tags: string[] = [];
+  public tags: string[] = [];
 
-  static async createFromRegsitry(dockerHostArg: DockerHost): Promise<DockerImage> {
+  /**
-    const resultingImage = new DockerImage();
+   * returns a boolean wether the image has a upstream image
-    return resultingImage;
+   */
+  public isUpstreamImage(): boolean {
+    // TODO: implement isUpastreamImage
+    return true;
   }
-}
+
+  /**
+   *
+   */
+  public async pullLatestImageFromRegistry(): Promise<boolean> {
+    // TODO: implement pullLatestImageFromRegistry
+    return true;
+  }
+}

ts/docker.classes.network.ts

@@ -0,0 +1,6 @@
+import * as plugins from './dockersock.plugins';
+import * as interfaces from './interfaces';
+
+import { DockerHost } from './docker.classes.host';
+
+export class DockerNetwork {}

ts/docker.classes.service.ts

@@ -0,0 +1,6 @@
+import * as plugins from './dockersock.plugins';
+import * as interfaces from './interfaces';
+
+import { DockerHost } from './docker.classes.host';
+
+export class DockerService {}

ts/dockersock.plugins.ts

@@ -1,6 +1,12 @@
-import 'typings-global';
+// @pushrocks scope
-export import smartlog = require('@pushrocks/smartlog');
+import * as lik from '@pushrocks/lik';
-export import lik = require('@pushrocks/lik');
+import * as smartlog from '@pushrocks/smartlog';
-export import smartpromise = require('@pushrocks/smartpromise');
+import * as smartpromise from '@pushrocks/smartpromise';
-export import smartrequest = require('@pushrocks/smartrequest');
+import * as smartrequest from '@pushrocks/smartrequest';
-export import rxjs = require('rxjs');
+
+export { lik, smartlog, smartpromise, smartrequest };
+
+// third party
+import * as rxjs from 'rxjs';
+
+export { rxjs };

ts/index.ts

@@ -1 +1,5 @@
-export { DockerHost } from './docker.classes.host';
+export * from './docker.classes.host';
+export * from './docker.classes.container';
+export * from './docker.classes.image';
+export * from './docker.classes.network';
+export * from './docker.classes.service';

ts/interfaces/container.ts

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

ts/interfaces/index.ts

@@ -0,0 +1,3 @@
+export * from './container';
+export * from './label';
+export * from './port';

ts/interfaces/label.ts

@@ -0,0 +1,2 @@
+// tslint:disable-next-line: interface-over-type-literal
+export type TLabels = { [key: string]: string };

ts/interfaces/port.ts

@@ -0,0 +1,6 @@
+export interface IPort {
+  PrivatePort: 80;
+  Type: 'tcp';
+}
+
+export type TPorts = IPort[];

tslint.json

@@ -0,0 +1,17 @@
+{
+  "extends": ["tslint:latest", "tslint-config-prettier"],
+  "rules": {
+    "semicolon": [true, "always"],
+    "no-console": false,
+    "ordered-imports": false,
+    "object-literal-sort-keys": false,
+    "member-ordering": {
+      "options":{
+        "order": [
+          "static-method"
+        ]
+      }
+    }
+  },
+  "defaultSeverity": "warning"
+}