diff options
author | Dan <2481552+opes@users.noreply.github.com> | 2018-04-30 21:07:55 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-04-30 21:07:55 +0300 |
commit | fbb85e77e3dc307c21b79c655302158077fad916 (patch) | |
tree | f31b99e9fa274d247551537a694f615167895379 /TESTS.md | |
parent | 75c6838a0dbb2fc84f2cf7d71cae9b147b04a379 (diff) | |
parent | 13b0e383a066c9c37d5cf71d4af521f9b73a173e (diff) |
Merge branch 'master' into chruby_options
Diffstat (limited to 'TESTS.md')
-rw-r--r-- | TESTS.md | 33 |
1 files changed, 30 insertions, 3 deletions
@@ -13,10 +13,37 @@ Tests in separate files under `test/functions`. These Tests tend to be more complex in setup than the basic tests. To avoid ending up in a huge single file, there is one file per segment in `test/segments`. -# Test-VMs +# Manual Testing If unit tests are not sufficient (e.g. you have an issue with your prompt that -occurs only in a specific ZSH framework), then you could use our Test-VMs! +occurs only in a specific ZSH framework) then you can use either Docker or +or our Vagrant. + +## Docker + +This is the easiest to use _if_ you have Docker already installed and running. + +The command `./test-in-docker` should make it fairly easy to get into a running +container with the framework of your choice. + +Examples: + +``` zsh +# Test Antigen with the oldest version of ZSH +$ ./test-in-docker antigen +``` + +``` zsh +# Test Prezto with ZSH version 5.2 +$ ./test-in-docker --zsh 5.2 prezto +``` + +You can get Docker at <https://www.docker.com/community-edition>. + +**Note:** Not all frameworks work with all versions of ZSH (or the underlying OS). + +## Vagrant + Currently there are two test VMs. `test-vm` is an Ubuntu machine with several pre-installed ZSH frameworks. And there is `test-bsd-vm` which is a FreeBSD! -For how to run the machines see [here](test-vm/README.md).
\ No newline at end of file +For how to run the machines see [here](test-vm/README.md). |