Jenkins

https://www.jenkins.io/doc
Admin
Jenkins is a self-contained, open-source automation server used to automate tasks related to...
Tokens:2,489,980
Snippets:18,822
Trust Score:9.9
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### getETInstallation Usage Examples

Source: https://www.jenkins.io/doc/pipeline/steps/ecutest

Examples of getting an ecu.test installation by name using either positional or named arguments.

```groovy
ET.installation('ecu.test')
```

```groovy
ET.installation toolName: 'ecu.test'
```

--------------------------------

### getATXServer Usage Examples

Source: https://www.jenkins.io/doc/pipeline/steps/ecutest

Examples of getting a test.guide server by name and then retrieving or overriding its settings. The last example shows chaining multiple method calls on the returned server instance.

```groovy
ATX.server('test.guide')
```

```groovy
ATX.server atxName: 'test.guide'
```

```groovy
def server ATX.server atxName: 'test.guide'
server.getSetting('serverURL')
server.getSettings()
server.overrideSetting('uploadToServer', true)
server.overrideSettings([serverURL: 'localhost', useHttpsConnection: true])
```

--------------------------------

### ETInstance.publishGenerators example with newInstallation

Source: https://www.jenkins.io/doc/pipeline/steps/ecutest

Example of using the ETInstance method with a new installation and both predefined and custom generators.

```groovy
def instance = ET.newInstallation('ecu.test', 'C:\\Program Files\\ECU-TEST 8.0')
instance.publishGenerators([[name: 'JSON']], [[name: 'Custom-JSON']])
```

--------------------------------

### publishATX example: using ATX.server and atxInstallation

Source: https://www.jenkins.io/doc/pipeline/steps/ecutest

Example of obtaining an ATX server installation and passing it to publishATX. Publishes ATX reports to test.guide.

```groovy
def server = ATX.server('test.guide')
publishATX atxInstallation: server.installation
```

--------------------------------

### publishTraceAnalysis usage examples

Source: https://www.jenkins.io/doc/pipeline/steps/ecutest

Examples of using publishTraceAnalysis. The first uses the default installation. The second uses an existing installation. The third and fourth create a new installation and call the method on the instance. Note the fourth example has a missing opening quote for installPath.

```groovy
publishTraceAnalysis('ecu.test')
            
```

```groovy
def instance = ET.installation('ecu.test')
publishTraceAnalysis installation: instance.installation, mergeReports: true, createReportDir: false
            
```

```groovy
def instance = ET.newInstallation('ecu.test', 'C:\Program Files\ECU-TEST 8.0')
instance.publishTraceAnalysis()
            
```

```groovy
def instance = ET.newInstallation toolName: 'ecu.test', installPath: C:\Program Files\ECU-TEST 8.0'
instance.publishTraceAnalysis mergeReports: true, createReportDir: false, timeout: 120, allowMissing: true, runOnFailed: true, archiving: true, keepAll: true
            
```

--------------------------------

### startET

Source: https://www.jenkins.io/doc/pipeline/steps/ecutest

Methods to start an ecu.test installation.

```APIDOC
## startET(String toolName) : void

### Description
Configure and start a preconfigured ecu.test installation.

### Method
startET

### Parameters
- **toolName** (String) - Required - The name of the ecu.test installation.

### Request Example
```groovy
startET('ecu.test')
```

### Response
No return value (void).

```

```APIDOC
## startET(String toolName, String workspaceDir, String settingsDir, int timeout, boolean debugMode, boolean keepInstance, boolean updateUserLibs) : void

### Description
Configure and start a preconfigured ecu.test installation with additional settings.

### Method
startET

### Parameters
- **toolName** (String) - Required - The name of the ecu.test installation.
- **workspaceDir** (String) - Optional - The workspace directory.
- **settingsDir** (String) - Optional - The settings directory.
- **timeout** (int) - Optional - Timeout in seconds.
- **debugMode** (boolean) - Optional - Enable debug mode.
- **keepInstance** (boolean) - Optional - Keep the instance running.
- **updateUserLibs** (boolean) - Optional - Update user libraries.

### Request Example
```groovy
startET('ecu.test', 'C:\\Data', 'C:\\Data', 120, true, false, true)
```

### Response
No return value (void).

```

```APIDOC
## ETInstance.start() : void

### Description
Start the ecu.test instance.

### Method
start

### Parameters
None.

### Request Example
```groovy
instance.start()
```

### Response
No return value (void).

```

```APIDOC
## ETInstance.start(String workspaceDir, String settingsDir, int timeout, boolean debugMode, boolean keepInstance, boolean updateUserLibs) : void

### Description
Start the ecu.test instance with additional settings.

### Method
start

### Parameters
- **workspaceDir** (String) - Optional - The workspace directory.
- **settingsDir** (String) - Optional - The settings directory.
- **timeout** (int) - Optional - Timeout in seconds.
- **debugMode** (boolean) - Optional - Enable debug mode.
- **keepInstance** (boolean) - Optional - Keep the instance running.
- **updateUserLibs** (boolean) - Optional - Update user libraries.

### Request Example
```groovy
instance.start('C:\\Data', 'C:\\Data', 120, true, false, true)
```

### Response
No return value (void).

```

