Merge lp:~mzanetti/unity-api/application-api into lp:unity-api

[Michael Zanetti]

Add Ubuntu.Application API, including tests and a mock implementation

[Gerry Boland (gerboland)]

This is amazing, thanks Michael!! My comments:

3 nested namespaces, can't we reduce that?

+ ApplicationInfoInterface

First off I think we can be ruthless and get rid of deprecated stuff.

Launcher doesn't care if application is fullscreen, and technically a surface is fullscreen, not an application. Please leave that out until I decide what to do there. Also screenshots are made available by an image loader, with URI based on the appId - so that 'screenshot' API is going away

So I'd propose simplifying this interface to include only those things we both need to share: appId, name, comment, icon, stage, state, focused.

Next I think these properties should be read only. I expect to implement this interface by adding a constructor which takes app_id and then sets these properties from the correct desktop file. I don't see these needing to be set by shell. But if the desktop file changes, want to notify shell of those property changes.

Q_PROPERTY(QString icon READ icon WRITE setIcon NOTIFY iconChanged)
QUrl better? Will this will return things like file:///usr/share/icons/whatever.png or gicon:///network-enabled, if so I'd like to use QUrl.

States enum will also need "Suspended", "Stopped" for process management (Stopped means process killed, but its state was written to disk, so can be respawned and resume itself). Maybe also desktop-y things like "Wants Attention" ?

+ ApplicationListModelInterface

The only reason ApplicationListModelInterface was useful was for when we had 2 separate lists for main stage and side stage applications. But we agreed it is best to combine these into one master list. So is it worth having this class at all, we could instead making the ApplicationManager class an QAbstractListModel?

Pet peeve: QAbstractListModel doesn't have a "count" property, unlike javascript models. It would be nice to add it :)

+ ApplicationManagerInterface

+ Application* startProcess(QString desktopFile, ExecFlags flags, QStringList arguments)
your correct in your comment that this needs to change a lot. Yes it should use appId. Flags should go away too. Thus can remove that enum.

+ void unfocusCurrentApplication(StageHint stageHint);
I think this best replaced with unfocusCurrentApplication()

+Q_SIGNALS:
415 + // TODO: needed?
416 + void mainStageFocusedApplicationChanged();
417 + void sideStageFocusedApplicationChanged();

Can combine these into one focusedApplicationChanged() signal

418 + void focusRequested(FavoriteApplication favoriteApplication)
I believe upstart will handle this, so shell won't need to care. Can leave it out completely.

[Michael Zanetti (mzanetti)]

> 3 nested namespaces, can't we reduce that?

It's not my personal preference either, but more important is to keep consistency between the apis. As lp:unity-api has been defined with this namespace structure, we need to adopt it. Note that you don't need to use them in the actual implementation. Just "using namespace unity::shell:application" once in your header should be enough to not have to care about it all any more. Check out the launcher implementation in lp:unity8 plugins/Unity/Launcher/.

>
> + ApplicationInfoInterface
>
> First off I think we can be ruthless and get rid of deprecated stuff.
>
> Launcher doesn't care if application is fullscreen, and technically a surface
> is fullscreen, not an application. Please leave that out until I decide what
> to do there. Also screenshots are made available by an image loader, with URI
> based on the appId - so that 'screenshot' API is going away
>
> So I'd propose simplifying this interface to include only those things we both
> need to share: appId, name, comment, icon, stage, state, focused.

Done.

>
> Next I think these properties should be read only. I expect to implement this
> interface by adding a constructor which takes app_id and then sets these
> properties from the correct desktop file. I don't see these needing to be set
> by shell. But if the desktop file changes, want to notify shell of those
> property changes.

Done.

>
> Q_PROPERTY(QString icon READ icon WRITE setIcon NOTIFY iconChanged)
> QUrl better? Will this will return things like
> file:///usr/share/icons/whatever.png or gicon:///network-enabled, if so I'd
> like to use QUrl.

Done.

>
> States enum will also need "Suspended", "Stopped" for process management
> (Stopped means process killed, but its state was written to disk, so can be
> respawned and resume itself). Maybe also desktop-y things like "Wants
> Attention" ?

Added Suspended and Stopped. I don't think "Wants Attention" or the like belongs in here. Just because an app wants attention it is still one of the other states (e.g. running). I'd probably even create a separate boolean property for "Wants attention".

>
> + ApplicationListModelInterface
>
> The only reason ApplicationListModelInterface was useful was for when we had 2
> separate lists for main stage and side stage applications. But we agreed it is
> best to combine these into one master list. So is it worth having this class
> at all, we could instead making the ApplicationManager class an
> QAbstractListModel?

Done. This matches the Launcher api now very closely :)

>
> Pet peeve: QAbstractListModel doesn't have a "count" property, unlike
> javascript models. It would be nice to add it :)

added.

>
>
> + ApplicationManagerInterface
>
> + Application* startProcess(QString desktopFile, ExecFlags flags, QStringList
> arguments)
> your correct in your comment that this needs to change a lot. Yes it should
> use appId. Flags should go away too. Thus can remove that enum.

