Merge lp:~dobey/ubuntu-app-launch/add-desktop-apis into lp:ubuntu-app-launch/16.10

[dobey]

Add missing APIs for necessary info from .desktop files.

[unity-api-1-bot (unity-api-1-bot)]

FAILED: Continuous integration, rev:238
https://jenkins.canonical.com/unity-api-1/job/lp-ubuntu-app-launch-ci/46/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build/327/console
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-0-fetch/333
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-1-sourcepkg/release=vivid+overlay/260
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-1-sourcepkg/release=xenial+overlay/260
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-1-sourcepkg/release=yakkety/260
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=amd64,release=vivid+overlay/190/console
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=amd64,release=xenial+overlay/190
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=amd64,release=xenial+overlay/190/artifact/output/*zip*/output.zip
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=amd64,release=yakkety/190
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=amd64,release=yakkety/190/artifact/output/*zip*/output.zip
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=armhf,release=vivid+overlay/190/console
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=armhf,release=xenial+overlay/190/console
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=armhf,release=yakkety/190
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=armhf,release=yakkety/190/artifact/output/*zip*/output.zip
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=i386,release=vivid+overlay/190
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=i386,release=vivid+overlay/190/artifact/output/*zip*/output.zip
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=i386,release=xenial+overlay/190
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=i386,release=xenial+overlay/190/artifact/output/*zip*/output.zip
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=i386,release=yakkety/190
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=i386,release=yakkety/190/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://jenkins.canonical.com/unity-api-1/job/lp-ubuntu-app-launch-ci/46/rebuild

review: Needs Fixing (continuous-integration)

[Ted Gould (ted)]

Needs to support code formatting for C++ code in this project. That can be easily done by typing "make format". Otherwise looks good!

review: Needs Fixing

[dobey (dobey)]

No, I can't use "make format" nor "make format-tests" because they are broken, do not follow the coding style which we really should be following anyway (nor does the rest of UAL follow that standard), and the changes in this MP are fully consistent with the rest of the file in which they changed.

I have filed several bugs about the style issues in UAL this morning. I'll agree they should be fixed, but this isn't the branch to do it in.

[Ted Gould (ted)]

All I care is that "make format && bzr diff" returns no changes.

review: Needs Fixing

=== modified file 'libubuntu-app-launch/application-info-desktop.cpp'
--- libubuntu-app-launch/application-info-desktop.cpp	2016-06-07 04:01:41 +0000
+++ libubuntu-app-launch/application-info-desktop.cpp	2016-08-09 20:01:05 +0000
@@ -127,6 +127,38 @@
     return retval;
 }
 
+template <typename T>
+auto stringlistFromKeyfile(std::shared_ptr<GKeyFile> keyfile,
+                           const gchar* key,
+                           const std::string& exceptionText = {}) -> T
+{
+    GError* error = nullptr;
+    auto keyval = g_key_file_get_locale_string_list(keyfile.get(), DESKTOP_GROUP, key, nullptr, nullptr, &error);
+
+    if (error != nullptr)
+    {
+        auto perror = std::shared_ptr<GError>(error, g_error_free);
+        if (!exceptionText.empty())
+        {
+            throw std::runtime_error(exceptionText + perror.get()->message);
+        }
+
+        return T::from_raw({});
+    }
+
+    std::vector<std::string> results;
+    for (auto i = 0; keyval[i] != nullptr; ++i)
+    {
+        if (strlen(keyval[i]) != 0)
+        {
+            results.emplace_back(keyval[i]);
+        }
+    }
+    g_strfreev(keyval);
+
+    return T::from_raw(results);
+}
+
 bool stringlistFromKeyfileContains(std::shared_ptr<GKeyFile> keyfile,
                                    const gchar* key,
                                    const std::string& match,
@@ -201,6 +233,11 @@
         }
         return fileFromKeyfile<Application::Info::IconPath>(keyfile, basePath, "Icon", "Missing icon for desktop file");
     }())
