#include <stdint.h>
#include "base/memory/raw_ptr.h"
#include "base/run_loop.h"
#include "base/task/sequenced_task_runner.h"
#include "base/task/single_thread_task_runner.h"
#include "base/test/bind.h"
#include "base/test/power_monitor_test.h"
#include "base/test/scoped_feature_list.h"
#include "base/test/task_environment.h"
#include "base/test/test_mock_time_task_runner.h"
#include "base/time/time.h"
#include "build/build_config.h"
#include "cc/metrics/frame_sequence_tracker.h"
#include "components/viz/common/surfaces/parent_local_surface_id_allocator.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "ui/base/ui_base_features.h"
#if defined(OHOS_UNITTESTS)
#define private public
#endif
#include "ui/compositor/compositor.h"
#if defined(OHOS_UNITTESTS)
#undef private
#include "cc/test/fake_layer_tree_frame_sink.h"
#endif
#include "ui/compositor/layer.h"
#include "ui/compositor/layer_delegate.h"
#include "ui/compositor/test/draw_waiter_for_test.h"
#include "ui/compositor/test/in_process_context_factory.h"
#include "ui/compositor/test/test_context_factories.h"
using testing::_;
using testing::Mock;
namespace ui {
namespace {
class CompositorTest : public testing::Test {
public:
CompositorTest() = default;
CompositorTest(const CompositorTest&) = delete;
CompositorTest& operator=(const CompositorTest&) = delete;
~CompositorTest() override = default;
void CreateCompositor() {
compositor_ = std::make_unique<Compositor>(
context_factories_->GetContextFactory()->AllocateFrameSinkId(),
context_factories_->GetContextFactory(), CreateTaskRunner(),
false );
compositor_->SetAcceleratedWidget(gfx::kNullAcceleratedWidget);
}
void SetUp() override {
context_factories_ = std::make_unique<TestContextFactories>(false);
CreateCompositor();
}
void TearDown() override {
compositor_.reset();
context_factories_.reset();
}
void DestroyCompositor() { compositor_.reset(); }
protected:
virtual scoped_refptr<base::SingleThreadTaskRunner> CreateTaskRunner() = 0;
Compositor* compositor() { return compositor_.get(); }
private:
std::unique_ptr<TestContextFactories> context_factories_;
std::unique_ptr<Compositor> compositor_;
};
class CompositorTestWithMockedTime : public CompositorTest {
protected:
scoped_refptr<base::SingleThreadTaskRunner> CreateTaskRunner() override {
task_runner_ = new base::TestMockTimeTaskRunner;
return task_runner_;
}
base::TestMockTimeTaskRunner* task_runner() { return task_runner_.get(); }
protected:
void AdvanceBy(base::TimeDelta delta) {
task_environment_.AdvanceClock(delta);
}
scoped_refptr<base::TestMockTimeTaskRunner> task_runner_;
base::test::ScopedPowerMonitorTestSource test_power_monitor_source_;
private:
#if defined(OHOS_UNITTESTS)
base::test::TaskEnvironment task_environment_{};
#else
base::test::TaskEnvironment task_environment_{
base::test::TaskEnvironment::MainThreadType::UI,
base::test::TaskEnvironment::TimeSource::MOCK_TIME};
#endif
};
class CompositorTestWithMessageLoop : public CompositorTest {
public:
#if defined(OHOS_UNITTESTS)
CompositorTestWithMessageLoop() : task_environment_() {}
#else
CompositorTestWithMessageLoop()
: task_environment_(base::test::TaskEnvironment::MainThreadType::UI) {}
#endif
~CompositorTestWithMessageLoop() override = default;
protected:
scoped_refptr<base::SingleThreadTaskRunner> CreateTaskRunner() override {
task_runner_ = base::SingleThreadTaskRunner::GetCurrentDefault();
return task_runner_;
}
base::SequencedTaskRunner* task_runner() { return task_runner_.get(); }
private:
#if defined(OHOS_UNITTESTS)
base::test::TaskEnvironment task_environment_{};
#else
base::test::TaskEnvironment task_environment_;
#endif
scoped_refptr<base::SingleThreadTaskRunner> task_runner_;
};
class TestCompositorAnimationObserver : public CompositorAnimationObserver {
public:
TestCompositorAnimationObserver() = default;
TestCompositorAnimationObserver(const TestCompositorAnimationObserver&) =
delete;
TestCompositorAnimationObserver& operator=(
const TestCompositorAnimationObserver&) = delete;
~TestCompositorAnimationObserver() override = default;
void OnAnimationStep(base::TimeTicks timestamp) override {}
void OnCompositingShuttingDown(Compositor* compositor) override {}
void NotifyFailure() override { failed_ = true; }
bool failed() const { return failed_; }
private:
bool failed_ = false;
};
}
TEST_F(CompositorTestWithMockedTime, AnimationObserverBasic) {
TestCompositorAnimationObserver test;
compositor()->AddAnimationObserver(&test);
test.Start();
test.Check();
AdvanceBy(base::Seconds(59));
EXPECT_FALSE(test.failed());
AdvanceBy(base::Seconds(2));
test.Check();
EXPECT_TRUE(test.failed());
compositor()->RemoveAnimationObserver(&test);
}
TEST_F(CompositorTestWithMockedTime, AnimationObserverResetAfterResume) {
TestCompositorAnimationObserver test;
compositor()->AddAnimationObserver(&test);
test.Start();
test.Check();
AdvanceBy(base::Seconds(59));
EXPECT_TRUE(test.is_active_for_test());
EXPECT_FALSE(test.failed());
test_power_monitor_source_.Suspend();
base::RunLoop().RunUntilIdle();
AdvanceBy(base::Seconds(32));
test_power_monitor_source_.Resume();
base::RunLoop().RunUntilIdle();
test.Check();
EXPECT_TRUE(test.is_active_for_test());
EXPECT_FALSE(test.failed());
AdvanceBy(base::Seconds(29));
test.Check();
EXPECT_TRUE(test.is_active_for_test());
EXPECT_FALSE(test.failed());
AdvanceBy(base::Seconds(32));
test.Check();
EXPECT_FALSE(test.is_active_for_test());
EXPECT_TRUE(test.failed());
test_power_monitor_source_.Suspend();
base::RunLoop().RunUntilIdle();
test_power_monitor_source_.Resume();
EXPECT_FALSE(test.is_active_for_test());
EXPECT_TRUE(test.failed());
compositor()->RemoveAnimationObserver(&test);
}
TEST_F(CompositorTestWithMessageLoop, ShouldUpdateDisplayProperties) {
auto root_layer = std::make_unique<Layer>(ui::LAYER_SOLID_COLOR);
viz::ParentLocalSurfaceIdAllocator allocator;
allocator.GenerateId();
root_layer->SetBounds(gfx::Rect(10, 10));
compositor()->SetRootLayer(root_layer.get());
compositor()->SetScaleAndSize(1.0f, gfx::Size(10, 10),
allocator.GetCurrentLocalSurfaceId());
ASSERT_TRUE(compositor()->IsVisible());
SkM44 color_matrix;
color_matrix.setRC(1, 1, 0.7f);
color_matrix.setRC(2, 2, 0.4f);
gfx::DisplayColorSpaces display_color_spaces(
gfx::ColorSpace::CreateDisplayP3D65());
display_color_spaces.SetSDRMaxLuminanceNits(1.f);
base::TimeTicks vsync_timebase(base::TimeTicks::Now());
base::TimeDelta vsync_interval(base::Milliseconds(250));
base::TimeDelta max_vrr_interval(base::Milliseconds(500));
compositor()->SetDisplayColorMatrix(color_matrix);
compositor()->SetDisplayColorSpaces(display_color_spaces);
compositor()->SetDisplayVSyncParameters(vsync_timebase, vsync_interval);
compositor()->SetMaxVrrInterval(max_vrr_interval);
InProcessContextFactory* context_factory =
static_cast<InProcessContextFactory*>(compositor()->context_factory());
compositor()->ScheduleDraw();
DrawWaiterForTest::WaitForCompositingEnded(compositor());
EXPECT_EQ(color_matrix, context_factory->GetOutputColorMatrix(compositor()));
EXPECT_EQ(display_color_spaces,
context_factory->GetDisplayColorSpaces(compositor()));
EXPECT_EQ(vsync_timebase,
context_factory->GetDisplayVSyncTimeBase(compositor()));
EXPECT_EQ(vsync_interval,
context_factory->GetDisplayVSyncTimeInterval(compositor()));
EXPECT_EQ(max_vrr_interval, context_factory->GetMaxVrrInterval(compositor()));
context_factory->ResetDisplayOutputParameters(compositor());
compositor()->SetVisible(false);
EXPECT_EQ(gfx::kNullAcceleratedWidget,
compositor()->ReleaseAcceleratedWidget());
compositor()->SetAcceleratedWidget(gfx::kNullAcceleratedWidget);
compositor()->SetVisible(true);
compositor()->ScheduleDraw();
DrawWaiterForTest::WaitForCompositingEnded(compositor());
EXPECT_EQ(color_matrix, context_factory->GetOutputColorMatrix(compositor()));
EXPECT_EQ(display_color_spaces,
context_factory->GetDisplayColorSpaces(compositor()));
EXPECT_EQ(vsync_timebase,
context_factory->GetDisplayVSyncTimeBase(compositor()));
EXPECT_EQ(vsync_interval,
context_factory->GetDisplayVSyncTimeInterval(compositor()));
EXPECT_EQ(max_vrr_interval, context_factory->GetMaxVrrInterval(compositor()));
compositor()->SetRootLayer(nullptr);
}
TEST_F(CompositorTestWithMockedTime,
ReleaseWidgetWithOutputSurfaceNeverCreated) {
compositor()->SetVisible(false);
EXPECT_EQ(gfx::kNullAcceleratedWidget,
compositor()->ReleaseAcceleratedWidget());
compositor()->SetAcceleratedWidget(gfx::kNullAcceleratedWidget);
compositor()->SetVisible(true);
}
TEST_F(CompositorTestWithMessageLoop, MoveThroughputTracker) {
{
auto tracker = compositor()->RequestNewThroughputTracker();
auto moved_tracker = std::move(tracker);
}
{
auto tracker = compositor()->RequestNewThroughputTracker();
tracker.Start(base::BindLambdaForTesting(
[&](const cc::FrameSequenceMetrics::CustomReportData& data) {
ADD_FAILURE();
}));
auto moved_tracker = std::move(tracker);
}
{
auto tracker = compositor()->RequestNewThroughputTracker();
tracker.Start(base::BindLambdaForTesting(
[&](const cc::FrameSequenceMetrics::CustomReportData& data) {
}));
auto moved_tracker = std::move(tracker);
EXPECT_TRUE(moved_tracker.Stop());
}
{
auto tracker = compositor()->RequestNewThroughputTracker();
tracker.Start(base::BindLambdaForTesting(
[&](const cc::FrameSequenceMetrics::CustomReportData& data) {
ADD_FAILURE();
}));
auto moved_tracker = std::move(tracker);
moved_tracker.Cancel();
}
{
auto tracker = compositor()->RequestNewThroughputTracker();
tracker.Start(base::BindLambdaForTesting(
[&](const cc::FrameSequenceMetrics::CustomReportData& data) {
}));
EXPECT_TRUE(tracker.Stop());
auto moved_tracker = std::move(tracker);
}
{
auto tracker = compositor()->RequestNewThroughputTracker();
tracker.Start(base::BindLambdaForTesting(
[&](const cc::FrameSequenceMetrics::CustomReportData& data) {
ADD_FAILURE();
}));
tracker.Cancel();
auto moved_tracker = std::move(tracker);
}
}
TEST_F(CompositorTestWithMessageLoop, ThroughputTracker) {
auto root_layer = std::make_unique<Layer>(ui::LAYER_SOLID_COLOR);
viz::ParentLocalSurfaceIdAllocator allocator;
allocator.GenerateId();
root_layer->SetBounds(gfx::Rect(10, 10));
compositor()->SetRootLayer(root_layer.get());
compositor()->SetScaleAndSize(1.0f, gfx::Size(10, 10),
allocator.GetCurrentLocalSurfaceId());
ASSERT_TRUE(compositor()->IsVisible());
ThroughputTracker tracker = compositor()->RequestNewThroughputTracker();
base::RunLoop run_loop;
tracker.Start(base::BindLambdaForTesting(
[&](const cc::FrameSequenceMetrics::CustomReportData& data) {
EXPECT_GT(data.frames_expected, 0u);
EXPECT_GT(data.frames_produced, 0u);
run_loop.Quit();
}));
for (int i = 0; i < 5; ++i) {
compositor()->ScheduleFullRedraw();
DrawWaiterForTest::WaitForCompositingEnded(compositor());
}
EXPECT_TRUE(tracker.Stop());
for (int i = 0; i < 5; ++i) {
compositor()->ScheduleFullRedraw();
DrawWaiterForTest::WaitForCompositingEnded(compositor());
}
run_loop.Run();
}
TEST_F(CompositorTestWithMessageLoop, ThroughputTrackerOutliveCompositor) {
auto tracker = compositor()->RequestNewThroughputTracker();
tracker.Start(base::BindLambdaForTesting(
[&](const cc::FrameSequenceMetrics::CustomReportData& data) {
ADD_FAILURE() << "No report should happen";
}));
DestroyCompositor();
EXPECT_FALSE(tracker.Stop());
}
TEST_F(CompositorTestWithMessageLoop, ThroughputTrackerCallbackStateChange) {
auto root_layer = std::make_unique<Layer>(ui::LAYER_SOLID_COLOR);
viz::ParentLocalSurfaceIdAllocator allocator;
allocator.GenerateId();
root_layer->SetBounds(gfx::Rect(10, 10));
compositor()->SetRootLayer(root_layer.get());
compositor()->SetScaleAndSize(1.0f, gfx::Size(10, 10),
allocator.GetCurrentLocalSurfaceId());
ASSERT_TRUE(compositor()->IsVisible());
ThroughputTracker tracker = compositor()->RequestNewThroughputTracker();
base::RunLoop run_loop;
tracker.Start(base::BindLambdaForTesting(
[&](const cc::FrameSequenceMetrics::CustomReportData& data) {
tracker.Cancel();
ThroughputTracker another_tracker =
compositor()->RequestNewThroughputTracker();
another_tracker.Start(base::DoNothing());
run_loop.Quit();
}));
for (int i = 0; i < 5; ++i) {
compositor()->ScheduleFullRedraw();
DrawWaiterForTest::WaitForCompositingEnded(compositor());
}
EXPECT_TRUE(tracker.Stop());
for (int i = 0; i < 5; ++i) {
compositor()->ScheduleFullRedraw();
DrawWaiterForTest::WaitForCompositingEnded(compositor());
}
run_loop.Run();
}
TEST_F(CompositorTestWithMessageLoop, ThroughputTrackerInvoluntaryReport) {
auto root_layer = std::make_unique<Layer>(ui::LAYER_SOLID_COLOR);
viz::ParentLocalSurfaceIdAllocator allocator;
allocator.GenerateId();
root_layer->SetBounds(gfx::Rect(10, 10));
compositor()->SetRootLayer(root_layer.get());
compositor()->SetScaleAndSize(1.0f, gfx::Size(10, 10),
allocator.GetCurrentLocalSurfaceId());
ASSERT_TRUE(compositor()->IsVisible());
ThroughputTracker tracker = compositor()->RequestNewThroughputTracker();
tracker.Start(base::BindLambdaForTesting(
[&](const cc::FrameSequenceMetrics::CustomReportData& data) {
ADD_FAILURE() << "No report should happen";
}));
for (int i = 0; i < 5; ++i) {
compositor()->ScheduleFullRedraw();
DrawWaiterForTest::WaitForCompositingEnded(compositor());
}
compositor()->SetVisible(false);
compositor()->ReleaseAcceleratedWidget();
EXPECT_FALSE(tracker.Stop());
}
#if BUILDFLAG(IS_WIN)
#define MAYBE_CreateAndReleaseOutputSurface \
DISABLED_CreateAndReleaseOutputSurface
#else
#define MAYBE_CreateAndReleaseOutputSurface CreateAndReleaseOutputSurface
#endif
TEST_F(CompositorTestWithMessageLoop, MAYBE_CreateAndReleaseOutputSurface) {
std::unique_ptr<Layer> root_layer(new Layer(ui::LAYER_SOLID_COLOR));
viz::ParentLocalSurfaceIdAllocator allocator;
allocator.GenerateId();
root_layer->SetBounds(gfx::Rect(10, 10));
compositor()->SetRootLayer(root_layer.get());
compositor()->SetScaleAndSize(1.0f, gfx::Size(10, 10),
allocator.GetCurrentLocalSurfaceId());
ASSERT_TRUE(compositor()->IsVisible());
compositor()->ScheduleDraw();
DrawWaiterForTest::WaitForCompositingEnded(compositor());
compositor()->SetVisible(false);
EXPECT_EQ(gfx::kNullAcceleratedWidget,
compositor()->ReleaseAcceleratedWidget());
compositor()->SetAcceleratedWidget(gfx::kNullAcceleratedWidget);
compositor()->SetVisible(true);
compositor()->ScheduleDraw();
DrawWaiterForTest::WaitForCompositingEnded(compositor());
compositor()->SetRootLayer(nullptr);
}
class LayerDelegateThatAddsDuringUpdateVisualState : public LayerDelegate {
public:
explicit LayerDelegateThatAddsDuringUpdateVisualState(Layer* parent)
: parent_(parent) {}
bool update_visual_state_called() const {
return update_visual_state_called_;
}
void UpdateVisualState() override {
added_layers_.push_back(std::make_unique<Layer>(ui::LAYER_SOLID_COLOR));
parent_->Add(added_layers_.back().get());
update_visual_state_called_ = true;
}
void OnPaintLayer(const PaintContext& context) override {}
void OnDeviceScaleFactorChanged(float old_device_scale_factor,
float new_device_scale_factor) override {}
private:
raw_ptr<Layer> parent_;
std::vector<std::unique_ptr<Layer>> added_layers_;
bool update_visual_state_called_ = false;
};
TEST_F(CompositorTestWithMessageLoop, AddLayerDuringUpdateVisualState) {
std::unique_ptr<Layer> root_layer =
std::make_unique<Layer>(ui::LAYER_SOLID_COLOR);
std::unique_ptr<Layer> child_layer =
std::make_unique<Layer>(ui::LAYER_TEXTURED);
std::unique_ptr<Layer> child_layer2 =
std::make_unique<Layer>(ui::LAYER_SOLID_COLOR);
LayerDelegateThatAddsDuringUpdateVisualState child_layer_delegate(
root_layer.get());
child_layer->set_delegate(&child_layer_delegate);
root_layer->Add(child_layer.get());
root_layer->Add(child_layer2.get());
viz::ParentLocalSurfaceIdAllocator allocator;
allocator.GenerateId();
root_layer->SetBounds(gfx::Rect(10, 10));
compositor()->SetRootLayer(root_layer.get());
compositor()->SetScaleAndSize(1.0f, gfx::Size(10, 10),
allocator.GetCurrentLocalSurfaceId());
ASSERT_TRUE(compositor()->IsVisible());
compositor()->ScheduleDraw();
DrawWaiterForTest::WaitForCompositingEnded(compositor());
EXPECT_TRUE(child_layer_delegate.update_visual_state_called());
compositor()->SetRootLayer(nullptr);
child_layer2.reset();
child_layer.reset();
root_layer.reset();
}
#if defined(OHOS_UNITTESTS)
TEST_F(CompositorTestWithMessageLoop, SetCurrentFrameSinkId1) {
testing::internal::CaptureStderr();
const viz::FrameSinkId id;
auto frame_sink = cc::FakeLayerTreeFrameSink::Create3d();
mojo::AssociatedRemote<viz::mojom::DisplayPrivate> display_private;
mojo::PendingAssociatedReceiver<viz::mojom::DisplayPrivate> remote =
display_private.BindNewEndpointAndPassDedicatedReceiver();
compositor()->SetLayerTreeFrameSink(std::move(frame_sink),
std::move(display_private));
compositor()->SetCurrentFrameSinkId(id);
std::string log_output = testing::internal::GetCapturedStderr();
EXPECT_EQ(
log_output.find("Compositor::SetCurrentDisplay display_private error"),
std::string::npos);
}
TEST_F(CompositorTestWithMessageLoop, SetCurrentFrameSinkId2) {
testing::internal::CaptureStderr();
const viz::FrameSinkId id;
compositor()->SetCurrentFrameSinkId(id);
std::string log_output = testing::internal::GetCapturedStderr();
EXPECT_NE(
log_output.find("Compositor::SetCurrentDisplay display_private error"),
std::string::npos);
}
TEST_F(CompositorTestWithMessageLoop, SetShouldFrameSubmissionBeforeDraw1) {
compositor()->SetShouldFrameSubmissionBeforeDraw(true);
EXPECT_FALSE(compositor()->display_private_);
}
TEST_F(CompositorTestWithMessageLoop, SetDrawRect1) {
auto frame_sink = cc::FakeLayerTreeFrameSink::Create3d();
mojo::AssociatedRemote<viz::mojom::DisplayPrivate> display_private;
mojo::PendingAssociatedReceiver<viz::mojom::DisplayPrivate> remote =
display_private.BindNewEndpointAndPassDedicatedReceiver();
compositor()->SetLayerTreeFrameSink(std::move(frame_sink),
std::move(display_private));
gfx::Rect rect = gfx::Rect(0, 0, 256, 256);
compositor()->SetDrawRect(rect);
EXPECT_TRUE(compositor()->display_private_);
}
TEST_F(CompositorTestWithMessageLoop, SetDrawRect2) {
gfx::Rect rect = gfx::Rect(0, 0, 256, 256);
compositor()->SetDrawRect(rect);
EXPECT_FALSE(compositor()->display_private_);
}
TEST_F(CompositorTestWithMessageLoop, DisableSwapUntilMaximized1) {
compositor()->DisableSwapUntilMaximized();
EXPECT_FALSE(compositor()->display_private_);
}
#endif
}