Merge pull request #91 from gh640/dependabot/npm_and_yarn/actions/core-1.10.0

Bump @actions/core from 1.9.1 to 1.10.0

Author: gh640

__tests__/main.test.ts

@@ -1,7 +1,12 @@
-import * as process from 'process'
 import * as cp from 'child_process'
+import * as fs from 'fs'
 import * as path from 'path'
-import {expect, test} from '@jest/globals'
+import * as process from 'process'
+
+import {afterAll, beforeAll, describe, expect, test} from '@jest/globals'
+
+const outDirParent = path.join(__dirname, 'test')
+const outDirPrefix = path.join(outDirParent, 'out-')
 
 type CommandResult = {
   exitCode: number
@@ -46,53 +51,123 @@ const prepareEnv: prepareEnvType = vars => {
   }
 }
 
-test('throws error on unknown command', async () => {
-  const {exitCode, stdout, stderr} = await execMain(
-    prepareEnv({INPUT_COMMAND: 'unknown'})
-  )
-  expect(exitCode).toEqual(1)
-  expect(stdout).toContain('Unable to locate executable file: unknown.')
-  expect(stderr).toContain('Error: Unable to locate executable file: unknown.')
-})
+describe('lib/main.js', () => {
+  beforeAll(() => {
+    if (!fs.existsSync(outDirParent)) {
+      fs.mkdirSync(outDirParent)
+    }
+  })
 
-test('properly handles single-line stdout', async () => {
-  const {stdout} = await execMain(
-    prepareEnv({INPUT_COMMAND: 'echo "Hello world"'})
-  )
-
-  expect(stdout).toContain('Starting command.')
-  expect(stdout).toContain(['echo Hello world', 'Hello world'].join('\n'))
-  expect(stdout).toContain('Finished command.')
-  expect(stdout).toContain('::set-output name=exitCode::0')
-  expect(stdout).toContain('::set-output name=stdout::Hello world%0A')
-  expect(stdout).toContain('::set-output name=stderr::')
-})
+  afterAll(() => {
+    fs.rmSync(outDirParent, {recursive: true})
+  })
 
-test('properly handles multi-line stdout (line breaks are escaped)', async () => {
-  const {stdout} = await execMain(
-    prepareEnv({INPUT_COMMAND: 'echo "Hello\nworld"'})
-  )
-
-  expect(stdout).toContain('Starting command.')
-  expect(stdout).toContain(['echo Hello\nworld', 'Hello\nworld'].join('\n'))
-  expect(stdout).toContain('Finished command.')
-  expect(stdout).toContain('::set-output name=exitCode::0')
-  expect(stdout).toContain('::set-output name=stdout::Hello%0Aworld%0A')
-  expect(stdout).toContain('::set-output name=stderr::')
-})
+  test('properly handles single-line stdout', async () => {
+    const [outFile, readOutFile] = tempFile()
+    const {stdout} = await execMain(
+      prepareEnv({
+        INPUT_COMMAND: 'echo "Hello world"',
+        GITHUB_OUTPUT: outFile
+      })
+    )
+    const outFileContent = readOutFile()
+
+    expect(stdout).toContain('Starting command.')
+    expect(stdout).toContain('echo Hello world\nHello world')
+    expect(stdout).toContain('Finished command.')
+
+    // `[\w-]` matches the delimtier.
+    expect(outFileContent).toMatch(/exitCode<<[\w-]+\n0\n/)
+    expect(outFileContent).toMatch(/stdout<<[\w-]+\nHello world\n/)
+    expect(outFileContent).toMatch(/stderr<<[\w-]+\n\n/)
+  })
+
+  test('properly handles multi-line stdout', async () => {
+    const [outFile, readOutFile] = tempFile()
+    const {stdout} = await execMain(
+      prepareEnv({
+        INPUT_COMMAND: 'echo "Hello\nworld"',
+        GITHUB_OUTPUT: outFile
+      })
+    )
+    const outFileContent = readOutFile()
+
+    // `[\w-]` matches the delimtier.
+    expect(outFileContent).toMatch(/exitCode<<[\w-]+\n0\n/)
+    expect(outFileContent).toMatch(/stdout<<[\w-]+\nHello\nworld\n/)
+    expect(outFileContent).toMatch(/stderr<<[\w-]+\n\n/)
+  })
 
-test('cwd', async () => {
-  const {stdout} = await execMain(
-    prepareEnv({
-      INPUT_COMMAND: 'ls',
-      INPUT_CWD: './lib'
-    })
-  )
-
-  expect(stdout).toContain('Starting command.')
-  expect(stdout).toContain(['ls', 'main.js'].join('\n'))
-  expect(stdout).toContain('Finished command.')
-  expect(stdout).toContain('::set-output name=exitCode::0')
-  expect(stdout).toContain('::set-output name=stdout::main.js%0A')
-  expect(stdout).toContain('::set-output name=stderr::')
+  test('works with option `cwd`', async () => {
+    const [outFile, readOutFile] = tempFile()
+    const {stdout} = await execMain(
+      prepareEnv({
+        INPUT_COMMAND: 'ls',
+        INPUT_CWD: './lib',
+        GITHUB_OUTPUT: outFile
+      })
+    )
+    const outFileContent = readOutFile()
+
+    // `[\w-]` matches the delimtier.
+    expect(outFileContent).toMatch(/exitCode<<[\w-]+\n0\n/)
+    expect(outFileContent).toMatch(/stdout<<[\w-]+\nmain\.js\n/)
+    expect(outFileContent).toMatch(/stderr<<[\w-]+\n\n/)
+  })
+
+  test('properly captures stderr', async () => {
+    const [outFile, readOutFile] = tempFile()
+    const {exitCode, stdout, stderr} = await execMain(
+      prepareEnv({
+        INPUT_COMMAND: 'ls /unkown/path/',
+        GITHUB_OUTPUT: outFile
+      })
+    )
+    const outFileContent = readOutFile()
+
+    expect(exitCode).toEqual(0)
+    expect(stdout).toContain('ls /unkown/path/')
+    expect(stderr).toContain('')
+
+    // `[\w-]` matches the delimtier.
+    // The `exitCode` can be 1 or 2 depending on the environment.
+    expect(outFileContent).toMatch(/exitCode<<[\w-]+\n[12]\n/)
+    expect(outFileContent).toMatch(/stdout<<[\w-]+\n\n/)
+    expect(outFileContent).toMatch(
+      /stderr<<[\w-]+\n.*No such file or directory\n/
+    )
+  })
+
+  test('fails with unknown command', async () => {
+    const [outFile, readOutFile] = tempFile()
+    const {exitCode, stdout, stderr} = await execMain(
+      prepareEnv({
+        INPUT_COMMAND: 'unknown',
+        GITHUB_OUTPUT: outFile
+      })
+    )
+    const outFileContent = readOutFile()
+
+    expect(exitCode).toEqual(1)
+    expect(stdout).toContain('Unable to locate executable file: unknown.')
+    expect(stderr).toContain(
+      'Error: Unable to locate executable file: unknown.'
+    )
+    expect(outFileContent).toEqual('')
+  })
 })
+
+/**
+ * Helper: prepare a temporary file.
+ */
+function tempFile(): [string, () => string] {
+  const directory = fs.mkdtempSync(outDirPrefix)
+  const file = path.join(directory, 'out')
+  fs.appendFileSync(file, '', {encoding: 'utf8'})
+
+  function read(): string {
+    return fs.readFileSync(file, {encoding: 'utf8'})
+  }
+
+  return [file, read]
+}

dist/index.js

@@ -25,7 +25,7 @@
   "author": "Goto Hayato <gh640@hey.com>",
   "license": "MIT",
   "dependencies": {
-    "@actions/core": "^1.9.0",
+    "@actions/core": "^1.10.0",
     "@actions/exec": "^1.1.1"
   },
   "devDependencies": {

dist/index.js.map

@@ -9,9 +9,7 @@ async function main(): Promise<void> {
   const command: string = core.getInput('command', {required: true})
   const cwd: string = core.getInput('cwd')
 
-  const options: exec.ExecOptions = {
-    ignoreReturnCode: true
-  }
+  const options: exec.ExecOptions = {ignoreReturnCode: true}
   if (cwd != null) {
     options.cwd = cwd
   }