Merge lp:~tiagosh/checkbox/welcome-persist into lp:checkbox

[Tiago Salem Herrmann]

This MR will make the Qt Ui use the new persistent layer.
Additionally it will make the checkbox present at the bottom of the welcome screen work properly, remembering its value on future runs.

[lp:~tiagosh/checkbox/welcome-persist]

1318. By Tiago Salem Herrmann on 2012-03-15

merge trunk

[Daniel Manrique (roadmr)]

OK, after some massaging to get this to merge against current trunk, it's now working, so I'll push it to trunk. Thanks!

review: Approve

=== modified file 'checkbox/user_interface.py'
--- checkbox/user_interface.py	2012-03-07 21:24:47 +0000
+++ checkbox/user_interface.py	2012-03-15 19:42:04 +0000
@@ -68,6 +68,7 @@
         self.title = title
         self.data_path = data_path
         self.progress = None
+        self.ui_flags = {}
 
         self.report_url = None
         self.direction = NEXT
 
=== modified file 'checkbox_qt/qt_interface.py'
--- checkbox_qt/qt_interface.py	2012-03-12 21:27:15 +0000
+++ checkbox_qt/qt_interface.py	2012-03-15 19:42:04 +0000
@@ -59,7 +59,10 @@
             self.onClosedFrontend, "closedFrontend")
         self.bus.add_signal_receiver(
             self.onReviewTestsClicked, "reviewTestsClicked")
+        self.bus.add_signal_receiver(
+            self.onWelcomeCheckboxToggled, "welcomeCheckboxToggled")
         self.qtiface.setInitialState()
+
         self._set_main_title()
 
     def onReviewTestsClicked(self):
@@ -68,8 +71,14 @@
     def onWelcomeScreenRequested(self):
         pass
 
-    def onClosedFrontend(self):
-        self.direction = KeyboardInterrupt
+    def onWelcomeCheckboxToggled(self, checked):
+        self.ui_flags["show_welcome_message"] = bool(checked)
+
+    def onClosedFrontend(self, finished):
+        if bool(finished):
+            self.direction = NEXT
+        else:
+            self.direction = KeyboardInterrupt
         self.loop.quit()
 
     def _set_main_title(self, test_name=None):
@@ -99,6 +108,9 @@
         #Reset window title
         self._set_main_title()
 
+        if not self.ui_flags == {}:
+            self.qtiface.setUiFlags(self.ui_flags)
+
         self.qtiface.showText(text)
         self.wait_on_signals(fullTestsClicked=onFullTestsClicked)
 
 
