Test Reference

plan 15;   # expect to run 15 tests

Not executed: the documentation states no expected output for this example.

plan :skip-all<These tests are only for Windows> unless $*DISTRO.is-win;
plan 1;
ok dir 'C:/'; # this won't get run on non-Windows

Not executed: the documentation states no expected output for this example.

plan 2;
subtest "Some Windows tests" => sub { # <-- note the `sub`; can't use bare block
plan :skip-all<We aren't on Windows> unless $*DISTRO.is-win;
plan 1;
ok dir 'C:/'; # this won't get run on non-Windows
}
ok 42; # this will run everywhere and isn't affected by skip-all inside subtest

Not executed: the documentation states no expected output for this example.

sub do-stuff {@};
use Test;
ok .is-prime for do-stuff;
done-testing;
# output:
1..0

Not executed: the documentation states no expected output for this example.

sub do-stuff {@};
use Test;
plan 1;
ok .is-prime for do-stuff;
# output:
1..1
# Looks like you planned 1 test, but ran 0

Not executed: the documentation states no expected output for this example.

my $response; my $query; ...;
ok $response.success, 'HTTP response was successful';

Not executed: the documentation states no expected output for this example.

sub factorial($x) { ... };
ok factorial(6) == 720, 'Factorial - small integer';

Not executed: the documentation states no expected output for this example.

my $response; my $query; ...;
nok $query.error, 'Query completed without error';

Not executed: the documentation states no expected output for this example.

my $pdf-document; sub factorial($x) { ... }; ...;
is $pdf-document.author, "Joe", 'Retrieving the author field';
is factorial(6),         720,   'Factorial - small integer';
my Int $a;
is $a, Int, 'The variable $a is an unassigned Int';

Not executed: the documentation states no expected output for this example.

is "foo\tbar", "foo\tbaz";   # expected: 'foo     baz'␤#      got: 'foo   bar'
is "foo\tbar", "foo    bar"; # expected: "foo    bar"␤#      got: "foo\tbar"

Not executed: the documentation states no expected output for this example.

isnt pi, 3, 'The constant π is not equal to 3';
my Int $a = 23;
$a = Nil;
isnt $a, Nil, 'Nil should not survive being put in a container';

Not executed: the documentation states no expected output for this example.

multi is-approx(Numeric $got, Numeric $expected, Numeric $abs-tol,
                $desc = '')

Not executed: the documentation states no expected output for this example.

multi is-approx(Numeric $got, Numeric $expected, $desc = '',
                Numeric :$rel-tol is required)

Not executed: the documentation states no expected output for this example.

multi is-approx(Numeric $got, Numeric $expected, $desc = '',
                Numeric :$abs-tol is required)

Not executed: the documentation states no expected output for this example.

multi is-approx(Numeric $got, Numeric $expected, $desc = '',
                Numeric :$rel-tol is required,
                Numeric :$abs-tol is required)

Not executed: the documentation states no expected output for this example.

my Numeric ($value, $expected, $abs-tol, $rel-tol) = ...

is-approx $value, $expected;
is-approx $value, $expected, 'test description';

is-approx $value, $expected, $abs-tol;
is-approx $value, $expected, $abs-tol, 'test description';

is-approx $value, $expected, :$rel-tol;
is-approx $value, $expected, :$rel-tol, 'test description';

is-approx $value, $expected, :$abs-tol;
is-approx $value, $expected, :$abs-tol, 'test description';

is-approx $value, $expected, :$abs-tol, :$rel-tol;
is-approx $value, $expected, :$abs-tol, :$rel-tol, 'test description';

Not executed: the documentation states no expected output for this example.

is-approx 3, 4, 2; # success
is-approx 3, 6, 2; # fail

is-approx 300, 302, 2; # success
is-approx 300, 400, 2; # fail
is-approx 300, 600, 2; # fail

Not executed: the documentation states no expected output for this example.

