package biz.xsoftware.examples.timer;

 import java.util.TimerTask;

 import junit.framework.TestCase;

 import biz.xsoftware.examples.advanced.ScheduleListener;

 import biz.xsoftware.mock.CalledMethod;

 import biz.xsoftware.mock.MockObjectFactory;

 import biz.xsoftware.mock.MockObject;

 /**

  * This example has the following tests

  * 

  * testBasicCalendar

  * 

  * Tests a few things

  * 1. Tests scheduling an event

  * 2. Tests that event was scheduled at the propert time

  * 3. Tests the event going off and verifying expected event behavior

  * 

  * testCancelOfEvent

  * 

  * Tests scheduling and cancelling the event.

  * 

  * @author Dean Hiller

  */

 public class TestExample extends TestCase {

         private MockObject mockListener;

         private MockObject mockTimer;

         private CalendarService calendar;

         /**

          * @showcode

          */

         public TestExample(String name) {

                 super(name);

         }

         /**

          * @showcode

          */

         @Override

     public void setUp() {

                 //Create a mockTimer which acts as a cache for TimerTasks.....

                 mockTimer = MockObjectFactory.createMock(TimerInterface.class);

                 calendar = new CalendarServiceImpl((TimerInterface) mockTimer);

                 //Create and add a mockListener which we use to verify receiving of the 

                 //proper events....

                 mockListener = MockObjectFactory.createMock(ScheduleListener.class);

                 calendar.addScheduleListener((ScheduleListener)mockListener);

         }

         /**

          * @showcode

          */

         @Override

     public void tearDown() {

                 calendar.removeScheduleListener((ScheduleListener)mockListener);

         }

         /**

          * Tests a few things

          * 1. Tests scheduling an event

          * 2. Tests that event was scheduled at the propert time

          * 3. Tests the event going off and verifying expected event behavior

          * 

          * @showcode

          */

         public void testBasicCalendar() {

                 String title = "some event";

                 long delay = 50000;

                 calendar.addEvent(title, delay);

                 //When an event is added, we expect schedule on the timer to be called...

                 CalledMethod method = mockTimer.expect("schedule");

                 //param[0] is the mock object's cached timer task....

                 TimerTask task = (TimerTask)method.getParameter(0);

                 assertEquals("Should have set the timer for "+delay+" ms", new Long(delay), method.getParameter(1));

                 //We already verified it was scheduled in the future, so there is

                 //no need to wait till run the task then

                 //run the task now instead of waiting 50000ms

                 task.run();

                 //expect that the listener's eventStarted method is called with the

                 //propert event title

                 method = mockListener.expect("eventStarted");

                 assertEquals("title should be the same", title, method.getParameter(0));

         }

         /**

          * Tests scheduling and cancelling the event.

          * 

          * @showcode

          */

         public void testCancelOfEvent() {

                 String title = "some event";

                 long delay = 50000;

                 calendar.addEvent(title, delay);

                 CalledMethod method = mockTimer.expect("schedule");

                 //param[0] is a timer task

                 TimerTask task = (TimerTask)method.getParameter(0);

                 assertEquals("Should have set the timer for "+delay+" ms", new Long(delay), method.getParameter(1));

                 calendar.cancelEvent(title);

                 //make sure the event is actually cancelled

                 mockTimer.expect("cancelTask");

                 TimerTask cancelledTask = (TimerTask)method.getParameter(0);

                 //Make sure the correct TimerTask is cancelled....

                 assertSame(task, cancelledTask);

         }

 }