[openssl-commits] [openssl] master update

Emilia Kasper emilia at openssl.org
Wed Nov 9 15:11:11 UTC 2016


The branch master has been updated
       via  e364c3b24e38bd60d40487e0a532261348a9bb10 (commit)
      from  7380737d77e89edd17651b04e439223a47ea833e (commit)


- Log -----------------------------------------------------------------
commit e364c3b24e38bd60d40487e0a532261348a9bb10
Author: Emilia Kasper <emilia at openssl.org>
Date:   Mon Nov 7 16:53:15 2016 +0100

    Add main() test methods to reduce test boilerplate.
    
    Simple tests only need to implement register_tests().
    Tests that need a custom main() should implement test_main(). This will
    be wrapped in a main() that performs common setup/teardown (currently
    crypto-mdebug).
    
    Note that for normal development, enable-asan is usually
    sufficient for detecting leaks, and more versatile.
    
    enable-crypto-mdebug is stricter as it will also
    insist that all static variables be freed. This is useful for debugging
    library init/deinit; however, it also means that test_main() must free
    everything it allocates.
    
    Reviewed-by: Richard Levitte <levitte at openssl.org>
    Reviewed-by: Rich Salz <rsalz at openssl.org>

-----------------------------------------------------------------------

Summary of changes:
 test/asn1_internal_test.c                          |  5 +-
 test/build.info                                    | 26 ++++-----
 test/cipherlist_test.c                             |  9 +--
 test/ct_test.c                                     | 27 ++-------
 test/d2i_test.c                                    | 18 +-----
 test/dtlstest.c                                    | 18 +-----
 test/mdc2_internal_test.c                          |  5 +-
 test/modes_internal_test.c                         |  3 +-
 test/poly1305_internal_test.c                      |  3 +-
 test/ssl_test.c                                    |  4 +-
 test/ssl_test_ctx_test.c                           |  3 +-
 test/sslapitest.c                                  | 18 +-----
 test/{aborttest.c => test_main.c}                  | 18 ++++--
 .../include/internal/async.h => test/test_main.h   | 10 +++-
 test/{aborttest.c => test_main_custom.c}           | 16 ++++--
 .../test_main_custom.h                             | 12 ++--
 test/testutil.c                                    | 38 +++++++++++++
 test/testutil.h                                    | 64 ++++++++++++++++++----
 test/wpackettest.c                                 | 19 +------
 test/x509_internal_test.c                          |  5 +-
 20 files changed, 176 insertions(+), 145 deletions(-)
 copy test/{aborttest.c => test_main.c} (52%)
 copy crypto/include/internal/async.h => test/test_main.h (61%)
 copy test/{aborttest.c => test_main_custom.c} (60%)
 copy include/openssl/__DECC_INCLUDE_EPILOGUE.H => test/test_main_custom.h (51%)

diff --git a/test/asn1_internal_test.c b/test/asn1_internal_test.c
index 6a5fce4..b7e8af0 100644
--- a/test/asn1_internal_test.c
+++ b/test/asn1_internal_test.c
@@ -15,6 +15,7 @@
 #include <openssl/asn1.h>
 #include <openssl/evp.h>
 #include <openssl/objects.h>
+#include "test_main.h"
 #include "testutil.h"
 #include "e_os.h"
 
@@ -90,10 +91,8 @@ static int test_standard_methods()
     return 0;
 }
 
-int main(int argc, char **argv)
+void register_tests(void)
 {
     ADD_TEST(test_tbl_standard);
     ADD_TEST(test_standard_methods);
-
-    return run_tests(argv[0]);
 }
diff --git a/test/build.info b/test/build.info
index 6ec03f7..0ec31d9 100644
--- a/test/build.info
+++ b/test/build.info
@@ -226,7 +226,7 @@ IF[{- !$disabled{tests} -}]
   INCLUDE[dtlsv1listentest]=.. ../include
   DEPEND[dtlsv1listentest]=../libssl
 
-  SOURCE[ct_test]=ct_test.c testutil.c
+  SOURCE[ct_test]=ct_test.c testutil.c test_main_custom.c
   INCLUDE[ct_test]=../crypto/include ../include
   DEPEND[ct_test]=../libcrypto
 
