05ed589f7457191b5223e4697a31256285c31fa1
[oweals/openssl.git] / test / testutil.c
1 /* test/testutil.c */
2 /*-
3  * Utilities for writing OpenSSL unit tests.
4  *
5  * More information:
6  * http://wiki.openssl.org/index.php/How_To_Write_Unit_Tests_For_OpenSSL
7  *
8  * Author: Mike Bland (mbland@acm.org)
9  * Date:   2014-07-15
10  * ====================================================================
11  * Copyright (c) 2014 The OpenSSL Project.  All rights reserved.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  *
17  * 1. Redistributions of source code must retain the above copyright
18  *    notice, this list of conditions and the following disclaimer.
19  *
20  * 2. Redistributions in binary form must reproduce the above copyright
21  *    notice, this list of conditions and the following disclaimer in
22  *    the documentation and/or other materials provided with the
23  *    distribution.
24  *
25  * 3. All advertising materials mentioning features or use of this
26  *    software must display the following acknowledgment:
27  *    "This product includes software developed by the OpenSSL Project
28  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
29  *
30  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
31  *    endorse or promote products derived from this software without
32  *    prior written permission. For written permission, please contact
33  *    licensing@OpenSSL.org.
34  *
35  * 5. Products derived from this software may not be called "OpenSSL"
36  *    nor may "OpenSSL" appear in their names without prior written
37  *    permission of the OpenSSL Project.
38  *
39  * 6. Redistributions of any form whatsoever must retain the following
40  *    acknowledgment:
41  *    "This product includes software developed by the OpenSSL Project
42  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
43  *
44  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
45  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
46  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
47  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
48  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
49  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
50  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
51  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
52  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
53  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
54  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
55  * OF THE POSSIBILITY OF SUCH DAMAGE.
56  * ====================================================================
57  */
58
59 #include "testutil.h"
60
61 #include <assert.h>
62 #include <stdlib.h>
63 #include <stdio.h>
64
65 /*
66  * Declares the structures needed to register each test case function.
67  */
68 typedef struct test_info {
69     const char *test_case_name;
70     int (*test_fn) ();
71 } TEST_INFO;
72
73 static TEST_INFO all_tests[1024];
74 static int num_tests = 0;
75
76 void add_test(const char *test_case_name, int (*test_fn) ())
77 {
78     assert(num_tests != (sizeof(all_tests) / sizeof(all_tests)[0]));
79     all_tests[num_tests].test_case_name = test_case_name;
80     all_tests[num_tests].test_fn = test_fn;
81     ++num_tests;
82 }
83
84 int run_tests(const char *test_prog_name)
85 {
86     int num_failed = 0;
87     int i = 0;
88
89     printf("%s: %d test case%s\n", test_prog_name, num_tests,
90            num_tests == 1 ? "" : "s");
91     for (i = 0; i != num_tests; ++i) {
92         if (all_tests[i].test_fn()) {
93             printf("** %s failed **\n--------\n",
94                    all_tests[i].test_case_name);
95             ++num_failed;
96         }
97     }
98
99     if (num_failed != 0) {
100         printf("%s: %d test%s failed (out of %d)\n", test_prog_name,
101                num_failed, num_failed != 1 ? "s" : "", num_tests);
102         return EXIT_FAILURE;
103     }
104     printf("  All tests passed.\n");
105     return EXIT_SUCCESS;
106 }