| 61b40ee3 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| 73e034df |
|
| 61b40ee3 |
<!--Converted with LaTeX2HTML 2002-2-1 (1.71) |
| 73e034df |
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD> |
| 96e05490 |
<TITLE>Running unit tests</TITLE>
<META NAME="description" CONTENT="Running unit tests"> |
| 73e034df |
<META NAME="keywords" CONTENT="clamdoc">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
|
| 61b40ee3 |
<META NAME="Generator" CONTENT="LaTeX2HTML v2002-2-1"> |
| 73e034df |
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="clamdoc.css">
|
| 96e05490 |
<LINK REL="next" HREF="node16.html">
<LINK REL="previous" HREF="node14.html">
<LINK REL="up" HREF="node9.html"> |
| 73e034df |
<LINK REL="next" HREF="node16.html">
</HEAD>
<BODY > |
| 61b40ee3 |
<DIV CLASS="navigation"><!--Navigation Panel--> |
| ee93a07e |
<A NAME="tex2html391" |
| 73e034df |
HREF="node16.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> |
| ee93a07e |
<A NAME="tex2html387" |
| 96e05490 |
HREF="node9.html"> |
| 73e034df |
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> |
| ee93a07e |
<A NAME="tex2html381" |
| 73e034df |
HREF="node14.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> |
| ee93a07e |
<A NAME="tex2html389" |
| 73e034df |
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR> |
| ee93a07e |
<B> Next:</B> <A NAME="tex2html392" |
| 96e05490 |
HREF="node16.html">Reporting a unit test</A> |
| ee93a07e |
<B> Up:</B> <A NAME="tex2html388" |
| 96e05490 |
HREF="node9.html">Installation</A> |
| ee93a07e |
<B> Previous:</B> <A NAME="tex2html382" |
| 73e034df |
HREF="node14.html">Compilation with clamav-milter enabled</A> |
| ee93a07e |
<B> <A NAME="tex2html390" |
| 73e034df |
HREF="node1.html">Contents</A></B>
<BR> |
| 61b40ee3 |
<BR></DIV> |
| 73e034df |
<!--End of Navigation Panel-->
|
| 96e05490 |
<H2><A NAME="SECTION00046000000000000000"></A><A NAME="unit-testing"></A>
<BR>
Running unit tests
</H2>
ClamAV includes unit tests that allow you to test that the compiled binaries work correctly on your platform.
<P>
The first step is to use your OS's package manager to install the <code>check</code> package. |
| ee93a07e |
If your OS doesn't have that package, you can download it from <TT><A NAME="tex2html8" |
| 96e05490 |
HREF="http://check.sourceforge.net/">http://check.sourceforge.net/</A></TT>,
build it and install it. |
| 73e034df |
<P> |
| 96e05490 |
To help clamav's configure script locate <code>check</code>, it is recommended that you install <code>pkg-config</code>, preferably |
| ee93a07e |
using your OS's package manager, or from <TT><A NAME="tex2html9" |
| 96e05490 |
HREF="http://pkg-config.freedesktop.org">http://pkg-config.freedesktop.org</A></TT>.
<P>
The recommended way to run unit-tests is the following, which ensures you will get an error if unit tests cannot be built: |
| ee93a07e |
<A NAME="tex2html10"
HREF="footnode.html#foot155"><SUP><SPAN CLASS="arabic">4</SPAN></SUP></A> <PRE> |
| 96e05490 |
$ ./configure --enable-check
$ make
$ make check
</PRE>
<P>
When <code>make check</code> is finished, you should get a message similar to this:
<PRE>
==================
All 5 tests passed
==================
</PRE>
<P>
If a unit test fails, you get a message similar to the following.
See the next section on how to report a bug when a unit test fails.
<PRE>
========================================
1 of 5 tests failed
Please report to http://bugs.clamav.net/
========================================
</PRE>
<P>
If unit tests are disabled (and you didn't use -enable-check), you will get this message:
<PRE>
*** Unit tests disabled in this build
*** Use ./configure --enable-check to enable them
SKIP: check_clamav
PASS: check_clamd.sh
PASS: check_freshclam.sh
PASS: check_sigtool.sh
PASS: check_clamscan.sh
======================
All 4 tests passed
(1 tests were not run)
======================
</PRE>
Running <code>./configure --enable-check</code> should tell you why.
<P>
<DIV CLASS="navigation"><HR>
<!--Navigation Panel--> |
| ee93a07e |
<A NAME="tex2html391" |
| 96e05490 |
HREF="node16.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> |
| ee93a07e |
<A NAME="tex2html387" |
| 96e05490 |
HREF="node9.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> |
| ee93a07e |
<A NAME="tex2html381" |
| 96e05490 |
HREF="node14.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> |
| ee93a07e |
<A NAME="tex2html389" |
| 96e05490 |
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A> |
| 61b40ee3 |
<BR> |
| ee93a07e |
<B> Next:</B> <A NAME="tex2html392" |
| 96e05490 |
HREF="node16.html">Reporting a unit test</A> |
| ee93a07e |
<B> Up:</B> <A NAME="tex2html388" |
| 96e05490 |
HREF="node9.html">Installation</A> |
| ee93a07e |
<B> Previous:</B> <A NAME="tex2html382" |
| 96e05490 |
HREF="node14.html">Compilation with clamav-milter enabled</A> |
| ee93a07e |
<B> <A NAME="tex2html390" |
| 96e05490 |
HREF="node1.html">Contents</A></B> </DIV>
<!--End of Navigation Panel--> |
| 73e034df |
<ADDRESS>
Tomasz Kojm |
| a6b4b6af |
2008-10-30 |
| 73e034df |
</ADDRESS>
</BODY>
</HTML> |