SuiteStructure

Suite Structure

test

This tag is definition of the single test in test suite. Test suite can contain many tests.

Attribute name	Description	Mandatory
name	Name of the test. Should consists only of letters, digits and/or characters: -, _. This value is also presented on report (more details in Suite Report section).	yes
useProxy	Defines which (if any) Proxy should be used during collection phase. If not provided or empty, proxy won't be used. If set to "rest" Rest Manager will be used. Otherwise Proxy Manager with provided name will be used (see Proxy). Proxy is needed by Status Codes Collector and Header Modifier.	no

Each test element contains:

• one collect and one compare element - test execution phases,
• one urls element - list of urls to process.

Proxy

Web proxy is required for some of the AET features:

• Status codes
• Header modifier
• Client-side performance (beta)

AET proxy is currently provided by BrowserMob Proxy .

rest

Rest proxy requires standalone Browsermob server. See Linux and Windows Setup for more details. This proxy is used when useProxy is set to "rest" in the test configuration (see the example below).

Example usage

<?xml version="1.0" encoding="UTF-8" ?>
<suite name="test-suite" company="cognifide" project="project">
    <test name="header-modify-test" useProxy="rest">
      ...
    </test>
    ...
</suite>

collect

This tag contain list of collectors and modifiers which will be run. It specifies what pages' data should be collected and it allows for some data modification before collection step. All collect steps are processed in defined order.

Each collector provides some specific result of gathering current data (i.e. png, html files) and a common metadata file - result.json.

Following elements are available in collect element:

• Open
• Collectors
• Modifiers

compare

This tag contain list of Comparators. Each comparator takes collected resource of defined type and runs it against comparator. It provides some specific result files illustrating found differences (i.e png, html files) and a common metadata file - result.json.

Each resource type has default comparator, user can use other comparators for each type by providing attribute comparator with comparator name, e.g.:

<source comparator="my_source_comparator"/>

runs my_source_comparator against each source collected during collection phase. Each comparator can contain list of Data Filters which will be performed before each compare phase.

Data filters are used to modify gathered data before these data are passed to comparator. For example you may remove some node from html tree. Data filters are defined in test suite xml as subnodes of comparator node.

Each Data Filter has predefined type of data on which it operates.

urls

See Urls.