done

>
> + void unfocusCurrentApplication(StageHint stageHint);
> I think this best replaced with unfocusCurrentApplication()

done

>
>
> +Q_SIGNALS:
> 415 + // TODO: needed?
> 416 + void mainStageFocuse...

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:96
http://jenkins.qa.ubuntu.com/job/unity-api-ci/111/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-saucy-armhf-ci/68
        deb: http://jenkins.qa.ubuntu.com/job/unity-api-saucy-armhf-ci/68/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-saucy-i386-ci/69

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-api-ci/111/rebuild

review: Approve (continuous-integration)

[Gerry Boland (gerboland)]

> > 3 nested namespaces, can't we reduce that?
>
> It's not my personal preference either, but more important is to keep
> consistency between the apis. As lp:unity-api has been defined with this
> namespace structure, we need to adopt it. Note that you don't need to use
> them in the actual implementation. Just "using namespace
> unity::shell:application" once in your header should be enough to not have
> to care about it all any more. Check out the launcher implementation in
> lp:unity8 plugins/Unity/Launcher/.

Ok, I'll accept for consistency with what's already in unity-api. But we should have a chat about it later on.

+ * @bried The currently focused application.
Typo: "brief"

startProcess & stopProcess - sorry I just realized that the names are next exactly correct, as an application may launch several processes (e.g. webbrowser-app spawns a QWebProcess for each tab). Perhaps rename to just "start" and "stop", or "startApplication" and "stopApplication"

Only other issue is in your tests, that "Ubuntu.Application" is not a clear name for the plugin. I'm using "Unity.ApplicationManager" in unity-mir which is hopefully more descriptive.

Otherwise, it's excellent!

[Michael Zanetti (mzanetti)]

> + * @bried The currently focused application.
> Typo: "brief"

fixed.

>
> startProcess & stopProcess - sorry I just realized that the names are next
> exactly correct, as an application may launch several processes (e.g.
> webbrowser-app spawns a QWebProcess for each tab). Perhaps rename to just
> "start" and "stop", or "startApplication" and "stopApplication"

renamed to start/stopApplication

>
> Only other issue is in your tests, that "Ubuntu.Application" is not a clear
> name for the plugin. I'm using "Unity.ApplicationManager" in unity-mir which
> is hopefully more descriptive.

As discussed in IRC, renamed to Unity.Application.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:98
http://jenkins.qa.ubuntu.com/job/unity-api-ci/112/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-api-saucy-armhf-ci/69/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-api-saucy-i386-ci/70/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-api-ci/112/rebuild

review: Needs Fixing (continuous-integration)

[Gerry Boland (gerboland)]

Works great, and I approve of the API

review: Approve

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
Unapproved changes made after approval.
http://jenkins.qa.ubuntu.com/job/unity-api-autolanding/48/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-saucy-armhf-autolanding/32
        deb: http://jenkins.qa.ubuntu.com/job/unity-api-saucy-armhf-autolanding/32/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-saucy-i386-autolanding/32

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:100
http://jenkins.qa.ubuntu.com/job/unity-api-ci/113/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-saucy-armhf-ci/70
        deb: http://jenkins.qa.ubuntu.com/job/unity-api-saucy-armhf-ci/70/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-saucy-i386-ci/71

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-api-ci/113/rebuild

review: Approve (continuous-integration)

=== modified file 'include/unity/shell/CMakeLists.txt'
--- include/unity/shell/CMakeLists.txt	2013-05-17 10:10:20 +0000
+++ include/unity/shell/CMakeLists.txt	2013-08-29 12:55:03 +0000
@@ -1,5 +1,6 @@
 add_subdirectory(notifications)
 add_subdirectory(launcher)
+add_subdirectory(application)
 
 file(GLOB headers "${CMAKE_CURRENT_SOURCE_DIR}/*.h")
 file(GLOB internal_headers "${CMAKE_CURRENT_SOURCE_DIR}/internal/*.h")

