Changeset d85532

Timestamp:

Dec 13, 2011, 12:00:30 PM (14 years ago)

Author:

Frederik Heber <heber@…>

Children:

b760ac5

Parents:

2c11c1

git-author:

Frederik Heber <heber@…> (12/02/11 10:10:17)

git-committer:

Frederik Heber <heber@…> (12/13/11 12:00:30)

Message:

Added unit test on Relay.

• added new stubs to ObserverStub implementing Relay.
• Relay is friend of Notification.

Location:

src

Files:

• Makefile.am (modified) (2 diffs)
• Patterns/Observer/Notification.hpp (modified) (2 diffs)
• Patterns/Observer/Observable.hpp (modified) (1 diff)
• Patterns/Observer/Observer.hpp (modified) (1 diff)
• Patterns/Observer/Relay.cpp (modified) (6 diffs)
• Patterns/Observer/Relay.hpp (modified) (1 diff)
• Patterns/Observer/unittests/ObserverUnitTest.cpp (modified) (3 diffs)
• Patterns/Observer/unittests/ObserverUnitTest.hpp (modified) (4 diffs)
• Patterns/Observer/unittests/stubs/ObserverStub.cpp (modified) (1 diff)
• Patterns/Observer/unittests/stubs/ObserverStub.hpp (modified) (2 diffs)

src/Makefile.am

@@ -41 +41 @@
         Patterns/Observer/Notification.cpp \
         Patterns/Observer/Observable.cpp \
-        Patterns/Observer/Observer.cpp
+        Patterns/Observer/Observer.cpp \
+        Patterns/Observer/Relay.cpp
 PATTERNSOURCEDEBUG = \
         $(PATTERNSOURCE) \
@@ -64 +65 @@
         Patterns/Observer/ObservedIterator.hpp \
         Patterns/Observer/ObservedContainer_impl.hpp \
+        Patterns/Observer/Relay.hpp \
         Patterns/Registry_impl.hpp \
         Patterns/Singleton_impl.hpp \

src/Patterns/Observer/Notification.hpp

@@ -16 +16 @@
 #include <set>
 
-class Channels;
 class Observable;
 class Observer;
