commit

Author: vCaisim

README.md

@@ -2,19 +2,44 @@
   <a href="https://github.com/actions/typescript-action/actions"><img alt="typescript-action status" src="https://github.com/actions/typescript-action/workflows/build-test/badge.svg"></a>
 </p>
 
-# Create a JavaScript Action using TypeScript
+# Cancel Currents run action
 
-Use this template to bootstrap the creation of a TypeScript action.:rocket:
+This action cancels the current cypress run by calling the Currents API.
 
-This template includes compilation support, tests, a validation workflow, publishing, and versioning guidance.  
+## Inputs
 
-If you are new, there's also a simpler introduction.  See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)
+### `currents-api-url`
 
-## Create an action from this template
+Currents API URL. Default value is `https://api.currents.dev/api/v1`
 
-Click the `Use this Template` and provide the new repo details for your action
+### `bearer-token`
 
-## Code in Main
+**Required** Bearer authorization token.
+
+### `github-run-id`
+
+**Required** GitHub run id.
+
+### `github-run-attempt`
+
+**Required** GitHub run attempt.
+
+## Example usage
+
+```yaml
+- name: Cancel the run if workflow is cancelled
+  if: ${{ cancelled() }}
+  uses: currents-dev/cancel-run-action@v1
+  with:
+    bearer-token: ${{ secrets.CURRENTS_API_TOKEN }}
+    github-run-id: ${{ github.run_id }}
+    github-run-attempt: ${{ github.run_attempt }}
+
+```
+
+## Development
+
+The repository is made using [this](https://github.com/actions/typescript-action) template
 
 > First, you'll need to have a reasonably modern version of `node` handy. This won't work with versions older than 9, for instance.
 
@@ -40,15 +65,15 @@ $ npm test
 ...
 ```
 
-## Change action.yml
+### Change action.yml
 
 The action.yml defines the inputs and output for your action.
 
 Update the action.yml with your name, description, inputs and outputs for your action.
 
 See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)
 
-## Change the Code
+### Change the Code
 
 Most toolkit and CI/CD operations involve async operations so the action is run in an async function.
 
@@ -88,7 +113,7 @@ Your action is now published! :rocket:
 
 See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
 
-## Validate
+### Validate
 
 You can now validate the action by referencing `./` in a workflow in your repo (see [test.yml](.github/workflows/test.yml))
 
@@ -100,6 +125,6 @@ with:
 
 See the [actions tab](https://github.com/actions/typescript-action/actions) for runs of this action! :rocket:
 
-## Usage:
+### Usage:
 
 After testing you can [create a v1 tag](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) to reference the stable and latest V1 action

__tests__/main.test.ts

@@ -1,29 +1,168 @@
-import {wait} from '../src/wait'
-import * as process from 'process'
-import * as cp from 'child_process'
-import * as path from 'path'
-import {expect, test} from '@jest/globals'
-
-test('throws invalid number', async () => {
-  const input = parseInt('foo', 10)
-  await expect(wait(input)).rejects.toThrow('milliseconds not a number')
-})
+import {run, request} from '../src/main'
+import * as core from '@actions/core'
+import nock from 'nock'
+
+const currentsApiUrl = 'http://localhost:4000/v1'
+const currentsApiCancelationPath = '/runs/cancel-by-github-ci'
+const githubRunId = '45166321'
+const githubRunAttempt = '1'
+
+describe('input validation', () => {
+  test('currents-api-url is required', async () => {
+    const spy = jest.spyOn(core, 'setFailed')
+
+    await run()
+
+    expect(spy).toHaveBeenCalledWith(
+      'Input required and not supplied: currents-api-url'
+    )
+  })
+
+  test('bearer-token is required', async () => {
+    process.env['INPUT_CURRENTS-API-URL'] = currentsApiUrl
+
+    const spy = jest.spyOn(core, 'setFailed')
+
+    await run()
+
+    expect(spy).toHaveBeenCalledWith(
+      'Input required and not supplied: bearer-token'
+    )
+  })
 
-test('wait 500 ms', async () => {
-  const start = new Date()
-  await wait(500)
-  const end = new Date()
-  var delta = Math.abs(end.getTime() - start.getTime())
-  expect(delta).toBeGreaterThan(450)
+  test('github-run-id is required', async () => {
+    process.env['INPUT_CURRENTS-API-URL'] = currentsApiUrl
+    process.env['INPUT_BEARER-TOKEN'] = 'bearer-token'
+
+    const spy = jest.spyOn(core, 'setFailed')
+
+    await run()
+
+    expect(spy).toHaveBeenCalledWith(
+      'Input required and not supplied: github-run-id'
+    )
+  })
+
+  test('github-run-attempt is required', async () => {
+    process.env['INPUT_CURRENTS-API-URL'] = currentsApiUrl
+    process.env['INPUT_BEARER-TOKEN'] = 'bearer-token'
+    process.env['INPUT_GITHUB-RUN-ID'] = githubRunId
+
+    const spy = jest.spyOn(core, 'setFailed')
+
+    await run()
+
+    expect(spy).toHaveBeenCalledWith(
+      'Input required and not supplied: github-run-attempt'
+    )
+  })
 })
 
-// shows how the runner will run a javascript action with env / stdout protocol
-test('test runs', () => {
-  process.env['INPUT_MILLISECONDS'] = '500'
-  const np = process.execPath
-  const ip = path.join(__dirname, '..', 'lib', 'main.js')
-  const options: cp.ExecFileSyncOptions = {
-    env: process.env
-  }
-  console.log(cp.execFileSync(np, [ip], options).toString())
+describe('api request', () => {
+  beforeEach(() => {
+    process.env['INPUT_CURRENTS-API-URL'] = currentsApiUrl
+    process.env['INPUT_BEARER-TOKEN'] = 'bearer-token'
+    process.env['INPUT_GITHUB-RUN-ID'] = githubRunId
+    process.env['INPUT_GITHUB-RUN-ATTEMPT'] = githubRunAttempt
+  })
+
+  afterEach(() => {
+    delete process.env['INPUT_CURRENTS-API-URL']
+    delete process.env['INPUT_BEARER-TOKEN']
+    delete process.env['INPUT_GITHUB-RUN-ID']
+    delete process.env['INPUT_GITHUB-RUN-ATTEMPT']
+  })
+
+  test('should resolve when status code is not 200', () => {
+    const error = JSON.stringify({
+      error: 'Invalid params'
+    })
+    nock(currentsApiUrl).put(currentsApiCancelationPath).reply(400, error)
+    expect(
+      request({
+        url: `${currentsApiUrl}${currentsApiCancelationPath}`,
+        body: {
+          githubRunId,
+          githubRunAttempt
+        },
+        bearerToken: 'token'
+      })
+    ).rejects.toThrowError(error)
+  })
+
+  test('should fail when status code is 404', async () => {
+    nock(currentsApiUrl).put(currentsApiCancelationPath).reply(404, {})
+    const spy = jest.spyOn(core, 'setFailed')
+
+    await run()
+    expect(spy).toHaveBeenCalledWith('Resource not found')
+  })
+
+  test('should retry when status code is 500', async () => {
+    nock(currentsApiUrl).put(currentsApiCancelationPath).reply(500)
+    const spy = jest.spyOn(core, 'setFailed')
+
+    await run()
+    expect(spy).toBeCalled()
+  }, 15000)
+
+  test('should fail when the input is invalid', async () => {
+    process.env['INPUT_CURRENTS-API-URL'] = 'bad url'
+    const spy = jest.spyOn(core, 'setFailed')
+
+    await run()
+    expect(spy).toHaveBeenCalledWith(expect.any(String))
+  })
+
+  test('should return the result when status code is 200', () => {
+    const result = {
+      githubRunId,
+      githubRunAttempt,
+      status: 'OK',
+      actor: 'api',
+      canceledAt: new Date().toDateString(),
+      reason: 'api call'
+    }
+
+    nock(currentsApiUrl).put(currentsApiCancelationPath).reply(200, result)
+
+    expect(
+      request({
+        url: `${currentsApiUrl}${currentsApiCancelationPath}`,
+        body: {
+          githubRunId,
+          githubRunAttempt
+        },
+        bearerToken: 'token'
+      })
+    ).resolves.toEqual({
+      headers: {
+        'content-type': 'application/json'
+      },
+      result,
+      statusCode: 200
+    })
+  })
+
+  test('should show the result when debug is enabled', async () => {
+    const result = {
+      githubRunId,
+      githubRunAttempt,
+      status: 'OK',
+      actor: 'api',
+      canceledAt: new Date().toDateString(),
+      reason: 'api call'
+    }
+
+    const spy = jest.spyOn(core, 'debug')
+
+    // enable debug
+    process.env['RUNNER_DEBUG'] = '1'
+
+    nock(currentsApiUrl).put(currentsApiCancelationPath).reply(200, result)
+
+    await run()
+
+    expect(spy).toHaveBeenCalled()
+  })
 })

action.yml

@@ -1,11 +1,19 @@
-name: 'Your name here'
-description: 'Provide a description here'
-author: 'Your name or organization here'
+name: "cancel-currents-run"
+description: "Cancels Currents run via the API"
 inputs:
-  milliseconds: # change this
+  currents-api-url:
+    description: "Currents API URL"
+    required: false
+    default: "https://api.currents.dev/api/v1"
+  bearer-token:
+    description: "Bearer authentication token"
+    required: true
+  github-run-id:
+    description: "GitHub run id"
+    required: true
+  github-run-attempt:
+    description: "GitHub run attempt"
     required: true
-    description: 'input description here'
-    default: 'default value if applicable'
 runs:
-  using: 'node16'
-  main: 'dist/index.js'
+  using: "node16"
+  main: "dist/index.js"

babel.config.js

@@ -0,0 +1 @@
+module.exports = {presets: ['@babel/preset-env']}