=== added directory 'include/unity/shell/application'
=== added file 'include/unity/shell/application/ApplicationInfoInterface.h'
--- include/unity/shell/application/ApplicationInfoInterface.h	1970-01-01 00:00:00 +0000
+++ include/unity/shell/application/ApplicationInfoInterface.h	2013-08-29 12:55:03 +0000
@@ -0,0 +1,165 @@
+/*
+ * Copyright 2013 Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authors:
+ *      Michael Zanetti <[e-mail]>
+ */
+
+#ifndef UNITY_SHELL_APPLICATION_APPLICATIONINFOINTERFACE_H
+#define UNITY_SHELL_APPLICATION_APPLICATIONINFOINTERFACE_H
+
+#include <unity/SymbolExport.h>
+
+#include <QtCore/QObject>
+#include <QtCore/QUrl>
+
+namespace unity
+{
+namespace shell
+{
+namespace application
+{
+
+/**
+ * @brief A class that holds information about applications
+ *
+ * The items hold all the information required for the visual representation
+ * in the launcher.
+ */
+
+class UNITY_API ApplicationInfoInterface: public QObject
+{
+    Q_OBJECT
+
+    Q_ENUMS(Stage)
+    Q_ENUMS(State)
+
+    /**
+     * @brief The appId of the application.
+     *
+     * Holds the appId for the application. For example (com.ubuntu.camera-app).
+     * The appId is derived from the filename of the .desktop file.
+     */
+    Q_PROPERTY(QString appId READ appId CONSTANT)
+
+    /**
+     * @brief The name of the application.
+     *
+     * Holds the name of the application. Localized to current language.
+     */
+    Q_PROPERTY(QString name READ name NOTIFY nameChanged)
+
+    /**
+     * @brief The comment for the application.
+     *
+     * Holds the comment of the application as obtained from the .desktop file. Localized
+     * to current language.
+     */
+    Q_PROPERTY(QString comment READ comment NOTIFY commentChanged)
+
+    /**
+     * @brief The application's icon.
+     *
+     * Holds a path to the icon for the application. Can be a file or a gicon url.
+     */
+    Q_PROPERTY(QUrl icon READ icon NOTIFY iconChanged)
+
+    /**
+     * @brief The application's stage.
+     *
+     * Holds the stage where this application is currently located.
+     */
+    Q_PROPERTY(Stage stage READ stage NOTIFY stageChanged)
+
+    /**
+     * @brief The application's state.
+     *
+     * Holds the current application state.
+     */
+    Q_PROPERTY(State state READ state NOTIFY stateChanged)
+
+    /**
+     * @brief The application's focus state.
+     *
+     * Holds the current application focus state. True if focused, false otherwise.
+     */
+    Q_PROPERTY(bool focused READ focused NOTIFY focusedChanged)
+
+protected:
+    /// @cond
+    ApplicationInfoInterface(const QString &appId, QObject* parent = 0): QObject(parent) { Q_UNUSED(appId) }
+    /// @endcond
+
+public:
+    /**
+     * @brief A enum that defines a stage.
+     *
+     * MainStage: The main stage, which is the normal place for applications in
+     * traditional desktop environments.
+     * SideStage: The side stage, a panel on the right to place phone form factor
+     * applications.
+     */
+    enum Stage {
+        MainStage,
+        SideStage
+    };
+
+    /**
+     * @brief An application's state.
+     *
+     * Starting: The application was launched and is currently starting up.
+     * Running: The application is running and ready to be used.
+     * Suspended: The application is in the background and has been suspended by
+     * the system in order to save resources.
+     * Stopped: The application is in the background and has been stopped by
+     * the system in order to save resources. From a programmers point of view,
+     * the application is closed, but it's state has been stored to disk and
+     * can be restored upon next launch.
+     */
+    enum State {
+        Starting,
+        Running,
+        Suspended,
+        Stopped
+    };
+
+    /// @cond
+    virtual ~ApplicationInfoInterface() {}
+
+    virtual QString appId() const = 0;
+    virtual QString name() const = 0;
+    virtual QString comment() const = 0;
+    virtual QUrl icon() const = 0;
+    virtual Stage stage() const = 0;
+    virtual State state() const = 0;
+    virtual bool focused() const = 0;
+    /// @endcond
+
+Q_SIGNALS:
+    /// @cond
+    void nameChanged(const QString &name);
+    void commentChanged(const QString &comment);
+    void iconChanged(const QUrl &icon);
+    void stageChanged(Stage stage);
+    void stateChanged(State state);
+    void focusedChanged(bool focused);
+    /// @endcond
+};
+
+} // namespace application
+} // namespace shell
+} // namespace unity
+
+#endif // UNITY_SHELL_APPLICATIONMANAGER_APPLICATIONINFOINTERFACE_H

