/*

  * Created on Jun 28, 2004

  *

  * To change the template for this generated file go to

  * Window - Preferences - Java - Code Generation - Code and Comments

  */

 package biz.xsoftware.examples.basic;

 import java.util.logging.Logger;

 import junit.framework.TestCase;

 import biz.xsoftware.mock.CalledMethod;

 import biz.xsoftware.mock.MockObjectFactory;

 import biz.xsoftware.mock.MockObject;

 /**

  * This example has 3 tests.

  * 

  *  testBasicSunnyDay

  *  

  * This verifies that the correct amount of money was

  * taken from the credit card and taken from the correct

  * user.  It then verifies the correct amount of money was

  * put on the gift card

  * 

  * testFailureOfAuthorization

  * 

  * In this test we test that a failure from CreditAuthSvc

  * results in the correct StoreUnderTest behavior which in this

  * instance is to throw an exception to the user.

  * 

  * testFailureOfBuyingGiftCard

  * 

  * This tests to make sure if putting money on the gift card fails that

  * we will return money back to the users credit card.

  * @author Dean Hiller

  */

 public class TestExample extends TestCase {

         private SysUnderTest sysUnderTest;

         private MockObject mockCreditSvc;

         private MockObject mockGiftSvc;

         private Logger log = Logger.getLogger(TestExample.class.getName());

         /**

          * @param name The name of the test

          * @showcode

          */

         public TestExample(String name) {

                 super(name);

         }

         /**

          * Setup for all the tests consists of created MockObjects that will simulate

          * the CreditAuthorizationSvc and GiftCardAccountSvc.  Then using 

          * dependency injection(inversion of control) pattern, these are given to

          * the SysUnderTest which has no idea they are not the real thing.

          * 

          * @showcode

          * @see junit.framework.TestCase#setUp()

          */

         @Override

     public void setUp() {

                 //first, create a mock CreditAuthorizationSvc

                 mockCreditSvc = MockObjectFactory.createMock(CreditAuthorizationSvc.class);

                 //next, create a mock GiftCardAccountSvc

                 mockGiftSvc = MockObjectFactory.createMock(GiftCardAccountSvc.class);

                 //Create the system we are going to test by passing these mock objects

                 //into the constructor....

                 CreditAuthorizationSvc credit = (CreditAuthorizationSvc)mockCreditSvc;

                 GiftCardAccountSvc gift = (GiftCardAccountSvc)mockGiftSvc;

                 sysUnderTest = new SysUnderTest(credit, gift);

         }

         /**

          * This verifies that the correct amount of money was

          * taken from the credit card and taken from the correct

          * user.  It then verifies the correct amount of money was

          * put on the gift card

          * 

          * @see SysUnderTest#purchase

          * @showcode

          */

         public void testBasicSunnyDay() {                

                 String user = "user1";

                 double amount = 340.99;

                 //now, purhase a gift card with user=user and amount=amount

                 sysUnderTest.buyGiftCard(user, amount);

                 CalledMethod m1 = mockCreditSvc.expect("takeMoney");

                 Object[] paramsToAuthorize = m1.getAllParams();

                 //method signature of takeMoney = 

                 //         public void takeMoney(String user, double usDollars);

                 //This first assert verifies that the first parameter pass into that was equal to user

                 assertEquals("User should be the same", user, paramsToAuthorize[0]);

                 //This next assert verifies the second parameter passed to the

                 //takeMoney method was the amount....

                 assertEquals("Amount should have been the same", new Double(amount), paramsToAuthorize[1]);

                 //lastly, we also expect putMoneyOnCard to be called with the correct amount...

                 CalledMethod m2 = mockGiftSvc.expect("putMoneyOnCard");

                 assertEquals("Money on gift card should be correct", amount, m2.getAllParams()[1]);

         }

         /**

          * In this test we test that a failure from CreditAuthSvc

          * results in the correct StoreUnderTest behavior which in this

          * instance is to throw an exception to the user.

          *

          * @see SysUnderTest#purchase

          * @showcode

          */

         public void testFailureOfAuthorization() {

                 //we want to tell mockCreditSvc to simulate a failure

                 //by throwing an exception on the takeMoney method call

                 mockCreditSvc.addThrowException("takeMoney", new IllegalStateException("cause failure"));

                 String user = "user1";

                 double amount = 340.99;

                 try {

                         //in this case, we just expect an exception and nothing else...

                         sysUnderTest.buyGiftCard(user, amount);

                         fail("Expecting exactly the exact exception thrown here, but that didn't happen");

                 } catch(IllegalStateException e) {

                         log.info(e.getMessage());

                 }

         }

         /**

          * This tests to make sure if putting money on the gift card fails that

          * we will return money back to the users credit card.

          *

          * @see SysUnderTest#buyGiftCard 

          * @showcode

          */

         public void testFailureOfBuyingGiftCard() {        

                 //Now, we want to simulate a failure that should cause recovery to occur....

                 mockGiftSvc.addThrowException("putMoneyOnCard", new RuntimeException("cause failure in subsystem"));

                 String user = "userXXX";

                 double amount = 40.01;

                 try {

                         //Now call the system which should recover

                         sysUnderTest.buyGiftCard(user, amount);

                         fail("Should have thrown exception");

                 } catch(PurchaseException e) {

                         log.info(e.getMessage());

                 }

                 //make sure takeMoney then return money was called which should happen

                 //in our failure case.

                 CalledMethod[] methods = mockCreditSvc.expect("takeMoney", "returnMoney");

                 CalledMethod takeMoney = methods[0];

                 assertEquals("Took from correct user", user, takeMoney.getParameter(0));

                 assertEquals("Took 40 dollars", new Double(amount), takeMoney.getParameter(1));

                 CalledMethod returnMoney = methods[1];

                 assertEquals("Gave money back to correct user", user, returnMoney.getParameter(0));

                 assertEquals("amount put back on card is correct", new Double(amount), returnMoney.getParameter(1));

         }

 }