Return-Path: Delivered-To: apmail-jakarta-commons-dev-archive@apache.org Received: (qmail 29154 invoked from network); 1 Apr 2002 05:54:55 -0000 Received: from unknown (HELO nagoya.betaversion.org) (192.18.49.131) by daedalus.apache.org with SMTP; 1 Apr 2002 05:54:55 -0000 Received: (qmail 7909 invoked by uid 97); 1 Apr 2002 05:54:26 -0000 Delivered-To: qmlist-jakarta-archive-commons-dev@jakarta.apache.org Received: (qmail 7850 invoked by uid 97); 1 Apr 2002 05:54:25 -0000 Mailing-List: contact commons-dev-help@jakarta.apache.org; run by ezmlm Precedence: bulk List-Unsubscribe: List-Subscribe: List-Help: List-Post: List-Id: "Jakarta Commons Developers List" Reply-To: "Jakarta Commons Developers List" Delivered-To: mailing list commons-dev@jakarta.apache.org Received: (qmail 7839 invoked by uid 97); 1 Apr 2002 05:54:24 -0000 Date: 1 Apr 2002 05:54:12 -0000 Message-ID: <20020401055412.60601.qmail@icarus.apache.org> From: dion@apache.org To: jakarta-commons-cvs@apache.org Subject: cvs commit: jakarta-commons/docs/latka developers-guide.html index.html release-plan-1.0.html status.html users-guide.html xml-reference.html X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N dion 02/03/31 21:54:12 Modified: docs/latka developers-guide.html index.html release-plan-1.0.html status.html users-guide.html xml-reference.html Log: Maven generated site changes Revision Changes Path 1.8 +184 -21 jakarta-commons/docs/latka/developers-guide.html Index: developers-guide.html =================================================================== RCS file: /home/cvs/jakarta-commons/docs/latka/developers-guide.html,v retrieving revision 1.7 retrieving revision 1.8 diff -u -r1.7 -r1.8 --- developers-guide.html 29 Mar 2002 13:27:38 -0000 1.7 +++ developers-guide.html 1 Apr 2002 05:54:12 -0000 1.8 @@ -1,23 +1,169 @@ -Latka - Latka Developers's Guide + + + + + + + + + + + + Latka - Latka Developers's Guide + + + + + + +
The Jakarta ProjectCommons - Latka
Latka
Home
User's Guide
XML Reference
Developers Guide
API Docs
CVS
Mailing List
List Bugs
Enter Bug
Download
Latest Release
Nightly Build
Project Files
Status
Original Proposal
License
Jakarta Community
Jakarta Home
Get Involved
Mailing Lists
CVS Repositories
Reference Library
Bugs
Introduction
- -

These are informal notes gathered as I've started working + "/> + + + + + +

+ + + + + + +
+ + +
+
+

Introduction

+

These are informal notes gathered as I've started working on Latka. Hopefully they will make sense to those coming after me, and possibly clarify the current state for the existing

-
Coding Style
- - -

Latka has some unusual coding conventions, which we've hopefully + +

Coding Style

+

Latka has some unusual coding conventions, which we've hopefully captured using a tool, CheckStyle .

- -

Onto the conventions... The Sun coding conventions are followed in +

Onto the conventions... The Sun coding conventions are followed in most places, except for the items that follow

-
    +

    • private and protected member variables begin with an -underscore, 

      _requestSucceeded

      • +underscore, _requestSucceeded

    • private methods also begin with an underscore on rare occasions (mainly when there is some public method and protected/private method with an otherwise identical signature)

      @@ -25,12 +171,10 @@

    • Javadoc on classes and methods is not yet complete. Feel free to help out here :-)

    -
General Practices
- - -

Here are some of the development practices of the Latka team

- -
    + +

    General Practices

    +

    Here are some of the development practices of the Latka team

    +

    • Before committing any changes, run a cvs diff to ensure unexpected changes are not being introduced

      • @@ -51,6 +195,25 @@

    -
