{"type":"doc","content":[{"type":"heading","attrs":{"level":1},"content":[{"text":"Configuration","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Client configuration in ","type":"text"},{"text":"$HOME/.greenspector/config.yml","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"The main configuration file must be located in ","type":"text"},{"text":"$HOME/.greenspector/config.yml","type":"text","marks":[{"type":"em"}]},{"text":". To initialize it, simply use the command:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"4bbb8963-3912-4e60-a59f-2a97eb5f8ea1"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"gspt init -a -p ","type":"text"}]}]}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"where:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"greenspectorApi","type":"text","marks":[{"type":"code"}]},{"text":" is your GREENSPECTOR Server API URL (for example ","type":"text"},{"text":"https://app.greenspector.com/api","type":"text","marks":[{"type":"link","attrs":{"href":"https://app.greenspector.com/api"}}]},{"text":");","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"privateToken","type":"text","marks":[{"type":"code"}]},{"text":" is your private token, available in the ","type":"text"},{"text":"Preferences","type":"text","marks":[{"type":"em"}]},{"text":" screen on your GREENSPECTOR Web Interface.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"The file ","type":"text"},{"text":"$HOME/.greenspector/config.yml","type":"text","marks":[{"type":"em"}]},{"text":" should now exists.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"To check your configuration, type:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"c8ecaf0a-612e-4a0e-83b2-d51f13c94276"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"gspt ping","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"This command will tell you whether your basic configuration and credentials are correct or not. If correct, you should have the message \"Server pinged with success\".","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Optional proxy configuration","type":"text"}]},{"type":"paragraph"},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"c13cf916-83af-4210-bc81-26072f23cac5"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The proxy can be automatically detected.","type":"text"}]},{"type":"paragraph","content":[{"text":"In windows, the CLI automatically detects ","type":"text"},{"text":"WPAD","type":"text","marks":[{"type":"code"}]},{"text":" settings or PAC configuration","type":"text"}]},{"type":"paragraph","content":[{"text":"In linux or mac, the CLI automatically detects env variable ","type":"text"},{"text":"HTTPS_PROXY","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"HTTP_PROXY or","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"FTP_PROXY","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph"}]}]}]},{"type":"paragraph","content":[{"text":"If previous gspt ping does not work in your work office, you probably need to configure a proxy to allow the CLI to access Internet.","type":"text"}]},{"type":"paragraph","content":[{"text":"You can check if you need to configure a proxy. Use a 4G mobile network for your PC and try to use the CLI. If it works, you need to configure a proxy.","type":"text"}]},{"type":"paragraph","content":[{"text":"Set the ","type":"text"},{"text":"proxyUrl","type":"text","marks":[{"type":"code"}]},{"text":" property simply by using the command:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"cbb60495-4b01-42a7-a0d9-31a825f5c61a"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"gspt set-proxy\nor\ngspt set-proxy --proxyUrl ","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"If you want more details on this option, you can run the command:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"8b4a3265-d1ac-4dfe-83b7-82cd87d4f670"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"gspt set-proxy -h","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Example for proxy without authentication:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"e490ed3f-2fb5-4a32-bcac-7670923e280b"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"gspt set-proxy --proxyUrl \"http://testproxy.local:3112/\"","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Example for proxy with authentication:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"478c34f5-8fb3-4948-81a8-457f6cefd960"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"gspt set-proxy --proxyUrl \"http://myuser:mypassword%241%2C%21@testproxy.local:3112/\"","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Using --proxyUrl, If you have password with specials characters, you need to encode the password to use as url. You can use this ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://smalldev.tools/url-encoder-online"}},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"For example, the password mypassword$1,! devient mypassword%241%2C%21","type":"text"}]},{"type":"paragraph","content":[{"text":"Example for proxy with authentification with interactive mode:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"b8e6596d-55fd-4339-bb93-11dd4aedac71"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"gspt set-proxy\n\nEnter the Proxy Protocol (http or https)\nProxy Protocol:\nhttp\n\nEnter the Proxy Host\nProxy Host:\ntestproxy.local\n\nEnter the Proxy Port\nProxy Port:\n3112\n\nIs this proxy authenticated? (y/N)\ny\n\nEnter the Proxy Username:\nmyuser\n\nEnter the Proxy Password:\nmypassword$1,!\n\n","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"You do not need to encode password in this interactive mode","type":"text"}]},{"type":"paragraph","content":[{"text":"To check your configuration, type:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"4863c90d-6dba-490e-aa63-74b5f53894c6"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"gspt ping","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"This command will tell you whether your basic configuration and credentials are correct or not. If correct, you should have the message \"Server pinged with success\".","type":"text"}]},{"type":"paragraph","content":[{"text":"you can get these errors if you misconfigured your proxy:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"da8091a5-7c66-418d-a4d7-e590e6cded62"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Error","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Cause","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":". because an auto detection of your browser is set, you, you can find","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Bad port","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Error: Get \"","type":"text"},{"text":"https://app.greenspector.com/api/ping","type":"text","marks":[{"type":"link","attrs":{"href":"https://app.greenspector.com/api/ping"}}]},{"text":"\": Proxy Authentication Required","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Bad user or password","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Error: Get \"","type":"text"},{"text":"https://app.greenspector.com/api/ping","type":"text","marks":[{"type":"link","attrs":{"href":"https://app.greenspector.com/api/ping"}}]},{"text":"\": proxyconnect tcp: dial tcp 149.202.59.166:3129: i/o timeout","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Bad Host","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Error: parse \"","type":"text"},{"text":"http://myuser:mypassword","type":"text","marks":[{"type":"link","attrs":{"href":"http://user2password1"}}]},{"text":"\": invalid port \":mypassword\" after host","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Need to encode password","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Error: Get \"","type":"text"},{"text":"https://app.greenspector.com/api/ping","type":"text","marks":[{"type":"link","attrs":{"href":"https://app.greenspector.com/api/ping"}}]},{"text":"\": proxyconnect tcp: tls: first record does not look like a TLS handshake","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Bad protocol, use http instead of https or the opposite","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Tips:","type":"text"}]},{"type":"paragraph","content":[{"text":"If you do not know the proxy host of your office and your browser is configured automatically to discover the proxy, you can get the following file via your browser :","type":"text"}]},{"type":"paragraph","content":[{"text":"wpad./wpad.dat","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Example : ","type":"text"},{"text":"https://wpad.myorganisation.fr/wpad.dat","type":"text","marks":[{"type":"link","attrs":{"href":"https://wpad.myorganisation.fr/wpad.dat"}}]}]},{"type":"paragraph","content":[{"text":"If you open this file, you can find the host and port for the proxy.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Current working folder configuration in ","type":"text"},{"text":"$CURRENT_FOLDER/.greenspector/config.yml","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"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 (","type":"text"},{"text":"$CURRENT_FOLDER/.greenspector/config.yml","type":"text","marks":[{"type":"em"}]},{"text":"). This file contains the following fields:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"a2e76e38-6a21-462c-96d7-c3af6668e137"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"application: \nversion: \nenvironment: \n\tplatform: \n\tos: \n\tversion: \n\tdevice: \n\tbrowsers: ","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"For example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"5aae68c0-4a97-4add-b564-79b6fc55d58f"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"application: MyFirstApplication\nversion: 0.1.2\nenvironment:\n\tplatform: mobile\n\tos: android\n\tversion: \"7\"\n\tdevice: nexus6\n\tbrowsers:\n\t- chrome","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"You do not have to manually edit this configuration file, you can simply initialize it with the command:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"170037cb-4bcc-4d12-a44d-ba31672c4137"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"gspt initprojectconfiguration -a \"\" -v \"\"\nor\ngspt ipc -a \"\" -v \"\"","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"This command will automatically set the fields ","type":"text"},{"text":"application","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"version","type":"text","marks":[{"type":"code"}]},{"text":" in you configuration file, other fields will be updated when you will start using CLI commands related to the Power Test Bench/Cloud service.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Usage","type":"text"}]},{"type":"paragraph","content":[{"text":"To use GREENSPECTOR Command Line, go to any folder and type the command:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"c20f6360-64b9-4805-b47b-df648ad363dc"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"gspt ","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"You will find below a list of the available commands.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Help","type":"text"}]},{"type":"paragraph","content":[{"text":"The help of GREENSPECTOR Command Line is built in a tree way. You will only see one help level at a time.","type":"text"}]},{"type":"paragraph","content":[{"text":"Choose one of the following commands, depending on the level of help you need: general help, command help or subcommand help.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"47ac977d-e73b-415b-a3d5-9f9d2708e39c"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"gspt -h\ngspt -h\ngspt -h","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Ping","type":"text"}]},{"type":"paragraph","content":[{"text":"Use this command to test the connection to your GREENSPECTOR Server and check that your settings are correct:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"035a7e40-d77a-4c16-97da-7936a75c2e4c"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"gspt ping","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Meter","type":"text"}]},{"type":"paragraph","content":[{"text":"This feature groups all the commands related to the Meter service:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"fa8fb8bb-bc94-4007-ad34-3ee3e5ca7abd"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"gspt meter ","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Before using ","type":"text"},{"text":"meter","type":"text","marks":[{"type":"code"}]},{"text":" 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 ","type":"text"},{"text":"CLI#Current working folder configuration in $CURRENT_FOLDER/.greenspector/config.yml","type":"text","marks":[{"type":"link","attrs":{"href":"#"}}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Send measures","type":"text"}]},{"type":"paragraph","content":[{"text":"Use this subcommand to send the results files from the current folder to the server:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"8ed78024-52c1-43d6-8f48-40eec6dc6b92"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"gspt meter send-measures","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"This feature will read all the results files in the current folder and send their contents to your GREENSPECTOR Server.","type":"text"},{"type":"hardBreak"},{"text":"Please note that these files are deleted when they are successfully sent.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Power Test Cloud/Bench","type":"text"}]},{"type":"paragraph","content":[{"text":"This feature groups all the commands related to the Power Test Cloud/Bench service:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"f7af8e73-82c2-4e9f-aebe-07e3052e5cbc"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"gspt testbench ","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Before using ","type":"text"},{"text":"testbench","type":"text","marks":[{"type":"code"}]},{"text":" 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 ","type":"text"},{"text":"CLI#Current working folder configuration in $CURRENT_FOLDER/.greenspector/config.yml","type":"text","marks":[{"type":"link","attrs":{"href":"#"}}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Set the environment","type":"text"}]},{"type":"paragraph","content":[{"text":"To use the ","type":"text"},{"text":"testbench","type":"text","marks":[{"type":"code"}]},{"text":" command, you first need to set the environment for your project.","type":"text"},{"type":"hardBreak"},{"text":"To do so, you should use this command:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"c7746ad7-6652-43f2-9a89-d26b1502ecdb"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"gspt testbench set-environment","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"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.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Run a measure on a website","type":"text"}]},{"type":"paragraph","content":[{"text":"This feature allows you to run a measure of a website on the Power Test Cloud/Bench.","type":"text"},{"type":"hardBreak"},{"text":"To use this feature, you have to first configure the application name, version and the environment to run the measure on.","type":"text"},{"type":"hardBreak"},{"text":"The command to run is:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"33bb1472-7f9f-438e-bdd5-209583819b29"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"gspt testbench measure-url --url ","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Examples:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"78c0765d-fc1c-4eea-bb80-85cf25891408"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"gspt testbench measure-url --url https://greenspector.com/\ngspt testbench measure-url --url https://greenspector.com/ --iterations 5 --browser chrome --networkMode 4G\ngspt testbench measure-url --url https://www.mozilla.org/fr/ --browser firefox --report","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"The options are :","type":"text"}]},{"type":"paragraph","content":[{"text":"1 - ","type":"text"},{"text":"--url","type":"text","marks":[{"type":"code"}]},{"text":": The URL to benchmark. ","type":"text"},{"text":"Mandatory option","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"2 - ","type":"text"},{"text":"--iterations","type":"text","marks":[{"type":"code"}]},{"text":": Number of iterations of measure you want. (Default: 1). ","type":"text"},{"text":"Optional","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"3 - ","type":"text"},{"text":"--browser","type":"text","marks":[{"type":"code"}]},{"text":": Browser you want to run the measure on. (Default: Google Chrome). ","type":"text"},{"text":"Optional","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"4 - ","type":"text"},{"text":"--networkMode: The network mode for the test. Values can be \"WIFI\", \"4G\", \"3G\" or \"2G\". (Default: WIFI). Optional","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"5 - ","type":"text"},{"text":"--report","type":"text","marks":[{"type":"code"}]},{"text":": Automatically generate the test report in the ","type":"text"},{"text":".greenspector","type":"text","marks":[{"type":"code"}]},{"text":" folder and wait for the job to end. (Default: false). ","type":"text"},{"text":"Optional","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"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.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Benchmark one or more APK(s)","type":"text"}]},{"type":"paragraph","content":[{"text":"This feature allows you to benchmark your Android application on the Power Test Cloud/Bench.","type":"text"},{"type":"hardBreak"},{"text":"To use this feature, you have to first configure the application name, version and the environment to run the measure on.","type":"text"},{"type":"hardBreak"},{"text":"The command to run is:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"c3933f38-365e-4bec-94f4-4923204ecc36"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"gspt testbench benchmark-apk --apkFile ","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Examples:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"8878257b-ca6b-4884-a127-8875349bff89"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"gspt testbench benchmark-apk --apkFile target/final.apk # local path to apk\ngspt testbench benchmark-apk --apkFile https://demo/demo.apk # apk from public url\ngspt testbench benchmark-apk --apkFile com.microsoft.office.outlook # package name to download the apk from the PlayStore\ngspt testbench benchmark-apk --apkFile target/main.apk --apkFile target/app-module.apk --apkFile target/commons.apk --networkMode 3G # three apk to install and launch benchmark in 3G\ngspt testbench benchmark-apk --apkFile target/final.apk --iterations 5 --report # Launch 5 iterations of the benchmark and wait for the report\n","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"The options are :","type":"text"}]},{"type":"paragraph","content":[{"text":"1 - ","type":"text"},{"text":"--apkFile","type":"text","marks":[{"type":"code"}]},{"text":": The APK(s) to benchmark. (If set multiple times, all the APK will be installed but only the first one will be launched and monitored). The apk file could be a local path, a public URL or a package name to download from the PlayStore. ","type":"text"},{"text":"Optional if the applications to benchmark are already installed on phone","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"2 - ","type":"text"},{"text":"--iterations","type":"text","marks":[{"type":"code"}]},{"text":": Number of iterations of measure you want. (Default: 1). ","type":"text"},{"text":"Optional","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"3 - ","type":"text"},{"text":"--report","type":"text","marks":[{"type":"code"}]},{"text":": (","type":"text"},{"text":"Beta feature","type":"text","marks":[{"type":"strong"}]},{"text":") Automatically generate the test report in the ","type":"text"},{"text":".greenspector","type":"text","marks":[{"type":"em"}]},{"text":" folder and wait for the job to end. (Default: false). ","type":"text"},{"text":"Optional","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"4 - ","type":"text"},{"text":"--networkMode: The network mode for the test. Values can be \"WIFI\", \"4G\", \"3G\" or \"2G\". (Default: WIFI). Optional","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"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.","type":"text"}]},{"type":"paragraph","content":[{"text":"Some options are deprecated:","type":"text"}]},{"type":"paragraph","content":[{"text":"1 - ","type":"text"},{"text":"--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.","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Run your custom functional tests on your APK / website","type":"text"}]},{"type":"paragraph","content":[{"text":"This feature allows you to run your custom functional tests on your Android application or web site on the Power Test Cloud/Bench.","type":"text"},{"type":"hardBreak"},{"text":"To use this feature, you have to first configure the application name, version and the environment to run the measure on.","type":"text"},{"type":"hardBreak"},{"text":"The command to run is:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"afc2fdcd-37b1-496c-b8e9-fdcd37bb0a14"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"# To run android tests (uiautomator, espresso)\ngspt testbench custom-tests --apkFile --testPackage --monitoredPackage \n\nor\n\n# To run Greenspector DSL tests\ngspt testbench custom-tests --apkFile --testsSuite --monitoredPackage ","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Examples:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"2f1a17cc-7b79-4c90-9f25-f2a40b585b74"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"gspt testbench custom-tests --apkFile target/application.apk --apkFile target/test.apk --testPackage com.greenspector.demo.tests --monitoredPackage com.greenspector.demo.app\n\ngspt testbench custom-tests --apkFile https://dl.greenspector.com/demo/demo.apk --apkFile https://dl.greenspector.com/demo/testuiautomator-debug-androidTest.apk --apkFile https://dl.greenspector.com/demo/testuiautomator-debug.apk\n --testPackage com.greenspector.demo.test --monitoredPackage com.greenspector.demo\n\ngspt 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\n\ngspt testbench custom-tests --apkFile target/application.apk --apkFile target/test.apk --testPackage com.greenspector.demo.tests --monitoredPackage com.greenspector.demo.app --report\n\ngspt testbench custom-tests --apkFile target/application.apk --testsSuite suite1:tests/file1.testgb,tests/file2.tgb --testsSuite suite2:tests/file3.testgb --monitoredPackage com.greenspector.demo.app\n\n","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"The options are:","type":"text"}]},{"type":"paragraph","content":[{"text":"1 - ","type":"text"},{"text":"--apkFile","type":"text","marks":[{"type":"code"}]},{"text":": 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. The apk file could be a local path, a public URL or a package name to download from the PlayStore.","type":"text"}]},{"type":"paragraph","content":[{"text":"2 - ","type":"text"},{"text":"--testPackage","type":"text","marks":[{"type":"code"}]},{"text":": 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 ","type":"text"},{"text":"AndroidManifest.xml","type":"text","marks":[{"type":"em"}]},{"text":"). All tests in those Android packages will be launched. ","type":"text"},{"text":"Mandatory option: Minimum 1 if --testsSuite is not used","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"3 - ","type":"text"},{"text":"--testsSuite","type":"text","marks":[{"type":"code"}]},{"text":": For each suite, precise the suite name and the lists of test files writen with Greenspector DSL. All test files will be launched in the specified order. ","type":"text"},{"text":"Mandatory option: Minimum 1 if --testPackage is not used","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"4 - ","type":"text"},{"text":"--monitoredPackage","type":"text","marks":[{"type":"code"}]},{"text":": 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. ","type":"text"},{"text":"com.android.chrome","type":"text","marks":[{"type":"code"}]},{"text":"). ","type":"text"},{"text":"Mandatory option: Minimum 1","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"5 - ","type":"text"},{"text":"--iterations","type":"text","marks":[{"type":"code"}]},{"text":": Number of iterations of measure you want. (Default: 1). ","type":"text"},{"text":"Optional","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"6 - ","type":"text"},{"text":"--report","type":"text","marks":[{"type":"code"}]},{"text":": Automatically generate the test report in the ","type":"text"},{"text":".greenspector","type":"text","marks":[{"type":"em"}]},{"text":" folder and wait for the job to end.(Default: false). ","type":"text"},{"text":"Optional","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"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.","type":"text"}]},{"type":"paragraph","content":[{"text":"7 - ","type":"text"},{"text":"--extra: ","type":"text","marks":[{"type":"code"}]},{"text":"Use to transmit extras parameters to your instrumentation with the format name=value ","type":"text"},{"text":". Optional","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"You can use custom parameters to fill parameters on your GDSL file. For example ","type":"text"},{"text":"--extra PARAMETERNAME=\"value\" ","type":"text","marks":[{"type":"strong"}]},{"text":"will replace all ${PARAMETERNAME} in the GDSL file by value","type":"text"}]},{"type":"paragraph","content":[{"text":"You can use predefined extra parameters to configure the phone before running GDSL file test","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"config-skipsetupphone: if \"true\" then skip the setup configuration that happens before test.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"config-waitForIdle: if \"false\" set idle timeout to 0","type":"text"},{"type":"hardBreak"},{"text":"config-screenofftimeout: Set the time of inactivity before the screen goes to sleep (in millisecond)","type":"text"},{"type":"hardBreak"},{"text":"config-screenbrightness: set brightness of the screen. value is between 0 and 255","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"config-gps: if \"enabled\" then activate location on phone before test","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"config-bluetooth: if \"enabled\" then activate bluetooth on phone before test","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"config-nfc: if \"enabled\" then activate NFC on phone before test","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"config-darkmode: if \"enabled\" then activate the dark mode on phone before test","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"You can filter your custom UIAutomator tests (no GDSL tests) using those extras parameters. For example, ","type":"text"},{"text":"--extra annotation=com.greenspector.demo.test.MyAnnotation","type":"text","marks":[{"type":"strong"}]},{"text":" add the following parameters to your instrumentation ","type":"text"},{"text":"-e annotation com.greenspector.demo.test.MyAnnotation","type":"text","marks":[{"type":"strong"}]},{"text":". Thus you can filter your tests for example using those extras parameters : ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://developer.android.com/reference/android/support/test/runner/AndroidJUnitRunner"}}]},{"type":"paragraph","content":[{"text":"8 - ","type":"text"},{"text":"--networkMode: The network mode for the test. Values can be \"WIFI\", \"4G\", \"3G\" or \"2G\". (Default: WIFI). Optional","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"9 - ","type":"text"},{"text":"--","type":"text","marks":[{"type":"code"}]},{"text":"disable-dumpsys: Disable Android System Monitoring. By default, this is enabled and will add one iteration to your job for more detailed metrics (Views, Activity, OpenSSL Sockets, ...). If you don't need these metrics, you can disable this iteration, it will reduce testing time.","type":"text"}]},{"type":"paragraph","content":[{"text":"10 - ","type":"text"},{"text":"--","type":"text","marks":[{"type":"code"}]},{"text":"only-dumpsys: Run only a Android System Monitoring iteration. This iteration will only be able to retrieve Android System metrics (Views, Activity, OpenSSL Sockets, ...).","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Some options are deprecated:","type":"text"}]},{"type":"paragraph","content":[{"text":"1 - ","type":"text"},{"text":"--apkFiles","type":"text","marks":[{"type":"code"}]},{"text":": 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. ","type":"text"},{"text":"This option is deprecated, use apkFile","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"2 - ","type":"text"},{"text":"--testPackages","type":"text","marks":[{"type":"code"}]},{"text":": 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 ","type":"text"},{"text":"AndroidManifest.xml","type":"text","marks":[{"type":"em"}]},{"text":"). All tests in those Android packages will be launched. ","type":"text"},{"text":"T","type":"text","marks":[{"type":"strong"}]},{"text":"his option is deprecated, use testPackage","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"3 - ","type":"text"},{"text":"--monitoredPackages","type":"text","marks":[{"type":"code"}]},{"text":": 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. ","type":"text"},{"text":"com.android.chrome","type":"text","marks":[{"type":"code"}]},{"text":"). ","type":"text"},{"text":"This option is deprecated, use ","type":"text","marks":[{"type":"strong"}]},{"text":"monitoredPackage","type":"text","marks":[{"type":"code"}]}]}],"version":1}

Browser not supported