To run the unit tests, install tox (this can be on your native system, via pip, or in a virtual environment), and just run tox.
Testflinger server can be deployed using Docker, and it makes a nice setup for local development. There's a Dockerfile for building the container and a docker-compose.yml which can be used as a basis for any kind of deployment. For development purposes, there's a docker-compose.override.yml under the devel directory. This will setup Testflinger running on port 5000, along with MongoDB, and a tool called "Express" on port 8081 for inspecting and modifying values directly in MongoDB. If you use the override file, then it will also point the code directory for Testflinger to the local code in this directory, and it runs gunicorn with --reload so that any changes you make locally will be immediately reflected in what's running. To get all this running on your system:
$ cp devel/docker-compose.override.yml .
$ docker-compose build
$ docker-compose up -d
There is a testflinger.yaml file under the devel directory which can be used with multipass to create a complete environment for demonstrating, testing, and developing on all parts of testflinger. This environment is self-contained, and automatically set up to point the command-line tools at a server running within this container. It also includes a deployment of MaaS with a pre-configured example node that runs in a VM, so you can use this environment to run a full test job through the entire process, including provisioning.
It is recommended to have at least 8GB of RAM free and 32GB of disk space for creating this container.
To get this running, first install multipass:
$ sudo snap install multipass
Next run the following command (this will take a while):
$ cat devel/testflinger.yaml |multipass launch --name testflinger -c4 -m8GB -d32GB --timeout 600 focal --cloud-init -
Due to the complexity of the environment being setup, this command may timeout rather than complete. If this happens the environment should still reach the final state successfully, but you will need to wait a few minutes before trying to connect.
To open a shell to the container, run:
$ multipass exec testflinger bash
From there, you can look at the README file for more information
If you wish to connect to the Web UI for MAAS to watch or debug deployment of the test container, you can get the ip address of the container using 'multipass list' and open a browser on your host system to:
http://<MAAS_IP>:5240/MAAS
To remove everything that has been deployed completely:
$ multipass delete -p testflinger