Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 16 Next »

UP TO DATE

Configuration

Client configuration in $HOME/.greenspector/config.yml

The main configuration file must be located in $HOME/.greenspector/config.yml. To initialize it, simply use the command:

gspt init -a <greenspectorApi> -p <privateToken>


where:

  • greenspectorApi is your GREENSPECTOR Server API URL (for example https://app.greenspector.com/api);
  • privateToken is your private token, available in the Preferences screen on your GREENSPECTOR Web Interface.

The file $HOME/.greenspector/config.yml should now exists.

In case you are behind a proxy, set the proxyUrl property simply by using the command:

gspt set-proxy
or
gspt set-proxy --proxyUrl <proxyUrl>

If you want more details on this option, you can run the command:

gspt set-proxy -h

To check your configuration, type:

gspt ping

This command will tell you whether your basic configuration and credentials are correct or not. 

Current working folder configuration in $CURRENT_FOLDER/.greenspector/config.yml

In order to be able to use all the features of the GREENSPECTOR CLI, you also need a configuration file in your current working folder ($CURRENT_FOLDER/.greenspector/config.yml). This file contains the following fields:

$CURRENT_FOLDER/.greenspector/config.yml
application: <name of the application>
version: <version of the application>
environment: <environment to run the tests on>
	platform: <platform of the environment (mobile in most cases)>
	os: <OS of the environment>
	version: <version of this OS>
	device: <device name of the environment>
	browsers: <list of browsers available on this environment>

For example:

$CURRENT_FOLDER/.greenspector/config.yml
application: MyFirstApplication
version: 0.1.2
environment:
	platform: mobile
	os: android
	version: "7"
	device: nexus6
	browsers:
	- chrome

You do not have to manually edit this configuration file, you can simply initialize it with the command:

gspt initprojectconfiguration -a "<Your application name>" -v "<Your version>"
or
gspt ipc -a "<Your application name>" -v "<Your version>"

This command will automatically set the fields application and version in you configuration file, other fields will be updated when you will start using CLI commands related to the Power Test Bench/Cloud service.

Usage

To use GREENSPECTOR Command Line, go to any folder and type the command:

gspt <command name>

You will find below a list of the available commands.

Help

The help of GREENSPECTOR Command Line is built in a tree way. You will only see one help level at a time.

Choose one of the following commands, depending on the level of help you need: general help, command help or subcommand help.

gspt -h
gspt <command name> -h
gspt <command name> <subcommand name> -h

Ping

Use this command to test the connection to your GREENSPECTOR Server and check that your settings are correct:

gspt ping

Meter

This feature groups all the commands related to the Meter service:

gspt meter <subcommand name>

Before using meter command, you have to define the application and the version you are working on by setting the configuration file in the current folder by following instructions in paragraph CLI#Current working folder configuration in $CURRENT_FOLDER/.greenspector/config.yml.

Send measures

Use this subcommand to send the results files from the current folder to the server:

gspt meter send-measures

This feature will read all the results files in the current folder and send their contents to your GREENSPECTOR Server.
Please note that these files are deleted when they are successfully sent.

Power Test Cloud/Bench

This feature groups all the commands related to the Power Test Cloud/Bench service:

gspt testbench <subcommand name>

Before using testbench command, you have to define the application and the version you are working on by setting the configuration file in the current folder by following instructions in paragraph CLI#Current working folder configuration in $CURRENT_FOLDER/.greenspector/config.yml.

Set the environment

To use the testbench command, you first need to set the environment for your project.
To do so, you should use this command:

gspt testbench set-environment

This command will ask you to select one environment among the available ones on your server. To select one, simply type the number for the environment you want when asked to.

Run a measure on a website

This feature allows you to run a measure of a website on the Power Test Cloud/Bench.
To use this feature, you have to first configure the application name, version and the environment to run the measure on.
The command to run is:

gspt testbench measure-url --url <Web Site URL>

Examples:

gspt testbench measure-url --url https://greenspector.com/
gspt testbench measure-url --url https://greenspector.com/ --iterations 5 --browser chrome
gspt testbench measure-url --url https://www.mozilla.org/fr/ --browser firefox --report

The options are :

1 - --url: The URL to benchmark. Mandatory option

2 - --iterations: Number of iterations of measure you want. (Default: 1). Optional

3 - --browser: Browser you want to run the measure on. (Default: Google Chrome). Optional

4 - --report: (Beta feature) Automatically generate the test report in the .greenspector folder and wait for the job to end. (Default: false). Optional

This command will send a measure request to the server. After this measure has run on the Power Test Bench/Cloud, you will find the results on the web interface.

Benchmark one or more APK(s)

This feature allows you to benchmark your Android application on the Power Test Cloud/Bench.
To use this feature, you have to first configure the application name, version and the environment to run the measure on.
The command to run is:

gspt testbench benchmark-apk --apkFile <path to APK>

Examples:

gspt testbench benchmark-apk --apkFile target/final.apk
gspt testbench benchmark-apk --apkFile target/main.apk --apkFile target/app-module.apk --apkFile target/commons.apk
gspt testbench benchmark-apk --apkFile target/final.apk --iterations 5 --report

The options are :

1 - --apkFile: The APK(s) to benchmark. (If set multiple times, all the APK will be installed but only the first one will be monitored). Mandatory option: Minimum 1

2 - --iterations: Number of iterations of measure you want. (Default: 1). Optional

3 - --report: (Beta feature) Automatically generate the test report in the .greenspector folder and wait for the job to end. (Default: false). Optional

This command will send a measure request to the server. After this measure has run on the Power Test Bench/Cloud, you will find the results on the Web Interface.

Some options are deprecated:

1 - --apkFiles: The APK(s) to benchmark. (If set multiple times, all the APK will be installed but only the first one will be monitored). Mandatory option: Minimum 1. This option is deprecated, use apkFile.

Run your custom functional tests on your APK / website

This feature allows you to run your custom functional tests on your Android application or web site on the Power Test Cloud/Bench.
To use this feature, you have to first configure the application name, version and the environment to run the measure on.
The command to run is:

 gspt testbench custom-tests --apkFile <path to APK> --testPackage <Test package to launch> --monitoredPackage <package to monitor>

Examples:

gspt testbench custom-tests --apkFile target/application.apk --apkFile target/test.apk --testPackage com.greenspector.demo.tests --monitoredPackage com.greenspector.demo.app
gspt testbench custom-tests --apkFile target/application.apk --apkFile target/test-1.apk --apkFile target/test-2.apk --testPackage com.greenspector.demo.tests.first --testPackage com.greenspector.demo.tests.second --monitoredPackage com.greenspector.demo.app --iterations 5
gspt testbench custom-tests --apkFile target/application.apk --apkFile target/test.apk --testPackage com.greenspector.demo.tests --monitoredPackage com.greenspector.demo.app --report

The options are:

1 - --apkFile: Precise the APKs you want to measure and the APKs which contain your functional tests to launch. Prefer separate APKs for your app and for your tests. Mandatory option: Minimum 1

2 - --testPackage: For each APK containing functional tests you want to launch (i.e. UI Automator or Espresso tests), precise the name of the android package (i.e. package in file AndroidManifest.xml). All tests in those Android packages will be launched. Mandatory option: Minimum 1

3 - --monitoredPackage: For each Android application you want to monitored, precise the name of the android package to get metrics about the process (process data, process CPU…). Probes can monitor multi package at a time. In this case, metrics are agreggated. For website, choose the browser where the tests runs (i.e. com.android.chrome). Mandatory option: Minimum 1

4 - --iterations: Number of iterations of measure you want. (Default: 1). Optional

5 - --report: (Beta feature) Automatically generate the test report in the .greenspector folder and wait for the job to end.(Default: false). Optional

This command will send a measure request to the server. After this measure will ran on the Power Test Bench/Cloud, you will find the results on the Web Interface.

6 - --extra: Use to transmit extras parameters to your instrumentation with the format name=value (ie --extra annotation=com.greenspector.demo.test.MyAnnotation add the following parameters to your instrumentation -e annotation com.greenspector.demo.test.MyAnnotation). Thus you can filter your tests for example using those extras parameters : https://developer.android.com/reference/android/support/test/runner/AndroidJUnitRunner). Optional


Some options are deprecated:

1 - --apkFiles: Precise the APKs you want to measure and the APKs which contain your functional tests to launch. Prefer separate APKs for your app and for your tests. This option is deprecated, use apkFile

2 - --testPackages: For each APK containing functional tests you want to launch (i.e. UIAutomator or Espresso tests), precise the name of the android package (i.e. package in file AndroidManifest.xml). All tests in those Android packages will be launched. This option is deprecated, use testPackage

3 - --monitoredPackages: The package name of the Android application to monitor with the probes to get metrics about the process (process data, process CPU…). Probes can monitor only one package at a time. For website, choose the browser where the tests runs (i.e. com.android.chrome). This option is deprecated, use monitoredPackages

Related articles


  • No labels