KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #developer-tools #ai-agent #claude-code #codex #typescript #ai-agents #deepseek-harness #mcp #cli #rust

fxtest-jenkins-pipeline

★ 42 Open GitHub ↗

DEPRECATED

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Shared libraries for Jenkins Pipeline
This repository holds
[shared libraries](https://jenkins.io/doc/book/pipeline/shared-libraries/) for
[Jenkins pipelines](https://jenkins.io/doc/book/pipeline/) used by
[Firefox Test Engineering](https://wiki.mozilla.org/TestEngineering).

[![Build Status](https://travis-ci.org/mozilla/fxtest-jenkins-pipeline.svg?branch=master)](https://travis-ci.org/mozilla/fxtest-jenkins-pipeline)

# Pipeline Steps
## ircNotification
Sends a notification to IRC with the specified `channel`, `nick`, and `server`.
By default it will connect to `irc.mozilla.org:6697` as `fxtest` and join the
`#fx-test-alerts` channel.

### Examples
```groovy
// use defaults
ircNotification()

// specify a channel
ircNotification('#fx-test-alerts')

// specify all values
ircNotification(
  channel: '#fx-test-alerts',
  nick: 'fxtest',
  server: 'irc.mozilla.org:6697'
)
```

## publishToPulse
Publishes a `message`, to [Pulse] with the specified `exchange` and
`routingKey`. If a schema is provided then it will be used to check that the
message is valid. If the message fails to pass validation, details will be
output to the console log and `ProcessingException` will be thrown.

### Requirements
* Pulse credentials to be configured in Jenkins.
* [Pipeline Model Definition Plugin] v1.2 or later.
* [Pipeline Utility Steps Plugin].

### Examples
```groovy
// configure environment variables from credentials
environment {
  PULSE = credentials('PULSE')
}

// send message without schema validation
publishToPulse(
  exchange: "exchange/${PULSE_USR}",
  routingKey: "${PULSE_USR}.foo",
  message: 'foo'
)

// send message with schema validation from resources
schema = libraryResource 'org/mozilla/fxtest/pulse/schemas/treeherder.json'
publishToPulse(
  exchange: "exchange/${PULSE_USR}",
  routingKey: "${PULSE_USR}.foo",
  message: 'foo',
  schema: schema
)
```

## publishToS3
Publishes the files at `path` to the specified Amazon S3 `bucket` and `region`.
Defaults to region `us-east-1`.

### Requirements
* [Amazon S3] bucket with appropriate permissions.
* [S3 Plugin] with profile configured in Jenkins.

### Examples
```groovy
// single file with default bucket and region
publishToS3('results.html')

// multiple files with specified bucket and region
publishToS3(
  path: 'results/*',
  bucket: 'foo',
  region: 'bar'
)
```

## submitToActiveData
Publishes the structured log(s) at `logPath` to ActiveData.

### Requirements
See [publishToS3](#publishtos3).

### Examples
```groovy
submitToActiveData('results/raw.txt')
```

## submitToTreeherder
Submits the build result for `project` to [Treeherder] using the specified
`jobSymbol` and `jobName`. If provided, files located by `artifactPath` and
`logPath` will be published to Amazon S3 and linked from the build results. By
default the job will have a `groupSymbol` of 'j', and a `groupName` of
'Executed by Jenkins'. To leave the job ungrouped pass a `groupSymbol` of '?'.

### Requirements
See [publishToS3](#publishtos3) and [publishToPulse](#publishtopulse).

### Examples
```groovy
// submit default grouped build results without artifacts or logs
submitToTreeherder(
  project: 'foo',
  jobSymbol: 'T',
  jobName: 'Tests'
)

// submit ungrouped build results without artifacts or logs
submitToTreeherder(
  project: 'foo',
  jobSymbol: 'T',
  jobName: 'Tests',
  groupSymbol: '?'
)

// submit custom grouped build results with artifacts and log
submitToTreeherder(
  project: 'foo',
  jobSymbol: 'I',
  jobName: 'Integration tests',
  artifactPath: 'results/*',
  logPath: 'results/tbpl.txt',
  groupSymbol: 'T',
  groupName: 'Tests'
)
```

## writeCapabilities
Writes a JSON file containing the items from the `capabilities` map to the
specified `path` (for use by [pytest-selenium]). If omitted, the `path`
defaults to `capabilities.json` in the working directory.

### Examples
```groovy
capabilities = [
  browserName: 'Firefox',
  version: '51.0',
  platform: 'Windows 10'
]

// write capabilities to default path
writeCapabilities(capabilities)

// write capabilities to specified path
writeCapabilities(
  desiredCapabilities: capabilities,
  path: 'fx51win10.json'
)
```
# ServiceBook
## testProject
Queries the Service Book project API for the given project `name`, iterates over
its associated test repositories, checks them out from SCM, and executes their
```run``` file(s).  Finally, it returns ```exit 0``` on successful/passing
tests, and ```exit 1``` in the event of failed builds.

## Examples
```groovy
@Library('fxtest') _

def sb = new org.mozilla.fxtest.ServiceBook()  
sb.testProject('kinto')
```

## Requirements
* [HTTP Request Plugin] v1.8.20 or later.

# How to run tests

Make sure you have the latest Gradle install and run:

```sh
$ gradle check
BUILD SUCCESSFUL in 1s
2 actionable tasks: 2 up-to-date
```

# Version History

### 1.10 (2018-01-15)
* Remove superfluous test stage when using Service Book.
* Use `GIT_COMMIT` when reporting revision to Treeherder.

### 1.9 (2017-09-14)
* Fixed the production Service Book API URL

### 1.8 (2017-09-14)
* Greatly simplified Service Book API calls using the HTTP Request Plugin.

### 1.7 (2017-09-04)
* Introduced ```ServiceBook``` class, with ```testProject``` method to execute tests for all pipeline associated with the specified project name.

### 1.6 (2017-04-13)
* Changed TBPL log name to `buildbot_text` in Treeherder message for log parsing. ([#12](https://github.com/mozilla/fxtest-jenkins-pipeline/issues/12))
* Switched to YAML schema for Treeherder message validation. ([#2](https://github.com/mozilla/fxtest-jenkins-pipeline/issues/2))
* Added link to Treeherder results to console log. ([#11](https://github.com/mozilla/fxtest-jenkins-pipeline/issues/11))
* Provided a default group for Treeherder jobs. ([#13](https://github.com/mozilla/fxtest-jenkins-pipeline/issues/13))

### 1.5 (2017-03-31)
* Changed S3 profile to `fx-test-jenkins-s3-publisher`.

### 1.4 (2017-02-31)
* Introduced `publishToS3`, `publishToPulse`, and `submitToTreeherder` steps.

### 1.3 (2017-02-23)
* Don't mark jobs as unstable if `submitToActiveData` fails.

### 1.2 (2017-02-22)
* Added `submitToActiveData` step for publishing structured logs to S3 for processing by ActiveData.

### 1.1 (2017-02-13)
* Changed order of arguments for `ircNotification` for ease of specifying alternate channel.

### 1.0 (2017-02-13)
* Initial release with `ircNotification` and `writeCapabilities` steps.

[Pulse]: https://wiki.mozilla.org/Auto-tools/Projects/Pulse
[Pipeline Utility Steps Plugin]: https://wiki.jenkins-ci.org/display/JENKINS/Pipeline+Utility+Steps+Plugin
[S3 Plugin]: https://wiki.jenkins-ci.org/display/JENKINS/S3+Plugin
[Amazon S3]: https://aws.amazon.com/s3/
[Treeherder]: https://wiki.mozilla.org/Auto-tools/Projects/Treeherder
[pytest-selenium]: http://pytest-selenium.readthedocs.io/en/latest/user_guide.html#capabilities-files
[Pipeline Model Definition Plugin]: https://wiki.jenkins-ci.org/display/JENKINS/Pipeline+Model+Definition+Plugin
[HTTP Request Plugin]: https://wiki.jenkins.io/display/JENKINS/HTTP+Request+Plugin

fxtest-jenkins-pipeline

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README