Skip to main content

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. 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 batchClose.

Example​

The example below:

  • Assumes that automatic closing of batches has been disabled by setting the environment variable APPLITOOLS_DONT_CLOSE_BATCHES to true.
  • 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.setBatchIds 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({testConcurrency: concurrentSessions}); 
/*
 * Setup a common batch for all tests
 */
let batchInfo = new BatchInfo(batchName);
batchInfo.setId(myGetUniqueBatchID()); // User defined function
suiteConfig = new Configuration() 
    .setBatch(batchInfo)
/* ... other configurations */; 
suiteConfig
    .setDontCloseBatches(true);
/*
 * 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
 */
let batchIds = process.env.APPLITOOLS_BATCH_ID;
let batchClose = new BatchClose();
batchClose.setBatchId(batchIds).close();

Methods​

BatchClose method​

To manually close a batch, instantiate an object of this class and then call BatchClose.setBatchIds followed by BatchClose.close in a fluent method style - see the example below.

Syntax​

let obj = new BatchClose(options);
let obj = new BatchClose();

Parameters​

options

Type: 

{  
  batchIds: string[];  
  serverUrl?: string;  
  apiKey?: string;  
  proxy?: ProxySettingsPlain;  
}; \[Optional \]

An object that defines the setup of this object

Return value​

Type: BatchClose

close method​

Syntax​

await obj.close();
await obj.close(options);

Note: This method has both static and non static overloads.

Parameters​

options

Type: 

{
  batchIds: string[];
  serverUrl?: string;
  apiKey?: string;
  proxy?: ProxySettingsPlain;
};

Options for the close command.

Return value​

Type: Promise<void>

setApiKey method​

Syntax​

let value = obj.setApiKey(apiKey);

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.

setBatchIds method​

When closing a batch manually, this call is typically followed by a call to the method BatchClose.close.

Syntax​

let value = obj.setBatchIds(batchIds);

Parameters​

batchIds

Type: string[]

One or more batches to be closed.

Return value​

Type: BatchClose

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 setBatchIds

setProxy method​

Syntax​

let value = obj.setProxy(proxy);

Parameters​

proxy

Type: ProxySettingsPlain

An object that defines how to interact with the proxy server. ProxySettingsPlain

Return value​

Type: BatchClose

setUrl method​

Syntax​

let value = obj.setUrl(serverUrl);

Parameters​

serverUrl

Type: string

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.