Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Test::use::ok (3)

Name

Test::use::ok - Alternative to Test::More::use_ok

Synopsis

use ok 'Some::Module';

Description

Perl Programmers Reference Guide                              Test::use::ok(3)



NAME
       Test::use::ok - Alternative to Test::More::use_ok

SYNOPSIS
           use ok 'Some::Module';

DESCRIPTION
       According to the Test::More documentation, it is recommended to run
       "use_ok()" inside a "BEGIN" block, so functions are exported at
       compile-time and prototypes are properly honored.

       That is, instead of writing this:

           use_ok( 'Some::Module' );
           use_ok( 'Other::Module' );

       One should write this:

           BEGIN { use_ok( 'Some::Module' ); }
           BEGIN { use_ok( 'Other::Module' ); }

       However, people often either forget to add "BEGIN", or mistakenly group
       "use_ok" with other tests in a single "BEGIN" block, which can create
       subtle differences in execution order.

       With this module, simply change all "use_ok" in test scripts to "use
       ok", and they will be executed at "BEGIN" time.  The explicit space
       after "use" makes it clear that this is a single compile-time action.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | runtime/perl-532      |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+

SEE ALSO
       Test::More

MAINTAINER
       Chad Granum <exodist@cpan.org>

CC0 1.0 Universal
       To the extent possible under law, XX has waived all copyright and
       related or neighboring rights to Test-use-ok.

       This work is published from Taiwan.

       <http://creativecommons.org/publicdomain/zero/1.0>



NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       http://www.cpan.org/src/5.0/perl-5.32.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.perl.org/.



perl v5.32.0                      2020-06-14                  Test::use::ok(3)