1 // Copyright 2023 The Pigweed Authors
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License"); you may not
4 // use this file except in compliance with the License. You may obtain a copy of
5 // the License at
6 //
7 // https://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, WITHOUT
11 // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12 // License for the specific language governing permissions and limitations under
13 // the License.
14
15 #include "pw_trace_tokenized/trace_service_pwpb.h"
16
17 #include "pw_chrono/system_clock.h"
18 #include "pw_rpc/pwpb/test_method_context.h"
19 #include "pw_stream/memory_stream.h"
20 #include "pw_trace/trace.h"
21 #include "pw_trace_tokenized/trace_tokenized.h"
22 #include "pw_unit_test/framework.h"
23
24 namespace pw::trace {
25
26 class TraceServiceTest : public ::testing::Test {
27 public:
TraceServiceTest()28 TraceServiceTest() {}
29
30 static constexpr uint32_t kTraceTransferHandlerId = 7;
31 };
32
TEST_F(TraceServiceTest,Start)33 TEST_F(TraceServiceTest, Start) {
34 auto& tracer = trace::GetTokenizedTracer();
35
36 std::array<std::byte, PW_TRACE_BUFFER_SIZE_BYTES> dest_buffer;
37 stream::MemoryWriter writer(dest_buffer);
38 PW_PWPB_TEST_METHOD_CONTEXT(TraceService, Start)
39 context(tracer, writer);
40
41 ASSERT_FALSE(tracer.IsEnabled());
42 ASSERT_EQ(context.call({}), OkStatus());
43 ASSERT_TRUE(tracer.IsEnabled());
44
45 // multiple calls to start are disallowed
46 ASSERT_EQ(context.call({}), Status::FailedPrecondition());
47 }
48
TEST_F(TraceServiceTest,Stop)49 TEST_F(TraceServiceTest, Stop) {
50 auto& tracer = trace::GetTokenizedTracer();
51
52 std::array<std::byte, PW_TRACE_BUFFER_SIZE_BYTES> dest_buffer;
53 stream::MemoryWriter writer(dest_buffer);
54 PW_PWPB_TEST_METHOD_CONTEXT(TraceService, Stop)
55 context(tracer, writer);
56 context.service().SetTransferId(kTraceTransferHandlerId);
57
58 tracer.Enable(true);
59 PW_TRACE_INSTANT("TestTrace");
60
61 ASSERT_EQ(context.call({}), OkStatus());
62 ASSERT_FALSE(tracer.IsEnabled());
63 EXPECT_EQ(kTraceTransferHandlerId, context.response().file_id);
64 EXPECT_LT(0u, writer.bytes_written());
65 }
66
TEST_F(TraceServiceTest,StopNoTransferHandlerId)67 TEST_F(TraceServiceTest, StopNoTransferHandlerId) {
68 auto& tracer = trace::GetTokenizedTracer();
69
70 std::array<std::byte, PW_TRACE_BUFFER_SIZE_BYTES> dest_buffer;
71 stream::MemoryWriter writer(dest_buffer);
72 PW_PWPB_TEST_METHOD_CONTEXT(TraceService, Stop)
73 context(tracer, writer);
74
75 tracer.Enable(true);
76 PW_TRACE_INSTANT("TestTrace");
77
78 ASSERT_EQ(context.call({}), OkStatus());
79 ASSERT_FALSE(tracer.IsEnabled());
80 EXPECT_FALSE(context.response().file_id.has_value());
81 EXPECT_LT(0u, writer.bytes_written());
82 }
83
TEST_F(TraceServiceTest,StopNotStarted)84 TEST_F(TraceServiceTest, StopNotStarted) {
85 auto& tracer = trace::GetTokenizedTracer();
86
87 std::array<std::byte, PW_TRACE_BUFFER_SIZE_BYTES> dest_buffer;
88 stream::MemoryWriter writer(dest_buffer);
89 PW_PWPB_TEST_METHOD_CONTEXT(TraceService, Stop)
90 context(tracer, writer);
91
92 // stopping while tracing is disabled results in FailedPrecondition
93 ASSERT_EQ(context.call({}), Status::FailedPrecondition());
94 }
95
TEST_F(TraceServiceTest,StopNoData)96 TEST_F(TraceServiceTest, StopNoData) {
97 auto& tracer = trace::GetTokenizedTracer();
98
99 std::array<std::byte, PW_TRACE_BUFFER_SIZE_BYTES> dest_buffer;
100 stream::MemoryWriter writer(dest_buffer);
101 PW_PWPB_TEST_METHOD_CONTEXT(TraceService, Stop)
102 context(tracer, writer);
103
104 tracer.Enable(true);
105
106 // stopping with no trace data results in Unavailable
107 ASSERT_EQ(context.call({}), Status::Unavailable());
108 }
109
TEST_F(TraceServiceTest,GetClockParameters)110 TEST_F(TraceServiceTest, GetClockParameters) {
111 auto& tracer = trace::GetTokenizedTracer();
112
113 std::array<std::byte, PW_TRACE_BUFFER_SIZE_BYTES> dest_buffer;
114 stream::MemoryWriter writer(dest_buffer);
115
116 PW_PWPB_TEST_METHOD_CONTEXT(TraceService, GetClockParameters)
117 context(tracer, writer);
118
119 ASSERT_EQ(context.call({}), OkStatus());
120 EXPECT_EQ(
121 static_cast<int32_t>(PW_CHRONO_SYSTEM_CLOCK_PERIOD_SECONDS_NUMERATOR),
122 context.response().clock_parameters.tick_period_seconds_numerator);
123 EXPECT_EQ(
124 static_cast<int32_t>(PW_CHRONO_SYSTEM_CLOCK_PERIOD_SECONDS_DENOMINATOR),
125 context.response().clock_parameters.tick_period_seconds_denominator);
126 EXPECT_EQ(
127 static_cast<int32_t>(chrono::SystemClock::epoch),
128 static_cast<int32_t>(*context.response().clock_parameters.epoch_type));
129 }
130
131 } // namespace pw::trace
132