2.0.26

.gitlab-ci.yml

@@ -1,5 +1,5 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
@@ -38,19 +38,7 @@ snyk:
 # test stage
 # ====================
 
-testLTS:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
+testStable:
   stage: test
   script:
   - npmci npm prepare
@@ -60,12 +48,24 @@ testSTABLE:
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - priv
+
+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:
   stage: release
   script:
-  - npmci node install stable
+  - npmci node install lts
   - npmci npm publish
   only:
   - tags
@@ -78,19 +78,11 @@ release:
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
+    - npmci command npm install -g tslint typescript
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
   - docker
   - priv
@@ -106,7 +98,9 @@ trigger:
   - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
+  image: hosttoday/ht-docker-dbase:npmci
+  services:
+   - docker:stable-dind
   stage: metadata
   script:
     - npmci command npm install -g @gitzone/tsdoc

README.md

@@ -23,6 +23,6 @@ Use TypeScript for best in class instellisense.
 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://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pushrocks/smartshell",
   "private": false,
-  "version": "2.0.20",
+  "version": "2.0.26",
   "description": "shell actions designed as promises",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -24,18 +24,31 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartshell#README",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.11",
-    "@gitzone/tsrun": "^1.2.6",
-    "@gitzone/tstest": "^1.0.22",
-    "@pushrocks/tapbundle": "^3.0.9",
-    "@types/node": "^12.0.2",
-    "tslint": "^5.16.0",
+    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsrun": "^1.2.8",
+    "@gitzone/tstest": "^1.0.24",
+    "@pushrocks/tapbundle": "^3.0.13",
+    "@types/node": "^12.7.2",
+    "tslint": "^5.19.0",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartexit": "^1.0.11",
+    "@pushrocks/smartdelay": "^2.0.3",
+    "@pushrocks/smartexit": "^1.0.15",
     "@pushrocks/smartpromise": "^3.0.2",
     "@types/which": "^1.3.1",
+    "tree-kill": "^1.2.2",
     "which": "^1.3.1"
