{jenkins-plugin-info:pluginId=pretested-integration|jiraComponent=pretested-integration}

Developed by

Sponsored by

Introduction

The Pretested Integration Plugin offers a branchy approach to pretested integration (also known as pre-tested commits), which upholds the invariant; that for a specific branch, known as the integration branch, all commits have been verified.


This plugin is developed by Praqma and sponsored by Atmel - It's maintained in the scope of Joint Open Source Roadmap Alliance (JOSRA).

The plugin rely on the SCM plugin to establish the workspace and then takes over to do the integration. Last the job make the decision whether to like and commit the result or hate and discard it. To get a comprehensive introduction to how the plugin relies on the SCM plugin please read the blog post at the JOSRA: Pretested Integration Plugin.

References

Limitations, requirements and dependencies

Support and contact

Please send us an email on support@praqma.net if you have a request or question regarding the plugin.

If you find an error or have feature requests, use the Jenkins issue tracker.

Comments and discussions on this page might not always be noticed.

The recommend setup and git workflow

Here is a simple git workflow where you can work on a features branch, and when ready push to a ready-branch. The Pretested Integration plugin, if configured as described will then pick up your changes, merge them and verify them. If verified they are integrated on the integration branch. The ready branch are automatically deleted if integration was successful.

Recommendation:

The simple plugin configuration

To configure the plugin to pick up ready branches, verify them and deliver them to the integration branch use the following configuration:


