ROS Testing with Gitlab-CI and Slack
I am part of the WPI Team that is competing in the Space Robotics Challenge by Nasa (Credits to them for the Valkyrie image on your left) and in this small post I’ll teach you to:
- Automate your testing with Gitlab-CI
- Prepare your Runners (The machines that run your tests)
- Get notifications using a SlackBot to know when your build is broken
And you’ll say why Gitlab and not Github? Everybody loves Github right? Well not for SRC, Nasa’s terms and conditions specify that all the participants’ repositories should be in Gitlab. Github has Travis, which somehow makes life a bit easier, but for this post I’ll use only Gitlab Tools. I assume that you have knowledge about Git, ROS and Testing.
Because bugs, that’s why! Here in the WHRL (WPI Humanoid Robotics Lab) there has been problems before while participating in the Darpa Robotics Challenge, with so many people committing code to the repository and a deadline coming, it was easy for the build to get broken and leave the workspace failing, leaving people that were starting to get into the project clueless. Testing is done to ensure that every commit to the Master branch (we use merge requests now, we’ve learn the lesson) is safe for everyone that updates the workspace early in the morning.
Setting up your Runner
Gitlab uses Runners, which are computers that run your tests, picture it as a guy that is always in the lab, refreshing the Gitlab page and as soon he finds a new change to the repo, he pulls it and builds the whole workspace, making sure there are no errors, tough job right? Yeah, don’t be that guy!
For this SRC challenge we use ROS Indigo in Ubuntu 14.04, so the first thing to do is have a machine connected to the web that has ROS already installed, it can be a computer in your lab or better yet you can use a computer on the cloud, I recommend DigitalOcean because it’s easy, cheap and fast. In the lab’s case we have many computers lying around so I just used one of them. I’ll upload a script that does all the required installation for the SRC once the official code is out there, but if you need to install ROS refer to this tutorial.
One you have ROS Indigo installed run:
# For Debian/Ubuntu curl -L https://packages.gitlab.com/install/repositories/runner/gitlab-ci-multi-runner/script.deb.sh | sudo bash
and then install
# For Debian/Ubuntu sudo apt-get install gitlab-ci-multi-runner
And then use the Registration Token and URL to set up your runner like this:
sudo gitlab-ci-multi-runner register Please enter the gitlab-ci coordinator URL (e.g. https://gitlab.com ) https://gitlab.com/ci Please enter the gitlab-ci token for this runner YOURTOKENHERE Please enter the gitlab-ci description for this runner indigo-runner INFO fcf5c619 Registering runner... succeeded Please enter the executor: shell, docker, docker-ssh, ssh? shell INFO Runner registered successfully. Feel free to start it, but if it's running already the config should be automatically reloaded!
Once that is done you only need to add a
.gitlab-ci.yml, this file is the one having all the configuration of your builds, what steps to take all your configurations. You can use this as a example (Hosted on Gist #rebel)
before_script part is used mostly to install and update resources, in our case we try not to do this too much since you’ll have to add sudo permissions to the gitlab-runner user in your runner computer, and that’s a no-no on my book. Then you go to your Pipelines tab in your Repo and you can start seeing this with every commit to the master branch:
Now you can run beautiful tests on your ROS module and make sure that the
catkin_make command is running OK, if you haven’t written tests for ROS before this is a small module that has some basic tests of a Calculator, use it wisely:
Now blame the one that broke the build on Slack.
Now to the funny part, it would be fun to have a bot that spams to slack once the build is broken right? Yup, so to have a bot that looks like this:
Go to THIS PAGE. I know, why not write all the steps here and save you a click? Well, I would only copy paste the steps there since the tutorial there is good and on point, so give it a look. As you can see above, it works wonders.
And that’s it folks, have fun on the SRC, hope you see you in the finals ;)
If you have any problems, doubts or something is not clear, send my an email to [email protected] and I’ll be happy to answer.
“Don't blame you," said Marvin and counted five hundred and ninety-seven thousand million sheep before falling asleep again a second later.”
– Douglas Adams, The Hitchhiker's Guide to the Galaxy