my_prove - Run MyTAP MySQL tests through a TAP harness.
my_prove -D myapp my_prove -D testdb tests/ my_prove sometest.sql
my_prove is a command-line application to run one or more MyTAP tests in a MySQL database. The output of the tests is harvested and processed by TAP::Harness in order to summarize the results of the test.
Tests can be written and run as SQL scripts. If no files or directories are supplied,
my_prove looks for all files matching the pattern
t/*.my. If the tests fail,
my_prove will exit with non-zero status.
MyTAP test scripts should consist of a series of SQL statements that output TAP. Here’s a simple example that assumes that the MyTAP functions have been installed in the "tap" database:
-- Start transaction and plan the tests. BEGIN; SELECT tap.plan(1); -- Run the tests. SELECT tap.pass( 'My test passed, w00t!' ); -- Finish the tests and clean up. CALL finish(); ROLLBACK;
Now run the tests by passing the list of SQL script names to
my_prove. Here’s what it looks like when the MyTAP tests are run with
% my_prove -u root sql/*.sql t/coltap.....ok t/hastap.....ok t/moretap....ok t/pktap......ok All tests successful. Files=4, Tests=216, 1 wallclock secs ( 0.06 usr 0.02 sys + 0.08 cusr 0.07 csys = 0.23 CPU) Result: PASS
-v, --verbose Print all test lines. -l, --lib Add 'lib' to the path for your tests (-Ilib). --blib Add 'blib/lib' and 'blib/arch' to the path for your tests -s, --shuffle Run the tests in random order. -c, --color Colored test output (default). --nocolor Do not color test output. --count Show the X/Y test count when not verbose (default) --nocount Disable the X/Y test count. --dry Dry run. Show test that would have run. --ext Set the extension for tests (default '.t') -f, --failures Show failed tests. -o, --comments Show comments and diagnostics. --ignore-exit Ignore exit status from test scripts. --merge Merge test scripts' STDERR with their STDOUT. -r, --recurse Recursively descend into directories. --reverse Run the tests in reverse order. -q, --quiet Suppress some test output while running tests. -Q, --QUIET Only print summary results. --parse Show full list of TAP parse errors, if any. --directives Only show results with TODO or SKIP directives. --timer Print elapsed time after each test. --trap Trap C<Ctrl-C> and print summary on interrupt. --normalize Normalize TAP output in verbose output -T Enable tainting checks. -t Enable tainting warnings. -W Enable fatal warnings. -w Enable warnings. -H, --help Display this help -?, Display this help -m, --man Longer manpage for my_prove --norc Don't process default .proverc
Options that take arguments:
-I Library paths to include. -P Load plugin (searches App::Prove::Plugin::*.) -M Load a module. -e, --exec Interpreter to run the tests ('' for compiled tests.) --harness Define test harness to use. See TAP::Harness. --formatter Result formatter to use. See FORMATTERS. --source Load and/or configure a SourceHandler. See SOURCE HANDLERS. -a, --archive out.tgz Store the resulting TAP in an archive file. -j, --jobs N Run N test jobs in parallel (try 9.) --state=opts Control prove's persistent state. --rc=rcfile Process options from rcfile -b --mysql-bin Location of the C<mysql> client. -D, --database Database to use. -u, --user User with which to connect. -p, --password The password to use when connecting. -h, --host Host to which to connect. -P, --port Port to which to connect.
my_prove --mysql-bin /usr/local/mysql/bin/mysql my_prove -b /usr/local/bin/mysql
Path to the
mysqlclient program, which will be used to actually run the tests. Defaults to mysql, which should work well if an executable with that name is in your path.
my_prove --database try my_prove -D root
The name of database to use.
my_prove --user foo my_prove -u root
The MySQL user name to use when connecting to the server.
my_prove --password foo my_prove -p root
The password to use when connecting to the server. Specifying a password on the command line should be considered insecure. You can use a MySQL option file such as /etc/my.cnf or the .my.cnf file in your home directory, to avoid giving the password on the command line.
my_prove --host mysql.example.com my_prove -h dev.local
Connect to the MySQL server on the given host.
my_prove --port 1234 my_prove -P 666
The TCP/IP port number to use for the connection.
my_prove --color my_prove -c
Display test results in color. Colored test output is the default, but if output is not to a terminal, color is disabled.
Do not display test results in color.
my_prove --formatter TAP::Formatter::File my_prove -f TAP::Formatter::Console
my_prove --archive tap.tar.gz my_prove -a test_output.tar
Send the TAP output to a TAP archive file as well as to the normal output destination. The archive formats supported are .tar and .tar.gz.
Show comments, such as diagnostics output by
diag(). Enabled by default. use
--trapoption will attempt to trap
Ctrl-C) during a test run and display the test summary even if the run is interrupted
You can ask
my_proveto remember the state of previous test runs and select and/or order the tests to be run based on that saved state.
--stateswitch requires an argument which must be a comma separated list of one or more of the following options.
Run the same tests as the last time the state was saved. This makes it possible, for example, to recreate the ordering of a shuffled test.
# Run all tests in random order $ my_prove --state=save --shuffle # Run them again in the same order $ my_prove --state=last
Run only the tests that failed on the last run.
# Run all tests $ my_prove --state=save # Run failures $ my_prove --state=failed
If you also specify the
saveoption newly passing tests will be excluded from subsequent runs.
# Repeat until no more failures $ my_prove --state=failed,save
Run only the passed tests from last time. Useful to make sure that no new problems have been introduced.
Run all tests in normal order. Multiple options may be specified, so to run all tests with the failures from last time first:
$ my_prove --state=failed,all,save
Run the tests that most recently failed first. The last failure time of each test is stored. The
hotoption causes tests to be run in most-recent- failure order.
$ my_prove --state=hot,save
Tests that have never failed will not be selected. To run all tests with the most recently failed first use
$ my_prove --state=hot,all,save
This combination of options may also be specified thus
$ my_prove --state=adrian
Run any tests with to-dos.
Run the tests in slowest to fastest order. This is useful in conjunction with the
-jparallel testing switch to ensure that your slowest tests start running first.
$ my_prove --state=slow -j9
Run test tests in fastest to slowest order.
Run the tests in newest to oldest order based on the modification times of the test scripts.
Run the tests in oldest to newest order.
Run those test scripts that have been modified since the last test run.
Save the state on exit. The state is stored in a file called .prove (_prove on Windows and VMS) in the current directory.
--stateswitch may be used more than once.
$ my_prove --state=hot --state=all,save
If ~/.proverc or ./.proverc exist they will be read and any options they contain processed before the command line options. Options in .proverc are specified in the same way as command line options:
# .proverc --state=hot,fast,save -j9
Additional option files may be specified with the
--rcoption. Default option file processing is disabled by the
Under Windows and VMS the option file is named _proverc rather than .proverc and is sought only in the current directory.
my_prove --help my_prove -H
Outputs a brief description of the options supported by
my_prove --man my_prove -m
Outputs this documentation and exits.
my_prove --version my_prove -V
Outputs the program name and version and exits.
David E. Wheeler <email@example.com>
Copyright and License
Copyright (c) 2010 David E. Wheeler. Some Rights Reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.