Skip to content

Performs different types of assertions for use in an Action workflow. This is intended to be used to validate outputs and helpful in writing integration tests of Actions.

License

Notifications You must be signed in to change notification settings

belav/assert-action

 
 

Repository files navigation

Assert Action

Various assertions to aide in validating action outputs


Inputs

expected

Required Expected value

actual

Required Actual value

comparison

Optional Type of comparison to perform. Supports exact (default), startsWith, endsWith, contains, notEqual, notStartsWith, notEndsWith, notContains


Outputs

result

Result of the comparison. Can be either passed or failed


Examples

Example usage w/ exact (using default comparison) assertion

- id: test-data
  run: echo "::set-output name=value::testing"
- uses: nick-invision@assert-action@v1
  with:
    expected: testing
    actual: ${{ steps.test-data.outputs.value }}

Example usage w/ exact assertion

- id: test-data
  run: echo "::set-output name=value::testing"
- uses: nick-invision@assert-action@v1
  with:
    expected: testing
    actual: ${{ steps.test-data.outputs.value }}
    comparison: exact

Example usage w/ startsWith assertion

- id: test-data
  run: echo "::set-output name=value::testing"
- uses: nick-invision@assert-action@v1
  with:
    expected: test
    actual: ${{ steps.test-data.outputs.value }}
    comparison: startsWith

Example usage w/ notStartsWith assertion

- id: test-data
  run: echo "::set-output name=value::testing"
- uses: nick-invision@assert-action@v1
  with:
    expected: abc
    actual: ${{ steps.test-data.outputs.value }}
    comparison: notStartsWith

Example usage w/ endsWith assertion

- id: test-data
  run: echo "::set-output name=value::testing"
- uses: nick-invision@assert-action@v1
  with:
    expected: ing
    actual: ${{ steps.test-data.outputs.value }}
    comparison: endsWith

Example usage w/ notEndsWith assertion

- id: test-data
  run: echo "::set-output name=value::testing"
- uses: nick-invision@assert-action@v1
  with:
    expected: abc
    actual: ${{ steps.test-data.outputs.value }}
    comparison: notEndsWith

Example usage w/ contains assertion

- id: test-data
  run: echo "::set-output name=value::testing"
- uses: nick-invision@assert-action@v1
  with:
    expected: est
    actual: ${{ steps.test-data.outputs.value }}
    comparison: endsWith

Example usage w/ notContains assertion

- id: test-data
  run: echo "::set-output name=value::testing"
- uses: nick-invision@assert-action@v1
  with:
    expected: est
    actual: ${{ steps.test-data.outputs.value }}
    comparison: notEndsWith

Example usage w/ notEqual assertion

- id: test-data
  run: echo "::set-output name=value::testing"
- uses: nick-invision@assert-action@v1
  with:
    expected: abc
    actual: ${{ steps.test-data.outputs.value }}
    comparison: notEqual

Limitations

  • If running on self-hosted runner, NodeJS must be installed.

About

Performs different types of assertions for use in an Action workflow. This is intended to be used to validate outputs and helpful in writing integration tests of Actions.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%