ci:modify test readme

This commit is contained in:
chenhaoran 2025-01-16 18:19:19 +08:00
parent ce384e325a
commit 59ea64e1a8
2 changed files with 14 additions and 15 deletions

View File

@ -145,27 +145,26 @@ cd tests
<summary>Detailed steps to add new system test case</summary>
you can refer below steps to add one test case:
test.py is the test case execution and monitoring of the entry program. you can refer below steps to add one test case:
##### 1. Create test case file and develop the test scripts
##### 1.Create a test case file and develop the test cases
In the test directory corresponding to the target function module, create test files in CPP format and write corresponding test cases.
Create a file in `tests/system-test` containing each functional directory and refer to the use case template `tests/system-test/0-others/test_case_template.py` to add a new test case.
##### 2. Update build configuration
##### 2.Execute the test case
Modify the CMakeLists.txt file in this directory to ensure that the new test files are properly included in the compilation process. See the source\os\test\CMakeLists.txt file for configuration examples.
cd tests/system-test & python3 ./test.py -f 0-others/test_case_template.py
##### 3. Compile test code
##### 3.Integrate into CI tests
In the root directory of the project, create a compilation directory (e.g., debug), switch to the directory and run CMake commands (e.g., cmake .. -DBUILD_TEST=1) to generate a compilation file, and then run a compilation command (e.g. make) to complete the compilation of the test code.
Edit `tests/parallel_test/cases.task` and add the testcase path and executions in the specified format. The third column indicates whether to use Address Sanitizer mode for testing.
##### 4. Execute the test program
Find the executable file in the compiled directory(e.g. TDengine/debug/build/bin/) and run it.
##### 5. Integrate into CI tests
Use the add_test command to add new compiled test cases into CI test collection, ensure that the new added test cases can be run for every build.
```bash
#caseID,rerunTimes,Run with Sanitizer,casePath,caseCommand
,,n,system-test, python3 ./test.py -f 0-others/test_case_template.py
```
</details>

View File

@ -27,14 +27,14 @@ class TDTestCase:
self.replicaVar = int(replicaVar)
def test_function(): # case function should be named start with test_
def test_function(self): # case function should be named start with test_
"""
Here is the function description for single test:
Test case for custom function
"""
tdLog.info(f"Test case test custom function")
# excute the sql
tdLog.execute(f"create database db_test_function")
tdSql.execute(f"create database db_test_function")
tdSql.execute(f"create table db_test_function.stb (ts timestamp, c1 int, c2 float, c3 double) tags (t1 int unsigned);")
# qury the result and return the result
tdSql.query(f"show databases")
@ -45,7 +45,7 @@ class TDTestCase:
def run(self):
self.test_5dnode_3mnode(dnodeNumbers=6,mnodeNums=3,restartNumbers=2,stopRole='vnode')
self.test_function()
def stop(self):
tdSql.close()