Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
printablefalse

Note

All the commands below have the sltoken and sltokenfile flags as optional.
They only need to be used if you have not placed the sltoken.txt file inside the agents folder.

Anchor
CreateSessionID
CreateSessionID
Creating a session ID

Code Block
firstline1
titleUsage
SL.DotNet.exe config {--token  <arg> | --tokenFile <arg>} --appName <arg> --branchName <arg> --buildName <arg> --includeNamespace <arg> [--excludeNamespace <arg>] [--include <arg>] [--exclude <arg>] [--buildSessionId <arg> | --buildSessionIdFile <arg>] [--token  <arg> | --tokenFile <arg>] [--proxy <arg>] 


ParameterDescription
token
Access token generated from the SeaLights server
tokenFile
Path to file containing access token generated from the SeaLights server
appName
Name of the application
branchName
The source branch of the application
buildName
The build label of the current build
includeNamespace

Comma-separated list of namespaces to include in scan

Supports wildcards (* = any string, ? = any character). For example: 'com.example.* ,io.*.demo, com.?ello.world'

excludeNamespace

Comma-separated list of packages to exclude from scan

Supports wildcards (* = any string, ? = any character). For example: 'com.example.* ,io.*.demo, com.?ello.world'

include

Comma-separated list of files to include in scan

Supports wildcards (* = any string, ? = any character). For example: '*-with-dependencies.dll , bad-bad?.exe, *-source.dll'

Default: *.exe, *.dll

exclude

Comma-separated list of files to exclude from scan

Supports wildcards (* = any string, ? = any character). For example: '*-with-dependencies.dll , bad-bad?.exe, *-source.dll'

Default: Microsoft.* System.*

buildSessionId 
Optional: A user provided session ID
buildSessionIdFile 
Optional: A user provided Build Session ID file.
tokenAccess token generated from the SeaLights server
tokenFilePath to file containing the access token generated from the SeaLights server
proxy
Address of proxy to run connection through


Preparing a build for MSBuild

Code Block
firstline1
titleUsage
SL.DotNet.exe prepareForMsBuild {--tokenbuildSessionId  <arg> | --tokenFilebuildSessionIdFile <arg>} {--buildSessionIdbaseDir <arg> | [--buildSessionIdFiletoken  <arg>} | --baseDirtokenFile <arg>] 


ParameterDescription
token
Access token generated from the SeaLights server
tokenFile
Path to file containing the access token generated from the SeaLights server
buildSessionId 
Session ID of configuration created
buildSessionIdFile
Path to file containing the Session ID of configuration created
baseDir

Base path where your solution file is

...

Code Block
firstline1
titleUsage
SL.DotNet.exe scan {--token  <arg> | --tokenFile <arg>} {--buildSessionId <arg> | --buildSessionIdFile <arg>} --workspacePath <arg> [--firstModule {true|false}] [--uniqueModuleId <arg>] [--baseDir <arg>] [--scm <arg>] [--token  <arg> | --tokenFile <arg>] [--proxy <arg>]


ParameterDescription
token
Access token generated from the SeaLights server
tokenFile
Path to file containing the access token generated from the SeaLights server
buildSessionId 
Session ID of configuration created
buildSessionIdFile
Path to file containing the Session ID of configuration created
workspacePath

Path to the source workspace

firstModule

Must be provided when scanning the first module

uniqueModuleId
A unique module ID to be used for seperate modules
baseDir

Base path where all relative paths should start from. By default the agent searches for the solution file and uses its path for this value

scm

The SCM that is used in order to provide integration with. Values: auto, git, none


proxy
Address of proxy to run connection through

...

