windowmanager/wm/test/systemtest/window_immersive_test.cpp

/*
 * Copyright (c) 2021-2022 Huawei Device Co., Ltd.
 * 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.
 */

// gtest
#include <gtest/gtest.h>
#include "window_manager.h"
#include "window_test_utils.h"
using namespace testing;
using namespace testing::ext;

namespace OHOS {
namespace Rosen {
namespace {
    constexpr HiviewDFX::HiLogLabel LABEL = {LOG_CORE, HILOG_DOMAIN_WINDOW, "WindowImmersiveTest"};

    const Rect SYS_BAR_REGION_NULL = { 0, 0, 0, 0 };
    const SystemBarProperty SYS_BAR_PROP_DEFAULT;
    const SystemBarProperty SYS_BAR_PROP_1(true, 0xE5111111, 0xE5222222);
    const SystemBarProperty SYS_BAR_PROP_2(false, 0xE5222222, 0xE5333333);
    const SystemBarProperty SYS_BAR_PROP_3(false, 0xE5333333, 0xE5444444);
    const SystemBarProperty SYS_BAR_PROP_4(true, 0xE5444444, 0x66555555);
    const SystemBarRegionTints TEST_PROPS_DEFAULT = {
        { WindowType::WINDOW_TYPE_STATUS_BAR, SYS_BAR_PROP_DEFAULT, SYS_BAR_REGION_NULL },
        { WindowType::WINDOW_TYPE_NAVIGATION_BAR, SYS_BAR_PROP_DEFAULT, SYS_BAR_REGION_NULL },
    };
    const SystemBarRegionTints TEST_PROPS_1 = {
        { WindowType::WINDOW_TYPE_STATUS_BAR, SYS_BAR_PROP_1, SYS_BAR_REGION_NULL },
        { WindowType::WINDOW_TYPE_NAVIGATION_BAR, SYS_BAR_PROP_2, SYS_BAR_REGION_NULL },
    };
    const SystemBarRegionTints TEST_PROPS_2 = {
        { WindowType::WINDOW_TYPE_STATUS_BAR, SYS_BAR_PROP_1, SYS_BAR_REGION_NULL },
        { WindowType::WINDOW_TYPE_NAVIGATION_BAR, SYS_BAR_PROP_3, SYS_BAR_REGION_NULL },
    };