=== added file 'include/unity/shell/application/ApplicationManagerInterface.h'
--- include/unity/shell/application/ApplicationManagerInterface.h	1970-01-01 00:00:00 +0000
+++ include/unity/shell/application/ApplicationManagerInterface.h	2013-08-29 12:55:03 +0000
@@ -0,0 +1,168 @@
+/*
+ * Copyright 2013 Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authors:
+ *      Michael Zanetti <[e-mail]>
+ */
+
+#ifndef UNITY_SHELL_APPLICATION_APPLICATIONMANAGERINTERFACE_H
+#define UNITY_SHELL_APPLICATION_APPLICATIONMANAGERINTERFACE_H
+
+#include <unity/SymbolExport.h>
+
+#include <QtCore/QObject>
+#include <QtCore/QAbstractListModel>
+
+namespace unity
+{
+namespace shell
+{
+namespace application
+{
+
+class ApplicationInfoInterface;
+
+/**
+ * @brief The Application manager
+ *
+ * This is the main class to interact with Applications
+ */
+
+class UNITY_API ApplicationManagerInterface: public QAbstractListModel
+{
+    Q_OBJECT
+
+    /**
+     * @brief The count of the applications known to the manager.
+     *
+     * This is the same as rowCount, added in order to keep compatibility with QML ListModels.
+     */
+    Q_PROPERTY(int count READ count NOTIFY countChanged)
+
+    /**
+     * @brief The currently focused application.
+     *
+     * Use focusApplication() and unfocusCurrentApplication() to modify this.
+     */
+    Q_PROPERTY(unity::shell::application::ApplicationInfoInterface* focusedApplication READ focusedApplication NOTIFY focusedApplicationChanged)
+
+protected:
+    /// @cond
+    ApplicationManagerInterface(QObject* parent = 0): QAbstractListModel(parent)
+    {
+        m_roleNames.insert(RoleAppId, "appId");
+        m_roleNames.insert(RoleName, "name");
+        m_roleNames.insert(RoleComment, "comment");
+        m_roleNames.insert(RoleIcon, "icon");
+        m_roleNames.insert(RoleStage, "stage");
+        m_roleNames.insert(RoleState, "state");
+        m_roleNames.insert(RoleFocused, "focused");
+
+        connect(this, SIGNAL(rowsInserted(QModelIndex, int, int)), SIGNAL(countChanged()));
+        connect(this, SIGNAL(rowsRemoved(QModelIndex, int, int)), SIGNAL(countChanged()));
+        connect(this, SIGNAL(modelReset()), SIGNAL(countChanged()));
+        connect(this, SIGNAL(layoutChanged()), SIGNAL(countChanged()));
+    }
+    /// @endcond
+
+public:
+    /**
+     * @brief The Roles supported by the model
+     *
+     * See ApplicationInfoInterface properties for details.
+     */
+    enum Roles {
+        RoleAppId = Qt::UserRole,
+        RoleName,
+        RoleComment,
+        RoleIcon,
+        RoleStage,
+        RoleState,
+        RoleFocused,
+    };
+
+    /// @cond
+    virtual ~ApplicationManagerInterface() {}
+
+    virtual QHash<int, QByteArray> roleNames() const
+    {
+        return m_roleNames;
+    }
+
+    int count() const {
+        return rowCount();
+    }
+
+    virtual unity::shell::application::ApplicationInfoInterface *focusedApplication() const = 0;
+    /// @endcond
+
+    /**
+     * @brief Get an ApplicationInfo item.
+     *
+     * Note: QML requires the full namespace in the return value.
+     *
+     * @param index the index of the item to get
+     * @returns The item.
+     */
+    Q_INVOKABLE virtual unity::shell::application::ApplicationInfoInterface *get(int index) const = 0;
+
+    /**
+     * @brief Focus the given application.
+     *
+     * @param application The application to be focused.
+     */
+    Q_INVOKABLE virtual void focusApplication(ApplicationInfoInterface *application) = 0;
+
+    /**
+     * @brief Unfocus the currently focused application.
+     */
+    Q_INVOKABLE virtual void unfocusCurrentApplication() = 0;
+
+    /**
+     * @brief Start an application.
+     *
+     * @param appId The appId for the application to be spawned.
+     * @param arguments Any arguments to be passed to the process.
+     */
+    Q_INVOKABLE virtual unity::shell::application::ApplicationInfoInterface* startApplication(const QString &appId, const QStringList &arguments) = 0;
+
+    /**
+      * @brief Stops an application.
+      *
+      * @param application The application to be stopped.
+      */
+    Q_INVOKABLE virtual void stopApplication(ApplicationInfoInterface* application) = 0;
+
+Q_SIGNALS:
+    /// @cond
+    void countChanged();
+    /// @endcond
+
+    /**
+     * @brief Will be emitted whenever the focused application changes.
+     */
+    void focusedApplicationChanged();
+
+protected:
+    /// @cond
+    QHash<int, QByteArray> m_roleNames;
+    /// @endcond
+};
+
+} // namespace application
+} // namespace shell
+} // namespace unity
+
+#endif // UNITY_SHELL_APPLICATIONMANAGER_APPLICATIONINFO_H

=== added file 'include/unity/shell/application/CMakeLists.txt'
--- include/unity/shell/application/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ include/unity/shell/application/CMakeLists.txt	2013-08-29 12:55:03 +0000
@@ -0,0 +1,22 @@
+set(INCLUDE_INSTALL_DIR include/unity/shell/application)
+
+file(GLOB headers "${CMAKE_CURRENT_SOURCE_DIR}/*.h")
+file(GLOB internal_headers "${CMAKE_CURRENT_SOURCE_DIR}/internal/*.h")
+
+install(FILES ${headers} DESTINATION ${INCLUDE_INSTALL_DIR})
+
+set(UNITY_API_LIB_HDRS ${UNITY_API_LIB_HDRS} ${headers} ${internal_headers} PARENT_SCOPE)
+
+set(VERSION 1)
+set(PKGCONFIG_NAME "unity-shell-appliction")
+set(PKGCONFIG_DESCRIPTION "Unity shell Application APIs")
+set(PKGCONFIG_REQUIRES "Qt5Core")
+set(PKGCONFIG_FILE unity-shell-application.pc)
+
+configure_file(${CMAKE_SOURCE_DIR}/data/unity-shell-api.pc.in
+  ${CMAKE_BINARY_DIR}/data/${PKGCONFIG_FILE} @ONLY
+)
+
+install(FILES ${CMAKE_BINARY_DIR}/data/${PKGCONFIG_FILE}
+  DESTINATION ${LIB_INSTALL_PREFIX}/pkgconfig
+)

