Version 3 vs 35
Version 3 vs 35
Content Changes
Content Changes
# Unit tests
* 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
* 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
### Run builds from Phabricator
* You can also trigger a build from Phabricator
* Create a Build Plan for your repository, https://c4science.ch/harbormaster/plan/
* Add a new Build Step of type "Make HTTP Request"
* 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 /dev/urandom | md5sum`
* Go back to your Build step on Phabricator and add the following URL, `https://jenkins.c4science.ch/buildByToken/build?token=<your token>&job=<your job name>`
* Save your step
* 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
# Linters
* You can use various syntax checking tools when submitting patches to phabricator
### List available tools
```
arc linters
```
### Configuration of a specific linter for your project
* Create a .arclint file in your project with the desired linters
* In this example it has python, text, spelling and filename linters
```
{
"linters": {
"spelling-linter": {
"type": "spelling"
},
"filename-linter": {
"type": "filename"
},
"text-linter": {
"type": "text"
},
"python-checks": {
"type": "pylint",
"include": "(\\.py$)"
}
}
}
```
Checks all files with configured linters
```
arc lint --everything
```
* Complete documentation: https://secure.phabricator.com/book/phabricator/article/arcanist_lint/
# Official documentation
* Lint [[https://secure.phabricator.com/book/phabricator/article/arcanist_lint/]]
* 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`)
# Unit tests
* Our build system is Jenkins and hosted at https://jenkins.c4science.ch
## Create a new Job# How to do Continuous Integration (CI)
* Create a new Item of type "Freestyle project", give it a name
* 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 fieldThere are two ways of doing unit testing in c4science
* [[#using-jenkins-on-c4scien | With Jenkins or external build system (advanced)]]
* To run your unit test, add a Build step, select Execute Shell and provide the command to run your tests* [[#using-arcanist-on-your-l | With Arcanist when doing code review or manually (simple)]]
### Run builds from Phabricator# Using Jenkins on c4science
* You can also trigger a build from Phabricator
* Create a Build Plan for your repository,### Access
Jenkins on c4science is in private beta mode. https://c4science.ch/harbormaster/plan/
* Add a new Build Step of type "Make HTTP Request"
* You'll have to create a token on your Jenkins job,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
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 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 can generate one like this on a linux shell: `head /dev/urandom | md5sum`
* Go back to your Build step on Phabricator and add the following URL,You'll have to provide a Project that will be used as Policy for the job. `https://jenkins.c4science.ch/buildByToken/build?token=<your token>&job=<your job name>`
* Save your step
* Go to Herald,Only the people in the Project will have access to the Job on Jenkins. 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 repositoryYou 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, a build will be generated on youras well as the link to the Jenkins job.
# Linters### Jenkinsfile
* You can use various syntax checking tools when submitting patches to phabricatorThe 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.
### List available tools#### Examples
```
arc linters
```- 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
### Configuration of a specific linter for your projectWe'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]].
* Create a .arclint file i* In your project with the desired lintersrepository
* In this example it has python, text, spelling and filename linters* Add the lib as a submodule
```
{
"linters": {
"spelling-linter": {
"type": "spelling"
},
"filename-linter": {git submodule add https://github.com/tagview/arcanist-extensions.git .arcanist-extensions
"type": "filename"git submodule update --init
},
"text-linter": {```
* Create an `.arcconfig` file with the following content
"type": "text"```{
},"load": [
"python-checks": {
"type": "pylint",".arcanist-extensions/tap_test_engine"
"includ],
"unit.engine": "(\\.py$)"
}TAPTestEngine",
}"unit.engine.tap.command": "your_unit_test_script.sh"
}
```
Checks all files with configured linters
```
arc lint --everything* 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]]
```
* Complete documentation: https://secure.phabricator.com/book/phabricator/article/arcanist_lint/
# Official documentation
* Lint [[https://secure.phabricator.com/book/phabricator/article/arcanist_lint/]]* 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`)
c4science · Help