Merge lp:~zsombi/ubuntu-ui-toolkit/serviceproperties-warnings into lp:ubuntu-ui-toolkit/staging

[Zsombor Egri]

Turning warnings to be reported in the error property. SHOW_SERVICEPROPERTIES_WARNINGS environment variable set will display them in the console.

[Cris Dywan (kalikiana)]

Very nice! Thanks a lot!

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== modified file 'modules/Ubuntu/Components/plugin/ucserviceproperties.cpp'
--- modules/Ubuntu/Components/plugin/ucserviceproperties.cpp	2015-02-04 07:14:04 +0000
+++ modules/Ubuntu/Components/plugin/ucserviceproperties.cpp	2015-02-19 10:00:30 +0000
@@ -41,11 +41,16 @@
 
 void UCServicePropertiesPrivate::warning(const QString &message)
 {
-    QByteArray suppressWarnings = qgetenv("SUPPRESS_SERVICEPROPERTIES_WARNINGS");
-    if ((suppressWarnings == "yes") || (suppressWarnings == "1")) {
-        return;
-    }
-    qmlInfo(q_ptr) << message;
+    // append warning messages to the error string
+    if (error.isEmpty()) {
+        setError(message);
+    } else {
+        setError(QString("%1\n%2").arg(error).arg(message));
+    }
+    QString env = qgetenv("SHOW_SERVICEPROPERTIES_WARNINGS");
+    if (!env.isEmpty() && (env == "1" || env.toLower() == "true")) {
+        qmlInfo(q_ptr) << message;
+    }
 }
 
 void UCServicePropertiesPrivate::setError(const QString &msg)

=== modified file 'tests/unit/runtest.sh'
--- tests/unit/runtest.sh	2015-02-18 15:39:38 +0000
+++ tests/unit/runtest.sh	2015-02-19 10:00:30 +0000
@@ -63,7 +63,6 @@
 	
     QML2_IMPORT_PATH=${_IMPORT_PATH} UBUNTU_UI_TOOLKIT_THEMES_PATH=${_THEMES_PATH} \
     ALARM_BACKEND=memory \
-    SUPPRESS_SERVICEPROPERTIES_WARNINGS=yes \
     $_CMD $_ARGS 2>&1 | grep -v 'QFontDatabase: Cannot find font directory'
     # Note: Get first command before the pipe, $? would be ambiguous
     RESULT=${PIPESTATUS[0]}

=== modified file 'tests/unit_x11/tst_serviceproperties/tst_serviceproperties.cpp'
--- tests/unit_x11/tst_serviceproperties/tst_serviceproperties.cpp	2014-12-03 12:55:58 +0000
+++ tests/unit_x11/tst_serviceproperties/tst_serviceproperties.cpp	2015-02-19 10:00:30 +0000
@@ -62,6 +62,12 @@
         }
     }
 
