Compare commits
21 Commits
Author | SHA1 | Date | |
---|---|---|---|
9ba5447e72 | |||
6cb7ab8f19 | |||
efdb80ddba | |||
db712b2223 | |||
0199160013 | |||
199fa19899 | |||
23a3230f07 | |||
ad0b7ac21c | |||
c8c0cbd47a | |||
213dac474e | |||
a4c188051a | |||
62195b63d6 | |||
16ba3803a4 | |||
613241cdcb | |||
f5df21e144 | |||
ba8c2d06d8 | |||
9bb0999f0e | |||
1beb3a0bbe | |||
c1133e9131 | |||
48dd3c3cca | |||
f0a5be41ea |
4
.gitignore
vendored
4
.gitignore
vendored
@ -15,8 +15,6 @@ node_modules/
|
|||||||
|
|
||||||
# builds
|
# builds
|
||||||
dist/
|
dist/
|
||||||
dist_web/
|
dist_*/
|
||||||
dist_serve/
|
|
||||||
dist_ts_web/
|
|
||||||
|
|
||||||
# custom
|
# custom
|
@ -1,10 +1,10 @@
|
|||||||
# gitzone standard
|
# gitzone ci_default
|
||||||
image: hosttoday/ht-docker-node:npmci
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
|
||||||
cache:
|
cache:
|
||||||
paths:
|
paths:
|
||||||
- .npmci_cache/
|
- .npmci_cache/
|
||||||
key: "$CI_BUILD_STAGE"
|
key: '$CI_BUILD_STAGE'
|
||||||
|
|
||||||
stages:
|
stages:
|
||||||
- security
|
- security
|
||||||
@ -19,38 +19,42 @@ mirror:
|
|||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci git mirror
|
- npmci git mirror
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
|
|
||||||
snyk:
|
auditProductionDependencies:
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
- npmci command npm install -g snyk
|
- npmci command npm install --production --ignore-scripts
|
||||||
- npmci command npm install --ignore-scripts
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
- npmci command snyk test
|
- npmci command npm audit --audit-level=high --only=prod --production
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
allow_failure: true
|
||||||
|
|
||||||
|
auditDevDependencies:
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
stage: security
|
||||||
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci command npm install --ignore-scripts
|
||||||
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
- npmci command npm audit --audit-level=high --only=dev
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
allow_failure: true
|
||||||
|
|
||||||
# ====================
|
# ====================
|
||||||
# test stage
|
# test stage
|
||||||
# ====================
|
# ====================
|
||||||
|
|
||||||
testLTS:
|
testStable:
|
||||||
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:
|
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
@ -60,7 +64,17 @@ testSTABLE:
|
|||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
|
||||||
|
testBuild:
|
||||||
|
stage: test
|
||||||
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci node install stable
|
||||||
|
- npmci npm install
|
||||||
|
- npmci command npm run build
|
||||||
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
|
||||||
release:
|
release:
|
||||||
stage: release
|
stage: release
|
||||||
@ -70,6 +84,7 @@ release:
|
|||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
|
|
||||||
@ -78,20 +93,16 @@ release:
|
|||||||
# ====================
|
# ====================
|
||||||
codequality:
|
codequality:
|
||||||
stage: metadata
|
stage: metadata
|
||||||
image: docker:stable
|
|
||||||
allow_failure: true
|
allow_failure: true
|
||||||
services:
|
only:
|
||||||
- docker:stable-dind
|
- tags
|
||||||
script:
|
script:
|
||||||
- export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
|
- npmci command npm install -g tslint typescript
|
||||||
- docker run
|
- npmci npm prepare
|
||||||
--env SOURCE_CODE="$PWD"
|
- npmci npm install
|
||||||
--volume "$PWD":/code
|
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||||
--volume /var/run/docker.sock:/var/run/docker.sock
|
|
||||||
"registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
|
|
||||||
artifacts:
|
|
||||||
paths: [codeclimate.json]
|
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- priv
|
- priv
|
||||||
|
|
||||||
@ -102,18 +113,20 @@ trigger:
|
|||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
|
|
||||||
pages:
|
pages:
|
||||||
image: hosttoday/ht-docker-node:npmci
|
|
||||||
stage: metadata
|
stage: metadata
|
||||||
script:
|
script:
|
||||||
|
- npmci node install lts
|
||||||
- npmci command npm install -g @gitzone/tsdoc
|
- npmci command npm install -g @gitzone/tsdoc
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci command tsdoc
|
- npmci command tsdoc
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
only:
|
only:
|
||||||
|
29
.vscode/launch.json
vendored
Normal file
29
.vscode/launch.json
vendored
Normal file
@ -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"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
26
.vscode/settings.json
vendored
Normal file
26
.vscode/settings.json
vendored
Normal file
@ -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", "wcc"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
28
README.md
28
README.md
@ -1,28 +0,0 @@
|
|||||||
# @pushrocks/smartshell
|
|
||||||
shell actions designed as promises
|
|
||||||
|
|
||||||
## Availabililty and Links
|
|
||||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartshell)
|
|
||||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartshell)
|
|
||||||
* [github.com (source mirror)](https://github.com/pushrocks/smartshell)
|
|
||||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartshell/)
|
|
||||||
|
|
||||||
## Status for master
|
|
||||||
[](https://gitlab.com/pushrocks/smartshell/commits/master)
|
|
||||||
[](https://gitlab.com/pushrocks/smartshell/commits/master)
|
|
||||||
[](https://www.npmjs.com/package/@pushrocks/smartshell)
|
|
||||||
[](https://snyk.io/test/npm/@pushrocks/smartshell)
|
|
||||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
||||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
||||||
[](https://prettier.io/)
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
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)
|
|
||||||
|
|
||||||
[](https://maintainedby.lossless.com)
|
|
@ -5,6 +5,7 @@
|
|||||||
"npmRegistryUrl": "registry.npmjs.org"
|
"npmRegistryUrl": "registry.npmjs.org"
|
||||||
},
|
},
|
||||||
"gitzone": {
|
"gitzone": {
|
||||||
|
"projectType": "npm",
|
||||||
"module": {
|
"module": {
|
||||||
"githost": "gitlab.com",
|
"githost": "gitlab.com",
|
||||||
"gitscope": "pushrocks",
|
"gitscope": "pushrocks",
|
||||||
|
24984
package-lock.json
generated
24984
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
47
package.json
47
package.json
@ -1,13 +1,13 @@
|
|||||||
{
|
{
|
||||||
"name": "@pushrocks/smartshell",
|
"name": "@pushrocks/smartshell",
|
||||||
"private": false,
|
"private": false,
|
||||||
"version": "2.0.17",
|
"version": "2.0.28",
|
||||||
"description": "shell actions designed as promises",
|
"description": "shell actions designed as promises",
|
||||||
"main": "dist/index.js",
|
"main": "dist_ts/index.js",
|
||||||
"typings": "dist/index.d.ts",
|
"typings": "dist_ts/index.d.ts",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(tstest test/)",
|
"test": "(tstest test/)",
|
||||||
"build": "(tsbuild)"
|
"build": "(tsbuild --web)"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@ -24,18 +24,35 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://gitlab.com/pushrocks/smartshell#README",
|
"homepage": "https://gitlab.com/pushrocks/smartshell#README",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@gitzone/tsbuild": "^2.1.11",
|
"@gitzone/tsbuild": "^2.1.26",
|
||||||
"@gitzone/tsrun": "^1.2.6",
|
"@gitzone/tsrun": "^1.2.17",
|
||||||
"@gitzone/tstest": "^1.0.21",
|
"@gitzone/tstest": "^1.0.54",
|
||||||
"@pushrocks/tapbundle": "^3.0.9",
|
"@pushrocks/tapbundle": "^3.2.14",
|
||||||
"@types/node": "^12.0.2",
|
"@types/node": "^16.6.1",
|
||||||
"tslint": "^5.16.0",
|
"tslint": "^6.1.3",
|
||||||
"tslint-config-prettier": "^1.18.0"
|
"tslint-config-prettier": "^1.18.0"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@pushrocks/smartexit": "^1.0.10",
|
"@pushrocks/smartdelay": "^2.0.13",
|
||||||
"@pushrocks/smartpromise": "^3.0.2",
|
"@pushrocks/smartexit": "^1.0.19",
|
||||||
"@types/which": "^1.3.1",
|
"@pushrocks/smartpromise": "^3.1.6",
|
||||||
"which": "^1.3.1"
|
"@types/which": "^2.0.1",
|
||||||
}
|
"tree-kill": "^1.2.2",
|
||||||
|
"which": "^2.0.2"
|
||||||
|
},
|
||||||
|
"files": [
|
||||||
|
"ts/**/*",
|
||||||
|
"ts_web/**/*",
|
||||||
|
"dist/**/*",
|
||||||
|
"dist_*/**/*",
|
||||||
|
"dist_ts/**/*",
|
||||||
|
"dist_ts_web/**/*",
|
||||||
|
"assets/**/*",
|
||||||
|
"cli.js",
|
||||||
|
"npmextra.json",
|
||||||
|
"readme.md"
|
||||||
|
],
|
||||||
|
"browserslist": [
|
||||||
|
"last 1 chrome versions"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
40
readme.md
Normal file
40
readme.md
Normal file
@ -0,0 +1,40 @@
|
|||||||
|
# @pushrocks/smartshell
|
||||||
|
shell actions designed as promises
|
||||||
|
|
||||||
|
## Availabililty and Links
|
||||||
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartshell)
|
||||||
|
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartshell)
|
||||||
|
* [github.com (source mirror)](https://github.com/pushrocks/smartshell)
|
||||||
|
* [docs (typedoc)](https://pushrocks.gitlab.io/smartshell/)
|
||||||
|
|
||||||
|
## Status for master
|
||||||
|
|
||||||
|
Status Category | Status Badge
|
||||||
|
-- | --
|
||||||
|
GitLab Pipelines | [](https://lossless.cloud)
|
||||||
|
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||||
|
npm | [](https://lossless.cloud)
|
||||||
|
Snyk | [](https://lossless.cloud)
|
||||||
|
TypeScript Support | [](https://lossless.cloud)
|
||||||
|
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||||
|
Code Style | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||||
|
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||||
|
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Use TypeScript for best in class instellisense.
|
||||||
|
|
||||||
|
|
||||||
|
## 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)
|
||||||
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||||
|
|
||||||
|
[](https://maintainedby.lossless.com)
|
14
test/test.ts
14
test/test.ts
@ -8,7 +8,7 @@ let testSmartshell: smartshell.Smartshell;
|
|||||||
tap.test('smartshell should create a Smartshell instance', async () => {
|
tap.test('smartshell should create a Smartshell instance', async () => {
|
||||||
testSmartshell = new smartshell.Smartshell({
|
testSmartshell = new smartshell.Smartshell({
|
||||||
executor: 'bash',
|
executor: 'bash',
|
||||||
sourceFilePaths: []
|
sourceFilePaths: [],
|
||||||
});
|
});
|
||||||
expect(testSmartshell).to.be.instanceof(smartshell.Smartshell);
|
expect(testSmartshell).to.be.instanceof(smartshell.Smartshell);
|
||||||
});
|
});
|
||||||
@ -26,7 +26,7 @@ tap.test('smartshell should run async and silent', async () => {
|
|||||||
tap.test('smartshell should stream a shell execution', async () => {
|
tap.test('smartshell should stream a shell execution', async () => {
|
||||||
let done = smartpromise.defer();
|
let done = smartpromise.defer();
|
||||||
let execStreamingResponse = await testSmartshell.execStreaming('npm -v');
|
let execStreamingResponse = await testSmartshell.execStreaming('npm -v');
|
||||||
execStreamingResponse.childProcess.stdout.on('data', data => {
|
execStreamingResponse.childProcess.stdout.on('data', (data) => {
|
||||||
done.resolve(data);
|
done.resolve(data);
|
||||||
});
|
});
|
||||||
let data = await done.promise;
|
let data = await done.promise;
|
||||||
@ -39,15 +39,19 @@ tap.test('it should execute and wait for a line in the output', async () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
tap.test('smartshell should run async', async () => {
|
tap.test('smartshell should run async', async () => {
|
||||||
return testSmartshell.execSilent('sleep 1 && npm -v').then(async execResult => {
|
return testSmartshell.execSilent('sleep 1 && npm -v').then(async (execResult) => {
|
||||||
console.log(execResult.stdout);
|
console.log(execResult.stdout);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('should be able to find git', 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({
|
tap.start({
|
||||||
throwOnError: true
|
throwOnError: true,
|
||||||
});
|
});
|
||||||
|
@ -31,7 +31,7 @@ export class ShellEnv {
|
|||||||
/**
|
/**
|
||||||
* imports path into the shell from env if available and returns it with
|
* imports path into the shell from env if available and returns it with
|
||||||
*/
|
*/
|
||||||
private _setPath(commandStringArg): string {
|
private _setPath(commandStringArg: string): string {
|
||||||
let commandResult = commandStringArg;
|
let commandResult = commandStringArg;
|
||||||
let commandPaths: string[] = [];
|
let commandPaths: string[] = [];
|
||||||
commandPaths = commandPaths.concat(process.env.PATH.split(':'));
|
commandPaths = commandPaths.concat(process.env.PATH.split(':'));
|
||||||
@ -41,7 +41,7 @@ export class ShellEnv {
|
|||||||
|
|
||||||
// lets filter for unwanted paths
|
// lets filter for unwanted paths
|
||||||
// Windows WSL
|
// Windows WSL
|
||||||
commandPaths = commandPaths.filter(commandPathArg => {
|
commandPaths = commandPaths.filter((commandPathArg) => {
|
||||||
const filterResult =
|
const filterResult =
|
||||||
!commandPathArg.startsWith('/mnt/c/') &&
|
!commandPathArg.startsWith('/mnt/c/') &&
|
||||||
!commandPathArg.startsWith('Files/1E') &&
|
!commandPathArg.startsWith('Files/1E') &&
|
||||||
|
@ -5,13 +5,13 @@ import * as plugins from './smartshell.plugins';
|
|||||||
* making sure the process doesn't run out of memory
|
* making sure the process doesn't run out of memory
|
||||||
*/
|
*/
|
||||||
export class ShellLog {
|
export class ShellLog {
|
||||||
logStore = Buffer.from('');
|
public logStore = Buffer.from('');
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* log data to console
|
* log data to console
|
||||||
* @param dataArg
|
* @param dataArg
|
||||||
*/
|
*/
|
||||||
logToConsole(dataArg: string | Buffer): void {
|
public writeToConsole(dataArg: string | Buffer): void {
|
||||||
// make sure we have the data as string
|
// make sure we have the data as string
|
||||||
process.stdout.write(dataArg);
|
process.stdout.write(dataArg);
|
||||||
}
|
}
|
||||||
@ -20,7 +20,7 @@ export class ShellLog {
|
|||||||
* add data to Buffer for later consumption
|
* add data to Buffer for later consumption
|
||||||
* @param dataArg
|
* @param dataArg
|
||||||
*/
|
*/
|
||||||
addToBuffer(dataArg: string | Buffer): void {
|
public addToBuffer(dataArg: string | Buffer): void {
|
||||||
// make sure we have the data as Buffer
|
// make sure we have the data as Buffer
|
||||||
const dataBuffer: Buffer = (() => {
|
const dataBuffer: Buffer = (() => {
|
||||||
if (!Buffer.isBuffer(dataArg)) {
|
if (!Buffer.isBuffer(dataArg)) {
|
||||||
@ -31,8 +31,8 @@ export class ShellLog {
|
|||||||
this.logStore = Buffer.concat([this.logStore, dataBuffer]);
|
this.logStore = Buffer.concat([this.logStore, dataBuffer]);
|
||||||
}
|
}
|
||||||
|
|
||||||
logAndAdd(dataArg: string | Buffer): void {
|
public logAndAdd(dataArg: string | Buffer): void {
|
||||||
this.logToConsole(dataArg);
|
this.writeToConsole(dataArg);
|
||||||
this.addToBuffer(dataArg);
|
this.addToBuffer(dataArg);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -21,7 +21,14 @@ export interface IExecResult {
|
|||||||
export interface IExecResultStreaming {
|
export interface IExecResultStreaming {
|
||||||
childProcess: cp.ChildProcess;
|
childProcess: cp.ChildProcess;
|
||||||
finalPromise: Promise<IExecResult>;
|
finalPromise: Promise<IExecResult>;
|
||||||
|
/**
|
||||||
|
* sends SIGKILL
|
||||||
|
*/
|
||||||
kill: () => void;
|
kill: () => void;
|
||||||
|
/**
|
||||||
|
* sends SIGTERM
|
||||||
|
*/
|
||||||
|
terminate: () => void;
|
||||||
}
|
}
|
||||||
|
|
||||||
// -- SmartShell --
|
// -- SmartShell --
|
||||||
@ -53,35 +60,24 @@ export class Smartshell {
|
|||||||
const execChildProcess = cp.spawn(commandToExecute, [], {
|
const execChildProcess = cp.spawn(commandToExecute, [], {
|
||||||
shell: true,
|
shell: true,
|
||||||
env: process.env,
|
env: process.env,
|
||||||
detached: true
|
detached: false,
|
||||||
});
|
});
|
||||||
|
|
||||||
this.smartexit.addProcess(execChildProcess);
|
this.smartexit.addProcess(execChildProcess);
|
||||||
|
|
||||||
execChildProcess.stdout.on('data', data => {
|
execChildProcess.stdout.on('data', (data) => {
|
||||||
if (!silentArg) {
|
if (!silentArg) {
|
||||||
spawnlogInstance.logToConsole(data);
|
spawnlogInstance.writeToConsole(data);
|
||||||
}
|
}
|
||||||
spawnlogInstance.addToBuffer(data);
|
spawnlogInstance.addToBuffer(data);
|
||||||
});
|
});
|
||||||
execChildProcess.stderr.on('data', data => {
|
execChildProcess.stderr.on('data', (data) => {
|
||||||
if (!silentArg) {
|
if (!silentArg) {
|
||||||
spawnlogInstance.logToConsole(data);
|
spawnlogInstance.writeToConsole(data);
|
||||||
}
|
}
|
||||||
spawnlogInstance.addToBuffer(data);
|
spawnlogInstance.addToBuffer(data);
|
||||||
});
|
});
|
||||||
|
|
||||||
if (streamingArg) {
|
|
||||||
done.resolve({
|
|
||||||
childProcess: execChildProcess,
|
|
||||||
finalPromise: childProcessEnded.promise,
|
|
||||||
kill: () => {
|
|
||||||
// this notation with the - kills the whole process group
|
|
||||||
process.kill(-execChildProcess.pid);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
execChildProcess.on('exit', (code, signal) => {
|
execChildProcess.on('exit', (code, signal) => {
|
||||||
this.smartexit.removeProcess(execChildProcess);
|
this.smartexit.removeProcess(execChildProcess);
|
||||||
if (strictArg && code === 1) {
|
if (strictArg && code === 1) {
|
||||||
@ -90,7 +86,7 @@ export class Smartshell {
|
|||||||
|
|
||||||
const execResult = {
|
const execResult = {
|
||||||
exitCode: code,
|
exitCode: code,
|
||||||
stdout: spawnlogInstance.logStore.toString()
|
stdout: spawnlogInstance.logStore.toString(),
|
||||||
};
|
};
|
||||||
|
|
||||||
if (!streamingArg) {
|
if (!streamingArg) {
|
||||||
@ -99,11 +95,28 @@ export class Smartshell {
|
|||||||
childProcessEnded.resolve(execResult);
|
childProcessEnded.resolve(execResult);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
if (streamingArg) {
|
||||||
|
done.resolve({
|
||||||
|
childProcess: execChildProcess,
|
||||||
|
finalPromise: childProcessEnded.promise,
|
||||||
|
kill: () => {
|
||||||
|
// this notation with the - kills the whole process group
|
||||||
|
console.log(`running tree kill with SIGKILL on process ${execChildProcess.pid}`);
|
||||||
|
plugins.treeKill(execChildProcess.pid, 'SIGKILL');
|
||||||
|
},
|
||||||
|
terminate: () => {
|
||||||
|
// this notation with the - kills the whole process group
|
||||||
|
console.log(`running tree kill with SIGTERM on process ${execChildProcess.pid}`);
|
||||||
|
plugins.treeKill(execChildProcess.pid, 'SIGTERM');
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
const result = await done.promise;
|
const result = await done.promise;
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
||||||
async exec(commandStringArg: string): Promise<IExecResult> {
|
public async exec(commandStringArg: string): Promise<IExecResult> {
|
||||||
return (await this._exec(commandStringArg, false)) as IExecResult;
|
return (await this._exec(commandStringArg, false)) as IExecResult;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -111,28 +124,32 @@ export class Smartshell {
|
|||||||
* executes a given command async and silent
|
* executes a given command async and silent
|
||||||
* @param commandStringArg
|
* @param commandStringArg
|
||||||
*/
|
*/
|
||||||
async execSilent(commandStringArg: string): Promise<IExecResult> {
|
public async execSilent(commandStringArg: string): Promise<IExecResult> {
|
||||||
return (await this._exec(commandStringArg, true)) as IExecResult;
|
return (await this._exec(commandStringArg, true)) as IExecResult;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* executes a command async and strict, meaning it rejects the promise if something happens
|
* 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;
|
return (await this._exec(commandStringArg, true, true)) as IExecResult;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* executes a command and allows you to stream output
|
* executes a command and allows you to stream output
|
||||||
*/
|
*/
|
||||||
async execStreaming(
|
public async execStreaming(
|
||||||
commandStringArg: string,
|
commandStringArg: string,
|
||||||
silentArg: boolean = false
|
silentArg: boolean = false
|
||||||
): Promise<IExecResultStreaming> {
|
): Promise<IExecResultStreaming> {
|
||||||
return (await this._exec(commandStringArg, silentArg, false, true)) as 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;
|
return (await this.execStreaming(commandStringArg, true)) as IExecResultStreaming;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -141,7 +158,11 @@ export class Smartshell {
|
|||||||
* @param commandStringArg
|
* @param commandStringArg
|
||||||
* @param regexArg
|
* @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 done = plugins.smartpromise.defer();
|
||||||
let execStreamingResult = await this.execStreaming(commandStringArg, silentArg);
|
let execStreamingResult = await this.execStreaming(commandStringArg, silentArg);
|
||||||
execStreamingResult.childProcess.stdout.on('data', (stdOutChunk: string) => {
|
execStreamingResult.childProcess.stdout.on('data', (stdOutChunk: string) => {
|
||||||
@ -152,7 +173,42 @@ export class Smartshell {
|
|||||||
return done.promise;
|
return done.promise;
|
||||||
}
|
}
|
||||||
|
|
||||||
async execAndWaitForLineSilent(commandStringArg: string, regexArg: RegExp) {
|
public async execAndWaitForLineSilent(commandStringArg: string, regexArg: RegExp) {
|
||||||
this.execAndWaitForLine(commandStringArg, regexArg, true);
|
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;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,5 +1,11 @@
|
|||||||
|
import * as smartdelay from '@pushrocks/smartdelay';
|
||||||
import * as smartexit from '@pushrocks/smartexit';
|
import * as smartexit from '@pushrocks/smartexit';
|
||||||
import * as smartpromise from '@pushrocks/smartpromise';
|
import * as smartpromise from '@pushrocks/smartpromise';
|
||||||
import * as which from 'which';
|
import * as which from 'which';
|
||||||
|
|
||||||
export { smartexit, smartpromise, which };
|
export { smartdelay, smartexit, smartpromise, which };
|
||||||
|
|
||||||
|
// third party
|
||||||
|
import treeKill from 'tree-kill';
|
||||||
|
|
||||||
|
export { treeKill };
|
||||||
|
Reference in New Issue
Block a user