iOS configuration parameters for the Gradle Plugin | Virtual devices

When running your XCTest or XCUITest tests with the Perfecto Gradle Plugin, you can add configuration information for the test execution at the following levels:

• Configuration file (recommended): A JSON-formatted file listing parameter assignments (see below).
• build.gradle file: In the perfectoGradleSettings clause, include Authentication parameters and indicate the location of the configuration file.
• Command-line: Include any of the parameters in the following format: -P<paramName>="<paramvalue>"

The configuration parameters are grouped into the following categories:

Perfecto lab authentication parameters

These parameters may be set in the format shown in the following sample code snippets:

"cloudURL": "mobilecloud.perfectomobile.com",
"securityToken": "<your-security-token>",

perfectoGradleSettings { 
    cloudURL "mobilecloud.perfectomobile.com" 
    securityToken "<your-security-token>" 
} 

> gradle perfecto-xctest-vd -PcloudURL="mobilecloud.perfectomobile.com" -PsecurityToken="<your-security-token>"

Device selection parameters

You can select specific devices or specify a number of default devices.

Select specific devices

You can select to use the following parameters to specify a list of devices. Obtain the values for the following parameters based on the matrix of supported simulators. For details, see Supported simulator devices and OS versions.

If no device selection parameters are set, the plugin will select the default Android device.

These parameters may be set in the configuration file, in the following format:

"devices": {
    "platformVersion": "15.*",
    "model": "iPhone 13"
}

In the following example, two devices are selected. The second device in this example ("{}") is the default iOS Simulator.

"devices" : [
    {
        "model": "iPhone 13",
        "platformVersion": "16.2",
    },
    {}
]

Specify the number of random devices

Instead of the devices clause, you can use the following parameter to indicate that the specified number of iOS devices should be selected and the tests run on the devices in parallel.

This parameters may be set in either the configuration file, the perfectoGradleSettings clause of the build.gradle file, or on the command line, in the following format:

"numOfDevices": 45

Application parameters

Format of the xctestProductsPath value

The path parameter indicates the location of the .xctestproducts file. The file may be located in either the local workstation storage or in the Perfecto Repository. To differentiate between these locations, use the following format to indicate a location in the Repository:

repository://[PUBLIC | PRIVATE]:/<path to item>

Repository item must have .zip type indicator.

The "repository://" prefix is mandatory for Repository location.

Selective testing parameters

In addition, there are filter parameters that limit the test scenarios executed during the run, as listed in the following table.

"testMethodNames":["Class#Method","Class#Method",...]

-PtestMethodNames="Class#Method;Class#Method;..."

These parameters may be set in the format shown in the following sample code snippets:

"xctestProductsPath": "Users/usern/test.xctestproducts",
"testMethodNames": [
      "DemoClass#demoMethod",
      "DemoClass#demoMethod2"
]

perfectoGradleSettings { 
    ...
    xctestProductsPath "Users/usern/test.xctestproducts"
} 

gradle perfecto-xctest-vd ... -PxctestProductsPath="Users/usern/test.xctestproducts" -PrunUnitTests="false" 

Screenshot parameters

Screenshots are an important tool for analyzing the test actions. The parameters listed in the following table affect XCUITest test executions.

These parameters may be set in the configuration file, build.gradle file, or the command line.

Reporting parameters

The following parameters are used by Smart Reporting to classify the execution report and make it easy to identify the reports for the execution.

These parameters may be set in the format shown in the following sample code snippets:

"tags" : [
       "plugin",
       "unit-test",
       "demo"
],
"projectName": "playground",
"projectVersion": "1.5",
"jobName": "newFeature",
"jobNumber": "45"

perfectoGradleSettings { 
    ...
    projectName "playground"
    projectVersion "1.5"
} 

gradle perfecto-xctest-vd ... -Ptags="plugin;uiTest;demo" -PjobName="newFeature"

Export the test execution report

The Perfecto toolset generates a test execution report that can be exported for analysis. It is recommended to:

1. Use these configuration parameters to define tags, jobName, and jobNumber for the test execution.
2. Export the report data using these information items with the Smart Reporting Public API.

Location of the configuration file

The plugin execution reads the configuration file whose location is indicated by the configFileLocation parameter that may be supplied in the format shown in the following code snippets

perfectoGradleSettings { 
    ...
    configFileLocation "C:\temp\XcuiTest\ConfigFile.json" 
} 

gradle perfecto-xctest-vd ... -PconfigFileLocation="C:\temp\XcuiTest\ConfigFile.json"

If the parameter is not supplied:

• Tests will run on the default device.
• The .xctestproducts file must be supplied in either the build.gradle file or on the command line.