Tough Day tough-day

What is Tough Day 2 what-is-tough-day

Tough Day 2 is a an application that allows you to stress test the limits of your AEM instance. It can be run out of the box with the default test suite or it can be configured to fit your testing needs. You can watch this recording for a presentation of the application.

How to run Tough Day 2 how-to-run-tough-day

Download the latest version of Tough Day 2 from the Adobe Repository. After you download the application, you can run it out of the box by providing the host parameter. In the following example, the AEM instance runs locally so the localhost value is used:

java -jar toughday2.jar --host=localhost

The default suite that runs after adding the parameters is named toughday. It contains the following use cases:

The suite contains 15% write actions and 85% read actions.

To run the suite tests, Tough Day 2 will install its default content package. This can be avoided by setting the installsamplecontent parameter to false, but remember that you should also change the default paths for the tests that you intend to run. If the jar is run without parameters, Tough Day 2 displays the help information.

As a general rule, you can use the application by following this pattern:

java -jar toughday2.jar [--help | --help_full | --help_tests | --help_publish]  [<global arguments> | <actions> | --runmode | --publishmode]

Getting Help getting-help

Tough Day 2 offers a wide range of help options that can be accessed from the command line. For example:

java -jar toughday2.jar --help_full

In the table below, you can find the relevant help parameters.

Global Parameters global-parameters

Tough Day 2 offers global parameters that set or change the environment for the tests. These include the host that is targeted, the port number, the protocol used, user and password for the instance and many more. For example:

java -jar toughday2.jar --host=host --protocol=https --port=4502 --duration=30m --dryrun=true

You can find the relevant parameters in the list bellow:

Customizing customizing

Customization can be achieved in two ways: command line parameters or yaml configuration files. Configuration files are generally used for large custom suites and they will override the Tough Day 2 default parameters. Command line parameters override both configuration files and the default parameters.

The only way to save a test configuration is to copy it in yaml format. For additional details, see this toughday.yaml configuration and the yaml configuration examples in the sections below.

Adding a New Test adding-a-new-test

If you do not want to use the default toughday suite you can add a test of your choosing by using the add parameter. The examples below show how to add the CreateAssetTreeTest test either by using command line parameters or a yaml configuration file.

By using command line parameters:

java -jar toughday2.jar --host=localhost --add CreateAssetTreeTest

By using a yaml configuration file:

globals:
  host : localhost
tests:
  - add : CreateAssetTreeTest

Adding Multiple Instances of the Same Test adding-multiple-instances-of-the-same-test

You can also add and run multiple instances of the same test, but each instance must have an unique name. The examples below show how to add two instances of the same test either by using command line parameters or a yaml configuration file.

By using command line parameters:

java -jar toughday2.jar --host=localhost --add CreateAssetTreeTest name=FirstAssetTree --add CreateAssetTreeTest name=SecondAssetTree

By using a yaml configuration file:

globals:
  host : localhost
tests:
  - add : CreateAssetTreeTest
    properties:
      name : FirstAssetTree
  - add : CreateAssetTreeTest
    properties:
      name : SecondAssetTree

Changing the Test Properties changing-the-test-properties

In case you need to change one or more of the test properties, you can add that property to the command line or the yaml configuration file. To see all the available test properties add the --help <TestClass/PublisherClass> parameter to the command line, for example:

java -jar toughday2.jar --help CreatePageTreeTest

Please keep in mind that yaml configuration files will overwrite the Tough Day 2 default parameters and command line parameters will override both the configuration files and the defaults.

The examples below show how to change the template property for the CreatePageTreeTest test either by using either command line parameters or a yaml configuration file.

By using command line parameters:

java -jar toughday2.jar --host=localhost --add CreatePageTreeTest template=/conf/toughday-templates/settings/wcm/templates/toughday-template

By using a yaml configuration file:

globals:
  host : localhost
tests:
  - add : CreatePageTreeTest
    properties:
      template : /conf/toughday-templates/settings/wcm/templates/toughday-template

Working with Predefined Test Suites working-with-predefined-test-suites

The examples below show how to add a test to a predefined suite and how to reconfigure and exclude an existing test from a predefined suite.

You can add a new test to a predefined suite using the add parameter and specifying the targeted predefined suite.

