Merge lp:~alecu/unity-scope-click/in-progress into lp:unity-scope-click/devel

[Alejandro J. Cura]

Query download manager for in-progress downloads

[Diego Sarmentero (diegosarmentero)]

review: Needs Information

[lp:~alecu/unity-scope-click/in-progress]

420. By Alejandro J. Cura on 2014-08-21

Use only one downloader

[dobey (dobey)]

review: Approve

[Diego Sarmentero (diegosarmentero)]

looks good, +1

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:420
http://jenkins.qa.ubuntu.com/job/unity-team-unity-scope-click-devel-ci/280/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-team-unity-scope-click-devel-utopic-amd64-ci/255
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-team-unity-scope-click-devel-utopic-armhf-ci/254
        deb: http://jenkins.qa.ubuntu.com/job/unity-team-unity-scope-click-devel-utopic-armhf-ci/254/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-team-unity-scope-click-devel-utopic-i386-ci/254

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-team-unity-scope-click-devel-ci/280/rebuild

review: Approve (continuous-integration)

=== modified file 'libclickscope/click/download-manager.cpp'
--- libclickscope/click/download-manager.cpp	2014-08-11 18:30:00 +0000
+++ libclickscope/click/download-manager.cpp	2014-08-21 14:29:59 +0000
@@ -43,6 +43,7 @@
 
 namespace udm = Ubuntu::DownloadManager;
 #include <ubuntu/download_manager/download_struct.h>
+#include <ubuntu/download_manager/downloads_list.h>
 #include <ubuntu/download_manager/download.h>
 #include <ubuntu/download_manager/error.h>
 
@@ -252,6 +253,12 @@
     emit clickTokenFetchError(QString("Network Error"));
 }
 
+void click::DownloadManager::getAllDownloadsWithMetadata(const QString &key, const QString &value,
+                                                         MetadataDownloadsListCb callback,
+                                                         MetadataDownloadsListCb errback)
+{
+    impl->systemDownloadManager->getAllDownloadsWithMetadata(key, value, callback, errback);
+}
 
 // Downloader
 namespace
@@ -281,9 +288,40 @@
 {
 }
 
-void click::Downloader::get_download_progress(std::string /*package_name*/, const std::function<void (std::string)>& /*callback*/)
-{
-    // TODO, unimplemented. see https://bugs.launchpad.net/ubuntu-download-manager/+bug/1277814
+click::Downloader::~Downloader()
+{
+
+}
+
+click::DownloadManager& click::Downloader::getDownloadManager()
+{
+    return downloadManagerInstance(networkAccessManager);
+}
+
+void click::Downloader::get_download_progress(std::string package_name, const std::function<void (std::string)>& callback)
+{
+    auto& dm = getDownloadManager();
+
+    dm.getAllDownloadsWithMetadata(DOWNLOAD_APP_ID_KEY, QString::fromStdString(package_name),
+       [callback, package_name](const QString& /*key*/, const QString& /*value*/, DownloadsList* downloads_list){
+        // got downloads matching metadata
+        std::string object_path;
+        auto downloads = downloads_list->downloads();
+        if (downloads.size() > 0) {
+            auto download = downloads.at(0);
+            object_path = download->id().toStdString();
+        }
+        qDebug() << "Found object path" << QString::fromStdString(object_path)
+                 << "for package" << QString::fromStdString(package_name);
+        if (downloads.size() != 1) {
+            qWarning() << "More than one download with the same object path";
+        }
+        callback(object_path);
+    }, [callback, package_name](const QString& /*key*/, const QString& /*value*/, DownloadsList* /*downloads_list*/){
+        // no downloads found
+        qDebug() << "No object path found for package" << QString::fromStdString(package_name);
+        callback("");
+    });
 }
 
 namespace

=== modified file 'libclickscope/click/download-manager.h'
--- libclickscope/click/download-manager.h	2014-08-11 18:30:00 +0000
+++ libclickscope/click/download-manager.h	2014-08-21 14:29:59 +0000
@@ -63,12 +63,16 @@
                     const QSharedPointer<click::CredentialsService>& ssoService,
                     const QSharedPointer<Ubuntu::DownloadManager::Manager>& systemDownloadManager,
                     QObject *parent = 0);
