Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cxw42/test-onlysome

Run only some of the tests specified in a Perl test file.
https://github.com/cxw42/test-onlysome

perl perl5 perl5-module skip-tests testing testing-tools

Last synced: about 2 months ago
JSON representation

Run only some of the tests specified in a Perl test file.

Awesome Lists containing this project

README 

        
# NAME



Test::OnlySome - Skip individual tests in a \*.t file



# INSTALLATION



Easiest: install `cpanminus` if you don't have it - see

[https://metacpan.org/pod/App::cpanminus#INSTALLATION](https://metacpan.org/pod/App::cpanminus#INSTALLATION).  Then run

`cpanm Test::OnlySome`.



Manually: clone or untar into a working directory.  Then, in that directory,



    perl Makefile.PL

    make

    make test



... and if all the tests pass,



    make install



If some of the tests fail, please check the issues and file a new one if

no one else has reported the problem yet.



# SYNOPSIS



Suppose you are testing a `long_running_function()`.  If it succeeded last

time, you don't want to take the time to test it again.  In your test file

(e.g., `t/01.t`):



    use Test::More tests => 2;

    use Test::OnlySome::RerunFailed;    # rerun only failed tests

    os ok(long_running_function());     # "os" marks tests that might be skipped

    os ok(0, 'fails');



At the command line, supposing the function passes the test:



    $ osprove -lv

    ...

    ok 1 - passes

    not ok 2 - fails

    ...

    Result: FAIL



This creates `.onlysome.yml`, which holds the test results from `t/01.t`.

Then, re-run:



    $ osprove -lv

    ...

    ok 1 # skip Test::OnlySome: you asked me to skip this

    not ok 2 - fails

    ...



Since test 1 passed the first time, it was skipped the second time.



You don't have to use [Test::OnlySome::RerunFailed](https://metacpan.org/pod/Test::OnlySome::RerunFailed).  You can directly

use `Test::OnlySome`, and you can decide in some other way which tests

you want to skip.



The argument to ["os"](#os) can be a statement or block, and it doesn't have to

be a [Test::More](https://metacpan.org/pod/Test::More) test.  You can wrap long-running tests in functions,

and apply ["os"](#os) to those functions.



Please note that ["os"](#os) can take a `test_count` argument, e.g., if there

are multiple tests in a block.  The whole block will be skipped if and only

if all the tests in that block are skipped.  Otherwise, the whole block

will be rerun.  The moral?  Use a `test_count` of 1 for all tests run under

[Test::OnlySome::RerunFailed](https://metacpan.org/pod/Test::OnlySome::RerunFailed) and you won't be surprised.



# MARKING TESTS



You can pick which tests to skip using implicit or explicit configuration.

Explicit configuration uses a hashref:



    my $opts = { skip => { 2=>true } };



    os $opts ok(1, 'This will run');    # Single statement OK



    os $opts {                          # Block also OK

        ok(0, 'This will be skipped');  # Skipped since it's test 2

    };



Implicit configuration uses a hashref in the package variable `$TEST_ONLYSOME`,

which Test::OnlySome creates in your package when you `use` it:



    $TEST_ONLYSOME->{skip} = { 2=>true };

    os ok(1, 'Test 1');                     # This one runs

    os ok(0, 'Test 2 - should be skipped'); # Skipped since it's test 2



# EXPORTS



## skip\_these



A convenience function to fill in `$hashref_options->{skip}`.



    skip_these $hashref_options, 1, 2;

        # Skip tests 1 and 2

    skip_these 1, 2;

        # If you are using implicit configuration



## skip\_next



Another convenience function: Mark the next test to be skipped.  Example:



    skip_next;

    os ok(0, 'This one will be skipped');



## import



The `import` sub defines the keywords so that they will be exported (!).

This is per [Keyword::Declare](https://metacpan.org/pod/Keyword::Declare).



## os



Keyword `os` marks a statement that should be excuted **o**nly **s**ome of

the time.  Example:



    os 'main::debug' $hrOpts  ok 1,'Something';

        # Run "ok 1,'Something'" if hashref $hrOpts indicates.

        # Save debug information into $main::debug.



Syntax:



    os ['debug::variable::name'] [$hashref_options] [test_count] 



- `$debug::variable::name` will be assigned at compilation time.  If specified,

the given package variable will be filled in with the [Keyword::Declare](https://metacpan.org/pod/Keyword::Declare)

parse of the os invocation.

- `$hashref_options` will be accessed at runtime.  If it is not given,

["$TEST\_ONLYSOME"](#test_onlysome) will be used instead.

- `test_count` must be a numeric literal, if present.  If it is given,

it will be used instead of the number of tests specified in

`$hashref_options->{n}`.



### Cautions



- The given statement or block will be run in its own lexical scope,

not in the caller's scope.

- If you use `test_count>1`, the whole block will be skipped only if

every test in the block is marked to be skipped.  So, for example,



        os 2 { ok(1); ok(0); }



    will still run the `ok(1)` even if it was marked to be skipped if

    the `ok(0)` was not marked to be skipped.



I recommend that, when using [Test::OnlySome::RerunFailed](https://metacpan.org/pod/Test::OnlySome::RerunFailed), you always use

`test_count == 1`.



## unimport



Removes the ["os"](#os) keyword definition.



# BUGS



Please report any bugs or feature requests on GitHub, at

[https://github.com/cxw42/Test-OnlySome/issues](https://github.com/cxw42/Test-OnlySome/issues).



# SUPPORT



You can find documentation for this module with the perldoc command.



    perldoc Test::OnlySome



You can also look for information at:



- The GitHub repository



    [https://github.com/cxw42/Test-OnlySome](https://github.com/cxw42/Test-OnlySome)



- AnnoCPAN: Annotated CPAN documentation



    [http://annocpan.org/dist/Test-OnlySome](http://annocpan.org/dist/Test-OnlySome)



- CPAN Ratings



    [https://cpanratings.perl.org/d/Test-OnlySome](https://cpanratings.perl.org/d/Test-OnlySome)



- Search CPAN



    [https://metacpan.org/release/Test-OnlySome](https://metacpan.org/release/Test-OnlySome)



- RT: CPAN's request tracker



    [https://rt.cpan.org/NoAuth/Bugs.html?Dist=Test-OnlySome](https://rt.cpan.org/NoAuth/Bugs.html?Dist=Test-OnlySome)



This module is versioned with [semantic versioning](https://semver.org),

but in the backward-compatible Perl format.  So version `0.001003` is

semantic version `0.1.3`.



# LICENSE AND COPYRIGHT



Copyright 2018 Christopher White.



This program is distributed under the MIT (X11) License:

[http://www.opensource.org/licenses/mit-license.php](http://www.opensource.org/licenses/mit-license.php)



Permission is hereby granted, free of charge, to any person

obtaining a copy of this software and associated documentation

files (the "Software"), to deal in the Software without

restriction, including without limitation the rights to use,

copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the

Software is furnished to do so, subject to the following

conditions:



The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.



THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

OTHER DEALINGS IN THE SOFTWARE.