Skip to main content

Foresight Test Kit Action

A GitHub Action to analyze test and/or coverage results. Foresight’s Test Kit action integrates with your Github Actions pipelines.

  • It makes simple to see failed tests, visualize performance of your tests and see their logs. It is the fastest way to access a failed test results in your workflow runs.
  • It correlates the changes to the codebase with the test coverage reports to determine how much of the changes are covered by the tests.

You need to integrate Test Kit action to your CI pipeline in order to use Test Monitoring and Change Impact Analysis features.

info

You'll need to have a reasonably modern version of node. This won't work with versions older than 9, for instance.

Prerequisites

Foresight analyzes your test and coverage report artifacts.

Available test framework and report pairs:

Test frameworkReport format
TESTNGn/a*
JUNITn/a*
JESTJUNIT
PYTESTJUNIT
XUNIT2n/a*
XUNIT2TRX
GOLANGJSON
GOLANGTEXT
info

You don't need to fill report format fields marked as n/a.

Available coverage formats:

Coverage formats
JACOCO/XML
COBERTURA/XML
GOLANG
LCOV/TXT

Usage

To use the action, add the following step after your test execution step. Please fill the test_format, test_framework and coverage_format fields by checking the supported options above.

You can get your api_key after sign up to Foresight.

- name: Analyze Test and/or Coverage Results
uses: runforesight/foresight-test-kit-action@v1
if: success() || failure()
with:
api_key: <your_api_key_required>
test_format: <test_format>
test_framework: <test_framework>
test_path: <test_results_path>
coverage_format: <coverage_format>
coverage_path: <coverage_results_path>
Get your API key
Learn how to get your API Key

Configuration

OptionRequirementDescription
api_keyRequiredForesight Api Key.
github_tokenOptionalAn alternative GitHub token, other than the default provided by GitHub Actions runner.
test_frameworkOptionalRuntime test framework name(jest, pytest, junit etc.)
test_formatOptionalRuntime test format name(trx, junit etc.)
test_pathOptionalTest results directory/file path.
coverage_formatOptionalRuntime coverage format name(jacoco/xml, cobertura/xml, golang etc.)
coverage_pathOptionalCoverage results directory/file path.
cli_versionOptionalInstalled Foresight cli version. Default is latest.
disable_actionOptionalDisable Foresight test kit action without removing from yml.