Code Block
firstline1
titleUsage
SL.DotNet.exe startExecution {--tokenbuildSessionId  <arg> | --tokenFilebuildSessionIdFile <arg>} {--buildSessionIdtestStage <arg> | [--buildSessionIdFilelabId <arg>}] [--testStagetoken  <arg> [| --labIdtokenFile <arg>] [--proxy <arg>]


ParameterDescription
token
Access token generated from the SeaLights server
tokenFile
Path to file containing the access token generated from the SeaLights server
buildSessionId 
Session ID of configuration created
buildSessionIdFile
Path to file containing the Session ID of configuration created
testStage

Name of the test stage

labId

Unique ID for a set of test labs in case multiple labs are running similtaniously

proxy
Address of proxy to run connection through

...

Code Block
firstline1
titleUsage
SL.DotNet.exe uploadTestReport {--tokenbuildSessionId  <arg> | --tokenFilebuildSessionIdFile <arg>} {--buildSessionIdtestStage <arg> | --buildSessionIdFilereport <arg>} [--testStagelabId <arg>] [--reporttoken  <arg> [| --labIdtokenFile <arg>] [proxy <arg>]


ParameterDescription
token
Access token generated from the SeaLights server
tokenFile
Path to file containing the access token generated from the SeaLights server
buildSessionId 
Session ID of configuration created
buildSessionIdFile
Path to file containing the Session ID of configuration created
testStage

Name of the test stage

report

Path to report file or directory containing all the valid reports (Non recursive). Supported formats are MSTest, xUnit.Net and NUnit

labId

Unique ID for a set of test labs in case multiple labs are running simultaneously

proxy
Address of proxy to run connection through

...

Code Block
firstline1
titleUsage
SL.DotNet.exe endExecution {--tokenbuildSessionId  <arg> | --tokenFilebuildSessionIdFile <arg>} {--buildSessionIdtestStage <arg> | [--buildSessionIdFilelabId <arg>}] [--testStagetoken  <arg> [| --labIdtokenFile <arg>] [--proxy <arg>]


ParameterDescription
token
Access token generated from the SeaLights server
tokenfile
Path to file containing the access token generated from the SeaLights server
buildsessionid 
Session ID of configuration created
buildsessionidfile
Path to file containing the Session ID of configuration created
labId

Unique ID for a set of test labs in case multiple labs are running similtaniously

proxy
Address of proxy to run connection through

...

Code Block
firstline1
titleUsage
SL.DotNet.exe testListener {--tokenbuildSessionId <arg> | --tokenFilebuildSessionIdFile <arg>} {--buildSessionIdtarget <arg> | [--buildSessionIdFileworkingDir <arg>}] [--targettargetArgs <arg>] [--workingDirlabId <arg>] [--targetArgstoken  <arg>] | [--labIdtokenFile <arg>] [--proxy <arg>] [--profilerRegistrationMethod <path32|path64>]

...

Code Block
firstline1
titleUsage
SL.DotNet.exe startBackgroundTestListener {--tokenbuildSessionId  <arg> | --tokenFilebuildSessionIdFile <arg>} {--buildSessionIdtestListenerSessionKey <arg> | [--buildSessionIdFilelabId <arg>}] [--testListenerSessionKeytoken  <arg> [| --labIdtokenFile <arg>] [--proxy <arg>]


ParameterDescription
token
Access token generated from the SeaLights server
tokenFile
Path to file containing the access token generated from the SeaLights server
buildSessionId 
Session ID of configuration created
buildSessionIdFile
Path to file containing the Session ID of configuration created
testListenerSessionKey

A random alphanumeric ID (%RANDOM% in command line)

This ID needs to be passed to any process that you want to capture cover

labId

Unique ID for a set of test labs in case multiple labs are running simultaneously

proxy
Address of proxy to run connection through

...

ParameterDescription
Cor_Profiler
{01CA2C22-DC03-4FF5-8350-59E32A3536BA}
Cor_Enable_Profiling
1
Cor_Profiler_Path

Path to the SeaLights profiler DLL.

Either SL.DotNet.ProfilerLib_x64.dll or SL.DotNet.ProfilerLib_x86.dll depending on your processes architecture

SeaLights_CollectorId
A random alphanumeric ID that was provided during the startBackgroundTestListener
SeaLights_LogLevelOptional: Level o logs to generate - Default is 0 (none), Fatal=1, Error=4, Debug=6, All=999
SeaLights_LogDirOptional: Folder to save log files in

...

Code Block
firstline1
titleUsage
SL.DotNet.exe stopBackgroundTestListener {--token buildSessionId <arg> | --tokenFilebuildSessionIdFile <arg>} {--buildSessionIdtestListenerSessionKey <arg> | [--buildSessionIdFilelabId <arg>}] [--testListenerSessionKeytoken  <arg> [| --labIdtokenFile <arg>] [--proxy <arg>]


ParameterDescription
token
Access token generated from the SeaLights server
tokenFile
Path to file containing the access token generated from the SeaLights server
buildSessionId 
Session ID of configuration created
buildSessionIdFile
Path to file containing the Session ID of configuration created
testListenerSessionKeyA random alphanumeric ID that was provided during the startBackgroundTestListener
labId

Unique ID for a set of test labs in case multiple labs are running simultaneously

proxy
Address of proxy to run connection through

...

Code Block
firstline1
titleUsage
SL.DotNet.exe startCollectorServiceSession {--token buildSessionId <arg> | --tokenFilebuildSessionIdFile <arg>} {--buildSessionIdprocessName <arg> | [--buildSessionIdFileprocessTag <arg>}] [--processName <arg>includeChildProcesses] [--processTaglabId <arg>] [--includeChildProcesses] [token  <arg> | --labIdtokenFile <arg>] [--proxy <arg>]


ParameterDescription
token
Access token generated from the SeaLights server
tokenFile
Path to file containing the access token generated from the SeaLights server
buildSessionId 
Session ID of configuration created
buildSessionIdFile
Path to file containing the Session ID of configuration created
processName

The executable name of the services process.

For instance IIS is: w3wp.exe

processTag

The application pool identity tag in IIS

For non IIS services this should not be provided

includeChildProcesses
Should be set if the service spawns child processes and coverage needs to be captured from them
labId

Unique ID for a set of test labs in case multiple labs are running simultaneously

proxy
Address of proxy to run connection through

...

Code Block
firstline1
titleUsage
SL.DotNet.exe stopCollectorServiceSession {--tokenbuildSessionId  <arg> | --tokenFilebuildSessionIdFile <arg>} {--buildSessionIdprocessName <arg> | [--buildSessionIdFileprocessTag <arg>}] [--processName <arg>includeChildProcesses] [--processTaglabId <arg>] [--includeChildProcesses] [token  <arg> | --labIdtokenFile <arg>] [--proxy <arg>]


ParameterDescription
token
Access token generated from the SeaLights server
tokenFile
Path to file containing the access token generated from the SeaLights server
buildSessionId 
Session ID of configuration created
buildSessionIdFile
Path to file containing the Session ID of configuration created
processName

The executable name of the services process.

For instance IIS is: w3wp.exe

processTag

The application pool identity tag in IIS

For non IIS services this should not be provided

includeChildProcesses
Should be set if the service spawns child processes and coverage needs to be captured from them
labId

Unique ID for a set of test labs in case multiple labs are running simultaneously

proxy
Address of proxy to run connection through

...