Merge lp:~boiko/telephony-service/test_tone_generator into lp:telephony-service

[Gustavo Pichorim Boiko]

Add unit tests for the ToneGenerator class.

Add unit tests for the ToneGenerator class.

== Checklist ==
Are there any related MPs required for this MP to build/function as expected? Please list.
Yes: https://code.launchpad.net/~vicamo/telephony-service/send-stop-tone-at-last/+merge/248214

Is your branch in sync with latest trunk (e.g. bzr pull lp:trunk -> no changes)
Yes

Did you perform an exploratory manual test run of your code change and any related functionality on device or emulator?
Yes

Did you successfully run all tests found in your component's Test Plan (https://wiki.ubuntu.com/Process/Merges/TestPlan/<package-name>) on device or emulator?
Yes

If you changed the UI, was the change specified/approved by design?
N/A

If you changed UI labels, did you update the pot file?
N/A

If you changed the packaging (debian), did you add a core-dev as a reviewer to this MP?
N/A

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1056
http://jenkins.qa.ubuntu.com/job/telephony-service-ci/419/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/telephony-service-vivid-amd64-ci/87
    FAILURE: http://jenkins.qa.ubuntu.com/job/telephony-service-vivid-armhf-ci/87/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/telephony-service-vivid-i386-ci/87

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/telephony-service-ci/419/rebuild

review: Needs Fixing (continuous-integration)

[Tiago Salem Herrmann (tiagosh)]

Looks good.

--checklist--
Did you perform an exploratory manual test run of the code change and any related functionality on device or emulator?
Yes

Did CI run pass? If not, please explain why.
No, not related to the changes

Have you checked that submitter has accurately filled out the submitter checklist and has taken no shortcut?
Yes

review: Approve

=== modified file '.bzrignore'
--- .bzrignore	2015-03-06 19:27:55 +0000
+++ .bzrignore	2015-04-16 21:40:33 +0000
@@ -48,6 +48,9 @@
 tests/common/dbus-test-wrapper.sh
 tests/common/mock/mockconnectionadaptor.*
 tests/common/mock/telepathy-mock
+tests/common/dbus-session.conf
+tests/common/dbus-services/*
 tests/Ubuntu.Telephony/ContactWatcherTest
 tests/libtelephonyservice/GreeterContactsTestExe
 tests/libtelephonyservice/GreeterContactsTestServerExe
+tests/libtelephonyservice/ToneGeneratorMock

=== modified file 'libtelephonyservice/tonegenerator.cpp'
--- libtelephonyservice/tonegenerator.cpp	2015-04-16 21:40:33 +0000
+++ libtelephonyservice/tonegenerator.cpp	2015-04-16 21:40:33 +0000
@@ -108,7 +108,7 @@
         stopTone();
     }
 
-    if (startEventTone((uint)79)) {
+    if (startEventTone(WAITING_TONE)) {
         mWaitingPlaybackTimer->start(WAITING_PLAYBACK_DURATION);
     }
 }
@@ -121,6 +121,6 @@
 
 void ToneGenerator::playCallEndedTone()
 {
-    startEventTone((uint)257);
+    startEventTone(CALL_ENDED_TONE);
     QTimer::singleShot(2000, this, SLOT(stopTone()));
 }

=== modified file 'libtelephonyservice/tonegenerator.h'
--- libtelephonyservice/tonegenerator.h	2014-10-15 22:10:45 +0000
+++ libtelephonyservice/tonegenerator.h	2015-04-16 21:40:33 +0000
@@ -29,6 +29,8 @@
 
 static const int DTMF_LOCAL_PLAYBACK_DURATION = 200; /* in milliseconds */
 static const int WAITING_PLAYBACK_DURATION = 8000; /* in milliseconds */
