Add tests README with instructions on testing

This commit is contained in:
Aaron Whitehouse 2022-03-17 10:05:01 +00:00
parent d863c35cac
commit e963dd228f
2 changed files with 31 additions and 1 deletions

30
tests/README.md Normal file
View File

@ -0,0 +1,30 @@
### Requirements ###
Tests must be run inside a virtual machine. This is for your own safety, as the tests may create and destroy zpools etc.
A VM with 35GB of storage and 8 cores completes the tests in about 5 hours.
#### Packages ####
The tests require the following packages to be installed in the VM (Ubuntu 20.04 package names are used, translate as appropriate):
```
zfsutils-linux
libconfig-inifiles-perl
libcapture-tiny-perl
```
```
apt install zfsutils-linux libconfig-inifiles-perl libcapture-tiny-perl
```
#### Install sanoid within the VM ####
Install sanoid within the VM, for example
```
apt install git
git clone https://github.com/jimsalterjrs/sanoid.git
mkdir /etc/sanoid/
cp sanoid/sanoid.defaults.conf /etc/sanoid/
```
### Run the tests ##
```
cd sanoid/tests/
./run-tests.sh
```

View File

@ -1,6 +1,6 @@
#!/bin/bash
# run's all the available tests
# runs all the available tests
for test in */; do
if [ ! -x "${test}/run.sh" ]; then