> ## How to check a test template locally > Fetch the complete documentation index at: https://antithesis.com/docs/llms.txt > Use this file to discover all available pages before exploring further. --- When you’re developing a test template for the Antithesis, whether you’re starting from scratch or just tweaking a command, it can be convenient to check your work locally before you kick off a full Antithesis test run. These guidelines should help you try out your commands in circumstances that resemble what Antithesis might do in one [branch of the Antithesis multiverse](/docs/product/debugging/advanced_multiverse_debugging/moment_branch/). They will not get you to an exhaustive test of your commands or your software -- for that, you need a real Antithesis test run -- but they may be useful for development or troubleshooting. ## We’re assuming… - You're a little bit familiar with the Antithesis [test templates](/docs/product/test_templates/) and the existence of different types of test commands. If not, please start with our [basics](/docs/product/test_templates/first_test/) or [reference](/docs/product/test_templates/test_composer_reference/). - You're on a computer with [Docker](https://docs.docker.com/), the software images and a `docker-compose.yaml` file that you'll be using in Antithesis. - At least one of the containers in your `docker-compose.yaml` has at least one test command (which should be located at `/opt/antithesis/test/v1//` in a container). - You know which of your containers have which test commands. ## How to use this guide Every type of test command has a section below, which tells you what must be true before you run a command of that type, and what must not be true when you run it. Before you run a command, start your cluster according to the [setup guide](/docs/getting_started/setup_guide/). Then, make sure you’ve done everything in the "must" section for the relevant command type, and nothing in the "must not" section. Since we don’t have a time machine when we run outside of the Antithesis Environment, if you want to run a command whose "must not" section has been violated, you’ll need to tear down your cluster and start over with setup. Run your commands with: ```bash docker compose -f exec ``` (Our examples assume a test directory named `my_test` in a service called `my_test_service`.) To make it easy to cancel your commands, we recommend running everything in the foreground and using multiple terminals. (Note that Antithesis will not cancel commands except before running an eventually command.) In general, remember that you should: - *Never* mix commands from different test directories. - *Always* start with a first command if your test directory has any. ## Setup 1. Run `docker compose -f up` This will run in the foreground, and you’ll be able to cancel it when you want to take down the cluster. 2. Wait for the [`SetupComplete` event](/docs/reference/sdk/manage_test_lifecycle/) 3. Open a new terminal to run your commands (with `docker compose -f exec ` as above) > **Note** > > `docker exec` and `docker compose exec` are both valid ways to run something in a container. We suggest `docker compose exec` because it accepts service names, but you can use whichever you’re comfortable with. ## Guidelines by Command ### First command ```bash docker compose -f ./docker-compose.yaml exec my_test_service /opt/antithesis/test/v1/my_test/first_example.sh ``` #### Must not - **Must not have** run any other commands. ### Singleton driver command ```bash docker compose -f ./docker-compose.yaml exec my_test_service /opt/antithesis/test/v1/my_test/singleton_driver_example.sh ``` #### Must - **Must have** run a first command to completion, if this test directory contains any. #### Must not - **Must not have** run any commands other than an applicable first command. ### Serial driver command ```bash docker compose -f ./docker-compose.yaml exec my_test_service /opt/antithesis/test/v1/my_test/serial_driver_example.sh ``` #### Must - **Must have** run a first command to completion, if this test directory contains any. #### Must not - **Must not have** run commands from any other test directory. - **Must not have** run a singleton driver, an eventually, or a finally. - **Must not be currently** running a serial driver or a parallel driver (it's fine to have run one or more to completion). ### Parallel driver command ```bash docker compose -f ./docker-compose.yaml exec my_test_service /opt/antithesis/test/v1/my_test/parallel_driver_example.sh ``` #### Must - **Must have** run a first command to completion, if this test directory contains any #### Must not - **Must not have** run commands from any other test directory. - **Must not have** run a singleton driver or an eventually. > **Note** > > It's fine to run more than one parallel driver at a time. As we mentioned in [how to](#how-to-use-this-guide), we suggest running test commands in the foreground so that you can tell when and whether they complete. ### Anytime command ```bash docker compose -f ./docker-compose.yaml exec my_test_service /opt/antithesis/test/v1/my_test/anytime_example.sh ``` #### Must - **Must have** run a first command to completion, if this test directory contains any. #### Must not - **Must not have** run commands from any other test directory. ### Finally command ```bash docker compose -f ./docker-compose.yaml exec my_test_service /opt/antithesis/test/v1/my_test/finally_example.sh ``` #### Must - **Must have** run a first command to completion, if this test directory contains any. - **Must have** run at least one (singleton, serial, or parallel) driver command to completion. #### Must not - **Must not have** run commands from any other test directory. - **Must not be currently** running any driver commands (but you may let them run to completion). ### Eventually command ```bash docker compose -f ./docker-compose.yaml exec my_test_service /opt/antithesis/test/v1/my_test/eventually_example.sh ``` #### Must - **Must have** run a first command to completion, if this test directory contains any. - **Must have** run at least one (singleton, serial, or parallel) driver command to completion. #### Must not - **Must not have** run commands from any other test directory. - **Must not be currently** running any driver commands (but you may cancel them or let them run to completion).