Browse Source

Improve test/README.md

- Document an even easier way to use google test on Debian.

  - Add a note about --gtest_break_on_failure.
ENGINE-655
Neal Walfield 3 years ago
parent
commit
f555c457b3
1 changed files with 26 additions and 21 deletions
  1. +26
    -21
      test/README.md

+ 26
- 21
test/README.md View File

@ -41,27 +41,29 @@ anyway and who am I to judge?
##### Debian and Ubuntu (and derivatives)
Thanks to Erik Smistad for this starting point (condensed from [Getting Started
with Google Test On
Ubuntu](https://www.eriksmistad.no/getting-started-with-google-test-on-ubuntu/)):
1. Install the packages `cmake` and `libgtest-dev` from the repository. This
will install the gtest source files to `/usr/src/gtest`. You'll still need to
compile the code and link the library files to be able to use them.
2. Compile the source files:
```
cd /usr/src/gtest
sudo cmake CMakeLists.txt
sudo make
```
3. Copy/symlink the libraries to the library location of your choice (here,
it's `/usr/lib`, hence the `sudo`, but as long as it's in your library path,
it shouldn't matter where you stick it):
```
sudo cp *.a /usr/lib
```
Using the libgtest-dev is easy, but not straightforward.
Unfortunately, the version of google test in Debian Buster is too old:
it's version 1.8 and we require version 1.9. Version 1.9 is available
in Debian Testing, but it is built with g++ 9.0, which is ABI
incompatible with binaries built with g++ 8.0, which is in Debian
stable. Specifically, gcc has changed the semantics of std::string
with C++11 and using g++ 8.0 results in the errors like the following:
undefined reference to `std::__cxx11::basic_stringstream<char, std::char_traits<char>, std::allocator<char> >::basic_stringstream()'
It's possible to install g++ 9.0 from testing to get the test suite
working, but that breaks other things (at least for me -Neal).
Instead, the easiest thing to do it to rebuild gtest for Debian
Stable. This is straightforward:
$ sudo apt install build-essential cmake debhelper
$ apt source -t testing libgtest-dev
$ cd googletest-1.9.0.20190831
$ dpkg-buildpackage -us -uc
...
$ sudo dpkg -i googletest_1.9.0.20190831-1_amd64.deb libgtest-dev_1.9.0.20190831-1_amd64.deb
That's it.
##### MacOS
@ -197,6 +199,9 @@ have found a dastardly bug in the engine, but it can also be a test issue.
gdb --args ./EngineTests --gtest_filter=TestSuiteName.test_function_name
```
When debugging a failing test, use '--gtest_break_on_failure' to have
gtest automatically break into the debugger where the assertion fails.
# Creating new tests
Script next on the agenda...


Loading…
Cancel
Save