=== modified file 'test/qmltest/mocks/CMakeLists.txt'
--- test/qmltest/mocks/CMakeLists.txt	2013-06-05 13:07:49 +0000
+++ test/qmltest/mocks/CMakeLists.txt	2013-08-29 12:55:03 +0000
@@ -1,2 +1,3 @@
 add_subdirectory(plugins/Unity/Notifications)
 add_subdirectory(plugins/Unity/Launcher)
+add_subdirectory(plugins/Unity/Application)

=== added directory 'test/qmltest/mocks/plugins/Unity/Application'
=== added file 'test/qmltest/mocks/plugins/Unity/Application/CMakeLists.txt'
--- test/qmltest/mocks/plugins/Unity/Application/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ test/qmltest/mocks/plugins/Unity/Application/CMakeLists.txt	2013-08-29 12:55:03 +0000
@@ -0,0 +1,37 @@
+include_directories(
+    ${CMAKE_SOURCE_DIR}/include/unity/shell/application
+    ${CMAKE_CURRENT_SOURCE_DIR}
+)
+
+add_definitions(-DQT_NO_KEYWORDS)
+set(CMAKE_AUTOMOC ON)
+
+find_package(Qt5Core REQUIRED)
+find_package(Qt5Quick REQUIRED)
+find_package(Qt5Qml REQUIRED)
+
+set(ApplicationMocks_SOURCES
+    ${CMAKE_SOURCE_DIR}/include/unity/shell/application/ApplicationManagerInterface.h
+    ${CMAKE_SOURCE_DIR}/include/unity/shell/application/ApplicationInfoInterface.h
+    Mocks/MockApplicationManager.cpp
+    Mocks/MockApplicationInfo.cpp
+)
+
+add_library(ApplicationMocks SHARED ${ApplicationMocks_SOURCES})
+
+qt5_use_modules(ApplicationMocks Core)
+
+set(TestApplicationPlugin_SOURCES
+    TestApplicationPlugin.cpp
+)
+
+add_library(TestApplicationPlugin MODULE ${TestApplicationPlugin_SOURCES})
+
+qt5_use_modules(TestApplicationPlugin Core Quick)
+
+target_link_libraries(TestApplicationPlugin ApplicationMocks)
+
+add_custom_target(TestApplicationPluginQmldir ALL
+    COMMAND cp "${CMAKE_CURRENT_SOURCE_DIR}/qmldir" "${CMAKE_CURRENT_BINARY_DIR}"
+    DEPENDS qmldir
+)

=== added directory 'test/qmltest/mocks/plugins/Unity/Application/Mocks'
=== added file 'test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.cpp'
--- test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.cpp	1970-01-01 00:00:00 +0000
+++ test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.cpp	2013-08-29 12:55:03 +0000
@@ -0,0 +1,97 @@
+/*
+ * Copyright 2013 Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authors:
+ *      Michael Zanetti <[e-mail]>
+ */
+
+#include <Mocks/MockApplicationInfo.h>
+
+using namespace unity::shell::application;
+
+MockApplicationInfo::MockApplicationInfo(const QString &appId, const QString& comment, const QString& name, const QUrl& icon, QObject* parent):
+    ApplicationInfoInterface(appId, parent),
+    m_appId(appId),
+    m_name(name),
+    m_comment(comment),
+    m_icon(icon),
+    m_stage(MainStage),
+    m_state(Running),
+    m_focused(false)
+{
+
+}
+
+QString MockApplicationInfo::appId() const
+{
+    return m_appId;
+}
+
+QString MockApplicationInfo::comment() const
+{
+    return m_comment;
+}
+
+QString MockApplicationInfo::name() const
+{
+    return m_name;
+}
+
+QUrl MockApplicationInfo::icon() const
+{
+    return m_icon;
+}
+
+ApplicationInfoInterface::Stage MockApplicationInfo::stage() const
+{
+    return m_stage;
+}
+
+void MockApplicationInfo::setStage(ApplicationInfoInterface::Stage stage)
+{
+    if (m_stage != stage)
+    {
+        m_stage = stage;
+        Q_EMIT stageChanged(m_stage);
+    }
+}
+
+ApplicationInfoInterface::State MockApplicationInfo::state() const
+{
+    return m_state;
+}
+
+void MockApplicationInfo::setState(ApplicationInfoInterface::State state)
+{
+    if (m_state != state)
+    {
+        m_state = state;
+        Q_EMIT stateChanged(m_state);
+    }
+}
+
+bool MockApplicationInfo::focused() const
+{
+    return m_focused;
+}
+
+void MockApplicationInfo::setFocused(bool focused)
+{
+    if (m_focused != focused)
+    {
+        m_focused = focused;
+        Q_EMIT focusedChanged(focused);
+    }
+}

