Android configuration parameters for the Gradle Plugin | Virtual devices

When running your Android instrumentation tests with the Perfecto Gradle Plugin against virtual devices in Perfecto, you can add configuration information for the test execution at the following levels:

• Configuration file (recommended): A JSON-formatted file listing parameter assignments. For a full configuration file example, see the fullConfigFileVirtualDevices.json in our Espresso project on GitHub.
• Within the module's build.gradle file: In the perfectoGradleSettings clause, include Authentication parameters and indicate the location of the configuration file.
• On the command-line: Include any of the parameters in the format: -P<paramName>="<paramvalue>"

The following sections list the parameters for the different 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": "<security_token>"

perfectoGradleSettings { 
    cloudURL "mobilecloud.perfectomobile.com" 
    securityToken "<security_token>" 
} 

> gradle perfecto-android-inst-vd -PcloudURL="mobilecloud.perfectomobile.com" -PsecurityToken="<security_token>"

Device selection parameters

You can select specific devices or specify a number of random 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 emulator 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": [ 
    {
    "platformName" : "Android",
    "model": "pixel 6",
    "platformVersion": "13"
    }
]

"devices" : [
    {
        "platformName" : "Android",
        "model": "pixel 5",
        "platformVersion": "12"
    },
    {
        "platformName" : "Android",
        "model": "galaxy.*",
        "platformVersion": "13"
     },
     {}
]

Specify a number of random devices

When using Espresso, you can use the following parameter, in place of the devices clause, to indicate that the specified number of Android devices should be selected and the Espresso 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

When activating the plugin, as a standalone activation, supply both the apkPath and testApkPath parameters.

Format of apkPath/testApkPath values

The path parameters indicate the location of the apk files of the application and the test-application. These may be located in either the local workstation storage or in the Perfecto Lab Repository. To differentiate between these locations, use the following format to indicate a location in the Repository:

repository://[PUBLIC | PRIVATE]:<app name>

Repository item must have .apk type indicator.

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

Selective testing parameters

In addition, there are filter parameters that limit the test scenarios executed during the run:

These parameters may be set:

• In the configuration file, in the following format:

  Copy

  "testApkPath": "Users/usern/AndroidStudioProjects/Playground/app/build/outputs/apk/app-debug-AndroidTest.apk",
  "apkPath": "Users/usern/AndroidStudioProjects/Playground/app/build/outputs/apk/app-debug.apk",
  "testSize": "small",
  "testMethodNames": ["com.perfectomobile.com.DemoClass#demoMethod","com.perfectomobile.com.DemoClass#demoMethod2"]

• In the perfectoGradleSettings clause of the build.gradle file:

  Copy

  perfectoGradleSettings { 
      ...
      testApkPath "Users/usern/AndroidStudioProjects/Playground/app/build/outputs/apk/app-debug-AndroidTest.apk"    apkPath "Users/usern/AndroidStudioProjects/Playground/app/build/outputs/apk/app-debug.apk" 
  } 

• In the command line, in the following format:

  Copy

  gradle perfecto-android-inst-vd ... -PapkPath="Users/usern/AndroidStudioProjects/Playground/app/build/outputs/apk/app-debug.apk" -PtestSize="large"

Pre-execution and post-execution parameters

The following parameters control whether the application and test apk files are uninstalled from the devices, either prior to installing the latest version or at the end of the tests:

These parameters may be configured:

• In the configuration file, in the following format:

  Copy

  "installationDetails" : {"grantAll" : true}
  "preExecution" : {"screenOrientation" : "PORTRAIT"}

• In the perfectoGradleSettings clause of the module's build.gradle file:

  Copy

  perfectoGradleSettings { 
      ...
      preExecution {
          screenOrientation "PORTRAIT"
      }
      installationDetails {
          grantAll true
      }
   } 

Screenshot parameters

Screenshots are an important tool for analyzing the test actions, these may be snapped by the Espresso test code, or the plugin can be configured to add screenshots when the test run ends.  The following parameters specify when the plugin takes a screenshot:

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 configuration file, in the following format:

  Copy

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

• In the perfectoGradleSettings clause of the build.gradle file:

  Copy

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

• In the command line, in the following format:

  Copy

  gradle perfecto-android-inst-vd ... -Ptags="plugin;espresso;demo" -PjobName="newFeature"

Export the 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 ReportingPublic 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 perfectoGradleSettings clause of the build.gradle file.

  Copy

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

• Or in the command line

  Copy

  gradle perfecto-android-inst-vd ... -PconfigFileLocation="C:\temp\Espresso\ConfigFile.json"

If the parameter is not supplied:

• If running in Android Studio project - default location is <project dir>/src/main/assets/perfecto/instrumentedTest/configFile.json
• If running in Standalone mode or the file is not found at the default location, then tests will run on a randomly selected available Android device.
• The application and test-application identification parameters (apkPath and testApkPath) must be supplied in either the build.gradle file or on the command line.