Documentation for tracelibcpp
[ric-plt/tracelibcpp.git] / tst / testcreate.cpp
1 /*
2  * Copyright (c) 2019 AT&T Intellectual Property.
3  * Copyright (c) 2018-2019 Nokia.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  *     http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  * This source code is part of the near-RT RIC (RAN Intelligent Controller)
18  * platform project (RICP).
19  */
20
21 #include <gtest/gtest.h>
22 #include <gmock/gmock.h>
23
24 #include "tracelibcpp.hpp"
25 #include "config.hpp"
26
27 using namespace testing;
28 using namespace tracelibcpp;
29
30 class ConfMakerTest: public ::testing::Test
31 {
32 public:
33     ConfMaker cm;
34     ConfMakerTest():
35         cm(ConfMaker("testservice"))
36     {
37     }
38     ~ConfMakerTest()
39     {
40         unsetenv(JAEGER_SAMPLER_TYPE_ENV);
41         unsetenv(TRACING_ENABLED_ENV);
42         unsetenv(JAEGER_SAMPLER_PARAM_ENV);
43         unsetenv(JAEGER_AGENT_ADDR_ENV);
44         unsetenv(JAEGER_LOG_LEVEL_ENV);
45     }
46 };
47
48 TEST_F(ConfMakerTest, TestEnvReadingNonExisingReturnsDefaultValue)
49 {
50     EXPECT_THAT("foobar", StrEq(cm.getEnv("nonexistent", "foobar")));
51 }
52
53 TEST_F(ConfMakerTest, TestEnvReadingReturnsEnvironmentValValue)
54 {
55     setenv("FOO", "BAR", 1);
56     auto val = cm.getEnv("FOO", "foobar");
57     unsetenv("FOO");
58     EXPECT_THAT("BAR", StrEq(val));
59 }
60
61 TEST_F(ConfMakerTest, TestTracingIsDisabledByDefault)
62 {
63     EXPECT_FALSE(cm.isTracingEnabled());
64 }
65
66 TEST_F(ConfMakerTest, TestTracingCanBeEnabledWithEnvValTrue)
67 {
68     setenv(TRACING_ENABLED_ENV, "true", 1);
69     EXPECT_TRUE(cm.isTracingEnabled());
70     setenv(TRACING_ENABLED_ENV, "TRUE", 1);
71     EXPECT_TRUE(cm.isTracingEnabled());
72 }
73
74 TEST_F(ConfMakerTest, TestTracingCanBeEnabledWithEnvValOne)
75 {
76     setenv(TRACING_ENABLED_ENV, "1", 1);
77     EXPECT_TRUE(cm.isTracingEnabled());
78 }
79
80 TEST_F(ConfMakerTest, TestTracingEnabledWithUnknownValuesResultsDisabled)
81 {
82     setenv(TRACING_ENABLED_ENV, "0", 1);
83     EXPECT_FALSE(cm.isTracingEnabled());
84     setenv(TRACING_ENABLED_ENV, "off", 1);
85     EXPECT_FALSE(cm.isTracingEnabled());
86 }
87
88 TEST_F(ConfMakerTest, TestThatByDefaultConstSamplerIsCreated)
89 {
90     auto samplerconf = cm.getSamplerConfig();
91     EXPECT_THAT("const", StrEq(samplerconf.type()));
92     EXPECT_EQ(0.001, samplerconf.param());
93 }
94
95 TEST_F(ConfMakerTest, TestThatSamplerTypeCanBeDefined)
96 {
97     setenv(JAEGER_SAMPLER_TYPE_ENV, "probabilistic", 1);
98     auto samplerconf = cm.getSamplerConfig();
99     EXPECT_THAT("probabilistic", StrEq(samplerconf.type()));
100     EXPECT_EQ(0.001, samplerconf.param());
101 }
102
103 TEST_F(ConfMakerTest, TestThatSamplerParamCanBeDefined)
104 {
105     setenv(JAEGER_SAMPLER_PARAM_ENV, "0.01", 1);
106     setenv(JAEGER_SAMPLER_TYPE_ENV, "probabilistic", 1);
107     auto samplerconf = cm.getSamplerConfig();
108     EXPECT_EQ(0.01, samplerconf.param());
109 }
110
111 TEST_F(ConfMakerTest, TestThatReporterAgentAddrDefaultsToLocalhost)
112 {
113     auto reporterConf = cm.getReporterConfig();
114     EXPECT_THAT(reporterConf.localAgentHostPort(), StrEq("127.0.0.1:6831"));
115 }
116
117 TEST_F(ConfMakerTest, TestThatReporterAgentAddrCanBeDefined)
118 {
119     setenv(JAEGER_AGENT_ADDR_ENV, "1.1.1.1:1111", 1);
120     auto reporterConf = cm.getReporterConfig();
121     EXPECT_THAT(reporterConf.localAgentHostPort(), StrEq("1.1.1.1:1111"));
122 }
123
124 TEST_F(ConfMakerTest, TestThatIfAgentPortIsNotGivenDefaultIsUsed)
125 {
126     setenv(JAEGER_AGENT_ADDR_ENV, "1.1.1.1", 1);
127     auto reporterConf = cm.getReporterConfig();
128     EXPECT_THAT(reporterConf.localAgentHostPort(), StrEq("1.1.1.1:6831"));
129 }
130
131 TEST_F(ConfMakerTest, TestThatLoggingDefaultIsErr)
132 {
133     EXPECT_EQ(LOG_ERR, cm.getLoggingLevel());
134 }
135
136 TEST_F(ConfMakerTest, TestThatLoggingLevelCanBeConfigured)
137 {
138     setenv(JAEGER_LOG_LEVEL_ENV, "all", 1);
139     EXPECT_EQ(LOG_ALL, cm.getLoggingLevel());
140
141     setenv(JAEGER_LOG_LEVEL_ENV, "error", 1);
142     EXPECT_EQ(LOG_ERR, cm.getLoggingLevel());
143
144     setenv(JAEGER_LOG_LEVEL_ENV, "none", 1);
145     EXPECT_EQ(LOG_NONE, cm.getLoggingLevel());
146 }
147
148 TEST_F(ConfMakerTest, TestThatByDefaultDisabledConfigIsCreated)
149 {
150     auto conf = cm.getTraceConfig();
151     EXPECT_TRUE(conf.disabled());
152 }
153
154 TEST_F(ConfMakerTest, TestThatIfTracerCreationFailsNoopTracerIsReturned)
155 {
156     setenv(TRACING_ENABLED_ENV, "1", 1);
157     setenv(JAEGER_AGENT_ADDR_ENV, "foobar.invalid", 1); // invalid address causes an exception
158     auto tracer = createTracer("foo");
159     EXPECT_THAT(tracer, NotNull());
160 }
161
162 TEST(CreateTest, TestThatTraceCreateReturnsANewInstance) {
163     auto tracer = createTracer("foo");
164     EXPECT_THAT(tracer, NotNull());
165 }
166