pEpEngine/test/README.md

Building and Running the Tests for the p≡p Engine

Work in progress... Currently have the debian build/run instructions in.

Caveat, before you begin

Right now, the engine tests only function on *nix-like systems (including MacOS).

(Conversion to Windows will require, at the very least, looking at some of the file-handling code. If you want to fix this, start by looking in Engine.cc in the test/src directory!)

Requirements

In addition to the engine requirements, you will need:

• cmake
• python3
• git (for getting the gtest-parallel repository, unless you grab the tarball from somewhere)

Building the prerequisites

The Engine test suite now requires (at least) two additional pieces to run:

• googletest
• gtest-parallel

How this proceeds depends on your platform and whether or not you use a packaged distribution.

These instructions do this with cmake. If you can manage it with bazel instead, more power to you ;)

Installing googletest

Packaged distributions

This is the currently preferred way to do this, because everyone was doing it 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):

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

MacOS

I am totally guessing for now - this is a placeholder - that macports gtest install will do the same. Will need to find the directories this goes in. Guessing /opt/local/src.

Downloading and compiling the source yourself

1. Get the source, Fred. (Luke is tired of the source, I hear.)

git clone https://github.com/google/googletest.git

2. Switch into the source directory and find the directory containing the src and include directories. Mark this directory for later. (For me, this is ./googletest/googletest)

3. Edit CMakeLists.txt here to contain the following line at the top:

set (CMAKE_CXX_STANDARD 11)

(If you don't, it won't compile, and I will shake my fist at you.)

4. Execute, in this directory:

cmake CMakeLists.txt
make

5. In the lib directory of your current directory are located the library files you'll use. Copy or symlink them to the library location of your choice (make sure this is a directory that can be seen during the test build process - i.e. one that's in one of the library paths used in building. Mine are located in $HOME/lib.

6. See Makefile and local.conf under "Building the test suite" - In this scenario, I set GTEST_SRC_DIR googletest/googletest under the directory I checked out googletest in (i.e. the absolute path of where the src and include directories were above - for me, /Users/krista/googletest/googletest).

Installing gtest-parallel

Pick a source directory and put your gtest-parallel source there (e.g. via git clone https://github.com/google/gtest-parallel.git).

We'll deal more with this when preparing to compile the test suite.

Building the test suite

Makefile and local.conf

So local.conf in the top-level engine directory is where we stick all of the Makefile overrides. The test Makefile contains some defaults for relevant variables here, but if you need to override them, please either create or modify local.conf in the top-level engine directory as needed. The relevant variables are:

• GTEST_SRC_DIR: This is the directory where you compiled googletest above (defaults to /usr/src/gtest)
• GTEST_INC_DIR: This is where the include files for googletest are located (defaults to $(GTEST_SRC_DIR)/include)
• GTEST_PL: This is the full path to the python file for gtest_parallel (default presumes you cloned it under src in your home directory, i.e. it is $(HOME)/src/gtest-parallel/gtest_parallel.py)

Building

Presuming the above works, then from the top test directory, simply run make.

Running the test suite

To simply run the test suite and see what tests fail...

Do one of:

1. make test OR
2. python3 <path to gtest-parallel.py> ./EngineTests

To run individual test suites, especially for debugging purposes

Note that for some test suites, this will, if something goes dreadfully wrong, mean that one test's failure may pollute another test. This generally means you have found a dastardly bug in the engine, but it can also be a test issue.

Caveat lector.

1. To run sequentially, in the same process:

./EngineTests --gtest_filter=TestSuiteName*

For example, for DeleteKeyTest:

./EngineTests DeleteKeyTest*

2. To debug the same with lldb:

lldb ./EngineTests -- --gtest_filter=TestSuiteName*

3. To debug with gdb:

gdb --args ./EngineTests --gtest_filter=TestSuiteName*

To run and/or debug individual test cases

1. To run:

./EngineTests --gtest_filter=TestSuiteName.test_function_name

For example, for check_delete_single_pubkey in DeleteKeyTest:

./EngineTests DeleteKeyTest.check_delete_single_pubkey

2. To debug the same with lldb:

lldb ./EngineTests -- --gtest_filter=TestSuiteName.test_function_name

3. To debug with gdb:

gdb --args ./EngineTests --gtest_filter=TestSuiteName.test_function_name

Creating new tests

Script next on the agenda...

Known Problems

There are 5 (maybe 6) tests that currently fail which are the function of broken tests, not the engine. They are on the agenda to fix (expired keys inside imported mails, etc). You'll see something like this - please ignore for this particular second in time:

    170 ms: ./EngineTests SubkeyRatingEvalTest.check_subkey_rating_eval_no_es
     170 ms: ./EngineTests SubkeyRatingEvalTest.check_subkey_rating_eval_revoked_sign_no_alt
     253 ms: ./EngineTests SubkeyRatingEvalTest.check_subkey_rating_eval_weak_e_strong_ecc_se
    1189 ms: ./EngineTests KeyResetMessageTest.check_non_reset_receive_revoked
    1376 ms: ./EngineTests KeyResetMessageTest.check_reset_receive_revoked