+    DownloadManager();
     virtual ~DownloadManager();
 
 public slots:
     virtual void startDownload(const QString& downloadUrl, const QString& download_sha512, const QString& package_name);
     virtual void fetchClickToken(const QString& downloadUrl, const QString& download_sha512);
-
+    virtual void getAllDownloadsWithMetadata(const QString& key,
+                                             const QString& value,
+                                             MetadataDownloadsListCb callback,
+                                             MetadataDownloadsListCb errback);
 signals:
 
     void credentialsNotFound();
@@ -97,9 +101,11 @@
 {
 public:
     Downloader(const QSharedPointer<click::network::AccessManager>& networkAccessManager);
-    void get_download_progress(std::string package_name, const std::function<void (std::string)>& callback);
+    virtual void get_download_progress(std::string package_name, const std::function<void (std::string)>& callback);
     void startDownload(const std::string& url, const std::string& download_sha512, const std::string& package_name,
                        const std::function<void (std::pair<std::string, InstallError>)>& callback);
+    virtual ~Downloader();
+    virtual click::DownloadManager& getDownloadManager();
 private:
     QSharedPointer<click::network::AccessManager> networkAccessManager;
 };

=== modified file 'libclickscope/click/preview.cpp'
--- libclickscope/click/preview.cpp	2014-08-19 21:42:44 +0000
+++ libclickscope/click/preview.cpp	2014-08-21 14:29:59 +0000
@@ -146,17 +146,17 @@
             } else {
                 qWarning() << "unexpected action id " << QString::fromStdString(action_id)
                            << " given with download_url" << QString::fromStdString(download_url);
-                return new UninstalledPreview(result, client, depts);
+                return new UninstalledPreview(result, client, depts, nam);
             }
         } else if (metadict.count(click::Preview::Actions::UNINSTALL_CLICK) != 0) {
             return new UninstallConfirmationPreview(result);
         } else if (metadict.count(click::Preview::Actions::CONFIRM_UNINSTALL) != 0) {
-            return new UninstallingPreview(result, client);
+            return new UninstallingPreview(result, client, nam);
         } else if (metadict.count(click::Preview::Actions::RATED) != 0) {
             return new InstalledPreview(result, metadata, client, depts);
         } else {
             qWarning() << "preview() called with unexpected metadata. returning uninstalled preview";
-            return new UninstalledPreview(result, client, depts);
+            return new UninstalledPreview(result, client, depts, nam);
         }
     } else {
         // metadata.scope_data() is Null, so we return an appropriate "default" preview:
@@ -167,7 +167,7 @@
         if (result["installed"].get_bool() == true) {
             return new InstalledPreview(result, metadata, client, depts);
         } else {
-            return new UninstalledPreview(result, client, depts);
+            return new UninstalledPreview(result, client, depts, nam);
         }
     }
 
@@ -526,7 +526,7 @@
             });
 }
 
-scopes::PreviewWidgetList InstallingPreview::progressBarWidget(const std::string& object_path)
+scopes::PreviewWidgetList PreviewStrategy::progressBarWidget(const std::string& object_path)
 {
     scopes::PreviewWidgetList widgets;
     scopes::PreviewWidget progress("download", "progress");
@@ -807,11 +807,18 @@
 
 // class UninstalledPreview
 
+click::Downloader* UninstalledPreview::get_downloader(const QSharedPointer<click::network::AccessManager>& nam)
+{
+    static auto downloader = new click::Downloader(nam);
+    return downloader;
+}
+
 UninstalledPreview::UninstalledPreview(const unity::scopes::Result& result,
                                        const QSharedPointer<click::web::Client>& client,
-                                       const std::shared_ptr<click::DepartmentsDb>& depts)
+                                       const std::shared_ptr<click::DepartmentsDb>& depts,
+                                       const QSharedPointer<click::network::AccessManager>& nam)
     : PreviewStrategy(result, client),
-      DepartmentUpdater(depts)
+      DepartmentUpdater(depts), nam(nam)
 {
 }
 
@@ -821,11 +828,20 @@
 
 void UninstalledPreview::run(unity::scopes::PreviewReplyProxy const& reply)
 {
-qDebug() << "in UninstalledPreview::run, about to populate details";
-
+    qDebug() << "in UninstalledPreview::run, about to populate details";
     populateDetails([this, reply](const PackageDetails &details){
             store_department(details);
-            pushPackagePreviewWidgets(reply, details, uninstalledActionButtonWidgets(details));
+            std::string app_name = result["name"].get_string();
+            get_downloader(nam)->get_download_progress(app_name,
+                                              [this, reply, details](std::string object_path){
+                scopes::PreviewWidgetList button_widgets;
+                if(object_path.empty()) {
+                    button_widgets = uninstalledActionButtonWidgets(details);
+                } else {
+                    button_widgets = progressBarWidget(object_path);
+                }
+                pushPackagePreviewWidgets(reply, details, button_widgets);
+            });
         },
         [this, reply](const ReviewList& reviewlist,
                       click::Reviews::Error error) {
@@ -874,10 +890,12 @@
 
 // TODO: this class should be removed once uninstall() is handled elsewhere.
 UninstallingPreview::UninstallingPreview(const unity::scopes::Result& result,
-                                         const QSharedPointer<click::web::Client>& client)
-    : UninstalledPreview(result, client, nullptr)
+                                         const QSharedPointer<click::web::Client>& client,
+                                         const QSharedPointer<click::network::AccessManager>& nam)
+      : UninstalledPreview(result, client, nullptr, nam)
 {
 }
+
 UninstallingPreview::~UninstallingPreview()
 {
 }

=== modified file 'libclickscope/click/preview.h'
--- libclickscope/click/preview.h	2014-08-19 21:42:44 +0000
+++ libclickscope/click/preview.h	2014-08-21 14:29:59 +0000
@@ -133,6 +133,7 @@
     virtual scopes::PreviewWidgetList headerWidgets(const PackageDetails &details);
     virtual scopes::PreviewWidgetList screenshotsWidgets(const PackageDetails &details);
     virtual scopes::PreviewWidgetList descriptionWidgets(const PackageDetails &details);
+    virtual scopes::PreviewWidgetList progressBarWidget(const std::string& object_path);
     virtual scopes::PreviewWidgetList reviewsWidgets(const click::ReviewList &reviewlist);
     virtual scopes::PreviewWidgetList downloadErrorWidgets();
     virtual scopes::PreviewWidgetList loginErrorWidgets();
@@ -183,7 +184,6 @@
     void run(unity::scopes::PreviewReplyProxy const& reply) override;
 
 protected:
-    virtual scopes::PreviewWidgetList progressBarWidget(const std::string& object_path);
     std::string download_url;
     std::string download_sha512;
     QSharedPointer<click::Downloader> downloader;
@@ -245,15 +245,18 @@
 
 class UninstalledPreview : public PreviewStrategy, public DepartmentUpdater
 {
+    const QSharedPointer<click::network::AccessManager>& nam;
 public:
     UninstalledPreview(const unity::scopes::Result& result,
                        const QSharedPointer<click::web::Client>& client,
-                       const std::shared_ptr<click::DepartmentsDb>& depts);
+                       const std::shared_ptr<click::DepartmentsDb>& depts,
+                       const QSharedPointer<click::network::AccessManager>& nam);
 
     virtual ~UninstalledPreview();
 
     void run(unity::scopes::PreviewReplyProxy const& reply) override;
 protected:
+    virtual click::Downloader* get_downloader(const QSharedPointer<click::network::AccessManager>& nam);
     virtual scopes::PreviewWidgetList uninstalledActionButtonWidgets(const PackageDetails &details);
 };
 
@@ -263,7 +266,8 @@
 {
 public:
     UninstallingPreview(const unity::scopes::Result& result,
-                        const QSharedPointer<click::web::Client>& client);
+                        const QSharedPointer<click::web::Client>& client,
+                        const QSharedPointer<click::network::AccessManager>& nam);
 
     virtual ~UninstallingPreview();
 

=== modified file 'libclickscope/tests/test_download_manager.cpp'
--- libclickscope/tests/test_download_manager.cpp	2014-08-11 18:30:00 +0000
+++ libclickscope/tests/test_download_manager.cpp	2014-08-21 14:29:59 +0000
@@ -47,6 +47,8 @@
 
 #include "mock_ubuntu_download_manager.h"
 
+using namespace ::testing;
+
 namespace udm = Ubuntu::DownloadManager;
 #include <ubuntu/download_manager/download_struct.h>
 
@@ -383,13 +385,13 @@
 
     std::function<void()> clickTokenSignalFunc;
     if (p.clickTokenFetchSignalsError) {
-        clickTokenSignalFunc = std::function<void()>([&](){ 
+        clickTokenSignalFunc = std::function<void()>([&](){
                 dm.clickTokenFetchError(TEST_DOWNLOADERROR_STRING);
             });
         EXPECT_CALL(*mockSystemDownloadManager, createDownload(_)).Times(0);
 
     } else {
-        clickTokenSignalFunc = std::function<void()>([&](){ 
+        clickTokenSignalFunc = std::function<void()>([&](){
                 dm.clickTokenFetched(TEST_CLICK_TOKEN_VALUE);
             });
 

=== modified file 'libclickscope/tests/test_preview.cpp'
--- libclickscope/tests/test_preview.cpp	2014-08-19 21:42:44 +0000
+++ libclickscope/tests/test_preview.cpp	2014-08-21 14:29:59 +0000
@@ -210,3 +210,81 @@
     EXPECT_CALL(preview, build_installing(_, FAKE_SHA512, _, _, _, _));
     preview.choose_strategy(client, nam, depts);
 }
+
+
+class UninstalledPreviewTest : public PreviewsBaseTest {
+public:
+    FakeResult result{vm};
+    click::PackageDetails details;
+    unity::scopes::PreviewWidgetList widgets;
+    QSharedPointer<click::web::Client> client;
+    QSharedPointer<click::network::AccessManager> nam;
+    std::shared_ptr<click::DepartmentsDb> depts;
+    unity::scopes::testing::MockPreviewReply reply;
+    std::shared_ptr<unity::scopes::testing::MockPreviewReply> replyptr{&reply, [](unity::scopes::testing::MockPreviewReply*){}};
+};
+
+class FakeDownloader : public click::Downloader {
+    std::string object_path;
+public:
+    FakeDownloader(const std::string& object_path, const QSharedPointer<click::network::AccessManager>& networkAccessManager)
+        : click::Downloader(networkAccessManager), object_path(object_path)
+    {
+
+    }
+    void get_download_progress(std::string /*package_name*/, const std::function<void (std::string)> &callback)
+    {
+        callback(object_path);
+    }
+};
+
+class FakeUninstalledPreview : public click::UninstalledPreview {
+    std::string object_path;
+public:
+    FakeUninstalledPreview(const std::string& object_path,
+                           const unity::scopes::Result& result,
+                           const QSharedPointer<click::web::Client>& client,
+                           const std::shared_ptr<click::DepartmentsDb>& depts,
+                           const QSharedPointer<click::network::AccessManager>& nam)
+        : click::UninstalledPreview(result, client, depts, nam), object_path(object_path)
+    {
+
+    }
+
+    virtual click::Downloader* get_downloader(const QSharedPointer<click::network::AccessManager> &nam)
+    {
+        return new FakeDownloader(object_path, nam);
+    }
+
+    void populateDetails(std::function<void (const click::PackageDetails &)> details_callback,
+                         std::function<void (const click::ReviewList &, click::Reviews::Error)> /*reviews_callback*/) {
+        click::PackageDetails details;
+        details_callback(details);
+    }
+    MOCK_METHOD1(uninstalledActionButtonWidgets, scopes::PreviewWidgetList (const click::PackageDetails &details));
+    MOCK_METHOD1(progressBarWidget, scopes::PreviewWidgetList(const std::string& object_path));
+};
+
+TEST_F(UninstalledPreviewTest, testDownloadInProgress) {
+    std::string fake_object_path = "/fake/object/path";
+
+    result["name"] = "fake_app_name";
+    scopes::PreviewWidgetList response;
+    FakeUninstalledPreview preview(fake_object_path, result, client, depts, nam);
+    EXPECT_CALL(preview, progressBarWidget(_))
+            .Times(1)
+            .WillOnce(Return(response));
+    preview.run(replyptr);
+}
+
+TEST_F(UninstalledPreviewTest, testNoDownloadProgress) {
+    std::string fake_object_path = "";
+
+    result["name"] = "fake_app_name";
+    scopes::PreviewWidgetList response;
+    FakeUninstalledPreview preview(fake_object_path, result, client, depts, nam);
+    EXPECT_CALL(preview, uninstalledActionButtonWidgets(_))
+            .Times(1)
+            .WillOnce(Return(response));
+    preview.run(replyptr);
+}