docs/html/node17.html
cf6778ef
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
73e034df
 
e79e504d
 <!--Converted with LaTeX2HTML 2008 (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>
e79e504d
 <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">
 
e79e504d
 <META NAME="Generator" CONTENT="LaTeX2HTML v2008">
73e034df
 <META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
 
 <LINK REL="STYLESHEET" HREF="clamdoc.css">
 
e79e504d
 <LINK REL="next" HREF="node18.html">
 <LINK REL="previous" HREF="node16.html">
 <LINK REL="up" HREF="node11.html">
73e034df
 <LINK REL="next" HREF="node18.html">
 </HEAD>
 
 <BODY >
cf6778ef
 <!--Navigation Panel-->
06e931e5
 <A NAME="tex2html439"
73e034df
   HREF="node18.html">
 <IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> 
06e931e5
 <A NAME="tex2html435"
e79e504d
   HREF="node11.html">
73e034df
 <IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> 
06e931e5
 <A NAME="tex2html429"
73e034df
   HREF="node16.html">
 <IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> 
06e931e5
 <A NAME="tex2html437"
73e034df
   HREF="node1.html">
 <IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>  
 <BR>
06e931e5
 <B> Next:</B> <A NAME="tex2html440"
e79e504d
   HREF="node18.html">Reporting a unit test</A>
06e931e5
 <B> Up:</B> <A NAME="tex2html436"
e79e504d
   HREF="node11.html">Installation</A>
06e931e5
 <B> Previous:</B> <A NAME="tex2html430"
e79e504d
   HREF="node16.html">Compilation with clamav-milter enabled</A>
06e931e5
  &nbsp; <B>  <A NAME="tex2html438"
73e034df
   HREF="node1.html">Contents</A></B> 
 <BR>
cf6778ef
 <BR>
73e034df
 <!--End of Navigation Panel-->
 
e79e504d
 <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.
06e931e5
         
 <BR>
 <BR>
e79e504d
 The first step is to use your OS's package manager to install the <code>check</code> package. 
 	If your OS doesn't have that package, you can download it from <TT><A NAME="tex2html11"
   HREF="http://check.sourceforge.net/">http://check.sourceforge.net/</A></TT>, 
 	build it and install it.
06e931e5
         
 <BR>
 <BR>
e79e504d
 To help clamav's configure script locate <code>check</code>, it is recommended that you install <code>pkg-config</code>, preferably
 	using your OS's package manager, or from <TT><A NAME="tex2html12"
   HREF="http://pkg-config.freedesktop.org">http://pkg-config.freedesktop.org</A></TT>.
06e931e5
         
 <BR>
 <BR>
e79e504d
 The recommended way to run unit-tests is the following, which ensures you will get an error if unit tests cannot be built:
 	<A NAME="tex2html13"
cf6778ef
   HREF="footnode.html#foot167"><SUP>7</SUP></A>	<PRE>
e79e504d
 	 $ ./configure --enable-check
 	 $ make
 	 $ make check
 </PRE>
06e931e5
 	When <code>make check</code> is finished, you should get a message similar to this:
e79e504d
 	<PRE>
 ==================
 All 8 tests passed
 ==================
 </PRE>
06e931e5
 	If a unit test fails, you get a message similar to the following.
         Note that in older versions of make check may report failures due to
         the absence of optional packages. Please make sure you have the
         latest versions of the components noted in section /refsec:components.
e79e504d
 	See the next section on how to report a bug when a unit test fails.
 	<PRE>
 ========================================
 1 of 8 tests failed
 Please report to http://bugs.clamav.net/
 ========================================
 </PRE>
06e931e5
 	If unit tests are disabled (and you didn't use -enable-check), you will get this message:
e79e504d
 	<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>
cf6778ef
 <HR>
e79e504d
 <!--Navigation Panel-->
06e931e5
 <A NAME="tex2html439"
e79e504d
   HREF="node18.html">
 <IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> 
06e931e5
 <A NAME="tex2html435"
e79e504d
   HREF="node11.html">
 <IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> 
06e931e5
 <A NAME="tex2html429"
e79e504d
   HREF="node16.html">
 <IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> 
06e931e5
 <A NAME="tex2html437"
e79e504d
   HREF="node1.html">
 <IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>  
ba4cac37
 <BR>
06e931e5
 <B> Next:</B> <A NAME="tex2html440"
e79e504d
   HREF="node18.html">Reporting a unit test</A>
06e931e5
 <B> Up:</B> <A NAME="tex2html436"
e79e504d
   HREF="node11.html">Installation</A>
06e931e5
 <B> Previous:</B> <A NAME="tex2html430"
e79e504d
   HREF="node16.html">Compilation with clamav-milter enabled</A>
06e931e5
  &nbsp; <B>  <A NAME="tex2html438"
cf6778ef
   HREF="node1.html">Contents</A></B> 
e79e504d
 <!--End of Navigation Panel-->
73e034df
 <ADDRESS>
9d8137e2
 Cisco 2014-10-10
73e034df
 </ADDRESS>
 </BODY>
 </HTML>