Added description of test scripts.

Prepared for release 0.0.11

diff --git a/doc/index.html b/doc/index.html
index 2a64c8b..63f0211 100644 (file)
--- a/doc/index.html
+++ b/doc/index.html
@@ -85,6 +85,7 @@ The core team on Gnucomo developer day 1.
      <li><a href="gnucomo-0.0.8.tar.bz2">Gnucomo-0.0.8</a> Sep 04, 2003 </li>
      <li><a href="gnucomo-0.0.9.tar.bz2">Gnucomo-0.0.9</a> Dec 24, 2003 </li>
      <li><a href="gnucomo-0.0.10.tar.bz2">Gnucomo-0.0.10</a> Oct 19, 2007 </li>
+     <li><a href="gnucomo-0.0.11.tar.bz2">Gnucomo-0.0.11</a> Nov 22, 2007 </li>
      <li><a href="gnucomo-snapshot.tar.bz2">Gnucomo Development snapshot</a> Jan 11, 2007 </li>
    </ul>
 

diff --git a/doc/makefile b/doc/makefile
index 4dfb900..7d73386 100644 (file)
--- a/doc/makefile
+++ b/doc/makefile
@@ -25,7 +25,7 @@ PICTURES= dataflow.eps architecture.eps erd-action.eps erd-anu.eps erd-log.eps \
           class-database_entity.eps classes-gcm_input.eps gcm_input-dataflow.eps \
         classes-message_filter.eps
 
-html: manifest.xhtml design.xhtml manual.xhtml
+html: manifest.xhtml design.xhtml manual.xhtml test.xhtml
 
 ps: manifest.ps design.ps
 
@@ -36,6 +36,9 @@ all:  ps html txt
 manual.xhtml : manual.xml $(IMAGES)
        xml2html manual.xml > manual.xhtml
 
+test.xhtml : test.xml
+       xml2html test.xml > test.xhtml
+
 manifest.xhtml : manifest.xml $(IMAGES)
        xml2html manifest.xml > manifest.xhtml
 

diff --git a/doc/test.xml b/doc/test.xml
new file mode 100644 (file)
index 0000000..fa04f23
--- /dev/null
+++ b/doc/test.xml
@@ -0,0 +1,150 @@
+<?xml version="1.0"?>
+<!DOCTYPE doc SYSTEM "/usr/local/xslt/doc.dtd">
+<?xml-stylesheet type="text/xsl" href="/usr/local/xslt/html.xsl"?>
+<doc style="main.css">
+
+<!--
+      Gnucomo - Gnu Computer Monitoring Test description
+      Original author :  Arjen Baart - arjen@andromeda.nl
+      Version         : $Revision: 1.1 $
+
+      This document is prepared for XMLDoc. Transform to HTML,
+      LaTeX, Postscript or plain text with XMLDoc utilities and
+      XSLT sheets from http://www.andromeda.nl/projects/xmldoc/
+-->
+
+<book>
+<titlepage>
+   <title>Gnucomo - test description</title>
+   <para><picture src='logo.png' eps='logo' scale='0.7'/></para>
+   <author>Arjen Baart <code>&lt;arjen@andromeda.nl&gt;</code></author>
+   <date>October 25, 2007</date>
+   <docinfo>
+      <infoitem label="Version">0.1</infoitem>
+      <infoitem label="Organization">Andromeda Technology &amp; Automation</infoitem>
+      <infoitem label="Organization">De Winter Information Solutions</infoitem>
+   </docinfo>
+   <abstract>
+   </abstract>
+</titlepage>
+
+<toc/>
+
+<chapter>
+<heading>Testing Gnucomo</heading>
+<para>
+Large parts of Gnucomo are tested automatically.
+The script that runs all these tests, <code>gcmtest</code>,
+along with individual scripts and data files, is located in the
+directory <code>test</code> in the Gnucomo source distribution.
+</para>
+</chapter>
+
+<chapter>
+<heading>Test cases</heading>
+
+<para>
+This chapter describes individual test cases.
+</para>
+
+<section>
+<heading>Test 0001: Database</heading>
+<para>
+Create and destroy the database.
+</para>
+</section>
+
+<section>
+<heading>Test 0002a: Read syslog entries</heading>
+<para>
+Create an object 'kithira.andromeda.nl' in the database and
+parse a piece of a syslog file.
+This tests normal operation in which gcm_input reads a syslog file
+directly.
+</para>
+</section>
+
+<section>
+<heading>Test 0003: Read corrupted syslog entries</heading>
+<para>
+Create an object 'vd.wt.tno.nl' in the database and
+parse a piece of a syslog file with short and even empty lines.
+There should be warnings printed on stderr.
+</para>
+</section>
+
+<section>
+<heading>Test 0004: Read syslog entries without hostname</heading>
+<para>
+Create an object 'kithira.andromeda.nl' in the database and
+try to parse a piece of a syslog file without specifying the hostname.
+The message should be rejected on account of an unknown host.
+</para>
+</section>
+
+<section>
+<heading>Test 0005: Read syslog entries without time</heading>
+<para>
+Create an object 'kithira.andromeda.nl' in the database and
+parse a piece of a syslog file without specifying a time.
+This tests wether an improper time still creates valid data.
+</para>
+</section>
+
+<section>
+<heading>Test 0008: Database upgrades</heading>
+<para>
+Test the database upgrades in gcm_daemon.
+Create an old, version 1, database and run gcm_daemon to perform
+an upgrade to the latest version.
+Then, create a latest-version database and compare dumps of these
+database. They should be essentially the same.
+</para>
+</section>
+
+<section>
+<heading>Test 0009: Service check notifications</heading>
+<para>
+Test the service check notifications.
+Create a database with two objects and no services. After reading two
+log file fragments for these two objects, gcm_daemon should create
+'service unknown' notifications, one for each object, as well as a few
+other notifications.
+
+This tests problem report nr. 23
+</para>
+</section>
+
+<section>
+<heading>Test 0010: Processing log entries</heading>
+<para>
+Test the log processing of gcm_daemon
+Create a database with one object and read a piece of sendmail log
+
+This tests problem report nrs. 14 through 17
+</para>
+</section>
+
+<section>
+<heading>Test 0011: Ambiguous log entries</heading>
+<para>
+Create an object 'vd.wt.tno.nl' in the database and
+parse a piece of a apache access file which may be mistaken for an rpm list
+</para>
+</section>
+
+<section>
+<heading>Test 0012: RPM package list</heading>
+<para>
+Create an object and parse an RPM package list.
+Parameters and properties are created in the database.
+The first line of the RPM list is empty. This tests whether
+gcm_input can handle empty lines properly.
+This tests problem report nr. 30.
+</para>
+</section>
+
+</chapter>
+
+</book>
+</doc>