- Copyright © 1999-2002, Apache Software Foundation -
\ No newline at end of file + + + + + + +
+ + + + + 1.10 +212 -61 jakarta-commons/docs/latka/index.html Index: index.html =================================================================== RCS file: /home/cvs/jakarta-commons/docs/latka/index.html,v retrieving revision 1.9 retrieving revision 1.10 diff -u -r1.9 -r1.10 --- index.html 25 Mar 2002 22:09:20 -0000 1.9 +++ index.html 1 Apr 2002 05:54:12 -0000 1.10 @@ -1,36 +1,185 @@ -Latka - Latka (Version 1.0 Alpha 2) + + + + + + + + + + + + Latka - Latka (Version 1.0 Alpha 2) + + + + + + + + +
The Jakarta ProjectCommons - Latka
Latka
Home
User's Guide
XML Reference
Developers Guide
API Docs
CVS
Mailing List
List Bugs
Enter Bug
Download
Latest Release
Nightly Build
Project Files
Status
Original Proposal
License
Jakarta Community
Jakarta Home
Get Involved
Mailing Lists
CVS Repositories
Reference Library
Bugs
Other Documentation
- -

See the XML Reference, + "/> + + + + + +

+ + + + + + +
+ + +
+
+

Other Documentation

+

See the XML Reference, User's Guide and API Docs for more detailed information.

-
What is Latka?
- -

+ +

What is Latka?

+

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 validations used to verify that the request was processed correctly.

-

Note: +

Note: Although Latka currently supports only HTTP and HTTPS request/response validations, it may be expanded to perform other sorts of functional testing as warranted.

-

+

A simple example of a Latka XML test suite is shown in our sample Latka test suite. When processed, this example would verify that the Jakarta Commons homepage is present and that all the Commons Components have online documenation.

-
Installing Latka
- -
Requirements
- -
- -
General installation
- -
    + +

    General installation

    +

    1. Download and uncompress the Latka distribution. @@ -60,11 +207,9 @@

    -
- -
Optional web application installation
- -
    + +

    Optional web application installation

    +

    1. Copy the "webapp/latka-webapp.war" file from the distribution to the "webapp" directory of Tomcat.

      @@ -75,15 +220,12 @@ directory of the Latka webapp.

    -
-
Using Latka
- -
Running the sample tests
- - -

Note:Command-line interface

- -
    + + +

    Using Latka

    +

    Running the sample tests

    +

    Note:Command-line interface

    +

    1. Open a command prompt inside the "bin" directory of the distribution.

      @@ -94,10 +236,8 @@

    - -

    Note:Web application

    - -
      +

      Note:Web application

      +

      1. Go to the index page of the Latka web application.

        2. @@ -111,20 +251,16 @@ Click on one of the tests to execute it.

      -
-
Creating your own tests
- -

+ +

Creating your own tests

+

(More to come...) Examine the Latka DTD in the conf directory for a list of all available elements. See the samples for typical syntax.

-
-
Running tests
- - -

Note:Command-line interface

- -
    + +

    Running tests

    +

    Note:Command-line interface

    +

    1. Open a command prompt inside the "bin" directory of the distribution.

      @@ -135,10 +271,8 @@

    - -

    Note:Web application

    - -
      +

      Note:Web application

      +

      1. Go to the index page of the Latka web application.

        2. @@ -149,12 +283,29 @@

      2. Click on one of the tests to execute it.

      -
- -
Creating your custom validations
- -

Note:(More to come...)

-
-
- Copyright © 1999-2002, Apache Software Foundation -
\ No newline at end of file + +

Creating your custom validations

+

Note:(More to come...)

+ + + + + + + +
+ + + + + 1.3 +189 -19 jakarta-commons/docs/latka/release-plan-1.0.html Index: release-plan-1.0.html =================================================================== RCS file: /home/cvs/jakarta-commons/docs/latka/release-plan-1.0.html,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- release-plan-1.0.html 25 Mar 2002 22:09:20 -0000 1.2 +++ release-plan-1.0.html 1 Apr 2002 05:54:12 -0000 1.3 @@ -1,25 +1,176 @@ -Latka - Release Plan for Latka 1.0 + + + + + + + + + + + + Latka - Release Plan for Latka 1.0 + + + + + + + + +
The Jakarta ProjectCommons - Latka
Latka
Home
User's Guide
XML Reference
Developers Guide
API Docs
CVS
Mailing List
List Bugs
Enter Bug
Download
Latest Release
Nightly Build
Project Files
Status
Original Proposal
License
Jakarta Community
Jakarta Home
Get Involved
Mailing Lists
CVS Repositories
Reference Library
Bugs
Administrivia
- -

This document describes a plan for a 1.0 release of the + "/> + + + + + +

+ + + + + + +
+ + +
+
+

Administrivia

