xxq250
/
homework-jianmu
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Merge pull request #29580 from taosdata/docs/wangxu/readme0116 

docs: update the structure for testing readme
This commit is contained in:
Feng Chao 2025-01-16 12:03:57 +08:00 committed by GitHub
parent d15189291b 5c052c1325
commit 935f73dbce
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 72 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

102
tests/README.md
View File

@ -1,35 +1,44 @@
# Table of Contents
1. [Introduction](#1-introduction)
1. [Prerequisites](#2-prerequisites)
2. [Testing Guide](#3-testing-guide)
1. [Testing Guide](#3-testing-guide)
1. [Unit Test](#31-unit-test)
1. [System Test](#32-system-test)
1. [Smoke Test](#33-smoke-test)
1. [Legacy Test](#34-legacy-test)
1. [Chaos Test](#35-chaos-test)
1. [TSBS Test](#36-tsbs-test)
# 1. Introduction
This manual is intended to provide users with comprehensive guidance to help them verify the TDengine function efficiently. The document is divided into three main sections: introduction, prerequisites and testing guide.
This manual is intended to provide users with comprehensive guidance to help them verify the TDengine function efficiently. The document is divided into three main sections: introduction, prerequisites and testing guide.
# 2. Prerequisites
# 2. Prerequisites
Install Python3.
- Install Python3
```bash
apt install python3
apt install python3-pip
```
Install the dependent Python components.
- Install Python dependencies
```bash
pip3 install pandas psutil fabric2 requests faker simplejson toml pexpect tzlocal distro decorator loguru hyperloglog
pip3 install pandas psutil fabric2 requests faker simplejson \
toml pexpect tzlocal distro decorator loguru hyperloglog
```
Install the Python connector for TDengine.
- Install Python connector for TDengine
```bash
pip3 install taospy taos-ws-py
```
> [!NOTE]
> Please make sure building operation with option '-DBUILD_TOOLS=true -DBUILD_TEST=true -DBUILD_CONTRIB=true' has been finished, execute the below commands if not:
- Building
Please make sure building operation with option `-DBUILD_TOOLS=true -DBUILD_TEST=true -DBUILD_CONTRIB=true` has been finished, otherwise execute commands below:
```bash
cd debug
@ -39,57 +48,90 @@ make && make install
# 3. Testing Guide
## Unit Test
In `tests` directory, there are different types of tests for TDengine. Below is a brief introduction about how to run them and how to add new cases.
Unit test script is the smallest testable part and developed for some function, method or class of TDengine, you can run
the script with below command:
## 3.1. Unit Test
Unit test script is the smallest testable part and developed for some function, method or class of TDengine.
### How to run tests?
```bash
cd tests/unit-test/
bash test.sh -e 0
```
## System Test
### How to add new cases?
Copy from the old version, need updates:
You can add sim test case under tests/script, python test case under tests/system-test or tests/army. When the case passes in the test branch, add the case to the cases.task file under tests/parallel_test, and then merge the pr into main branch to run in the future CI.
## 3.2. System Test
Python test script includes almost all of the functions of TDengine, so some test case maybe fail cause the function only
work for TDengine Enterprise Edition, you can run the script with below command:
work for TDengine Enterprise Edition.
### How to run tests?
```bash
cd tests/system-test
python3 ./test.py -f 2-query/floor.py
```
## Smoke Test
### How to add new cases?
Smoke test script is known as sanity testing to ensure that the critical functionalities of TDengine, you can run the
script with commands below:
[Placeholder]
## 3.3. Smoke Test
Smoke test script is known as sanity testing to ensure that the critical functionalities of TDengine.
### How to run tests?
```bash
cd /root/TDengine/packaging/smokeTest
./test_smoking_selfhost.sh
```
## Legacy Test
### How to add new cases?
In the early stage of TDengine development, test cases are run by an internal test framework called TSIM, which is developed in C++. To run the legacy test cases, please execute the following commands:
[Placeholder]
## 3.4. Legacy Test
In the early stage of TDengine development, test cases are run by an internal test framework called TSIM, which is developed in C++.
### How to run tests?
To run the legacy test cases, please execute the following commands:
```bash
cd tests/script
./test.sh -f tsim/db/basic1.sim
```
## How TO Add Test Cases
You can add sim test case under tests/script, python test case under tests/system-test or tests/army. When the case passes in the test branch, add the case to the cases.task file under tests/parallel_test, and then merge the pr into main branch to run in the future CI.
### How to add new cases?
## TSBS Test
[Placeholder]
Time Series Benchmark Suite (TSBS) is an open-source performance benchmarking platform specifically designed for time-series data processing systems, such as databases. It provides a standardized approach to evaluating the performance of various databases by simulating typical use cases such as IoT and DevOps.
## 3.5. Chaos Test
[Desciprtion]
### How to run tests?
[Placeholder]
### How to add new cases?
[Placeholder]
## 3.6. TSBS Test
[Time Series Benchmark Suite (TSBS)](https://github.com/timescale/tsbs) is an open-source performance benchmarking platform specifically designed for time-series data processing systems, such as databases. It provides a standardized approach to evaluating the performance of various databases by simulating typical use cases such as IoT and DevOps.
### How to run tests?
Need updates: must be run from public repo!
TSBS Test is based on the TDengine Enterprise Edition and need private repositry privilege, you can refer the link for detail steps. [TSBS Test](https://github.com/taosdata/TDinternal/tree/main?tab=readme-ov-file#85-tsbs-test)
## TestNG Test
TestNG Test is another test framwork which developed by python, functionally speaking, it's a supplement for system test, and
also run longer time than system test for stability testing purposes.
TestNG Test is based on the TDengine Enterprise Edition and need private repositry privilege, you can refer the link for detail steps. [TestNG Test](https://github.com/taosdata/TDinternal/tree/main?tab=readme-ov-file#87-testng-test)