Skip to content

Commit 1b2822a

Browse files
winlinvipwinlinvip
committed
ST: Support utest by gtest and coverage by gcov/gocvr
1 parent 55dd343 commit 1b2822a

File tree

6 files changed

+228
-1
lines changed

6 files changed

+228
-1
lines changed

‎trunk/3rdparty/st-srs/.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,8 @@ DARWIN_*_DBG
22
LINUX_*_DBG
33
obj
44
st.pc
5+
6+
gtest
7+
*.gcda
8+
*.gcno
9+
*.html

‎trunk/3rdparty/st-srs/Makefile

+28
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,9 @@ DESC = st.pc
7575
TARGETS = darwin-debug darwin-optimized \
7676
linux-debug linux-optimized
7777

78+
UTEST_TARGETS = darwin-debug-utest linux-debug-utest \
79+
darwin-debug-gcov linux-debug-gcov
80+
7881
#
7982
# Platform specifics
8083
#
@@ -159,9 +162,14 @@ endif
159162
# or to enable stats for ST:
160163
#
161164
# make EXTRA_CFLAGS=-DDEBUG_STATS
165+
#
166+
# or enable the coverage for utest:
167+
# make UTEST_FLAGS="-fprofile-arcs -ftest-coverage"
168+
#
162169
##########################
163170

164171
CFLAGS += $(DEFINES) $(OTHER_FLAGS) $(EXTRA_CFLAGS)
172+
CFLAGS += $(UTEST_FLAGS)
165173

166174
OBJS = $(TARGETDIR)/sched.o \
167175
$(TARGETDIR)/stk.o \
@@ -204,6 +212,8 @@ unknown:
204212
@echo
205213
@for target in $(TARGETS); do echo $$target; done
206214
@echo
215+
@for target in $(UTEST_TARGETS); do echo $$target; done
216+
@echo
207217

208218
st.pc: st.pc.in
209219
sed "s/@VERSION@/${VERSION}/g" < $< > $@
@@ -267,5 +277,23 @@ linux-debug:
267277
linux-optimized:
268278
$(MAKE) OS="LINUX" BUILD="OPT"
269279

280+
darwin-debug-utest:
281+
@echo "Build utest for state-threads"
282+
$(MAKE) OS="DARWIN" BUILD="DBG"
283+
cd utest && $(MAKE)
284+
linux-debug-utest:
285+
@echo "Build utest for state-threads"
286+
$(MAKE) OS="LINUX" BUILD="DBG"
287+
cd utest && $(MAKE)
288+
289+
darwin-debug-gcov:
290+
@echo "Build utest with gcov for state-threads"
291+
$(MAKE) OS="DARWIN" BUILD="DBG" UTEST_FLAGS="-fprofile-arcs -ftest-coverage"
292+
cd utest && $(MAKE) UTEST_FLAGS="-fprofile-arcs -ftest-coverage"
293+
linux-debug-gcov:
294+
@echo "Build utest with gcov for state-threads"
295+
$(MAKE) OS="LINUX" BUILD="DBG" UTEST_FLAGS="-fprofile-arcs -ftest-coverage"
296+
cd utest && $(MAKE) UTEST_FLAGS="-fprofile-arcs -ftest-coverage"
297+
270298
##########################
271299

‎trunk/3rdparty/st-srs/README.md

+28-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Get code:
1515

1616
```
1717
git clone https://github.com/ossrs/state-threads.git st-1.9 &&
18-
git checkout -b srs origin/srs
18+
git checkout srs
1919
```
2020

2121
For Linux:
@@ -89,6 +89,33 @@ Important cli options:
8989
1. `--track-origins=<yes|no> [default: no]`, Controls whether Memcheck tracks the origin of uninitialised values. By default, it does not, which means that although it can tell you that an uninitialised value is being used in a dangerous way, it cannot tell you where the uninitialised value came from. This often makes it difficult to track down the root problem.
9090
1. `--show-reachable=<yes|no> , --show-possibly-lost=<yes|no>`, to show the using memory.
9191