    const Rect EMPTY_RECT = {0, 0, 0, 0};
    const float RATIO = 0.3;
}

using Utils = WindowTestUtils;
const int WAIT_ASYNC_US = 100000;  // 100000us

class TestSystemBarChangedListener : public ISystemBarChangedListener {
public:
    SystemBarRegionTints tints_ = TEST_PROPS_DEFAULT;
    void OnSystemBarPropertyChange(DisplayId displayId, const SystemBarRegionTints& tints) override;
};

class TestAvoidAreaChangedListener : public IAvoidAreaChangedListener {
public:
    AvoidArea avoidArea_;
    void OnAvoidAreaChanged(const AvoidArea avoidArea, AvoidAreaType type) override;
};

class WindowImmersiveTest : public testing::Test {
public:
    static void SetUpTestCase();
    static void TearDownTestCase();
    virtual void SetUp() override;
    virtual void TearDown() override;
    void SetWindowSystemProps(const sptr<Window>& window, const SystemBarRegionTints& props);
    bool SystemBarPropsEqualsTo(const SystemBarRegionTints& expect);
    void DumpFailedInfo(const SystemBarRegionTints& expect);
    void DumpFailedInfo(bool expectStatus, bool expectNav);
    bool SystemBarEnableState(bool expectStatus, bool expectNav);
    DisplayId displayId_ = 0;
    std::vector<sptr<Window>> activeWindows_;
    static vector<Rect> fullScreenExpecteds_;
    static sptr<TestSystemBarChangedListener> testSystemBarChangedListener_;
    static sptr<TestAvoidAreaChangedListener> testAvoidAreaChangedListener_;
    Utils::TestWindowInfo fullScreenAppinfo_;
    Utils::TestWindowInfo avoidBarInfo_;
    uint32_t leftAvoidW_;
    uint32_t leftAvoidH_;
    uint32_t topAvoidW_;
    uint32_t topAvoidH_;
    sptr<Window> backgroundWindow_;
};

vector<Rect> WindowImmersiveTest::fullScreenExpecteds_;
sptr<TestSystemBarChangedListener> WindowImmersiveTest::testSystemBarChangedListener_ =
    new TestSystemBarChangedListener();
sptr<TestAvoidAreaChangedListener> WindowImmersiveTest::testAvoidAreaChangedListener_ =
    new TestAvoidAreaChangedListener();

void WindowImmersiveTest::SetWindowSystemProps(const sptr<Window>& window, const SystemBarRegionTints& tints)
{
    for (auto tint : tints) {
        window->SetSystemBarProperty(tint.type_, tint.prop_);
    }
}

void WindowImmersiveTest::DumpFailedInfo(const SystemBarRegionTints& expect)
{
    auto act = testSystemBarChangedListener_->tints_;
    WLOGFI("WindowImmersiveTest Expected:");
    for (auto tint : expect) {
        WLOGFI("WindowType: %{public}4d, Enable: %{public}4d, Color: %{public}x | %{public}x",
            static_cast<uint32_t>(tint.type_), tint.prop_.enable_,
            tint.prop_.backgroundColor_, tint.prop_.contentColor_);
    }
    WLOGFI("WindowImmersiveTest Act: ");
    for (auto tint : act) {
        WLOGFI("WindowType: %{public}4d, Enable: %{public}4d, Color: %{public}x | %{public}x",
            static_cast<uint32_t>(tint.type_), tint.prop_.enable_,
            tint.prop_.backgroundColor_, tint.prop_.contentColor_);
    }
}

void WindowImmersiveTest::DumpFailedInfo(bool expectStatus, bool expectNav)
{
    auto act = testSystemBarChangedListener_->tints_;
    WLOGFI("WindowImmersiveTest Expected:");
    WLOGFI("expectStatus: %{public}4d, expectNav: %{public}4d", expectStatus, expectNav);
    WLOGFI("WindowImmersiveTest Act: ");
    for (auto tint : act) {
        WLOGFI("WindowType: %{public}4d, Enable: %{public}4d, Color: %{public}x | %{public}x",
            static_cast<uint32_t>(tint.type_), tint.prop_.enable_,
            tint.prop_.backgroundColor_, tint.prop_.contentColor_);
    }
}

bool WindowImmersiveTest::SystemBarPropsEqualsTo(const SystemBarRegionTints& expect)
{
    usleep(WAIT_ASYNC_US);
    auto act = testSystemBarChangedListener_->tints_;
    if (act.size() != expect.size()) {
        DumpFailedInfo(expect);
        return false;
    }
    for (auto item : expect) {
        bool check = false;
        for (auto tint : act) {
            if (item.prop_ == tint.prop_ && item.type_ == tint.type_) {
                check = true;
                break;
            }
        }
        if (!check) {
            DumpFailedInfo(expect);
            return false;
        }
        check = false;
    }
    return true;
}

bool WindowImmersiveTest::SystemBarEnableState(bool expectStatus, bool expectNav)
{
    usleep(WAIT_ASYNC_US);
    auto act = testSystemBarChangedListener_->tints_;
    bool check = false;
    for (auto tint : act) {
        if ((tint.type_ == WindowType::WINDOW_TYPE_STATUS_BAR && tint.prop_.enable_ == expectStatus)
            || (tint.type_ == WindowType::WINDOW_TYPE_NAVIGATION_BAR && tint.prop_.enable_ == expectNav)) {
            check = true;
        } else {
            check = false;
        }
    }
    if (!check) {
        DumpFailedInfo(expectStatus, expectNav);
    }
    return check;
}

void TestSystemBarChangedListener::OnSystemBarPropertyChange(DisplayId displayId, const SystemBarRegionTints& tints)
{
    WLOGFI("TestSystemBarChangedListener Display ID: %{public}" PRIu64"", displayId);
    for (auto tint : tints) {
        auto type = tint.type_;
        for (uint32_t i = 0; i < tints_.size(); i++) {
            if (tints_[i].type_ == type) {
                tints_[i] = tint;
            }
        }
    }
}

void TestAvoidAreaChangedListener::OnAvoidAreaChanged(const AvoidArea avoidArea, AvoidAreaType type)
{
    avoidArea_ = avoidArea;
}

void WindowImmersiveTest::SetUpTestCase()
{
    auto display = DisplayManager::GetInstance().GetDisplayById(0);
    ASSERT_TRUE((display != nullptr));
    WLOGFI("GetDefaultDisplay: id %{public}" PRIu64", w %{public}d, h %{public}d, fps %{public}u",
        display->GetId(), display->GetWidth(), display->GetHeight(), display->GetRefreshRate());
    Rect displayRect = {0, 0, display->GetWidth(), display->GetHeight()};
    Utils::InitByDisplayRect(displayRect);
}

void WindowImmersiveTest::TearDownTestCase()
{
}

void WindowImmersiveTest::SetUp()
{
    fullScreenAppinfo_ = {
        .name = "main",
        .rect = Utils::customAppRect_,
        .type = WindowType::WINDOW_TYPE_APP_MAIN_WINDOW,
        .mode = WindowMode::WINDOW_MODE_FULLSCREEN, // immersive setting
        .needAvoid = false, // immersive setting
        .parentLimit = false,
        .parentName = "",
    };
    avoidBarInfo_ = {
        .name = "LeftAvoidTest",
        .rect = EMPTY_RECT,
        .type = WindowType::WINDOW_TYPE_STATUS_BAR,
        .mode = WindowMode::WINDOW_MODE_FLOATING,
    };
    // makesure left avoid win w < h
    leftAvoidW_ = std::min(Utils::displayRect_.width_, static_cast<uint32_t>(Utils::displayRect_.height_ * RATIO));
    leftAvoidH_ = Utils::displayRect_.height_;
    // makesure top avoid win h < w
    topAvoidW_ = Utils::displayRect_.width_;
    topAvoidH_ = std::min(Utils::displayRect_.height_, static_cast<uint32_t>(Utils::displayRect_.width_ * RATIO));

    WindowManager::GetInstance().RegisterSystemBarChangedListener(testSystemBarChangedListener_);
    activeWindows_.clear();
}

void WindowImmersiveTest::TearDown()
{
    while (!activeWindows_.empty()) {
        ASSERT_EQ(WMError::WM_OK, activeWindows_.back()->Destroy());
        activeWindows_.pop_back();
    }
    WindowManager::GetInstance().UnregisterSystemBarChangedListener(testSystemBarChangedListener_);
}

namespace {
/**
 * @tc.name: ImmersiveTest01
 * @tc.desc: Add one immersive window and hide
 * @tc.type: FUNC
 */
HWTEST_F(WindowImmersiveTest, ImmersiveTest01, Function | MediumTest | Level3)
{
    fullScreenAppinfo_.name = "immer01";
    const sptr<Window>& window = Utils::CreateTestWindow(fullScreenAppinfo_);
    activeWindows_.push_back(window);
    SetWindowSystemProps(window, TEST_PROPS_1);
    ASSERT_EQ(WMError::WM_OK, window->Show());
    ASSERT_TRUE(SystemBarPropsEqualsTo(TEST_PROPS_1));
    ASSERT_EQ(WMError::WM_OK, window->Hide());
}

/**
 * @tc.name: ImmersiveTest02
 * @tc.desc: Add two immersive window and switch
 * @tc.type: FUNC
 */
HWTEST_F(WindowImmersiveTest, ImmersiveTest02, Function | MediumTest | Level3)
{
    const sptr<Window>& window1 = Utils::CreateTestWindow(fullScreenAppinfo_);
    activeWindows_.push_back(window1);
    SetWindowSystemProps(window1, TEST_PROPS_1);
    fullScreenAppinfo_.name = "Immer02";
    const sptr<Window>& window2 = Utils::CreateTestWindow(fullScreenAppinfo_);
    activeWindows_.push_back(window2);
    SetWindowSystemProps(window2, TEST_PROPS_2);
    ASSERT_EQ(WMError::WM_OK, window1->Show());
    ASSERT_TRUE(SystemBarPropsEqualsTo(TEST_PROPS_1));
    ASSERT_EQ(WMError::WM_OK, window2->Show());

    ASSERT_TRUE(SystemBarPropsEqualsTo(TEST_PROPS_2));
    ASSERT_EQ(WMError::WM_OK, window2->Hide());
    ASSERT_TRUE(SystemBarPropsEqualsTo(TEST_PROPS_1));
    ASSERT_EQ(WMError::WM_OK, window1->Hide());
}

/**
 * @tc.name: ImmersiveTest03
 * @tc.desc: Add one no immersive window
 * @tc.type: FUNC
 */
HWTEST_F(WindowImmersiveTest, ImmersiveTest03, Function | MediumTest | Level3)
{
    const sptr<Window>& window1 = Utils::CreateTestWindow(fullScreenAppinfo_);
    activeWindows_.push_back(window1);
    SetWindowSystemProps(window1, TEST_PROPS_1);
    fullScreenAppinfo_.name = "Immer03";
    fullScreenAppinfo_.needAvoid = true; // no immersive setting
    const sptr<Window>& window2 = Utils::CreateTestWindow(fullScreenAppinfo_);
    activeWindows_.push_back(window2);
    SetWindowSystemProps(window2, TEST_PROPS_2);
    ASSERT_EQ(WMError::WM_OK, window1->Show());
    ASSERT_TRUE(SystemBarPropsEqualsTo(TEST_PROPS_1));
    ASSERT_EQ(WMError::WM_OK, window2->Show());
    ASSERT_TRUE(SystemBarPropsEqualsTo(TEST_PROPS_2));
    ASSERT_EQ(WMError::WM_OK, window1->Hide());
    ASSERT_TRUE(SystemBarPropsEqualsTo(TEST_PROPS_2));
}

/**
 * @tc.name: ImmersiveTest04
 * @tc.desc: SetLayoutFullScreen
 * @tc.type: FUNC
 */
HWTEST_F(WindowImmersiveTest, ImmersiveTest04, Function | MediumTest | Level3)
{
    fullScreenAppinfo_.needAvoid = true; // no immersive setting
    const sptr<Window>& window1 = Utils::CreateTestWindow(fullScreenAppinfo_);
    activeWindows_.push_back(window1);
    SetWindowSystemProps(window1, TEST_PROPS_1);
    ASSERT_EQ(WMError::WM_OK, window1->Show());
    ASSERT_TRUE(SystemBarPropsEqualsTo(TEST_PROPS_1));
    ASSERT_EQ(WMError::WM_OK, window1->SetLayoutFullScreen(true));
    ASSERT_EQ(true, window1->IsLayoutFullScreen());
    ASSERT_TRUE(SystemBarPropsEqualsTo(TEST_PROPS_1));
    ASSERT_EQ(WMError::WM_OK, window1->SetLayoutFullScreen(false));
    ASSERT_EQ(false, window1->IsLayoutFullScreen());
    ASSERT_TRUE(SystemBarPropsEqualsTo(TEST_PROPS_1));
    ASSERT_EQ(WMError::WM_OK, window1->Hide());
}

/**
 * @tc.name: ImmersiveTest05
 * @tc.desc: SetFullScreen
 * @tc.type: FUNC
 */
HWTEST_F(WindowImmersiveTest, ImmersiveTest05, Function | MediumTest | Level3)
{
    fullScreenAppinfo_.needAvoid = true; // no immersive setting
    const sptr<Window>& window1 = Utils::CreateTestWindow(fullScreenAppinfo_);
    activeWindows_.push_back(window1);
    SetWindowSystemProps(window1, TEST_PROPS_1);
    ASSERT_EQ(WMError::WM_OK, window1->Show());
    ASSERT_TRUE(SystemBarPropsEqualsTo(TEST_PROPS_1));
    ASSERT_EQ(WMError::WM_OK, window1->SetFullScreen(true));
    ASSERT_EQ(true, window1->IsFullScreen());
    ASSERT_TRUE(SystemBarEnableState(false, false));
    ASSERT_EQ(WMError::WM_OK, window1->SetFullScreen(false));
    ASSERT_EQ(false, window1->IsFullScreen());
    ASSERT_EQ(WMError::WM_OK, window1->Hide());
}

/**
 * @tc.name: ImmersiveNegativeTest01
 * @tc.desc: set systembar props with wrong window type
 * @tc.type: FUNC
 */
HWTEST_F(WindowImmersiveTest, ImmersiveNegativeTest01, Function | MediumTest | Level3)
{
    const SystemBarRegionTints TEST_PROPS_NEGATIVE = {
        { WindowType::WINDOW_TYPE_KEYGUARD, SYS_BAR_PROP_1, SYS_BAR_REGION_NULL },
        { WindowType::WINDOW_TYPE_POINTER, SYS_BAR_PROP_2, SYS_BAR_REGION_NULL },
    };
    const sptr<Window>& window = Utils::CreateTestWindow(fullScreenAppinfo_);
    activeWindows_.push_back(window);
    SetWindowSystemProps(window, TEST_PROPS_NEGATIVE);
    ASSERT_EQ(WMError::WM_OK, window->Show());
    ASSERT_FALSE(SystemBarPropsEqualsTo(TEST_PROPS_NEGATIVE));
    ASSERT_EQ(WMError::WM_OK, window->Hide());
    ASSERT_FALSE(SystemBarPropsEqualsTo(TEST_PROPS_NEGATIVE));
}

/**
 * @tc.name: GetAvoidAreaByTypeTest01
 * @tc.desc: Test GetAvoidArea use unsupported Type(TYPE_CUTOUT).
 * @tc.type: FUNC
 */
HWTEST_F(WindowImmersiveTest, GetAvoidAreaByTypeTest01, Function | MediumTest | Level3)
{
    // Add full screenwindow for call GetAvoidArea, and push_back in activeWindows_
    const sptr<Window>& win = Utils::CreateTestWindow(fullScreenAppinfo_);
    activeWindows_.push_back(win);

    // Test GetAvoidArea
    AvoidArea avoidarea;
    WMError ret = win->GetAvoidAreaByType(AvoidAreaType::TYPE_CUTOUT, avoidarea);
    ASSERT_EQ(WMError::WM_OK, ret);
    ASSERT_TRUE(Utils::RectEqualToRect(EMPTY_RECT, avoidarea.leftRect_));
    ASSERT_TRUE(Utils::RectEqualToRect(EMPTY_RECT, avoidarea.rightRect_));
    ASSERT_TRUE(Utils::RectEqualToRect(EMPTY_RECT, avoidarea.topRect_));
    ASSERT_TRUE(Utils::RectEqualToRect(EMPTY_RECT, avoidarea.bottomRect_));
    ASSERT_EQ(WMError::WM_OK, win->Hide());
}

/**
 * @tc.name: DockWindowTest01
 * @tc.desc: Add unexistavoid and remove this avoid. Test OnAvoidAreaChanged listener
 * @tc.type: FUNC
 */
HWTEST_F(WindowImmersiveTest, DockWindowTest01, Function | MediumTest | Level3)
{
    const sptr<Window>& dockWindow = Utils::CreateDockWindow();
    ASSERT_EQ(WMError::WM_OK, dockWindow->Show());

    const sptr<Window>& window = Utils::CreateTestWindow(fullScreenAppinfo_);

    usleep(WAIT_ASYNC_US);
    auto act = testSystemBarChangedListener_->tints_;
    for (SystemBarRegionTint tint : act) {
        if (tint.type_ == WindowType::WINDOW_TYPE_LAUNCHER_DOCK) {
            ASSERT_FALSE(tint.prop_.enable_);
        }
    }

    ASSERT_EQ(WMError::WM_OK, window->Hide());

    usleep(WAIT_ASYNC_US);
    act = testSystemBarChangedListener_->tints_;
    for (SystemBarRegionTint tint : act) {
        if (tint.type_ == WindowType::WINDOW_TYPE_LAUNCHER_DOCK) {
            ASSERT_TRUE(tint.prop_.enable_);
        }
    }
    ASSERT_EQ(WMError::WM_OK, dockWindow->Destroy());
}
}
} // namespace Rosen
} // namespace OHOS