=== added file 'test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.h'
--- test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.h	1970-01-01 00:00:00 +0000
+++ test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationInfo.h	2013-08-29 12:55:03 +0000
@@ -0,0 +1,59 @@
+/*
+ * Copyright 2013 Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authors:
+ *      Michael Zanetti <[e-mail]>
+ */
+
+#ifndef MOCKAPPLICATIONINFO_H
+#define MOCKAPPLICATIONINFO_H
+
+#include <ApplicationInfoInterface.h>
+
+#include <QUrl>
+
+using namespace unity::shell::application;
+
+class UNITY_API MockApplicationInfo: public ApplicationInfoInterface
+{
+    Q_OBJECT
+public:
+    MockApplicationInfo(const QString &appId, const QString& name, const QString& comment, const QUrl& icon, QObject* parent = 0);
+
+    QString appId() const;
+    QString name() const;
+    QString comment() const;
+    QUrl icon() const;
+
+    ApplicationInfoInterface::Stage stage() const;
+    void setStage(ApplicationInfoInterface::Stage stage);
+
+    ApplicationInfoInterface::State state() const;
+    void setState(ApplicationInfoInterface::State state);
+
+    bool focused() const;
+    void setFocused(bool focused);
+
+private:
+    QString m_appId;
+    QString m_name;
+    QString m_comment;
+    QUrl m_icon;
+    ApplicationInfoInterface::Stage m_stage;
+    ApplicationInfoInterface::State m_state;
+    bool m_focused;
+};
+
+#endif // MOCKAPPLICATIONINFO_H

=== added file 'test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationManager.cpp'
--- test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationManager.cpp	1970-01-01 00:00:00 +0000
+++ test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationManager.cpp	2013-08-29 12:55:03 +0000
@@ -0,0 +1,107 @@
+/*
+ * Copyright 2013 Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authors:
+ *      Michael Zanetti <[e-mail]>
+ */
+
+#include <Mocks/MockApplicationManager.h>
+#include <Mocks/MockApplicationInfo.h>
+
+using namespace unity::shell::application;
+
+MockApplicationManager::MockApplicationManager(QObject* parent): ApplicationManagerInterface(parent)
+{
+    MockApplicationInfo *item = new MockApplicationInfo("phone-app", "Phone App", "Telephony application", QUrl("/usr/share/pixmaps/some/icon.png"));
+    m_list.append(item);
+    item = new MockApplicationInfo("camera-app", "Camera App", "Lets you take pictures with the camera.", QUrl("/usr/share/pixmaps/some/icon.png"));
+    m_list.append(item);
+    item = new MockApplicationInfo("calendar-app", "Calendar App", "5 missed reminders", QUrl("/usr/share/pixmaps/some/icon.png"));
+    m_list.append(item);
+}
+
+MockApplicationManager::~MockApplicationManager()
+{
+    while (!m_list.empty())
+    {
+        m_list.takeFirst()->deleteLater();
+    }
+}
+
+// cppcheck-suppress unusedFunction
+int MockApplicationManager::rowCount(const QModelIndex& parent) const
+{
+    Q_UNUSED(parent)
+    return m_list.count();
+}
+
+QVariant MockApplicationManager::data(const QModelIndex& index, int role) const
+{
+    ApplicationInfoInterface *item = m_list.at(index.row());
+    switch(role)
+    {
+    case RoleAppId:
+        return item->appId();
+    case RoleName:
+        return item->name();
+    case RoleComment:
+        return item->comment();
+    case RoleIcon:
+        return item->icon();
+    case RoleStage:
+        return item->stage();
+    case RoleState:
+        return item->state();
+    case RoleFocused:
+        return item->focused();
+    }
+
+    return QVariant();
+}
+
+unity::shell::application::ApplicationInfoInterface *MockApplicationManager::get(int index) const
+{
+    if (index < 0 || index >= m_list.count())
+    {
+        return 0;
+    }
+    return m_list.at(index);
+}
+
+unity::shell::application::ApplicationInfoInterface *MockApplicationManager::focusedApplication() const
+{
+    return m_list.first();
+}
+
+void MockApplicationManager::focusApplication(ApplicationInfoInterface *application)
+{
+    Q_UNUSED(application)
+}
+
+void MockApplicationManager::unfocusCurrentApplication()
+{
+}
+
+unity::shell::application::ApplicationInfoInterface *MockApplicationManager::startApplication(const QString &appId, const QStringList &arguments)
+{
+    Q_UNUSED(appId)
+    Q_UNUSED(arguments)
+    return 0;
+}
+
+void MockApplicationManager::stopApplication(unity::shell::application::ApplicationInfoInterface *application)
+{
+    Q_UNUSED(application)
+}

