source: trunk/autoquest-plugin-html/src/main/resources/manuals/parseHTML @ 2069

Parses an HTML log file them into an event sequence and a GUI model.

The parsing process can be parameterized. This allows to replace ids or ignore indexes of GUI elements in the log files. If they are replaced or ignored, the GUI model is more harmonized and GUI elements are considered equal although they are not. This may be helpful, e.g., if you have a table where each row is semantically the same. Without ignoring indexes or ids of the rows, each row is treated separately. But with ignored or replaced indexes or ids, all rows are considered the same.

The parameterization is done in a separate properties file. The keys in the file specify the tags for which either the id shall be replaced or the index shall be ignored. A specification for a simple tag either simply by its name, by its name and index or by its name and id looks as follows:

tagName
tagName[index]
tagName(htmlId\=id)

Furthermore, tags can be specified as paths through the DOM in that several tags specifications are given and concatenated using /. An example with three specified tag (tag1 with index 5, tag 2, and tag 3 with id "id") is the following:

tag1[5]/tag2/tag3(htmlId\=id)

The specification of a tag id may contain the # character to denote a wildcard. This allows matching several GUI elements with similar ids at once and to give them the same id. An example entry of this is:

div(htmlId\=id_number_#)

This line would match all divs with an id starting with "id_number_" where # denotes any character.

It is also possible to specify the document in which the tag path should match. A document is specified by giving a part of the documents path in the URL. After the document specification, the full path to the specified tag must be given. An example is the following:

document(path\=accounts)/html/body/div[0]/ul/li(htmlId\=breadcrumb1)/a

Please note that for specifying the keys, it is required to escape any = sign in the key specification. This is usually required if the path to the denoted GUI elements denotes elements by their id as shown in the example.

To remove the id of a specified tag, the value must be empty. To set the id, the value must be the id the tag shall have. To clear the index of the specified tag, that value must be CLEAR_INDEX. Here are some further example entries:

body/div/div/div/form=
body/p/small/a=imprint-link
document(path\=accounts/login)/html/body/div[0]/div[1]/div[0]/form/p/a=password-reset-link
document(path\=accounts/login)/html/body/div[0]/div[1]/div[0]/form/div/button=CLEAR_INDEX
body/div[5]=date-chooser
div(htmlId\=date-chooser)/div[0]=date-chooser_day

It is also possible to set a new path for a document and to clear queries belonging to the paths of the documents. Examples for this are:

document(path\=/pathToPage/)=CLEAR_QUERY
document(path\=/pathToOtherPath)=new/path
document(path\=/pathTo/Page/withQuery/=CLEAR_QUERY,new/path   (clears the query and changes the path at once

For path specifications, also wild cards are allowed. To denote the end of a path, the $ sign can be used.


$USAGE$

<file>
    path to the file to be parsed 
[<sequenceNames>]
    array of sequences into which the parsed events shall be stored
{-parseParams=path/to/replacementfile}
    used to define id replacements as described in a separate file

Example(s):
parseDirHTML /path/to/file.log
parseDirHTML /path/to/file.log sequences -parseParams=idReplacements.txt