@exercism/typescript-test-runner

Exercism TypeScript Test Runner

The Docker image for automatically run tests on TypeScript solutions submitted to exercism.

At this moment, the input path must be relative to the package.json of this respository. jest doesn't like running outside of its tree. This might change in the future.

Installation

Clone this repository and then run:

yarn install

You'll need at least Node LTS for this to work.

yarn build

Usage

If you're developing this, you can run this via yarn or the provided shell script.

• .sh enabled systems (UNIX, WSL): yarn execute:dev
• .bat fallback (cmd.exe, Git Bash for Windows): unsupported

You'll want these :dev variants because it will build the required code (it will transpile from TypeScript to JavaScript, which is necessary to run this in Node environments, unlike Deno environments). When on Windows, if you're using Git Bash for Windows or a similar terminal, the .sh files will work, but will open a new window (which closes after execution). The .bat scripts will work in the same terminal. In this case it might be much easier to run bin/run.sh directly, so a new shell won't open.

You can also manually build using yarn or yarn build, and then run the script directly: ./bin/run.sh arg1 arg2 arg3.

Running the Solution's Tests

To run a solution's tests, do the following:

1. Open terminal in project's root
2. Run ./bin/run.sh <exercise-slug> <path-to-solution-folder> [<path-to-output-folder>]

For example:

$ ./bin/run.sh two-fer ./test/fixtures/two-fer/pass

PASS  test/fixtures/two-fer/pass/two-fer.spec.js
Test Suites: 1 passed, 1 total
Tests:       3 passed, 3 total
Snapshots:   0 total
Time:        2.817s
Find the output at:
test/fixtures/two-fer/pass/results.json

Running the Tests of a Remote Solution

Instead of passing in an <exercises-slug> and <path-to-solution-folder>, you can also directly pass in an https://exercism.io url, as long as you have the exercism CLI installed.

You can pass the following type of URLs:

• Published solutions: /tracks/typescript/exercises/<slug>/<id>
• Mentor solutions: /mentor/solutions/<id>
• Your solutions: /my/solutions/<id>
• Private solutions: /solutions/<id>

For example:

$ ./bin/run.sh https://exercism.io/my/solutions/c3b826d95cb54441a8f354d7663e9e16
Exercism remote UUID: c3b826d95cb54441a8f354d7663e9e16

Downloaded to
C:\Users\Derk-Jan\Exercism\typescript\clock
PASS  tmp/clock/c3b826d95cb54441a8f354d7663e9e16/clock/clock.spec.js
Test Suites: 1 passed, 1 total
Tests:       52 passed, 52 total
Snapshots:   0 total
Time:        2.987s
Find the output at:
./tmp/clock/c3b826d95cb54441a8f354d7663e9e16/clock/results.json

As you can see, it will be copied to a local directory. It's up to you to clean-up this directory.

Running the Solution's Tests in Docker container

This script is provided for testing purposes

To run a solution's test in the Docker container, do the following:

1. Open terminal in project's root
2. Run ./run-in-docker.sh <exercise-slug> <relative-path-to-solution-folder>

Maintaining

The package.json needs to be in-sync with the typescript exercise package.json.

Testing

Running the tests of the test-runner itself can be achieved by using the test script from package.json. The tests delegate to the build output, which is why yarn test first calls yarn build before running jest. The tests take over a minute to run on a decent machine.

Changelog

3.0.0

• Rewritten for jest 17