@@ -238,19 +238,19 @@ IF[{- !$disabled{tests} -}]
   INCLUDE[afalgtest]=.. ../include
   DEPEND[afalgtest]=../libcrypto
 
-  SOURCE[d2i_test]=d2i_test.c testutil.c
+  SOURCE[d2i_test]=d2i_test.c testutil.c test_main_custom.c
   INCLUDE[d2i_test]=.. ../include
   DEPEND[d2i_test]=../libcrypto
 
-  SOURCE[ssl_test_ctx_test]=ssl_test_ctx_test.c ssl_test_ctx.c testutil.c
+  SOURCE[ssl_test_ctx_test]=ssl_test_ctx_test.c ssl_test_ctx.c testutil.c test_main_custom.c
   INCLUDE[ssl_test_ctx_test]=.. ../include
   DEPEND[ssl_test_ctx_test]=../libcrypto
 
-  SOURCE[ssl_test]=ssl_test.c ssl_test_ctx.c testutil.c handshake_helper.c
+  SOURCE[ssl_test]=ssl_test.c ssl_test_ctx.c testutil.c handshake_helper.c test_main_custom.c
   INCLUDE[ssl_test]=.. ../include
   DEPEND[ssl_test]=../libcrypto ../libssl
 
-  SOURCE[cipherlist_test]=cipherlist_test.c testutil.c
+  SOURCE[cipherlist_test]=cipherlist_test.c testutil.c test_main.c
   INCLUDE[cipherlist_test]=.. ../include
   DEPEND[cipherlist_test]=../libcrypto ../libssl
 
@@ -271,11 +271,11 @@ IF[{- !$disabled{tests} -}]
   INCLUDE[bioprinttest]=../include
   DEPEND[bioprinttest]=../libcrypto
 
-  SOURCE[sslapitest]=sslapitest.c ssltestlib.c testutil.c
+  SOURCE[sslapitest]=sslapitest.c ssltestlib.c testutil.c test_main_custom.c
   INCLUDE[sslapitest]=../include
   DEPEND[sslapitest]=../libcrypto ../libssl
 
-  SOURCE[dtlstest]=dtlstest.c ssltestlib.c testutil.c
+  SOURCE[dtlstest]=dtlstest.c ssltestlib.c testutil.c test_main_custom.c
   INCLUDE[dtlstest]=../include .
   DEPEND[dtlstest]=../libcrypto ../libssl
 
@@ -298,7 +298,7 @@ IF[{- !$disabled{tests} -}]
 
   IF[{- $disabled{shared} -}]
     PROGRAMS_NO_INST=wpackettest cipher_overhead_test
-    SOURCE[wpackettest]=wpackettest.c testutil.c
+    SOURCE[wpackettest]=wpackettest.c testutil.c test_main_custom.c
     INCLUDE[wpackettest]=../include
     DEPEND[wpackettest]=../libcrypto ../libssl
 
@@ -330,7 +330,7 @@ IF[{- !$disabled{tests} -}]
     PROGRAMS_NO_INST=poly1305_internal_test
   ENDIF
 
-  SOURCE[poly1305_internal_test]=poly1305_internal_test.c testutil.c
+  SOURCE[poly1305_internal_test]=poly1305_internal_test.c testutil.c test_main_custom.c
   IF[{- !$disabled{shared} -}]
     SOURCE[poly1305_internal_test]= ../crypto/poly1305/poly1305.c \
         {- rebase_files("../crypto/poly1305", $target{poly1305_asm_src}) -} \
@@ -340,7 +340,7 @@ IF[{- !$disabled{tests} -}]
   INCLUDE[poly1305_internal_test]=.. ../include ../crypto/include
   DEPEND[poly1305_internal_test]=../libcrypto
 
-  SOURCE[asn1_internal_test]=asn1_internal_test.c testutil.c
+  SOURCE[asn1_internal_test]=asn1_internal_test.c testutil.c test_main.c
   IF[{- !$disabled{shared} -}]
     SOURCE[asn1_internal_test]= ../crypto/asn1/a_strnid.c \
         ../crypto/rsa/rsa_ameth.c ../crypto/dsa/dsa_ameth.c \