Configure the SCM as above.

  • Recommend ready branch specifier is the 'Branch Speciifier' : ready/**
  • Remember to add the two additional behaviours to ensure a clean work space and that old deleted branches are cleaned
  • It is recommended to name your repository in the 'Name' field.


Configure the Pretested Integration plugin with integration branch 'master' and the named repository 'origin'.
There is a Pretested Integration plugin post-build step, which ensure verified changes are published. You don't have to configure it - it is automatically added.

Now you only need to configure your definition of done - the verification. How should the job verify the commits? It can be compile and measure compiler warning, build and run unit tests and check that coverage do not drop.

The simple Git workflow

Get your repository up to date:

git fetch --prune

git checkout master

git pull origin master

Create a feature- or development- or... branch

git checkout -b feat_1337-improved-login-screen

...work, stage and commit changes.

Then push changes to a ready branch, which is basically just a branch following a naming conventions for branches matching ready/**.

git push origin feat_1337-improved-login-screen:ready/feat_1337-improved-login-screen

The change will be picked up by the plugin if configured as shown in next section.

Help and error messages

*NOT YET DONE - work in progress* (We have gathered some common errors and problems seen, together with some suggested solutions - Help and error messages)

Demo jobs and example on commit messages and output

We have created some Jenkins job on our public Jenkins master that shows the plugin in action, in the version we have installed (typically latest one or even latest snapshop).

There is actually a demo job you can run, that triggers a demonstration:

The commits end up in our Github test repository called blackhole

Accumulated strategy - build console output

Version 2.3.0

Version 2.2.3

[PREINT] Preparing environment using Pretested Integration Plugin 2.3.0-SNAPSHOT (cbd24) 
[PREINT] Checking out integration branch master:
[PREINT]  git checkout -B master origin/master
[pretested-integration-plugin__demo-job-accumulated-strategy] $ git checkout -B master origin/master
[PREINT]  git pull origin master
[pretested-integration-plugin__demo-job-accumulated-strategy] $ git pull origin master
[PREINT] Preparing to merge changes in commit b1e190f90a8c1a22402af4492c70ae45eb32c981 on development branch origin/ready/feature-accumulated-32 to integration branch master
[PREINT] Collecting commit messages on development branch origin/ready/feature-accumulated-32
[PREINT] Done collecting commit messages
[PREINT] Collecting author of last commit on development branch
[PREINT] Done colecting last commit author: demo-job-user <support@praqma.net> 1435686815 +0200
[PREINT] Starting accumulated merge (no-ff) - without commit:
[PREINT]  git merge -m "Accumulated commit of the following from branch 'origin/ready/feature-accumulated-32':

commit b1e190f90a8c1a22402af4492c70ae45eb32c981
Author: demo-job-user <support@praqma.net>
Date:   Tue Jun 30 19:53:35 2015 +0200

    Demo commit message for Pretested Integration:
    
    This is a longer commit message about what this commit is about.
    
    We use this commit to illustrate the Prested Integration Plugin commit messages, based on their strategies. There are two demo jobs, one for each strategy and a job that does two commits, one on two different branches to be picked up as ready branches.
    

" b1e190f90a8c1a22402af4492c70ae45eb32c981 --no-ff --no-commit
[pretested-integration-plugin__demo-job-accumulated-strategy] $ git merge -m "Accumulated commit of the following from branch 'origin/ready/feature-accumulated-32':

commit b1e190f90a8c1a22402af4492c70ae45eb32c981
Author: demo-job-user <support@praqma.net>
Date:   Tue Jun 30 19:53:35 2015 +0200

    Demo commit message for Pretested Integration:
    
    This is a longer commit message about what this commit is about.
    
    We use this commit to illustrate the Prested Integration Plugin commit messages, based on their strategies. There are two demo jobs, one for each strategy and a job that does two commits, one on two different branches to be picked up as ready branches.
    

" b1e190f90a8c1a22402af4492c70ae45eb32c981 --no-ff --no-commit
[PREINT] Accumulated merge done
[PREINT] Merge was successful
[PREINT] Starting to commit accumulated merge changes:
[PREINT]  git commit --no-edit "--author=demo-job-user <support@praqma.net> 1435686815 +0200"
[pretested-integration-plugin__demo-job-accumulated-strategy] $ git commit --no-edit "--author=demo-job-user <support@praqma.net> 1435686815 +0200"
[PREINT] Commit of accumulated merge done
[PREINT] Commit was successful
[pretested-integration-plugin__demo-job-accumulated-strategy] $ /bin/sh -xe /tmp/hudson2956180739635715796.sh
+ echo Build and verification was successful
Build and verification was successful
[PREINT] Performing pre-verified post build steps
[PREINT] Pushing changes to integration branch:
[PREINT]  git push origin master
[pretested-integration-plugin__demo-job-accumulated-strategy] $ git push origin master
[PREINT] Done pushing changes
[PREINT] Deleting development branch:
[PREINT]  git push origin :ready/feature-accumulated-32
[pretested-integration-plugin__demo-job-accumulated-strategy] $ git push origin :ready/feature-accumulated-32
[PREINT] Done deleting development branch
[PREINT] Preparing environment using Pretested Integration Plugin 2.2.3 (5f8d7) 
Checking out integration target branch master and pulling latest changes
[PREINT]  git checkout -B master origin/master
[pretested-integration-plugin__demo-job-accumulated-strategy] $ git checkout -B master origin/master
[PREINT]  git pull origin master
[pretested-integration-plugin__demo-job-accumulated-strategy] $ git pull origin master
Preparing to merge changes in commit f2a7164be5c64c452f19a5eeeb0a0566fd3fecde to integration branch master
[PREINT]  git merge -m "Accumulated commit of the following from branch 'origin/ready/feature-accumulated-31':

commit f2a7164be5c64c452f19a5eeeb0a0566fd3fecde
Author: demo-job-user <support@praqma.net>
Date:   Tue Jun 30 05:48:32 2015 +0200

    Demo commit message for Pretested Integration:
    
    This is a longer commit message about what this commit is about.
    
    We use this commit to illustrate the Prested Integration Plugin commit messages, based on their strategies. There are two demo jobs, one for each strategy and a job that does two commits, one on two different branches to be picked up as ready branches.
    

" f2a7164be5c64c452f19a5eeeb0a0566fd3fecde --no-ff
[pretested-integration-plugin__demo-job-accumulated-strategy] $ git merge -m "Accumulated commit of the following from branch 'origin/ready/feature-accumulated-31':

commit f2a7164be5c64c452f19a5eeeb0a0566fd3fecde
Author: demo-job-user <support@praqma.net>
Date:   Tue Jun 30 05:48:32 2015 +0200

    Demo commit message for Pretested Integration:
    
    This is a longer commit message about what this commit is about.
    
    We use this commit to illustrate the Prested Integration Plugin commit messages, based on their strategies. There are two demo jobs, one for each strategy and a job that does two commits, one on two different branches to be picked up as ready branches.
    

" f2a7164be5c64c452f19a5eeeb0a0566fd3fecde --no-ff
[pretested-integration-plugin__demo-job-accumulated-strategy] $ /bin/sh -xe /tmp/hudson4752198164619580916.sh
+ echo Build and verification was successful
Build and verification was successful
Performing pre-verified post build steps
[PREINT-GIT] Commiting changes
[PREINT]  git push origin master
[pretested-integration-plugin__demo-job-accumulated-strategy] $ git push origin master
[PREINT-GIT] Deleting development branch
[PREINT]  git push origin :ready/feature-accumulated-31
[pretested-integration-plugin__demo-job-accumulated-strategy] $ git push origin :ready/feature-accumulated-31

Accumulated demo job example #32

Accumulated demo job example #31

Squashed strategy - build console output

Version 2.3.0

Version 2.2.3

[PREINT] Preparing environment using Pretested Integration Plugin 2.3.0-SNAPSHOT (cbd24) 
[PREINT] Checking out integration branch master:
[PREINT]  git checkout -B master origin/master
[pretested-integration-plugin__demo-job-squashed-strategy] $ git checkout -B master origin/master
[PREINT]  git pull origin master
[pretested-integration-plugin__demo-job-squashed-strategy] $ git pull origin master
[PREINT] Preparing to merge changes in commit 26576c087d13a50179a13054cc6edac603271abd on development branch origin/ready/feature-squashed-32 to integration branch master
[PREINT] Collecting commit messages on development branch (for debug printing): origin/ready/feature-squashed-32
[PREINT] Done collecting commit messages
[PREINT] Collecting author of last commit on development branch
[PREINT] Done colecting last commit author: demo-job-user <support@praqma.net> 1435686849 +0200
[PREINT] Starting squash merge - without commit:
[PREINT]  git merge --squash origin/ready/feature-squashed-32
[pretested-integration-plugin__demo-job-squashed-strategy] $ git merge --squash origin/ready/feature-squashed-32
[PREINT] Squash merge done
[PREINT] Merge was successful
[PREINT] Starting to commit squash merge changes:
[PREINT]  git commit --no-edit "--author=demo-job-user <support@praqma.net> 1435686849 +0200"
[pretested-integration-plugin__demo-job-squashed-strategy] $ git commit --no-edit "--author=demo-job-user <support@praqma.net> 1435686849 +0200"
[PREINT] Commit of squashed merge done
[PREINT] Debug print - commit message for squash merge:
Demo commit message for Pretested Integration:

This is a longer commit message about what this commit is about.

We use this commit to illustrate the Prested Integration Plugin commit messages, based on their strategies. There are two demo jobs, one for each strategy and a job that does two commits, one on two different branches to be picked up as ready branches.

[PREINT] Commit was successful
[pretested-integration-plugin__demo-job-squashed-strategy] $ /bin/sh -xe /tmp/hudson3927922213950794742.sh
+ echo Build and verification was successful
Build and verification was successful
[PREINT] Performing pre-verified post build steps
[PREINT] Pushing changes to integration branch:
[PREINT]  git push origin master
[pretested-integration-plugin__demo-job-squashed-strategy] $ git push origin master
[PREINT] Done pushing changes
[PREINT] Deleting development branch:
[PREINT]  git push origin :ready/feature-squashed-32
[pretested-integration-plugin__demo-job-squashed-strategy] $ git push origin :ready/feature-squashed-32
[PREINT] Done deleting development branch
[PREINT] Preparing environment using Pretested Integration Plugin 2.2.3 (5f8d7) 
Checking out integration target branch master and pulling latest changes
[PREINT]  git checkout -B master origin/master
[pretested-integration-plugin__demo-job-squashed-strategy] $ git checkout -B master origin/master
[PREINT]  git pull origin master
[pretested-integration-plugin__demo-job-squashed-strategy] $ git pull origin master
Preparing to merge changes in commit 4f0f6c07291d1b936918fa79823e523ce6fb0aab to integration branch master(94c9c678b20c6486df218e356887f64f76c01227)
[PREINT]  git merge --squash origin/ready/feature-squashed-31
[pretested-integration-plugin__demo-job-squashed-strategy] $ git merge --squash origin/ready/feature-squashed-31
[PREINT]  git commit --no-edit
[pretested-integration-plugin__demo-job-squashed-strategy] $ git commit --no-edit
Commit message:
Demo commit message for Pretested Integration:

This is a longer commit message about what this commit is about.

We use this commit to illustrate the Prested Integration Plugin commit messages, based on their strategies. There are two demo jobs, one for each strategy and a job that does two commits, one on two different branches to be picked up as ready branches.

[pretested-integration-plugin__demo-job-squashed-strategy] $ /bin/sh -xe /tmp/hudson666893911441445345.sh
+ echo Build and verification was successful
Build and verification was successful
Performing pre-verified post build steps
[PREINT-GIT] Commiting changes
[PREINT]  git push origin master
[pretested-integration-plugin__demo-job-squashed-strategy] $ git push origin master
[PREINT-GIT] Deleting development branch
[PREINT]  git push origin :ready/feature-squashed-31

Squashed demo job example #32

Squashed demo job example #31

Accumulated strategy - commit message

Version 2.3.0

Version 2.2.3

Squashed strategy - commit message

Version 2.3.0

Version 2.2.3

Manual building

In general you are not able to use 'Build now' with a pretested integration job configuration. The Pretested Integration Plugin is first in action when a "workspace" is handed over from the Git Plugin (or Multiple SCMs Plugin), and typically those will serve the last build revision again. If that succeeded last time, the revision is deleted after the integration and retrying the integration fails.

Some successful and failing cases using manual builds are:

You are welcome to contribute with ideas and use-cases for manual build and support for it on the roadmap in the Trello board.

Using multiple repository configurations

The plugin is designed to work on only one repository - as in you can only integrate on one repository pr. Jenkins job, but your Jenkins job can be used with multiple repositories for eg. checking out several repositories into a given folder structure you need for building the software. Though we consider this a work-around for not having the right dependency management, it can be done. You have the choice of using the Git Plugin or the Multiple SCMs Plugin, but need to follow the configuration examples below.

Requirements if using multiple repository jobs

Every repository should be explicitly and uniquely named* in the git repository configuration under 'Advanced'. Then use this as integration repository in the prested integration configuration

Example with multiple git repositories

  • The two repositories 'capital-letters' and 'numbers' are checked out to the same workspace.
  • 'numbers' are the repository that is being integrated, so the branch specifier will typically match that patter ('capital-letters' might just be needed for building)
  • The pretested integration configuration now explicitly states that the 'numbers' repository is the integration repository.
  • Also remember to add the two additional behaviours to ensure a clean work space and that old deleted branches are cleaned

Basically the same setup needs to be applied if using the Multiple SCMs plugin, but you can benefit from additional behaviours like checking each git repository out to a subdirectory if needed. Still every git repository must be explicitly and uniquely named.

Acknowledgement

Code contributions were initially made by Computer Science students at University of Copenhagen as part of a study project

Ronni Elken Lindsgaard
Alexander Winther Uldall
Esben Skaarup
Andreas Frisch

Issues

Changes

(unreleased) 2.3.0

Available as snapshot artifact in our Jenkins pipeline

Version 2.2.3
Version 2.2.1
Version 2.2.0
Version 2.1.2
Version 2.1.1
Version 2.1.0
Version 2.0
Version 1.1
Version 1.0