=== added file 'test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationManager.h'
--- test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationManager.h	1970-01-01 00:00:00 +0000
+++ test/qmltest/mocks/plugins/Unity/Application/Mocks/MockApplicationManager.h	2013-08-29 12:55:03 +0000
@@ -0,0 +1,57 @@
+/*
+ * Copyright 2013 Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authors:
+ *      Michael Zanetti <[e-mail]>
+ */
+
+#ifndef MOCKAPPLICATIONMANAGER_H
+#define MOCKAPPLICATIONMANAGER_H
+
+#include <ApplicationManagerInterface.h>
+
+using namespace unity::shell::application;
+
+class MockApplicationInfo;
+
+class UNITY_API MockApplicationManager: public ApplicationManagerInterface
+{
+   Q_OBJECT
+
+public:
+    MockApplicationManager(QObject* parent = 0);
+    ~MockApplicationManager();
+
+    int rowCount(const QModelIndex& parent) const;
+
+    QVariant data(const QModelIndex& index, int role) const;
+
+    unity::shell::application::ApplicationInfoInterface *focusedApplication() const;
+
+    Q_INVOKABLE unity::shell::application::ApplicationInfoInterface *get(int index) const;
+
+    Q_INVOKABLE void focusApplication(unity::shell::application::ApplicationInfoInterface *application);
+
+    Q_INVOKABLE void unfocusCurrentApplication();
+
+    Q_INVOKABLE unity::shell::application::ApplicationInfoInterface *startApplication(const QString &appId, const QStringList &arguments);
+
+    Q_INVOKABLE void stopApplication(unity::shell::application::ApplicationInfoInterface *application);
+
+private:
+    QList<MockApplicationInfo*> m_list;
+};
+
+#endif // MOCKAPPLICATIONMANAGER_H

=== added file 'test/qmltest/mocks/plugins/Unity/Application/TestApplicationPlugin.cpp'
--- test/qmltest/mocks/plugins/Unity/Application/TestApplicationPlugin.cpp	1970-01-01 00:00:00 +0000
+++ test/qmltest/mocks/plugins/Unity/Application/TestApplicationPlugin.cpp	2013-08-29 12:55:03 +0000
@@ -0,0 +1,45 @@
+/*
+ * Copyright 2013 Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authors:
+ *      Michael Zanetti <[e-mail]>
+ */
+
+#include <TestApplicationPlugin.h>
+#include <Mocks/MockApplicationManager.h>
+#include <Mocks/MockApplicationInfo.h>
+
+#include <ApplicationManagerInterface.h>
+#include <ApplicationInfoInterface.h>
+
+#include <QtQml/qqml.h>
+
+using namespace unity::shell::application;
+
+static QObject* modelProvider(QQmlEngine* /* engine */, QJSEngine* /* scriptEngine */)
+{
+    return new MockApplicationManager();
+}
+
+// cppcheck-suppress unusedFunction
+void TestApplicationPlugin::registerTypes(const char* uri)
+{
+    // @uri Unity.Application
+    qmlRegisterUncreatableType<ApplicationManagerInterface>(uri, 0, 1, "ApplicationManagerInterface", "Interface for the ApplicationManager");
+    qmlRegisterUncreatableType<ApplicationInfoInterface>(uri, 0, 1, "ApplicationInfoInterface", "Interface for the ApplicationInfo");
+
+    qmlRegisterSingletonType<MockApplicationManager>(uri, 0, 1, "ApplicationManager", modelProvider);
+    qmlRegisterUncreatableType<MockApplicationInfo>(uri, 0, 1, "ApplicationInfo", "Can't create ApplicationInfos in QML. Get them from the ApplicationManager");
+}

=== added file 'test/qmltest/mocks/plugins/Unity/Application/TestApplicationPlugin.h'
--- test/qmltest/mocks/plugins/Unity/Application/TestApplicationPlugin.h	1970-01-01 00:00:00 +0000
+++ test/qmltest/mocks/plugins/Unity/Application/TestApplicationPlugin.h	2013-08-29 12:55:03 +0000
@@ -0,0 +1,35 @@
+/*
+ * Copyright 2013 Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authors:
+ *      Michael Zanetti <[e-mail]>
+ */
+
+
+#ifndef TESTAPPLICATION_PLUGIN_H
+#define TESTAPPLICATION_PLUGIN_H
+
+#include <QtQml/QQmlExtensionPlugin>
+
+class TestApplicationPlugin : public QQmlExtensionPlugin
+{
+    Q_OBJECT
+    Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QQmlExtensionInterface")
+
+public:
+    void registerTypes(const char* uri);
+};
+
+#endif // TESTAPPLICATION_PLUGIN_H

=== added file 'test/qmltest/mocks/plugins/Unity/Application/qmldir'
--- test/qmltest/mocks/plugins/Unity/Application/qmldir	1970-01-01 00:00:00 +0000
+++ test/qmltest/mocks/plugins/Unity/Application/qmldir	2013-08-29 12:55:03 +0000
@@ -0,0 +1,2 @@
+module Unity.Application
+plugin TestApplicationPlugin

