Labeling of Transactions, Actions, and Requests

[rschwietzke]

Goal

We want to label transactions, actions, and requests. So we can group these better. See https://training.xceptance.com/qa-and-test/050-performance-rating-system-devtest-leeds-2019.html#/14 for an example of categories (homepage, catalog, cart, account, checkout, place order).

• These labels have to be part of the testreport XML and later HTML.
• For performance reasons, this labeling has to happen when all data was collected because it does not merge or split data, just "stamps" it.
• A label can be any string, such as homepage, #test, F17, Foo Bar or even an emulated double label, such as "homepage, B2C" (w/o the quotes of course). Barely any limits on what characters are possible.

Non-Goal

We would rather not have the full freedom yet to grab data from the evaluation and move it into the label. This is a very static approach.

Examples

• Transactions: transactional, registered
• Actions: catalog, cart, checkout, homepage
• Requests: catalog, cart, checkout, homepage

Non-Goal

We would rather not add multiple labels at the moment, so we don't think tags here.

Requirements

Report

All label information has to be part of the output XML so the reporting can later on incorporate it as well as the upcoming evaluation module.

The transaction, action, and the request table in the section of the report will get a new column "Label" (next to name) which supports sorting and filtering similarly to "Name".

One should be able to filter one column and later the other. We imagine two input fields here so it is clear where you filter, and we don't introduce any special syntax for the filters by that (this is lower prio and can be moved into a future release).

When there is no label attached, the cell or column stays empty.

Definition

The test suite gets new properties for the labeling. We will use a similar concept to merge and Apdex rules.

com.xceptance.xlt.reportgenerator.label.1.matching.name = .*Homepage$
com.xceptance.xlt.reportgenerator.label.1.matching.name.exclude = ^Goto.*
#com.xceptance.xlt.reportgenerator.label.1.matching.label = ordering
#com.xceptance.xlt.reportgenerator.label.1.matching.label.exclude = bathtub.*
com.xceptance.xlt.reportgenerator.label.1.label = Homepage
com.xceptance.xlt.reportgenerator.label.1.stopOnMatch = false

• Matching: We match against the name and label only. One or the other has to be given, if both have to be given, we run an AND operation across all matching types.
• Exclude: gives us the ability to specify things to negate against in case our regexp cannot cover that.
• stopOnMatch: Allows us to stop match rule processing for that name if needed, this will simplify rule setup
• Label: The label to apply. This is just a string, so anything is permitted here.

Rules are processed in order (1, 2, ...) and you can have holes in the list (similar to mergerules) and you don't have to start with 1 or have an upper limit (well.. Integer.MAX is the limit, kind of).

When

Labeling takes place after merge rule processing, so labeling can efficiently cache many evaluations and does not have to perform it again. Ensure that this is per thread to avoid contention (similar to merge rules).

More

See #508

[jowerner]

Labeling rules are similar to merge rules, so applied the same mechanism here. Also reused the rule configuration syntax.