close method

Class: BatchClosePlatform: Selenium 3Language: Python SDK:

Close the batches whose batch IDs were passed to BatchClose.set_batch_ids.

Introduction

The Test Manager displays test results in batches. The article Grouping tests into batches with the SDK explains how tests are associated with batches based on a batch ID, and how you can use the SDK to control which tests will be part of a particular batch.

Here, we will focus on understanding the notions of an active batch and closing a batch.

A batch is created and becomes active when a test is started with a batch ID that does not match an existing active batch. As long as a batch is active, new tests that have a matching batch ID will be added to the batch.

Batches are closed automatically in one of two ways. By default, runner-based SDKs implement the Auto batch closure feature. This feature closes the batches associated with the runner's test after the tests have completed. In addition, in order to prevent large batches that could cause performance issues, the Eyes server closes active batches that have not been used for several hours, or if they have been in continuous use for more than a few days.

When a batch is closed, the Eyes server can send the user a batch completion notification. This feature must be enabled explicitly, see Batch completion notifications for details.

You can manage Auto batch closure by:

Syntax

obj.close()

Parameters

This method does not take any parameters.

Return value

Type:

Example

Disable automatic closing of batches by setting the environment variable APPLITOOLS_DONT_CLOSE_BATCHES to a true value.

The example below illustrates:

  • How to manually close the batch when all tests on all runners have completed, using the method BatchClose.close.

Note that the batch ID of the batch being closed needs to be passed to the BatchClose.set_batch_ids method. In this example, we assume that a batch ID was set for all of the batches by assigning a unique ID to the APPLITOOLS_BATCH_ID environment variable. This is used as a default by the Configuration.set_batch method which is set up in the suite Configuration object and then assigned to each Eyes instance.

runner = VisualGridRunner()
#
# After creating the runner, configure it so that won't close the batch
#
runner = VisualGridRunner()
runner.dont_close_batch(True)
#
# Setup a common batch for all tests
#
batch_info = BatchInfo(batch_name)
batch_info.id = my_get_uniue_id()  # User defined method
suite_config = (Configuration()  
    .set_batch(BatchInfo(batch_name))
#
# Assign the configuration to all newly created Eyes instances
#
eyes = Eyes(runner)
eyes.set_configuration(suite_config) 
#
# After all the tests have completed, in all the runners
#
batch_id = os.getenv("APPLITOOLS_BATCH_ID")
batch_close = BatchClose()
batch_close.setBatchId(batch_id).close()