@@ -351,7 +351,7 @@ IF[{- !$disabled{tests} -}]
   INCLUDE[asn1_internal_test]=.. ../include ../crypto/include
   DEPEND[asn1_internal_test]=../libcrypto
 
-  SOURCE[modes_internal_test]=modes_internal_test.c testutil.c
+  SOURCE[modes_internal_test]=modes_internal_test.c testutil.c test_main_custom.c
   IF[{- !$disabled{shared} -}]
     SOURCE[modes_internal_test]= \
         {- rebase_files("../crypto", $target{cpuid_asm_src}); -} \
@@ -363,7 +363,7 @@ IF[{- !$disabled{tests} -}]
   # The reason for the huge amount of directly included x509v3 files
   # is that a table that is checked by x509_internal_test refers to
   # structures that are spread all over those files.
-  SOURCE[x509_internal_test]=x509_internal_test.c testutil.c
+  SOURCE[x509_internal_test]=x509_internal_test.c testutil.c test_main.c
   IF[{- !$disabled{shared} -}]
     SOURCE[x509_internal_test]= ../crypto/x509v3/v3_bitst.c \
         ../crypto/x509v3/v3_ia5.c ../crypto/x509v3/v3_skey.c \
@@ -382,7 +382,7 @@ IF[{- !$disabled{tests} -}]
   INCLUDE[x509_internal_test]=.. ../include
   DEPEND[x509_internal_test]=../libcrypto
 
-  SOURCE[mdc2_internal_test]=mdc2_internal_test.c testutil.c
+  SOURCE[mdc2_internal_test]=mdc2_internal_test.c testutil.c test_main.c
   INCLUDE[mdc2_internal_test]=.. ../include
   DEPEND[mdc2_internal_test]=../libcrypto
 
diff --git a/test/cipherlist_test.c b/test/cipherlist_test.c
index b5dd7d9..40596bc 100644
--- a/test/cipherlist_test.c
+++ b/test/cipherlist_test.c
@@ -18,6 +18,7 @@
 #include <openssl/tls1.h>
 
 #include "e_os.h"
+#include "test_main.h"
 #include "testutil.h"
 
 typedef struct cipherlist_test_fixture {
@@ -189,14 +190,8 @@ static int test_default_cipherlist_explicit()
     EXECUTE_CIPHERLIST_TEST();
 }
 
-int main(int argc, char **argv)
+void register_tests()
 {
-    int result = 0;
-
     ADD_TEST(test_default_cipherlist_implicit);
     ADD_TEST(test_default_cipherlist_explicit);
-
-    result = run_tests(argv[0]);
-
-    return result;
 }
diff --git a/test/ct_test.c b/test/ct_test.c
index 2553bc6..edd02af 100644
--- a/test/ct_test.c
+++ b/test/ct_test.c
@@ -18,9 +18,9 @@
 #include <openssl/x509.h>
 #include <openssl/x509v3.h>
 #include "testutil.h"
+#include "test_main_custom.h"
 
 #ifndef OPENSSL_NO_CT
-
 /* Used when declaring buffers to read text files into */
 #define CT_TEST_MAX_FILE_SIZE 8096
 
@@ -530,15 +530,10 @@ static int test_encode_tls_sct()
     EXECUTE_CT_TEST();
 }
 
-int main(int argc, char *argv[])
+int test_main(int argc, char *argv[])
 {
     int result = 0;
-    char *tmp_env = NULL;
-
-    tmp_env = getenv("OPENSSL_DEBUG_MEMORY");
-    if (tmp_env != NULL && strcmp(tmp_env, "on") == 0)
-        CRYPTO_set_mem_debug(1);
-    CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
+    char *tmp_env;
 
     tmp_env = getenv("CT_DIR");
     ct_dir = OPENSSL_strdup(tmp_env != NULL ? tmp_env : "ct");
@@ -554,24 +549,10 @@ int main(int argc, char *argv[])
     ADD_TEST(test_encode_tls_sct);
 
     result = run_tests(argv[0]);
-    ERR_print_errors_fp(stderr);
 
     OPENSSL_free(ct_dir);
     OPENSSL_free(certs_dir);
 
-#ifndef OPENSSL_NO_CRYPTO_MDEBUG
-    if (CRYPTO_mem_leaks_fp(stderr) <= 0)
-        result = 1;
-#endif
-
     return result;
 }