+    void cleanup()
+    {
+        // restore env var setting
+        qputenv("SHOW_SERVICEPROPERTIES_WARNINGS", QByteArray());
+    }
+
     void test_change_property()
     {
         if (!error.isEmpty()) {
@@ -85,40 +91,100 @@
         spy.wait(400);
     }
 
+    void test_environment_variable_data()
+    {
+        QTest::addColumn<QByteArray>("value");
+        QTest::addColumn<bool>("warning");
+
+        QTest::newRow("empty string, no warning") << QByteArray() << false;
+        QTest::newRow("0 integer, no warning") << QByteArray("0") << false;
+        QTest::newRow("boolean false, no warning") << QByteArray("false") << false;
+        QTest::newRow("boolean FALSE, no warning") << QByteArray("false") << false;
+        QTest::newRow("1 integer, warning") << QByteArray("1") << true;
+        QTest::newRow("boolean true, warning") << QByteArray("true") << true;
+        QTest::newRow("boolean TRUE, warning") << QByteArray("true") << true;
+        QTest::newRow("positive integer, no warning") << QByteArray("5") << false;
+        QTest::newRow("invalid integral value, no warning") << QByteArray("whatever") << false;
+    }
+
+    void test_environment_variable()
+    {
+        if (!error.isEmpty()) {
+            QSKIP(qPrintable(error));
+        }
+        QFETCH(QByteArray, value);
+        QFETCH(bool, warning);
+        qputenv("SHOW_SERVICEPROPERTIES_WARNINGS", value);
+        if (warning) {
+            ignoreWarning("InvalidPropertyWatcher.qml", 22, 5, "QML ServiceProperties: No such property 'ThisIsAnInvalidPropertyToWatch'");
+        }
+        QScopedPointer<UbuntuTestCase> test(new UbuntuTestCase("InvalidPropertyWatcher.qml"));
+        UCServiceProperties *watcher = static_cast<UCServiceProperties*>(test->rootObject()->property("service").value<QObject*>());
+        QVERIFY(watcher);
+        // error should contain the warning
+        QCOMPARE(watcher->property("error").toString(), QString("No such property 'ThisIsAnInvalidPropertyToWatch'"));
+    }
+
+    void test_invalid_property_data()
+    {
+        QTest::addColumn<bool>("warning");
+
+        QTest::newRow("Without warning") << false;
+        QTest::newRow("With warning") << true;
+    }
     void test_invalid_property()
     {
         if (!error.isEmpty()) {
             QSKIP(qPrintable(error));
         }
-        ignoreWarning("InvalidPropertyWatcher.qml", 22, 5, "QML ServiceProperties: No such property 'ThisIsAnInvalidPropertyToWatch'");
+        QFETCH(bool, warning);
+        qputenv("SHOW_SERVICEPROPERTIES_WARNINGS", warning ? "1" : "0");
+        if (warning) {
+            ignoreWarning("InvalidPropertyWatcher.qml", 22, 5, "QML ServiceProperties: No such property 'ThisIsAnInvalidPropertyToWatch'");
+        }
         QScopedPointer<UbuntuTestCase> test(new UbuntuTestCase("InvalidPropertyWatcher.qml"));
         UCServiceProperties *watcher = static_cast<UCServiceProperties*>(test->rootObject()->property("service").value<QObject*>());
         QVERIFY(watcher);
-        // error should not be set
-        QCOMPARE(watcher->property("error").toString(), QString());
-    }
-
+        // error should contain the warning
+        QCOMPARE(watcher->property("error").toString(), QString("No such property 'ThisIsAnInvalidPropertyToWatch'"));
+    }
+
+    void test_one_valid_one_invalid_property_data()
+    {
+        QTest::addColumn<bool>("warning");
+
+        QTest::newRow("Without warning") << false;
+        QTest::newRow("With warning") << true;
+    }
     void test_one_valid_one_invalid_property()
     {
         if (!error.isEmpty()) {
             QSKIP(qPrintable(error));
         }
-        ignoreWarning("InvalidPropertyWatcher2.qml", 22, 5, "QML ServiceProperties: No such property 'ThisIsAnInvalidPropertyToWatch'");
+        QFETCH(bool, warning);
+        qputenv("SHOW_SERVICEPROPERTIES_WARNINGS", warning ? "1" : "0");
+        if (warning) {
+            ignoreWarning("InvalidPropertyWatcher2.qml", 22, 5, "QML ServiceProperties: No such property 'ThisIsAnInvalidPropertyToWatch'");
+        }
         QScopedPointer<UbuntuTestCase> test(new UbuntuTestCase("InvalidPropertyWatcher2.qml"));
         UCServiceProperties *watcher = static_cast<UCServiceProperties*>(test->rootObject()->property("service").value<QObject*>());
         QVERIFY(watcher);
-        // error should not be set
-        QCOMPARE(watcher->property("error").toString(), QString());
+        // error should contain the wearning
+        QCOMPARE(watcher->property("error").toString(), QString("No such property 'ThisIsAnInvalidPropertyToWatch'"));
     }
 
     void test_change_connection_props_data()
     {
         QTest::addColumn<QString>("property");
         QTest::addColumn<QString>("value");
+        QTest::addColumn<bool>("warning");
 
-        QTest::newRow("Changing servcie") << "service" << "anything.else";
-        QTest::newRow("Changing interface") << "serviceInterface" << "anything.else";
-        QTest::newRow("Changing adaptor") << "adaptorInterface" << "anything.else";
+        QTest::newRow("Changing servcie, no warning") << "service" << "anything.else" << false;
+        QTest::newRow("Changing servcie, with warning") << "service" << "anything.else" << true;
+        QTest::newRow("Changing interface, no warning") << "serviceInterface" << "anything.else" << false;
+        QTest::newRow("Changing interface, with warning") << "serviceInterface" << "anything.else" << true;
+        QTest::newRow("Changing adaptor, no warning") << "adaptorInterface" << "anything.else" << false;
+        QTest::newRow("Changing adaptor, with warning") << "adaptorInterface" << "anything.else" << true;
     }
     void test_change_connection_props()
     {
@@ -128,15 +194,19 @@
         if (!error.isEmpty()) {
             QSKIP(qPrintable(error));
         }
-        ignoreWarning("IncomingCallVibrateWatcher.qml", 22, 5, "QML ServiceProperties: Changing connection parameters forbidden.");
+        QFETCH(bool, warning);
+        qputenv("SHOW_SERVICEPROPERTIES_WARNINGS", warning ? "1" : "0");
+        if (warning) {
+            ignoreWarning("IncomingCallVibrateWatcher.qml", 22, 5, "QML ServiceProperties: Changing connection parameters forbidden.");
+        }
         QScopedPointer<UbuntuTestCase> test(new UbuntuTestCase("IncomingCallVibrateWatcher.qml"));
         UCServiceProperties *watcher = static_cast<UCServiceProperties*>(test->rootObject()->property("service").value<QObject*>());
         QVERIFY(watcher);
 
         // try to change the property
         watcher->setProperty(property.toLocal8Bit().constData(), value);
-        // no error should be reported
-        QCOMPARE(watcher->property("error").toString(), QString());
+        // error shoudl also have the warning
+        QCOMPARE(watcher->property("error").toString(), QString("Changing connection parameters forbidden."));
     }
 
 };