is-approx 10, 10.5, :rel-tol<0.1>; # success
is-approx 10, 11.5, :rel-tol<0.1>; # fail

is-approx 100, 105, :rel-tol<0.1>; # success
is-approx 100, 115, :rel-tol<0.1>; # fail

Not executed: the documentation states no expected output for this example.

          |value - expected|
⁣rel-diff = ────────────────────────
       max(|value|, |expected|)

Not executed: the documentation states no expected output for this example.

is-approx $value, $expected, :rel-tol<.5>, :abs-tol<10>;

Not executed: the documentation states no expected output for this example.

                    $rel-tol where { !.defined or $_ >= 0 }, $desc)

Not executed: the documentation states no expected output for this example.

use Test;
plan 1;

sub string-info(Str() $_) {
Map.new: (
  length  =>  .chars,
  char-counts => Bag.new-from-pairs: (
      letters => +.comb(/<:letter>/),
      digits  => +.comb(/<:digit>/),
      other   => +.comb(/<.-:letter-:digit>/),
))
}

is-deeply string-info('42 Butterflies ♥ Raku'), Map.new((
:21length,
char-counts => Bag.new-from-pairs: ( :15letters, :2digits, :4other, )
)), 'string-info gives right info';

Not executed: the documentation states no expected output for this example.

cmp-ok 'my spelling is apperling', '~~', /perl/, "bad speller";

Not executed: the documentation states no expected output for this example.

cmp-ok <a b c>, &[!eqv], <b d e>, 'not equal';

Not executed: the documentation states no expected output for this example.

sub my-comp { $^a / $^b  < rand };
cmp-ok 1, &my-comp, 2, 'the dice giveth and the dice taketh away'
cmp-ok 2, -> $a, $b { $a.is-prime and $b.is-prime and $a < $b }, 7,
'we got primes, one larger than the other!';

Not executed: the documentation states no expected output for this example.

class Womble {}
class GreatUncleBulgaria is Womble {}
my $womble = GreatUncleBulgaria.new;

isa-ok $womble, Womble, "Great Uncle Bulgaria is a womble";
isa-ok $womble, 'Womble';     # equivalent

Not executed: the documentation states no expected output for this example.

say 42.isa(Numeric); # OUTPUT: «False␤»
isa-ok 42, Numeric;  # OUTPUT: «ok 1 - The object is-a 'Numeric'␤»

False
ok 1 - The object is-a 'Numeric'

Documentation, Rakudo and Raku++ all agree.

class Womble {
method collect-rubbish { ... }
}
my $womble = Womble.new;

# with automatically generated test description
can-ok $womble, 'collect-rubbish';
#  => An object of type 'Womble' can do the method 'collect-rubbish'

# with human-generated test description
can-ok $womble, 'collect-rubbish', "Wombles can collect rubbish";
#  => Wombles can collect rubbish

Not executed: the documentation states no expected output for this example.

# create a Womble who can invent
role Invent {
method brainstorm { say "Aha!" }
}
class Womble {}
class Tobermory is Womble does Invent {}

# ... and later in the tests
use Test;

my $tobermory = Tobermory.new;

# with automatically generated test description
does-ok $tobermory, Invent;
#  => The object does role Type

does-ok $tobermory, Invent, "Tobermory can invent";
#  => Tobermory can invent

Not executed: the documentation states no expected output for this example.

like 'foo', /fo/, 'foo looks like fo';

Not executed: the documentation states no expected output for this example.

unlike 'foo', /bar/, 'foo does not look like bar';

Not executed: the documentation states no expected output for this example.

use-ok 'Full::Qualified::ModuleName';

Not executed: the documentation states no expected output for this example.

use-ok 'Full::Qualified::ModuleName :my-argument';

Not executed: the documentation states no expected output for this example.

sub saruman(Bool :$ents-destroy-isengard) {
die "Killed by Wormtongue" if $ents-destroy-isengard;
}

dies-ok { saruman(ents-destroy-isengard => True) }, "Saruman dies";

