kurtosis-tech.github.io


Project maintained by kurtosis-tech Hosted on GitHub Pages — Theme by mattgraham

Building & Running

Every testsuite is simply a package of test code in an arbitrary language that runs in a Docker container. This means that every test developer needs to a) build a testsuite Docker image and b) then feed it to Kurtosis for execution.

Building a testsuite container

Testsuites bootstrapped using the quickstart instructions will come with the Dockerfile and main function necessary to package your test code into a Docker image. To build the testsuite Docker image, you’d need to call docker build on the Dockerfile to generate a new Docker image every time you make changes to your testsuite. This becomes tedious quickly, so we’ve automated this with a script that we’ll see soon.

Feeding a testsuite container to Kurtosis

Kurtosis is invoked via the Kurtosis CLI. To run your testsuite, you’d need to call kurtosis test and pass in the name of your testsuite image. As with building, this becomes tedious so we’ve automated it in a script.

build-and-run.sh

Building the testsuite image and running it is such a common task that calling docker build and kurtosis test manually each time becomes frictionful. To ease the pain, we’ve automated the process with a script called build-and-run-core.sh, which is also released with every Kurtosis Core version and will be created in the .kurtosis directory of the testsuite repo. This script takes in an action (e.g. build, to just build, or help, to display helptext) as well as several other arguments, and will handle the image-building and image-running for you.

build-and-run-core.sh is versioned with Kurtosis Core and should be upgraded whenever Kurtosis Core is upgraded. This means that any changes you make to it would be overwritten. To fix this issue, every bootstrapped testsuite repo comes with a build-and-run.sh wrapper script that calls down to build-and-run-core.sh, and is yours to modify as you please.

Because build-and-run.sh calls build-and-run-core.sh which calls the Kurtosis CLI, and because the Kurtosis CLI has arguments of its own, any additional arguments after the arg telling build-and-run.sh what to do will be passed as-is to the CLI. As an example, you can call build-and-run.sh all --help to signify that a) build-and-run.sh should do both build and run steps and b) you want to see the extra flags that the Kurtosis CLI receives. As a second example, build-and-run.sh run --parallelism 2 would execute only the run step (no build) and call kurtosis test with parallelism set to 2.


Back to index