cvs commit: jakarta-commons/latka/doc users-guide.xml

[di...@apache.org]

dion        02/01/27 06:21:54

  Added:       latka/doc users-guide.xml
  Log:
  First cut users guide - not well fleshed out yet
  
  Revision  Changes    Path
  1.1                  jakarta-commons/latka/doc/users-guide.xml
  
  Index: users-guide.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
  
  <!--
      Author:     dIon Gillard
      Version:    $Id: users-guide.xml,v 1.1 2002/01/27 14:21:54 dion Exp $
  -->
  
  <chapter id="users-guide">
      <title>Latka User's Guide</title>
      <!-- taken directly from index.xml -->
      <section>
          <title>What is <firstterm>Latka</firstterm></title>
          <para>Latka is a functional (end-to-end) testing tool. It is implemented
          in Java, and uses an XML syntax to define a series of HTTP (or HTTPS) 
          requests and a set of <firstterm>validations</firstterm> used to verify
          that the request was processed correctly.
          </para>
          <remark>
           Although Latka currently supports only HTTP and HTTPS
           request/response validations, it may be expanded to perform other
           sorts of functional testing as warranted.
          </remark>
          <para>
           A simple example of a Latka XML test suite is shown in our 
           <ulink url="TestCommonsWebsite.xml">sample Latka test suite</ulink>.
           When processed, this example would verify that the Jakarta Commons 
           homepage is present and that all the Commons Components have online
           documenation. 
          </para>
      </section>
      
      <section>
          <title>Running Latka</title>
          <para>A Latka test suite can be run:
              <itemizedlist>
                  <listitem><para>From a command prompt</para></listitem>
                  <listitem><para>From the Latka web application</para></listitem>
                  <listitem><para>From a JUnit TestRunner</para></listitem>
              </itemizedlist>
              <remark>How about an ant task?</remark>
          </para>
          
          <section>
              <title>Running Latka from the command prompt</title>
              <para>There are two scripts (or batch files) shipped with latka:</para>
              <orderedlist>
                  <listitem><para>latka.bat - for Windows machines</para></listitem>
                  <listitem><para>latka.sh - for Unix machines</para></listitem>
              </orderedlist>
              <para>Both of the scripts take the following parameters: </para>
              <orderedlist>
                  <listitem><para></para></listitem>
              </orderedlist>
          </section>
      </section>
      
      <section>
          <title>Anatomy of a test suite</title>
          <para>A Latka test suite is an XML document</para>
      </section>
  </chapter>
  
  
  
  

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>