+static const uint WAITING_TONE = 79;
+static const uint CALL_ENDED_TONE = 257;
 
 class ToneGenerator : public QObject
 {

=== modified file 'tests/libtelephonyservice/CMakeLists.txt'
--- tests/libtelephonyservice/CMakeLists.txt	2015-03-20 21:50:47 +0000
+++ tests/libtelephonyservice/CMakeLists.txt	2015-04-16 21:40:33 +0000
@@ -9,15 +9,25 @@
 add_executable(GreeterContactsTestServerExe GreeterContactsTestServer.cpp)
 qt5_use_modules(GreeterContactsTestServerExe Core DBus)
 
+add_executable(ToneGeneratorMock ToneGeneratorMock.cpp)
+qt5_use_modules(ToneGeneratorMock Core DBus)
+
 generate_test(GreeterContactsTest USE_DBUS
               SOURCES GreeterContactsTest.cpp ${LIBTELEPHONYSERVICE_DIR}/greetercontacts.cpp
               QT5_MODULES Contacts Core DBus Test
               ENVIRONMENT XDG_SESSION_CLASS=greeter XDG_GREETER_DATA_DIR=${CMAKE_BINARY_DIR}/Testing/Temporary
-              TASKS --task env --ignore-return --task ${CMAKE_CURRENT_BINARY_DIR}/GreeterContactsTestServerExe --task-name server --ignore-return
+              TASKS --task ${CMAKE_CURRENT_BINARY_DIR}/GreeterContactsTestServerExe --task-name server --ignore-return
               WAIT_FOR org.freedesktop.Accounts)
 set_target_properties(GreeterContactsTest PROPERTIES COMPILE_DEFINITIONS "AS_BUSNAME=sessionBus;CMAKE_SOURCE_DIR=\"${CMAKE_SOURCE_DIR}\"")
 add_dependencies(GreeterContactsTest GreeterContactsTestServerExe)
 
+generate_test(ToneGeneratorTest USE_DBUS
+              SOURCES ToneGeneratorTest.cpp ${LIBTELEPHONYSERVICE_DIR}/tonegenerator.cpp
+              QT5_MODULES Core DBus Test
+              TASKS --task ${CMAKE_CURRENT_BINARY_DIR}/ToneGeneratorMock --task-name tone-gen --ignore-return
+              WAIT_FOR com.Nokia.Telephony.Tones)
+add_dependencies(ToneGeneratorTest ToneGeneratorMock)
+
 generate_test(ContactUtilsTest SOURCES ContactUtilsTest.cpp QT5_MODULES Contacts Core Test LIBRARIES telephonyservice USE_UI)
 generate_test(PhoneUtilsTest SOURCES PhoneUtilsTest.cpp LIBRARIES telephonyservice USE_UI)
 

=== added file 'tests/libtelephonyservice/ToneGeneratorMock.cpp'
--- tests/libtelephonyservice/ToneGeneratorMock.cpp	1970-01-01 00:00:00 +0000
+++ tests/libtelephonyservice/ToneGeneratorMock.cpp	2015-04-16 21:40:33 +0000
@@ -0,0 +1,66 @@
+/*
+ * Copyright (C) 2015 Canonical, Ltd.
+ *
+ * This file is part of telephony-service.
+ *
+ * telephony-service 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.
+ *
+ * telephony-service 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/>.
+ */
+
+#include <QObject>
+#include <QCoreApplication>
+#include <QDBusConnection>
+#include <QDBusMessage>
+#include <QDBusObjectPath>
+#include <QDebug>
+
+#define TONEGEN_DBUS_SERVICE_NAME "com.Nokia.Telephony.Tones"
+#define TONEGEN_DBUS_OBJ_PATH "/com/Nokia/Telephony/Tones"
+
+class ToneGeneratorMock : public QObject
+{
+    Q_OBJECT
+    Q_CLASSINFO("D-Bus Interface", TONEGEN_DBUS_SERVICE_NAME)
+
+public:
+    Q_SCRIPTABLE void StartEventTone(uint key, int volume, uint duration);
+    Q_SCRIPTABLE void StopTone();
+
+Q_SIGNALS:
+    Q_SCRIPTABLE void StartEventToneRequested(uint key, int volume, uint duration);
+    Q_SCRIPTABLE void StopToneRequested();
+};
+
+void ToneGeneratorMock::StartEventTone(uint key, int volume, uint duration)
+{
+    Q_EMIT StartEventToneRequested(key, volume, duration);
+}
+
+void ToneGeneratorMock::StopTone()
+{
+    Q_EMIT StopToneRequested();
+}
+
+int main(int argc, char **argv)
+{
+    QCoreApplication a(argc, argv);
+
+    QDBusConnection connection = QDBusConnection::sessionBus();
+
+    ToneGeneratorMock toneGen;
+    connection.registerObject(TONEGEN_DBUS_OBJ_PATH, &toneGen, QDBusConnection::ExportScriptableContents);
+    connection.registerService(TONEGEN_DBUS_SERVICE_NAME);
+
+    return a.exec();
+}
+
+#include "ToneGeneratorMock.moc"

=== added file 'tests/libtelephonyservice/ToneGeneratorTest.cpp'
--- tests/libtelephonyservice/ToneGeneratorTest.cpp	1970-01-01 00:00:00 +0000
+++ tests/libtelephonyservice/ToneGeneratorTest.cpp	2015-04-16 21:40:33 +0000
@@ -0,0 +1,134 @@
+/*
+ * Copyright (C) 2015 Canonical, Ltd.
+ *
+ * This file is part of telephony-service.
+ *
+ * telephony-service 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.
+ *
+ * telephony-service 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/>.
+ */
+
+#include <QtCore/QObject>
+#include <QtTest/QtTest>
+#include <QDBusInterface>
+
+#include "tonegenerator.h"
+
+#define TONEGEN_DBUS_SERVICE_NAME "com.Nokia.Telephony.Tones"
+#define TONEGEN_DBUS_OBJ_PATH "/com/Nokia/Telephony/Tones"
+
+class ToneGeneratorTest : public QObject
+{
+    Q_OBJECT
+
+private Q_SLOTS:
+    void initTestCase();
+    void cleanupTestCase();
+    void cleanup();
+    void testSingleTone_data();
+    void testSingleTone();
+    void testMultipleTones();
+    void testWaitingTone();
+    void testCallEndedTone();
+
+private:
+    QDBusInterface *mToneInterface;
+    QSignalSpy *mStartToneSpy;
+    QSignalSpy *mStopToneSpy;
+};
+
+void ToneGeneratorTest::initTestCase()
+{
+    mToneInterface = new QDBusInterface(TONEGEN_DBUS_SERVICE_NAME,
+                                        TONEGEN_DBUS_OBJ_PATH,
+                                        TONEGEN_DBUS_SERVICE_NAME,
+                                        QDBusConnection::sessionBus(),
+                                        this);
+
+    mStartToneSpy = new QSignalSpy(mToneInterface, SIGNAL(StartEventToneRequested(uint, int, uint)));
+    mStopToneSpy = new QSignalSpy(mToneInterface,SIGNAL(StopToneRequested()));
+}
+
+void ToneGeneratorTest::cleanupTestCase()
+{
+    mToneInterface->deleteLater();
+    mStartToneSpy->deleteLater();
+    mStopToneSpy->deleteLater();
+}
+
+void ToneGeneratorTest::cleanup()
+{
+    mStartToneSpy->clear();
+    mStopToneSpy->clear();
+}
+
+void ToneGeneratorTest::testSingleTone_data()
+{
+    QTest::addColumn<uint>("key");
+
+    QTest::newRow("0") << (uint)0;
+    QTest::newRow("1") << (uint)1;
+    QTest::newRow("2") << (uint)2;
+    QTest::newRow("3") << (uint)3;
+    QTest::newRow("4") << (uint)4;
+    QTest::newRow("5") << (uint)5;
+    QTest::newRow("6") << (uint)6;
+    QTest::newRow("7") << (uint)7;
+    QTest::newRow("8") << (uint)8;
+    QTest::newRow("9") << (uint)9;
+    QTest::newRow("10") << (uint)10;
+    QTest::newRow("11") << (uint)11;
+}
+
+void ToneGeneratorTest::testSingleTone()
+{
+    QFETCH(uint, key);
+
+    ToneGenerator::instance()->playDTMFTone(key);
+    QTRY_COMPARE(mStartToneSpy->count(), 1);
+    QCOMPARE(mStartToneSpy->first()[0].toUInt(), key);
+
+    QTRY_COMPARE(mStopToneSpy->count(), 1);
+}
+
+void ToneGeneratorTest::testMultipleTones()
+{
+    int count = 12;
+    for (uint key = 0; key < count; ++key) {
+        ToneGenerator::instance()->playDTMFTone(key);
+    }
+
+    QTRY_COMPARE(mStartToneSpy->count(), count);
+    QTRY_COMPARE(mStopToneSpy->count(), 1);
+}
+
+void ToneGeneratorTest::testWaitingTone()
+{
+    ToneGenerator::instance()->playWaitingTone();
+    QTRY_COMPARE(mStartToneSpy->count(), 1);
+    QCOMPARE(mStartToneSpy->first()[0].toUInt(), WAITING_TONE);
+
+    ToneGenerator::instance()->stopWaitingTone();
+    QTRY_COMPARE(mStopToneSpy->count(), 1);
+}
+
+void ToneGeneratorTest::testCallEndedTone()
+{
+    ToneGenerator::instance()->playCallEndedTone();
+
+    QTRY_COMPARE(mStartToneSpy->count(), 1);
+    QCOMPARE(mStartToneSpy->first()[0].toUInt(), CALL_ENDED_TONE);
+
+    QTRY_COMPARE(mStopToneSpy->count(), 1);
+}
+
+QTEST_MAIN(ToneGeneratorTest)
+#include "ToneGeneratorTest.moc"