mirror of
Fork 0
Anish Athalye f15293b3d5 Rename 'canonicalize-path' into 'canonicalize'
This parallels 'relative' (it's not 'relative-path'). The old
'canonicalize-path' is still supported for backward compatibility.
2021-02-25 08:26:19 -05:00
tests Rename 'canonicalize-path' into 'canonicalize' 2021-02-25 08:26:19 -05:00
.editorconfig Add tests for more Python versions 2017-03-06 15:20:27 -05:00
.gitignore Add testing framework and tests 2015-05-05 20:11:46 -04:00
README.md Add --debug flag to test driver 2021-02-25 08:14:34 -05:00
Vagrantfile Fix interaction between --only and defaults 2020-11-22 16:58:00 -05:00
driver-lib.bash Add --debug flag to test driver 2021-02-25 08:14:34 -05:00
test Add --debug flag to test driver 2021-02-25 08:14:34 -05:00
test-lib.bash Add --debug flag to test driver 2021-02-25 08:14:34 -05:00



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
sudo apt install vagrant virtualbox
  • Install Dotbot dependencies
git submodule update --init --recursive


git submodule update --init --recursive

Running the Tests

Before running the tests, you must SSH into the VM. Start it with vagrant up and SSH in with vagrant ssh. All following commands must be run inside the VM.

First, you must install a version of Python to test against, using pyenv install -s {version}. You can choose any version you like, e.g. 3.8.1. It isn't particularly important to test against all supported versions of Python in the VM, because they will be tested by CI. Once you've installed a specific version of Python, activate it with pyenv global {version}.

The VM mounts the Dotbot directory in /dotbot as read-only (you can make edits on your host machine). You can run the test suite by cd /dotbot/test and then running ./test. Selected tests can be run by passing paths to the tests as arguments, e.g. ./test tests/create.bash tests/defaults.bash.

To debug tests, you can run the test driver with the --debug (or -d short form) flag, e.g. ./test --debug tests/link-if.bash. This will enable printing stdout/stderr.

When finished with testing, it is good to shut down the virtual machine by running vagrant halt.