README.md@14500a149b31 (annotated)
README.md
Sun, 30 Dec 2018 09:43:36 +0000
- author
- Matthew Wild <mwild1@gmail.com>
- date
- Sun, 30 Dec 2018 09:43:36 +0000
- changeset 164
- 14500a149b31
- parent 143
- 28b92d201120
- child 167
- 8b322a7eca1e
- permissions
- -rw-r--r--
client: Ignore timeout timer if we received a stanza
| 143 | 1 | # Scansion - XMPP testing tool |
| 2 | ||
| 3 | Scansion executes simple scripts containing XMPP stanzas. It sends stanzas | |
| 4 | in the script, and awaits the response, and verifies it matches what the | |
| 5 | script expects. | |
| 6 | ||
| 7 | You can find some example scripts in the `scripts/` directory. | |
| 8 | ||
| 9 | ## Setup | |
| 10 | ||
| 11 | ### Requirements | |
| 12 | ||
| 13 | Scansion requires: | |
| 14 | ||
| 15 | - Lua 5.2 | |
| 16 | - Verse | |
| 17 | - LuaExpat | |
| 18 | - LuaCJSON | |
| 19 | - LuaSec | |
| 20 | - LuaSocket | |
| 21 | - LuaFileSystem (optional) | |
| 22 | ||
| 23 | If these are present, a simple 'make' and 'sudo make install' should suffice to install scansion to `/usr/local/bin/`. | |
| 24 | ||
| 25 | ### Docker | |
| 26 | ||
| 27 | A Dockerfile is also provided, to allow you to build and run scansion inside a clean environment with all dependencies | |
| 28 | installed already. | |
| 29 | ||
| 30 | First, build the image: | |
| 31 | ||
| 32 | ``` | |
| 33 | docker build -t scansion . | |
| 34 | ``` | |
| 35 | ||
| 36 | To run it with a directory of test scripts in ./spec/scansion: | |
| 37 | ||
| 38 | ``` | |
| 39 | docker run -v$PWD/spec/scansion:/scripts scansion | |
| 40 | ``` | |
| 41 | ||
| 42 | To run it as a web server: | |
| 43 | ||
| 44 | ``` | |
| 45 | docker run -p 8007:8007 -v$PWD/spec/scansion:/scripts scansion --serve | |
| 46 | ||
| 47 | ``` | |
| 48 |
