1.2.24

.gitignore

@@ -1,4 +1,8 @@
 node_modules/
 coverage/
-docs/
+pages/
+public/
+
+test/
+assets/
 .nogit/

.gitlab-ci.yml

@@ -1,35 +1,69 @@
-image: hosttoday/ht-docker-node:npmts
+image: hosttoday/ht-docker-dbase:npmci
+services:
+  - docker:dind
 
 stages:
+- mirror
 - test
 - release
+- trigger
+- pages
 
-testLEGACY:
-  stage: test
+mirror:
+  image: hosttoday/ht-docker-node:npmci
+  stage: mirror
   script:
-    - npmci test legacy
+    - npmci git mirror
   tags:
     - docker
 
-testLTS:
+
+test:
   stage: test
   script:
-    - npmci test lts
-  tags:
-    - docker
-    
-testSTABLE:
-  stage: test
-  script:
-    - npmci test stable
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   tags:
     - docker
+    - lossless
+    - priv
 
 release:
   stage: release
+  environment: npmjs-com_registry
   script:
-    - npmci publish
+    - npmci npm prepare
+    - npmci npm publish
   only:
     - tags
   tags:
     - docker
+    - lossless
+    - priv
+
+trigger:
+  stage: trigger
+  script:
+    - npmci trigger
+  only:
+    - tags
+  tags:
+    - docker
+    - lossless
+    - priv
+
+pages:
+  image: hosttoday/ht-docker-node:npmci
+  stage: pages
+  script:
+    - npmci command yarn global add npmpage
+    - npmci command npmpage
+  only:
+    - tags
+  tags:
+    - docker
+  artifacts:
+    expire_in: 1 week
+    paths:
+    - public

Dockerfile

@@ -0,0 +1,4 @@
+FROM hosttoday/ht-docker-node:stable
+LABEL author="Lossless GmbH <office@lossless.com>"
+
+RUN yarn global add npmci npmdocker npmts ts-node

README.md

@@ -1,5 +1,67 @@
 # npmdocker
+
 develop npm modules cross platform with docker
 