Not executed: the documentation states no expected output for this example.

sub frodo(Bool :$destroys-ring) {
die "Oops, that wasn't supposed to happen" unless $destroys-ring;
}

lives-ok { frodo(destroys-ring => True) }, "Frodo survives";

Not executed: the documentation states no expected output for this example.

eval-dies-ok q[my $joffrey = "nasty";
           die "bye bye Ned" if $joffrey ~~ /nasty/],
"Ned Stark dies";

Not executed: the documentation states no expected output for this example.

eval-lives-ok q[my $daenerys-burns = False;
            die "Oops, Khaleesi now ashes" if $daenerys-burns],
"Dany is blood of the dragon";

Not executed: the documentation states no expected output for this example.

exits-ok({ say 3; exit 4}, 4, "exited with the right code") # passes

Not executed: the documentation states no expected output for this example.

sub frodo(Bool :$destroys-ring) {
fail "Oops. Frodo dies" unless $destroys-ring
};
throws-like { frodo }, Exception, message => /dies/;

Not executed: the documentation states no expected output for this example.

sub fails-not-throws { +"a" }
# test passes, even though it's just a Failure and would not always throw:
throws-like { fails-not-throws }, Exception;

# test detects nothing thrown, because our Failure wasn't sunk or made fatal:
throws-like { no fatal; my $ = fails-not-throws; Nil }, Exception;

Not executed: the documentation states no expected output for this example.

throws-like { EVAL q[ fac("foo") ] }, X::TypeCheck::Argument;

Not executed: the documentation states no expected output for this example.

fails-like { +"a" }, X::Str::Numeric,
:message(/'Cannot convert string to number'/),
'converting non-numeric string to number fails';

Not executed: the documentation states no expected output for this example.

class Womble {}

class GreatUncleBulgaria is Womble {
has $.location = "Wimbledon Common";
has $.spectacles = True;
}

subtest {
my $womble = GreatUncleBulgaria.new;

isa-ok $womble,            Womble,             "Correct type";
is     $womble.location,   "Wimbledon Common", "Correct location";
ok     $womble.spectacles,                     "Correct eyewear";

}, "Check Great Uncle Bulgaria";

Not executed: the documentation states no expected output for this example.

subtest 'A bunch of tests', {
plan 42;
...
...
}

subtest {
plan 72;
...
...
} => 'Another bunch of tests';

Not executed: the documentation states no expected output for this example.

sub my-custom-pi { 3 };

todo 'not yet precise enough';         # Mark the test as TODO.
is my-custom-pi(), pi, 'my-custom-pi'; # Run the test, but don't report
                                   # failure in test harness.

Not executed: the documentation states no expected output for this example.

not ok 1 - my-custom-pi # TODO not yet precise enough
# Failed test 'my-custom-pi'
# at test-todo.rakutest line 7
# expected: '3.14159265358979'
#      got: '3'

Not executed: the documentation states no expected output for this example.

sub num-forward-slashes($arg) { ... } ;

if $*KERNEL ~~ 'linux' {
is num-forward-slashes("/a/b"),             2;
is num-forward-slashes("/a//b".IO.cleanup), 2;
}
else {
skip "Can't use forward slashes on Windows", 2;
}

Not executed: the documentation states no expected output for this example.

my $location; sub womble { ... }; ...;
unless $location ~~ "Wimbledon Common" {
skip-rest "We can't womble, the remaining tests will fail";
exit;
}

# tests requiring functional wombling
ok womble();
# ...

Not executed: the documentation states no expected output for this example.

my $has-db-connection;
...
$has-db-connection  or bail-out 'Must have database connection for testing';

Not executed: the documentation states no expected output for this example.

pass "Actually, this test has passed";
flunk "But this one hasn't passed";

Not executed: the documentation states no expected output for this example.

diag "Yay!  The tests got to here!";

Not executed: the documentation states no expected output for this example.