92+
## UTest and Coverage
93+
94+
To make ST with utest and run it:
95+
96+
```bash
97+
make linux-debug-utest-gcov && ./obj/st_utest
98+
```
99+
100+
> For macOS: `make darwin-debug-utest-gcov && ./obj/st_utest`
101+
102+
Then, install [gcovr](https://gcovr.com/en/stable/guide.html) for coverage:
103+
104+
```bash
105+
yum install -y python2-pip &&
106+
pip install lxml && pip install gcovr
107+
```
108+
109+
> For macOS: `pip3 install gcovr`
110+
111+
Finally, run test and get the report
112+
113+
```bash
114+
mkdir -p coverage &&
115+
gcovr -r . -e LINUX -e DARWIN --html --html-details -o coverage/st.html &&
116+
open coverage/st.html
117+
```
118+
92119
## Docs & Analysis
93120

94121
* Introduction: http://ossrs.github.io/state-threads/docs/st.html

‎trunk/3rdparty/st-srs/utest/Makefile

+82
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# user must run make the objs/utest dir
2+
# at the same dir of Makefile.
3+
4+
# A sample Makefile for building Google Test and using it in user
5+
# tests. Please tweak it to suit your environment and project. You
6+
# may want to move it to your project's root directory.
7+
#
8+
# SYNOPSIS:
9+
#
10+
# make [all] - makes everything.
11+
# make TARGET - makes the given target.
12+
# make clean - removes all files generated by make.
13+
14+
# Please tweak the following variable definitions as needed by your
15+
# project, except GTEST_HEADERS, which you can use in your own targets
16+
# but shouldn't modify.
17+
18+
# Points to the root of Google Test, relative to where this file is.
19+
# Remember to tweak this if you move this file.
20+
GTEST_DIR = ./gtest
21+
22+
# Flags passed to the preprocessor.
23+
CPPFLAGS += -I$(GTEST_DIR)/include
24+
25+
# Flags passed to the C++ compiler.
26+
CXXFLAGS += -g -O0 -std=c++11
27+
CXXFLAGS += -Wall -Wno-deprecated-declarations -Wno-unused-private-field -Wno-unused-command-line-argument
28+
CXXFLAGS += -DGTEST_USE_OWN_TR1_TUPLE=1
29+
30+
# All tests produced by this Makefile. Remember to add new tests you
31+
# created to the list.
32+
TESTS = ../obj/st_utest
33+
34+
# All Google Test headers. Usually you shouldn't change this
35+
# definition.
36+
GTEST_HEADERS = $(GTEST_DIR)/include/gtest/*.h \
37+
$(GTEST_DIR)/include/gtest/internal/*.h
38+
39+
# House-keeping build targets.
40+
41+
all : $(TESTS)
42+
43+
clean :
44+
rm -f $(TESTS) gtest.a gtest_main.a *.o *.gcno *.gcda
45+
46+
# Usually you shouldn't tweak such internal variables, indicated by a
47+
# trailing _.
48+
GTEST_SRCS_ = $(GTEST_DIR)/src/*.cc $(GTEST_DIR)/src/*.h $(GTEST_HEADERS)
49+
50+
# For simplicity and to avoid depending on Google Test's
51+
# implementation details, the dependencies specified below are
52+
# conservative and not optimized. This is fine as Google Test
53+
# compiles fast and for ordinary users its source rarely changes.
54+
../obj/gtest-all.o : $(GTEST_SRCS_)
55+
$(CXX) $(CPPFLAGS) -I$(GTEST_DIR) $(CXXFLAGS) -c \
56+
$(GTEST_DIR)/src/gtest-all.cc -o $@
57+
58+
../obj/gtest.a : ../obj/gtest-all.o
59+
$(AR) $(ARFLAGS) $@ $^
60+
61+
#####################################################################################
62+
#####################################################################################
63+
# ST(state-threads) utest section
64+
#####################################################################################
65+
#####################################################################################
66+
67+
# Includes, the include dir.
68+
ST_UTEST_INC = -I../obj -I./
69+
70+
# Depends, the depends objects
71+
ST_UTEST_DEPS = ../obj/libst.a
72+
73+
# Depends, utest header files
74+
UTEST_DEPS = st_utest.hpp
75+
76+
# Objects, build each object of utest
77+
../obj/st_utest.o : $(UTEST_DEPS) st_utest.cpp $(ST_UTEST_DEPS)
78+
$(CXX) $(CPPFLAGS) $(CXXFLAGS) $(UTEST_FLAGS) $(ST_UTEST_INC) -c st_utest.cpp -o $@
79+
80+
# generate the utest binary
81+
../obj/st_utest : $(ST_UTEST_DEPS) ../obj/st_utest.o ../obj/gtest.a
82+
$(CXX) -o $@ $(CPPFLAGS) $(CXXFLAGS) $(UTEST_FLAGS) $^ -lpthread -ldl -lpthread

‎trunk/3rdparty/st-srs/utest/st_utest.cpp

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
/*
2+
The MIT License (MIT)
3+
4+
Copyright (c) 2021 Winlin
5+
6+
Permission is hereby granted, free of charge, to any person obtaining a copy of
7+
this software and associated documentation files (the "Software"), to deal in
8+
the Software without restriction, including without limitation the rights to
9+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
10+
the Software, and to permit persons to whom the Software is furnished to do so,
11+
subject to the following conditions:
12+
13+
The above copyright notice and this permission notice shall be included in all
14+
copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
18+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
19+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
20+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22+
*/
23+
24+
#include <st_utest.hpp>
25+
26+
#include <st.h>
27+
#include <assert.h>
28+
29+
// We could do something in the main of utest.
30+
// Copy from gtest-1.6.0/src/gtest_main.cc
31+
GTEST_API_ int main(int argc, char **argv) {
32+
// Select the best event system available on the OS. In Linux this is
33+
// epoll(). On BSD it will be kqueue.
34+
assert(st_set_eventsys(ST_EVENTSYS_ALT) != -1);
35+
assert(st_init() == 0);
36+
37+
testing::InitGoogleTest(&argc, argv);
38+
return RUN_ALL_TESTS();
39+
}
40+
41+
// basic test and samples.
42+
VOID TEST(SampleTest, FastSampleInt64Test)
43+
{
44+
EXPECT_EQ(1, (int)sizeof(int8_t));
45+
EXPECT_EQ(2, (int)sizeof(int16_t));
46+
EXPECT_EQ(4, (int)sizeof(int32_t));
47+
EXPECT_EQ(8, (int)sizeof(int64_t));
48+
}
49+

‎trunk/3rdparty/st-srs/utest/st_utest.hpp

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
/*
2+
The MIT License (MIT)
3+
4+
Copyright (c) 2021 Winlin
5+
6+
Permission is hereby granted, free of charge, to any person obtaining a copy of
7+
this software and associated documentation files (the "Software"), to deal in
8+
the Software without restriction, including without limitation the rights to
9+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
10+
the Software, and to permit persons to whom the Software is furnished to do so,
11+
subject to the following conditions:
12+
13+
The above copyright notice and this permission notice shall be included in all
14+
copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
18+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
19+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
20+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22+
*/
23+
24+
#ifndef ST_UTEST_PUBLIC_HPP
25+
#define ST_UTEST_PUBLIC_HPP
26+
27+
// Before define the private/protected, we must include some system header files.
28+
// Or it may fail with:
29+
// redeclared with different access struct __xfer_bufptrs
30+
// @see https://stackoverflow.com/questions/47839718/sstream-redeclared-with-public-access-compiler-error
31+
#include <gtest/gtest.h>
32+
33+
#define VOID
34+
35+
#endif
36+

0 commit comments

Comments
 (0)