### ----------------------------------------------------
### -- Test::Async
### -- Licenses: Artistic-2.0
### -- Authors: Vadim Belman <vrurg@cpan.org>
### -- File: README.md
### ----------------------------------------------------
# NAME

`Test::Async` - asynchronous, thread-sage testing

# SYNOPSYS

``` raku
use Test::Async;

plan 2, :parallel;

subtest "Async 1" => {
    plan 1;
    pass "a test"
}

subtest "Async 2" => {
    plan 1;
    pass "another test"
}
```

# DESCRIPTION

`Test::Async` provides a framework and a base set of tests tools compatible with the standard Raku `Test` module. But contrary to the standard, `Test::Async` has been developed with two primary goals in mind: concurrency and extensibility.

Here is the key features provided:

  - event-driven, threaded, and OO core

  - easy development of 3rd party test bundles

  - asynchronous and/or random execution of subtests

  - support of threaded user code

The SYNOPSYS section provides an example where two subtests would be started in parallel, each in its own thread. This allows to achieve two goals: speed up big test suits by splitting them in smaller chunks; and testing for possible concurrency problems in tested code.

With

``` 
plan $count, :random;
```

subtests will be executed in random order. In this mode it is possible to catch another class of errors caused by code being dependent on the order execution.

It is also possible to combine both *parallel* and *random* modes of operation.

# WAY MORE IN

  - [`Test::Async::Manual`](docs/md/Test/Async/Manual.md)

  - [`Test::Async::CookBook`](docs/md/Test/Async/CookBook.md)

  - [`Test::Async`](docs/md/Test/Async.md)

  - [`Test::Async::Base`](docs/md/Test/Async/Base.md)

  - [`ChangeLog`](ChangeLog.md)

  - [`INDEX`](INDEX.md)

# COPYRIGHT

(c) 2023, Vadim Belman <vrurg@cpan.org>

# LICENSE

Artistic License 2.0

See the [*LICENSE*](LICENSE) file in this distribution.


