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
class$runner$setdontclosebatches. 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
class$batchclose$close$morp.
Using statement
using Applitools;
Example
The example below:
- Illustrates how to prevent the runner from closing the batch, using VisualGridRunner.DontCloseBatches or ClassicRunner.DontCloseBatches.
- 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.SetBatchId 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.SetBatch method which is set up in the suite Configuration object and then assigned to each Eyes instance.
/*
* After creating the runner, configure it so that won't close the batch
*/
runner = new VisualGridRunner(new RunnerOptions().TestConcurrency(10));
runner.DontCloseBatches = true;
/*
* Setup a common batch for all tests
*/
BatchInfo batchInfo = new BatchInfo(batchName);
batchInfo.Id = MyGetUniqueBatchID(); // User defined
suiteConfig = (Configuration) new Configuration()
.SetBatch(batchInfo)
/* ... other configurations */;
/*
* Assign the configuration to all newly created Eyes instances
*/
eyes = new Eyes(runner);
eyes.SetConfiguration(suiteConfig);
/*
* After all the tests have completed, in all the runners
*/
List<String> batchIds = new List<string>() { Environment.GetEnvironmentVariable("APPLITOOLS_BATCH_ID") };
BatchClose batchClose = new BatchClose();
batchClose.SetBatchId(batchIds).Close();
BatchClose method
To manually close a batch, instantiate an object of this class and then call BatchClose.SetBatchId followed by BatchClose.Close in a fluent method style - see the example below.
Syntax
BatchClose obj = new BatchClose();
Parameters
This method does not take any parameters.
Return value
Type: BatchClose
ApiKey property
Syntax
string value; // give relevant initial value
obj.ApiKey = value;
value = obj.ApiKey
Type: string
Close method
Syntax
obj.Close();
Parameters
This method does not take any parameters.
Return value
Type: void
SetApiKey method
Syntax
BatchClose value = obj.SetApiKey(apiKey);
obj.ApiKey = value;
= obj.ApiKey;
Note that this feature is available as both a method and a property.
Parameters
apiKey
Type: string
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.
SetProxy method
Syntax
BatchClose value = obj.SetProxy(proxy);
obj.Proxy = value;
= obj.Proxy;
Note that this feature is available as both a method and a property.
Parameters
proxy
Type: WebProxy
An object that defines how to interact with the proxy server.
Return value
Type: BatchClose
SetUrl method
Syntax
BatchClose value = obj.SetUrl(url);
Parameters
url
Type: string
The URL of the Eyes server.
url
Type: Uri
The URI 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.