Testing_DocTest: Feature/Change Request 16393 [Assigned] Better support for file-level code

dw-pear at digger dot net — 2009-09-17T10:52:54+00:00

Testing_DocTest Feature/Change Request
Reported by digger
2009-07-01T02:36:01+00:00
PHP: 5.2.9 OS: n/a Package Version: 0.4.1

Description:
------------
Some of the files I would like to add doctests to contain bare code (outside of functions and classes), and have behavior that depends on external values (web server environment variables, command-line arguments, etc).  Since DocTest require()s the tested source before running the test, the tested code has already executed by the time test code gets a chance to set up the necessary data.

What would be nice to see is a keyword ("setup:" in my examples below) that could be used to specify test setup code to run BEFORE the tested file is require()d.  This way the test code could prepare some necessary data, then the tested file would be require()d, and finally the test code would be run.

Similarly, scripts with bare code like this will often produce output without any actual test code needed.  But if the code section of the test is omitted, DocTest complains "Error: unexpected expects line".  So the second part of this request is that the test code be optional.  That is, a test could contain the setup code (described above), or the usual test code, or both, or neither.

The "both" case is a bit tricky, due to the need to somehow separate the setup code and the test code.  Perhaps there could be an optional keyword ("test:" in my examples) which if present just indicates the start of the test code, acting as a separator if necessary.

Test script:
---------------
/**
 * 
 * // doctest: Web page test
 * // setup:
 * // $_SERVER['REQUEST_URI'] = '/test/script';
 * // expects:
 * // You requested '/test/script'.
 * 
 */
echo "You requested '{$_SERVER['REQUEST_URI']}'.";

//===================

/**
 * 
 * // doctest: Command line test
 * // setup:
 * // $argc = 1;
 * // $argv = array('test');
 * // expects:
 * // Your command was 'test'.
 * 
 */
if ($argc > 0) {
    echo "Your command was: '{$argv[0]}'.";
}

//===================

/**
 * 
 * // doctest: Both setup and test code
 * // setup:
 * // $_ENV['OSTYPE'] = 'linux';
 * // test:
 * // echo OS_TYPE;
 * // expects:
 * // linux
 * 
 */
define('OS_TYPE', $_ENV['OSTYPE']);

Testing_DocTest: Feature/Change Request 15948 [Analyzed] Add ability to enter into interactive mode inside a doctest

sofiacardita at gmail dot com — 2009-02-27T08:14:27+00:00

Testing_DocTest Feature/Change Request
Reported by sofia
2009-02-26T12:57:29+00:00
PHP: 5.2.1 OS: irrelevant Package Version: 

Description:
------------
      I'm not sure this is feasible but it would be really useful. I was thinking 
something along what's described here 
http://bluedynamics.com/articles/jens/interlude-write-python-doctests-
interactive . We would have have some kind of stopword, eg //interact
, that would signal the include of a file which would import the code that had 
been run up until that point into an interactive session. As soon as the user 
exited the session the doctest would continue its normal business. Do you 
think this is feasible in php?

Test script:
---------------
      

Expected result:
----------------
      

Actual result:
--------------

PEAR Bug Search Results

Testing_DocTest: Feature/Change Request 16393 [Assigned] Better support for file-level code

Testing_DocTest: Feature/Change Request 15948 [Analyzed] Add ability to enter into interactive mode inside a doctest