-
-#else /* OPENSSL_NO_CT */
-
-int main(int argc, char* argv[])
-{
-    return EXIT_SUCCESS;
-}
-
-#endif /* OPENSSL_NO_CT */
+#endif
diff --git a/test/d2i_test.c b/test/d2i_test.c
index e12f249..e771e01 100644
--- a/test/d2i_test.c
+++ b/test/d2i_test.c
@@ -13,6 +13,7 @@
 #include <string.h>
 
 #include "testutil.h"
+#include "test_main_custom.h"
 
 #include <openssl/asn1.h>
 #include <openssl/asn1t.h>
@@ -109,12 +110,10 @@ static int test_bad_asn1()
  * Usage: d2i_test <type> <file>, e.g.
  * d2i_test generalname bad_generalname.der
  */
-int main(int argc, char **argv)
+int test_main(int argc, char *argv[])
 {
-    int result = 0;
     const char *test_type_name;
     const char *expected_error_string;
-    const char *p = getenv("OPENSSL_DEBUG_MEMORY");
 
     size_t i;
 
@@ -126,10 +125,6 @@ int main(int argc, char **argv)
         {"compare", ASN1_COMPARE}
     };
 
-    if (p != NULL && strcmp(p, "on") == 0)
-        CRYPTO_set_mem_debug(1);
-    CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
-
     if (argc != 4) {
         fprintf(stderr,
                 "Usage: d2i_test item_name expected_error file.der\n");
@@ -169,12 +164,5 @@ int main(int argc, char **argv)
 
     ADD_TEST(test_bad_asn1);
 
-    result = run_tests(argv[0]);
-
-#ifndef OPENSSL_NO_CRYPTO_MDEBUG
-    if (CRYPTO_mem_leaks_fp(stderr) <= 0)
-        result = 1;
-#endif
-
-    return result;
+    return run_tests(argv[0]);
 }
diff --git a/test/dtlstest.c b/test/dtlstest.c
index fd6e2ab..b4a756f 100644
--- a/test/dtlstest.c
+++ b/test/dtlstest.c
@@ -14,6 +14,7 @@
 
 #include "ssltestlib.h"
 #include "testutil.h"
+#include "test_main_custom.h"
 
 static char *cert = NULL;
 static char *privkey = NULL;
@@ -104,9 +105,8 @@ static int test_dtls_unprocessed(int testidx)
     return testresult;
 }
 
