1.0.95

.gitignore

@@ -15,8 +15,6 @@ node_modules/
 
 # builds
 dist/
-dist_web/
-dist_serve/
-dist_ts_web/
+dist_*/
 
 # custom

.gitlab-ci.yml

@@ -3,14 +3,14 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
 
 # ====================
 # security stage
@@ -18,21 +18,24 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
-snyk:
+audit:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # test stage
@@ -41,37 +44,40 @@ snyk:
 testStable:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 testBuild:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci command npm run build
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install stable
-  - npmci npm publish
+    - npmci node install stable
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
@@ -81,33 +87,35 @@ codequality:
   allow_failure: true
   script:
     - npmci command npm install -g tslint typescript
+    - npmci npm prepare
     - npmci npm install
     - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-dbase:npmci
-  services:
-   - docker:stable-dind
   stage: metadata
   script:
+    - npmci node install lts
     - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
     - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -115,5 +123,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

.snyk

@@ -0,0 +1,9 @@
+# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
+version: v1.13.5
+# ignores vulnerabilities until expiry date; change duration by modifying expiry date
+ignore:
+  SNYK-JS-HTTPSPROXYAGENT-469131:
+    - '@pushrocks/smartnetwork > speedtest-net > https-proxy-agent':
+        reason: None given
+        expires: '2019-11-04T13:59:28.695Z'
+patch: {}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

@@ -10,6 +10,7 @@
     "npmRegistryUrl": "registry.npmjs.org"
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "mojoio",

package.json

