BatchClose class
Use an object of this class to close a batch explicitly.
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:
- Disabling the Auto batch closure feature by calling
runner.setdontclosebatches (not yet available in selenium python). This is useful if you want to combine tests from multiple runners, or tests that run as separate executions, into a common batch. - Disabling the Auto batch closure by defining the environment variable
APPLITOOLS_DONT_CLOSE_BATCHES(on supported SDKs). This is useful if you want to combine tests from multiple runners, or tests that run as separate executions, into a common batch. - Manually closing the batch after it has been disabled, after all the tests have run, by using the
close.
Example
The example below:
- Assumes that automatic closing of batches has been disabled by setting the environment variable APPLITOOLS_DONT_CLOSE_BATCHES to a true value.
- 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.
Python
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()
BatchClose method
To manually close a batch, instantiate an object of this class and then call BatchClose.set_batch_ids followed by BatchClose.close in a fluent method style - see the example below.
Syntax
obj = BatchClose()
Parameters
This method does not take any parameters.
Return value
Type: None
api_key property
Syntax
obj.api_key = value
value = obj.api_key
Type: Text
Your API key.
close method
Syntax
obj.close()
Parameters
This method does not take any parameters.
Return value
Type:
set_api_key method
Syntax
value = obj.set_api_key(api_key)
obj.api_key = value
value = obj.api_key
Note that this feature is available as both a method and a property.
Parameters
api_key
Type: Text
Your API key.
Return value
Type: BatchClose
The object that called this method. This allows other methods of this class to be appended in a Fluent style.
set_batch_ids method
When closing a batch manually, this call is typically followed by a call to the method BatchClose.close.
Syntax
value = obj.set_batch_ids(ids)
Parameters
ids
Type: Union[Text,List[Text]]
One or more batches to be closed.
Return value
Type: _EnabledBatchClose
The returned object is an instance of a class inherited from BatchClose. This is to ensure that you only call BatchClose.close if you've set the batch ID by calling set_batch_ids
set_proxy method
Syntax
value = obj.set_proxy(proxy)
obj.proxy = value
value = obj.proxy
Note that this feature is available as both a method and a property.
Parameters
proxy
Type: ProxySettings
An object that defines how to interact with the proxy server.
Return value
Type: BatchClose
set_url method
Syntax
value = obj.set_url(url)
Parameters
url
Type: Text
The URL of the Eyes server.
Return value
Type: BatchClose
The object that called this method. This allows other methods of this class to be appended in a Fluent style.