IterationListenerTest.cpp File Reference

#include "Std.hpp"
#include "IterationListener.hpp"
#include "pwiz/utility/misc/unit.hpp"
#include <cstring>
#include <ctime>

Go to the source code of this file.

Classes
class	TestListener
class	CancelListener
class	BadListener

Functions
void	nullDeallocate (IterationListener *s)
void	test ()
void	testCancel ()
void	testRemove ()
void	testTime ()
int	main (int argc, char *argv[])

Variables
ostream *	os_ = 0

---

Function Documentation

void nullDeallocate

(

IterationListener *

s

)

Definition at line 83 of file IterationListenerTest.cpp.

Referenced by test(), testCancel(), testRemove(), and testTime().

{
    // do nothing
}

void test

(

)

Definition at line 88 of file IterationListenerTest.cpp.

References pwiz::util::IterationListenerRegistry::addListener(), pwiz::util::IterationListenerRegistry::broadcastUpdateMessage(), TestListener::count(), nullDeallocate(), os_, test3(), test4(), and unit_assert.

{
    if (os_) *os_ << "test()\n";

    IterationListenerRegistry registry;

    TestListener test3("test3");
    TestListener test4("test4");
    TestListener test5("test5");
    TestListener test6("test6");

    registry.addListener(IterationListenerPtr(&test3, nullDeallocate), 3);
    registry.addListener(IterationListenerPtr(&test4, nullDeallocate), 4);
    registry.addListener(IterationListenerPtr(&test5, nullDeallocate), 5);
    registry.addListener(IterationListenerPtr(&test6, nullDeallocate), 6);

    size_t iterationCount = 24;
    for (size_t i=0; i<iterationCount; i++)
        registry.broadcastUpdateMessage(IterationListener::UpdateMessage(i, iterationCount));

    // validate

    unit_assert(test3.count() == 9); // 0 2 5 8 11 14 17 20 23
    unit_assert(test4.count() == 7);
    unit_assert(test5.count() == 6);
    unit_assert(test6.count() == 5);

    if (os_) *os_ << endl;
}

void testCancel

(

)

Definition at line 119 of file IterationListenerTest.cpp.

References pwiz::util::IterationListenerRegistry::addListener(), pwiz::util::IterationListenerRegistry::broadcastUpdateMessage(), TestListener::count(), nullDeallocate(), os_, pwiz::util::IterationListener::Status_Cancel, test3(), test4(), and unit_assert.

Referenced by main().

{
    if (os_) *os_ << "testCancel()\n";

    IterationListenerRegistry registry;

    CancelListener cancelListener(12);
    TestListener test3("test3");
    TestListener test4("test4");
    TestListener test6("test6");

    registry.addListener(IterationListenerPtr(&cancelListener, nullDeallocate), 1);
    registry.addListener(IterationListenerPtr(&test3, nullDeallocate), 3);
    registry.addListener(IterationListenerPtr(&test4, nullDeallocate), 4);
    registry.addListener(IterationListenerPtr(&test6, nullDeallocate), 5);

    // typical use of IterationListenerRegistry, with proper Status_Cancel handling

    bool canceled = false;
    
    size_t iterationCount = 24;
    for (size_t i=0; i<iterationCount; i++)
    {
        IterationListener::Status status = 
            registry.broadcastUpdateMessage(IterationListener::UpdateMessage(i, iterationCount));

        // handle Status_Cancel
        if (status == IterationListener::Status_Cancel) 
        {
            canceled = true;
            break;
        }
    }

    // implementations should send a final update on completion of the iteration

    if (!canceled)
        registry.broadcastUpdateMessage(IterationListener::UpdateMessage(iterationCount, iterationCount));

    // validate

    unit_assert(test3.count() == 5);
    unit_assert(test4.count() == 4);
    unit_assert(test6.count() == 3);

    if (os_) *os_ << endl;
}

void testRemove

(

)

Definition at line 179 of file IterationListenerTest.cpp.

References pwiz::util::IterationListenerRegistry::addListener(), pwiz::util::IterationListenerRegistry::broadcastUpdateMessage(), e(), nullDeallocate(), os_, pwiz::util::IterationListenerRegistry::removeListener(), test3(), test4(), and unit_assert.

Referenced by main().

{
    if (os_) *os_ << "testRemove()\n";

    IterationListenerRegistry registry;

    BadListener bad;
    TestListener test3("test3");
    TestListener test4("test4");

    IterationListenerPtr badPtr(&bad, nullDeallocate);

    registry.addListener(IterationListenerPtr(&test3, nullDeallocate), 3);
    registry.addListener(badPtr, 1);
    registry.addListener(IterationListenerPtr(&test4, nullDeallocate), 4);

    // sanity check -- verify that broadcast throws if BadListener is in the registry    
    
    bool caught = false;

    try
    {
        registry.broadcastUpdateMessage(IterationListener::UpdateMessage(0,0));
    }
    catch (exception& e)
    {
        if (e.what() == string("bad")) caught = true;
    }

    unit_assert(caught);

    // remove BadListener -- broadcast will throw if not removed properly

    registry.removeListener(badPtr);
    registry.broadcastUpdateMessage(IterationListener::UpdateMessage(0,0));

    if (os_) *os_ << endl;
}

void testTime

(

)

Definition at line 219 of file IterationListenerTest.cpp.

References pwiz::util::IterationListenerRegistry::addListener(), pwiz::util::IterationListenerRegistry::addListenerWithTimer(), pwiz::util::IterationListenerRegistry::broadcastUpdateMessage(), nullDeallocate(), and os_.

Referenced by main().

{
    if (os_) *os_ << "testTime()\n";

    IterationListenerRegistry registry;

    TestListener test_iteration("test_iteration");
    TestListener test_time("test_time");

    registry.addListener(IterationListenerPtr(&test_iteration, nullDeallocate), 1000000);
    registry.addListenerWithTimer(IterationListenerPtr(&test_time, nullDeallocate), 1.0); 

    time_t start;
    time(&start);

    const double iterationDuration = 5.0;
    for (int i=0; ; i++) 
    {
        time_t now;
        time(&now);
        if (difftime(now, start) > iterationDuration) break;

        registry.broadcastUpdateMessage(IterationListener::UpdateMessage(i,0));
    }

    if (os_) *os_ << endl;
}

int main	(	int	argc,
		char *	argv[]
	)

Definition at line 248 of file IterationListenerTest.cpp.

References e(), os_, test(), TEST_EPILOG, TEST_FAILED, TEST_PROLOG, testCancel(), testRemove(), and testTime().

{
    TEST_PROLOG(argc, argv)

    try
    {
        if (argc>1 && !strcmp(argv[1],"-v")) os_ = &cout;
        test();
        testCancel();
        testRemove();
        testTime();
    }
    catch (exception& e)
    {
        TEST_FAILED(e.what())
    }
    catch (...)
    {
        TEST_FAILED("Caught unknown exception.")
    }

    TEST_EPILOG
}

---

Variable Documentation

ostream* os_ = 0

Definition at line 34 of file IterationListenerTest.cpp.