+class Relay;
 
 /** Notifications are sort of news channels of an Observable.
@@ -28 +28 @@
  */
 class Notification {
+  //!> grant Observable access to notifyAll()
   friend class Observable;
-  friend class Channels;
+  //!> grant Relay access to notifyAll()
+  friend class Relay;
 public:
   Notification(size_t _channelno);

src/Patterns/Observer/Observable.hpp

@@ -114 +114 @@
   static PriorityLevel PriorityDefault;
 
-private:
+protected:
   typedef std::multimap<int,Observer*> callees_t;
   typedef std::set<Notification*> notificationSet;

src/Patterns/Observer/Observer.hpp

@@ -44 +44 @@
 class Observer
 {
+  friend class Notification;
   friend class Observable;
-  friend class Notification;
+  friend class Relay;
   template<class> friend class ObservedIterator;
 

src/Patterns/Observer/Relay.cpp

@@ -22 +22 @@
 #include "Relay.hpp"
 
+#include "Assert.hpp"
+#include "Channels.hpp"
+#include "defs.hpp"
+#include "Notification.hpp"
+
 
 /** Constructor for class Relay.
  */
-Relay::Relay(string name) :
-  Observer(Observer::BaseConstructor())
+Relay::Relay(std::string name) :
+  Observable(name),
+  Updater(NULL)
 {
 #ifdef LOG_OBSERVER
@@ -42 +48 @@
   observerLog().addMessage() << "-- Destroying Relay " << observerLog().getName(this);
 #endif
-  if(callTable.count(this)) {
-    // delete all entries for this observable
-    callees_t callees = callTable[this];
-    callees_t::iterator iter;
-    for(iter=callees.begin();iter!=callees.end();++iter){
-      (*iter).second->subjectKilled(this);
-    }
-    callTable.erase(this);
-  }
 }
 
 
 /** Notify all Observers of changes.
- * Puts \a *this into Relay::busyRelays, calls Observer::update() for all in callee_t
+ * Puts \a *this into Relay::busyObservables, calls Observer::update() for all in callee_t
  * and removes from busy list.
  */
 void Relay::notifyAll() {
+  ASSERT(Updater != NULL,
+      "Relay::notifyAll() called while Updater is NULL.");
   // we are busy notifying others right now
   // add ourselves to the list of busy subjects to enable circle detection
-  busyRelays.insert(this);
+  busyObservables.insert(this);
   // see if anyone has signed up for observation
   // and call all observers
@@ -86 +85 @@
   // send out all notifications that need to be done
 
-  notificationSet currentNotifications = notifications[this];
+  notificationSet currentNotifications = notifications[Updater];
   for(notificationSet::iterator it = currentNotifications.begin();
       it != currentNotifications.end();++it){
-    (*it)->notifyAll();
+    (*it)->notifyAll(Updater);
   }
 
-  notifications.erase(this);
+  notifications.erase(Updater);
 
    // done with notification, we can leave the set of busy subjects
-  busyRelays.erase(this);
+  busyObservables.erase(this);
 }
 
@@ -106 +105 @@
 void Relay::update(Observable *publisher) {
   // circle detection
-  if(busyRelays.find(this)!=busyRelays.end()) {
+  if(busyObservables.find(this)!=busyObservables.end()) {
     // somehow a circle was introduced... we were busy notifying our
     // observers, but still we are called by one of our sub-Relays
@@ -122 +121 @@
 #ifdef LOG_OBSERVER
       observerLog().addMessage() << "-* Update from " << observerLog().getName(publisher)
-                                 << " relayed by " << observerLog().getName(this) << endl;
+                                 << " relayed by " << observerLog().getName(this);
 #endif
       Updater = publisher;
@@ -130 +129 @@
 #ifdef LOG_OBSERVER
       observerLog().addMessage() << "-| Update from " <<  observerLog().getName(publisher)
-                                 << " not relayed by " << observerLog().getName(this) << endl;
+                                 << " not relayed by " << observerLog().getName(this);
 #endif
     }

src/Patterns/Observer/Relay.hpp

@@ -17 +17 @@
 
 /**
- * An Relay acts as a node in a many-to-one observation.
+ * A Relay acts as a node in a many-to-one observation.
  *
  * All Observable::update() calls will pass through this relay. Hence, if an

src/Patterns/Observer/unittests/ObserverUnitTest.cpp

@@ -68 +68 @@
   notificationObserver2 = new NotificationObserver(
       notificationObservable->getChannel(NotificationObservable::Operation2Notify));
+
+  RelayObservable = new RelayTest;
+  RelayObserver = new RelayCountObserver(RelayObservable);
 }
 
@@ -79 +82 @@
   delete obsset;
   delete obsmap;
+  delete RelayObservable;
+  delete RelayObserver;
 
   delete observer1;
@@ -237 +242 @@
 }
 
+void ObserverTest::relayTest()
+{
+  // sign on some observables to the relay
+  simpleObservable1->signOn(RelayObservable);
+  simpleObservable2->signOn(RelayObservable);
+
+  // sign on an observer to the relay
+  RelayObservable->signOn(RelayObserver);
+  simpleObservable1->signOn(observer1);
+
+  // check that all is zero
+  CPPUNIT_ASSERT_EQUAL( 0, RelayObserver->updates );
+  CPPUNIT_ASSERT_EQUAL( 0, observer1->updates );
+
+  // signal update
+  simpleObservable1->changeMethod();
+
+  // check that both the change
+  // (and RelayObserver checks being called correctly)
+  CPPUNIT_ASSERT_EQUAL( 1, RelayObserver->updates );
+  CPPUNIT_ASSERT_EQUAL( 1, observer1->updates );
+
+  // signal update through relay only
+  simpleObservable2->changeMethod();
+
+  // check that only one got the change
+  CPPUNIT_ASSERT_EQUAL( 2, RelayObserver->updates );
+  CPPUNIT_ASSERT_EQUAL( 1, observer1->updates );
+
+  // check on signOff
+  simpleObservable1->signOff(RelayObservable);
+  simpleObservable1->signOff(observer1);
+}
+
 void ObserverTest::CircleDetectionTest() {
   std::cout << std::endl << "Warning: the next test involved methods that can produce infinite loops." << std::endl;

src/Patterns/Observer/unittests/ObserverUnitTest.hpp

@@ -24 +24 @@
 class ObservableSet;
 class ObservableMap;
+class RelayObservable;
 class BlockObservable;
 class NotificationObservable;
+class RelayCountObserver;
 
 class ObserverTest :  public CppUnit::TestFixture
@@ -37 +39 @@
   CPPUNIT_TEST ( doesReportTest );
   CPPUNIT_TEST ( iteratorTest );
+  CPPUNIT_TEST ( relayTest );
   CPPUNIT_TEST ( CircleDetectionTest );
   CPPUNIT_TEST_SUITE_END();
@@ -51 +54 @@
   void doesReportTest();
   void iteratorTest();
+  void relayTest();
   void CircleDetectionTest();
 
@@ -70 +74 @@
   ObservableSet *obsset;
   ObservableMap *obsmap;
-
+  RelayTest *RelayObservable;
+  RelayCountObserver *RelayObserver;
 };
 

src/Patterns/Observer/unittests/stubs/ObserverStub.cpp

@@ -230 +230 @@
 }
 
+/****************** Relay *********************/
+
+RelayTest::RelayTest() :
+    Relay(std::string("RelayTest"))
+{}
+
+RelayTest::~RelayTest()
+{}
+
+/************ RelayCountObserver ***************/
+
+RelayCountObserver::RelayCountObserver(const Observable * const _relay) :
+    Observer("RelayCountObserver"),
+    updates(0),
+    relay(_relay)
+{}
+
+RelayCountObserver::~RelayCountObserver()
+{}
+
+void RelayCountObserver::update(Observable *publisher){
+  // check that we are not called by the relay itself
+  CPPUNIT_ASSERT(publisher != relay);
+  updates++;
+}
+
+void RelayCountObserver::subjectKilled(Observable *publisher) {
+}
+

src/Patterns/Observer/unittests/stubs/ObserverStub.hpp

@@ -12 +12 @@
 #include "Observer/Observable.hpp"
 #include "Observer/ObservedIterator.hpp"
+#include "Observer/Relay.hpp"
 
 class UpdateCountObserver : public Observer {
@@ -126 +127 @@
 };
 
+class RelayTest : public Relay
+{
+public:
+  RelayTest();
+  ~RelayTest();
+private:
+};
+
+class RelayCountObserver : public Observer {
+public:
+  RelayCountObserver(const Observable * const relay);
+  virtual ~RelayCountObserver();
+
+  void update(Observable *publisher);
+  void subjectKilled(Observable *publisher);
+
+  int updates;
+private:
+  const Observable * const relay;
+};
 
 #endif /* OBSERVERSTUB_HPP_ */