Copyright (C) 2002  Internet Software Consortium.

Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM
DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
INTERNET SOFTWARE CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

$Id: TESTING,v 1.3 2002/12/13 23:43:28 lidl Exp $

ISC OpenReg Testing Instructions
================================

You can perform several partial tests of your OpenReg installation
by running some of the programs created in the "test" directory.
These tools are not installed with the production system software,
but are useful for verifying basic system operation.

1) Using test-xaction.

   The test-xaction script (located in the test directory) connects
   to the msgbus daemon, and passes protocol requests to the backend
   daemon (xaction).  It constructs data packets on the fly, sends
   them to the backend, and prints out a lightly formatted response
   of the return data packet.  Use of this program skips the XML
   unpacking and repacking of requests to the end users.  It is a
   useful diagnostic tool for testing specific functions of the
   backend.

   Simply running the test-xaction script while both the msgq and
   xaction daemons are running should result in a relatively simple
   to follow dump of low-level data structures from the xaction process.

2) Using epp-from-file.

   The epp-from-file script (located in the bin directory) is a
   tool for feeding a set of XML documents in a simple format to
   the epp-frontend and saving the results to a log file.  This
   allows for easy automated testing of the epp-frontend.  In
   addition to sending EPP XML documents to the epp-frontend program,
   the script does include file processing and variable substitution
   on the input documents.  This allows an organization to setup
   a testing environment that caters to their domains of interest,
   and perform a wide variety of automated tests on hosts and
   domains in that apex.  The substitution syntax is described in
   the test/epp/README file.

   A wide variety of test EPP XML documents are available in the
   test/epp directory.  They can all be run against the server via
   a "make test" command in that directory (or "gmake test",
   depending on your particular system).  For each file of the name
   *.epp, a log file will be created, and the EPP XML document will
   be sent to the epp-frontend daemon for processing.

3) Whois testing.

   The whois server can be easily tested, using most available
   whois clients.  If the OpenReg whois server is running on the
   standard whois port, a client should be able to issue a request
   for a sample domain.  The ORG.ISC.ORG domain is loaded into the
   database by default.  A test whois query against this domain
   should succeed, with results like this:

   # whois -h localhost ORG.ISC.ORG

   Whois Server Version 1.0

   This whois server contains a sample load of data from the ORG.ISC.ORG zone.
   All data returned is for example and testing only.

      Domain Name: ORG.ISC.ORG
      Registrar: ISC Sample Registry
      Whois Server: org-test.isc.org
      Referral URL: http://org-test.isc.org
      Name Server: NS3.TLD.ISC.ORG
      Name Server: NS2.TLD.ISC.ORG
      Name Server: NS1.TLD.ISC.ORG

   This data is for testing and validation purposes ONLY
   #

