test/README.external

   1 Running external test suites with OpenSSL
   2 =========================================
   3
   4 It is possible to integrate external test suites into OpenSSL's "make test".
   5 This capability is considered a developer option and may not work on all
   6 platforms.
   7
   8 At the current time the only supported external suite is the one used by
   9 BoringSSL.
  10
  11
  12 The BoringSSL test suite
  13 ========================
  14
  15 In order to run the BoringSSL tests with OpenSSL, first checkout the BoringSSL
  16 source code into an appropriate directory:
  17
  18 $ git clone https://boringssl.googlesource.com/boringssl boringssl
  19
  20 The BoringSSL tests are only confirmed to work at a specific commit in the
  21 BoringSSL repository. Later commits may or may not pass the test suite:
  22
  23 $ cd boringssl
  24 $ git checkout 490469f850e
  25
  26 From the OpenSSL source code configure to use the external tests:
  27
  28 $ cd ../openssl
  29 $ ./config enable-ssl3 enable-ssl3-method enable-weak-ssl-ciphers \
  30   enable-external-tests
  31
  32 Note that using other config option than those given above may cause the tests
  33 to fail.
  34
  35 Run the OpenSSL tests by providing the path to the BoringSSL test runner in the
  36 BORING_RUNNER_DIR environment variable:
  37
  38 $ BORING_RUNNER_DIR=/path/to/boringssl/ssl/test/runner make test
  39
  40 Note that the test suite may change directory while running so the path provided
  41 should be absolute and not relative to the current working directory.
  42
  43 To see more detailed output you can run just the BoringSSL tests with the
  44 verbose option:
  45
  46 $ VERBOSE=1 BORING_RUNNER_DIR=/path/to/boringssl/ssl/test/runner make \
  47   TESTS="test_external_boringssl" test
  48
  49
  50 Test failures and suppressions
  51 ------------------------------
  52
  53 A large number of the BoringSSL tests are known to fail. A test could fail
  54 because of many possible reasons. For example:
  55
  56 - A bug in OpenSSL
  57 - Different interpretations of standards
  58 - Assumptions about the way BoringSSL works that do not apply to OpenSSL
  59 - The test uses APIs added to BoringSSL that are not present in OpenSSL
  60 - etc
  61
  62 In order to provide a "clean" baseline run with all the tests passing a config
  63 file has been provided that suppresses the running of tests that are known to
  64 fail. These suppressions are held in the file "test/ossl_shim/ossl_config.json"
  65 within the OpenSSL source code.
  66
  67 The community is encouraged to contribute patches which reduce the number of
  68 suppressions that are currently present.
  69