```APIDOC
## ETInstance.start(Map<String, Object> settings) : void

### Description
Start the ecu.test instance with a map of settings.

### Method
start

### Parameters
- **settings** (Map<String, Object>) - Required - A map of settings. Supported keys include: `workspaceDir`, `settingsDir`, `timeout`, `debugMode`, `keepInstance`, `updateUserLibs`.

### Request Example
```groovy
instance.start([workspaceDir: 'C:\\Data', settingsDir: 'C:\\Data', timeout: 120, debugMode: true, keepInstance: false, updateUserLibs: true])
```

### Response
No return value (void).

```

--------------------------------

### publishGenerators example with ET.installation

Source: https://www.jenkins.io/doc/pipeline/steps/ecutest

Example of using the publishGenerators step with an installation obtained from ET.installation.

```groovy
def instance = ET.installation('ecu.test')
publishGenerators installation: instance.installation, generators: [[name: 'JSON']]
```

--------------------------------

### Prepare a reference git repository with multiple submodule remotes.fetch all updates for multiple submodules via git fetch --all in a --bare git init'd bare git init'directory, then `git fetch --description git://remote add SubProject1/2 https://(unspecified.com)/subproject2, fetch --all to update all configured remotes to fetch all configured sub-libraries simultaneously; used to prepare a reference git directory for sparse checkout/submodule options requiring git >=1.instaplus; ensure you replace the URLs with actual URLs and ensure git is at least 30 days.primary language: bash/code_list_language_and_code_string /bin/bash code:=

Source: https://www.jenkins.io/doc/pipeline/steps/workflow-scm-step

Useful when configuring sparseCheckPaths/submodule options that need a reference repository prepared in bare git init bare; git fetch --all updates all remotes fetched earlier with git remote add SubProject1/2.xyz/subproject2, fetch --all updates all configured remouthly, and the example assumes git installed and accessible in the build or scripted pipeline shell/bash shell/bash interpreter; replace URLs as needed and ensure git is at 'least >1. 

```bash (Git commands in a POSIX-like shell/bash/bash-compatible environment; adjust for Windows cmd.exe would-be-d) — language tag derived from fence-less Git shell commands displayed in docs pagegit@example.com:user1/subproj1.git https://example.com/user2/subcode for git remote add SubProject1 https://gitrepo.com/subproject1
git init --bare https://example.com/subproject1 https://oops-not-a-原文原样copy the exact code exactly as displayed in the source exactly once exactly once exactly once? -.- language:bash_and_syntax_escaping:

I apologize, I am a, I am a language model, I am a 
```

--------------------------------

### Excluded user name example

Source: https://www.jenkins.io/doc/pipeline/steps/workflow-multibranch

Example of an excluded user name for the UserExclusion extension. Each exclusion uses exact string comparison and must be separated by a new line.

```text
auto_build_user
```

--------------------------------

### Groovy script for custom parser using matcher and builder

Source: https://www.jenkins.io/doc/pipeline/steps/warnings-ng

Use this Groovy script as a starting point for a custom parser. It composes a new warning using the matcher of the regular expression `^\s*(.*):(\d+):(.*):\s*(.*)$`. The script receives the `matcher` and `builder` variables, and must return an `Optional<Issue>`. Use `buildOptional()` to wrap the issue; return `Optional.empty()` for false positives.

```groovy
import edu.hm.hafner.analysis.Severity

builder.setFileName(matcher.group(1))
        .setLineStart(Integer.parseInt(matcher.group(2)))
        .setSeverity(Severity.WARNING_NORMAL)
        .setCategory(matcher.group(3))
        .setMessage(matcher.group(4))

return builder.buildOptional();
  
```

--------------------------------

### Groovy script to create an Issue from a Matcher

Source: https://www.jenkins.io/doc/pipeline/steps/warnings-ng

Groovy script for the Warnings Next Generation plugin that processes a Matcher instance to create an Issue. It uses the provided builder to set file name, line start, severity, category, and message from regex groups, then returns an Optional via buildOptional(). The script must return Optional<Issue> and can use variables like fileName and lineNumber.

```groovy
import edu.hm.hafner.analysis.Severity

builder.setFileName(matcher.group(1))
        .setLineStart(Integer.parseInt(matcher.group(2)))
        .setSeverity(Severity.WARNING_NORMAL)
        .setCategory(matcher.group(3))
        .setMessage(matcher.group(4))

return builder.buildOptional();
```

--------------------------------

### startET and ETInstance.start() examples

Source: https://www.jenkins.io/doc/pipeline/steps/ecutest

Examples for the startET step and the ETInstance.start() method. The last example uses named parameters and sets all optional arguments.

