Merge lp:~sylvain-pineau/checkbox/ui_profiles into lp:checkbox

[Sylvain Pineau]

Add support for application settings using a QSettings object invokable from both C++ and QML.

An example of configuration file could be this one:

[welcome]

title = "blah blah"

text = "<p>Welcome to System Testing.</p><p></p><p>This program contains
 automated and manual tests to help you assess how well your system works
 with Ubuntu.</p><p></p><p>This application will step the user through these
 tests in a predetermined order and automatically collect both system
 information as well as test results. It will also prompt the user for input
 when manual testing is required.</p><p></p><p>The run time for the tests is
 determined by which tests you decide to execute. The user will have the
 opportunity to customize the test run based on the hardware components they
 are interested in and the amount of time they have
 available.</p><p></p><p>To begin, simply click the Continue button below and
 follow the onscreen instructions.</p><p></p>"

whitelist_filter = "^ihv-.*"

[Brendan Donegan (brendan-donegan)]

316 - whitelist.insert(child->object_path,true);
317 + whitelist.insert(child->object_path, false);

I don't understand this change, can you explain it?

review: Needs Information

[Sylvain Pineau (sylvain-pineau)]

I can have multiple providers installed on my system, but since I restrict the whitelists shown in the SuiteSelection screen, I can only select/unselect the ones displayed. The rest of the whitelists were automatically selected by gui-engine. So by default nothing is selected and I let the application decide which ones to display/preselect (like the default.whitelist for ubuntu)

[Zygmunt Krynicki (zyga)]

http://bazaar.launchpad.net/~sylvain-pineau/checkbox/ui_profiles/revision/2798

Missing destructor for non-trivial constructor for QSettings

review: Needs Fixing

[Sylvain Pineau (sylvain-pineau)]

Added a destructor for the Settings class

review: Needs Resubmitting

[Zygmunt Krynicki (zyga)]

306 + ~Settings();

I'd mark that as virtual, I know we inherit from QObject but I think that's a good practice, anyway, +1

review: Approve

[lp:~sylvain-pineau/checkbox/ui_profiles]

2797. By Sylvain Pineau on 2014-03-18

checkbox-gui: Remove unused commandtool files

2798. By Sylvain Pineau on 2014-03-18

checkbox-gui:settings: Provide a QObject invokable wrapper for QSettings

Meant to be used from both the C++ code and the QML app.
The configuration file hosting all the application settings must be in the
INI-style format.
The first command-line parameter is the path to a such configuration file.

2799. By Sylvain Pineau on 2014-03-18

checkbox-gui:gui-engine.cpp: Insert whitelists but do not pre-select them

2800. By Sylvain Pineau on 2014-03-18

checkbox-gui:main.cpp: Use settings values/defaults

To customize the app title, the welcome text and the list of whitelists to
display (using a QRegExp filter).

=== modified file 'checkbox-gui/checkbox-gui/WhiteListModelFactory.cpp'
--- checkbox-gui/checkbox-gui/WhiteListModelFactory.cpp	2013-12-10 17:41:24 +0000
+++ checkbox-gui/checkbox-gui/WhiteListModelFactory.cpp	2014-03-18 16:22:23 +0000
@@ -21,7 +21,7 @@
 
 #include "WhiteListModelFactory.h"
 
-ListModel* WhiteListModelFactory::CreateWhiteListModel(ListModel *model)
+ListModel* WhiteListModelFactory::CreateWhiteListModel(ListModel *model, const QString &filter)
 {
     qDebug("WhiteListModelFactory::CreateWhiteListModel()");
 
@@ -53,15 +53,16 @@
 
     QMap<QDBusObjectPath,QString>::const_iterator iter = paths_and_names.begin();
 
+    QRegExp rx(filter);
+
     while(iter != paths_and_names.end() ) {
-
-        qDebug() << iter.key().path();
-
-        qDebug() << " Name: " << iter.value();
-
-        model->appendRow(new WhiteListItem(iter.value(), \
-                                           iter.key().path(), \
-                                           model));
+        if (rx.exactMatch(iter.value())) {
+            qDebug() << iter.key().path();
+            qDebug() << " Name: " << iter.value();
+            model->appendRow(new WhiteListItem(iter.value(), \
+                                               iter.key().path(), \
+                                               model));
+        }
         iter++;
     }
 
 
=== modified file 'checkbox-gui/checkbox-gui/WhiteListModelFactory.h'
--- checkbox-gui/checkbox-gui/WhiteListModelFactory.h	2013-12-10 17:41:24 +0000
+++ checkbox-gui/checkbox-gui/WhiteListModelFactory.h	2014-03-18 16:22:23 +0000
@@ -36,7 +36,7 @@
     ~WhiteListModelFactory() {};
 
 public slots:
-    ListModel* CreateWhiteListModel(ListModel* model=NULL);
+    ListModel* CreateWhiteListModel(ListModel* model=NULL, const QString &filter=QString());
 };
 
 #endif // WHITELISTMODELFACTORY_H
 