=== modified file 'debian/changelog'
--- debian/changelog	2012-03-15 14:05:42 +0000
+++ debian/changelog	2012-03-15 19:42:04 +0000
@@ -7,6 +7,10 @@
     plugins/user_interface.py, qt/frontend/qtfront.cpp, qt/frontend/qtfront.h:
     Correctly update automated test execution status in the Selection tab
     (LP: #950105).
+  * set interface.direction to NEXT if all the tests were executed and the user 
+    either analyzed or submitted the results. (LP: #956329)
+  * use the ui persistent storage to keep some ui configuration 
+    values. (LP: #937626)
 
   [Jeff Lane]
   * Reset default checkbox log level to INFO from DEBUG to make logs less
 
=== modified file 'plugins/user_interface.py'
--- plugins/user_interface.py	2012-03-07 21:24:47 +0000
+++ plugins/user_interface.py	2012-03-15 19:42:04 +0000
@@ -16,6 +16,7 @@
 # You should have received a copy of the GNU General Public License
 # along with Checkbox.  If not, see <http://www.gnu.org/licenses/>.
 #
+from checkbox.contrib.persist import Persist, MemoryBackend
 from checkbox.plugin import Plugin
 from checkbox.properties import Path, String
 from checkbox.user_interface import PREV
@@ -44,9 +45,21 @@
     # Path where data files are stored.
     data_path = Path(required=False)
 
+    @property
+    def persist(self):
+        if self._persist is None:
+            self._persist = Persist(backend=MemoryBackend())
+
+        return self._persist.root_at("user_interface")
+
     def register(self, manager):
         super(UserInterface, self).register(manager)
 
+        self._persist = None
+
+        self._manager.reactor.call_on("prompt-begin", self.prompt_begin)
+        self._manager.reactor.call_on("stop", self.save_persist)
+        self._manager.reactor.call_on("begin-persist", self.begin_persist)
         self._manager.reactor.call_on("run", self.run)
         self._manager.reactor.call_on("launchpad-report", self.launchpad_report)
 
@@ -58,6 +71,16 @@
         #information about each job that completes
         interface.update_status(job)
 
+    def begin_persist(self, persist):
+        self._persist = persist
+
+    def prompt_begin(self, interface):
+        self._interface.ui_flags = self.persist.get("ui_flags", {})
+
+    def save_persist(self, *args):
+        self.persist.set("ui_flags", self._interface.ui_flags)
+        self.persist.save()
+    
     def set_progress(self, progress):
         self._interface.progress = progress
         
 
=== modified file 'qt/frontend/qtfront.cpp'
--- qt/frontend/qtfront.cpp	2012-03-08 17:15:05 +0000
+++ qt/frontend/qtfront.cpp	2012-03-15 19:42:04 +0000
@@ -39,7 +39,9 @@
     m_model(0),
     m_statusModel(new QStandardItemModel()),
     m_currentTab(1),
-    m_skipTestMessage(false)
+    m_skipTestMessage(false),
+    isFirstTimeWelcome(true),
+    m_doneTesting(false)
 {
     m_mainWindow = (QWidget*)new CustomQWidget();
     ui->setupUi(m_mainWindow);
@@ -62,7 +64,8 @@
     connect(ui->previousTestButton, SIGNAL(clicked()), this, SLOT(onPreviousTestClicked()));
     connect(ui->buttonSubmitResults, SIGNAL(clicked()), this, SLOT(onSubmitTestsClicked()));
     connect(ui->buttonViewResults, SIGNAL(clicked()), this, SLOT(onReviewTestsClicked()));
-    connect(m_mainWindow, SIGNAL(closed()), this, SIGNAL(closedFrontend()));
+    connect(m_mainWindow, SIGNAL(closed()), this, SLOT(onClosedFrontend()));
+    connect(ui->checkBox, SIGNAL(toggled(bool)), SIGNAL(welcomeCheckboxToggled(bool)));
     connect(ui->treeView, SIGNAL(collapsed(QModelIndex)), this, SLOT(onJobItemChanged(QModelIndex)));
     connect(ui->treeView, SIGNAL(expanded(QModelIndex)), this, SLOT(onJobItemChanged(QModelIndex)));
     connect(ui->treeView->verticalScrollBar(), SIGNAL(valueChanged(int)), ui->statusView->verticalScrollBar(), SLOT(setValue(int)));
@@ -102,6 +105,18 @@
 
 }
 
+void QtFront::setUiFlags(QVariantMap flags)
+{
+    // process all ui flags
+    QVariant checked = flags["show_welcome_message"];
+    ui->checkBox->setChecked(checked.toBool());
+}
+
+void QtFront::onClosedFrontend()
+{
+    emit closedFrontend(m_doneTesting);
+}
+
 void QtFront::onSelectAllContextMenu(const QPoint& pos)
 {
     if (currentState != TREE || !m_model)
@@ -212,19 +227,28 @@
 {
     ui->buttonSubmitResults->setEnabled(false);
     ui->lineEditEmailAddress->setEnabled(false);
+    m_doneTesting = true;
     emit submitTestsClicked();
 }
 
 void QtFront::onReviewTestsClicked()
 {
+    m_doneTesting = true;
     emit reviewTestsClicked();
 }
 
 void QtFront::showText(QString text)
 {
     if (currentState == WELCOME) {
+        if(isFirstTimeWelcome) {
+            isFirstTimeWelcome = false;
+            if (ui->checkBox->isChecked()) {
+                QTimer::singleShot(100, this, SLOT(onFullTestsClicked()));
+            }
+        } else {
+            ui->tabWidget->setCurrentIndex(0);
+        }
         m_mainWindow->show();
-        ui->tabWidget->setCurrentIndex(0);
         ui->welcomeTextBox->setPlainText(text);
     } else if (currentState == SUBMISSION) {
         ui->submissionWarningLabel->setText(text);
@@ -546,6 +570,5 @@
          qDebug() << "error registering object";
          return false;
      }
-
      return true;
 }
 
=== modified file 'qt/frontend/qtfront.h'
--- qt/frontend/qtfront.h	2012-03-08 17:15:05 +0000
+++ qt/frontend/qtfront.h	2012-03-15 19:42:04 +0000
@@ -51,6 +51,7 @@
     QString getEmailAddress();
     void showTest(QString purpose, QString steps, QString verification, QString info, QString testType, QString testName, bool enableTestButton);
     QString showInfo(QString text, QStringList options, QString defaultoption);
+    void setUiFlags(QVariantMap flags);
     void updateAutoTestStatus(QString status, QString testName);
 
 private slots:
@@ -69,6 +70,7 @@
     void updateTestStatus(QStandardItem *item, QString status);
     void updateTestStatus(QString status = QString());
     void onSelectAllContextMenu(const QPoint& pos);
+    void onClosedFrontend();
 
 signals:
     void fullTestsClicked();
@@ -84,7 +86,8 @@
     void welcomeScreenRequested();
     // when the user clicks welcome from the tests selection tree
     void welcomeClicked();
-    void closedFrontend();
+    void closedFrontend(bool testsFinished);
+    void welcomeCheckboxToggled(bool toogled);
 
 private:
     bool registerService();
@@ -100,6 +103,8 @@
     int m_currentTab;
     bool m_skipTestMessage;
     QString m_currentTestName;
+    bool isFirstTimeWelcome;
+    bool m_doneTesting;
 };
 
 #endif // QTFRONT_H