Skip to content

Commit

Permalink
get started: update docs for run/debug integration tests (#261)
Browse files Browse the repository at this point in the history
  • Loading branch information
winoros authored Oct 18, 2024
1 parent e9c4077 commit 65f882d
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/get-started/run-and-debug-integration-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ TiDB now has some integration tests inside the folder `tests/integrationtest`. T

# 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`)
Expand Down Expand Up @@ -38,4 +40,4 @@ Then you just need to click the run button, VS Code will build the binary and th

![VS Code begin debugging](../img/vscode-debug-binary.png)

You can find more about VS Code's debugging on its official documents.
You can find more about VS Code's debugging on its official documents.
Binary file modified src/img/vscode-debug-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 65f882d

Please sign in to comment.