diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 43 |
1 files changed, 43 insertions, 0 deletions
@@ -9,6 +9,49 @@ Puomi will be based on the Debian GNU/Linux operating system. It needs to be run on a small PC or other suitable hardware. Puomi will have no interactive user interface, and will be managed entirely via Ansible. +## To build and test + +Create a VM, accessible with the name `puomienv`, then run this to +provision and verify it works: + +~~~sh +(cd env && ./setup.sh) +./check +~~~ + +You need [Subplot](https://subplot.liw.fi/) installed for `./check`. + +If you use [vmadm](https://vmadm.liw.fi/ to create the outer VM: + +~~~sh +(cd env && vmadm delete env.yaml && vmadm new env.yaml && ./setup.sh) && ./check +~~~ + +This will all take a while. On my laptop, it takes order of 10 to 15 +minutes. Changes making this faster would be welcome. + +## Walk through + +Some of the more important files in the source tree: + +* `env/` --- directory with Ansible, vmadm, and other files to set up + a virtual testing environment. + * `env/env.yaml` --- vmadm specification file for creating the outer + VM + * `env/playbook.yml` --- Ansible playbook for provisioning the outer + VM + * `env/setup.sh` --- shell script to provision the outer VM and + creating and provisioning the inner VMs + * `env/ssh` --- SSH keys and configuration for accessing the outer + VM, used by the acceptance test suite +* `check` --- script that runs the acceptance tests +* `puomi.md` --- Markdown file that describes Puomi, the test + environment, and how the environment is verified as working +* `puomi.yaml` and `puomi.py` --- implementations of the scenario + steps used in the acceptance test in `puomi.md` +* `test.log` --- log file from test program; created by `check`; + looking at the log may help debug any issues + ## Hardware We will be aiming Puomi at hardware like the following: |