By using command line parameters:

java -jar toughday2.jar --host=localhost --suite=toughday --add CreatePageTreeTest

By using a yaml configuration file:

globals:
  host : localhost
  suite : toughday
tests:
  - add : CreatePageTreeTest

Existing tests in a given suite can also be reconfigured using the config* *parameter. Please note that you must also specify the suite name and the actual name of the test (not the Test Class name). You can find the test name in the name property of the Test Class. For further details on how to find test properties, read the Changing Test Properties section.

In the example below the default asset title for the CreatePageTreeTest (named UploadAsset) is changed to “NewAsset”.

By using command line parameters:

java -jar toughday2.jar --host=localhost --suite=toughday --config UploadAsset title=NewAsset

By using a yaml configuration file:

globals:
  host : localhost
  suite : toughday
tests:
  - config : UploadAsset
    properties :
      title : NewAsset

Aditionally, you can also remove tests from predefined suites or publishers from the default configuration with the use of the exclude parameter. Please note that you must also specify the suite name and the actual name of the test (not the Test C lass name). You can find the test name in the name property of the test class. In the example below, the CreatePageTreeTest (named UploadAsset) test is removed from the toughday suite.

By using command line parameters:

java -jar toughday2.jar --host=localhost --suite=toughday --exclude UploadAsset

By using a yaml configuration file:

globals:
  host : localhost
  suite : toughday
tests:
  - exclude : UploadAsset

Run Modes run-modes

Tough Day 2 can run in one of the following modes: normal and constant load.

The normal run mode has two parameters:

The example below shows how to add the parameters by using either the command line:

java -jar toughday2.jar --host=localhost --add CreateAssetTreeTest --runmode=normal concurrency=20

or by using a yaml configuration file:

runmode:
  type : normal
  waittime : 300
  concurrency : 200

The constant load run mode differs from the normal run mode by generating a constant number of started test executions, rather than a constant number of threads. You can set the load by using the run mode parameter with the same name.

Test Selection test-selection

The test selection process is the same for both run modes and it goes as follows: all tests have a weight property, which determines the likelihood of execution in a thread. For example, if we have two tests, one with a weight of 5 and the other with a weight of 10, the latter is two times more likely to be executed than the former.

Furthermore, tests can have a count property, which limits the number of executions to a given number. After this number is passed, no further executions of the test will occur. All test instances that are already running will finish the run as configured. The following example shows how to add these parameters either at the command line or by using a yaml configuration file.

java -jar toughday2.jar --host=localhost --add CreateAssetTreeTest weight=5 --add CreatePageTreeTest weight=10 count=100 --runmode=normal concurrency=20

or

- add : CreateAssetTreeTest
    properties :
      name : UploadAsset
      weight : 5
      base : 3
      foldertitle : IAmAFolder
      assettitle : IAmAnAsset
      count : 100

Dry Run dry-run

A dry run parses all the given input (command line parameters or config files), merging it with the defaults and then outputs the results. It does not execute any of the tests.

java -jar toughday2.jar --host=localhost --suite=toughday --add CreatePageTreeTest --dryrun=true

Output output

Tough Day 2 outputs both test metrics and logs. For further details, read the following sections.

Test Metrics test-metrics

Tough Day 2 currently reports 9 test metrics that you can evaluate. Metrics with the * symbol are reported only after successful runs:

These metrics are written with the help of publishers that can be added with the add parameter (similarly to adding tests). Currently, there are two options:

By default, both publishers are enabled.

Additionally, there are two modes in which the metrics are reported:

The following example shows how to configure the intervals parameter either at the command line or by using a yaml configuration file.

By using command line parameters:

java -jar toughday2.jar --host=localhost --add CreatePageTreeTest --publishmode type=intervals interval=10s

By using a yaml configuration file:

publishmode:
     type : intervals
     interval : 10s
     tests:
        -add : CreatePageTreeTest

Logging logging

Tough Day 2 creates a logs folder in the same directory where you ran Tough Day 2. This folder contains two types of logs:

The logs are not overwritten, subsequent runs will append messages to the existing logs. The logs have several levels, for more information see the [loglevel parameter](/docs/experience-manager-64/developing/testing/tough-day.md#global-parameters).