| Table of Contents |
|---|
...
| Code Block |
|---|
sl-python config {--token <token> | --tokenfile <file>} --appname <appname> --branch <branch> --build <build> [--buildsessionid <buildsessionid>] [--proxy <proxy>] [--failbuild {true|false}] |
Parameter | Description | code||
|---|---|---|---|
| Access token generated from the Sealights server | ||
| Code Block |
| Path to file containing access token generated from the SeaLights server code | |
| Name of the application | ||
| Code Block |
| The source branch of the application code | |
| The build label of the current build code | ||
| Optional: A user provided session ID code | ||
| Address of proxy to run connection through | ||
| Exit with an error code if an error is encountered (Default: false) | ||
| Show Help message and exit. |
Scanning a build
| Code Block |
|---|
sl-python build {--token <token> | --tokenfile <file>} {--buildsessionid <id> | --buildsessionidfile <file>} --workspacepath <workspacepath> --scm {git|none} [--projectRoot <folder>] [--excludedpaths <excludedpaths>] [--uniqueModuleId <id>] [--es-modules] [--jobName <jobName>] [--logsUrl <logsUrl>] [--dependenciesFile <dependenciesFile>] [--instrumentForBrowsers --outputpath <folder> [--downloadAgent {true|false}] [--instrumentationOnly] [--labid <labid>]] [--proxy <proxy>] [--failbuild {true|false}] [--scmBaseUrl --scmProvider {github|gitlab|bitbucket} --scmVersion] [--babylonPlugins decorators-legacy] |
Parameter | Description | ||
|---|---|---|---|
| Access token generated from the SeaLights server | ||
| Path to file containing access token generated from the SeaLights server | ||
| Session ID of configuration created | ||
| Path to file containing the Session ID of configuration created | ||
| Path to the source workspace | ||
| Comma-separated list of files to exclude from scan Supports wildcards (* = any string, ? = any character). For example: '*-with-dependencies.jar , bad-bad?.war, *-source.jar' | ||
| Path to the root of the project. Usually where the src folder resides | ||
| Unique name when providing more than one build scan per build | ||
es-modules | Indicates that you use es6 modules | ||
| Name of Jenkins job | ||
| Path to Jenkins log folder | ||
| Source control used Current options are: git, none | ||
| A path to a json file that is in the following format: | ||
| Instrument the JS files for providing browser front-end coverage information. Must be used with the outputpath parameter. | ||
| Set this value to 'false' in order to prevent the instrumented javascript to try and download the browser test listener (for example, when using 'Karma'). | ||
| Only instrument the javascript files, without sending the build information to the SeaLights server | ||
| Folder to generate the instrumented JS files in when using the instrumentForBrowsers parameter | ||
| Unique ID for a set of test labs in case multiple labs are running simultaneously or for an integration build. | ||
| Address of proxy to run connection through | ||
| Exit with an error code if an error is encountered (Default: false) | ||
scmProvider | The provider name of your Source Control Management (SCM) tool. | ||
scmBaseUrl | The URL to the repository which contains the code. If not provided, the url of the remote GIT origin will be used Example: | ||
scmVersion | The version of your Source Control Management (SCM) tool. If not provided, cloud version is assumed | ||
babylonPlugins | When there are decorators in the code, you should use this flag with the "decorators-legacy" value |
...
| Code Block |
|---|
sl-python uploadReports {--token <token> | --tokenfile <file>} {--buildsessionid <id> | --buildsessionidfile <file>} {--reportFile <reportFile> | --reportFilesFolder <reportFilesFolder>} [--hasmorerequests {False|True}] [--labid <labid>] [--source <source>] [--type <type>] [--proxy <proxy>] [--failbuild {true|false}help] |
Parameter | Description | ||||||
|---|---|---|---|---|---|---|---|
| Name of the application | ||||||
| The source branch of the application | ||||||
| The build label of the current build | ||||||
Parameter | Description | code||||||
| Access token generated from the SeaLights server code | ||||||
| Path to file containing access token generated from the SeaLights server | ||||||
| Code Block |
| Session ID of configuration created | |||||
| Code Block |
| Path to file containing the Session ID of configuration created | |||||
| Code Block |
| Path to report file (multiple entries can be provided) |
| Path to folder containing report files (multiple entries can be provided). This argument can be declared multiple times in order to upload multiple files. | |||
| Path to folder that contains nothing but report files. All files in folder will be uploaded. Note: all files in the folder will be uploaded code | ||||||
| Set to ‘True’ if test results contains multiple reports (Default: ‘False’). | ||||||
| Unique ID for a set of test labs in case multiple labs are running simultaneously code(case-sensitive) | ||||||
| The reports providerDefault: . If not set, the default will be 'Junit xml report'. | ||||||
|
| ||||||
type | Name of testing framework type | ||||||
| Code Block | Name of testing framework type. The report type. If not set, the default will be 'JunitReport'
| ||||||
| Address of proxy to run connection through | ||||||
| Exit with an error code if an error is encountered (Default: false) |
Optional override parameters:
| Show Help message and exit. |
Ending a test stage
| Code Block |
|---|
sl-python end {--token <token> | --tokenfile <file>} {--buildsessionid <id> | --buildsessionidfile <file>} [--labid <labid>] [--proxy <proxy>] [--failbuild {true|false}] |
Parameter | Description | code||
|---|---|---|---|
| Access token generated from the SeaLights server | ||
| Code Block |
| Path to file containing access token generated from the SeaLights server code | |
| Session ID of configuration created code | ||
| Path to file containing the Session ID of configuration created code | ||
| Unique ID for a set of test labs in case multiple labs are running simultaneously code | ||
| Address of proxy to run connection through | ||
| Exit with an error code if an error is encountered (Default: false) | ||
| Show Help message and exit. |
Running backend server
| Code Block |
|---|
sl-python run {--token <token> | --tokenfile <file>} {--buildsessionid <id> | --buildsessionidfile <file>} [--cov-workspacepathreport <path>] [--useinitialcolorper-test {true|false}] [--teststageinterval <teststage><interval>] [--labid <labid>] [--proxy <proxy>] [--failbuild {true|false}help] args... |
Parameter | Description | |||||
|---|---|---|---|---|---|---|
| Code Block |
| Access token generated from the SeaLights server code | ||||
| Path to file containing access token generated from the SeaLights server | |||||
| Code Block |
| Session ID of configuration created code | ||||
| Path to file containing the Session ID of configuration created | |||||
| Code Block |
| Path to the source workspace |
| When reporting tests manually this should be set to false generate XML coverage report | ||
| Collect coverage per test (Default: false) | |||||
| Name of the test stage | |||||
| code
| Interval in milliseconds to send data | |||||
| Unique ID for a set of test labs in case multiple labs are running simultaneously (case-sensitive) | |||||
| Code Block |
| Address of proxy to run connection through | ||||
| Exit with an error code if an error is encountered (Default: false) | Show Help message and exit. | ||||
| Extra arguments for running mocha framework teststhe application server |
Logging
Enabling logging in Python is done using by setting the SL_DEBUG environment variable to “true”.
...