+

This document describes a plan for a 1.0 release of the Jakarta-Commons Latka component (for the remainder of this document, simply "Latka").

-

As per the +

As per the Jakarta/ASF guidelines, this document doesn't mean anything until accepted by the relevant committer community via a lazy majority vote (hereafter, simply "lazy majority"). Once accepted, it may be replaced by an alternative plan, again subject to lazy majority approval.

-

Non-binding votes (votes cast by those outside the relevant +

Non-binding votes (votes cast by those outside the relevant committer community) are welcome, but only binding votes are significant for decision making purposes.

-
Objective
-

The objective of the 1.0 release of Latka is to provide a stable + +

Objective

+

The objective of the 1.0 release of Latka is to provide a stable and robust release focused on design clarity, forward compatibility, and ease of use (i.e., with the intention of providing a stable foundation for the further evolution of the Latka component).

-

Specifically, the 1.0 release seeks to +

Specifically, the 1.0 release seeks to introduce and evaluate changes based upon the following (ordered) criteria:

    @@ -33,7 +184,7 @@

-

The 1.0 release should also include: +

The 1.0 release should also include:

  • Adequate documentation (including both API-level/JavaDoc documentation as well documentation suitable for use on the @@ -47,13 +198,13 @@ Versioning Guidelines document

-
Release Manager
- -

dIon Gillard + +

Release Manager

+

dIon Gillard (assuming no one else is really itching to do it)

-
Timeline
- -

(All days ending at 23:59:59 GMT in case of dispute.) + +

Timeline

+

(All days ending at 23:59:59 GMT in case of dispute.)

  • Review Period

    @@ -97,6 +248,25 @@

-
- Copyright © 1999-2002, Apache Software Foundation -
\ No newline at end of file + + + + + + +
+ + + + + 1.9 +200 -33 jakarta-commons/docs/latka/status.html Index: status.html =================================================================== RCS file: /home/cvs/jakarta-commons/docs/latka/status.html,v retrieving revision 1.8 retrieving revision 1.9 diff -u -r1.8 -r1.9 --- status.html 25 Mar 2002 22:09:20 -0000 1.8 +++ status.html 1 Apr 2002 05:54:12 -0000 1.9 @@ -1,23 +1,177 @@ -Latka - Status File for Jakarta Commons "Latka" Application + + + + + + + + + + + + Latka - Status File for Jakarta Commons "Latka" Application + + + + + + + + + + + + + + +
The Jakarta ProjectCommons - Latka
Latka
Home
User's Guide
XML Reference
Developers Guide
API Docs
CVS
Mailing List
List Bugs
Enter Bug
Download
Latest Release
Nightly Build
Project Files
Status
Original Proposal
License
Jakarta Community
Jakarta Home
Get Involved
Mailing Lists
CVS Repositories
Reference Library
Bugs
INTRODUCTION
- + "/> + + + + + + + + + + + + +
+ + +
+
+

INTRODUCTION

+

Testing websites is a pain. Many regression tests for a website can be verified automatically, speeding up the quality assurance process and allowing the engineers to focus on the more important issues. Additionally developers may want to monitor their development, QA and production environment, so that they can be sure that everything is running as they expect.

- -

Latka is an HTTP functional testing suite for automated QA, acceptance and +

Latka is an HTTP functional testing suite for automated QA, acceptance and regression testing. Latka suites are XML documents, which can be written and/or modified without writing Java code. Latka tests can be created quickly and modified easily, even by engineers without Java experience.

-
2. DEPENDENCIES
- -

Latka relies on:

-
    + +

    2. DEPENDENCIES

    +

    Latka relies on:

    +

    • Java Development Kit (Version 1.3 or later)

    • A JAXP 1.1 implementation

    • A SAX 2.0 parser conforming to the JAXP 1.1 APIs

      • @@ -29,32 +183,29 @@

    • Jakarta-Regexp - regular expression tests and XML preprocessing (for variable support)

    • JDOM - for building XML reports

    -
3. RELEASE INFO
- - -

Current Release: + +

3. RELEASE INFO

+

Current Release: 1.0 alpha 1

-

Planned Next Release: 1.0, timeframe: None defined

-
4. COMMITTERS
- +

Planned Next Release: 1.0, timeframe: None defined

-

The following individuals are the primary developers and +

4. COMMITTERS

+

The following individuals are the primary developers and maintainers of this component. Developers who plan to use Latka in their own projects are encouraged to collaborate on the future development of this component to ensure that it continues to meet a variety of needs.

-
    +

    • Morgan Delagrange

    • Doug Sale

    • Rodney Waldhoff

    • Jeff Turner (part-time)

    • dIon Gillard

    -
5. DEVELOPMENT STATUS
- - -

Latka development status:

-
    + +

    5. DEVELOPMENT STATUS

    +

    Latka development status:

    +

    • Latka 1.0 Alpha 1 released

    • Latka library and command line interface:

      Fully functional, but with potential interface changes @@ -64,11 +215,8 @@

    • Latka web application (in Commons Sandbox):

      Experimental, promising but unstable.

    - -
    Todo items:
    - - -
      +

      Todo items:

      +

      • Add a universal mechanism for negating validators. Currently regexp and xpath validators implement negation internally as a special cond attribute. This adds somewhat to the @@ -93,7 +241,26 @@

      • Add XMLValidate tasks to the build file so that any XML doc with a DTD is checked before used

      -
    -
- Copyright © 1999-2002, Apache Software Foundation -
\ No newline at end of file + + + + + + + +
+ + + + + 1.9 +234 -55 jakarta-commons/docs/latka/users-guide.html Index: users-guide.html =================================================================== RCS file: /home/cvs/jakarta-commons/docs/latka/users-guide.html,v retrieving revision 1.8 retrieving revision 1.9 diff -u -r1.8 -r1.9 --- users-guide.html 25 Mar 2002 22:09:20 -0000 1.8 +++ users-guide.html 1 Apr 2002 05:54:12 -0000 1.9 @@ -1,27 +1,175 @@ -Latka - Latka User's Guide + + + + + + + + + + + + Latka - Latka User's Guide + + + + + + +
The Jakarta ProjectCommons - Latka
Latka
Home
User's Guide
XML Reference
Developers Guide
API Docs
CVS
Mailing List
List Bugs
Enter Bug
Download
Latest Release
Nightly Build
Project Files
Status
Original Proposal
License
Jakarta Community
Jakarta Home
Get Involved
Mailing Lists
CVS Repositories
Reference Library
Bugs
What is Latka
- -

Latka is a functional (end-to-end) testing tool. It is implemented + "/> + + + + + +

+ + + + + + +
+ + +
+
+

What is Latka

+

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 validations used to verify that the request was processed correctly.

-

Note: +

Note: Although Latka currently supports only HTTP and HTTPS request/response validations, it may be expanded to perform other sorts of functional testing as warranted.

-

+

A simple example of a Latka XML test suite is shown in our sample Latka test suite. When processed, this example would verify that the Jakarta Commons homepage is present and that all the Commons Components have online documenation.

-
Running Latka
- -

A Latka test suite can be run: + +

Running Latka

+

A Latka test suite can be run:

  • From a command prompt

  • From the Latka web application

    • @@ -30,52 +178,68 @@

    Note:To run Latka as an ant task, we suggest you use the JUnit support of ant and write a small test case to invoke Latka, as discussed later

    - -
    Running Latka from the command prompt
    - -

    There are two scripts (or batch files) shipped with latka: + +

    Running Latka from the command prompt

    +

    There are two scripts (or batch files) shipped with latka:

    1. latka.bat - for Windows machines

    2. latka.sh - for Unix machines

    -

    Both of the scripts take the following parameters:

    -
      +

      Both of the scripts take the following parameters:

      +

      1. a test suite URL, e.g. -

        file:./TestCommonsWebsite.xml
        or -
        http://jakarta.apache.org/commons/latka/TestCommonsWebsite.xml
        +file:./TestCommonsWebsite.xml or +http://jakarta.apache.org/commons/latka/TestCommonsWebsite.xml

      2. Optionally properties files of Latka options -can be specified using the propfile parameter: 

        propfile:<file name>
        +can be specified using the propfile parameter: propfile:<file name>

      3. Optionally individual Latka options may be specified -using the prop parameter: 

        prop:<prop name>=<prop value>
        +using the prop parameter: prop:<prop name>=<prop value>

      - -

      For more information about what properties you can pass to +

      For more information about what properties you can pass to Latka, please see the Latka Properties definition

      -
    - -
    Running Latka from a web application (Under Construction)
    - -

    The Latka release distribution comes with a web application + + +

    Running Latka from a web application (Under Construction)

    +

    The Latka release distribution comes with a web application (latka-webapp.war) ready to deploy on a conforming Servlet 2.2/ JSP 1.1 container.

    -

    For example, to install the Latka web application into a +

    For example, to install the Latka web application into a Tomcat 4 server, simply copy the .war file to Tomcat's webapp directory, e.g.

    -
    [Win32] copy latka-webapp.war c:\tomcat4\webapps
    +
    + + + + +
    +

    + 

    [Win32] copy latka-webapp.war c:\tomcat4\webapps
    +
    +

    or

    -
    [Unix] cp latka-webapp.war /usr/java/jtomcat4/webapps
    +
    + + + + +
    +

    + 

    [Unix] cp latka-webapp.war /usr/java/jtomcat4/webapps
    +
    +

    and restart Tomcat

    -

    Using the Latka Web App
    + +

    Using the Latka Web App

    Once you've gotten the Latka web app running, it's straightforward to use. You can either @@ -84,47 +248,62 @@

    -
    - -
    Running Latka as a JUnit Test Case
    - -

    Here's hoping you're familiar with JUnit

    -

    Latka ships with a class JUnitTestAdapter + + +

    Running Latka as a JUnit Test Case

    +

    Here's hoping you're familiar with JUnit

    +

    Latka ships with a class JUnitTestAdapter that bridges Latka and JUnit. You can use this class to create JUnit Tests from Latka's XML documents. For example, calling -

    JUnitTestAdapter.createTestFromFile(fileName)
    +JUnitTestAdapter.createTestFromFile(fileName) with a valid Latka XML document's file name will return you back a JUnit Test, ready to be added to a TestCase.

    -

    So, essentially you code a JUnit TestCase, and in the +

    So, essentially you code a JUnit TestCase, and in the suite method, you add the Tests created by JUnitTestAdapter to the JUnit TestSuite. -

      +
       public static Test suite() {
           TestSuite suite = new TestSuite();
           String fileName = "tests/samples/TestCommonsWebsite.xml";
           suite.addTest(JUnitTestAdapter.createTestFromFile(fileName));
           return suite;
       }
  -
    +

    -

    Once you have Latka's suite as a JUnit TestSuite, you can run it +

    Once you have Latka's suite as a JUnit TestSuite, you can run it using any JUnit TestRunner to execute the suite, including those shipped with ant.

    -
    -
Anatomy of a test suite (Under Construction)
- - -

For a reference of the XML tags that can + + +

Anatomy of a test suite (Under Construction)

+

For a reference of the XML tags that can possibly be used in developing latka test suites, see The XML Reference

- -

A Latka test suite is an XML document with a top level element +

A Latka test suite is an XML document with a top level element of suite

-
Latka Properties (Under Construction)
- - -

Definitive list of properties and their meanings...

-
- Copyright © 1999-2002, Apache Software Foundation -
\ No newline at end of file + +

Latka Properties (Under Construction)

+

Definitive list of properties and their meanings...

+ + + + + + +
+ + + + + 1.9 +461 -340 jakarta-commons/docs/latka/xml-reference.html Index: xml-reference.html =================================================================== RCS file: /home/cvs/jakarta-commons/docs/latka/xml-reference.html,v retrieving revision 1.8 retrieving revision 1.9 diff -u -r1.8 -r1.9 --- xml-reference.html 25 Mar 2002 22:09:20 -0000 1.8 +++ xml-reference.html 1 Apr 2002 05:54:12 -0000 1.9 @@ -1,66 +1,214 @@ -Latka - Latka XML Reference + + + + + + + + + + + + Latka - Latka XML Reference + + + + + + + + +
The Jakarta ProjectCommons - Latka
Latka
Home
User's Guide
XML Reference
Developers Guide
API Docs
CVS
Mailing List
List Bugs
Enter Bug
Download
Latest Release
Nightly Build
Project Files
Status
Original Proposal
License
Jakarta Community
Jakarta Home
Get Involved
Mailing Lists
CVS Repositories
Reference Library
Bugs
Latka XML Reference
+ "/> + + - -
byteLength
- -

+ +

+ + + + + + +
+ + +
+
+

Latka XML Reference

+ +

byteLength

+

validates the length of an HTTP(S) response

-

DTD
+

DTD
- 

<!ELEMENT byteLength EMPTY>
  +            <!ELEMENT byteLength EMPTY>
   <!ATTLIST byteLength min   CDATA "0"
                        max   CDATA #IMPLIED
  -                     label CDATA #IMPLIED>
+ label CDATA #IMPLIED>

-

Attributes
+

Attributes
- + - - - - + + + + - - - - + + + + - - - - + + + +
NameTypeDefaultDescription
NameTypeDefaultDescription
minNUMBER0 + minNUMBER0 Minimum number of bytes required for a valid response. Implied. Defaults to 0. -
maxNUMBERnone + maxNUMBERnone Maximum number of bytes required for a valid response. Optional. When absent, there is no upper limit on the number of bytes in a valid response. -
labelCDATAnone + labelCDATAnone Label associated with this validation, which may be used in programatically generated documentation or reports. Optional. -

-

Parents
+

Parents

-

Description
+

Description

A byteLength validation @@ -70,63 +218,61 @@ max bytes long.

-
- -
cookie
- -

+ +

cookie

+

validates the presence of an HTTP(S) cookie in a response

-

DTD
+

DTD
- 

<!ELEMENT cookie EMPTY>
  +            <!ELEMENT cookie EMPTY>
   <!ATTLIST cookie name  CDATA #REQUIRED
                    value CDATA #IMPLIED
  -                 label CDATA #IMPLIED>
+ label CDATA #IMPLIED>

-

Attributes
+

Attributes
- + - - - - + + + + - - - - + + + + - - - - + + + +
NameTypeDefaultDescription
NameTypeDefaultDescription
nameCDATAnone, but required + nameCDATAnone, but required The name of the cookie to look for. Required. -
valueCDATAnone, optional + valueCDATAnone, optional The value that the cookie with the specified name should have (if any). -
labelCDATAnone + labelCDATAnone Label associated with this validation, which may be used in programatically generated documentation or reports. Optional. -

-

Parents
+

Parents

-

Description
+

Description

A cookie validation @@ -136,99 +282,95 @@ the cookie must also have the specified value.

-
- -
credentials
- -

+ +

credentials

+

username/password credentials for Basic HTTP authentication.

-

DTD
+

DTD
- 

<!ELEMENT credentials EMPTY>
  +            <!ELEMENT credentials EMPTY>
   <!ATTLIST credentials userName CDATA #REQUIRED
  -                      password  CDATA #REQUIRED>
+ password CDATA #REQUIRED>

-

Attributes
+

Attributes
- + - - - - + + + + - - - - + + + +
NameTypeDefaultDescription
NameTypeDefaultDescription
userNameCDATAnone, requiredUser name. Required.userNameCDATAnone, requiredUser name. Required.
passwordCDATAnone, requiredPassword. Required.passwordCDATAnone, requiredPassword. Required.

-

Parents
+

Parents

-

Description
+

Description

Contains credentials for HTTP Basic Authentication.

-
- -
maxRequestTime
- -

validates the response time for an HTTP(S) request

-

DTD
+ +

maxRequestTime

+

validates the response time for an HTTP(S) request

+

DTD
- 

<!ELEMENT maxRequestTime EMPTY>
  +            <!ELEMENT maxRequestTime EMPTY>
   <!ATTLIST maxRequestTime millis CDATA "30000"
  -                           message  CDATA #IMPLIED>
+ message CDATA #IMPLIED>

-

Attributes
+

Attributes
- + - - - - + + + + - - - - + + + +
NameTypeDefaultDescription
NameTypeDefaultDescription
millisNUMBER30000 + millisNUMBER30000 Maximum amount of time, in milliseconds, in which a response must be returned to be considered a valid response. Implied. Defaults to 30000 milliseconds, or 30 seconds. -
labelCDATAnone + labelCDATAnone Label associated with this validation, which may be used in programatically generated documentation or reports. Optional. -

-

Parents
+

Parents

-

Description
+

Description

A maxRequestTime validation @@ -236,175 +378,167 @@ millis milliseconds.

-
- -
param
- -

indicates a request parameter as part of an HTTP(S) request to be executed

-

DTD
+ +

param

+

indicates a request parameter as part of an HTTP(S) request to be executed

+

DTD
- 

<!ELEMENT request (paramName, paramValue)>
+ <!ELEMENT request (paramName, paramValue)>

-

Attributes
+

Attributes

None.

-

Parents
+

Parents

-

Description
+

Description

A parameter to be submitted as part of a request.

-
- -
paramName
- -

the name part of a name/value pair parameter

-

DTD
+ +

paramName

+

the name part of a name/value pair parameter

+

DTD
- 

<!ELEMENT paramName (#PCDATA)>
+ <!ELEMENT paramName (#PCDATA)>

-

Attributes
+

Attributes

None.

-

Parents
+

Parents

-

Description
+

Description

The name part of param to be submitted as part of a request.

-
- -
paramValue
- -

the value part of a name/value pair parameter

-

DTD
+ +

paramValue

+

the value part of a name/value pair parameter

+

DTD
- 

<!ELEMENT paramValue (#PCDATA)>
+ <!ELEMENT paramValue (#PCDATA)>

-

Attributes
+

Attributes

None.

-

Parents
+

Parents

-

Description
+

Description

The value part of param to be submitted as part of a request.

-
- -
regexp
- -

+ +

regexp

+

validates the presence or absence of a regular expression within an HTTP(S) response

-

DTD
+

DTD
- 

<!ELEMENT regexp EMPTY>
  +            <!ELEMENT regexp EMPTY>
   <!ATTLIST regexp pattern    CDATA          #REQUIRED
                    cond       (true | false) "true"
                    ignoreCase (true | false) "false"
  -                 label       CDATA         #IMPLIED>
+ label CDATA #IMPLIED>

-

Attributes
+

Attributes
- + - - - - + + + + - - + - - + + + - - + - - + + + - - - - + + + +
NameTypeDefaultDescription
NameTypeDefaultDescription
patternCDATAnone, but required. + patternCDATAnone, but required. The regular expression to look for. -
cond + cond Enumeration:
  • true
  • false
- 		true + true When true, the given pattern must match within the response. When false, the given pattern must not match within the response. -
ignoreCase + ignoreCase Enumeration:
  • true
  • false
- 		false + false When true, case is ignored within the given pattern. -
labelCDATAnone + labelCDATAnone Label associated with this validation, which may be used in programatically generated documentation or reports. Optional. -

-

Parents
+

Parents

-

Description
+

Description

A maxRequestTime validation @@ -412,143 +546,133 @@ millis milliseconds.

-
- -
request
- - - -

indicates an HTTP(S) request to be executed

- -

DTD
+ +

request

+

indicates an HTTP(S) request to be executed

+

DTD
- 

<!ELEMENT request (credentials?, param*, validate?)>
  +            <!ELEMENT request (credentials?, param*, validate?)>
   <!ATTLIST request path   CDATA        #REQUIRED
                        method (post | get) "get"
                        host   CDATA        #IMPLIED
                        port   CDATA        #IMPLIED
  -                     label  CDATA        #IMPLIED>
+ label CDATA #IMPLIED>

-

Attributes
+

Attributes

- + - - - - + + + + - - + - - + + + - - - - + + + + - - - - + + + + - - - - + + + +
NameTypeDefaultDescription
NameTypeDefaultDescription
pathCDATAnone, but requiredRequest path. Required.pathCDATAnone, but requiredRequest path. Required.
method + method enumeration:
  • get
  • post
- 		getHTTP method. Implied. Defaults to get.getHTTP method. Implied. Defaults to get.
hostCDATAnone + hostCDATAnone Host to submit request to. Optional. When absent, uses default from suite. -
portNUMBERdepends upon protocol + portNUMBERdepends upon protocol Port to submit request to. Optional. When absent, uses default from suite. -
labelCDATAnone + labelCDATAnone Label associated with this validation, which may be used in programatically generated documentation or reports. Optional. -

-

Parents
+

Parents

-

Description
+

Description

An HTTP(S) request to be executed.

-
- - -
session
- - - -

wrapper for a sequence of requests associated with the same state (session)

-

DTD
+ +

session

+

wrapper for a sequence of requests associated with the same state (session)

+

DTD
- 

<!ELEMENT session (request+)>
  +            <!ELEMENT session (request+)>
   <!ATTLIST session sessionId CDATA #IMPLIED
  -                     label      CDATA #IMPLIED>
+ label CDATA #IMPLIED>

-

Attributes
+

Attributes
- + - - - - + + + + - - - - + + + +
NameTypeDefaultDescription
NameTypeDefaultDescription
sessionIdCDATAnone + sessionIdCDATAnone Unique identifier for this session. Sessions with the same sessionId will share the same underlying state (e.g., cookies, etc.) -
labelCDATAnone + labelCDATAnone Label associated with this session, which may be used in programatically generated documentation or reports. Optional. -

-

Parents
+

Parents

-

Description
+

Description

A session is a collection of @@ -560,55 +684,50 @@ requests.

-
- - -
statusCode
- - -

validates an HTTP response code

- -

DTD
+ +

statusCode

+

validates an HTTP response code

+

DTD
- 

<!ELEMENT statusCode EMPTY>
  +            <!ELEMENT statusCode EMPTY>
   <!ATTLIST statusCode code  CDATA "200"
  -                      label CDATA #IMPLIED>
+ label CDATA #IMPLIED>

-

Attributes
+

Attributes
- + - - - - + + + + - - - - + + + +
NameTypeDefaultDescription
NameTypeDefaultDescription
codeNUMBER200 + codeNUMBER200 Numeric HTTP response code to expect. Implied. Defaults to 200. -
labelCDATAnone + labelCDATAnone Label associated with this validation, which may be used in programatically generated documentation or reports. Optional. -

-

Parents
+

Parents

-

Description
+

Description

A statusCode validation @@ -617,62 +736,57 @@ code.

-
- - -
suite
- - -

root element for a suite of tests

- -

DTD
+ +

suite

+

root element for a suite of tests

+

DTD
- 

<!ELEMENT suite ( (session | request)+ )>
  +            <!ELEMENT suite ( (session | request)+ )>
   <!ATTLIST suite defaultHost CDATA #IMPLIED
                      defaultPort CDATA #IMPLIED
  -                   label        CDATA #IMPLIED>
+ label CDATA #IMPLIED>

-

Attributes
+

Attributes
- + - - - - + + + + - - - - + + + + - - - - + + + +
NameTypeDefaultDescription
NameTypeDefaultDescription
defaultHostCDATAnone + defaultHostCDATAnone Default hostname for requests. Optional. -
defaultPortNUMBERnone + defaultPortNUMBERnone Default port for requests. Optional. -
labelCDATAnone + labelCDATAnone Label associated with this suite, which may be used in programatically generated documentation or reports. Optional. -

-

Parents
+

Parents

None.

-

Description
+

Description

A suite is a collection of @@ -681,36 +795,30 @@ to execute.

-
- - - -
validate
- - -

+ +

validate

+

indicates the suite of validations to apply to the current request (and its response)

- -

DTD
+

DTD
- 

<!ELEMENT validate (byteLength | cookie | maxRequestTime | regexp | statusCode | xpath )+>
+ <!ELEMENT validate (byteLength | cookie | maxRequestTime | regexp | statusCode | xpath )+>

-

Attributes
+

Attributes

None.

-

Parents
+

Parents

-

Description
+

Description

Contains the set of validations to apply to the @@ -718,102 +826,115 @@ (and its response).

-
- -
xpath
- - -

+ +

xpath

+

xpath - assuming the HTTP(s) response contains XML, checks if an XPath expression matches

- - -

DTD
+

DTD
- 

<!ELEMENT xpath EMPTY>
  +            <!ELEMENT xpath EMPTY>
   <!ATTLIST xpath select    CDATA          #REQUIRED
                      cond       (true | false) "true"
                      value     CDATA          #IMPLIED
  -                   label     CDATA          #IMPLIED>
+ label CDATA #IMPLIED>

- -

Attributes
+

Attributes
- + - - - - + + + + - - + - + - + + - - + - + - + + - - + - + - + +
NameTypeDefaultDescription
NameTypeDefaultDescription
selectCDATAnone + selectCDATAnone An XPath expression, designed to match a node in the XML body of the response. -
cond + cond Enumeration:
  • true
  • false
- 		+ true - + When true, the given XPath expression must match within the response. When false, the given XPath expression must not match within the response. -
value + value CDATA - + none, optional - + The value that the matched node should have, if any. -
label + label CDATA - + none - + Label associated with this validation, which may be used in programatically generated documentation or reports. Optional. -

-

Parents
+

Parents

-

Description
+

Description

A xpath validation passes if the HTTP(S) response body contains XML, and the specified XPath expression matches (or not, depending on cond)

-
-
- Copyright © 1999-2002, Apache Software Foundation -
\ No newline at end of file + + + + + + + +
+ + + + + -- To unsubscribe, e-mail: For additional commands, e-mail: