Merge lp:~nick-dedekind/qtmir/1355173.trust-prompt-suspend into lp:qtmir

[Nick Dedekind]

Added support for prompt suspension

We don't want to suspend the trust helper, but we need to inform it that the application has been "backgrounded" (suspended). It should be the responsibility of the trust helper to deal with the providers if the application has been suspended.

Added support for prompt suspension

Requires:
https://code.launchpad.net/~nick-dedekind/mir/1355173.trust-prompt-suspend/+merge/241588
https://code.launchpad.net/~nick-dedekind/platform-api/1355173.trust-prompt-suspend/+merge/242210

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:276
http://jenkins.qa.ubuntu.com/job/qtmir-ci/154/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/qtmir-vivid-amd64-ci/5/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/qtmir-vivid-armhf-ci/5/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/qtmir-ci/154/rebuild

review: Needs Fixing (continuous-integration)

[Gerry Boland (gerboland)]

Code looks reasonable, I didn't test though

review: Approve (code)

[lp:~nick-dedekind/qtmir/1355173.trust-prompt-suspend]

277. By Nick Dedekind on 2014-11-25

updated for changes in mir

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:277
http://jenkins.qa.ubuntu.com/job/qtmir-ci/158/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/qtmir-vivid-amd64-ci/9/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/qtmir-vivid-armhf-ci/9/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/qtmir-ci/158/rebuild

review: Needs Fixing (continuous-integration)

[lp:~nick-dedekind/qtmir/1355173.trust-prompt-suspend]

278. By Nick Dedekind on 2014-12-18

merged with trunk

279. By Nick Dedekind on 2015-01-07

merged with compatibility branch

280. By Nick Dedekind on 2015-01-09

mirConfig->mirServer

281. By Nick Dedekind on 2015-01-09

merged with trunk

Unmerged revisions

=== modified file 'src/modules/Unity/Application/session.cpp'
--- src/modules/Unity/Application/session.cpp	2014-09-11 16:18:40 +0000
+++ src/modules/Unity/Application/session.cpp	2014-11-25 16:16:29 +0000
@@ -26,6 +26,7 @@
 
 // mir
 #include <mir/scene/session.h>
+#include <mir/scene/prompt_session.h>
 #include <mir/scene/prompt_session_manager.h>
 
 // Qt
@@ -223,7 +224,6 @@
         {
         case Session::State::Suspended:
             if (m_state == Session::State::Running) {
-                stopPromptSessions();
                 session()->set_lifecycle_state(mir_lifecycle_state_will_suspend);
                 m_suspendTimer->start(3000);
             }
@@ -253,6 +253,19 @@
         m_state = state;
         Q_EMIT stateChanged(state);
 
+        foreachPromptSession([this, state](const std::shared_ptr<ms::PromptSession>& promptSession) {
+            switch (state) {
+                case Session::State::Suspended:
+                    m_promptSessionManager->suspend_prompt_session(promptSession);
+                    break;
+                case Session::State::Running:
+                    m_promptSessionManager->resume_prompt_session(promptSession);
+                    break;
+                default:
+                    break;
+            }
+        });
+
         foreachChildSession([state](SessionInterface* session) {
             session->setState(state);
         });

=== modified file 'src/platforms/mirserver/promptsessionlistener.cpp'
--- src/platforms/mirserver/promptsessionlistener.cpp	2014-07-11 17:15:47 +0000
+++ src/platforms/mirserver/promptsessionlistener.cpp	2014-11-25 16:16:29 +0000
@@ -45,6 +45,18 @@
     Q_EMIT promptSessionStopping(prompt_session);
 }
 
+void PromptSessionListener::suspending(std::shared_ptr<ms::PromptSession> const& prompt_session)
+{
+    qCDebug(QTMIR_MIR_MESSAGES) << "PromptSessionListener::suspending - this=" << this << "prompt_session=" << prompt_session.get();
+    Q_EMIT promptSessionSuspending(prompt_session);
+}
+
+void PromptSessionListener::resuming(std::shared_ptr<ms::PromptSession> const& prompt_session)
+{
+    qCDebug(QTMIR_MIR_MESSAGES) << "PromptSessionListener::resuming - this=" << this << "prompt_session=" << prompt_session.get();
+    Q_EMIT promptSessionResuming(prompt_session);
+}
+
 void PromptSessionListener::prompt_provider_added(ms::PromptSession const& prompt_session,
                                                   std::shared_ptr<ms::Session> const& prompt_provider)
 {

=== modified file 'src/platforms/mirserver/promptsessionlistener.h'
--- src/platforms/mirserver/promptsessionlistener.h	2014-07-11 17:15:47 +0000
+++ src/platforms/mirserver/promptsessionlistener.h	2014-11-25 16:16:29 +0000
@@ -30,6 +30,8 @@
 
     void starting(std::shared_ptr<mir::scene::PromptSession> const& prompt_session) override;
     void stopping(std::shared_ptr<mir::scene::PromptSession> const& prompt_session) override;
+    void suspending(std::shared_ptr<mir::scene::PromptSession> const& prompt_session) override;
+    void resuming(std::shared_ptr<mir::scene::PromptSession> const& prompt_session) override;
 
     void prompt_provider_added(mir::scene::PromptSession const& prompt_session,
         std::shared_ptr<mir::scene::Session> const& prompt_provider) override;
@@ -39,6 +41,8 @@
 Q_SIGNALS:
     void promptSessionStarting(std::shared_ptr<mir::scene::PromptSession> const& session);
     void promptSessionStopping(std::shared_ptr<mir::scene::PromptSession> const& session);
+    void promptSessionSuspending(std::shared_ptr<mir::scene::PromptSession> const& session);
+    void promptSessionResuming(std::shared_ptr<mir::scene::PromptSession> const& session);
 
     void promptProviderAdded(mir::scene::PromptSession const*, std::shared_ptr<mir::scene::Session> const&);
     void promptProviderRemoved(mir::scene::PromptSession const*, std::shared_ptr<mir::scene::Session> const&);

=== modified file 'tests/modules/SessionManager/session_test.cpp'
--- tests/modules/SessionManager/session_test.cpp	2014-09-11 16:18:40 +0000
+++ tests/modules/SessionManager/session_test.cpp	2014-11-25 16:16:29 +0000
@@ -191,3 +191,61 @@
     delete session;
     EXPECT_THAT(destroyed, UnorderedElementsAre(session1, session2, session3));
 }
