universal-test-runner 0.3.0

Universal, language-aware unit test runner.

universal-test-runner

The universal test runner is a zero-configuration, language-aware way to run your unit tests.

If you're working on a JS project, it runs [your package manager here] test. You've run pytest in this folder before? pytest it is. Rust project? cargo test coming right up. Is also clever about running all your go module tests (regardless of how they're organized). No matter the command, all args are passed directly into the test runner.

Currently supports 7 languages (and their respective test frameworks). Please open an issue if I'm missing your favorite!

Installation

UTR is available on PyPi:

pipx install universal-test-runner

Design Philosophy

1. The runner itself should need no configuration - it Just Works
2. It should pass all arguments through to the underlying test command
3. It should have wide language and test runner support; please open an issue if your use case isn't supported!

Usage

Once installed, the command t will be available. Run that in a folder with tests and it'll do its best to run your unit tests:

% t
====================== test session starts ======================
platform darwin -- Python 3.11.0, pytest-7.3.1, pluggy-1.0.0
rootdir: /Users/david/projects/universal-test-runner
collected 37 items

tests/test_matchers.py .........................          [ 67%]
tests/test_runner.py ............                         [100%]

====================== 37 passed in 0.04s =======================

It passes all arguments and environment modifications down to the chosen test runner.

If it can't guess the testing method, it will tell you so. Feel free to open an issue to request wider language support!

Debugging

The package also ships a program to surface info about itself: universal-test-runner. It has a few key pieces of functionality:

• the universal-test-runner --version flag, which prints info about your installed package version
• the universal-test-runner debug command, which prints info about which matcher would run (and why)

Supported Languages

1. Python
   • uses pytest if you've run pytest before
   • looks for a tests.py file if not
2. Rust
   • cargo test
3. Go
   • if there's a X_test.go, then runs a plain go test
   • if you pass any args at all, runs go test your-args-here
   • otherwise, runs go test ./...
4. Elixir
   • runs mix test
5. Clojure
   • runs lein test
6. Makefile
   • looks for a line that starts with test:
7. JS/TS
   • if there's a package.json and it has a test script, runs [package manager] test, where [package manager] is:
     • npm if there's a package-lock.json
     • yarn if there's a yarn.lock
     • pnpm if there's a pnpm-lock.yaml

Motivation

I work in a few languages at a time, so I've actually had a version of this in my dotfiles for a while. Also, as I've been doing Exercism's #12in23 program, I'm really switching languages. It's nice not to have to re-learn any muscle memory. Plus, increasingly complex bash was holding me back.

Development

This section is people making changes to this package.

When in a virtual environment, run the following:

pip install -e '.[test]'

This installs the package in --edit mode and makes its dependencies available. You can now run reddit-user-to-sqlite to invoke the CLI.

Running Tests

In your virtual environment, a simple pytest should run the unit test suite. You can also run pyright for type checking.

Releasing New Versions

these notes are mostly for myself (or other contributors)

0. ensure tests pass (pytest)
1. install release tooling (pip install -e '.[release]')
2. build the package (python -m build)
3. upload the release (python -m twine upload dist/*)
   1. give your username as __token__
   2. give your password as your stored API key
   3. If you're getting invalid password, verify that ~/.pypirc is empty