gem5  v20.1.0.5
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
unittest.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011 Advanced Micro Devices, Inc.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met: redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer;
9  * redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution;
12  * neither the name of the copyright holders nor the names of its
13  * contributors may be used to endorse or promote products derived from
14  * this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 #include "unittest/unittest.hh"
30 
31 #include <cstdlib>
32 
33 #include "base/cprintf.hh"
34 
35 namespace {
36 
37 bool _printOnPass = (getenv("PRINT_ON_PASS") != NULL);
38 unsigned _passes = 0;
39 unsigned _failures = 0;
40 
41 bool _casePrinted = false;
42 const char *_case = NULL;
43 
44 } // anonymous namespace
45 
46 namespace UnitTest {
47 
48 void
49 checkVal(const char *file, const unsigned line,
50  const char *test, const bool result)
51 {
52  if (!result || _printOnPass) {
53  if (!_casePrinted && _case) {
54  cprintf("CASE %s:\n", _case);
55  _casePrinted = true;
56  }
57  cprintf(" CHECK %s: %s:%d %s\n",
58  result ? "PASSED" : "FAILED", file, line, test);
59  }
60  if (result) _passes++;
61  else _failures++;
62 }
63 
64 bool printOnPass() { return _printOnPass; }
65 void printOnPass(bool newPrintOnPass) { _printOnPass = newPrintOnPass; }
66 
67 unsigned passes() { return _passes; }
68 unsigned failures() { return _failures; }
69 
70 unsigned
71 printResults()
72 {
73  cprintf("TEST %s: %d checks passed, %d checks failed.\n",
74  _failures ? "FAILED" : "PASSED", _passes, _failures);
75  return _failures;
76 }
77 
78 void
79 reset()
80 {
81  _passes = 0;
82  _failures = 0;
83 }
84 
85 void
86 setCase(const char *newCase)
87 {
88  _casePrinted = false;
89  _case = newCase;
90 }
91 
92 } //namespace UnitTest
UnitTest::printOnPass
bool printOnPass()
Print on pass is a switch that specifies whether to print a message even when a check passes.
Definition: unittest.cc:64
UnitTest
Definition: unittest.cc:46
test
Definition: test.h:38
UnitTest::reset
void reset()
Zero the number of passes and failures so far.
Definition: unittest.cc:79
UnitTest::setCase
void setCase(const char *newCase)
Sets the current test case.
Definition: unittest.cc:86
cprintf
void cprintf(const char *format, const Args &...args)
Definition: cprintf.hh:152
cprintf.hh
unittest.hh
UnitTest::printResults
unsigned printResults()
Function to call at the end of a test that prints an overall result and a summary of how many checks ...
Definition: unittest.cc:71
UnitTest::passes
unsigned passes()
Function that returns the current number of passed checks.
Definition: unittest.cc:67
UnitTest::failures
unsigned failures()
Function that returns the current number of failed checks.
Definition: unittest.cc:68
UnitTest::checkVal
void checkVal(const char *file, const unsigned line, const char *test, const bool result)
Function that actually handles checking whether an EXPECT_* passed.
Definition: unittest.cc:49
Generated on Thu Mar 18 2021 12:09:21 for gem5 by doxygen 1.8.17