perfetto: refactor test code to consolidate pattern
With several types of testing now present, a clear pattern has been
established in how test code for end to end tests should be written.
This pattern involves spinning up service and producer, setting up a
test-specific trace config and then defining an intricate set of
checkpoints and RunUntilCheckpoint calls.
All of this code is duplicated and this will only get worse as we add
more benchmarks and tests to the codebase. Moreover, the
complex-appearance of the code hides the true simplicity within.
Refactor all the duplicated code into a helper file and call the
functions in this class from the four other cases where they are used
(integration test, fuzzer, benchmark and CTS).
Bug: 74380167
Change-Id: I261636b3da15b16f063e6a5dc6c293080b8ff4ac
diff --git a/test/test_helper.h b/test/test_helper.h
new file mode 100644
index 0000000..87a9be5
--- /dev/null
+++ b/test/test_helper.h
@@ -0,0 +1,66 @@
+/*
+ * Copyright (C) 2018 The Android Open Source Project
+ *
+ * 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
+ *
+ * http://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.
+ */
+
+#ifndef TEST_TEST_HELPER_H_
+#define TEST_TEST_HELPER_H_
+
+#include "perfetto/tracing/core/consumer.h"
+#include "perfetto/tracing/core/trace_config.h"
+#include "perfetto/tracing/core/trace_packet.h"
+#include "perfetto/tracing/ipc/consumer_ipc_client.h"
+#include "src/base/test/test_task_runner.h"
+#include "test/fake_producer.h"
+#include "test/task_runner_thread.h"
+
+namespace perfetto {
+
+class TestHelper : public Consumer {
+ public:
+ explicit TestHelper(base::TestTaskRunner* task_runner);
+
+ // Consumer implementation.
+ void OnConnect() override;
+ void OnDisconnect() override;
+ void OnTracingStop() override;
+ void OnTraceData(std::vector<TracePacket> packets, bool has_more) override;
+
+ void StartServiceIfRequired();
+ FakeProducer* ConnectFakeProducer();
+ void ConnectConsumer();
+ void StartTracing(const TraceConfig& config);
+ void ReadData(std::function<void(const TracePacket::DecodedTracePacket&)>
+ packet_callback,
+ std::function<void()> on_finish_callback);
+
+ std::function<void()> WrapTask(const std::function<void()>& function);
+
+ TaskRunnerThread* service_thread() { return &service_thread_; }
+ TaskRunnerThread* producer_thread() { return &producer_thread_; }
+
+ private:
+ base::TestTaskRunner* task_runner_ = nullptr;
+
+ std::function<void(const TracePacket::DecodedTracePacket&)> packet_callback_;
+ std::function<void()> continuation_callack_;
+
+ TaskRunnerThread service_thread_;
+ TaskRunnerThread producer_thread_;
+ std::unique_ptr<Service::ConsumerEndpoint> endpoint_; // Keep last.
+};
+
+} // namespace perfetto
+
+#endif // TEST_TEST_HELPER_H_