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

udpate README to remove the second layer section for Building and Testing by charles

This commit is contained in:
Feng Chao 2025-01-07 16:44:39 +08:00
parent 1e2e526f96
commit 16d1542712
1 changed files with 259 additions and 269 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
README.md
View File

@ -30,20 +30,11 @@ English | [简体中文](README-CN.md) | [TDengine Cloud](https://cloud.tdengine
- [1. Introduction](#1-introduction)
- [2. Documentation](#2-documentation)
- [3. Prerequisites](#3-prerequisites)
- [3.1 Install dependencies tools](#31-install-dependencies-tools)
- [3.2 Get the source codes](#32-get-the-source-codes)
- [3.3 Special Note](#33-special-note)
- [4. Building](#4-building)
- [5. Packaging](#5-packaging)
- [6. Installation](#6-installation)
- [7. Running](#7-running)
- [8. Testing](#8-testing)
- [8.1 Run the TSIM test script](#81-run-the-tsim-test-script)
- [8.2 Run the Python test script](#82-run-the-python-test-script)
- [8.3 Run unittest](#83-run-unittest)
- [8.4 Smoke Testing](#84-smoke-testing)
- [8.5 TSBS Test --replace](#85-tsbs-test---replace)
- [8.6 Crash\_gen Test](#86-crash_gen-test)
- [9. Releasing](#9-releasing)
- [10. CI/CD](#10-cicd)
- [11. Coverage --replace](#11-coverage---replace)
@ -81,9 +72,9 @@ List the software and tools required to work on the project.
Step-by-step instructions to set up the prerequisites software.
## 3.1 Install dependencies tools
- Install dependencies tools
Install the required package for linux
- The required package for linux
```bash
apt-get install -y llvm gcc make cmake libssl-dev pkg-config perl g++ lzma curl locales psmisc sudo tree libgeos-dev libgflags2.2 libgflags-dev libgoogle-glog-dev libjansson-dev libsnappy-dev liblzma-dev libz-dev zlib1g build-essential valgrind rsync vim libjemalloc-dev openssh-server screen sshpass net-tools dirmngr gnupg apt-transport-https ca-certificates software-properties-common r-base iputils-ping
@ -177,17 +168,17 @@ Install the Python connector for TDengine.
pip3 install taospy taos-ws-py
```
Install the required package for windows
- The required package for windows
to be updated...
Install the required package for macOS
- The required package for macOS
```
brew install argp-standalone gflags pkgconfig
```
## 3.2 Get the source codes
- Get the source codes
First of all, you may clone the source codes from github:
@ -203,8 +194,7 @@ You can modify the file ~/.gitconfig to use ssh protocol instead of https for be
insteadOf = https://github.com/
```
## 3.3 Special Note
- Special Note
[JDBC Connector](https://github.com/taosdata/taos-connector-jdbc)， [Go Connector](https://github.com/taosdata/driver-go)，[Python Connector](https://github.com/taosdata/taos-connector-python)，[Node.js Connector](https://github.com/taosdata/taos-connector-node)，[C# Connector](https://github.com/taosdata/taos-connector-dotnet) ，[Rust Connector](https://github.com/taosdata/taos-connector-rust) and [Grafana plugin](https://github.com/taosdata/grafanaplugin) has been moved to standalone repository.
# 4. Building
@ -217,7 +207,7 @@ TDengine provide a few useful tools such as taosBenchmark (was named taosdemo) a
To build TDengine, use [CMake](https://cmake.org/) 3.13.0 or higher versions in the project directory.
Linux platform building
- Linux platform building
You can run the bash script `build.sh` to build both TDengine and taosTools including taosBenchmark and taosdump as below:
@ -250,7 +240,7 @@ aarch64:
cmake .. -DCPUTYPE=aarch64 && cmake --build .
```
4.2 Windows platform building
- Windows platform building
If you use the Visual Studio 2013, please open a command window by executing "cmd.exe".
Please specify "amd64" for 64 bits Windows or specify "x86" for 32 bits Windows when you execute vcvarsall.bat.
@ -282,7 +272,7 @@ cmake .. -G "NMake Makefiles"
nmake
```
MacOS platform building
- MacOS platform building
Please install XCode command line tools and cmake. Verified with XCode 11.4+ on Catalina and Big Sur.
@ -293,21 +283,11 @@ cmake .. && cmake --build .
# 5. Packaging
Linux platform packaging
to be updated...
Windows platform packaging
to be updated...
MacOS platform packaging
to be updated...
To be updated...
# 6. Installation
Linux platform installation
- Linux platform installation
After building successfully, TDengine can be installed by
@ -319,7 +299,7 @@ Users can find more information about directories installed on the system in the
Installing from source code will also configure service management for TDengine.Users can also choose to [install from packages](https://docs.tdengine.com/get-started/deploy-from-package/) for it.
Windows platform installation
- Windows platform installation
After building successfully, TDengine can be installed by:
@ -327,7 +307,7 @@ After building successfully, TDengine can be installed by:
nmake install
```
MacOS platform installation
- MacOS platform installation
After building successfully, TDengine can be installed by:
@ -337,7 +317,7 @@ sudo make install
# 7. Running
To start the service after installation on linux, in a terminal, use:
- To start the service after installation on linux, in a terminal, use:
```bash
sudo systemctl start taosd
@ -365,7 +345,7 @@ In another terminal, use the TDengine CLI to connect the server:
option "-c test/cfg" specifies the system configuration file directory.
To start the service after installation on windows, in a terminal, use:
- To start the service after installation on windows, in a terminal, use:
```bash
to be updated
@ -376,7 +356,7 @@ Then users can use the TDengine CLI to connect the TDengine server. In a termina
to be updated
```
To start the service after installation on macOS, double-click the /applications/TDengine to start the program, or in a terminal, use:
- To start the service after installation on macOS, double-click the /applications/TDengine to start the program, or in a terminal, use:
```bash
sudo launchctl start com.tdengine.taosd
@ -392,7 +372,7 @@ If TDengine CLI connects the server successfully, welcome messages and version i
# 8. Testing
## 8.1 Run the TSIM test script
- Run the TSIM test script
TSIM test framework is developed by c++ in the start-up period of TDengine， the test scripts are basic cases, you can run
the script with below command:
@ -402,7 +382,8 @@ cd /root/TDengine/tests/script
./test.sh -f tsim/db/basic1.sim
```
## 8.2 Run the Python test script
- Run the Python test script
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 version, you can run the script with below command:
@ -411,7 +392,8 @@ cd /root/TDengine/tests/system-test
python3 ./test.py -f 2-query/floor.py
```
## 8.3 Run unittest
- Run unittest
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:
@ -420,7 +402,8 @@ cd /root/TDengine/tests/unit-test/
bash test.sh
```
## 8.4 Smoke Testing
- Smoke Testing
Smoke test script is known as sanity testing to ensure that the critical functionalities of TDengine, you can run the
script with below command:
@ -429,32 +412,39 @@ cd /root/TDengine/packaging/smokeTest
./test_smoking_selfhost.sh
```
## 8.5 TSBS Test --replace
- TSBS Test --replace
The Time Series Benchmark Suite(TSBS) test script provides a standardized approach to evaluate the performance of various
time series databases, you can run the script with below command:
1. Clone the code
- Clone the code
```bash
cd /root && git clone https://github.com/taosdata/tsbs.git && cd tsbs/scripts/tsdbComp
```
1. Modify IP and host of client and server in `test.ini`
- Modify IP and host of client and server in `test.ini`
```ini
clientIP="192.168.0.203" # client ip
clientHost="trd03" # client hostname
serverIP="192.168.0.204" # server ip
serverHost="trd04" # server hostname
```
1. Set up passwordless login between the client and server; otherwise, you'll need to configure the server password:
- Set up passwordless login between the client and server; otherwise, you'll need to configure the server password:
```ini
serverPass="taosdata123" # server root password
```
1. Run the following command to start the test:
- Run the following command to start the test:
```bash
nohup bash tsdbComparison.sh > test.log &
```
1. When the test is done, the result can be found in `/data2/` directory, which can also be configured in `test.ini`.
When the test is done, the result can be found in `/data2/` directory, which can also be configured in `test.ini`.
- Crash_gen Test
## 8.6 Crash_gen Test
Crash_gen is a chaotic testing tool developed by TDengine, it can evaluate the resilience of TDengine through simulating
normal operation、intentional fault injection and their combination, you can run the script with below command: