Keeper

Merge lp:~xavi-garcia-mena/keeper/cancel-feature into lp:keeper/devel

cancel-feature
Merge into devel

Proposed by Xavi Garcia on 2016-09-28

Status:	Merged
Merged at revision:	115
Proposed branch:	lp:~xavi-garcia-mena/keeper/cancel-feature
Merge into:	lp:keeper/devel
Diff against target:	390 lines (+226/-5) 11 files modified src/service/keeper-task.cpp (+17/-0) src/service/keeper-task.h (+2/-0) src/service/keeper-user.cpp (+1/-3) src/service/keeper.cpp (+13/-0) src/service/keeper.h (+2/-0) src/service/private/keeper-task_p.h (+2/-0) src/service/task-manager.cpp (+24/-0) src/service/task-manager.h (+2/-0) tests/integration/helpers/helpers-test.cc (+73/-2) tests/integration/helpers/test-helpers-base.cpp (+88/-0) tests/integration/helpers/test-helpers-base.h (+2/-0)
To merge this branch:	bzr merge lp:~xavi-garcia-mena/keeper/cancel-feature
Related bugs:	Link a bug report

Reviewer	Review Type	Date Requested	Status
unity-api-1-bot	continuous-integration		Approve on 2016-09-30
Charles Kerr (community)		2016-09-28	Approve on 2016-09-29
Review via email: mp+307030@code.launchpad.net

Commit message

Cancel feature implemented.

Description of the change

Cancel feature implemented.

The branch also adds an integration test that cancels the first task when it reaches 20%

Revision history for this message

unity-api-1-bot (unity-api-1-bot) wrote on 2016-09-28:

Click here to trigger a rebuild:
https://jenkins.canonical.com/unity-api-1/job/lp-keeper-ci/93/rebuild

review: Approve (continuous-integration)

Revision history for this message

Charles Kerr (charlesk) wrote on 2016-09-29:

Looks really good.

Some minor optional suggestions inline

review: Approve

lp:~xavi-garcia-mena/keeper/cancel-feature updated on 2016-09-30

114. By Xavi Garcia on 2016-09-30: addedn suggested modifications

Revision history for this message

Xavi Garcia (xavi-garcia-mena) wrote on 2016-09-30:

Thanks for the review and suggestions, Charles. I've committed the suggested changes.
Comments inline.

I'm going to merge this with devel.

Revision history for this message

unity-api-1-bot (unity-api-1-bot) wrote on 2016-09-30:

Click here to trigger a rebuild:
https://jenkins.canonical.com/unity-api-1/job/lp-keeper-ci/94/rebuild

review: Approve (continuous-integration)

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk

Subscribers

People subscribed via source and target branches

to all changes:

Unity API Team

Xavi Garcia

 === modified file 'src/service/keeper-task.cpp'
 --- src/service/keeper-task.cpp	2016-09-13 08:47:14 +0000
 +++ src/service/keeper-task.cpp	2016-09-30 09:23:25 +0000
@@ -149,6 +149,14 @@
      Q_EMIT(q_ptr->task_state_changed(state));
+ }
++void KeeperTaskPrivate::cancel()
++{
++    if (helper_)
++    {
++        helper_->stop();
++    }
++}
++
  QVariantMap KeeperTaskPrivate::get_initial_state(KeeperTask::TaskData const &td)
+ {
      QVariantMap ret;
@@ -188,12 +196,14 @@
  bool KeeperTask::start()
+ {
      Q_D(KeeperTask);
++
      return d->start();
+ }
  QVariantMap KeeperTask::state() const
+ {
      Q_D(const KeeperTask);
++
      return d->state();
+ }
@@ -201,3 +211,10 @@
+ {
      return KeeperTaskPrivate::get_initial_state(td);
+ }
++
++void KeeperTask::cancel()
++{
++    Q_D(KeeperTask);
++
++    return d->cancel();
++}
 === modified file 'src/service/keeper-task.h'
 --- src/service/keeper-task.h	2016-09-07 17:07:23 +0000
 +++ src/service/keeper-task.h	2016-09-30 09:23:25 +0000
@@ -57,6 +57,8 @@
      static QVariantMap get_initial_state(KeeperTask::TaskData const &td);
++    void cancel();
++
  Q_SIGNALS:
      void task_state_changed(Helper::State state);
      void task_socket_ready(int socket_descriptor);
 === modified file 'src/service/keeper-user.cpp'
 --- src/service/keeper-user.cpp	2016-09-07 16:35:26 +0000
 +++ src/service/keeper-user.cpp	2016-09-30 09:23:25 +0000
@@ -81,9 +81,7 @@
  void
  KeeperUser::Cancel()
+ {
--    // FIXME: writeme
--
--    qDebug() << "hello world";
++    keeper_.cancel();
+ }
  QVariantDictMap
 === modified file 'src/service/keeper.cpp'
 --- src/service/keeper.cpp	2016-09-07 16:35:26 +0000
 +++ src/service/keeper.cpp	2016-09-30 09:23:25 +0000
@@ -135,6 +135,11 @@
          return QDBusUnixFileDescriptor(0);
+     }
++    void cancel()
++    {
++        task_manager_.cancel();
++    }
++
  private:
      Keeper * const q_ptr;
