docs/wiki/pcb-unit_tests.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html>
   4 <head>
   5   <link rel="stylesheet" media="screen" type="text/css" href="./style.css" />
   6   <link rel="stylesheet" media="screen" type="text/css" href="./design.css" />
   7   <link rel="stylesheet" media="print" type="text/css" href="./print.css" />
   8
   9   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  10 </head>
  11 <body>
  12
  13 <h2 id="unittestingframework">Unit Testing Framework</h2>
  14 <div class="level2">
  15
  16 <p>
  17 I just figured this out, so, here&#039;s how it works, and I&#039;ll formalize this page later.
  18 </p>
  19
  20 <p>
  21 pcb uses the glib testing framework for unit tests: https:<em>developer.gnome.org/glib/stable/glib-Testing.html
  22
  23 Look at main-test.c for examples.
  24
  25 In the actual code, you can wrap the unit test stuff in:
  26
  27 &lt;code&gt;
  28 #ifdef PCB_UNIT_TEST
  29 #endif /* PCB_UNIT_TEST */
  30 &lt;/code&gt;
  31
  32 so that it doesn&#039;t bog things down when not testing. Does it really bog things down when not testing??
  33
  34 You need a &quot;&lt;x&gt;_register_tests&quot; function, and then how ever many functions you&#039;re going to use to execute your tests. Put prototypes in the header file. Include the header file in main-test.c, and add a call to the &quot;&lt;x&gt;_register_tests&quot; function in main.
  35
  36 In the register function, make a call to g_test_add_func to add whatever testing functions you want to call. It uses a /x/y naming convention, where x is the test module, and y are the individual tests.
  37
  38 You have to add the source file to the list of files to be compiled for testing in Makefile.am. Look for the TEST_SRCS variable, and add your files there, in addition to adding them wherever else you need so that pcb compiles them.
  39
  40 Finally, you can rerun configure (to regen the makefiles), and execute &quot;make check&quot; from the build directory. This will build and execute the tests without necessarily building all of pcb. I&#039;m not sure if this runs the pcb level tests or not.
  41 </p>
  42
  43 </div>
  44 </body>
  45 </html>