1
0
Fork 0
mirror of synced 2024-06-02 07:21:10 -04:00
dotbot/test/README.md
Anish Athalye b7022f4abb Speed up Vagrant tests
This patch removes the snapshot/rollback system for the tests and
replaces it with a simple cleanup script that removes the appropriate
files from the VM's $HOME before every test. A side benefit is that
there is no more dependency on the Sahara plugin.

The cleanup script may not provide as good isolation between independent
tests as the previous setup, but it is orders of magnitude faster to run
without a VM rollback for every single test, and it does not break any
of the current tests.
2018-03-27 20:56:55 -04:00

53 lines
1.2 KiB
Markdown

Testing
=======
Dotbot testing code uses [Vagrant] to run all tests inside a virtual machine to
have tests be completely isolated from the host machine.
Installing the Test environnement
---------------------------------
### Debian-based distributions
- Install the test requirements
```bash
sudo apt install vagrant virtualbox
```
- Install Dotbot dependencies
```bash
git submodule update --init --recursive
```
### macOS
- Install the test requirements
- [VirtualBox]
- [Vagrant]
- Install Dotbot dependencies
```bash
git submodule update --init --recursive
```
Running the Tests
-----------------
Before running the tests, the virtual machine must be running. It can be
started by running `vagrant up`.
The test suite can be run by running `./test`. Selected tests can be run by
passing paths to the tests as arguments to `./test`.
Tests can be run with a specific Python version by running `./test --version
<version>` - for example, `./test --version 3.4.3`.
When finished with testing, it is good to shut down the virtual machine by
running `vagrant halt`.
[VirtualBox]: https://www.virtualbox.org/wiki/Downloads
[Vagrant]: https://www.vagrantup.com/