util: Add a unit test for the m5 util's "sum" command.
[gem5.git] / util / m5 / src / command / sum.test.cc
1 /*
2 * Copyright 2020 Google Inc.
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: redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer;
8 * redistributions in binary form must reproduce the above copyright
9 * notice, this list of conditions and the following disclaimer in the
10 * documentation and/or other materials provided with the distribution;
11 * neither the name of the copyright holders nor the names of its
12 * contributors may be used to endorse or promote products derived from
13 * this software without specific prior written permission.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28 #include <gtest/gtest.h>
29
30 #include <sstream>
31
32 #include "args.hh"
33 #include "command.hh"
34 #include "dispatch_table.hh"
35
36 unsigned test_a, test_b, test_c, test_d, test_e, test_f;
37 unsigned test_result;
38
39 unsigned
40 test_m5_sum(unsigned a, unsigned b, unsigned c,
41 unsigned d, unsigned e, unsigned f)
42 {
43 test_a = a;
44 test_b = b;
45 test_c = c;
46 test_d = d;
47 test_e = e;
48 test_f = f;
49
50 return test_result;
51 }
52
53 void
54 check_args(unsigned a, unsigned b, unsigned c,
55 unsigned d, unsigned e, unsigned f)
56 {
57 EXPECT_EQ(test_a, a);
58 EXPECT_EQ(test_b, b);
59 EXPECT_EQ(test_c, c);
60 EXPECT_EQ(test_d, d);
61 EXPECT_EQ(test_e, e);
62 EXPECT_EQ(test_f, f);
63 }
64
65 DispatchTable dt = { .m5_sum = &test_m5_sum };
66
67 std::string cout_output;
68
69 bool
70 run(std::initializer_list<std::string> arg_args)
71 {
72 Args args(arg_args);
73
74 // Redirect cout into a stringstream.
75 std::stringstream buffer;
76 std::streambuf *orig = std::cout.rdbuf(buffer.rdbuf());
77
78 bool res = Command::run(dt, args);
79
80 // Capture the contents of the stringstream and restore cout.
81 cout_output = buffer.str();
82 std::cout.rdbuf(orig);
83
84 return res;
85 }
86
87 TEST(Sum, Arguments)
88 {
89 // Called with no arguments.
90 EXPECT_FALSE(run({"sum"}));
91
92 // Called with one argument.
93 EXPECT_FALSE(run({"sum", "1"}));
94
95 // Called with two arguments.
96 test_result = 42;
97 EXPECT_TRUE(run({"sum", "1", "2"}));
98 check_args(1, 2, 0, 0, 0, 0);
99 EXPECT_EQ(cout_output, "Sum is 42.\n");
100
101 // Call with all arguments.
102 test_result = 314159;
103 EXPECT_TRUE(run({"sum", "6", "5", "4", "3", "2", "1"}));
104 check_args(6, 5, 4, 3, 2, 1);
105 EXPECT_EQ(cout_output, "Sum is 314159.\n");
106 }