@@ -201,3 +206,11 @@
      return d->get_state();
+ }
++
++void
++Keeper::cancel()
++{
++    Q_D(Keeper);
++
++    return d->cancel();
++}
 === modified file 'src/service/keeper.h'
 --- src/service/keeper.h	2016-09-07 16:47:55 +0000
 +++ src/service/keeper.h	2016-09-30 09:23:25 +0000
@@ -63,6 +63,8 @@
      QVariantDictMap get_state() const;
++    void cancel();
++
  private:
      QScopedPointer<KeeperPrivate> const d_ptr;
  };
 === modified file 'src/service/private/keeper-task_p.h'
 --- src/service/private/keeper-task_p.h	2016-09-07 14:50:51 +0000
 +++ src/service/private/keeper-task_p.h	2016-09-30 09:23:25 +0000
@@ -36,6 +36,8 @@
      QVariantMap state() const;
      void ask_for_storage_framework_socket(quint64 n_bytes);
++    void cancel();
++
      static QVariantMap get_initial_state(KeeperTask::TaskData const &td);
  protected:
 === modified file 'src/service/task-manager.cpp'
 --- src/service/task-manager.cpp	2016-09-13 08:47:14 +0000
 +++ src/service/task-manager.cpp	2016-09-30 09:23:25 +0000
@@ -73,6 +73,23 @@
+         }
+     }
++    void cancel()
++    {
++        if (task_)
++        {
++            task_->cancel();
++        }
++        for (auto const & task: remaining_tasks_)
++        {
++            auto& td = task_data_[task];
++            td.action = QStringLiteral("cancelled"); // TODO i18n
++            set_initial_task_state(td);
++        }
++        // notify the initial state once for all tasks
++        notify_state_changed();
++        remaining_tasks_.clear();
++    }
++
  private:
      enum class Mode { IDLE, BACKUP, RESTORE };
@@ -321,3 +338,10 @@
      d->ask_for_uploader(n_bytes);
+ }
++
++void TaskManager::cancel()
++{
++    Q_D(TaskManager);
++
++    d->cancel();
++}
 === modified file 'src/service/task-manager.h'
 --- src/service/task-manager.h	2016-09-07 17:07:23 +0000
 +++ src/service/task-manager.h	2016-09-30 09:23:25 +0000
@@ -58,6 +58,8 @@
      void ask_for_uploader(quint64 n_bytes);
++    void cancel();
++
  Q_SIGNALS:
      void socket_ready(int reply);
      void state_changed();
 === modified file 'tests/integration/helpers/helpers-test.cc'
 --- tests/integration/helpers/helpers-test.cc	2016-09-15 16:02:54 +0000
 +++ tests/integration/helpers/helpers-test.cc	2016-09-30 09:23:25 +0000
@@ -73,7 +73,7 @@
      QDBusReply<QVariantDictMap> choices = user_iface->call("GetBackupChoices");
      EXPECT_TRUE(choices.isValid()) << qPrintable(choices.error().message());
--    QString user_option = "XDG_MUSIC_DIR";
++    QString user_option = QStringLiteral("XDG_MUSIC_DIR");
      auto user_dir = qgetenv(user_option.toLatin1().data());
      ASSERT_FALSE(user_dir.isEmpty());
@@ -87,7 +87,7 @@
      ASSERT_FALSE(user_folder_uuid.isEmpty());
      qDebug() << "User folder UUID is:" << user_folder_uuid;
--    QString user_option_2 = "XDG_VIDEOS_DIR";
++    QString user_option_2 = QStringLiteral("XDG_VIDEOS_DIR");
      auto user_dir_2 = qgetenv(user_option_2.toLatin1().data());
      ASSERT_FALSE(user_dir_2.isEmpty());
