View Source mix test.interactive (mix test.interactive v4.0.0)
Interactive test runner for ExUnit tests.
mix test.interactive
allows you to easily switch between running all tests,
stale tests, or failed tests. Or, you can run only the tests whose filenames
contain a substring. Includes an optional "watch mode" which runs tests after
every file change.
Usage
mix test.interactive <options> [-- <mix test arguments>]
mix test.interactive <mix test arguments>
mix test.interactive --help
mix test.interactive --version
Your tests will run immediately (and every time a file changes).
Options
mix test.interactive
understands the following options, most of which
correspond to configuration settings below.
Note that, if you want to pass both mix test.interactive options and mix test
arguments, you must separate them with --
.
If an option is provided on the command line, it will override the same option specified in the configuration.
--(no-)clear
: Clear the console before each run (defaultfalse
).--command <command> [--arg <arg>]
: Custom command and arguments for running tests (default: "mix" with no arguments). NOTE: Use--arg
multiple times to specify more than one argument.--exclude <regex>
: Exclude files/directories from triggering test runs (default:["~r/.#/", "~r{priv/repo/migrations}"
]) NOTE: Use--exclude
multiple times to specify more than one regex.--extra-extensions <extension>
: Watch files with additional extensions (default: []).--runner <module name>
: Use a custom runner module (default:MixTestInteractive.PortRunner
).--task <task name>
: Run a different mix task (default:"test"
).--(no-)timestamp
: Display the current time before running the tests (default:false
).--(no-)watch
: Don't run tests when a file changes (default:true
).
All of the <mix test arguments>
are passed through to mix test
on every
test run.
mix test.interactive
will detect the --stale
and --failed
flags and use
those as initial settings in interactive mode. You can then toggle those flags
on and off as needed.
Patterns and filenames
mix test.interactive
can take the same filename or filename:line_number
patterns that mix test
understands. It also allows you to specify one or
more "patterns" - strings that match one or more test files. When you provide
one or more patterns on the command-line, mix test.interactive
will find all
test files matching those patterns and pass them to mix test
as if you had
used the p
command (described below).
Interactive Commands
After the tests run, you can use the interactive mode to change which tests will run.
a
: Run all tests.f
: Run only tests that failed on the last run (equivalent to the--failed
option ofmix test
).p
: Run only test files that match one or more provided patterns. A pattern is the project-root-relative path to a test file (with or without a line number specification) or a string that matches a portion of full pathname. e.g.test/my_project/my_test.exs
,test/my_project/my_test.exs:12:24
ormy
.q
: Exit the program. (Can also useCtrl-D
.)s
: Run only test files that reference modules that have changed since the last run (equivalent to the--stale
option ofmix test
).w
: Turn file-watching mode on or off.Enter
: Re-run the current set of tests without requiring a file change.
Configuration
If your project has a config/config.exs
file, you can customize the
operation of mix test.interactive
with the following settings:
clear: true
: Clear the console before each run (default:false
).command: <program>
orcommand: {<program>, [<arg>, ...]}
: Use the provided command and arguments to run the test task (default:mix
).exclude: [patterns...]
: A list ofRegex
es to ignore when watching for changes (default:[~r/.#/, ~r{priv/repo/migrations}]
).extra_extensions: [<ext>...]
: Additional filename extensions to include when watching for file changes (default:[]
).runner: <module>
: A custom runner for running the tests (default:MixTestInteractive.PortRunner
).task: <task name>
: The mix task to use when running tests (default:"test"
).timestamp: true
: Print current time (UTC) before running tests (default: false).
Summary
Functions
Callback implementation for Mix.Task.run/1
.
Functions
Callback implementation for Mix.Task.run/1
.