GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  TEST::MINI::ASSERTIONS (3)

.ds Aq ’

NAME

Test::Mini::Assertions - Basic Assertions for Test::Mini

CONTENTS

METHODS

    Exported Functions

<B>assertB>


    assert($test, $msg)



Asserts that $test is truthy, and throws a Test::Mini::Exception::Assert if that assertion fails.

Examples:



    assert 1;
   
    assert true, Truth should shine clear;



Parameters:
o <B>B>$test<B>B> — The value to test.
o (String) <B>B>$msg<B>B> — An optional description.

<B>assert_blockB>


    assert_block($block, $msg)


    Deprecated. This assertion offers little advantage over the base L<<<<
    S<<<<< #assert >>>>>|Test::Mini::Assertions/assert >>>>. This will be
    removed in v2.0.0.



Asserts that the given code reference returns a truthy value.

Examples:



    assert_block { true };
   
    assert_block \&some_sub, expected better from &some_sub;



Parameters:
o (CODE) <B>B>$block<B>B> — The code reference to test.
o (String) <B>B>$msg<B>B> — An optional description.

<B>assert_canB>
Aliased as: assert_responds_to


    assert_can($obj, $method, $msg)



Verifies that the given $obj is capable of responding to the given $method name.

Examples:



    assert_can $date, day_of_week;
   
    assert_can $time, seconds, $time cannot respond to #seconds;



Parameters:
o <B>B>$obj<B>B> — The object being tested.
o (String) <B>B>$method<B>B> — The method name being checked for.
o (String) <B>B>$msg<B>B> — An optional description.

<B>assert_containsB>
Aliased as: assert_includes


    assert_contains($collection, $obj, $msg)



Verifies that the given $collection contains the given $obj as a member.

Examples:



    assert_contains [qw/ 1 2 3 /], 2;
   
    assert_contains { a => b }, a;  # b also contained
   
    assert_contains expectorate, xp;
   
    assert_contains Collection->new(1, 2, 3), 2;  # if Collection->contains(2)



