aboutsummaryrefslogtreecommitdiff
path: root/pw_trace_tokenized/trace_service_pwpb_test.cc
blob: 00821019368813cfef0e024b0fe93e7fc24027a4 (plain)
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
// Copyright 2023 The Pigweed Authors
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.

#include "pw_trace_tokenized/trace_service_pwpb.h"

#include "gtest/gtest.h"
#include "pw_chrono/system_clock.h"
#include "pw_rpc/pwpb/test_method_context.h"
#include "pw_stream/memory_stream.h"
#include "pw_trace/trace.h"
#include "pw_trace_tokenized/trace_tokenized.h"

namespace pw::trace {

class TraceServiceTest : public ::testing::Test {
 public:
  TraceServiceTest() {}

  static constexpr uint32_t kTraceTransferHandlerId = 7;
};

TEST_F(TraceServiceTest, Start) {
  auto& tracer = trace::GetTokenizedTracer();

  std::array<std::byte, PW_TRACE_BUFFER_SIZE_BYTES> dest_buffer;
  stream::MemoryWriter writer(dest_buffer);
  PW_PWPB_TEST_METHOD_CONTEXT(TraceService, Start)
  context(tracer, writer);

  ASSERT_FALSE(tracer.IsEnabled());
  ASSERT_EQ(context.call({}), OkStatus());
  ASSERT_TRUE(tracer.IsEnabled());

  // multiple calls to start are disallowed
  ASSERT_EQ(context.call({}), Status::FailedPrecondition());
}

TEST_F(TraceServiceTest, Stop) {
  auto& tracer = trace::GetTokenizedTracer();

  std::array<std::byte, PW_TRACE_BUFFER_SIZE_BYTES> dest_buffer;
  stream::MemoryWriter writer(dest_buffer);
  PW_PWPB_TEST_METHOD_CONTEXT(TraceService, Stop)
  context(tracer, writer);
  context.service().SetTransferId(kTraceTransferHandlerId);

  tracer.Enable(true);
  PW_TRACE_INSTANT("TestTrace");

  ASSERT_EQ(context.call({}), OkStatus());
  ASSERT_FALSE(tracer.IsEnabled());
  EXPECT_EQ(kTraceTransferHandlerId, context.response().file_id);
  EXPECT_LT(0u, writer.bytes_written());
}

TEST_F(TraceServiceTest, StopNoTransferHandlerId) {
  auto& tracer = trace::GetTokenizedTracer();

  std::array<std::byte, PW_TRACE_BUFFER_SIZE_BYTES> dest_buffer;
  stream::MemoryWriter writer(dest_buffer);
  PW_PWPB_TEST_METHOD_CONTEXT(TraceService, Stop)
  context(tracer, writer);

  tracer.Enable(true);
  PW_TRACE_INSTANT("TestTrace");

  ASSERT_EQ(context.call({}), OkStatus());
  ASSERT_FALSE(tracer.IsEnabled());
  EXPECT_FALSE(context.response().file_id.has_value());
  EXPECT_LT(0u, writer.bytes_written());
}

TEST_F(TraceServiceTest, StopNotStarted) {
  auto& tracer = trace::GetTokenizedTracer();

  std::array<std::byte, PW_TRACE_BUFFER_SIZE_BYTES> dest_buffer;
  stream::MemoryWriter writer(dest_buffer);
  PW_PWPB_TEST_METHOD_CONTEXT(TraceService, Stop)
  context(tracer, writer);

  // stopping while tracing is disabled results in FailedPrecondition
  ASSERT_EQ(context.call({}), Status::FailedPrecondition());
}

TEST_F(TraceServiceTest, StopNoData) {
  auto& tracer = trace::GetTokenizedTracer();

  std::array<std::byte, PW_TRACE_BUFFER_SIZE_BYTES> dest_buffer;
  stream::MemoryWriter writer(dest_buffer);
  PW_PWPB_TEST_METHOD_CONTEXT(TraceService, Stop)
  context(tracer, writer);

  tracer.Enable(true);

  // stopping with no trace data results in Unavailable
  ASSERT_EQ(context.call({}), Status::Unavailable());
}

TEST_F(TraceServiceTest, GetClockParameters) {
  auto& tracer = trace::GetTokenizedTracer();

  std::array<std::byte, PW_TRACE_BUFFER_SIZE_BYTES> dest_buffer;
  stream::MemoryWriter writer(dest_buffer);

  PW_PWPB_TEST_METHOD_CONTEXT(TraceService, GetClockParameters)
  context(tracer, writer);

  ASSERT_EQ(context.call({}), OkStatus());
  EXPECT_EQ(PW_CHRONO_SYSTEM_CLOCK_PERIOD_SECONDS_NUMERATOR,
            context.response().clock_parameters.tick_period_seconds_numerator);
  EXPECT_EQ(
      PW_CHRONO_SYSTEM_CLOCK_PERIOD_SECONDS_DENOMINATOR,
      context.response().clock_parameters.tick_period_seconds_denominator);
  EXPECT_EQ(
      static_cast<int32_t>(chrono::SystemClock::epoch),
      static_cast<int32_t>(*context.response().clock_parameters.epoch_type));
}

}  // namespace pw::trace