Unit Tests

Updated 2,758 Days AgoPublic

Actions

• Our build system is Jenkins and hosted at https://jenkins.c4science.ch
• Phabricator also includes support for CircleCI

How to do continuous integration

Here are the step that you have to setup, detailed in the following sections.

• Create a Jenkins Job with parameters
• Create a Build Plan on Harbormaster which will trigger the Job
• Create an Herald rule which will trigger the Build Plan

Create a new Job

• Create a new Item of type "Freestyle project", give it a name

• If you want to trigger the build from Herald on a new Diffusion or Commit: choose "This build is parameterized" and add a new String Parameter with the name PHID

• Select Git as source code management and put the URL of the repository
  • If your repository is private, you have to create a new Creadential for it, for instance using an SSH key with your Phabricator username, You'll add the public key to your phabricator profile: https://c4science.ch/settings/panel/ssh/

• If you want to periodically build the project, select the option under Build triggers and use this syntax H/30 * * * * to build every 30 mn. See complete documentation about the syntax by clicking on the question mark on the right of the field

• To run your unit test, add a Build step, select Execute Shell and provide the command to run your tests

• If you want to specify the docker image, you can choose on by clicking on "Restrict where this project can be run" with the following values
  • ubuntu:trusty Ubuntu Trusty 14.04.4 LTS x86_64
  • centos:7 Centos 7.2 x86_64
  • More to come

• If you want to trigger the build from Phabricator, under Build Triggers, tick "Trigger builds remotely" and create a token.
  • The best would be some random string, you can generate one like this on a linux shell: head -c 16 /dev/urandom | md5sum
• To have the status reported back to Phabricator, add the "Post to Phabricator" post-build step

Trigger build on commit

• You can trigger a build from Phabricator using Harbormaster and Herald applications, either on commit or on differential

Harbormaster (run build)

• Create a Build Plan for your repository, https://c4science.ch/harbormaster/plan/
• You'll have to create a custom policy so yourself can view and edit, as well as the @jenkins user

• Add a new Build Step of type "Make HTTP Request"

• Add the following URL, https://jenkins.c4science.ch/buildByToken/buildWithParameters?PHID=${target.phid}&token=<your token>&job=<your job name>
• Select "GET" on the HTTP Method field
• Select "Wait For Message" on the When Complete field.
• Save your step

Herald (Notification and action)

• Go to Herald, https://c4science.ch/herald/
• Create a new Rule on Commits of type Object
• Put the reference of your object, the repository ID (rXX) or callsign (rCALLSIGN)
• Give it a name and select the condition as "Repository is any of <your repository>"
• Then select the "Run build plans" action with your newly created Build plan
• Save the rule
• Now when a commit is pushed on your repository, a build will be generated on your Jenkins job and the result will be reported back to phabricator.
• You can access the jenkins job build in the harbormaster build, under artifacts, as shown on this image