Parameters:
o (Array|Hash|String|#contains) <B>B>$collection<B>B> — The collection to test.
o <B>B>$obj<B>B> — The needle to find.
o (String) <B>B>$msg<B>B> — An optional description.

<B>assert_definedB>
Aliased as: refute_undef


    assert_defined($obj, $msg)



Validates that the given $obj is defined.

Examples:



    assert_defined $value;  # if defined $value



Parameters:
o <B>B>$obj<B>B> — The value to check.
o (String) <B>B>$msg<B>B> — An optional description.

<B>assert_diesB>


    assert_dies($sub, $error, $msg)



Tests that the supplied code block dies, and fails if it succeeds. If $error is provided, the error message in $@ must contain it.

Examples:



    assert_dies { die LAGHLAGHLAGHL };
   
    assert_dies { die Failure on line 27 in Foo.pm } line 27;



Parameters:
o (CODE) <B>B>$sub<B>B> — The code that should die.
o (String) <B>B>$error<B>B> — The (optional) error substring expected.
o (String) <B>B>$msg<B>B> — An optional description.

<B>assert_emptyB>


    assert_empty($collection, $msg)



Verifies the emptiness of a collection.

Examples:



    assert_empty [];
   
    assert_empty {};
   
    assert_empty ;
   
    assert_empty Collection->new();  # if Collection->new()->is_empty()



Parameters:
o (Array|Hash|String|#is_empty) <B>B>$collection<B>B> — The collection under scrutiny.
o (String) <B>B>$msg<B>B> — An optional description.

<B>assert_equalB>
Aliased as: assert_eq


    assert_equal($actual, $expected, $msg)



Checks two given arguments for equality.

Examples:



    assert_equal 3.000, 3;
   
    assert_equal lc(FOO), foo;
   
    assert_equal [qw/ 1 2 3 /], [ 1, 2, 3 ];
   
    assert_equal { a => eh }, { a => eh };
   
    assert_equal Class->new(), $expected;  # if $expected->equals(Class->new())



Parameters:
o <B>B>$actual<B>B> — The value under test.
o <B>B>$expected<B>B> — The expected value.
o (String) <B>B>$msg<B>B> — An optional description.

<B>assert_in_deltaB>


    assert_in_delta($actual, $expected, $delta, $msg)



Checks that the difference between $actual and $expected is less than $delta.

Examples:



    assert_in_delta 1.001, 1;
   
    assert_in_delta 104, 100, 5;



Parameters:
o (Number) <B>B>$actual<B>B> — The tested value.
o (Number) <B>B>$expected<B>B> — The static value.
o (Number) <B>B>$delta<B>B> — The expected delta. Defaults to 0.001.
o (String) <B>B>$msg<B>B> — An optional description.

<B>assert_in_epsilonB>


    assert_in_epsilon($actual, $expected, $epsilon, $msg)



Checks that the difference between $actual and $expected is less than a given fraction of the smaller of the two numbers.

Examples:



    assert_in_epsilon 22.0 / 7.0, Math::Trig::pi;
   
    assert_in_epsilon 220, 200, 0.10



Parameters:
o (Number) <B>B>$actual<B>B> — The tested value.
o (Number) <B>B>$expected<B>B> — The static value.
o (Number) <B>B>$epsilon<B>B> — The expected tolerance factor. Defaults to 0.001.
o (String) <B>B>$msg<B>B> — An optional description.

<B>assert_instance_ofB>


    assert_instance_of($obj, $type, $msg)



Validates that the given object is an instance of $type.

Examples:



    assert_instance_of MyApp::Person->new(), MyApp::Person;



Parameters:
o <B>B>$obj<B>B> — The instance to check.
o (Class) <B>B>$type<B>B> — The type to expect.
o (String) <B>B>$msg<B>B> — An optional description.

See Also:
o #assert_is_a

<B>assert_is_aB>
Aliased as: assert_isa


    assert_is_a($obj, $type, $msg)



Validates that $obj inherits from $type.

Examples:



    assert_is_a Employee, Employee;
   
    assert_is_a Employee->new(), Employee;
   
    assert_is_a Employee, Person; # assuming Employee->isa(Person)
   
    assert_is_a Employee->new(), Person;



Parameters:
o <B>B>$obj<B>B> — The instance or class to check.
o (Class) <B>B>$type<B>B> — The expected superclass.
o (String) <B>B>$msg<B>B> — An optional description.

<B>assert_matchB>


    assert_match($string, $pattern, $msg)



Validates that the given $string matches the given $pattern.

Examples:



    assert_match Four score and seven years ago..., qr/score/;



Parameters:
o (String) <B>B>$string<B>B> — The string to match.
o (Regex) <B>B>$pattern<B>B> — The regular expression to match against.
o (String) <B>B>$msg<B>B> — An optional description.

<B>assert_undefB>
Aliased as: refute_defined


    assert_undef($obj, $msg)



Validates that the given $obj is undefined.

Examples:



    assert_undef $value;  # if not defined $value



Parameters:
o <B>B>$obj<B>B> — The value to check.
o (String) <B>B>$msg<B>B> — An optional description.

<B>flunkB>


    flunk($msg)



Causes the current test to exit immediately with a failing status.

Parameters:
o (String) <B>B>$msg<B>B> — An optional description.

<B>refuteB>


    refute($test, $msg)



Asserts that $test is falsey, and throws a Test::Mini::Exception::Assert if that assertion fails.

Examples:



    refute 0;
   
    refute undef, Deny the untruths;



Parameters:
o <B>B>$test<B>B> — The value to test.
o (String) <B>B>$msg<B>B> — An optional description.

<B>refute_blockB>


    refute_block($block, $msg)


    Deprecated. This assertion offers little advantage over the base L<<<<
    S<<<<< #refute >>>>>|Test::Mini::Assertions/refute >>>>. This will be
    removed in v2.0.0.



Asserts that the given code reference returns a falsey value.

Examples:



    refute_block {  };
   
    refute_block \&some_sub, expected worse from &some_sub;



Parameters:
o (CODE) <B>B>$block<B>B> — The code reference to test.
o (String) <B>B>$msg<B>B> — An optional description.

<B>refute_canB>
Aliased as: refute_responds_to


    refute_can($obj, $method, $msg)



Verifies that the given $obj is <B>notB> capable of responding to the given $method name.

Examples:



    refute_can $date, to_time;
   
    refute_can $time, day, $time cannot respond to #day;



Parameters:
o <B>B>$obj<B>B> — The object being tested.
o (String) <B>B>$method<B>B> — The method name being checked.
o (String) <B>B>$msg<B>B> — An optional description.

<B>refute_containsB>


    refute_contains($collection, $obj, $msg)



Verifies that the given $collection does not contain the given $obj as a member.

Examples:



    refute_contains [qw/ 1 2 3 /], 5;
   
    refute_contains { a => b }, x;
   
    refute_contains expectorate, spec;
   
    refute_contains Collection->new(1, 2, 3), 5;  # unless Collection->contains(5)



Parameters:
o (Array|Hash|String|#contains) <B>B>$collection<B>B> — The collection to test.
o <B>B>$obj<B>B> — The needle to look for.
o (String) <B>B>$msg<B>B> — An optional description.

<B>refute_emptyB>


    refute_empty($collection, $msg)



Verifies the non-emptiness of a collection.

Examples:



    refute_empty [ 1 ];
   
    refute_empty { a => 1 };
   
    refute_empty full;
   
    refute_empty Collection->new();  # unless Collection->new()->is_empty()



Parameters:
o (Array|Hash|String|#is_empty) <B>B>$collection<B>B> — The collection under scrutiny.
o (String) <B>B>$msg<B>B> — An optional description.

<B>refute_equalB>
Aliased as: refute_eq


    refute_equal($actual, $unexpected, $msg)



Checks two given arguments for inequality.

Examples:



    refute_equal 3.001, 3;
   
    refute_equal lc(FOOL), foo;
   
    refute_equal [qw/ 1 23 /], [ 1, 2, 3 ];
   
    refute_equal { a => ae }, { a => eh };
   
    refute_equal Class->new(), $expected;  # unless $expected->equals(Class->new())



Parameters:
o <B>B>$actual<B>B> — The value under test.
o <B>B>$expected<B>B> — The tested value.
o (String) <B>B>$msg<B>B> — An optional description.

<B>refute_in_deltaB>


    refute_in_delta($actual, $expected, $delta, $msg)



Checks that the difference between $actual and $expected is greater than $delta.

Examples:



    refute_in_delta 1.002, 1;
   
    refute_in_delta 106, 100, 5;



Parameters:
o (Number) <B>B>$actual<B>B> — The tested value.
o (Number) <B>B>$expected<B>B> — The static value.
o (Number) <B>B>$delta<B>B> — The delta $actual and $expected are expected to differ by. Defaults to 0.001.
o (String) <B>B>$msg<B>B> — An optional description.

<B>refute_in_epsilonB>


    refute_in_epsilon($actual, $expected, $epsilon, $msg)



Checks that the difference between $actual and $expected is greater than a given fraction of the smaller of the two numbers.

Examples:



    refute_in_epsilon 21.0 / 7.0, Math::Trig::pi;
   
    refute_in_epsilon 220, 200, 0.20



Parameters:
o (Number) <B>B>$actual<B>B> — The tested value.
o (Number) <B>B>$expected<B>B> — The static value.
o (Number) <B>B>$epsilon<B>B> — The factor by which $actual and $expected are expected to differ by. Defaults to 0.001.
o (String) <B>B>$msg<B>B> — An optional description.

<B>refute_matchB>


    refute_match($string, $pattern, $msg)



Validates that the given $string does not match the given $pattern.

Examples:



    refute_match Four score and seven years ago..., qr/score/;



Parameters:
o (String) <B>B>$string<B>B> — The string to match.
o (Regex) <B>B>$pattern<B>B> — The regular expression to match against.
o (String) <B>B>$msg<B>B> — An optional description.

<B>skipB>


    skip($msg)



Allows the current test to be bypassed with an indeterminate status.

Parameters:
o (String) <B>B>$msg<B>B> — An optional description.

    Class Methods

<B>importB>


    import($class)



Pulls all of the test-related methods into the calling package.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 TEST::MINI::ASSERTIONS (3) 2011-02-13

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.