1 // Copyright 2005, Google Inc.
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 //
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above
11 // copyright notice, this list of conditions and the following disclaimer
12 // in the documentation and/or other materials provided with the
13 // distribution.
14 // * Neither the name of Google Inc. nor the names of its
15 // contributors may be used to endorse or promote products derived from
16 // this software without specific prior written permission.
17 //
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30 // A sample program demonstrating using Google C++ testing framework.
31
32 // In this example, we use a more advanced feature of Google Test called
33 // test fixture.
34 //
35 // A test fixture is a place to hold objects and functions shared by
36 // all tests in a test case. Using a test fixture avoids duplicating
37 // the test code necessary to initialize and cleanup those common
38 // objects for each test. It is also useful for defining sub-routines
39 // that your tests need to invoke a lot.
40 //
41 // <TechnicalDetails>
42 //
43 // The tests share the test fixture in the sense of code sharing, not
44 // data sharing. Each test is given its own fresh copy of the
45 // fixture. You cannot expect the data modified by one test to be
46 // passed on to another test, which is a bad idea.
47 //
48 // The reason for this design is that tests should be independent and
49 // repeatable. In particular, a test should not fail as the result of
50 // another test's failure. If one test depends on info produced by
51 // another test, then the two tests should really be one big test.
52 //
53 // The macros for indicating the success/failure of a test
54 // (EXPECT_TRUE, FAIL, etc) need to know what the current test is
55 // (when Google Test prints the test result, it tells you which test
56 // each failure belongs to). Technically, these macros invoke a
57 // member function of the Test class. Therefore, you cannot use them
58 // in a global function. That's why you should put test sub-routines
59 // in a test fixture.
60 //
61 // </TechnicalDetails>
62
63 #include "sample3-inl.h"
64 #include "gtest/gtest.h"
65 namespace {
66 // To use a test fixture, derive a class from testing::Test.
67 class QueueTestSmpl3 : public testing::Test {
68 protected: // You should make the members protected s.t. they can be
69 // accessed from sub-classes.
70 // virtual void SetUp() will be called before each test is run. You
71 // should define it if you need to initialize the variables.
72 // Otherwise, this can be skipped.
SetUp()73 void SetUp() override {
74 q1_.Enqueue(1);
75 q2_.Enqueue(2);
76 q2_.Enqueue(3);
77 }
78
79 // virtual void TearDown() will be called after each test is run.
80 // You should define it if there is cleanup work to do. Otherwise,
81 // you don't have to provide it.
82 //
83 // virtual void TearDown() {
84 // }
85
86 // A helper function that some test uses.
Double(int n)87 static int Double(int n) { return 2 * n; }
88
89 // A helper function for testing Queue::Map().
MapTester(const Queue<int> * q)90 void MapTester(const Queue<int>* q) {
91 // Creates a new queue, where each element is twice as big as the
92 // corresponding one in q.
93 const Queue<int>* const new_q = q->Map(Double);
94
95 // Verifies that the new queue has the same size as q.
96 ASSERT_EQ(q->Size(), new_q->Size());
97
98 // Verifies the relationship between the elements of the two queues.
99 for (const QueueNode<int>*n1 = q->Head(), *n2 = new_q->Head();
100 n1 != nullptr; n1 = n1->next(), n2 = n2->next()) {
101 EXPECT_EQ(2 * n1->element(), n2->element());
102 }
103
104 delete new_q;
105 }
106
107 // Declares the variables your tests want to use.
108 Queue<int> q0_;
109 Queue<int> q1_;
110 Queue<int> q2_;
111 };
112
113 // When you have a test fixture, you define a test using TEST_F
114 // instead of TEST.
115
116 // Tests the default c'tor.
TEST_F(QueueTestSmpl3,DefaultConstructor)117 TEST_F(QueueTestSmpl3, DefaultConstructor) {
118 // You can access data in the test fixture here.
119 EXPECT_EQ(0u, q0_.Size());
120 }
121
122 // Tests Dequeue().
TEST_F(QueueTestSmpl3,Dequeue)123 TEST_F(QueueTestSmpl3, Dequeue) {
124 int* n = q0_.Dequeue();
125 EXPECT_TRUE(n == nullptr);
126
127 n = q1_.Dequeue();
128 ASSERT_TRUE(n != nullptr);
129 EXPECT_EQ(1, *n);
130 EXPECT_EQ(0u, q1_.Size());
131 delete n;
132
133 n = q2_.Dequeue();
134 ASSERT_TRUE(n != nullptr);
135 EXPECT_EQ(2, *n);
136 EXPECT_EQ(1u, q2_.Size());
137 delete n;
138 }
139
140 // Tests the Queue::Map() function.
TEST_F(QueueTestSmpl3,Map)141 TEST_F(QueueTestSmpl3, Map) {
142 MapTester(&q0_);
143 MapTester(&q1_);
144 MapTester(&q2_);
145 }
146 } // namespace
147