Added UnitTest cases for factory method.

Author: mfarid

factory-method/pom.xml

@@ -14,5 +14,10 @@
       <artifactId>junit</artifactId>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.mockito</groupId>
+      <artifactId>mockito-core</artifactId>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 </project>

factory-method/src/main/java/com/iluwatar/factory/method/ElfWeapon.java

@@ -1,9 +1,7 @@
 package com.iluwatar.factory.method;
 
 /**
- * 
- * ElfWeapon
- *
+ * ElfWeapon.
  */
 public class ElfWeapon implements Weapon {
 
@@ -17,4 +15,9 @@ public ElfWeapon(WeaponType weaponType) {
   public String toString() {
     return "Elven " + weaponType;
   }
+
+  @Override
+  public WeaponType getWeaponType() {
+    return weaponType;
+  }
 }

factory-method/src/main/java/com/iluwatar/factory/method/OrcWeapon.java

@@ -1,9 +1,7 @@
 package com.iluwatar.factory.method;
 
 /**
- * 
- * OrcWeapon
- *
+ * OrcWeapon.
  */
 public class OrcWeapon implements Weapon {
 
@@ -17,4 +15,9 @@ public OrcWeapon(WeaponType weaponType) {
   public String toString() {
     return "Orcish " + weaponType;
   }
+
+  @Override
+  public WeaponType getWeaponType() {
+    return weaponType;
+  }
 }

factory-method/src/main/java/com/iluwatar/factory/method/Weapon.java

@@ -1,10 +1,10 @@
 package com.iluwatar.factory.method;
 
 /**
- * 
- * Weapon interface
- *
+ * Weapon interface.
  */
 public interface Weapon {
 
+  WeaponType getWeaponType();
+
 }

factory-method/src/test/java/com/iluwatar/factory/method/AppTest.java

@@ -0,0 +1,79 @@
+package com.iluwatar.factory.method;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
+import org.junit.Test;
+
+/**
+ * The Factory Method is a creational design pattern which uses factory methods to deal with the
+ * problem of creating objects without specifying the exact class of object that will be created.
+ * This is done by creating objects via calling a factory method either specified in an interface
+ * and implemented by child classes, or implemented in a base class and optionally overridden by
+ * derived classes—rather than by calling a constructor.
+ * 
+ * <p>Factory produces the object of its liking. 
+ * The weapon {@link Weapon} manufactured by the
+ * blacksmith depends on the kind of factory implementation it is referring to.
+ * </p>
+ */
+public class FactoryMethodTest {
+
+  /**
+   * Testing {@link OrcBlacksmith} to produce a SPEAR asserting that the Weapon is an instance 
+   * of {@link OrcWeapon}.
+   */
+  @Test
+  public void testOrcBlacksmithWithSpear() {
+    Blacksmith blacksmith = new OrcBlacksmith();
+    Weapon weapon = blacksmith.manufactureWeapon(WeaponType.SPEAR);
+    verifyWeapon(weapon, WeaponType.SPEAR, OrcWeapon.class);
+  }
+
+  /**
+   * Testing {@link OrcBlacksmith} to produce a AXE asserting that the Weapon is an instance
+   *  of {@link OrcWeapon}.
+   */
+  @Test
+  public void testOrcBlacksmithWithAxe() {
+    Blacksmith blacksmith = new OrcBlacksmith();
+    Weapon weapon = blacksmith.manufactureWeapon(WeaponType.AXE);
+    verifyWeapon(weapon, WeaponType.AXE, OrcWeapon.class);
+  }
+
+  /**
+   * Testing {@link ElfBlacksmith} to produce a SHORT_SWORD asserting that the Weapon is an
+   * instance of {@link ElfWeapon}.
+   */
+  @Test
+  public void testElfBlacksmithWithShortSword() {
+    Blacksmith blacksmith = new ElfBlacksmith();
+    Weapon weapon = blacksmith.manufactureWeapon(WeaponType.SHORT_SWORD);
+    verifyWeapon(weapon, WeaponType.SHORT_SWORD, ElfWeapon.class);
+  }
+
+  /**
+   * Testing {@link ElfBlacksmith} to produce a SPEAR asserting that the Weapon is an instance
+   * of {@link ElfWeapon}.
+   */
+  @Test
+  public void testElfBlacksmithWithSpear() {
+    Blacksmith blacksmith = new ElfBlacksmith();
+    Weapon weapon = blacksmith.manufactureWeapon(WeaponType.SPEAR);
+    verifyWeapon(weapon, WeaponType.SPEAR, ElfWeapon.class);
+  }
+
+  /**
+   * This method asserts that the weapon object that is passed is an instance of the clazz and the
+   * weapon is of type expectedWeaponType.
+   * 
+   * @param weapon weapon object which is to be verified
+   * @param expectedWeaponType expected WeaponType of the weapon
+   * @param clazz expected class of the weapon
+   */
+  private void verifyWeapon(Weapon weapon, WeaponType expectedWeaponType, Class clazz) {
+    assertTrue("Weapon must be an object of: " + clazz.getName(), clazz.isInstance(weapon));
+    assertEquals("Weapon must be of weaponType: " + clazz.getName(), expectedWeaponType,
+        weapon.getWeaponType());
+  }
+}