```groovy
startET('ecu.test')
```

```groovy
def instance = ET.installation('ecu.test')
startET installation: instance.installation, workspaceDir: 'C:\\Data'
```

```groovy
def instance = ET.newInstallation('ecu.test', 'C:\\Program Files\\ECU-TEST 8.0')
instance.start()
```

```groovy
def instance = ET.newInstallation toolName: 'ecu.test', installPath: C:\\Program Files\\ECU-TEST 8.0'
instance.start workspaceDir: 'C:\\Data', settingsDir: 'C:\\Data', timeout: 120, debugMode: true, keepInstance: false, updateUserLibs: true
```

--------------------------------

### isConfigStarted Usage Example

Source: https://www.jenkins.io/doc/pipeline/steps/ecutest

Example of checking the configuration status of an ecu.test installation. It gets an installation instance and then calls isConfigStarted() on it.

```groovy
def instance = ET.installation('ecu.test')
boolean isConfigStarted = instance.isConfigStarted()
```

--------------------------------

### startTS and ETInstance.startTS() examples

Source: https://www.jenkins.io/doc/pipeline/steps/ecutest

Examples for the startTS step and the ETInstance.startTS() method. The last example uses named parameters and sets all optional arguments.

```groovy
startTS('ecu.test')
```

```groovy
def instance = ET.installation('ecu.test')
startTS installation: instance.installation
```

```groovy
def instance = ET.newInstallation('ecu.test', 'C:\\Program Files\\ECU-TEST 8.0')
instance.startTS()
```

```groovy
def instance = ET.newInstallation toolName: 'ecu.test', installPath: C:\\Program Files\\ECU-TEST 8.0'
instance.startTS toolLibsIniPath: C:\\ToolLibs.ini, tcpPort: 5017, timeout: 60, keepInstance: false
```

--------------------------------

### stopTS usage examples

Source: https://www.jenkins.io/doc/pipeline/steps/ecutest

Examples of using stopTS. The first stops the default installation. The second uses an existing installation. The third creates a new installation and stops it. The fourth creates a new installation with named arguments and stops it with a timeout.

```groovy
stopTS('ecu.test')
            
```

```groovy
def instance = ET.installation('ecu.test')
stopTS installation: instance.installation
            
```

```groovy
def instance = ET.newInstallation('ecu.test', 'C:\Program Files\ECU-TEST 8.0')
instance.stopTS()
            
```

```groovy
def instance = ET.newInstallation toolName: 'ecu.test', installPath: C:\Program Files\ECU-TEST 8.0'
instance.stopTS timeout: 60
            
```

--------------------------------

### newETInstallation examples

Source: https://www.jenkins.io/doc/pipeline/steps/ecutest

Examples of the newETInstallation step. The first uses only tool name and install path; the second adds a program ID and timeout; the third uses named arguments.

```groovy
ET.newInstallation('ecu.test', 'C:\Program Files\ECU-TEST 8.0')
```

```groovy
ET.newInstallation('ecu.test', 'C:\Program Files\ECU-TEST 8.0', 'ECU-TEST.Application', 120)
```

```groovy
ET.newInstallation toolName: 'ecu.test', installPath: 'C:\Program Files\ECU-TEST 8.0', progId: 'ECU-TEST.Application', timeout: 120
```

--------------------------------

### step([$class: 'CreateVirtualService'])

Source: https://www.jenkins.io/doc/pipeline/steps/cavisson-ns-nd-integration

Creates a Cavisson service virtualization instance with the provided configuration and recording/replay file path.

```APIDOC
## step([$class: 'CreateVirtualService'])

### Description
Creates a Cavisson service virtualization instance with the provided configuration and recording/replay file path.

### Parameters
- **config** (String) - Required - Configuration string for the virtual service.
- **rrFilePath** (String) - Required - Path to the recording/replay file.
- **host** (String) - Required - Hostname or IP address of the service.
- **username** (String) - Required - Username for authentication.
- **password** (class hudson.util.Secret) - Required - Password for authentication.
- **isstart** (boolean) - Required - Whether to start the service immediately.
- **token** (class hudson.util.Secret) - Required - Authentication token.

```

--------------------------------

### startET and ETInstance.start() signatures

Source: https://www.jenkins.io/doc/pipeline/steps/ecutest

Signatures for the startET step and the ETInstance.start() method. Use these to configure and start a preconfigured ecu.test installation.

```groovy
startET(String toolName) : void
```

```groovy
startET(String toolName, String workspaceDir, String settingsDir, int timeout,
        boolean debugMode, boolean keepInstance, boolean updateUserLibs) : void
```

```groovy
ETInstance.start() : void
```

```groovy
ETInstance.start(String workspaceDir, String settingsDir, int timeout,
         boolean debugMode, boolean keepInstance, boolean updateUserLibs) : void
```

```groovy
ETInstance.start(Map<String, Object> settings) : void
```
Tokens:
Raw