@@ -127,6 +127,77 @@
      EXPECT_TRUE(check_storage_framework_files(QStringList{user_dir, user_dir_2}));
+ }
++TEST_F(TestHelpers, StartFullTestCancelling)
++{
++    XdgUserDirsSandbox tmp_dir;
++
++    // starts the services, including keeper-service
++    start_tasks();
++
++    QSharedPointer<DBusInterfaceKeeperUser> user_iface(new DBusInterfaceKeeperUser(
++                                                            DBusTypes::KEEPER_SERVICE,
++                                                            DBusTypes::KEEPER_USER_PATH,
++                                                            dbus_test_runner.sessionConnection()
++                                                        ) );
++
++    ASSERT_TRUE(user_iface->isValid()) << qPrintable(dbus_test_runner.sessionConnection().lastError().message());
++
++    // ask for a list of backup choices
++    QDBusReply<QVariantDictMap> choices = user_iface->call("GetBackupChoices");
++    EXPECT_TRUE(choices.isValid()) << qPrintable(choices.error().message());
++
++    QString user_option = QStringLiteral("XDG_MUSIC_DIR");
++
++    auto user_dir = qgetenv(user_option.toLatin1().data());
++    ASSERT_FALSE(user_dir.isEmpty());
++    qDebug() << "USER DIR:" << user_dir;
++
++    // fill something in the music dir
++    FileUtils::fillTemporaryDirectory(user_dir, qrand() % 100);
++
++    // search for the user folder uuid
++    auto user_folder_uuid = get_uuid_for_xdg_folder_path(user_dir, choices.value());
++    ASSERT_FALSE(user_folder_uuid.isEmpty());
++    qDebug() << "User folder UUID is:" << user_folder_uuid;
++
++    QString user_option_2 = QStringLiteral("XDG_VIDEOS_DIR");
++
++    auto user_dir_2 = qgetenv(user_option_2.toLatin1().data());
++    ASSERT_FALSE(user_dir_2.isEmpty());
++    qDebug() << "USER DIR 2:" << user_dir_2;
++
++    // fill something in the music dir
++    FileUtils::fillTemporaryDirectory(user_dir_2, qrand() % 100);
++
++    // search for the user folder uuid
++    auto user_folder_uuid_2 = get_uuid_for_xdg_folder_path(user_dir_2, choices.value());
++    ASSERT_FALSE(user_folder_uuid_2.isEmpty());
++    qDebug() << "User folder 2 UUID is:" << user_folder_uuid_2;
++
++    QSharedPointer<DBusPropertiesInterface> properties_interface(new DBusPropertiesInterface(
++                                                            DBusTypes::KEEPER_SERVICE,
++                                                            DBusTypes::KEEPER_USER_PATH,
++                                                            dbus_test_runner.sessionConnection()
++                                                        ) );
++
++    ASSERT_TRUE(properties_interface->isValid()) << qPrintable(QDBusConnection::sessionBus().lastError().message());
++
++    QSignalSpy spy(properties_interface.data(),&DBusPropertiesInterface::PropertiesChanged);
++
++    // Now we know the music folder uuid, let's start the backup for it.
++    QDBusReply<void> backup_reply = user_iface->call("StartBackup", QStringList{user_folder_uuid, user_folder_uuid_2});
++    ASSERT_TRUE(backup_reply.isValid()) << qPrintable(dbus_test_runner.sessionConnection().lastError().message());
++
++    EXPECT_TRUE(cancel_first_task_at_percentage(spy, 0.20, user_iface));
++
++    // wait until all the tasks have the action state "complete"
++    // this one uses pooling so it should just call Get once
++    EXPECT_TRUE(wait_for_all_tasks_have_action_state({user_folder_uuid, user_folder_uuid_2}, "cancelled", user_iface));
++
++    // check that we have no files in storage framework
++    EXPECT_EQ(0, check_storage_framework_nb_files());
++}
++
  TEST_F(TestHelpers, SimplyCheckThatTheSecondDBusInterfaceIsFine)
