Skip to content

Commit

Permalink
toolrunner should which tool before invoking
Browse files Browse the repository at this point in the history
  • Loading branch information
ericsciple committed Nov 15, 2019
1 parent 28a7970 commit 99befb3
Show file tree
Hide file tree
Showing 9 changed files with 72 additions and 64 deletions.
70 changes: 15 additions & 55 deletions .github/workflows/unit-tests.yml
Expand Up @@ -6,18 +6,27 @@ on:
pull_request:
paths-ignore:
- '**.md'

jobs:
Ubuntu:
name: Run Ubuntu
runs-on: ubuntu-latest

build:
name: Build

strategy:
matrix:
runs-on: [ubuntu-latest, macOS-latest, windows-latest]
fail-fast: false

runs-on: ${{ matrix.runs-on }}

steps:
- name: Checkout
uses: actions/checkout@master
uses: actions/checkout@v1

- name: Set Node.js 10.x
- name: Set Node.js 12.x
uses: actions/setup-node@master
with:
node-version: 10.x
node-version: 12.x

- name: npm install
run: npm install
Expand All @@ -36,52 +45,3 @@ jobs:

- name: Format
run: npm run format-check
macOS:
name: Run macOS
runs-on: macos-latest
steps:
- name: Checkout
uses: actions/checkout@master

- name: Set Node.js 10.x
uses: actions/setup-node@master
with:
node-version: 10.x

- name: npm install
run: npm install

- name: Bootstrap
run: npm run bootstrap

- name: Compile
run: npm run build

- name: npm test
run: npm test
Windows:
name: Run Windows
runs-on: windows-latest
steps:
- name: Checkout
uses: actions/checkout@master

- name: Set Node.js 10.x
uses: actions/setup-node@master
with:
node-version: 10.x

- name: npm install
run: npm install

- name: Bootstrap
run: npm run bootstrap

- name: Compile
run: npm run build

# TODO: This currently ignores exec due to issues with Node and spawning on Windows, which I think is exacerbated by Jest.
# It doesn't seem to affect behavior in actions themselves, just when testing with Jest.
# See other similar issues here: https://github.com/nodejs/node/issues/25484
- name: npm test
run: npm run test-ci
3 changes: 1 addition & 2 deletions package.json
Expand Up @@ -9,8 +9,7 @@
"format-check": "prettier --check packages/**/*.ts",
"lint": "eslint packages/**/*.ts",
"new-package": "scripts/create-package",
"test": "jest",
"test-ci": "jest --testPathIgnorePatterns=\"<rootDir>/packages/exec/__tests__/exec.test.ts\""
"test": "jest"
},
"devDependencies": {
"@types/jest": "^24.0.11",
Expand Down
2 changes: 1 addition & 1 deletion packages/core/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 2 additions & 4 deletions packages/exec/README.md
Expand Up @@ -48,13 +48,11 @@ await exec.exec('node', ['index.js', 'foo=bar'], options);

#### Exec tools not in the PATH

You can use it in conjunction with the `which` function from `@actions/io` to execute tools that are not in the PATH:
You can specify the full path for tools not in the PATH:

```js
const exec = require('@actions/exec');
const io = require('@actions/io');

const pythonPath: string = await io.which('python', true)

await exec.exec(`"${pythonPath}"`, ['main.py']);
await exec.exec('"<FULL-PATH-TO-TOOL>"', ['arg1']);
```
36 changes: 36 additions & 0 deletions packages/exec/__tests__/exec.test.ts
Expand Up @@ -572,6 +572,42 @@ describe('@actions/exec', () => {
)
})

it('execs .cmd from path (Windows)', async () => {
// this test validates whether a .cmd is resolved from the PATH when the extension is not specified
const cmd = 'print-args-cmd' // note, not print-args-cmd.cmd
const cmdPath = path.join(__dirname, 'scripts', `${cmd}.cmd`)
const args: string[] = ['my arg 1', 'my arg 2']
const outStream = new StringStream()
let output = ''
const options = {
outStream: <stream.Writable>outStream,
listeners: {
stdout: (data: Buffer) => {
output += data.toString()
}
}
}

const originalPath = process.env['Path']
try {
process.env['Path'] = `${originalPath};${path.dirname(cmdPath)}`
const exitCode = await exec.exec(`${cmd}`, args, options)
expect(exitCode).toBe(0)
expect(outStream.getContents().split(os.EOL)[0]).toBe(
`[command]${
process.env.ComSpec
} /D /S /C "${cmdPath} "my arg 1" "my arg 2""`
)
expect(output.trim()).toBe(
'args[0]: "<quote>my arg 1<quote>"\r\n' +
'args[1]: "<quote>my arg 2<quote>"'
)
} catch (err) {
process.env['Path'] = originalPath
throw err
}
})

it('execs .cmd with arg quoting (Windows)', async () => {
// this test validates .cmd quoting rules are applied, not the default libuv rules
const cmdPath = path.join(
Expand Down
12 changes: 12 additions & 0 deletions packages/exec/__tests__/scripts/print-args-cmd.cmd
@@ -0,0 +1,12 @@
@echo off
setlocal
set index=0

:check_arg
set arg=%1
if not defined arg goto :eof
set "arg=%arg:"=<quote>%"
echo args[%index%]: "%arg%"
set /a index=%index%+1
shift
goto check_arg
2 changes: 1 addition & 1 deletion packages/exec/package.json
Expand Up @@ -32,7 +32,7 @@
"bugs": {
"url": "https://github.com/actions/toolkit/issues"
},
"devDependencies": {
"dependencies": {
"@actions/io": "^1.0.1"
}
}
3 changes: 3 additions & 0 deletions packages/exec/src/toolrunner.ts
Expand Up @@ -3,6 +3,7 @@ import * as events from 'events'
import * as child from 'child_process'
import * as stream from 'stream'
import * as im from './interfaces'
import * as io from '@actions/io'

/* eslint-disable @typescript-eslint/unbound-method */

Expand Down Expand Up @@ -392,6 +393,8 @@ export class ToolRunner extends events.EventEmitter {
* @returns number
*/
async exec(): Promise<number> {
this.toolPath = await io.which(this.toolPath, true)

return new Promise<number>((resolve, reject) => {
this._debug(`exec tool: ${this.toolPath}`)
this._debug('arguments:')
Expand Down
2 changes: 1 addition & 1 deletion packages/tool-cache/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 99befb3

Please sign in to comment.