+    , _defaultDepartment(stringFromKeyfile<Application::Info::DefaultDepartment>(keyfile, "X-Ubuntu-Default-Department-ID"))
+    , _screenshotPath([keyfile, basePath]() {
+        return fileFromKeyfile<Application::Info::IconPath>(keyfile, basePath, "X-Screenshot");
+    }())
+    , _keywords(stringlistFromKeyfile<Application::Info::Keywords>(keyfile, "Keywords"))
     , _splashInfo(
           {stringFromKeyfile<Application::Info::Splash::Title>(keyfile, "X-Ubuntu-Splash-Title"),
            fileFromKeyfile<Application::Info::Splash::Image>(keyfile, basePath, "X-Ubuntu-Splash-Image"),

=== modified file 'libubuntu-app-launch/application-info-desktop.h'
--- libubuntu-app-launch/application-info-desktop.h	2016-06-07 04:01:41 +0000
+++ libubuntu-app-launch/application-info-desktop.h	2016-08-09 20:01:05 +0000
@@ -50,6 +50,18 @@
     {
         return _iconPath;
     }
+    const Application::Info::DefaultDepartment& defaultDepartment() override
+    {
+        return _defaultDepartment;
+    }
+    const Application::Info::IconPath& screenshotPath() override
+    {
+        return _screenshotPath;
+    }
+    const Application::Info::Keywords& keywords() override
+    {
+        return _keywords;
+    }
 
     Application::Info::Splash splash() override
     {
@@ -78,6 +90,9 @@
     Application::Info::Name _name;
     Application::Info::Description _description;
     Application::Info::IconPath _iconPath;
+    Application::Info::DefaultDepartment _defaultDepartment;
+    Application::Info::IconPath _screenshotPath;
+    Application::Info::Keywords _keywords;
 
     Application::Info::Splash _splashInfo;
     Application::Info::Orientations _supportedOrientations;

=== modified file 'libubuntu-app-launch/application.h'
--- libubuntu-app-launch/application.h	2016-06-07 04:01:41 +0000
+++ libubuntu-app-launch/application.h	2016-08-09 20:01:05 +0000
@@ -83,6 +83,10 @@
         struct DescriptionTag;
         /** \private */
         struct IconPathTag;
+        /** \private */
+        struct DefaultDepartmentTag;
+        /** \private */
+        struct KeywordsTag;
 
         /** \private */
         typedef TypeTagger<NameTag, std::string> Name;
@@ -90,6 +94,10 @@
         typedef TypeTagger<DescriptionTag, std::string> Description;
         /** \private */
         typedef TypeTagger<IconPathTag, std::string> IconPath;
+        /** \private */
+        typedef TypeTagger<DefaultDepartmentTag, std::string> DefaultDepartment;
+        /** \private */
+        typedef TypeTagger<KeywordsTag, std::vector<std::string>> Keywords;
 
         /** Name of the application */
         virtual const Name& name() = 0;
@@ -97,6 +105,12 @@
         virtual const Description& description() = 0;
         /** Path to the icon that represents the application */
         virtual const IconPath& iconPath() = 0;
+        /** Default department of the application */
+        virtual const DefaultDepartment& defaultDepartment() = 0;
+        /** Path to the screenshot of the application */
+        virtual const IconPath& screenshotPath() = 0;
+        /** List of keywords for the application */
+        virtual const Keywords& keywords() = 0;
 
         /** Information to be shown on the app splash screen */
         struct Splash

=== modified file 'tests/application-info-desktop.cpp'
--- tests/application-info-desktop.cpp	2016-05-10 19:09:34 +0000
+++ tests/application-info-desktop.cpp	2016-08-09 20:01:05 +0000
@@ -64,6 +64,7 @@
     EXPECT_EQ("Foo App", appinfo.name().value());
     EXPECT_EQ("", appinfo.description().value());
     EXPECT_EQ("/foo.png", appinfo.iconPath().value());
+    EXPECT_EQ("", appinfo.defaultDepartment().value());
 
     EXPECT_EQ("", appinfo.splash().title.value());
     EXPECT_EQ("", appinfo.splash().image.value());
@@ -126,6 +127,29 @@
 #endif
 }
 
+TEST_F(ApplicationInfoDesktop, KeyfileDefaultDepartment)
+{
+    auto keyfile = defaultKeyfile();
+    g_key_file_set_string(keyfile.get(), DESKTOP, "X-Ubuntu-Default-Department-ID", "foo");
+    EXPECT_NO_THROW(ubuntu::app_launch::app_info::Desktop(keyfile, "/"));
+}
+
+TEST_F(ApplicationInfoDesktop, KeyfileScreenshotPath)
+{
+    auto keyfile = defaultKeyfile();
+    g_key_file_set_string(keyfile.get(), DESKTOP, "X-Screenshot", "foo.png");
+    EXPECT_EQ("/foo.png", ubuntu::app_launch::app_info::Desktop(keyfile, "/").screenshotPath().value());
+}
+
+TEST_F(ApplicationInfoDesktop, KeyfileKeywords)
+{
+    std::vector<std::string>expectedKeywords{"foo", "bar", "baz"};
+
+    auto keyfile = defaultKeyfile();
+    g_key_file_set_string(keyfile.get(), DESKTOP, "Keywords", "foo;bar;baz;");
+    EXPECT_EQ(expectedKeywords, ubuntu::app_launch::app_info::Desktop(keyfile, "/").keywords().value());
+}
+
 TEST_F(ApplicationInfoDesktop, KeyfileShowListEdgeCases)
 {
   // Not appearing in not show list