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 10 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 of your GREENSPECTOR Server

The file config.yml should now exist.

In case you are behind a proxy, set the proxyUrl property simply 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 $CURRENT_FOLDER/.greenspector/config.yml

To use some of its features, we type the gspt command in a given folder ($CURRENT_FOLDER). The CLI generates and works with a file in the path $CURRENT_FOLDER/.greenspector/config.yml. This file contains:

$CURRENT_FOLDER/.greenspector/config.yml
application: The application name
version: The version of the application
environment: The environment to run the tests on
platform: The platform of the environment (mobile or pc)
os: The OS of the environment
version: The Version of the OS of the environment
device: The Device name of the environment

Its content depends on the command called and can be the following:


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

To initialize it, simply use the command:

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

Usage

General

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

gspt <command name>

Here is a list of the commands by features:

Help

To get the help of GREENSPECTOR Command Line:

gspt -h

Please note that the help is built in a tree way.
We see only one help level at a time.

For example, to get the help of a command:

gspt <command name> -h

and to get the help of a subcommand:

gspt <command name> <subcommand name> -h

Ping

To test the connection to GREENSPECTOR Server and to see your settings are correct:

gspt ping

Meter

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

gspt meter <subcommand name>

Before using the meter command, you have to define your application and version by setting the config file in the current folder by following instructions at <<current-working-folder-configuration, $CURRENT_FOLDER/.greenspector/config.yml>>

Send measures

To send the measures from the current folder to the server:

gspt meter send-measures

This feature will read all the files in the current folder and send their contents to GREENSPECTOR Server.
When the sending is done successfully, files will be deleted.

Power Test Bench/Cloud

Usage

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

gspt testbench <subcommand name>

Before using the testbench command, you have to define your application and version by setting the config file in the current folder by following instructions at <<current-working-folder-configuration, $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 web site on the Power Test Bench/Cloud.
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. (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 Bench/Cloud.
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 --apkFiles <path to APK>

Examples:

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

The options are :

1 - --apkFiles: The APK(s) to benchmark (If set multiple times, all the APK will be installed but only the first one will be probed). 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. (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.

Run your custom functional Test 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 Bench/Cloud.
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 --apkFiles <path to APK> --testPackages <Test package to launch> --monitoredPackage <package to monitor>

Examples

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

The options are :

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. Mandatory option: Minimum 1

2 - --testPackages: For each APK containing functional tests you want to launch (i.e. UIAutomator or Espresso APK 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: 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). Mandatory option: Exactly 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. (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.

Related articles


  • No labels