@@ -1,10 +1,10 @@
 {
   "name": "@mojoio/docker",
-  "version": "1.0.70",
+  "version": "1.0.95",
   "description": "easy communication with docker remote api from node, TypeScript ready",
   "private": false,
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
     "test": "tstest test/",
     "build": "tsbuild"
@@ -27,34 +27,36 @@
   },
   "homepage": "https://gitlab.com/pushrocks/dockersock#README",
   "dependencies": {
-    "@pushrocks/lik": "^3.0.11",
-    "@pushrocks/smartfile": "^7.0.4",
-    "@pushrocks/smartjson": "^3.0.8",
-    "@pushrocks/smartlog": "^2.0.19",
-    "@pushrocks/smartnetwork": "^1.1.14",
-    "@pushrocks/smartpath": "^4.0.1",
-    "@pushrocks/smartpromise": "^3.0.2",
-    "@pushrocks/smartrequest": "^1.1.26",
-    "@pushrocks/smartstring": "^3.0.10",
+    "@pushrocks/lik": "^4.0.17",
+    "@pushrocks/smartfile": "^8.0.0",
+    "@pushrocks/smartjson": "^3.0.10",
+    "@pushrocks/smartlog": "^2.0.39",
+    "@pushrocks/smartnetwork": "^1.1.22",
+    "@pushrocks/smartpath": "^4.0.3",
+    "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/smartrequest": "^1.1.51",
+    "@pushrocks/smartstring": "^3.0.18",
     "@pushrocks/smartversion": "^2.0.4",
-    "rxjs": "^6.5.3"
+    "@tsclass/tsclass": "^3.0.25",
+    "rxjs": "^6.6.3"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.24",
-    "@pushrocks/tapbundle": "^3.0.13",
-    "@types/node": "^12.7.4",
-    "tslint": "^5.19.0",
+    "@gitzone/tsbuild": "^2.1.25",
+    "@gitzone/tsrun": "^1.2.12",
+    "@gitzone/tstest": "^1.0.48",
+    "@pushrocks/tapbundle": "^3.2.9",
+    "@types/node": "^14.11.2",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "files": [
-    "ts/*",
-    "ts_web/*",
-    "dist/*",
-    "dist_web/*",
-    "dist_ts_web/*",
-    "assets/*",
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"

readme.md

@@ -8,7 +8,7 @@ unofficial docker engine api abstraction package written in TypeScript
 * [docs (typedoc)](https://mojoio.gitlab.io/docker/)
 
 ## Status for master
-[![build status](https://gitlab.com/mojoio/docker/badges/master/build.svg)](https://gitlab.com/mojoio/docker/commits/master)
+[![pipeline status](https://gitlab.com/mojoio/docker/badges/master/pipeline.svg)](https://gitlab.com/mojoio/docker/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/@mojoio/docker.svg)](https://www.npmjs.com/package/@mojoio/docker)
 [![Known Vulnerabilities](https://snyk.io/test/npm/@mojoio/docker/badge.svg)](https://snyk.io/test/npm/@mojoio/docker)
@@ -30,6 +30,10 @@ const run = async () => {
 };
 ```
 
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
 For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)

test/test.ts

@@ -87,29 +87,24 @@ tap.test('should create a service', async () => {
     Name: 'testNetwork'
   });
   const testSecret = await docker.DockerSecret.createSecret(testDockerHost, {
-    name: 'serviceSecret',
+    name: 'testSecret',
     version: '0.0.1',
     labels: {},
     contentArg: '{"hi": "wow"}'
   });
   const testImage = await docker.DockerImage.createFromRegistry(testDockerHost, {
-    imageUrl: 'nginx:latest'
+    imageUrl: 'registry.gitlab.com/hosttoday/ht-docker-static'
   });
   const testService = await docker.DockerService.createService(testDockerHost, {
     image: testImage,
-    labels: {
-      testlabel: 'hi'
-    },
+    labels: {},
     name: 'testService',
     networks: [testNetwork],
     networkAlias: 'testService',
     secrets: [testSecret],
-    ports: []
+    ports: ['3000:80']
   });
 
-  await testSecret.update(`{"updated": "socool"}`);
-  await testService.update();
-
   await testService.remove();
   await testNetwork.remove();
   await testSecret.remove();

ts/docker.classes.container.ts

@@ -2,6 +2,7 @@ import * as plugins from './docker.plugins';
 import * as interfaces from './interfaces';
 
 import { DockerHost } from './docker.classes.host';
+import { logger } from './docker.logging';
 
 export class DockerContainer {
   // STATIC
@@ -47,9 +48,9 @@ export class DockerContainer {
       User: 'root'
     });
     if (response.statusCode < 300) {
-      plugins.smartlog.defaultLogger.log('info', 'Container created successfully');
+      logger.log('info', 'Container created successfully');
     } else {
-      plugins.smartlog.defaultLogger.log(
+      logger.log(
         'error',
         'There has been a problem when creating the container'
       );

ts/docker.classes.host.ts

@@ -2,6 +2,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';
+import { logger } from './docker.logging';
 
 export interface IAuthData {
   serveraddress: string;
@@ -62,7 +63,7 @@ export class DockerHost {
       username: gitlabAuthArray[0],
       password: gitlabAuthArray[1],
       serveraddress: 'registry.gitlab.com'
-    })
+    });
   }
 
   /**
@@ -138,9 +139,9 @@ export class DockerHost {
       ForceNewCluster: false
     });
     if (response.statusCode === 200) {
-      plugins.smartlog.defaultLogger.log('info', 'created Swam succesfully');
+      logger.log('info', 'created Swam succesfully');
     } else {
-      plugins.smartlog.defaultLogger.log('error', 'could not initiate swarm');
+      logger.log('error', 'could not initiate swarm');
     }
   }
 

ts/docker.classes.image.ts

@@ -1,6 +1,7 @@
 import * as plugins from './docker.plugins';
 import * as interfaces from './interfaces';
 import { DockerHost } from './docker.classes.host';
+import { logger } from './docker.logging';
 
 export class DockerImage {
   // STATIC
@@ -63,14 +64,14 @@ export class DockerImage {
       )}&tag=${encodeURIComponent(imageUrlObject.imageTag)}`
     );
     if (response.statusCode < 300) {
-      plugins.smartlog.defaultLogger.log(
+      logger.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`);
+      logger.log('error', `Failed at the attempt of creating a new image`);
     }
   }
 
@@ -137,6 +138,10 @@ export class DockerImage {
 
   // get stuff
   public async getVersion() {
-    return this.Labels.version;
+    if (this.Labels && this.Labels.version) {
+      return this.Labels.version;
+    } else {
+      return '0.0.0';
+    }
   }
 }

ts/docker.classes.network.ts

@@ -2,6 +2,8 @@ import * as plugins from './docker.plugins';
 import * as interfaces from './interfaces';
 
 import { DockerHost } from './docker.classes.host';
+import { DockerService } from './docker.classes.service';
+import { logger } from './docker.logging';
 
 export class DockerNetwork {
   public static async getNetworks(dockerHost: DockerHost): Promise<DockerNetwork[]> {
@@ -29,25 +31,25 @@ export class DockerNetwork {
       CheckDuplicate: true,
       Driver: 'overlay',
       EnableIPv6: false,
-      IPAM: {
+      /* IPAM: {
         Driver: 'default',
         Config: [
           {
-            Subnet: '172.20.10.0/16',
-            IPRange: '172.20.10.0/24',
-            Gateway: '172.20.10.11'
+            Subnet: `172.20.${networkCreationDescriptor.NetworkNumber}.0/16`,
+            IPRange: `172.20.${networkCreationDescriptor.NetworkNumber}.0/24`,
+            Gateway: `172.20.${networkCreationDescriptor.NetworkNumber}.11`
           }
         ]
-      },
-      Internal: true,
+      }, */
+      Internal: false,
       Attachable: true,
       Ingress: false
     });
     if (response.statusCode < 300) {
-      plugins.smartlog.defaultLogger.log('info', 'Created network successfully');
+      logger.log('info', 'Created network successfully');
       return await DockerNetwork.getNetworkByName(dockerHost, networkCreationDescriptor.Name);
     } else {
-      plugins.smartlog.defaultLogger.log(
+      logger.log(
         'error',
         'There has been an error creating the wanted network'
       );
@@ -90,4 +92,30 @@ export class DockerNetwork {
   public async remove() {
     const response = await this.dockerHost.request('DELETE', `/networks/${this.Id}`);
   }
+
+  public async getContainersOnNetwork(): Promise<
+    Array<{
+      Name: string;
+      EndpointID: string;
+      MacAddress: string;
+      IPv4Address: string;
+      IPv6Address: string;
+    }>
+  > {
+    const returnArray = [];
+    const response = await this.dockerHost.request('GET', `/networks/${this.Id}`);
+    for (const key of Object.keys(response.body.Containers)) {
+      returnArray.push(response.body.Containers[key]);
+    }
+
+    return returnArray;
+  }
+
+  public async getContainersOnNetworkForService(serviceArg: DockerService) {
+    const containersOnNetwork = await this.getContainersOnNetwork();
+    const containersOfService = containersOnNetwork.filter(container => {
+      return container.Name.startsWith(serviceArg.Spec.Name);
+    });
+    return containersOfService;
+  }
 }

ts/docker.classes.service.ts

@@ -4,6 +4,7 @@ import * as interfaces from './interfaces';
 import { DockerHost } from './docker.classes.host';
 import { DockerImage } from './docker.classes.image';
 import { DockerSecret } from './docker.classes.secret';
+import { logger } from './docker.logging';
 
 export class DockerService {
   // STATIC
@@ -37,7 +38,7 @@ export class DockerService {
     serviceCreationDescriptor: interfaces.IServiceCreationDescriptor
   ): Promise<DockerService> {
     // lets get the image
-    plugins.smartlog.defaultLogger.log(
+    logger.log(
       'info',
       `now creating service ${serviceCreationDescriptor.name}`
     );
@@ -50,7 +51,46 @@ export class DockerService {
       version: serviceVersion
     };
 
-    const networkArray: any[] = [];
+    const mounts: Array<{
+      /**
+       * the target inside the container
+       */
+      Target: string;
+      /**
+       * The Source from which to mount the data (Volume or host path)
+       */
+      Source: string;
+      Type: 'bind' | 'volume' | 'tmpfs' | 'npipe';
+      ReadOnly: boolean;
+      Consistency: 'default' | 'consistent' | 'cached' | 'delegated';
+    }> = [];
+    if (serviceCreationDescriptor.accessHostDockerSock) {
+      mounts.push({
+        Target: '/var/run/docker.sock',
+        Source: '/var/run/docker.sock',
+        Consistency: 'default',
+        ReadOnly: false,
+        Type: 'bind'
+      });
+    }
+
+    if (serviceCreationDescriptor.resources && serviceCreationDescriptor.resources.volumeMounts) {
+      for(const volumeMount of serviceCreationDescriptor.resources.volumeMounts) {
+        mounts.push({
+          Target: volumeMount.containerFsPath,
+          Source: volumeMount.hostFsPath,
+          Consistency: 'default',
+          ReadOnly: false,
+          Type: 'bind'
+        });
+      }
+    }
+
+    const networkArray: Array<{
+      Target: string;
+      Aliases: string[];
+    }> = [];
+
     for (const network of serviceCreationDescriptor.networks) {
       networkArray.push({
         Target: network.Name,
@@ -64,17 +104,18 @@ export class DockerService {
       const hostPort = portArray[0];
       const containerPort = portArray[1];
       ports.push({
-        "Protocol": "tcp",
-        "PublishedPort": parseInt(containerPort, 10),
-        "TargetPort": parseInt(hostPort, 10)
+        Protocol: 'tcp',
+        PublishedPort: parseInt(hostPort, 10),
+        TargetPort: parseInt(containerPort, 10)
       });
     }
 
+    // lets configure secrets
     const secretArray: any[] = [];
     for (const secret of serviceCreationDescriptor.secrets) {
       secretArray.push({
         File: {
-          Name: 'secret.json',
+          Name: 'secret.json', // TODO: make sure that works with multiple secrets
           UID: '33',
           GID: '33',
           Mode: 384
@@ -84,13 +125,32 @@ export class DockerService {
       });
     }
 
+    // lets configure limits
+
+    const memoryLimitMB =
+      serviceCreationDescriptor.resources && serviceCreationDescriptor.resources.memorySizeMB
+        ? serviceCreationDescriptor.resources.memorySizeMB
+        : 1000;
+
+    const limits = {
+      MemoryBytes: memoryLimitMB * 1000000
+    };
+
+    if (serviceCreationDescriptor.resources) {
+      limits.MemoryBytes = serviceCreationDescriptor.resources.memorySizeMB * 1000000;
+    }
+
     const response = await dockerHost.request('POST', '/services/create', {
       Name: serviceCreationDescriptor.name,
       TaskTemplate: {
         ContainerSpec: {
           Image: serviceCreationDescriptor.image.RepoTags[0],
           Labels: labels,
-          Secrets: secretArray
+          Secrets: secretArray,
+          Mounts: mounts
+          /* DNSConfig: {
+            Nameservers: ['1.1.1.1']
+          } */
         },
         UpdateConfig: {
           Parallelism: 0,
@@ -99,7 +159,17 @@ export class DockerService {
           Monitor: 15000000000,
           MaxFailureRatio: 0.15
         },
-        ForceUpdate: 1
+        ForceUpdate: 1,
+        Resources: {
+          Limits: limits
+        },
+        LogDriver: {
+          Name: 'json-file',
+          Options: {
+            'max-file': '3',
+            'max-size': '10M'
+          }
+        }
       },
       Labels: labels,
       Networks: networkArray,
@@ -151,25 +221,6 @@ export class DockerService {
     this.dockerHostRef = dockerHostArg;
   }
 
-  public async update() {
-    const labels: interfaces.TLabels = {
-      ...this.Spec.Labels,
-      version: 'x.x.x'
-    };
-
-    const dockerData = await this.dockerHostRef.request(
-      'POST',
-      `/services/${this.ID}/update?version=${this.Version.Index}`,
-      {
-        Name: this.Spec.Name,
-        TaskTemplate: this.Spec.TaskTemplate,
-        Labels: labels,
-        Networks: this.Spec.Networks
-      }
-    );
-    Object.assign(this, dockerData);
-  }
-
   public async remove() {
     await this.dockerHostRef.request('DELETE', `/services/${this.ID}`);
   }
@@ -196,10 +247,4 @@ export class DockerService {
       console.log(`service ${this.Spec.Name} is up to date.`);
     }
   }
-
-  public async updateFromRegistry() {
-    if (await this.needsUpdate()) {
-      this.update();
-    }
-  }
 }

ts/docker.logging.ts

@@ -0,0 +1,3 @@
+import * as plugins from './docker.plugins';
+
+export const logger = new plugins.smartlog.ConsoleLog();

ts/docker.plugins.ts

@@ -15,8 +15,6 @@ import * as smartrequest from '@pushrocks/smartrequest';
 import * as smartstring from '@pushrocks/smartstring';
 import * as smartversion from '@pushrocks/smartversion';
 
-smartlog.defaultLogger.enableConsole();
-
 export {
   lik,
   smartfile,
@@ -30,6 +28,13 @@ export {
   smartversion
 };
 
+// @tsclass scope
+import * as tsclass from '@tsclass/tsclass';
+
+export {
+  tsclass
+};
+
 // third party
 import * as rxjs from 'rxjs';
 

ts/interfaces/service.ts

@@ -1,3 +1,5 @@
+import * as plugins from '../docker.plugins';
+
 import * as interfaces from './';
 import { DockerNetwork } from '../docker.classes.network';
 import { DockerSecret } from '../docker.classes.secret';
@@ -11,4 +13,9 @@ export interface IServiceCreationDescriptor {
   networkAlias: string;
   secrets: DockerSecret[];
   ports: string[];
+  accessHostDockerSock?: boolean;
+  resources?: {
+    memorySizeMB?: number;
+    volumeMounts?: plugins.tsclass.container.IVolumeMount[]
+  };
 }