-  }
+  },
+  "files": [
+    "ts/*",
+    "ts_web/*",
+    "dist/*",
+    "dist_web/*",
+    "dist_ts_web/*",
+    "assets/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

test/test.ts

@@ -45,7 +45,11 @@ tap.test('smartshell should run async', async () => {
 });
 
 tap.test('should be able to find git', async () => {
-  testSmartshell.exec('git --version');
+  await testSmartshell.exec('git --version');
+});
+
+tap.test('should spawn an interactive cli', async () => {
+  // await testSmartshell.execInteractive('echo "hi"');
 });
 
 tap.start({

ts/smartshell.classes.shelllog.ts

@@ -5,13 +5,13 @@ import * as plugins from './smartshell.plugins';
  * making sure the process doesn't run out of memory
  */
 export class ShellLog {
-  logStore = Buffer.from('');
+  public logStore = Buffer.from('');
 
   /**
    * log data to console
    * @param dataArg
    */
-  logToConsole(dataArg: string | Buffer): void {
+  public writeToConsole(dataArg: string | Buffer): void {
     // make sure we have the data as string
     process.stdout.write(dataArg);
   }
@@ -20,7 +20,7 @@ export class ShellLog {
    * add data to Buffer for later consumption
    * @param dataArg
    */
-  addToBuffer(dataArg: string | Buffer): void {
+  public addToBuffer(dataArg: string | Buffer): void {
     // make sure we have the data as Buffer
     const dataBuffer: Buffer = (() => {
       if (!Buffer.isBuffer(dataArg)) {
@@ -31,8 +31,8 @@ export class ShellLog {
     this.logStore = Buffer.concat([this.logStore, dataBuffer]);
   }
 
-  logAndAdd(dataArg: string | Buffer): void {
-    this.logToConsole(dataArg);
+  public logAndAdd(dataArg: string | Buffer): void {
+    this.writeToConsole(dataArg);
     this.addToBuffer(dataArg);
   }
 }

ts/smartshell.classes.smartshell.ts

@@ -53,20 +53,20 @@ export class Smartshell {
     const execChildProcess = cp.spawn(commandToExecute, [], {
       shell: true,
       env: process.env,
-      detached: false
+      detached: false,
     });
 
     this.smartexit.addProcess(execChildProcess);
 
-    execChildProcess.stdout.on('data', data => {
+    execChildProcess.stdout.on('data', (data) => {
       if (!silentArg) {
-        spawnlogInstance.logToConsole(data);
+        spawnlogInstance.writeToConsole(data);
       }
       spawnlogInstance.addToBuffer(data);
     });
-    execChildProcess.stderr.on('data', data => {
+    execChildProcess.stderr.on('data', (data) => {
       if (!silentArg) {
-        spawnlogInstance.logToConsole(data);
+        spawnlogInstance.writeToConsole(data);
       }
       spawnlogInstance.addToBuffer(data);
     });
@@ -77,8 +77,9 @@ export class Smartshell {
         finalPromise: childProcessEnded.promise,
         kill: () => {
           // this notation with the - kills the whole process group
-          process.kill(-execChildProcess.pid);
-        }
+          console.log(`running tree kill on process ${execChildProcess.pid}`);
+          plugins.treeKill(execChildProcess.pid);
+        },
       });
     }
 
@@ -90,7 +91,7 @@ export class Smartshell {
 
       const execResult = {
         exitCode: code,
-        stdout: spawnlogInstance.logStore.toString()
+        stdout: spawnlogInstance.logStore.toString(),
       };
 
       if (!streamingArg) {
@@ -103,7 +104,7 @@ export class Smartshell {
     return result;
   }
 
-  async exec(commandStringArg: string): Promise<IExecResult> {
+  public async exec(commandStringArg: string): Promise<IExecResult> {
     return (await this._exec(commandStringArg, false)) as IExecResult;
   }
 
@@ -111,28 +112,32 @@ export class Smartshell {
    * executes a given command async and silent
    * @param commandStringArg
    */
-  async execSilent(commandStringArg: string): Promise<IExecResult> {
+  public async execSilent(commandStringArg: string): Promise<IExecResult> {
     return (await this._exec(commandStringArg, true)) as IExecResult;
   }
 
   /**
    * executes a command async and strict, meaning it rejects the promise if something happens
    */
-  async execStrict(commandStringArg: string): Promise<IExecResult> {
+  public async execStrict(commandStringArg: string): Promise<IExecResult> {
+    return (await this._exec(commandStringArg, false, true)) as IExecResult;
+  }
+
+  public async execStrictSilent(commandStringArg: string): Promise<IExecResult> {
     return (await this._exec(commandStringArg, true, true)) as IExecResult;
   }
 
   /**
    * executes a command and allows you to stream output
    */
-  async execStreaming(
+  public async execStreaming(
     commandStringArg: string,
     silentArg: boolean = false
   ): Promise<IExecResultStreaming> {
     return (await this._exec(commandStringArg, silentArg, false, true)) as IExecResultStreaming;
   }
 
-  async execStreamingSilent(commandStringArg: string) {
+  public async execStreamingSilent(commandStringArg: string) {
     return (await this.execStreaming(commandStringArg, true)) as IExecResultStreaming;
   }
 
@@ -141,7 +146,11 @@ export class Smartshell {
    * @param commandStringArg
    * @param regexArg
    */
-  async execAndWaitForLine(commandStringArg: string, regexArg: RegExp, silentArg: boolean = false) {
+  public async execAndWaitForLine(
+    commandStringArg: string,
+    regexArg: RegExp,
+    silentArg: boolean = false
+  ) {
     let done = plugins.smartpromise.defer();
     let execStreamingResult = await this.execStreaming(commandStringArg, silentArg);
     execStreamingResult.childProcess.stdout.on('data', (stdOutChunk: string) => {
@@ -152,7 +161,42 @@ export class Smartshell {
     return done.promise;
   }
 
-  async execAndWaitForLineSilent(commandStringArg: string, regexArg: RegExp) {
+  public async execAndWaitForLineSilent(commandStringArg: string, regexArg: RegExp) {
     this.execAndWaitForLine(commandStringArg, regexArg, true);
   }
+
+  /**
+   * execs an command and then enters interactive CLI
+   * @param commandStringArg
+   * @param regexArg
+   */
+  public async execInteractive(commandStringArg: string) {
+    if (process.env.CI) {
+      return;
+    }
+    const done = plugins.smartpromise.defer();
+    const shell = cp.spawn('sh', [], { stdio: 'pipe' });
+    this.smartexit.addProcess(shell);
+    const shellLog = new ShellLog();
+    const stdInStream = process.stdin.pipe(shell.stdin);
+    const stdOutStream = shell.stdout.pipe(process.stdout);
+    shell.on('close', (code) => {
+      console.log(`interactive shell terminated with code ${code}`);
+      stdInStream.removeAllListeners();
+      stdInStream.uncork();
+      stdOutStream.removeAllListeners();
+      stdOutStream.unpipe();
+      shell.kill('SIGTERM');
+      process.stdin.pause();
+      done.resolve();
+    });
+    let commandString = commandStringArg;
+    if (process.env.CI) {
+      commandString += ' && exit';
+    }
+    commandString += '\n';
+
+    shell.stdin.write(commandString);
+    await done.promise;
+  }
 }

ts/smartshell.plugins.ts

@@ -1,5 +1,11 @@
+import * as smartdelay from '@pushrocks/smartdelay';
 import * as smartexit from '@pushrocks/smartexit';
 import * as smartpromise from '@pushrocks/smartpromise';
 import * as which from 'which';
 
-export { smartexit, smartpromise, which };
+export { smartdelay, smartexit, smartpromise, which };
+
+// third party
+import treeKill from 'tree-kill';
+
+export { treeKill };