add docs or script for running tests locally

[darrenmce]

No description provided.

[darrenmce]

#44 (comment)

[darrenmce]

from #44:

test command:

docker run --rm -it \
  -v "$PWD:/tt" -v "/var/run/docker.sock:/var/run/docker.sock:ro" -w=/tt \
  darrenmce/tt-test-base \
  sh -c "sudo make install && DEBUG=true bats test/tt_ip.bats; cat debug.log"

also dont forget to install submodules first

git submodule sync
git submodule update --init

---

bit of explanation here:

the docker command just runs the tests inside the procured image that has all the dependencies already installed, so you just mount your docker socket (so it can use your daemon for docker-based tests) and then

1. install tt
2. run the tests (with debug on)
3. output the debug.log (useful for bats as stdout is captured, so using the debug helper functions to output to a log is the way to debug your tests)

the git submodules are for the following bats libraries

https://github.com/ztombol/bats-support
https://github.com/ztombol/bats-assert

note: they are only required for running the tests, not for tt