BatchClose class

Platform: ImagesLanguage: Python SDK:
Use an object of this class to close a batch explicitly.


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.

The Eyes server closes an active batch if it has not been used for several hours, or if it has been in continuous use for more than a few days.

When a batch is closed, the Eyes server sends a batch completion notification, if this feature is enabled. New tests that start will be added to a new batch and not to the closed batch.

You can manage batch closure by manually closing the batch. This is recommended if the user wants to get a batch completion notification as soon as the tests complete and not when the batch is closed automatically by the server.


The example below illustrates how to close a batch programmatically:

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 environment variable APPLITOOLS_BATCH_ID. This is used as a default by the method Configuration.set_batch which is set up in a suite Configuration object and assigned to each Eyes instance.

# Setup a common batch for all tests
batch_info = BatchInfo(batch_name) = my_get_uniue_id()  # User defined method
suite_config = (Configuration()  
# Assign the configuration to all newly created Eyes instances
eyes = Eyes()
# After all the tests have completed, in all the runners
batch_id = os.getenv("APPLITOOLS_BATCH_ID")
batch_close = BatchClose()


The constructor for the BatchClose class.


Use this method to set your Eyes license key.


Close the batches whose batch IDs were passed to BatchClose.set_batch_ids.
Use this method to set your Eyes license key.
Set the batch ID of the batches that should be closed.
Use this method to provide the URL, username, and password of a Proxy server that the SDK can use to access the Eyes server.
Set the Eyes server URL.