Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jenkinsci/groovy-label-assignment-plugin

Jenkins plugin to set label dynamically with scripts
https://github.com/jenkinsci/groovy-label-assignment-plugin

adopt-this-plugin

Last synced: about 2 months ago
JSON representation

Jenkins plugin to set label dynamically with scripts

Host: GitHub
URL: https://github.com/jenkinsci/groovy-label-assignment-plugin
Owner: jenkinsci
Created: 2013-06-05T12:38:28.000Z (over 11 years ago)
Default Branch: master
Last Pushed: 2019-10-09T08:14:58.000Z (about 5 years ago)
Last Synced: 2024-10-08T11:43:47.842Z (3 months ago)
Topics: adopt-this-plugin
Language: Java
Homepage: https://plugins.jenkins.io/groovy-label-assignment/
Size: 62.5 KB
Stars: 1
Watchers: 104
Forks: 7
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

Groovy Label Assignment plugin
==============================

Japanese version of this document is README_ja.md

Jenkins plugin to set label dynamically with groovy scripts

What's this?
------------

Groovy Label Assignment is a [Jenkins](http://jenkins-ci.org/) plugin.
This plugin provides "Groovy script to restrict where this project can be run" to the job configuration page:

* The value returned from the script is treated as a label expression.
* This label expression overrides "Restrict where this project can be run", and "Slaves"/"Label-expression" axes of multi-configuration projects.
* A non-string values is converted into a string with `toString()`.
* Returning null or empty string does not override existing label expressions.
* Following variables are binded to the Groovy script:
* Parameters defined with "This build is parameterized".
* Axes defined with a multi-configuration project.
* Environment variables defined with plugins.
* A build does not start (trigger is ignored) in following cases:
* No groovy script is configured even though Groovy Label Assignment is enabled in the job.
* The groovy script contains syntax errors.
* The groovy script throws an exception at the runtime.

Use case 1
----------

Think a following scenario:

* You have to build a project for multiple platforms: arm, win, linux
* There are following nodes:

|Node|Label|arm|win|linux|
|:---|:----|:--|:--|:----|
|win1|vs2010,armcc|O|O|X|
|win2|armcc|X|O|X|
|linux|gcc|X|X|O|

You can manage this by using multi-configuration project as followings:

* Define a User-defined axis "platform": arm, win, linux
* Define a Slaves axis "slave": armcc, vs2010, gcc
* Define "Combination Filter" as following:

```
(platform == "arm" && slave=="armcc") || (platform == "win" && slave=="vs2010") || (platform == "linux" && slave=="gcc")
```

Groovy Label Assignment plugin provides following alternate solution:

* Define a User-defined axis "platform": arm, win, linux
* Define "Groovy script to restrict where this project can be run":

```
def labelMap = [
arm: "armcc",
win: "vs2010",
linux: "gcc",
];
return labelMap.get(binding.getVariables().get("platform"));
```

Use case 2
----------

Consider to create a job with which developers build a source tree.

* You want developers can build both a release build and a snapshot with that job. Developers select release or snapshot when they trigger a build.
* Release build must be built on nodes labeled "RELEASE" for releasing. Snapshot build must be built not on those nodes, but on other nodes.

You can create a satisfying job by using Groovy Label Assignment plugin:

* Parameterize the job.
* Define a Boolen Value parameter "release", which specifies the triggering build is for release.
* Define "Groovy script to restrict where this project can be run":

```
return (release == "true")?"RELEASE":"!RELEASE"
```

Limitations
-----------

* Some variables may not be properly binded:
* Some type of parameters may be not properly binded.
* Environment variables of some type of plugins may be not properly binded.
* This is for Groovy Label Assignment plugin works when a build is going to be created, and is not created. Parameters and plugins that refers build information does not work properly.
* When Groovy Label Assignment plugin fails, a build is rejected silently. Failures happen in following cases. You can refer the system log to see why Groovy Label Assignment plugin failed.
* Groovy script is not defined.
* Groovy script contains syntax errors.
* Groovy script failed at the runtime.
* Especially in case referring non-binded variables. It often happens when running with multi-configuration project. In that case, you can access the variable safely as following:

```
binding.getVariables().get("variable-name");
```

* Returned value cannot be parsed as a label expression.

How does this work?
-------------------

This plugin works as following:

1. When a new build is triggerd, `GroovyLabelAssignmentQueueDecisionHandler` is called.
2. If `GroovyLabelAssignmentProperty` is assigned to the job, call it.
3. `EnvironmentContributingAction#buildEnvVars` is called for retrieving variables to bind to the Groovy script.
* Parameters are defined here.
4. Retrieve axes values configured to that job and bind to the Groovy script.
5. Run Groovy script.
6. Parse returned value as a label expression.
7. Assign it with `LabelAssignmentAction`.