runtime_probe/utils/function_test_utils.h

// Copyright 2022 The ChromiumOS Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef RUNTIME_PROBE_UTILS_FUNCTION_TEST_UTILS_H_
#define RUNTIME_PROBE_UTILS_FUNCTION_TEST_UTILS_H_

#include <memory>
#include <string>
#include <utility>

#include <base/test/task_environment.h>
#include <base/test/test_future.h>
#include <base/values.h>

#include "runtime_probe/probe_function.h"
#include "runtime_probe/system/context_mock_impl.h"
#include "runtime_probe/utils/file_test_utils.h"

namespace runtime_probe {

// A helper class for creating probe function related unittest.
class BaseFunctionTest : public BaseFileTest {
 protected:
  BaseFunctionTest();
  BaseFunctionTest(const BaseFunctionTest&) = delete;
  BaseFunctionTest& operator=(const BaseFunctionTest&) = delete;
  ~BaseFunctionTest();

 protected:
  // Helper function to create the expected probe result form a json string.
  static base::ListValue CreateProbeResultFromJson(const std::string& str);

  // Helper function to make an assertion that |result| is equal to some
  // permutation of |ans|.Use this function for indeterminate order results.
  static void ExpectUnorderedListEqual(const base::ListValue& result,
                                       const base::ListValue& ans);

  ContextMockImpl* mock_context() { return &mock_context_; }

 private:
  base::test::SingleThreadTaskEnvironment task_environment_;
  ::testing::NiceMock<ContextMockImpl> mock_context_;
};

// A fake probe function that always returns |probe_result|.
class FakeProbeFunction : public ProbeFunction {
 public:
  explicit FakeProbeFunction(const std::string& probe_result);
  FakeProbeFunction(FakeProbeFunction&) = delete;
  FakeProbeFunction& operator=(FakeProbeFunction&) = delete;
  ~FakeProbeFunction() override;

  NAME_PROBE_FUNCTION("fake");

 private:
  DataType EvalImpl() const override;

  DataType fake_result_;
};

// Get the result that the callback receives.
ProbeFunction::DataType EvalProbeFunction(ProbeFunction* probe_function);

}  // namespace runtime_probe

#endif  // RUNTIME_PROBE_UTILS_FUNCTION_TEST_UTILS_H_