Merge lp:~gerboland/qtmir/initial-surface-expose into lp:qtmir

[Gerry Boland]

Recalculate MirSurface.visible after first frame swap by client

Fixes issue where OSK would be invisible at startup

[Unity8 CI Bot (unity8-ci-bot)]

PASSED: Continuous integration, rev:584
https://unity8-jenkins.ubuntu.com/job/lp-qtmir-ci/442/
Executed test runs:
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build/3751
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-0-fetch/3779
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=xenial+overlay/3623
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=xenial+overlay/3623/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=zesty/3623
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=zesty/3623/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=xenial+overlay/3623
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=xenial+overlay/3623/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=zesty/3623
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=zesty/3623/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=xenial+overlay/3623
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=xenial+overlay/3623/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=zesty/3623
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=zesty/3623/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://unity8-jenkins.ubuntu.com/job/lp-qtmir-ci/442/rebuild

review: Approve (continuous-integration)

[Nick Dedekind (nick-dedekind)]

All good here.
Test fails before, passes after.

review: Approve

=== modified file 'src/modules/Unity/Application/mirsurface.cpp'
--- src/modules/Unity/Application/mirsurface.cpp	2016-11-25 15:23:36 +0000
+++ src/modules/Unity/Application/mirsurface.cpp	2017-01-10 18:01:14 +0000
@@ -845,6 +845,7 @@
     if (!m_ready) {
         DEBUG_MSG << "()";
         m_ready = true;
+        updateVisible(); // as Mir can change m_surface->visible() to true after first frame swap
         Q_EMIT ready();
         updateExposure();
     }

=== modified file 'tests/modules/WindowManager/mirsurface_test.cpp'
--- tests/modules/WindowManager/mirsurface_test.cpp	2016-11-03 20:17:46 +0000
+++ tests/modules/WindowManager/mirsurface_test.cpp	2017-01-10 18:01:14 +0000
@@ -61,6 +61,8 @@
 struct MockSurface : public StubSurface
 {
     MOCK_CONST_METHOD1(buffers_ready_for_compositor, int(void const*));
+    MOCK_CONST_METHOD0(visible, bool());
+    MOCK_CONST_METHOD0(state, MirSurfaceState());
 };
 
 class MirSurfaceTest : public ::testing::Test
@@ -159,6 +161,34 @@
 }
 
 /*
+ * Test that MirSurface.visible is recalculated after the client swaps the first frame.
+ * A surface is not considered visible unless it has a non-hidden & non-minimized state, and
+ * it has drawn at least one frame.
+ */
+TEST_F(MirSurfaceTest, EnsureVisiblePropertyRecalculatedAfterFrameSwap)
+{
+    auto mockSurface = std::make_shared<NiceMock<MockSurface>>();
+    miral::Window mockWindow(stubSession, mockSurface);
+    ms::SurfaceCreationParameters spec;
+    miral::WindowInfo mockWindowInfo(mockWindow, spec);
+
+    EXPECT_CALL(*mockSurface.get(),state())
+        .WillRepeatedly(Return(mir_surface_state_maximized));
+    EXPECT_CALL(*mockSurface.get(),visible())
+        .WillOnce(Return(false));
+
+    MirSurface surface(mockWindowInfo, nullptr);
+
+    EXPECT_FALSE(surface.visible());
+
+    EXPECT_CALL(*mockSurface.get(),visible())
+        .WillOnce(Return(true));
+
+    surface.setReady();
+    EXPECT_TRUE(surface.visible());
+}
+
+/*
  * Test that a surface whose client fails to comply with a close request will eventually comply.
  */
 struct MockWindowModelController : public StubWindowModelController