Please note, this is a STATIC archive of website developer.mozilla.org from 03 Nov 2016, cach3.com does not collect or store any user information, there is no "phishing" involved.

Revision 185925 of How to add a build-time test

  • Revision slug: How_to_add_a_build-time_test
  • Revision title: How to add a build-time test
  • Revision id: 185925
  • Created:
  • Creator: Kray2
  • Is current revision? No
  • Comment add Makefile smarts to this page, removing from xpcshell create doc
Tags: 

Revision Content

Here are the simple guidelines for adding a build-time test:

  1. For now, enclose your test-related code (in the makefile) with ifdef ENABLE_TESTS
  2. Run the test program from the "check" target in the makefile. ({{wiki.template('Named-source', [ "netwerk/test/Makefile.in", "example" ])}} to run the TestCookie program)
  3. In the test program:
    • If the test fails, exit with a non-zero status and/or print the string "FAIL" to stdout
    • If the test passes, exit with a zero status and don't print the string "FAIL" (bonus points for printing "PASS" :) )

Write the test so that you expect it to pass on all platforms, since if the test fails, the tree will go orange (once we've set this up - see {{template.Bug(352240)}} for status).

For example, to add an xpcshell test to a module, do the following:

  1. Copy {{template.Source("tools/test-harness/xpcshell-simple/example")}} to yourmoduledir/tests_type, where tests_type is something that describes your tests. You can of course use unit or test if you're not feeling creative.
  2. In <tt>yourmoduledir/tests_type/Makefile.in</tt> change DEPTH, MODULE, and XPCSHELL_TESTS appropriately:
    • DEPTH should be a relative path pointing to <tt>mozilla/</tt>, e.g. if you're in <tt>netwerk/test</tt>, set DEPTH = ../..
    • MODULE should be defined to test_yourmodule or just yourmodule -- either will work fine.
    • XPCSHELL_TESTS be a list of subdirectories of the current directory which contain xpcshell tests. You can of course just use the one tests_type directory here, but if you want to subdivide your tests by functionality, separate directories is the way to go.
  3. Reference the test dir in a parent makefile (<tt>yourmoduledir/Makefile.in</tt>): 
    ifdef ENABLE_TESTS
DIRS  += tests_type
endif
  4. (Optional, but recommended) Add the new makefile to allmakefiles.sh (TODO: need more details about this)
  5. Reconfigure (e.g. with <tt>make -f client.mk configure</tt>)
  6. make / make check in <tt>yourmodule</tt>

Revision Source

 
<p>
Here are the simple guidelines for adding a build-time test:
</p>
<ol><li> For now, enclose your test-related code (in the makefile) with <code>ifdef ENABLE_TESTS</code>
</li><li> Run the test program from the "check" target in the makefile. ({{wiki.template('Named-source', [ "netwerk/test/Makefile.in", "example" ])}} to run the TestCookie program)
</li><li> In the test program:
<ul><li> If the test fails, exit with a non-zero status and/or print the string "FAIL" to stdout
</li><li> If the test passes, exit with a zero status and don't print the string "FAIL" (bonus points for printing "PASS" :) )
</li></ul>
</li></ol>
<p>Write the test so that you expect it to pass on all platforms, since if the test fails, the tree will go orange (once we've set this up - see {{template.Bug(352240)}} for status).
</p><p>For example, to add an xpcshell test to a module, do the following:
</p>
<ol>
<li>Copy {{template.Source("tools/test-harness/xpcshell-simple/example")}} to <code><i>yourmoduledir</i>/<i>tests_type</i></code>, where <i>tests_type</i> is something that describes your tests.  You can of course use <code>unit</code> or <code>test</code> if you're not feeling creative.</li>
<li>In <tt><i>yourmoduledir</i>/<i>tests_type</i>/Makefile.in</tt> change <code><a href="en/DEPTH">DEPTH</a></code>, <code><a href="en/MODULE">MODULE</a></code>, and <code><a href="en/XPCSHELL_TESTS">XPCSHELL_TESTS</a></code> appropriately:</li>
<ul>
<li><code>DEPTH</code> should be a relative path pointing to <tt>mozilla/</tt>, e.g. if you're in <tt>netwerk/test</tt>, set <code>DEPTH = ../..</code></li>
<li><code>MODULE</code> should be defined to <code>test_<i>yourmodule</i></code> or just <code><i>yourmodule</i></code> -- either will work fine.</li>
<li><code>XPCSHELL_TESTS</code> be a list of subdirectories of the current directory which contain xpcshell tests.  You can of course just use the one <i>tests_type</i> directory here, but if you want to subdivide your tests by functionality, separate directories is the way to go.</li>
</ul>
<li>Reference the test dir in a parent makefile (<tt><i>yourmoduledir</i>/Makefile.in</tt>):

<pre>ifdef ENABLE_TESTS
DIRS  += tests_type
endif</pre>
</li>
<li>(Optional, but recommended) Add the new makefile to <a href="en/Allmakefiles.sh">allmakefiles.sh</a> (TODO: need more details about this)</li>
<li>Reconfigure (e.g. with <tt>make -f client.mk configure</tt>)</li>
<li><i>make</i> / <i>make check</i> in <tt><i>yourmodule</i></tt></li>
</ol>
Revert to this revision