Version 11 vs 35
Version 11 vs 35
Content Changes
Content Changes
* Our build system is Jenkins and hosted at https://jenkins.c4science.ch
## Create a new Job
* Create a new Item of type "Freestyle project", give it a name
* 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
* You have access to differents build environment, you can choose on by clicking on "Restrict where this project can be run" with the following values
** ubuntu: Ubuntu Trusty 14.04.4 LTS x86_64
** centos: Centos 7.2 x86_64
** More to come
### 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/
* Add a new Build Step of type "Make HTTP Request"
{F16204}
* You'll have to create a token on your Jenkins job, go to your job configuration page 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`
* Go back to your Build step on Phabricator and add the following URL, `https://jenkins.c4science.ch/buildByToken/build?PHID=${target.phid}&token=<your token>&job=<your job name>`
* Select "Wait For Message" on the //When Complete// field.
* Save your step
{F16207}
#### Herald (Notification and action)
* Go to Herald, https://c4science.ch/herald/
* Create a new Rule on Commits of type Global
* 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
{F16202, size=full}
* Our build system is Jenkins and hosted at https://jenkins.c4science.ch
# How to do Continuous Integration (CI)
There are two ways of doing unit testing in c4science
* [[#using-jenkins-on-c4scien | With Jenkins or external build system (advanced)]]
* [[#using-arcanist-on-your-l | With Arcanist when doing code review or manually (simple)]]
# Using Jenkins on c4science
### Access
Jenkins on c4science is in private beta mode. You can [[https://c4science.ch/maniphest/task/edit/form/8/?title=Jenkins%20access | ask to have access]]. Once you're given access to the group #jenkins_access
you will see a `Jenkins Job` tab on every of your repository and a `Create Jenkins Job`on your Project.
### How this works
You can create a new Job from a Project page or from the [[/jobs | Jenkins application]]. You'll have to provide a Project that will be used as Policy for the job. Only the people in the Project will have access to the Job on Jenkins. You also have to provide a branch the Job will use.
Once you created the job, a Harbormaster build plan and a Herald commit rule will automatically be created. The Herald rule triggers the Harbormaster build plan on new commit on the Repository/Branch couple. The build plan then call the new Jenkins Job.
You can see the status of the job from the Project page and the Repository page, as well as the link to the Jenkins job.
### Jenkinsfile
The most important part of the setup is the Jenkinsfile. It is a file that must be present in your repository/branch the job will execute against. This file contains a set of options and command that define your Job.
#### Examples
- You can find basic example in this repo: rPHJENKINS and discuss about the experience in the [[https://c4science.ch/conpherence/84/|chatroom]]
- A very good set of examples can be found in the rMUSPECTRE repository https://c4science.ch/source/muSpectre/browse/master/Jenkinsfile : ReadTheDocs trigger, gcc warnings, diffusion interaction (build result posted back to c4science), Jenkins artifacts referenced in the Harbormaster build, ...
# Using Arcanist on your local machine
We'll be using a community extensions to integrate your custom unit test engine with Phabricator. This extensions allows any [[https://testanything.org/|TAP]] compatible engine to be used. You can also write your own engine, [[https://secure.phabricator.com/book/phabricator/article/arcanist_lint_unit/|take a look at the documentation]].
* In your repository
* Add the lib as a submodule
```
git submodule add https://github.com/tagview/arcanist-extensions.git .arcanist-extensions
git submodule update --init
```
* Create an `.arcconfig` file with the following content
```{
"load": [
".arcanist-extensions/tap_test_engine"
],
"unit.engine": "TAPTestEngine",
"unit.engine.tap.command": "your_unit_test_script.sh"
}
```
* Replace `your_unit_test_script.sh` by a script in your repository that do the unit testing and returns the result in a [[https://testanything.org/producers.html|TAP format]]
* For instance if your code is in python, you can use `tap.py`, see the example in rPHTEST
* Those tests can be run by using the `arc unit` command or it will be run automatically when you create a Differential Revision using Arcanist (`arc diff`)
* Our build system is Jenkins and hosted at https://jenkins.c4science.ch
## Create a new Job# How to do Continuous Integration (CI)
There are two ways of doing unit testing in c4science
* Create a new Item of type "Freestyle project", give it a name* [[#using-jenkins-on-c4scien | With Jenkins or external build system (advanced)]]
* 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,[[#using-arcanist-on-your-l | With Arcanist when doing code review or manually (simple)]]
# Using Jenkins on c4science
### Access
Jenkins on c4science is in private beta mode. you have to create a new Creadential for it, for instance using an SSH key with your Phabricator username,You can [[https://c4science.ch/maniphest/task/edit/form/8/?title=Jenkins%20access | ask to have access]]. 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,Once you're given access to the group #jenkins_access
you will see a `Jenkins Job` tab on every of your repository and a `Create Jenkins Job`on your Project.
### How this works
You can create a new Job from a Project page or from the [[/jobs | Jenkins application]]. You'll have to provide a Project that will be used as Policy for the job. add a Build step,Only the people in the Project will have access to the Job on Jenkins. select Execute Shell andYou also have to provide the command to run your tests
* You have access to differents build environmenta branch the Job will use.
Once you created the job, you can choose on by clicking on "Restrict where this project can be run" with the following values
** ubuntu: Ubuntu Trusty 14.04.4 LTS x86_64
** centos: Centos 7.2 x86_64
** More to coma Harbormaster build plan and a Herald commit rule will automatically be created. The Herald rule triggers the Harbormaster build plan on new commit on the Repository/Branch couple. The build plan then call the new Jenkins Job.
You can see the status of the job from the Project page and the Repository page, as well as the link to the Jenkins job.
### Jenkinsfile
### Trigger build on commitThe most important part of the setup is the Jenkinsfile. It is a file that must be present in your repository/branch the job will execute against. This file contains a set of options and command that define your Job.
* You can trigger a build from Phabricator using Harbormaster and Herald applications, either on commit or on differential#### Examples
#### Harbormaster (run build)- You can find basic example in this repo: rPHJENKINS and discuss about the experience in the [[https://c4science.ch/conpherence/84/|chatroom]]
* Create a Build Plan for your repository- A very good set of examples can be found in the rMUSPECTRE repository https://c4science.ch/source/muSpectre/browse/master/Jenkinsfile : ReadTheDocs trigger, gcc warnings, diffusion interaction (build result posted back to c4science), https://c4sciJenkins artifacts reference.ch/hd in the Harbormaster/plan/
* Add a new Build Step of type "Make HTTP Request" build, ...
# Using Arcanist on your local machine
{F16204}We'll be using a community extensions to integrate your custom unit test engine with Phabricator. This extensions allows any [[https://testanything.org/|TAP]] compatible engine to be used. You can also write your own engine, [[https://secure.phabricator.com/book/phabricator/article/arcanist_lint_unit/|take a look at the documentation]].
* You'll have to create a token on your Jenkins job, go to your job configuration page under Build Triggers, tick "Trigger builds remotely" and create a token.In your repository
* Add the lib as a submodule
** The best would be some random string, you can generate one like this on a linux shell: `head -c 16 /dev/urandom | md5sum````
* Go back to your Build step on Phabricator and add the following URL, `https://jenkins.c4science.ch/buildByToken/build?PHID=${target.phid}&token=<your token>&job=<your job name>`git submodule add https://github.com/tagview/arcanist-extensions.git .arcanist-extensions
* Select "Wait For Message" on the //When Complete// field.git submodule update --init
* Save your step```
{F16207}
#### Herald (Notification and action)
* Go to Herald, https://c4science.ch/herald/* Create an `.arcconfig` file with the following content
```{
"load": [
".arcanist-extensions/tap_test_engine"
* Create a new Rule on Commits of type Global ],
"unit.engine": "TAPTestEngine",
* Give it a name and select the condition as "Repository is any of <your repository>" "unit.engine.tap.command": "your_unit_test_script.sh"
* 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.Replace `your_unit_test_script.sh` by a script in your repository that do the unit testing and returns the result in a [[https://testanything.org/producers.html|TAP format]]
* You can access the jenkins job build* For instance if your code is in the harbormaster buildpython, under artifactsyou can use `tap.py`, as shown on this imagesee the example in rPHTEST
{F16202, size=full}* Those tests can be run by using the `arc unit` command or it will be run automatically when you create a Differential Revision using Arcanist (`arc diff`)
c4science · Help