+ {
      XdgUserDirsSandbox tmp_dir;
 === modified file 'tests/integration/helpers/test-helpers-base.cpp'
 --- tests/integration/helpers/test-helpers-base.cpp	2016-09-08 14:06:56 +0000
 +++ tests/integration/helpers/test-helpers-base.cpp	2016-09-30 09:23:25 +0000
@@ -598,6 +598,94 @@
      return analyze_tasks_values(uuids_state);
+ }
++bool TestHelpersBase::cancel_first_task_at_percentage(QSignalSpy & spy, double expected_percentage, QSharedPointer<DBusInterfaceKeeperUser> const & user_iface, int max_timeout_msec)
++{
++    QMap<QString, QList<QVariantMap>> uuids_state;
++    QMap<QString, QString> uuids_current_state;
++
++    QElapsedTimer timer;
++    timer.start();
++    bool finished = false;
++    while (!timer.hasExpired(max_timeout_msec) && !finished)
++    {
++        spy.wait();
++
++        qDebug() << "PropertiesChanged SIGNALS RECEIVED:  " << spy.count();
++        while (spy.count())
++        {
++            auto arguments = spy.takeFirst();
++
++            if (arguments.size() != 3)
++            {
++                qWarning() << "Bad number of arguments in PropertiesChanged signal";
++                return false;
++            }
++
++            // verify interface and invalidated_properties arguments
++            if(!verify_signal_interface_and_invalidated_properties(arguments.at(0), arguments.at(2), DBusTypes::KEEPER_USER_INTERFACE, "State"))
++            {
++                return false;
++            }
++            QVariantDictMap keeper_state;
++            if (!get_property_qvariant_dict_map("State", arguments.at(1), keeper_state))
++            {
++                return false;
++            }
++            for (auto iter = keeper_state.begin(); iter != keeper_state.end(); ++iter )
++            {
++                QVariantMap task_state;
++                if (!qvariant_to_map((*iter), task_state))
++                {
++                    qWarning() << "Error converting second argument in PropertiesChanged signal to QVariantMap for uuid: " << iter.key();
++                    return false;
++                }
++                qDebug() << "State for uuid: " << iter.key() << " : " << task_state;
++
++                QVariant action;
++                if (get_task_property("action", task_state, action))
++                {
++                    if (action.type() != QVariant::String)
++                    {
++                        qWarning() << "Property [action] is not a string";
++                        return false;
++                    }
++                    if ( action.toString() == "saving")
++                    {
++                        // the helper is saving data... check for the percentage
++                        QVariant percentage;
++                        if (!get_task_property("percent-done", task_state, percentage))
++                        {
++                            qWarning() << Q_FUNC_INFO << ": Percentage was not found for task: " << iter.key();
++                            return false;
++                        }
++                        bool ok_double;
++                        auto percentage_double = percentage.toDouble(&ok_double);
++                        if (!ok_double)
++                        {
++                            qWarning() << Q_FUNC_INFO << ": Error converting percent-done to double for uuid: " << iter.key() << ". State: " << (*iter);
++                            return false;
++                        }
++                        if (percentage_double >= expected_percentage)
++                        {
++                            qDebug() << "CANCELLING ******************************";
++                            // found... cancel keeper
++                            QDBusReply<void> backup_reply = user_iface->call("Cancel");
++                            if (!backup_reply.isValid())
++                            {
++                                qWarning() << "Error calling Cancel in the dbus user interface: " << backup_reply.error().message();
++                                return false;
++                            }
++                            return true;
++                        }
++                    }
++                }
++            }
++        }
++    }
++    qWarning() << Q_FUNC_INFO << ":Error no task was not found or the expected percentage was not reached";
++    return false;
++}
++
  QString TestHelpersBase::get_uuid_for_xdg_folder_path(QString const &path, QVariantDictMap const & choices) const
+ {
      for(auto iter = choices.begin(); iter != choices.end(); ++iter)
 === modified file 'tests/integration/helpers/test-helpers-base.h'
 --- tests/integration/helpers/test-helpers-base.h	2016-09-07 21:09:15 +0000
 +++ tests/integration/helpers/test-helpers-base.h	2016-09-30 09:23:25 +0000
@@ -101,6 +101,8 @@
      bool capture_and_check_state_until_all_tasks_complete(QSignalSpy & spy, QStringList const & uuids, QString const & action_state, int max_timeout_msec = 15000);
++    bool cancel_first_task_at_percentage(QSignalSpy & spy, double expected_percentage, QSharedPointer<DBusInterfaceKeeperUser> const & user_iface, int max_timeout_msec = 15000);
++
      QString get_uuid_for_xdg_folder_path(QString const &path, QVariantDictMap const & choices) const;
      bool start_dbus_monitor();