=== modified file 'checkbox-gui/checkbox-gui/checkbox-gui.pro'
--- checkbox-gui/checkbox-gui/checkbox-gui.pro	2013-12-10 17:41:24 +0000
+++ checkbox-gui/checkbox-gui/checkbox-gui.pro	2014-03-18 16:22:23 +0000
@@ -40,8 +40,8 @@
     whitelistitem.cpp \
     testitem.cpp \
     listmodel.cpp \
-    commandtool.cpp \
     testitemmodel.cpp \
+    settings.cpp \
     WhiteListModelFactory.cpp
 
 # Please do not modify the following two lines. Required for deployment.
@@ -61,8 +61,8 @@
 HEADERS += whitelistitem.h \
     testitem.h \
     listmodel.h \
-    commandtool.h \
     testitemmodel.h \
+    settings.h \
     WhiteListModelFactory.h
 
 target.path = $$PREFIX/bin
 
=== removed file 'checkbox-gui/checkbox-gui/commandtool.cpp'
--- checkbox-gui/checkbox-gui/commandtool.cpp	2013-07-24 15:21:15 +0000
+++ checkbox-gui/checkbox-gui/commandtool.cpp	1970-01-01 00:00:00 +0000
@@ -1,15 +0,0 @@
-#include "commandtool.h"
-
-CommandTool::CommandTool(QObject *parent) :
-    QObject(parent),
-    m_process(new QProcess(this))
-{
-}
-
-
-void CommandTool::exec(const QString& cmd, const QString& args)
-{
-    QStringList arguments;
-    arguments << args;
-    m_process->start(cmd, arguments);
-}
 
