Init readme

Author: CAGS295

devenv/integration/README.md

@@ -0,0 +1,54 @@
+## Containerized integration testing
+
+Hi! Congatulations on making it this far. By now you should know how to launch a
+full node for local development using `devnev`. To take a step further this are
+the steps you need to follow to run and implement integration tests using
+`devenv`
+
+### Running integration tests.
+
+starting at `devenv`, `pushd integration`. In this directory you will find
+scripts in the `/bin` folder. The ones you will be using are `build` and `test`.
+`test` is how you are expected to run the suite. run `bin/build` and `popd`.
+Back in devenv run `integration/bin/test`.
+
+### Adding grouping filters
+
+In `/devenv/integration/test` there is a filter array that determines how many
+nodes are going to be spun and what tests are going to run in parallel inside
+the node.
+
+```bash
+filters=("package(romeo)" "test(deposit_parse)" "test(deposit_output)")
+```
+
+Use nextest's DSL to group up your integration tests. Add new filters as you see
+fit.
+
+### Adding node readiness checks.
+
+In `devenv/integration/docker/entrypoint` you can add checks to wait until a
+node is ready to take tests.
+
+In this snip we wait until the stacks api is responsive and burchain block
+height is 205.
+
+```bash
+STACKS=$PROJECT_NAME-stacks-1
+API_URL=http://$STACKS:20443/v2/info
+
+# makes sure the node is ready before proceeding
+# stacks node get info
+echo "Waiting on Stacks API"
+while ! curl -s $API_URL >/dev/null; do
+    sleep 1
+done
+
+DEV_READY_HEIGHT=205
+
+# bitcoind get info
+echo "Waiting on burn block height $DEV_READY_HEIGHT"
+while [ "$(curl -s $API_URL | jq '.burn_block_height')" -lt $DEV_READY_HEIGHT ]; do
+    sleep 2
+done
+```