1 // Copyright 2024 The gRPC Authors
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 #include <grpc/grpc.h>
16
17 #include "absl/strings/match.h"
18 #include "gtest/gtest.h"
19 #include "src/core/lib/debug/trace.h"
20 #include "test/core/test_util/test_config.h"
21
22 class TraceFlags : public ::testing::Test {
23 public:
TraceFlags()24 TraceFlags() {}
~TraceFlags()25 ~TraceFlags() override { saved_flags_.Restore(); }
26
27 private:
28 grpc_core::SavedTraceFlags saved_flags_;
29 };
30
TEST_F(TraceFlags,ReturnsFalseWhenNotFound)31 TEST_F(TraceFlags, ReturnsFalseWhenNotFound) {
32 ASSERT_FALSE(grpc_core::ParseTracers("arst"));
33 }
34
TEST_F(TraceFlags,CanSetAValue)35 TEST_F(TraceFlags, CanSetAValue) {
36 auto it = grpc_core::GetAllTraceFlags().find("api");
37 ASSERT_NE(it, grpc_core::GetAllTraceFlags().end());
38 EXPECT_TRUE(grpc_core::ParseTracers("api"));
39 EXPECT_TRUE(it->second->enabled());
40 EXPECT_TRUE(grpc_core::ParseTracers("-api"));
41 EXPECT_FALSE(it->second->enabled());
42 }
43
TEST_F(TraceFlags,SpecialRefcountFlagWorks)44 TEST_F(TraceFlags, SpecialRefcountFlagWorks) {
45 for (const auto& flag : grpc_core::GetAllTraceFlags()) {
46 if (absl::StrContains(flag.first, "refcount")) {
47 EXPECT_FALSE(flag.second->enabled());
48 }
49 }
50 EXPECT_TRUE(grpc_core::ParseTracers("refcount"));
51 for (const auto& flag : grpc_core::GetAllTraceFlags()) {
52 if (absl::StrContains(flag.first, "refcount")) {
53 EXPECT_TRUE(flag.second->enabled());
54 }
55 }
56 }
57
TEST_F(TraceFlags,SpecialAllFlagWorks)58 TEST_F(TraceFlags, SpecialAllFlagWorks) {
59 // Snapshot the trace flag state at the beginning
60 EXPECT_TRUE(grpc_core::ParseTracers("all"));
61 for (const auto& flag : grpc_core::GetAllTraceFlags()) {
62 EXPECT_TRUE(flag.second->enabled()) << flag.first << " was not enabled.";
63 }
64 EXPECT_TRUE(grpc_core::ParseTracers("-all"));
65 for (const auto& flag : grpc_core::GetAllTraceFlags()) {
66 EXPECT_FALSE(flag.second->enabled())
67 << flag.first << " was still enabled after turning all flags off.";
68 }
69 }
70
TEST_F(TraceFlags,GlobStarAllWorks)71 TEST_F(TraceFlags, GlobStarAllWorks) {
72 // Snapshot the trace flag state at the beginning
73 EXPECT_TRUE(grpc_core::ParseTracers("*"));
74 for (const auto& flag : grpc_core::GetAllTraceFlags()) {
75 EXPECT_TRUE(flag.second->enabled()) << flag.first << " was not enabled.";
76 }
77 EXPECT_TRUE(grpc_core::ParseTracers("-*"));
78 for (const auto& flag : grpc_core::GetAllTraceFlags()) {
79 EXPECT_FALSE(flag.second->enabled())
80 << flag.first << " was still enabled after turning all flags off.";
81 }
82 }
83
TEST_F(TraceFlags,SaveAndRestoreWorks)84 TEST_F(TraceFlags, SaveAndRestoreWorks) {
85 auto it = grpc_core::GetAllTraceFlags().find("api");
86 ASSERT_NE(it, grpc_core::GetAllTraceFlags().end());
87 EXPECT_FALSE(it->second->enabled());
88 grpc_core::SavedTraceFlags saved_1;
89 EXPECT_TRUE(grpc_core::ParseTracers("all"));
90 EXPECT_TRUE(it->second->enabled());
91 saved_1.Restore();
92 EXPECT_FALSE(it->second->enabled());
93 }
94
TEST_F(TraceFlags,CApiStillWorks)95 TEST_F(TraceFlags, CApiStillWorks) {
96 auto it = grpc_core::GetAllTraceFlags().find("api");
97 ASSERT_NE(it, grpc_core::GetAllTraceFlags().end());
98 EXPECT_FALSE(it->second->enabled());
99 EXPECT_TRUE(grpc_tracer_set_enabled("all", true));
100 EXPECT_TRUE(it->second->enabled());
101 EXPECT_TRUE(grpc_tracer_set_enabled("all", false));
102 EXPECT_FALSE(it->second->enabled());
103 }
104
main(int argc,char ** argv)105 int main(int argc, char** argv) {
106 grpc::testing::TestEnvironment env(&argc, argv);
107 ::testing::InitGoogleTest(&argc, argv);
108 grpc_init();
109 auto res = RUN_ALL_TESTS();
110 grpc_shutdown();
111 return res;
112 }
113