Re: [Gnash-commit] gnash/doc/C internals.xml [testing-documentation-refactor]

[strk]

On Tue, Dec 19, 2006 at 03:46:30PM +0000, Ann Barcomb wrote:

> Branch:               testing-documentation-refactor

> Running tests

Due to the target audience, I belive this whole chapter should be
moved under the 'building gnash' section. Builders are likely the
ones that will run testcases as after install there will be no
testcases accessible (except the online ones, for which we could still
leave a pointer in the documentation).

The usual way to go should be:

        ./configure
        make
        make check
        make install

> The easiest way to run Gnash's test suite is to install  DejaGnu.
> After installing DejaGnu, change to the testsuite directory and run:
>
>            make check

I belive 'make check' does something even w/out Dejagnu, just a bit less.
BTW, the directory change to 'testsuite' isn't required. If it is, 
or adds something (like the totals summary) that should be considered 
as a bug.

> make -C testsuite/samples/clip_as_button2-TestRunner check

This sounds as an invalid call to me, the -C switch is to "change" into
a directory and run 'make check' there. This would run all tests in a
single directory. Be warned that since many tests rely on the availability
of the testsuite/Dejagnu.swf file, which is only built when 'make check'
is run in that directory, running 'make check' in an inner directory *before*
Dejagnu.swf is created will fail. So 'make check' from top-level dir first.

To run a *single* testcase, you just invoke it from command line.
For the case above:

        src/gnash$ testsuite/samples/clip_as_button2-TestRunner

> makeswf XML.as

Since we're using 'Dejagnu.swf' loadable module, the above command
isn't appropriate anymore, as the XML.as will contain calls to functions
which are undefined until Dejagnu.swf is loaded. The actual call to make
that work is a bit complex:

        makeswf -i../Dejagnu.swf:dejagnu dejagnu_so_init.as XML.as 
dejagnu_so_fini.as

To make things easier (also adding support for multiple targets) there's a
make rule for this task:

        make XML-v#.swf

Where # is the *target* SWF version. I usually go like this:

        make XML-v{5,6,7,8}.swf

Note that in this case, the output *is* capable of graphic output (that's the
whole point behind Dejagnu.swf), so you might as well run with ``gnash -v 
XML-v6.swf'',
or ``another_flash_player XML-v6.swf''.

> Writing tests

This section seems still confusing to me, but I understand it is a stub and I 
already
pointed out lots of things on the other stuff, so won't go into that for the 
moment.
I suggest we finish the 'Running tests (for builders and for users)' section 
first.

--strk;