Added presence notifier.

author: Remko Tronçon <git@el-tramo.be> 2010-09-12 18:29:39 (GMT)
committer: Remko Tronçon <git@el-tramo.be> 2010-09-13 19:19:52 (GMT)
commit: ef1052bbdb315aaa1c6254098ea05638d9a25b2f (patch)
tree: 482277f649f6c0fc00027514ea8986861fe33437 /Swift/Controllers/UnitTest
parent: 3ae8cccfe9c6bfed5dda5f024a5cb046ccfc9793 (diff)
download: swift-ef1052bbdb315aaa1c6254098ea05638d9a25b2f.zip
swift-ef1052bbdb315aaa1c6254098ea05638d9a25b2f.tar.bz2
4 files changed, 322 insertions, 8 deletions
diff --git a/Swift/Controllers/UnitTest/NickResolverTest.cpp b/Swift/Controllers/UnitTest/NickResolverTest.cpp
index dfb459f..f42a28a 100644
--- a/Swift/Controllers/UnitTest/NickResolverTest.cpp
+++ b/Swift/Controllers/UnitTest/NickResolverTest.cpp
@@ -35,7 +35,7 @@ class NickResolverTest : public CppUnit::TestFixture {
 	public:
 		void setUp() {
 			ownJID_ = JID("kev@wonderland.lit");
-			xmppRoster_ = boost::shared_ptr<XMPPRoster>(new XMPPRoster());
+			xmppRoster_ = new XMPPRoster();
 			stanzaChannel_ = new DummyStanzaChannel();
 		  iqRouter_ = new IQRouter(stanzaChannel_);
 			vCardStorage_ = new VCardMemoryStorage();
@@ -135,7 +135,7 @@ class NickResolverTest : public CppUnit::TestFixture {
 	
 	private:
 		std::vector<String> groups_;
-		boost::shared_ptr<XMPPRoster> xmppRoster_;
+		XMPPRoster* xmppRoster_;
 		VCardStorage* vCardStorage_;
 		IQRouter* iqRouter_;
 		DummyStanzaChannel* stanzaChannel_;
diff --git a/Swift/Controllers/UnitTest/PresenceNotifierTest.cpp b/Swift/Controllers/UnitTest/PresenceNotifierTest.cpp
new file mode 100644
index 0000000..85433f3
--- /dev/null
+++ b/Swift/Controllers/UnitTest/PresenceNotifierTest.cpp
@@ -0,0 +1,310 @@
+/*
+ * Copyright (c) 2010 Remko Tronçon
+ * Licensed under the GNU General Public License v3.
+ * See Documentation/Licenses/GPLv3.txt for more information.
+ */
+
+#include <cppunit/extensions/HelperMacros.h>
+#include <cppunit/extensions/TestFactoryRegistry.h>
+#include <vector>
+#include <boost/bind.hpp>
+
+#include "Swift/Controllers/PresenceNotifier.h"
+#include "SwifTools/Notifier/LoggingNotifier.h"
+#include "Swiften/Client/DummyStanzaChannel.h"
+#include "Swiften/MUC/MUCRegistry.h"
+#include "Swiften/Roster/XMPPRoster.h"
+#include "Swiften/Presence/PresenceOracle.h"
+#include "Swiften/Avatars/DummyAvatarManager.h"
+#include "Swiften/Network/DummyTimerFactory.h"
+
+using namespace Swift;
+
+class PresenceNotifierTest : public CppUnit::TestFixture {
+		CPPUNIT_TEST_SUITE(PresenceNotifierTest);
+		CPPUNIT_TEST(testReceiveFirstPresenceCreatesAvailableNotification);
+		CPPUNIT_TEST(testReceiveSecondPresenceCreatesStatusChangeNotification);
+		CPPUNIT_TEST(testReceiveUnavailablePresenceAfterAvailablePresenceCreatesUnavailableNotification);
+		CPPUNIT_TEST(testReceiveUnavailablePresenceWithoutAvailableDoesNotCreateNotification);
+		CPPUNIT_TEST(testReceiveAvailablePresenceAfterUnavailableCreatesAvailableNotification);
+		CPPUNIT_TEST(testReceiveAvailablePresenceAfterReconnectCreatesAvailableNotification);
+		CPPUNIT_TEST(testReceiveAvailablePresenceFromMUCDoesNotCreateNotification);
+		CPPUNIT_TEST(testNotificationSubjectContainsNameForJIDInRoster);
+		CPPUNIT_TEST(testNotificationSubjectContainsJIDForJIDNotInRoster);
+		CPPUNIT_TEST(testNotificationSubjectContainsStatus);
+		CPPUNIT_TEST(testNotificationMessageContainsStatusMessage);
+		CPPUNIT_TEST(testNotificationPicture);
+		CPPUNIT_TEST(testNotificationActivationEmitsSignal);
+		CPPUNIT_TEST(testReceiveFirstPresenceWithQuietPeriodDoesNotNotify);
+		CPPUNIT_TEST(testReceiveFirstPresenceWithQuietPeriodDoesNotCountAsQuietPeriod);
+		CPPUNIT_TEST(testReceivePresenceDuringQuietPeriodDoesNotNotify);
+		CPPUNIT_TEST(testReceivePresenceDuringQuietPeriodResetsTimer);
+		CPPUNIT_TEST(testReceivePresenceAfterQuietPeriodNotifies);
+		CPPUNIT_TEST(testReceiveFirstPresenceAfterReconnectWithQuietPeriodDoesNotNotify);
+		CPPUNIT_TEST_SUITE_END();
+
+	public:
+		void setUp() {
+			stanzaChannel = new DummyStanzaChannel();
+			notifier = new LoggingNotifier();
+			mucRegistry = new MUCRegistry();
+			user1 = JID("user1@bar.com/bla");
+			user2 = JID("user2@foo.com/baz");
+			avatarManager = new DummyAvatarManager();
+			roster = new XMPPRoster();
+			presenceOracle = new PresenceOracle(stanzaChannel);
+			timerFactory = new DummyTimerFactory();
+		}
+
+		void tearDown() {
+			delete presenceOracle;
+			delete roster;
+			delete avatarManager;
+			delete mucRegistry;
+			delete notifier;
+			delete stanzaChannel;
+		}
+
+		void testReceiveFirstPresenceCreatesAvailableNotification() {
+			std::auto_ptr<PresenceNotifier> testling = createNotifier();
+
+			sendPresence(user1, StatusShow::Online);
+
+			CPPUNIT_ASSERT_EQUAL(1, static_cast<int>(notifier->notifications.size()));
+			CPPUNIT_ASSERT_EQUAL(Notifier::ContactAvailable, notifier->notifications[0].type);
+		}
+
+		void testReceiveSecondPresenceCreatesStatusChangeNotification() {
+			std::auto_ptr<PresenceNotifier> testling = createNotifier();
+			sendPresence(user1, StatusShow::Away);
+			notifier->notifications.clear();
+
+			sendPresence(user1, StatusShow::Online);
+
+			CPPUNIT_ASSERT_EQUAL(1, static_cast<int>(notifier->notifications.size()));
+			CPPUNIT_ASSERT_EQUAL(Notifier::ContactStatusChange, notifier->notifications[0].type);
+		}
+
+		void testReceiveUnavailablePresenceAfterAvailablePresenceCreatesUnavailableNotification() {
+			std::auto_ptr<PresenceNotifier> testling = createNotifier();
+			sendPresence(user1, StatusShow::Away);
+			notifier->notifications.clear();
+
+			sendUnavailablePresence(user1);
+
+			CPPUNIT_ASSERT_EQUAL(1, static_cast<int>(notifier->notifications.size()));
+			CPPUNIT_ASSERT_EQUAL(Notifier::ContactUnavailable, notifier->notifications[0].type);
+		}
+
+		void testReceiveUnavailablePresenceWithoutAvailableDoesNotCreateNotification() {
+			std::auto_ptr<PresenceNotifier> testling = createNotifier();
+
+			sendUnavailablePresence(user1);
+
+			CPPUNIT_ASSERT_EQUAL(0, static_cast<int>(notifier->notifications.size()));
+		}
+
+		void testReceiveAvailablePresenceAfterUnavailableCreatesAvailableNotification() {
+			std::auto_ptr<PresenceNotifier> testling = createNotifier();
+			sendPresence(user1, StatusShow::Away);
+			sendUnavailablePresence(user1);
+			notifier->notifications.clear();
+
+			sendPresence(user1, StatusShow::Away);
+
+			CPPUNIT_ASSERT_EQUAL(1, static_cast<int>(notifier->notifications.size()));
+			CPPUNIT_ASSERT_EQUAL(Notifier::ContactAvailable, notifier->notifications[0].type);
+		}
+
+		void testReceiveAvailablePresenceAfterReconnectCreatesAvailableNotification() {
+			std::auto_ptr<PresenceNotifier> testling = createNotifier();
+			sendPresence(user1, StatusShow::Away);
+			stanzaChannel->setAvailable(false);
+			stanzaChannel->setAvailable(true);
+			notifier->notifications.clear();
+
+			sendPresence(user1, StatusShow::Away);
+
+			CPPUNIT_ASSERT_EQUAL(1, static_cast<int>(notifier->notifications.size()));
+			CPPUNIT_ASSERT_EQUAL(Notifier::ContactAvailable, notifier->notifications[0].type);
+		}
+
+		void testReceiveAvailablePresenceFromMUCDoesNotCreateNotification() {
+			std::auto_ptr<PresenceNotifier> testling = createNotifier();
+			mucRegistry->addMUC(JID("teaparty@wonderland.lit"));
+
+			sendPresence(JID("teaparty@wonderland.lit/Alice"), StatusShow::Away);
+
+			CPPUNIT_ASSERT_EQUAL(0, static_cast<int>(notifier->notifications.size()));
+		}
+
+		void testNotificationPicture() {
+			std::auto_ptr<PresenceNotifier> testling = createNotifier();
+			avatarManager->avatars[user1] = ByteArray("abcdef");
+
+			sendPresence(user1, StatusShow::Online);
+
+			CPPUNIT_ASSERT_EQUAL(1, static_cast<int>(notifier->notifications.size()));
+			CPPUNIT_ASSERT_EQUAL(ByteArray("abcdef"), notifier->notifications[0].picture);
+		}
+
+		void testNotificationActivationEmitsSignal() {
+			std::auto_ptr<PresenceNotifier> testling = createNotifier();
+
+			sendPresence(user1, StatusShow::Online);
+			CPPUNIT_ASSERT(notifier->notifications[0].callback);
+			notifier->notifications[0].callback();
+
+			CPPUNIT_ASSERT_EQUAL(1, static_cast<int>(activatedNotifications.size()));
+			CPPUNIT_ASSERT_EQUAL(user1, activatedNotifications[0]);
+		}
+
+		void testNotificationSubjectContainsNameForJIDInRoster() {
+			std::auto_ptr<PresenceNotifier> testling = createNotifier();
+			roster->addContact(user1.toBare(), "User 1", std::vector<String>(), RosterItemPayload::Both);
+
+			sendPresence(user1, StatusShow::Online);
+
+			CPPUNIT_ASSERT_EQUAL(1, static_cast<int>(notifier->notifications.size()));
+			CPPUNIT_ASSERT(notifier->notifications[0].subject.contains("User 1"));
+		}
+
+		void testNotificationSubjectContainsJIDForJIDNotInRoster() {
+			std::auto_ptr<PresenceNotifier> testling = createNotifier();
+
+			sendPresence(user1, StatusShow::Online);
+
+			CPPUNIT_ASSERT_EQUAL(1, static_cast<int>(notifier->notifications.size()));
+			CPPUNIT_ASSERT(notifier->notifications[0].subject.contains(user1.toBare().toString()));
+		}
+
+		void testNotificationSubjectContainsStatus() {
+			std::auto_ptr<PresenceNotifier> testling = createNotifier();
+
+			sendPresence(user1, StatusShow::Away);
+
+			CPPUNIT_ASSERT_EQUAL(1, static_cast<int>(notifier->notifications.size()));
+			CPPUNIT_ASSERT(notifier->notifications[0].subject.contains("Away"));
+		}
+
+		void testNotificationMessageContainsStatusMessage() {
+			std::auto_ptr<PresenceNotifier> testling = createNotifier();
+
+			sendPresence(user1, StatusShow::Away);
+
+			CPPUNIT_ASSERT_EQUAL(1, static_cast<int>(notifier->notifications.size()));
+			CPPUNIT_ASSERT(notifier->notifications[0].description.contains("Status Message"));
+		}
+
+		void testReceiveFirstPresenceWithQuietPeriodDoesNotNotify() {
+			std::auto_ptr<PresenceNotifier> testling = createNotifier();
+			testling->setInitialQuietPeriodMS(10);
+
+			sendPresence(user1, StatusShow::Online);
+
+			CPPUNIT_ASSERT_EQUAL(0, static_cast<int>(notifier->notifications.size()));
+		}
+
+		void testReceivePresenceDuringQuietPeriodDoesNotNotify() {
+			std::auto_ptr<PresenceNotifier> testling = createNotifier();
+			testling->setInitialQuietPeriodMS(10);
+
+			sendPresence(user1, StatusShow::Online);
+			timerFactory->setTime(1);
+			sendPresence(user2, StatusShow::Away);
+
+			CPPUNIT_ASSERT_EQUAL(0, static_cast<int>(notifier->notifications.size()));
+		}
+
+		void testReceivePresenceDuringQuietPeriodResetsTimer() {
+			std::auto_ptr<PresenceNotifier> testling = createNotifier();
+			testling->setInitialQuietPeriodMS(10);
+
+			sendPresence(user1, StatusShow::Online);
+			timerFactory->setTime(9);
+			sendPresence(user2, StatusShow::Away);
+			timerFactory->setTime(18);
+			sendPresence(user1, StatusShow::Away);
+
+			CPPUNIT_ASSERT_EQUAL(0, static_cast<int>(notifier->notifications.size()));
+		}
+
+		void testReceivePresenceAfterQuietPeriodNotifies() {
+			std::auto_ptr<PresenceNotifier> testling = createNotifier();
+			testling->setInitialQuietPeriodMS(10);
+
+			sendPresence(user1, StatusShow::Online);
+			timerFactory->setTime(11);
+			sendPresence(user2, StatusShow::Away);
+
+			CPPUNIT_ASSERT_EQUAL(1, static_cast<int>(notifier->notifications.size()));
+		}
+
+		void testReceiveFirstPresenceWithQuietPeriodDoesNotCountAsQuietPeriod() {
+			std::auto_ptr<PresenceNotifier> testling = createNotifier();
+			testling->setInitialQuietPeriodMS(10);
+
+			timerFactory->setTime(11);
+			sendPresence(user1, StatusShow::Away);
+
+			CPPUNIT_ASSERT_EQUAL(0, static_cast<int>(notifier->notifications.size()));
+		}
+
+		void testReceiveFirstPresenceAfterReconnectWithQuietPeriodDoesNotNotify() {
+			std::auto_ptr<PresenceNotifier> testling = createNotifier();
+			testling->setInitialQuietPeriodMS(10);
+			sendPresence(user1, StatusShow::Online);
+			timerFactory->setTime(15);
+			notifier->notifications.clear();
+
+			stanzaChannel->setAvailable(false);
+			stanzaChannel->setAvailable(true);
+			sendPresence(user1, StatusShow::Online);
+			timerFactory->setTime(21);
+			sendPresence(user2, StatusShow::Online);
+
+			CPPUNIT_ASSERT_EQUAL(0, static_cast<int>(notifier->notifications.size()));
+		}
+
+
+	private:
+		std::auto_ptr<PresenceNotifier> createNotifier() {
+			std::auto_ptr<PresenceNotifier> result(new PresenceNotifier(stanzaChannel, notifier, mucRegistry, avatarManager, roster, presenceOracle, timerFactory));
+			result->onNotificationActivated.connect(boost::bind(&PresenceNotifierTest::handleNotificationActivated, this, _1));
+			result->setInitialQuietPeriodMS(0);
+			return result;
+		}
+
+		void sendPresence(const JID& jid, StatusShow::Type type) {
+			boost::shared_ptr<Presence> presence(new Presence());
+			presence->setFrom(jid);
+			presence->setShow(type);
+			presence->setStatus("Status Message");
+			stanzaChannel->onPresenceReceived(presence);
+		}
+
+		void sendUnavailablePresence(const JID& jid) {
+			boost::shared_ptr<Presence> presence(new Presence());
+			presence->setType(Presence::Unavailable);
+			presence->setFrom(jid);
+			stanzaChannel->onPresenceReceived(presence);
+		}
+
+		void handleNotificationActivated(const JID& j) {
+			activatedNotifications.push_back(j);
+		}
+
+	private:
+		DummyStanzaChannel* stanzaChannel;
+		LoggingNotifier* notifier;
+		MUCRegistry* mucRegistry;
+		DummyAvatarManager* avatarManager;
+		XMPPRoster* roster;
+		PresenceOracle* presenceOracle;
+		DummyTimerFactory* timerFactory;
+		JID user1;
+		JID user2;
+		std::vector<JID> activatedNotifications;
+};
+
+CPPUNIT_TEST_SUITE_REGISTRATION(PresenceNotifierTest);
diff --git a/Swift/Controllers/UnitTest/RosterControllerTest.cpp b/Swift/Controllers/UnitTest/RosterControllerTest.cpp
index fdcc44f..174b682 100644
--- a/Swift/Controllers/UnitTest/RosterControllerTest.cpp
+++ b/Swift/Controllers/UnitTest/RosterControllerTest.cpp
@@ -23,6 +23,7 @@
 #include "Swiften/Avatars/NullAvatarManager.h"
 #include "Swift/Controllers/EventController.h"
 #include "Swiften/Presence/PresenceOracle.h"
+#include "Swiften/Presence/PresenceSender.h"
 #include "Swift/Controllers/NickResolver.h"
 #include "Swift/Controllers/UIEvents/UIEventStream.h"
 #include "Swiften/MUC/MUCRegistry.h"
@@ -30,6 +31,7 @@
 using namespace Swift;
 
 #define CHILDREN mainWindow_->roster->getRoot()->getChildren()
+
 class RosterControllerTest : public CppUnit::TestFixture
 {
 		CPPUNIT_TEST_SUITE(RosterControllerTest);
@@ -43,7 +45,7 @@ class RosterControllerTest : public CppUnit::TestFixture
 
 		void setUp() {
 			jid_ = JID("testjid@swift.im/swift");
-			xmppRoster_ = boost::shared_ptr<XMPPRoster>(new XMPPRoster());
+			xmppRoster_ = new XMPPRoster();
 			avatarManager_ = new NullAvatarManager();
 			mainWindowFactory_ = new MockMainWindowFactory();
 			mucRegistry_ = new MUCRegistry();
@@ -52,9 +54,10 @@ class RosterControllerTest : public CppUnit::TestFixture
 			router_ = new IQRouter(channel_);
 			stanzaChannel_ = new DummyStanzaChannel();
 			presenceOracle_ = new PresenceOracle(stanzaChannel_);
+			presenceSender_ = new PresenceSender(stanzaChannel_);
 			eventController_ = new EventController();
 			uiEventStream_ = new UIEventStream();
-			rosterController_ = new RosterController(jid_, xmppRoster_, avatarManager_, mainWindowFactory_, nickResolver_, presenceOracle_, eventController_, uiEventStream_, router_);
+			rosterController_ = new RosterController(jid_, xmppRoster_, avatarManager_, mainWindowFactory_, nickResolver_, presenceOracle_, presenceSender_, eventController_, uiEventStream_, router_);
 			mainWindow_ = mainWindowFactory_->last;
 		};
 
@@ -67,6 +70,7 @@ class RosterControllerTest : public CppUnit::TestFixture
 			delete channel_;
 			delete router_;
 			delete eventController_;
+			delete presenceSender_;
 			delete presenceOracle_;
 			delete stanzaChannel_;
 			delete uiEventStream_;
@@ -119,7 +123,7 @@ class RosterControllerTest : public CppUnit::TestFixture
 
 	private:
 		JID jid_;
-		boost::shared_ptr<XMPPRoster> xmppRoster_;
+		XMPPRoster* xmppRoster_;
 		MUCRegistry* mucRegistry_;
 		AvatarManager* avatarManager_;
 		MockMainWindowFactory* mainWindowFactory_;
@@ -129,10 +133,10 @@ class RosterControllerTest : public CppUnit::TestFixture
 		DummyStanzaChannel* stanzaChannel_;	
 		IQRouter* router_;
 		PresenceOracle* presenceOracle_;
+		PresenceSender* presenceSender_;
 		EventController* eventController_;
 		UIEventStream* uiEventStream_;
 		MockMainWindow* mainWindow_;
 };
-#undef children
 
 CPPUNIT_TEST_SUITE_REGISTRATION(RosterControllerTest);
diff --git a/Swift/Controllers/UnitTest/XMPPRosterControllerTest.cpp b/Swift/Controllers/UnitTest/XMPPRosterControllerTest.cpp
index 2bfd8ce..6787528 100644
--- a/Swift/Controllers/UnitTest/XMPPRosterControllerTest.cpp
+++ b/Swift/Controllers/UnitTest/XMPPRosterControllerTest.cpp
@@ -31,7 +31,7 @@ class XMPPRosterControllerTest : public CppUnit::TestFixture
 		void setUp() {
 			channel_ = new DummyIQChannel();
 			router_ = new IQRouter(channel_);
-			xmppRoster_ = boost::shared_ptr<XMPPRoster>(new XMPPRoster());
+			xmppRoster_ = new XMPPRoster();
 		}
 
 		void tearDown() {
@@ -78,7 +78,7 @@ class XMPPRosterControllerTest : public CppUnit::TestFixture
 	private:
 		DummyIQChannel* channel_;
 		IQRouter* router_;
-		boost::shared_ptr<XMPPRoster> xmppRoster_;
+		XMPPRoster* xmppRoster_;
 };
 
 CPPUNIT_TEST_SUITE_REGISTRATION(XMPPRosterControllerTest);
author	Remko Tronçon <git@el-tramo.be>	2010-09-12 18:29:39 (GMT)
committer	Remko Tronçon <git@el-tramo.be>	2010-09-13 19:19:52 (GMT)
commit	ef1052bbdb315aaa1c6254098ea05638d9a25b2f (patch)
tree	482277f649f6c0fc00027514ea8986861fe33437 /Swift/Controllers/UnitTest
parent	3ae8cccfe9c6bfed5dda5f024a5cb046ccfc9793 (diff)
download	swift-ef1052bbdb315aaa1c6254098ea05638d9a25b2f.zip swift-ef1052bbdb315aaa1c6254098ea05638d9a25b2f.tar.bz2