1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/reporting/util/status_macros.h"
#include "base/debug/stack_trace.h"
#include "base/types/expected.h"
#include "components/reporting/util/status.h"
#include "components/reporting/util/statusor.h"
#include "testing/gtest/include/gtest/gtest-spi.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace reporting {
namespace {
Status StatusTestFunction(bool fail) {
if (fail) {
return Status(error::INVALID_ARGUMENT, "Fail was true.");
}
return Status::StatusOK();
}
Status ReturnIfErrorStatusWrapperFunction(bool fail) {
RETURN_IF_ERROR_STATUS(StatusTestFunction(fail));
// Return error here to make sure that we aren't just returning the OK from
// StatusTestFunction.
return Status(error::INTERNAL, "Returning Internal Error");
}
// RETURN_IF_ERROR_STATUS macro actually returns on a non-OK status.
TEST(StatusMacros, ReturnsOnErrorStatus) {
Status test_status = ReturnIfErrorStatusWrapperFunction(/*fail=*/true);
EXPECT_FALSE(test_status.ok());
EXPECT_EQ(test_status.code(), error::INVALID_ARGUMENT);
}
// RETURN_IF_ERROR_STATUS macro continues on an OK status.
TEST(StatusMacros, ReturnIfErrorStatusContinuesOnOk) {
Status test_status = ReturnIfErrorStatusWrapperFunction(/*fail=*/false);
EXPECT_FALSE(test_status.ok());
EXPECT_EQ(test_status.code(), error::INTERNAL);
}
base::unexpected<Status> UnexpectedStatusTestFunction(bool fail) {
if (fail) {
return base::unexpected(Status(error::INVALID_ARGUMENT, "Fail was true."));
}
return base::unexpected(Status::StatusOK());
}
StatusOr<int> ReturnIfErrorUnexpectedStatusWrapperFunction(bool fail) {
RETURN_IF_ERROR_STATUS(UnexpectedStatusTestFunction(fail));
// Return error here to make sure that we aren't just returning the OK from
// UnexpectedStatusTestFunction.
return base::unexpected(Status(error::INTERNAL, "Returning Internal Error"));
}
// RETURN_IF_ERROR_STATUS macro actually returns on a non-OK status.
TEST(StatusMacros, ReturnsOnErrorUnexpectedStatus) {
StatusOr<int> test_status =
ReturnIfErrorUnexpectedStatusWrapperFunction(/*fail=*/true);
EXPECT_FALSE(test_status.has_value());
EXPECT_EQ(test_status.error().code(), error::INVALID_ARGUMENT);
}
// RETURN_IF_ERROR_STATUS macro continues on an OK status.
TEST(StatusMacros, ReturnIfErrorUnexpectedStatusContinuesOnOk) {
StatusOr<int> test_status =
ReturnIfErrorUnexpectedStatusWrapperFunction(/*fail=*/false);
EXPECT_FALSE(test_status.has_value());
EXPECT_EQ(test_status.error().code(), error::INTERNAL);
}
TEST(StatusMacros, CheckOKOnStatus) {
const auto ok_status = Status::StatusOK();
CHECK_OK(ok_status);
CHECK_OK(ok_status) << "error message";
// rvalue
CHECK_OK(Status::StatusOK());
// Can't check on error status here because CHECK does not use gtest
// utilities.
}
TEST(StatusMacros, DCheckOKOnStatus) {
const auto ok_status = Status::StatusOK();
DCHECK_OK(ok_status);
DCHECK_OK(ok_status) << "error message";
// rvalue
DCHECK_OK(Status::StatusOK());
// Can't check on error status here because DCHECK does not use gtest
// utilities.
}
void AssertOKErrorStatus() {
ASSERT_OK(Status(error::INTERNAL, ""));
}
TEST(StatusMacros, AssertOKOnStatus) {
// The assertion failure in AssertOKErrorStatus will generate a stack trace.
// This is desirable for the normal case, where the trace can help the
// developer understand the failure. In this test, however, the failure is
// expected and its output is swallowed. Suppress generation of stack traces
// so that the cost of generating them does not lead to flaky timeouts in
// configurations where the collection and emission of stack traces is
// expensive (e.g., in debug builds).
base::debug::OverrideStackTraceOutputForTesting suppress_stacks(
base::debug::OverrideStackTraceOutputForTesting::Mode::kSuppressOutput);
const auto ok_status = Status::StatusOK();
ASSERT_OK(ok_status);
ASSERT_OK(ok_status) << "error message";
// rvalue
ASSERT_OK(Status::StatusOK());
EXPECT_FATAL_FAILURE(AssertOKErrorStatus(), "error::INTERNAL");
}
void ExpectOKErrorStatus() {
EXPECT_OK(Status(error::INTERNAL, ""));
}
TEST(StatusMacros, ExpectOKOnStatus) {
// The assertion failure in ExpectOKErrorStatus will generate a stack trace.
// This is desirable for the normal case, where the trace can help the
// developer understand the failure. In this test, however, the failure is
// expected and its output is swallowed. Suppress generation of stack traces
// so that the cost of generating them does not lead to flaky timeouts in
// configurations where the collection and emission of stack traces is
// expensive (e.g., in debug builds).
base::debug::OverrideStackTraceOutputForTesting suppress_stacks(
base::debug::OverrideStackTraceOutputForTesting::Mode::kSuppressOutput);
EXPECT_OK(Status::StatusOK());
EXPECT_OK(Status::StatusOK()) << "error message";
EXPECT_NONFATAL_FAILURE(ExpectOKErrorStatus(), "error::INTERNAL");
}
TEST(StatusMacros, CheckOKOnStatusOr) {
StatusOr<int> status_or(2);
CHECK_OK(status_or);
CHECK_OK(status_or) << "error message";
// rvalue
CHECK_OK(StatusOr<int>(2));
// Can't check on error status here because CHECK does not use gtest
// utilities.
}
TEST(StatusMacros, DCheckOKOnStatusOr) {
StatusOr<int> status_or(2);
DCHECK_OK(status_or);
DCHECK_OK(status_or) << "error message";
// rvalue
DCHECK_OK(StatusOr<int>(2));
// Can't check on error status here because DCHECK does not use gtest
// utilities.
}
void AssertOKErrorStatusOr() {
ASSERT_OK(StatusOr<int>(base::unexpected(Status(error::INTERNAL, ""))));
}
TEST(StatusMacros, AssertOKOnStatusOr) {
// The assertion failure in AssertOKErrorStatusOr will generate a stack trace.
// This is desirable for the normal case, where the trace can help the
// developer understand the failure. In this test, however, the failure is
// expected and its output is swallowed. Suppress generation of stack traces
// so that the cost of generating them does not lead to flaky timeouts in
// configurations where the collection and emission of stack traces is
// expensive (e.g., in debug builds).
base::debug::OverrideStackTraceOutputForTesting suppress_stacks(
base::debug::OverrideStackTraceOutputForTesting::Mode::kSuppressOutput);
StatusOr<int> status_or(2);
ASSERT_OK(status_or);
ASSERT_OK(status_or) << "error message";
// rvalue
ASSERT_OK(StatusOr<int>(2));
EXPECT_FATAL_FAILURE(AssertOKErrorStatusOr(), "error::INTERNAL");
}
void ExpectOKErrorStatusOr() {
EXPECT_OK(StatusOr<int>(base::unexpected(Status(error::INTERNAL, ""))));
}
TEST(StatusMacros, ExpectOKOnStatusOr) {
// The assertion failure in ExpectOKErrorStatusOr will generate a stack trace.
// This is desirable for the normal case, where the trace can help the
// developer understand the failure. In this test, however, the failure is
// expected and its output is swallowed. Suppress generation of stack traces
// so that the cost of generating them does not lead to flaky timeouts in
// configurations where the collection and emission of stack traces is
// expensive (e.g., in debug builds).
base::debug::OverrideStackTraceOutputForTesting suppress_stacks(
base::debug::OverrideStackTraceOutputForTesting::Mode::kSuppressOutput);
StatusOr<int> status_or(2);
EXPECT_OK(status_or);
EXPECT_OK(status_or) << "error message";
// rvalue
EXPECT_OK(StatusOr<int>(2));
EXPECT_NONFATAL_FAILURE(ExpectOKErrorStatusOr(), "error::INTERNAL");
}
} // namespace
} // namespace reporting
|
