1 // Copyright 2023 The Chromium Authors 2 // Use of this source code is governed by a BSD-style license that can be 3 // found in the LICENSE file. 4 5 // Use TestTraceProcessor to load a perfetto trace and run queries on the trace. 6 // Documentation on how to use the trace processor and write queries can be 7 // found here: https://perfetto.dev/docs/analysis/trace-processor. 8 // TODO(b/224531105): Implement EXTRACT_ARGS to return multiple args to simplify 9 // queries. 10 11 #ifndef BASE_TEST_TEST_TRACE_PROCESSOR_H_ 12 #define BASE_TEST_TEST_TRACE_PROCESSOR_H_ 13 14 #include "base/test/test_trace_processor_impl.h" 15 #include "base/test/trace_test_utils.h" 16 #include "base/types/expected.h" 17 #include "build/build_config.h" 18 19 #if BUILDFLAG(USE_PERFETTO_CLIENT_LIBRARY) && !BUILDFLAG(IS_WIN) 20 #define TEST_TRACE_PROCESSOR_ENABLED 21 #endif 22 23 namespace base::test { 24 25 #if BUILDFLAG(USE_PERFETTO_CLIENT_LIBRARY) 26 27 using perfetto::protos::gen::TraceConfig; 28 29 TraceConfig DefaultTraceConfig(const StringPiece& category_filter_string, 30 bool privacy_filtering); 31 32 // Use TestTraceProcessor to record Perfetto traces in unit and browser tests. 33 // This API can be used to start and stop traces, run SQL queries on the trace 34 // and write expectations against the query result. 35 // 36 // Example: 37 // 38 // TestTraceProcessor test_trace_processor; 39 // test_trace_processor.StartTrace(); 40 // 41 // /* do stuff */ 42 // 43 // absl::Status status = test_trace_processor.StopAndParseTrace(); 44 // ASSERT_TRUE(status.ok()) << status.message(); 45 // 46 // std::string query = "YOUR QUERY"; 47 // auto result = test_trace_processor.RunQuery(query); 48 // 49 // ASSERT_TRUE(result.has_value()) << result.message(); 50 // EXPECT_THAT(result.value(), /* your expectations */); 51 52 class TestTraceProcessor { 53 public: 54 using QueryResult = std::vector<std::vector<std::string>>; 55 56 TestTraceProcessor(); 57 ~TestTraceProcessor(); 58 59 void StartTrace(const StringPiece& category_filter_string, 60 bool privacy_filtering = false); 61 void StartTrace( 62 const TraceConfig& config, 63 perfetto::BackendType backend = perfetto::kUnspecifiedBackend); 64 65 absl::Status StopAndParseTrace(); 66 67 base::expected<QueryResult, std::string> RunQuery(const std::string& query); 68 69 private: 70 TestTraceProcessorImpl test_trace_processor_; 71 std::unique_ptr<perfetto::TracingSession> session_; 72 }; 73 74 #endif // BUILDFLAG(USE_PERFETTO_CLIENT_LIBRARY) 75 76 } // namespace base::test 77 78 #endif // BASE_TEST_TEST_TRACE_PROCESSOR_H_ 79