• Table of contents
• Hacking prerequisites
  • Host options
    • Starting on your workstation
    • Starting on a VM
    • Starting in a docker container
  • Install dev environment
    • With Ansible
      • Install Ansible
      • Write an Arvados database configuration
      • Write an Ansible inventory
      • Run the playbook
    • Manually
  • Start Postgres
  • Setup groups
  • Run tests

Hacking prerequisites¶

The Arvados test suite can run in a Docker container, a VM, or your workstation -- provided a few prerequisites are satisfied.

Host options¶

Starting on your workstation¶

If your workstation is a debian buster system -- and you don't mind installing a bunch of packages on your workstation, some of them without apt -- the easiest way to get running is to run tests on bare metal. Skip to "Dependencies".

Other linux distributions should work too with some modifications, but it's probably easier to use a VM.

Starting on a VM¶

Another option is to create a virtual machine using something like Xen or VirtualBox, and run debian buster on it. The instructions below assume you have just a few basic requirements:

• SSH server
• sudo (apt-get install sudo)
• A user account with sudo privileges

Starting in a docker container¶

Arvbox provides a preinstalled Docker-based dev environment. The following instructions are for creating a dev environment inside Docker from scratch.

This can get you started quickly, but (unlike the above options) you'll need to remember to use something like docker commit to save your state before shutting down your container.

See http://docker.io for more about installing docker. On debian it looks something like this.

sudo apt-get install docker-ce
sudo adduser $USER docker
# {log out & log back in}
groups
# {should include "docker"}

Start up a new container with debian 10 (buster), make a new user and log in as that user:

docker run -it --privileged debian:10 bash
apt-get update
apt-get -y install sudo
adduser me
adduser me sudo
sudo -u me -i

The "--privileged" is required in order for /dev/fuse to be accessible (without it, no tests that require FUSE will work).

Install dev environment¶

With Ansible¶

This is a prototype still in development, but initial development was done in January 2025 and it can automate much of the process for you.

Install Ansible¶

The simplest thing to do is pip install Ansible inside a virtualenv:

sudo apt install python3-venv
python3 -m venv ~/arvados-ansible
~/arvados-ansible/bin/pip install "ansible~=8.7" 

If that works, you're done and you can go on to the next section. For background:

• The Arvados Ansible playbooks are tested with Ansible 8, which we use for its Python version compatibility. Older versions are known not to work. You're welcome to try newer versions if you want to for any reason, but they haven't been tested.

• There are other installation options if you can't do this for some reason.

Write an Arvados database configuration¶

Next, write an Arvados configuration file that defines how you want to set up the PostgreSQL database. Write a file ~/arvados-ansible/zzzzz.yml like this:

Clusters:
  zzzzz:
    PostgreSQL:
      Connection:
        user: arvados
        password: GoodPasswordHere
        dbname: arvados_development
        host: localhost
        port: "5432" 

The cluster ID must be zzzzz. You can change the user, password, and dbname settings freely. Our Ansible playbook will configure PostgreSQL so your settings here work.

The playbook will always install the postgresql server package. If you already have this installed and have configured it to listen somewhere other than the default, you may update host and port to reflect that. Note that port is a string containing digits.

Write an Ansible inventory¶

An inventory file tells Ansible what host(s) to manage and how to connect to them. If you've installed Ansible on the same system where you want to install a test environment, write this inventory file to ~/arvados-ansible/inventory.ini:

[arvados-test]
localhost ansible_connection=local

If that's sufficient, you can skip to the next section. If you want to do something fancier, like having Ansible install a test environment on one or more remote hosts, refer to the Ansible inventory documentation to learn how to write your own.

Run the playbook¶

The basic command to run the playbook is:

cd arvados/tools/compute-images/ansible
~/arvados-ansible/bin/ansible-playbook -e "arvados_config=$HOME/arvados-ansible/zzzzz.yml" -i ~/arvados-ansible/inventory.ini -K install-test-env.yml

There are some things you should know about how the playbook will work:

• It will add a user account to the docker group in order to be able to run tests. By default it uses the name of the account running Ansible. If you want to use a different account for Arvados testing, define arvados_dev_user inside the -e argument; e.g.,

  ~/arvados-ansible/bin/ansible-playbook -e "arvados_dev_user=USERNAME arvados_config=$HOME/arvados-ansible/zzzzz.yml" …

• It will install symlinks for Go, Node, Singularity, and Yarn under /usr/local/bin. The actual tools are installed under /opt. If you need different versions of these tools for other work, you'll need to customize your PATH environment variable so the Arvados versions are found first when you're doing Arvados work.

Manually¶

Start with Debian 10+ and run the following commands as root.

Note that the last command here ("arvados-server install -type test") installs additional debian packages to your system, along with additional software in /var/lib/arvados/ (such as suitable versions of Ruby and Go) that do not interfere with system packages. It also creates a postgresql database user named "arvados" with an insecure password. Don't expose this postgresql server to the internet or to untrusted users!

apt update
apt install wget ca-certificates
wget https://apt.arvados.org/bullseye/pool/main/a/arvados-server/arvados-server_2.4.3-1_amd64.deb
dpkg -i arvados-server_2.4.3-1_amd64.deb
arvados-server install -type test

Alternatively, install Go ≥ 1.20 (see https://golang.org) and git, and run arvados-server from source.

wget -O- https://go.dev/dl/go1.22.1.linux-amd64.tar.gz | tar -C /usr/local -xzf -
ln -s /usr/local/go/bin/* /usr/local/bin/

apt install git build-essential libpam-dev

cd
git clone https://git.arvados.org/arvados.git
cd arvados
go mod download
go run ./cmd/arvados-server install -type test

Start Postgres¶

If you're running in a docker container you'll need to start Postgres manually:

sudo /etc/init.d/postgresql start

(If you're on a regular workstation/server/VM, startup scripts have already taken care of that for you.)

Setup groups¶

Make sure the fuse and docker groups exist (create them if necessary) and that the user who will run the tests is a member of them.

Run tests¶

time ~/arvados/build/run-tests.sh WORKSPACE=~/arvados

During development, you'll probably want something more like this. It reuses the given temp directory, which avoids a lot of repetitive downloading of dependencies, and allows you to save time with --skip-install or --only-install sdk/ruby and so on.

mkdir -p ~/.cache/arvados-build
time ~/arvados/build/run-tests.sh WORKSPACE=~/arvados --temp ~/.cache/arvados-build