tests

Overview:

This directory contains dedicated unit tests for Open Enclave. To run all tests Open Enclave tests, type the following commands to build and run the tests from the corresponding CMake output folder.

build$ make
build$ ctest

To run only specific tests, go to the corresponding subtree in the build directory and run ctest from there. For example,

build/tests/echo$ make

This builds and runs all the tests. For libcxx a small subset is the default, the complete one is very slow to build and run. To enable the full set, set the ENABLE_FULL_LIBCXX_TESTS cmake variable as follows:

build$ cmake .. -DENABLE_FULL_LIBCXX_TESTS=1
build$ make
build$ ctest

Test mechanics

OE_TEST() is used as a simple check, and is the general paradigm in all tests.

Some tests can only be run in certain environments and fail in others. It is recommended for such tests to check the environment, and abort the test signalling a "did not run" state to ctest (rather than failing). To signal "did not run", such tests should return with an exit code of 2. ctest evaluates this specifically.

On calls to add_enclave

The test enclave targets are added by calling add_enclave, a CMake macro defined in cmake/add_enclave.cmake. This macro determines at configuration-time whether enclaves are being built for Intel SGX or ARM TrustZone. SGX enclave binaries can be named anything, and as such their on-disk name follows the name given in the TARGET parameter of the add_enclave macro. ARM TrustZone enclaves are different, and must always be named with a UUID. Hence, every call to add_enclave includes a friendly CMake target name, which is also used for the on-disk name of SGX enclave binaries, and a UUID, used for the on-disk name of ARM TrustZone enclave binaries. The CMake target name however is always the value of TARGET, never that of UUID.