=== modified file 'test/qmltest/unity/shell/CMakeLists.txt'
--- test/qmltest/unity/shell/CMakeLists.txt	2013-06-05 13:07:49 +0000
+++ test/qmltest/unity/shell/CMakeLists.txt	2013-08-29 12:55:03 +0000
@@ -8,3 +8,4 @@
 
 add_qml_test(notifications Notifications)
 add_qml_test(launcher Launcher)
+add_qml_test(application Application)

=== added directory 'test/qmltest/unity/shell/application'
=== added file 'test/qmltest/unity/shell/application/tst_Application.qml'
--- test/qmltest/unity/shell/application/tst_Application.qml	1970-01-01 00:00:00 +0000
+++ test/qmltest/unity/shell/application/tst_Application.qml	2013-08-29 12:55:03 +0000
@@ -0,0 +1,139 @@
+/*
+ * Copyright 2013 Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authors:
+ *      Michael Zanetti <[e-mail]>
+ */
+
+import QtQuick 2.0
+import QtTest 1.0
+import TestUtil 0.1
+import Unity.Application 0.1
+
+Item {
+
+    SignalSpy {
+        id: signalSpy
+    }
+
+    Verifier {
+        id: checkModelVerifier
+
+        property var model: ApplicationManager
+
+        function test_model_data() {
+            return [
+                { tag: "ApplicationManager[object]", type: "object" },
+                { tag: "ApplicationManager[ApplicationManagerInterface]", type: "unity::shell::application::ApplicationManagerInterface" },
+            ];
+        }
+
+        function test_model(data) {
+            object = model;
+            name = "ApplicationManager"
+
+            verifyData(data);
+        }
+    }
+
+    Verifier {
+        when: checkModelVerifier.completed
+
+        Repeater {
+            id: repeater
+            model: ApplicationManager
+            delegate: Item {
+                property var roles: model
+            }
+        }
+
+        /* make sure all the required roles are exposed on ApplicationManager */
+        function test_model_roles_data() {
+            return [
+                        { tag: "ApplicationManager.roles[appId]", role: "appId", type: "string" },
+                        { tag: "ApplicationManager.roles[name]", role: "name", type: "string" },
+                        { tag: "ApplicationManager.roles[comment]", role: "comment", type: "string" },
+                        { tag: "ApplicationManager.roles[icon]", role: "icon", type: "object" },
+                        { tag: "ApplicationManager.roles[stage]", role: "stage", type: "number" },
+                        { tag: "ApplicationManager.roles[state]", role: "state", type: "number" },
+                        { tag: "ApplicationManager.roles[focused]", role: "focused", type: "boolean" },
+                    ];
+        }
+
+        function test_model_roles(data) {
+            name = "ApplicationManager"
+            try {
+                object = repeater.itemAt(0).roles;
+            } catch(err) {
+                object = undefined;
+            }
+
+            verifyData(data);
+        }
+
+        function test_model_methods_data() {
+            return [
+                { tag: "ApplicationManager.methods[get]", method: "get" },
+                { tag: "ApplicationManager.methods[focusApplication]", method: "focusApplication" },
+                { tag: "ApplicationManager.methods[unfocusCurrentApplication]", method: "unfocusCurrentApplication" },
+                { tag: "ApplicationManager.methods[startApplication]", method: "startApplication" },
+                { tag: "ApplicationManager.methods[stopApplication]", method: "stopApplication" },
+            ];
+        }
+
+        function test_model_methods(data) {
+            name = "ApplicationManager";
+            object = ApplicationManager;
+            verifyData(data);
+        }
+
+        function test_model_properties_data() {
+            return [
+                { tag: "ApplicationManager.count", property: "count", type: "number" },
+                { tag: "ApplicationManager.focusedApplication", property: "focusedApplication", type: "unity::shell::application::ApplicationInfoInterface" },
+            ];
+        }
+
+        function test_model_properties(data) {
+            name = "ApplicationManager";
+            object = ApplicationManager;
+            verifyData(data);
+        }
+
+        function test_item_properties_data() {
+            return [
+                { tag: "ApplicationInfo.properties[appId]", constant: "appId", type: "string" },
+                { tag: "ApplicationInfo.properties[name]", property: "name", type: "string" },
+                { tag: "ApplicationInfo.properties[comment]", property: "comment", type: "string" },
+                { tag: "ApplicationInfo.properties[icon]", property: "icon", type: "object" },
+                { tag: "ApplicationInfo.properties[stage]", property: "stage", type: "number" },
+                { tag: "ApplicationInfo.properties[state]", property: "state", type: "number" },
+                { tag: "ApplicationInfo.properties[focused]", property: "focused", type: "boolean" },
+            ];
+        }
+
+        function test_item_properties(data) {
+            name = "ApplicationInfo"
+            try {
+                object = ApplicationManager.get(0)
+            } catch(err) {
+                object = undefined;
+                print(err)
+            }
+
+            verifyData(data)
+        }
+    }
+}