+
+class MockQtMirSession : public qtmir::Session
+{
+public:
+    MockQtMirSession(const std::shared_ptr<ms::Session>& session,
+                     const std::shared_ptr<ms::PromptSessionManager>& promptSessionManager)
+    : Session(session, promptSessionManager)
+    {}
+
+    using SessionInterface::appendPromptSession;
+};
+
+TEST_F(SessionTests, SuspendPromptSessionWhenSessionSuspends)
+{
+    using namespace testing;
+
+    const QString appId("test-app");
+    quint64 procId = 5551;
+
+    auto mirSession = std::make_shared<MockSession>(appId.toStdString(), procId);
+    EXPECT_CALL(*mirSession, set_lifecycle_state(_));
+
+    auto session = std::make_shared<MockQtMirSession>(mirSession, mirConfig->the_prompt_session_manager());
+    session->setState(Session::State::Running);
+
+    auto mirPromptSession = std::make_shared<ms::MockPromptSession>();
+    session->appendPromptSession(mirPromptSession);
+
+    EXPECT_CALL(*mirConfig->the_mock_prompt_session_manager(), suspend_prompt_session(_)).Times(1);
+
+    session->setState(Session::State::Suspended);
+
+    Mock::VerifyAndClear(mirConfig->the_mock_prompt_session_manager().get());
+}
+
+TEST_F(SessionTests, ResumePromptSessionWhenSessionResumes)
+{
+    using namespace testing;
+
+    const QString appId("test-app");
+    quint64 procId = 5551;
+
+    auto mirSession = std::make_shared<MockSession>(appId.toStdString(), procId);
+    EXPECT_CALL(*mirSession, set_lifecycle_state(_));
+
+    auto session = std::make_shared<MockQtMirSession>(mirSession, mirConfig->the_prompt_session_manager());
+    session->setState(Session::State::Suspended);
+
+    auto mirPromptSession = std::make_shared<ms::MockPromptSession>();
+    session->appendPromptSession(mirPromptSession);
+
+    EXPECT_CALL(*mirConfig->the_mock_prompt_session_manager(), resume_prompt_session(_)).Times(1);
+
+    session->setState(Session::State::Running);
+
+    Mock::VerifyAndClear(mirConfig->the_mock_prompt_session_manager().get());
+}
+

=== modified file 'tests/modules/common/mock_mir_session.h'
--- tests/modules/common/mock_mir_session.h	2014-09-11 16:18:40 +0000
+++ tests/modules/common/mock_mir_session.h	2014-11-25 16:16:29 +0000
@@ -31,7 +31,7 @@
 struct MockSession : public Session
 {
     MockSession() {}
-    MockSession(std::string const& sessionName, pid_t processId) 
+    MockSession(std::string const& sessionName, pid_t processId)
         : m_sessionName(sessionName), m_sessionId(processId)
     {}
 
@@ -62,6 +62,8 @@
 
     void start_prompt_session() override {};
     void stop_prompt_session() override {};
+    void suspend_prompt_session() override {};
+    void resume_prompt_session() override {};
 
 private:
     std::string m_sessionName;

=== modified file 'tests/modules/common/mock_prompt_session.h'
--- tests/modules/common/mock_prompt_session.h	2014-09-11 16:18:40 +0000
+++ tests/modules/common/mock_prompt_session.h	2014-11-25 16:16:29 +0000
@@ -26,6 +26,11 @@
 
 struct MockPromptSession : public PromptSession
 {
+public:
+    MOCK_METHOD1(start, void(std::shared_ptr<Session> const&));
+    MOCK_METHOD1(stop, void(std::shared_ptr<Session> const&));
+    MOCK_METHOD1(suspend, void(std::shared_ptr<Session> const&));
+    MOCK_METHOD1(resume, void(std::shared_ptr<Session> const&));
 };
 
 } // namespace scene

=== modified file 'tests/modules/common/mock_prompt_session_manager.h'
--- tests/modules/common/mock_prompt_session_manager.h	2014-09-11 16:18:40 +0000
+++ tests/modules/common/mock_prompt_session_manager.h	2014-11-25 16:16:29 +0000
@@ -34,12 +34,13 @@
 
     MOCK_CONST_METHOD1(stop_prompt_session, void(std::shared_ptr<PromptSession> const&));
 
+    MOCK_CONST_METHOD1(suspend_prompt_session, void(std::shared_ptr<PromptSession> const&));
+
+    MOCK_CONST_METHOD1(resume_prompt_session, void(std::shared_ptr<PromptSession> const&));
+
     MOCK_CONST_METHOD2(add_prompt_provider, void(std::shared_ptr<PromptSession> const&,
         std::shared_ptr<mir::scene::Session> const&));
 
-    MOCK_CONST_METHOD2(add_prompt_provider_by_pid, void(std::shared_ptr<PromptSession> const&,
-        pid_t));
-
     MOCK_CONST_METHOD1(add_expected_session, void(std::shared_ptr<Session> const&));
 
     MOCK_CONST_METHOD1(remove_session, void(std::shared_ptr<Session> const&));