> For the complete documentation index, see [llms.txt](https://zz-jason.gitbook.io/tidb-dev-guide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://zz-jason.gitbook.io/tidb-dev-guide/src/get-started/run-and-debug-integration-tests.md).

# run-and-debug-integration-tests

## Run and debug integration tests

TiDB now has some integration tests inside the folder `tests/integrationtest`. Those tests are simply organized as SQL files. The test inputs are put in the folder `t/` and the pre-stored result files are in the folder `r/`.

## How to run integration tests

Unlike the production environment, we enable extra assertion in integration tests to do some strict checking. You'll need to run `make server_check` instead of `make`/`make server` to build the TiDB binary. The main difference between them is that the `make server_check` adds two new go build tags named `enableassert` and `deadlock`.

Once you have built a TiDB binary. You can go to the folder `tests/integrationtest` and run `./run-tests.sh -s ../../bin/tidb-server` to run all the integration tests.

And you can use `-t` to specify a test file to test. If you run `./run-tests.sh -s ../../bin/tidb-server -t executor/simple`, the scripts will run the tests inside the file `t/executor/simple.test`.(It's corresponding result file is `r/executor/simple.result`)

If you find out that the changes of tests are expected, you can pass `-r` to re-generate the result file. If you run `./run-tests.sh -s ../../bin/tidb-server -r executor/simple`, it will overwirte the `r/executor/simple.test` by the new binary.

## How to debug integration tests

Sometimes you will need to debug the test when you find out that some changes are not expected. You will need to do some preparation before attach to `dlv` if you prefer to use `dlv` to do live debugging.

We use some build tags to inject some check in the testing environment. Those tags are `intest,deadlock,integrationtest`, so you need to pass `--tags intest,deadlock,integrationtest` when you're building the binary. Or you can directly run `make server_check` to build the needed binary and then use `dlv` to do the debugging.

After you build the correct binary, you can follow the descriptions in [Use delve for debugging](/tidb-dev-guide/src/get-started/debug-and-profile.md#use-delve-for-debugging) to debug TiDB.

### How to use IDE to debug

If you're using IDEs, you'll need to create a special build file for it.

#### Visual Studio Code

Find the `Run and Debug` in the left sidebar. If you haven't created any config, click the `create a launch.json file.`

![VS Code create debug file](https://1966855898-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MZmmQ7rxYvhbo891oTe%2Fuploads%2Fgit-blob-cad06ee52b5d4cad9dce26b9b77f05fe228a40ea%2Fvscode-go-to-edit.png?alt=media)

And then you are able to create different run\&debug configurations.

![VS Code config sample](https://1966855898-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MZmmQ7rxYvhbo891oTe%2Fuploads%2Fgit-blob-129514aff27d7be8e280f4a971b4f697666a795b%2Fvscode-debug-config.png?alt=media)

The above image shows some samples of the configuration. And the `tidb-on-2432-integration-test` is the one enabling build tags.

Then you just need to click the run button, VS Code will build the binary and then use `dlv` to attach on it.

![VS Code begin debugging](https://1966855898-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MZmmQ7rxYvhbo891oTe%2Fuploads%2Fgit-blob-2efc72bc2964e7a4e46e8974eb79c1562f36f1e9%2Fvscode-debug-binary.png?alt=media)

You can find more about VS Code's debugging on its official documents.