tests: log_call is not returning any value
[gem5.git] / src / base / callback.test.cc
1 /*
2 * Copyright (c) 2019 The Regents of the University of California
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder. You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions are
16 * met: redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer;
18 * redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution;
21 * neither the name of the copyright holders nor the names of its
22 * contributors may be used to endorse or promote products derived from
23 * this software without specific prior written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 */
37
38 #include <gtest/gtest.h>
39
40 #include "base/callback.hh"
41
42 class CallbackImpl : public Callback
43 {
44 public:
45 bool processed = false;
46 void process()
47 {
48 processed = true;
49 }
50 };
51
52 class MockClass
53 {
54 public:
55 bool methodExecuted = false;
56 void method()
57 {
58 methodExecuted = true;
59 }
60 };
61
62 TEST(CallbackQueueTest, GetName)
63 {
64 CallbackQueue callbackQueue;
65 EXPECT_EQ("CallbackQueue", callbackQueue.name());
66 }
67
68 TEST(CallbackQueueTest, IsEmpty)
69 {
70 CallbackQueue callbackQueue;
71 EXPECT_TRUE(callbackQueue.empty());
72 }
73
74 TEST(CallbackQueueTest, IsNotEmpty)
75 {
76 CallbackQueue callbackQueue;
77 CallbackImpl impl;
78 callbackQueue.add(&impl);
79 EXPECT_FALSE(callbackQueue.empty());
80 }
81
82 TEST(CallbackQueueTest, AddOneAndProcess)
83 {
84 CallbackQueue callbackQueue;
85 CallbackImpl impl;
86 callbackQueue.add(&impl);
87 EXPECT_FALSE(impl.processed);
88 callbackQueue.process();
89 EXPECT_TRUE(impl.processed);
90 // Processing a queue does not clear it.
91 EXPECT_FALSE(callbackQueue.empty());
92 }
93
94 TEST(CallbackQueueTest, AddManyAndProcess)
95 {
96 CallbackQueue callbackQueue;
97 CallbackImpl impl1;
98 CallbackImpl impl2;
99 CallbackImpl impl3;
100 CallbackImpl impl4;
101 callbackQueue.add(&impl1);
102 callbackQueue.add(&impl2);
103 callbackQueue.add(&impl3);
104 callbackQueue.add(&impl4);
105 EXPECT_FALSE(impl1.processed);
106 EXPECT_FALSE(impl2.processed);
107 EXPECT_FALSE(impl3.processed);
108 EXPECT_FALSE(impl4.processed);
109 callbackQueue.process();
110 EXPECT_TRUE(impl1.processed);
111 EXPECT_TRUE(impl2.processed);
112 EXPECT_TRUE(impl3.processed);
113 EXPECT_TRUE(impl4.processed);
114 EXPECT_FALSE(callbackQueue.empty());
115 }
116
117 TEST(CallbackQueueTest, ClearQueue)
118 {
119 CallbackQueue callbackQueue;
120 CallbackImpl callbackImpl;
121 callbackQueue.add(&callbackImpl);
122 EXPECT_FALSE(callbackQueue.empty());
123 callbackQueue.clear();
124 EXPECT_TRUE(callbackQueue.empty());
125 }
126
127 TEST(CallbackQueueTest, MakeCallbackAddByReference)
128 {
129 CallbackQueue callbackQueue;
130 MockClass mockClass;
131 EXPECT_FALSE(mockClass.methodExecuted);
132 callbackQueue.add<MockClass, &MockClass::method>(mockClass);
133 callbackQueue.process();
134 EXPECT_TRUE(mockClass.methodExecuted);
135 EXPECT_FALSE(callbackQueue.empty());
136 }
137
138 TEST(CallbackQueueTest, MakeCallbackAddByPointer)
139 {
140 CallbackQueue callbackQueue;
141 MockClass mockClass;
142 EXPECT_FALSE(mockClass.methodExecuted);
143 callbackQueue.add<MockClass, &MockClass::method>(&mockClass);
144 callbackQueue.process();
145 EXPECT_TRUE(mockClass.methodExecuted);
146 EXPECT_FALSE(callbackQueue.empty());
147 }