qiurui
/
uvgrtp-base
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Update test suite instructions

This commit is contained in:
Joni Räsänen 2022-12-14 15:52:31 +02:00 committed by GitHub
parent fbd2be2c7e
commit 93868c0650
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
test/README.md
View File

@ -6,15 +6,17 @@ These tests are not meant to be readable examples. For that you might want to ch
## Building the automated tests
uvgRTP uses GoogleTest framework for automated testing. The automated tests are run separately after the build process. First, [build](../BUILDING.md) uvgRTP normally. Running the CMake will create a new folder called ```test``` under the ```build``` folder.
uvgRTP uses GoogleTest framework for automated testing. The automated tests are run separately after the build process. First, [build](../BUILDING.md) uvgRTP normally. Running the CMake will create a new folder called ```test``` under the ```build``` folder, where you can find the necessary files for building the test suite.
### GCC (Linux)
Install Crypto++. After this, run ```make``` in ```build/test``` folder. This will create a program called ```uvgrtp_test```. Run this program to run the automated tests.
Install Crypto++ if you want to test encryption. After this, run ```make``` in ```build/test``` folder. This will create a program called ```uvgrtp_test```. Run this program to run the automated tests.
### MSVC (Windows)
Open the generated solution. Add the location of compiled Crypto++ library to ```uvgrtp_test -> Properties -> Linker -> General -> Additional Library Directories``` unless it is found in PATH. Building the uvgrtp_test will generate the program in Debug/Release folder. Run the ```uvgrtp_test.exe``` to start the automated tests. Using a command line is recommended so the results don't disappear after finishing.
Open the generated solution. Building the `uvgrtp_test` will generate the program in Debug/Release folder. Run the ```uvgrtp_test.exe``` to start the automated tests. Using a command line is recommended so the results don't disappear after finishing.
See the [build instruction](../BUILDING.md#linking-uvgrtp-and-crypto-to-an-application) for how to integrate Crypto++ to test suite.
## Current test suites
@ -25,7 +27,6 @@ Currently, the automated tests consist of the following test suites:
- [Format tests](test_4_formats.cpp)
- [SRTP + ZRTP tests](test_5_srtp_zrtp.cpp)
The tests should be coded in such a way to make the tests themselves as resilient as possible to problems while also validating that the uvgRTP output is correct. In other words, it is more helpful if a check is false than if the test suite crashes.
## Creating new tests