+## Availabililty
+
+[![npm](https://gitzone.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/npmdocker)
+[![git](https://gitzone.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/gitzone/npmdocker)
+[![git](https://gitzone.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/gitzone/npmdocker)
+[![docs](https://gitzone.gitlab.io/assets/repo-button-docs.svg)](https://gitzone.gitlab.io/npmdocker/)
+
+## Status for master
+
+[![build status](https://GitLab.com/gitzone/npmdocker/badges/master/build.svg)](https://GitLab.com/gitzone/npmdocker/commits/master)
+[![coverage report](https://GitLab.com/gitzone/npmdocker/badges/master/coverage.svg)](https://GitLab.com/gitzone/npmdocker/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/npmdocker.svg)](https://www.npmjs.com/package/npmdocker)
+[![Dependency Status](https://david-dm.org/gitzonetools/npmdocker.svg)](https://david-dm.org/gitzonetools/npmdocker)
+[![bitHound Dependencies](https://www.bithound.io/github/gitzonetools/npmdocker/badges/dependencies.svg)](https://www.bithound.io/github/gitzonetools/npmdocker/master/dependencies/npm)
+[![bitHound Code](https://www.bithound.io/github/gitzonetools/npmdocker/badges/code.svg)](https://www.bithound.io/github/gitzonetools/npmdocker)
+[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+[![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
-npmdocker looks for a npmextra.json at the root of your directory and looks at the npmdocker portion of it.
+
+Use TypeScript for best in class instellisense.
+
+### Why does this package exist?
+
+Sometimes you want a clean and fresh linux environment everytime you test your package.
+Usually this is the default i CI, but locally behaviour tends to defer.
+
+### Where does it work
+
+The npmdocker package works in everywhere where the docker cli is available. e.g.:
+
+* docker toolbox
+* native docker application
+* docker in docker
+* mounted docker.sock
+
+### How do I use it?
+
+create a npmextra.json in the project's root directory
+
+```json
+{
+  "npmdocker": {
+    "baseImage": "hosttoday/ht-docker-node:npmts",
+    "command": "npmci test stable",
+    "dockerSock": false
+  }
+}
+```
+
+| option      | description                                                                           |
+| ----------- | ------------------------------------------------------------------------------------- |
+| baseImage   | the base image that is the context for your project                                   |
+| command     | the cli command to run within the the project's directory inside the docker container |
+| dockersSock | wether or not the testcontainer will have access to the docker.sock of the host       |
+
+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)
+
+[![repo-footer](https://gitzone.gitlab.io/assets/repo-footer.svg)](https://git.zone)

assets/Dockerfile

@@ -0,0 +1,6 @@
+FROM hosttoday/ht-docker-node:npmci
+RUN yarn global add npmdocker
+COPY ./ /workspace
+WORKDIR /workspace
+ENV CI=true
+CMD ["npmdocker","runinside"];

cli.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+process.env.CLI_CALL = 'true';
+require('./dist/index');

cli.ts.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+process.env.CLI_CALL = 'true';
+require('@gitzone/tsrun');
+require('./ts/index');

dist/index.js

@@ -1 +0,0 @@
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIn0=

docs/index.md

@@ -0,0 +1 @@
+Docs for npmpage coming soon.

npmextra.json

@@ -0,0 +1,13 @@
+{
+  "npmts": {
+    "mode": "default",
+    "cli": true
+  },
+  "npmci": {
+    "npmGlobalTools": [
+      "@gitzone/npmts",
+      "ts-node"
+    ],
+    "npmAccessLevel": "public"
+  }
+}

package.json

@@ -1,17 +1,26 @@
 {
-  "name": "npmdocker",
-  "version": "1.0.1",
+  "name": "@gitzone/npmdocker",
+  "version": "1.2.24",
+  "private": false,
   "description": "develop npm modules cross platform with docker",
   "main": "dist/index.js",
-  "directories": {
-    "test": "test"
+  "typings": "dist/index.d.ts",
+  "bin": {
+    "npmdocker": "cli.js"
   },
   "scripts": {
-    "test": "(npmts)"
+    "test": "(npm run clean && npm run setupCheck && npm run testStandard && npm run testSpeed)",
+    "build": "tsbuild",
+    "testStandard": "(cd test/ && node ../cli.ts.js)",
+    "testSpeed": "(cd test/ && node ../cli.ts.js speedtest)",
+    "testClean": "(cd test/ && node ../cli.ts.js clean --all)",
+    "clean": "(rm -rf test/)",
+    "compile": "(npmts --notest)",
+    "setupCheck": "(git clone https://gitlab.com/sandboxzone/sandbox-npmts.git test/)"
   },
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@gitlab.com/pushrocks/npmdocker.git"
+    "url": "git+ssh://git@gitlab.com/gitzone/npmdocker.git"
   },
   "keywords": [
     "docker"
@@ -19,19 +28,27 @@
   "author": "Lossless GmbH",
   "license": "MIT",
   "bugs": {
-    "url": "https://gitlab.com/pushrocks/npmdocker/issues"
+    "url": "https://gitlab.com/gitzone/npmdocker/issues"
   },
-  "homepage": "https://gitlab.com/pushrocks/npmdocker#README",
+  "homepage": "https://gitlab.com/gitzone/npmdocker#README",
   "devDependencies": {
-    "npmts-g": "^5.2.6",
-    "should": "^9.0.2",
-    "typings-test": "^1.0.1"
+    "@gitzone/tsbuild": "^2.0.22",
+    "@gitzone/tsrun": "^1.1.12",
+    "@gitzone/tstest": "^1.0.15",
+    "@pushrocks/tapbundle": "^3.0.7",
+    "@types/node": "^10.9.4"
   },
   "dependencies": {
-    "beautylog": "^5.0.13",
-    "q": "^1.4.1",
-    "rxjs": "^5.0.0-beta.10",
-    "smartfile": "^4.0.10",
-    "typings-global": "^1.0.6"
+    "@pushrocks/npmextra": "^3.0.1",
+    "@pushrocks/projectinfo": "^4.0.2",
+    "@pushrocks/qenv": "^2.0.2",
+    "@pushrocks/smartcli": "^3.0.4",
+    "@pushrocks/smartfile": "^6.0.8",
+    "@pushrocks/smartpromise": "^2.0.5",
+    "@pushrocks/smartshell": "^2.0.6",
+    "@pushrocks/smartstring": "^3.0.4",
+    "@types/shelljs": "^0.8.0",
+    "beautylog": "^6.1.10",
+    "smartanalytics": "^2.0.9"
   }
 }

ts/analytics.ts

@@ -0,0 +1,20 @@
+/**
+ * smartanalytics:
+ * We count executions of this tool to keep track which of our tools are really used.
+ * This insight is used to plan spending our limited resources for improving them.
+ * Any submitted analytics data is fully anonymized (no Ips or any other personal information is tracked).
+ * Feel free to dig into the smartanalytics package, if you are interested in how it works.
+ * Our privacy policy can be found here: https://lossless.gmbh/privacy.html
+ * The privacy policy is also linked in the readme, so we hope this behaviour does not come as a surprise to you.
+ * Have a nice day and regards
+ * Your Open Source team at Lossless GmbH :)
+ */
+import * as smartanalytics from 'smartanalytics';
+let npmdockerAnalytics = new smartanalytics.Analytics({
+  apiEndPoint: 'https://pubapi.lossless.one',
+  appName: 'npmdocker',
+  projectId: 'gitzone'
+});
+npmdockerAnalytics.recordEvent('npmtoolexecution', {
+  somedata: 'somedata'
+});

ts/index.ts

@@ -0,0 +1,5 @@
+import './analytics';
+import * as plugins from './npmdocker.plugins';
+import * as cli from './npmdocker.cli';
+
+cli.run();

ts/npmdocker.cli.ts

@@ -0,0 +1,76 @@
+import * as plugins from './npmdocker.plugins';
+import * as paths from './npmdocker.paths';
+
+// modules
+import * as ConfigModule from './npmdocker.config';
+import * as DockerModule from './npmdocker.docker';
+
+let npmdockerCli = new plugins.smartcli.Smartcli();
+
+export let run = () => {
+  npmdockerCli.standardTask().subscribe(async argvArg => {
+    plugins.beautylog.figletSync('npmdocker');
+    let configArg = await ConfigModule.run().then(DockerModule.run);
+    if (configArg.exitCode === 0) {
+      plugins.beautylog.success('container ended all right!');
+    } else {
+      plugins.beautylog.error(`container ended with error! Exit Code is ${configArg.exitCode}`);
+      process.exit(1);
+    }
+  });
+
+  /**
+   * this command is executed inside docker and meant for use from outside docker
+   */
+  npmdockerCli.addCommand('runinside').subscribe(async argvArg => {
+    plugins.beautylog.ok('Allright. We are now in Docker!');
+    plugins.beautylog.log('now trying to run your specified command');
+    let configArg = await ConfigModule.run();
+    const smartshellInstance = new plugins.smartshell.Smartshell({
+      executor: 'bash'
+    })
+    await smartshellInstance.exec(configArg.command).then(response => {
+      if (response.exitCode !== 0) {
+        process.exit(1);
+      }
+    });
+  });
+
+  npmdockerCli.addCommand('clean').subscribe(async argvArg => {
+    plugins.beautylog.ora.start();
+    plugins.beautylog.ora.text('cleaning up docker env...');
+    if (argvArg.all) {
+      const smartshellInstance = new plugins.smartshell.Smartshell({
+        executor: 'bash'
+      })
+      plugins.beautylog.ora.text('killing any running docker containers...');
+      await smartshellInstance.exec(`docker kill $(docker ps -q)`);
+
+      plugins.beautylog.ora.text('removing stopped containers...');
+      await smartshellInstance.exec(`docker rm $(docker ps -a -q)`);
+
+      plugins.beautylog.ora.text('removing images...');
+      await smartshellInstance.exec(`docker rmi $(docker images -q -f dangling=true)`);
+
+      plugins.beautylog.ora.text('removing all other images...');
+      await smartshellInstance.exec(`docker rmi $(docker images -a -q)`);
+
+      plugins.beautylog.ora.text('removing all volumes...');
+      await smartshellInstance.exec(`docker volume rm $(docker volume ls -f dangling=true -q)`);
+    }
+    plugins.beautylog.ora.endOk('docker environment now is clean!');
+  });
+
+  npmdockerCli.addCommand('speedtest').subscribe(async argvArg => {
+    const smartshellInstance = new plugins.smartshell.Smartshell({
+      executor: 'bash'
+    })
+    plugins.beautylog.figletSync('npmdocker');
+    plugins.beautylog.ok('Starting speedtest');
+    await smartshellInstance.exec(
+      `docker pull tianon/speedtest && docker run --rm tianon/speedtest`
+    );
+  });
+
+  npmdockerCli.startParse();
+};

ts/npmdocker.config.ts

@@ -0,0 +1,40 @@
+import * as plugins from './npmdocker.plugins';
+import * as paths from './npmdocker.paths';
+
+// interfaces
+import { IKeyValueObject } from '@pushrocks/qenv';
+
+export interface IConfig {
+  baseImage: string;
+  command: string;
+  dockerSock: boolean;
+  exitCode?: number;
+  keyValueObjectArray: IKeyValueObject[];
+}
+
+let getQenvKeyValueObject = async () => {
+  let qenvKeyValueObjectArray: IKeyValueObject[];
+  if (plugins.smartfile.fs.fileExistsSync(plugins.path.join(paths.cwd, 'qenv.yml'))) {
+    qenvKeyValueObjectArray = new plugins.qenv.Qenv(paths.cwd, '.nogit/').keyValueObjectArray;
+  } else {
+    qenvKeyValueObjectArray = [];
+  }
+  return qenvKeyValueObjectArray;
+};
+
+let buildConfig = async (qenvKeyValueObjectArrayArg: IKeyValueObject[]) => {
+  let npmextra = new plugins.npmextra.Npmextra(paths.cwd);
+  let config = npmextra.dataFor<IConfig>('npmdocker', {
+    baseImage: 'hosttoday/ht-docker-node:npmdocker',
+    init: 'rm -rf node_nodules/ && yarn install',
+    command: 'npmci npm test',
+    dockerSock: false,
+    keyValueObjectArray: qenvKeyValueObjectArrayArg
+  });
+  return config;
+};
+
+export let run = async (): Promise<IConfig> => {
+  let config = await getQenvKeyValueObject().then(buildConfig);
+  return config;
+};

ts/npmdocker.docker.ts

@@ -0,0 +1,168 @@
+import * as plugins from './npmdocker.plugins';
+import * as paths from './npmdocker.paths';
+import * as snippets from './npmdocker.snippets';
+
+const smartshellInstance = new plugins.smartshell.Smartshell({
+  executor: 'bash'
+})
+
+// interfaces
+import { IConfig } from './npmdocker.config';
+
+let config: IConfig;
+
+/**
+ * the docker data used to build the internal testing container
+ */
+let dockerData = {
+  imageTag: 'npmdocker-temp-image:latest',
+  containerName: 'npmdocker-temp-container',
+  dockerProjectMountString: '',
+  dockerSockString: '',
+  dockerEnvString: ''
+};
+
+/**
+ * check if docker is available
+ */
+let checkDocker = () => {
+  let done = plugins.smartpromise.defer();
+  plugins.beautylog.ora.text('checking docker...');
+  
+  if (smartshellInstance.exec('which docker')) {
+    plugins.beautylog.ok('Docker found!');
+    done.resolve();
+  } else {
+    done.reject(new Error('docker not found on this machine'));
+  }
+  return done.promise;
+};
+
+/**
+ * builds the Dockerfile according to the config in the project
+ */
+let buildDockerFile = () => {
+  let done = plugins.smartpromise.defer();
+  plugins.beautylog.ora.text('building Dockerfile...');
+  let dockerfile: string = snippets.dockerfileSnippet({
+    baseImage: config.baseImage,
+    command: config.command
+  });
+  plugins.beautylog.info(`Base image is: ${config.baseImage}`);
+  plugins.beautylog.info(`Command is: ${config.command}`);
+  plugins.smartfile.memory.toFsSync(dockerfile, plugins.path.join(paths.cwd, 'npmdocker'));
+  plugins.beautylog.ok('Dockerfile created!');
+  plugins.beautylog.ora.stop();
+  done.resolve();
+  return done.promise;
+};
+
+/**
+ * builds the Dockerimage from the built Dockerfile
+ */
+let buildDockerImage = async () => {
+  plugins.beautylog.info('pulling latest base image from registry...');
+  await smartshellInstance.exec(`docker pull ${config.baseImage}`);
+  plugins.beautylog.ora.text('building Dockerimage...');
+  let execResult = await smartshellInstance.execSilent(
+    `docker build -f npmdocker -t ${dockerData.imageTag} ${paths.cwd}`
+  );
+  if (execResult.exitCode !== 0) {
+    console.log(execResult.stdout);
+    process.exit(1);
+  }
+  plugins.beautylog.ok('Dockerimage built!');
+};
+
+let buildDockerProjectMountString = async () => {
+  if (process.env.CI !== 'true') {
+    dockerData.dockerProjectMountString = `-v ${paths.cwd}:/workspace`;
+  }
+};
+
+/**
+ * builds an environment string that docker cli understands
+ */
+let buildDockerEnvString = async () => {
+  for (let keyValueObjectArg of config.keyValueObjectArray) {
+    let envString = (dockerData.dockerEnvString =
+      dockerData.dockerEnvString + `-e ${keyValueObjectArg.key}=${keyValueObjectArg.value} `);
+  }
+};
+
+/**
+ * creates string to mount the docker.sock inside the testcontainer
+ */
+let buildDockerSockString = async () => {
+  if (config.dockerSock) {
+    dockerData.dockerSockString = `-v /var/run/docker.sock:/var/run/docker.sock`;
+  }
+};
+
+/**
+ * creates a container by running the built Dockerimage
+ */
+let runDockerImage = async () => {
+  let done = plugins.smartpromise.defer();
+  plugins.beautylog.ora.text('starting Container...');
+  plugins.beautylog.ora.end();
+  plugins.beautylog.log('now running Dockerimage');
+  config.exitCode = (await smartshellInstance.exec(
+    `docker run ${dockerData.dockerProjectMountString} ${dockerData.dockerSockString} ${
+      dockerData.dockerEnvString
+    } --name ${dockerData.containerName} ${dockerData.imageTag}`
+  )).exitCode;
+};
+
+/**
+ * cleans up: deletes the test container
+ */
+let deleteDockerContainer = async () => {
+  await smartshellInstance.execSilent(`docker rm -f ${dockerData.containerName}`);
+};
+
+/**
+ * cleans up deletes the test image
+ */
+let deleteDockerImage = async () => {
+  await smartshellInstance.execSilent(`docker rmi ${dockerData.imageTag}`).then(async response => {
+    if (response.exitCode !== 0) {
+      console.log(response.stdout);
+    }
+  });
+};
+
+let preClean = async () => {
+  await deleteDockerImage()
+    .then(deleteDockerContainer)
+    .then(async () => {
+      plugins.beautylog.ok('ensured clean Docker environment!');
+    });
+};
+
+let postClean = async () => {
+  await deleteDockerContainer()
+    .then(deleteDockerImage)
+    .then(async () => {
+      plugins.beautylog.ok('cleaned up!');
+    });
+  plugins.smartfile.fs.removeSync(paths.npmdockerFile);
+};
+
+export let run = async (configArg: IConfig): Promise<IConfig> => {
+  plugins.beautylog.ora.start();
+  config = configArg;
+  let resultConfig = await checkDocker()
+    .then(preClean)
+    .then(buildDockerFile)
+    .then(buildDockerImage)
+    .then(buildDockerProjectMountString)
+    .then(buildDockerEnvString)
+    .then(buildDockerSockString)
+    .then(runDockerImage)
+    .then(postClean)
+    .catch(err => {
+      console.log(err);
+    });
+  return config;
+};

ts/npmdocker.paths.ts

@@ -0,0 +1,8 @@
+import * as plugins from './npmdocker.plugins';
+
+// directories
+export let cwd = process.cwd();
+export let packageBase = plugins.path.join(__dirname, '../');
+export let assets = plugins.path.join(packageBase, 'assets/');
+plugins.smartfile.fs.ensureDirSync(assets);
+export let npmdockerFile = plugins.path.join(cwd, 'npmdocker');

ts/npmdocker.plugins.ts

@@ -0,0 +1,23 @@
+import * as beautylog from 'beautylog';
+import * as npmextra from '@pushrocks/npmextra';
+import * as path from 'path';
+import * as projectinfo from '@pushrocks/projectinfo';
+import * as smartpromise from '@pushrocks/smartpromise';
+import * as qenv from '@pushrocks/qenv';
+import * as smartcli from '@pushrocks/smartcli';
+import * as smartfile from '@pushrocks/smartfile';
+import * as smartshell from '@pushrocks/smartshell';
+import * as smartstring from '@pushrocks/smartstring';
+
+export {
+  beautylog,
+  npmextra,
+  path,
+  projectinfo,
+  smartpromise,
+  qenv,
+  smartcli,
+  smartfile,
+  smartshell,
+  smartstring
+};

ts/npmdocker.snippets.ts

@@ -0,0 +1,37 @@
+import * as plugins from './npmdocker.plugins';
+
+export interface IDockerfileSnippet {
+  baseImage: string;
+  command: string;
+}
+
+let getMountSolutionString = (optionsArg: IDockerfileSnippet) => {
+  if (process.env.CI) {
+    return 'COPY ./ /workspace';
+  } else {
+    return '# not copying workspcae since not in CI';
+  }
+};
+
+let getGlobalPreparationString = (optionsArg: IDockerfileSnippet) => {
+  if (optionsArg.baseImage !== 'hosttoday/ht-docker-node:npmdocker') {
+    return 'RUN npm install -g npmdocker';
+  } else {
+    return '# not installing npmdocker since it is included in the base image';
+  }
+};
+
+export let dockerfileSnippet = (optionsArg: IDockerfileSnippet): string => {
+  return plugins.smartstring.indent.normalize(
+    `
+FROM ${optionsArg.baseImage}
+# For info about what npmdocker does read the docs at https://gitzone.github.io/npmdocker
+${getGlobalPreparationString(optionsArg)}
+${getMountSolutionString(optionsArg)}
+WORKDIR /workspace
+ENV CI=true
+ENTRYPOINT ["npmdocker"]
+CMD ["runinside"]
+`
+  );
+};

tslint.json

@@ -0,0 +1,3 @@
+{
+    "extends": "tslint-config-standard"
+}