blob: 3e038e35559ef849325cdcc1a922618214609b23 [file] [log] [blame]
// Copyright 2018 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef NET_TEST_TEST_WITH_TASK_ENVIRONMENT_H_
#define NET_TEST_TEST_WITH_TASK_ENVIRONMENT_H_
#include "base/test/task_environment.h"
#include "base/time/time.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace base {
class TickClock;
} // namespace base
namespace net {
// Inherit from this class if a TaskEnvironment is needed in a test.
// Use in class hierachies where inheritance from ::testing::Test at the same
// time is not desirable or possible (for example, when inheriting from
// PlatformTest at the same time).
class WithTaskEnvironment {
public:
WithTaskEnvironment(const WithTaskEnvironment&) = delete;
WithTaskEnvironment& operator=(const WithTaskEnvironment&) = delete;
protected:
// Always uses MainThreadType::IO, |time_source| may optionally be provided
// to mock time.
explicit WithTaskEnvironment(
base::test::TaskEnvironment::TimeSource time_source =
base::test::TaskEnvironment::TimeSource::DEFAULT)
: task_environment_(base::test::TaskEnvironment::MainThreadType::IO,
time_source) {}
[[nodiscard]] bool MainThreadIsIdle() const {
return task_environment_.MainThreadIsIdle();
}
void RunUntilIdle() { task_environment_.RunUntilIdle(); }
void FastForwardBy(base::TimeDelta delta) {
task_environment_.FastForwardBy(delta);
}
void FastForwardUntilNoTasksRemain() {
task_environment_.FastForwardUntilNoTasksRemain();
}
// Only valid for instances using TimeSource::MOCK_TIME.
void AdvanceClock(base::TimeDelta delta) {
task_environment_.AdvanceClock(delta);
}
[[nodiscard]] const base::TickClock* GetMockTickClock() {
return task_environment_.GetMockTickClock();
}
[[nodiscard]] size_t GetPendingMainThreadTaskCount() const {
return task_environment_.GetPendingMainThreadTaskCount();
}
[[nodiscard]] base::TimeDelta NextMainThreadPendingTaskDelay() const {
return task_environment_.NextMainThreadPendingTaskDelay();
}
private:
base::test::TaskEnvironment task_environment_;
};
// Inherit from this class instead of ::testing::Test directly if a
// TaskEnvironment is needed in a test.
class TestWithTaskEnvironment : public ::testing::Test,
public WithTaskEnvironment {
public:
TestWithTaskEnvironment(const TestWithTaskEnvironment&) = delete;
TestWithTaskEnvironment& operator=(const TestWithTaskEnvironment&) = delete;
protected:
using WithTaskEnvironment::WithTaskEnvironment;
};
} // namespace net
#endif // NET_TEST_TEST_WITH_TASK_ENVIRONMENT_H_