-int main(int argc, char *argv[])
+int test_main(int argc, char *argv[])
 {
-    BIO *err = NULL;
     int testresult = 1;
 
     if (argc != 3) {
@@ -117,11 +117,6 @@ int main(int argc, char *argv[])
     cert = argv[1];
     privkey = argv[2];
 
-    err = BIO_new_fp(stderr, BIO_NOCLOSE | BIO_FP_TEXT);
-
-    CRYPTO_set_mem_debug(1);
-    CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
-
     ADD_ALL_TESTS(test_dtls_unprocessed, NUM_TESTS);
 
     testresult = run_tests(argv[0]);
@@ -129,14 +124,5 @@ int main(int argc, char *argv[])
     bio_f_tls_dump_filter_free();
     bio_s_mempacket_test_free();
 
-#ifndef OPENSSL_NO_CRYPTO_MDEBUG
-    if (CRYPTO_mem_leaks(err) <= 0)
-        testresult = 1;
-#endif
-    BIO_free(err);
-
-    if (!testresult)
-        printf("PASS\n");
-
     return testresult;
 }
diff --git a/test/mdc2_internal_test.c b/test/mdc2_internal_test.c
index 3353507..9acea21 100644
--- a/test/mdc2_internal_test.c
+++ b/test/mdc2_internal_test.c
@@ -14,6 +14,7 @@
 
 #include <openssl/mdc2.h>
 #include "testutil.h"
+#include "test_main.h"
 #include "e_os.h"
 
 typedef struct {
@@ -63,9 +64,7 @@ static int test_mdc2(int idx)
     return 1;
 }
 
-int main(int argc, char **argv)
+void register_tests()
 {
     ADD_ALL_TESTS(test_mdc2, OSSL_NELEM(tests));
-
-    return run_tests(argv[0]);
 }
diff --git a/test/modes_internal_test.c b/test/modes_internal_test.c
index 5704503..c5265c9 100644
--- a/test/modes_internal_test.c
+++ b/test/modes_internal_test.c
@@ -16,6 +16,7 @@
 #include <openssl/modes.h>
 #include "../crypto/modes/modes_lcl.h"
 #include "testutil.h"
+#include "test_main_custom.h"
 #include "e_os.h"
 
 typedef struct {
@@ -964,7 +965,7 @@ static void benchmark_gcm128(const unsigned char *K, size_t Klen,
 #endif
 }
 
-int main(int argc, char **argv)
+int test_main(int argc, char **argv)
 {
     int result = 0;
     int iter_argv;
diff --git a/test/poly1305_internal_test.c b/test/poly1305_internal_test.c
index 17746ba..547c2fd 100644
--- a/test/poly1305_internal_test.c
+++ b/test/poly1305_internal_test.c
@@ -13,6 +13,7 @@
 #include <string.h>
 
 #include "testutil.h"
+#include "test_main_custom.h"
 #include "internal/poly1305.h"
 #include "../crypto/poly1305/poly1305_local.h"
 #include "e_os.h"
@@ -1638,7 +1639,7 @@ static int test_poly1305(int idx)
     return 1;
 }
 
-int main(int argc, char **argv)
+int test_main(int argc, char **argv)
 {
     int result = 0;
     int iter_argv;
diff --git a/test/ssl_test.c b/test/ssl_test.c
index e53889b..2003fd7 100644
--- a/test/ssl_test.c
+++ b/test/ssl_test.c
@@ -17,6 +17,7 @@
 #include "handshake_helper.h"
 #include "ssl_test_ctx.h"
 #include "testutil.h"
+#include "test_main_custom.h"
 
 static CONF *conf = NULL;
 
@@ -296,7 +297,7 @@ err:
     return ret;
 }
 
-int main(int argc, char **argv)
+int test_main(int argc, char **argv)
 {
     int result = 0;
     long num_tests;
@@ -315,5 +316,6 @@ int main(int argc, char **argv)
     ADD_ALL_TESTS(test_handshake, (int)(num_tests));
     result = run_tests(argv[0]);
 
+    NCONF_free(conf);
     return result;
 }
diff --git a/test/ssl_test_ctx_test.c b/test/ssl_test_ctx_test.c
index d8b9f83..36d17a7 100644
--- a/test/ssl_test_ctx_test.c
+++ b/test/ssl_test_ctx_test.c
@@ -18,6 +18,7 @@
 #include "e_os.h"
 #include "ssl_test_ctx.h"
 #include "testutil.h"
+#include "test_main_custom.h"
 #include <openssl/e_os2.h>
 #include <openssl/err.h>
 #include <openssl/conf.h>
@@ -303,7 +304,7 @@ static int test_bad_configuration(int idx)
     return 1;
 }
 
-int main(int argc, char **argv)
+int test_main(int argc, char **argv)
 {
     int result = 0;
 
diff --git a/test/sslapitest.c b/test/sslapitest.c
index a78b060..1fa9a8d 100644
--- a/test/sslapitest.c
+++ b/test/sslapitest.c
@@ -17,6 +17,7 @@
 
 #include "ssltestlib.h"
 #include "testutil.h"
+#include "test_main_custom.h"
 
 static char *cert = NULL;
 static char *privkey = NULL;
@@ -863,9 +864,8 @@ static int test_ssl_bio_change_wbio(void)
     EXECUTE_TEST(execute_test_ssl_bio, ssl_bio_tear_down);
 }
 
-int main(int argc, char *argv[])
+int test_main(int argc, char *argv[])
 {
-    BIO *err = NULL;
     int testresult = 1;
 
     if (argc != 3) {
@@ -876,11 +876,6 @@ int main(int argc, char *argv[])
     cert = argv[1];
     privkey = argv[2];
 
-    err = BIO_new_fp(stderr, BIO_NOCLOSE | BIO_FP_TEXT);
-
-    CRYPTO_set_mem_debug(1);
-    CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
-
     ADD_TEST(test_large_message_tls);
     ADD_TEST(test_large_message_tls_read_ahead);
 #ifndef OPENSSL_NO_DTLS
@@ -900,14 +895,5 @@ int main(int argc, char *argv[])
 
     bio_s_mempacket_test_free();
 
-#ifndef OPENSSL_NO_CRYPTO_MDEBUG
-    if (CRYPTO_mem_leaks(err) <= 0)
-        testresult = 1;
-#endif
-    BIO_free(err);
-
-    if (!testresult)
-        printf("PASS\n");
-
     return testresult;
 }
diff --git a/test/aborttest.c b/test/test_main.c
similarity index 52%
copy from test/aborttest.c
copy to test/test_main.c
index ba5055e..99b21ac 100644
--- a/test/aborttest.c
+++ b/test/test_main.c
@@ -7,10 +7,20 @@
  * https://www.openssl.org/source/license.html
  */
 
-#include <openssl/crypto.h>
+#include "test_main.h"
+#include "testutil.h"
 
-int main(int argc, char **argv)
+#include <stdio.h>
+
+int main(int argc, char *argv[])
 {
-    OPENSSL_die("Voluntary abort", __FILE__, __LINE__);
-    return 0;
+    int ret;
+    if (argc > 1)
+        printf("Warning: ignoring extra command-line arguments.\n");
+
+    setup_test();
+    register_tests();
+    ret = run_tests(argv[0]);
+
+    return finish_test(ret);
 }
diff --git a/crypto/include/internal/async.h b/test/test_main.h
similarity index 61%
copy from crypto/include/internal/async.h
copy to test/test_main.h
index db56258..ce0d06a 100644
--- a/crypto/include/internal/async.h
+++ b/test/test_main.h
@@ -7,8 +7,12 @@
  * https://www.openssl.org/source/license.html
  */
 
-#include <openssl/async.h>
+#ifndef HEADER_TEST_MAIN_H
+# define HEADER_TEST_MAIN_H
 
-int async_init(void);
-void async_deinit(void);
+/*
+ * Simple unit tests should implement register_tests() and link to test_main.c.
+ */
+extern void register_tests(void);
 
+#endif  /* HEADER_TEST_MAIN_H */
diff --git a/test/aborttest.c b/test/test_main_custom.c
similarity index 60%
copy from test/aborttest.c
copy to test/test_main_custom.c
index ba5055e..e10f279 100644
--- a/test/aborttest.c
+++ b/test/test_main_custom.c
@@ -7,10 +7,18 @@
  * https://www.openssl.org/source/license.html
  */
 
-#include <openssl/crypto.h>
+#include "test_main_custom.h"
+#include "testutil.h"
 
-int main(int argc, char **argv)
+#include <stdio.h>
+#include <stdlib.h>
+
+int main(int argc, char *argv[])
 {
-    OPENSSL_die("Voluntary abort", __FILE__, __LINE__);
-    return 0;
+    int ret;
+    setup_test();
+
+    ret = test_main(argc, argv);
+
+    return finish_test(ret);
 }
diff --git a/include/openssl/__DECC_INCLUDE_EPILOGUE.H b/test/test_main_custom.h
similarity index 51%
copy from include/openssl/__DECC_INCLUDE_EPILOGUE.H
copy to test/test_main_custom.h
index c350018..22bc8f5 100644
--- a/include/openssl/__DECC_INCLUDE_EPILOGUE.H
+++ b/test/test_main_custom.h
@@ -7,10 +7,14 @@
  * https://www.openssl.org/source/license.html
  */
 
+#ifndef HEADER_TEST_MAIN_CUSTOM_H
+# define HEADER_TEST_MAIN_CUSTOM_H
+
 /*
- * This file is only used by HP C on VMS, and is included automatically
- * after each header file from this directory
+ * Unit tests that need a custom main() should implement test_main and link to
+ * test_main_custom.c
+ * test_main() should return the result of run_tests().
  */
+extern int test_main(int argc, char *argv[]);
 
-/* restore state.  Must correspond to the save in __decc_include_prologue.h */
-#pragma names restore
+#endif  /* HEADER_TEST_MAIN_CUSTOM_H */
diff --git a/test/testutil.c b/test/testutil.c
index f1cad64..aab4513 100644
--- a/test/testutil.c
+++ b/test/testutil.c
@@ -15,6 +15,8 @@
 #include <string.h>
 #include "e_os.h"
 
+#include <openssl/opensslconf.h>
+#include <openssl/crypto.h>
 #include <openssl/err.h>
 
 /*
@@ -57,6 +59,42 @@ void add_all_tests(const char *test_case_name, int(*test_fn)(int idx),
     num_test_cases += num;
 }
 
+#ifndef OPENSSL_NO_CRYPTO_MDEBUG
+static int should_report_leaks()
+{
+    /*
+     * When compiled with enable-crypto-mdebug, OPENSSL_DEBUG_MEMORY=0
+     * can be used to disable leak checking at runtime.
+     * Note this only works when running the test binary manually;
+     * the test harness always enables OPENSSL_DEBUG_MEMORY.
+     */
+    char *mem_debug_env = getenv("OPENSSL_DEBUG_MEMORY");
+
+    return mem_debug_env == NULL
+        || (strcmp(mem_debug_env, "0") && strcmp(mem_debug_env, ""));
+}
+#endif
+
+
+void setup_test()
+{
+#ifndef OPENSSL_NO_CRYPTO_MDEBUG
+    if (should_report_leaks()) {
+        CRYPTO_set_mem_debug(1);
+        CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
+    }
+#endif
+}
+
+int finish_test(int ret)
+{
+#ifndef OPENSSL_NO_CRYPTO_MDEBUG
+    if (should_report_leaks() && CRYPTO_mem_leaks_fp(stderr) <= 0)
+        return EXIT_FAILURE;
+#endif
+    return ret;
+}
+
 static void finalize(int success)
 {
     if (success)
diff --git a/test/testutil.h b/test/testutil.h
index 53d58be..39b6d0e 100644
--- a/test/testutil.h
+++ b/test/testutil.h
@@ -11,14 +11,52 @@
 # define HEADER_TESTUTIL_H
 
 #include <openssl/err.h>
+#include <openssl/e_os2.h>
 
-/*
- * In main(), call ADD_TEST to register each test case function, then call
- * run_tests() to execute all tests and report the results. The result
- * returned from run_tests() should be used as the return value for main().
+/*-
+ * Simple unit tests should implement register_tests() from test_main.h
+ * and link against test_main.c.
+ * To register tests, call ADD_TEST or ADD_ALL_TESTS:
+ *
+ * #include "test_main.h"
+ *
+ * void register_tests(void)
+ * {
+ *     ADD_TEST(test_foo);
+ *     ADD_ALL_TESTS(test_bar, num_test_bar);
+ * }
+ *
+ * Tests that need to perform custom setup or read command-line arguments should
+ * implement test_main() from test_main_custom.h and link against
+ * test_main_custom.c:
+ *
+ * int test_main(int argc, char *argv[])
+ * {
+ *     int ret;
+ *
+ *     // Custom setup ...
+ *
+ *     ADD_TEST(test_foo);
+ *     ADD_ALL_TESTS(test_bar, num_test_bar);
+ *     // Add more tests ...
+ *
+ *     ret = run_tests(argv[0]);
+ *
+ *     // Custom teardown ...
+ *
+ *     return ret;
+ * }
  */
+
+/* Adds a simple test case. */
 # define ADD_TEST(test_function) add_test(#test_function, test_function)
 
+/*
+ * Simple parameterized tests. Calls test_function(idx) for each 0 <= idx < num.
+ */
+# define ADD_ALL_TESTS(test_function, num) \
+  add_all_tests(#test_function, test_function, num)
+
 /*-
  * Test cases that share common setup should use the helper
  * SETUP_TEST_FIXTURE and EXECUTE_TEST macros for test case functions.
@@ -82,15 +120,21 @@
 # endif                         /* __STDC_VERSION__ */
 
 /*
- * Simple parameterized tests. Adds a test_function(idx) test for each
- * 0 <= idx < num.
+ * Internal helpers. Test programs shouldn't use these directly, but should
+ * rather link to one of the helper main() methods.
  */
-# define ADD_ALL_TESTS(test_function, num) \
-  add_all_tests(#test_function, test_function, num)
+
+/* setup_test() should be called as the first thing in a test main(). */
+void setup_test(void);
+/*
+ * finish_test() should be called as the last thing in a test main().
+ * The result of run_tests() should be the input to finish_test().
+ */
+__owur int finish_test(int ret);
 
 void add_test(const char *test_case_name, int (*test_fn) ());
 void add_all_tests(const char *test_case_name, int (*test_fn)(int idx), int num);
-int run_tests(const char *test_prog_name);
+__owur int run_tests(const char *test_prog_name);
 
 /*
  *  Test assumption verification helpers.
@@ -101,7 +145,6 @@ int run_tests(const char *test_prog_name);
  * Otherwise, returns 0 and pretty-prints diagnostics using |desc|.
  */
 int strings_equal(const char *desc, const char *s1, const char *s2);
-#endif                          /* HEADER_TESTUTIL_H */
 
 /*
  * For "impossible" conditions such as malloc failures or bugs in test code,
@@ -115,3 +158,4 @@ int strings_equal(const char *desc, const char *s1, const char *s2);
             OPENSSL_assert(!#condition);        \
         }                                       \
     } while (0)
+#endif                          /* HEADER_TESTUTIL_H */
diff --git a/test/wpackettest.c b/test/wpackettest.c
index e082b18..52c9827 100644
--- a/test/wpackettest.c
+++ b/test/wpackettest.c
@@ -11,6 +11,7 @@
 #include <openssl/buffer.h>
 #include "../ssl/packet_locl.h"
 #include "testutil.h"
+#include "test_main_custom.h"
 
 const static unsigned char simple1 = 0xff;
 const static unsigned char simple2[] = { 0x01, 0xff };
@@ -401,16 +402,10 @@ static int test_WPACKET_memcpy(void)
     return 1;
 }
 
-int main(int argc, char *argv[])
+int test_main(int argc, char *argv[])
 {
-    BIO *err = NULL;
     int testresult = 0;
 
-    err = BIO_new_fp(stderr, BIO_NOCLOSE | BIO_FP_TEXT);
-
-    CRYPTO_set_mem_debug(1);
-    CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
-
     buf = BUF_MEM_new();
     if (buf != NULL) {
         ADD_TEST(test_WPACKET_init);
@@ -425,15 +420,5 @@ int main(int argc, char *argv[])
         BUF_MEM_free(buf);
     }
 
-#ifndef OPENSSL_NO_CRYPTO_MDEBUG
-    if (CRYPTO_mem_leaks(err) <= 0)
-        testresult = 1;
-#endif
-    BIO_free(err);
-
-    if (!testresult)
-        printf("PASS\n");
-
     return testresult;
 }
-
diff --git a/test/x509_internal_test.c b/test/x509_internal_test.c
index e0cb615..df88f89 100644
--- a/test/x509_internal_test.c
+++ b/test/x509_internal_test.c
@@ -15,6 +15,7 @@
 #include <openssl/x509.h>
 #include <openssl/x509v3.h>
 #include "testutil.h"
+#include "test_main.h"
 #include "e_os.h"
 
 /**********************************************************************
@@ -52,9 +53,7 @@ static int test_standard_exts()
     return good;
 }
 
-int main(int argc, char **argv)
+void register_tests()
 {
     ADD_TEST(test_standard_exts);
-
-    return run_tests(argv[0]);
 }


More information about the openssl-commits mailing list