=== removed file 'checkbox-gui/checkbox-gui/commandtool.h'
--- checkbox-gui/checkbox-gui/commandtool.h	2013-12-10 17:41:24 +0000
+++ checkbox-gui/checkbox-gui/commandtool.h	1970-01-01 00:00:00 +0000
@@ -1,40 +0,0 @@
-/*
- * This file is part of Checkbox
- *
- * Copyright 2013 Canonical Ltd.
- *
- * Authors:
- * - Julia Segal <[e-mail]>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU 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 General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-#ifndef COMMANDTOOL_H
-#define COMMANDTOOL_H
-
-#include <QObject>
-#include <QProcess>
-#include <qdebug.h>
-
-class CommandTool : public QObject
-{
-    Q_OBJECT
-public:
-    explicit CommandTool(QObject *parent = 0);
-    Q_INVOKABLE void exec(const QString& cmd, const QString &args);
-
-private:
-    QProcess *m_process;
-};
-
-#endif // COMMAND_H
 
=== modified file 'checkbox-gui/checkbox-gui/main.cpp'
--- checkbox-gui/checkbox-gui/main.cpp	2014-01-29 10:00:26 +0000
+++ checkbox-gui/checkbox-gui/main.cpp	2014-03-18 16:22:23 +0000
@@ -28,9 +28,9 @@
 #include <QtQml>
 
 #include "qtquick2applicationviewer.h"
-#include "commandtool.h"
 #include "listmodel.h"
 #include "whitelistitem.h"
+#include "settings.h"
 #include "testitem.h"
 #include "testitemmodel.h"
 #include "WhiteListModelFactory.h"
@@ -61,10 +61,14 @@
     // Initialise - connect to Plainbox
     guiengine.Initialise();
 
+    Settings* settings;
+    settings = new Settings();
+    if (app.arguments().size() > 1) {
+        settings = new Settings(app.arguments().at(1));
+    }
+    viewer.rootContext()->setContextProperty("settings", settings);
 
-    // WhiteList Item Model Factory and placeholder model registered with QML engine
     WhiteListModelFactory whitelistfactory;
-    viewer.rootContext()->setContextProperty("whitelistitemFactory",&whitelistfactory);
 
     /* We need a placeholder object here or the QML integration is unhappy
      * that this isnt a recognisable Qt object.
@@ -76,10 +80,10 @@
         exit(1);
     }
 
+    whitelistfactory.CreateWhiteListModel(whitelistmodel, settings->value("welcome/whitelist_filter", ".*"));
+
     viewer.rootContext()->setContextProperty("whiteListModel", whitelistmodel);
 
-
-
     // Test Item Model Factory and placeholder model registered with QML engine
     TestItemModel testitemFactory;
     viewer.rootContext()->setContextProperty("testitemFactory",&testitemFactory);
@@ -96,14 +100,6 @@
 
     viewer.rootContext()->setContextProperty("testListModel", testlistmodel);
 
-
-
-    // We may not need this at all
-    CommandTool cmdTool;
-    viewer.rootContext()->setContextProperty("cmdTool", &cmdTool);
-
-
-
      // In the beginning, lets see if we need to resume
     bool resumeSession = false;
 
@@ -124,7 +120,7 @@
     // Now, load the main page
     viewer.setMainQmlFile(QStringLiteral("../share/checkbox-gui/qml/checkbox-gui.qml"));
 
-    viewer.setTitle(app.tr("System Testing"));
+    viewer.setTitle(settings->value("welcome/title", app.tr("System Testing")));
 
     // Ensure a reasonable minimum size for this window
     viewer.setMinimumSize(QSize(800,600));
 
=== modified file 'checkbox-gui/checkbox-gui/qml/SuiteSelectionView.qml'
--- checkbox-gui/checkbox-gui/qml/SuiteSelectionView.qml	2014-03-05 10:38:05 +0000
+++ checkbox-gui/checkbox-gui/qml/SuiteSelectionView.qml	2014-03-18 16:22:23 +0000
@@ -135,9 +135,6 @@
 
             suitelist.visible = false;
 
-            // Dump the whitelist as finally selected by the user
-            guiEngine.dump_whitelist_selection();
-
             /* Now, we should go run the guiengine update to run the local jobs
               which happen to match the whitelist. Then we can collect the
               test jobs and show them to the user.
 
=== modified file 'checkbox-gui/checkbox-gui/qml/WelcomeView.qml'
--- checkbox-gui/checkbox-gui/qml/WelcomeView.qml	2014-02-19 11:31:39 +0000
+++ checkbox-gui/checkbox-gui/qml/WelcomeView.qml	2014-03-18 16:22:23 +0000
@@ -26,7 +26,7 @@
 
 Page {
     id: welcomePage
-    title: i18n.tr("System Testing")
+    title: settings.value("welcome/title", i18n.tr("System Testing"));
 
     tools: ToolbarItems {
         locked: true
@@ -87,9 +87,8 @@
                     margins: units.gu(2)
                 }
 
-                // TODO load text from Plainbox
                 // TRANSLATORS: The <p> tags are HTML - DO NOT translate them.
-                text: i18n.tr("<p>Welcome to System Testing.</p><p></p><p>This program contains automated and manual tests to help you assess how well your system works with Ubuntu.</p><p></p><p>This application will step the user through these tests in a predetermined order and automatically collect both system information as well as test results. It will also prompt the user for input when manual testing is required.</p><p></p><p>The run time for the tests is determined by which tests you decide to execute. The user will have the opportunity to customize the test run based on the hardware components they are interested in and the amount of time they have available.</p><p></p><p>To begin, simply click the Continue button below and follow the onscreen instructions.</p><p></p>")
+                text: settings.value("welcome/text", i18n.tr("<p>Welcome to System Testing.</p><p></p><p>This program contains automated and manual tests to help you assess how well your system works with Ubuntu.</p><p></p><p>This application will step the user through these tests in a predetermined order and automatically collect both system information as well as test results. It will also prompt the user for input when manual testing is required.</p><p></p><p>The run time for the tests is determined by which tests you decide to execute. The user will have the opportunity to customize the test run based on the hardware components they are interested in and the amount of time they have available.</p><p></p><p>To begin, simply click the Continue button below and follow the onscreen instructions.</p><p></p>"))
 
                 height: units.gu(60)
                 width: units.gu(30)
@@ -127,9 +126,6 @@
         text: i18n.tr("Continue")
         color: UbuntuColors.lightAubergine
         onClicked: {
-            // Generate the the list of whitelists
-            whitelistitemFactory.CreateWhiteListModel(whiteListModel);
-
             // Move to the whitelist selection screen
             mainView.state = "SUITESELECTION"
         }
 
=== added file 'checkbox-gui/checkbox-gui/settings.cpp'
--- checkbox-gui/checkbox-gui/settings.cpp	1970-01-01 00:00:00 +0000
+++ checkbox-gui/checkbox-gui/settings.cpp	2014-03-18 16:22:23 +0000
@@ -0,0 +1,26 @@
+#include <QDebug>
+#include <QStringList>
+#include "settings.h"
+
+Settings::Settings(QObject *parent) : QObject(parent)
+{
+    m_settings = new QSettings();
+}
+
+Settings::Settings(const QString &fileName, QObject *parent) : QObject(parent)
+{
+    m_settings = new QSettings(fileName, QSettings::NativeFormat);
+}
+
+void Settings::setValue(const QString &key, const QVariant &value) {
+    m_settings->setValue(key, value);
+}
+
+QString Settings::value(const QString &key, const QString &defaultValue) const {
+    return m_settings->value(key, defaultValue).toStringList().at(0);
+}
+
+Settings::~Settings()
+{
+  delete m_settings;
+}
 
=== added file 'checkbox-gui/checkbox-gui/settings.h'
--- checkbox-gui/checkbox-gui/settings.h	1970-01-01 00:00:00 +0000
+++ checkbox-gui/checkbox-gui/settings.h	2014-03-18 16:22:23 +0000
@@ -0,0 +1,24 @@
+#ifndef SETTINGS_H
+#define SETTINGS_H
+
+#include <QObject>
+#include <QSettings>
+
+class Settings : public QObject
+{
+    Q_OBJECT
+
+public:
+    Settings(QObject *parent = 0);
+    explicit Settings(const QString & filename, QObject *parent = 0);
+    ~Settings();
+
+public slots:
+    void setValue(const QString & key, const QVariant & value);
+    QString value(const QString &key, const QString &defaultValue = QString()) const;
+
+private:
+    QSettings* m_settings;
+};
+
+#endif // SETTINGS_H
 
=== modified file 'checkbox-gui/gui-engine/gui-engine.cpp'
--- checkbox-gui/gui-engine/gui-engine.cpp	2014-03-18 15:54:05 +0000
+++ checkbox-gui/gui-engine/gui-engine.cpp	2014-03-18 16:22:23 +0000
@@ -490,7 +490,7 @@
 
             // First time round, fill in our whitelist member
             if (!initialised) {
-                whitelist.insert(child->object_path,true);
+                whitelist.insert(child->object_path, false);
             }
         }
 
@@ -507,22 +507,6 @@
     whitelist.insert(opath,check);
 }
 
-// temporary helper
-void GuiEngine::dump_whitelist_selection(void)
-{
-    // loop around all the children
-    QMap<QDBusObjectPath,bool>::const_iterator iter = whitelist.begin();
-
-    while(iter != whitelist.end() ) {
-
-        bool yes = iter.value();
-
-        qDebug() << iter.key().path() << (yes ? "Yes" : "No");
-
-        iter++;
-    }
-}
-
 void GuiEngine::Pause(void)
 {
     // Very simple
 
=== modified file 'checkbox-gui/gui-engine/gui-engine.h'
--- checkbox-gui/gui-engine/gui-engine.h	2014-03-18 15:54:05 +0000
+++ checkbox-gui/gui-engine/gui-engine.h	2014-03-18 16:22:23 +0000
@@ -131,9 +131,6 @@
         /* Helper functions for logging and testing
          */
 
-        // Logging function
-        void dump_whitelist_selection(void);
-
         // Used by the test program test-gui-engine
         void AcknowledgeJobsDone(void);
         void AcknowledgeLocalJobsDone(void);