Add unit tests for ViewAllCommand and ViewCommand classes #111

test/java/seedu/addressbook/commands/ViewAllCommandTest.java

@@ -0,0 +1,7 @@
+package seedu.addressbook.commands;
+
+public class ViewAllCommandTest {
+    // ViewAll command is tested together with View command
+    // This is because they function similarly but View command hides private information
+    // They are tested with same test data input
+}

test/java/seedu/addressbook/commands/ViewCommandTest.java

@@ -0,0 +1,152 @@
+package seedu.addressbook.commands;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+import org.junit.Before;
+import org.junit.Test;
+
+import seedu.addressbook.common.Messages;
+import seedu.addressbook.data.AddressBook;
+import seedu.addressbook.data.person.Address;
+import seedu.addressbook.data.person.Email;
+import seedu.addressbook.data.person.Name;
+import seedu.addressbook.data.person.Person;
+import seedu.addressbook.data.person.Phone;
+import seedu.addressbook.data.person.ReadOnlyPerson;
+import seedu.addressbook.data.tag.UniqueTagList;
+import seedu.addressbook.util.TestUtil;
+import seedu.addressbook.util.TypicalPersons;
+
+import static seedu.addressbook.util.TestUtil.assertCommandResult;
+
+public class ViewCommandTest {
+    private AddressBook addressBook;
+    private AddressBook emptyAddressBook;
+    private List<ReadOnlyPerson> emptyDisplayList = new ArrayList<ReadOnlyPerson>();
+    private List<ReadOnlyPerson> listWithAll;
+    private List<ReadOnlyPerson> listWithSome;
+
+    @Before
+    public void setUp() throws Exception {
+        emptyAddressBook = TestUtil.createAddressBook();
+
+        TypicalPersons td = new TypicalPersons();
+        addressBook = td.getTypicalAddressBook();
+        listWithAll = td.getListWithAllPersons();
+        listWithSome = td.getListWithSomePersons();
+    }
+
+    @Test
+    public void viewCommand_invalidIndex_returnsInvalidIndexMessage() {
+        // empty addressbook
+        assertViewErrorInvalidIndex(emptyAddressBook, emptyDisplayList, 1);
+
+        // non-empty addressbook
+        assertViewErrorInvalidIndex(addressBook, listWithAll, -1);
+        assertViewErrorInvalidIndex(addressBook, listWithAll, 0);
+        assertViewErrorInvalidIndex(addressBook, listWithAll, listWithAll.size() + 1);
+    }
+
+    @Test
+    public void viewCommand_personNotInAddressBook_returnsPersonNotInAddressBookMessage() throws Exception {
+        // generate person not in addressbook, add to displayList
+        Person someone = new Person(new Name("me"),
+                                    new Phone("123", true),
+                                    new Email("[email protected]", true),
+                                    new Address("nus", false),
+                                    new UniqueTagList(Collections.emptySet()));
+        listWithAll.add(someone);
+
+        // empty addressbook
+        assertViewErrorPersonNotInAddressBook(emptyAddressBook, listWithAll, 1);
+
+        // non-empty addressbook
+        assertViewErrorPersonNotInAddressBook(addressBook, listWithAll, listWithAll.size());
+    }
+
+    @Test
+    public void viewCommand_validIndex_returnsPersonDetails() {
+        // person with no private information
+        assertViewSuccess(addressBook, listWithAll, 1);
+
+        // person with some private information
+        assertViewSuccess(addressBook, listWithAll, 2);
+
+        // addressbook has more people than displayList
+        assertViewSuccess(addressBook, listWithSome, 1);
+    }
+
+    /**
+     * Creates a new View command.
+     */
+    private Command generateViewCommand(AddressBook addressBook, List<ReadOnlyPerson> displayList, int index) {
+        ViewCommand command = new ViewCommand(index);
+        command.setData(addressBook, displayList);
+
+        return command;
+    }
+
+    /**
+     * Creates a new ViewAll command.
+     */
+    private Command generateViewAllCommand(AddressBook addressBook, List<ReadOnlyPerson> displayList, int index) {
+        Command command = new ViewAllCommand(index);
+        command.setData(addressBook, displayList);
+
+        return command;
+    }
+
+    /**
+     * Asserts that the details of the person at specific index can be successfully retrieved
+     * and displayed.
+     */
+    private void assertViewSuccess(AddressBook addressBook, List<ReadOnlyPerson> list, int index) {
+        String expectedMessage = String.format(ViewCommand.MESSAGE_VIEW_PERSON_DETAILS,
+                                               list.get(index - 1).getAsTextHidePrivate());
+        assertViewCommandBehaviour(addressBook, list, expectedMessage, index);
+
+        expectedMessage = String.format(ViewCommand.MESSAGE_VIEW_PERSON_DETAILS,
+                                        list.get(index - 1).getAsTextShowAll());
+        assertViewAllCommandBehaviour(addressBook, list, expectedMessage, index);
+    }
+
+    /**
+     * Asserts that the details of person at specific index cannot be retrieved due to
+     * invalid index.
+     */
+    private void assertViewErrorInvalidIndex(AddressBook addressBook, List<ReadOnlyPerson> list, int index) {
+        String expectedMessage = Messages.MESSAGE_INVALID_PERSON_DISPLAYED_INDEX;
+
+        assertViewCommandBehaviour(addressBook, list, expectedMessage, index);
+        assertViewAllCommandBehaviour(addressBook, list, expectedMessage, index);
+    }
+
+    /**
+     * Asserts that the details of person at specific index cannot be retrieved due to
+     * person not existing in the addressbook.
+     */
+    private void assertViewErrorPersonNotInAddressBook(AddressBook addressBook, List<ReadOnlyPerson> list, int index) {
+        String expectedMessage = Messages.MESSAGE_PERSON_NOT_IN_ADDRESSBOOK;
+
+        assertViewCommandBehaviour(addressBook, list, expectedMessage, index);
+        assertViewAllCommandBehaviour(addressBook, list, expectedMessage, index);
+    }
+
+    /**
+     * Asserts that the View command gives correct feedback information
+     */
+    private void assertViewCommandBehaviour(AddressBook addressBook, List<ReadOnlyPerson> list, String message, int index) {
+        Command command = generateViewCommand(addressBook, list, index);
+        assertCommandResult(command, message, addressBook, TestUtil.clone(addressBook));
+    }
+
+    /**
+     * Asserts that the ViewAll command gives correct feedback information
+     */
+    private void assertViewAllCommandBehaviour(AddressBook addressBook, List<ReadOnlyPerson> list, String message, int index) {
+        Command command = generateViewAllCommand(addressBook, list, index);
+        assertCommandResult(command, message, addressBook, TestUtil.clone(addressBook));
+    }
+}

test/java/seedu/addressbook/util/TestUtil.java

@@ -10,6 +10,8 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import seedu.addressbook.commands.Command;
+import seedu.addressbook.commands.CommandResult;
 import seedu.addressbook.data.AddressBook;
 import seedu.addressbook.data.exception.IllegalValueException;
 import seedu.addressbook.data.person.Address;
@@ -75,4 +77,18 @@ public static void assertTextFilesEqual(Path path1, Path path2) throws IOExcepti
         List<String> list2 = Files.readAllLines(path2, Charset.defaultCharset());
         assertEquals(String.join("\n", list1), String.join("\n", list2));
     }
+
+    /**
+     * Executes the command, and asserts the result message is as expected.
+     */
+    public static void assertCommandResult(Command command, String expectedMessage, AddressBook addressBook, 
+                                                                             AddressBook expectedAddressBook) {
+        CommandResult result = command.execute();
+
+        // asserts the result message is correct as expected
+        assertEquals(expectedMessage, result.feedbackToUser);
+
+        // TODO: overwrite equals method in AddressBook and replace with equals method below 
+        assertEquals(addressBook.getAllPersons(), expectedAddressBook.getAllPersons());
+    }
 }

test/java/seedu/addressbook/util/TypicalPersons.java

@@ -1,4 +1,7 @@
 package seedu.addressbook.util;
+
+import java.util.ArrayList;
+import java.util.List;
 
 import seedu.addressbook.data.AddressBook;
 import seedu.addressbook.data.exception.IllegalValueException;
@@ -7,23 +10,27 @@
 import seedu.addressbook.data.person.Name;
 import seedu.addressbook.data.person.Person;
 import seedu.addressbook.data.person.Phone;
+import seedu.addressbook.data.person.ReadOnlyPerson;
+import seedu.addressbook.data.tag.Tag;
 import seedu.addressbook.data.tag.UniqueTagList;
-
+ 
 /**
  * Class to generate typical test persons
  */
 public class TypicalPersons {
 
-    public Person amy, bill, candy;
+    public Person amy, bill, candy, dan;
 
     public TypicalPersons() {
         try {
             amy = new Person(new Name("Amy Buck"), new Phone("91119111", false), new Email("[email protected]", false),
                     new Address("1 Clementi Road", false), new UniqueTagList());
             bill = new Person(new Name("Bill Clint"), new Phone("92229222", false), new Email("[email protected]", false),
-                    new Address("2 Clementi Road", false), new UniqueTagList());
-            candy = new Person(new Name("Candy Destiny"), new Phone("93339333", false),
-                    new Email("[email protected]", false), new Address("3 Clementi Road", false), new UniqueTagList());
+                    new Address("2 Clementi Road", true), new UniqueTagList());
+            candy = new Person(new Name("Candy Destiny"), new Phone("93339333", true),
+                    new Email("[email protected]", false), new Address("3 Clementi Road", true), new UniqueTagList());
+            dan = new Person(new Name("Dan Smith"), new Phone("1234556", true), new Email("[email protected]", true),
+                    new Address("NUS", true), new UniqueTagList(new Tag("Test")));
         } catch (IllegalValueException e) {
             e.printStackTrace();
             assert false : "not possible";
@@ -41,7 +48,7 @@ private void loadAddressBookWithSampleData(AddressBook ab) {
     }
 
     public Person[] getTypicalPersons() {
-        return new Person[]{amy, bill, candy};
+        return new Person[]{amy, bill, candy, dan};
     }
 
     public AddressBook getTypicalAddressBook() {
@@ -50,4 +57,17 @@ public AddressBook getTypicalAddressBook() {
         return ab;
     }
 
+    public List<ReadOnlyPerson> getListWithAllPersons() {
+        List<ReadOnlyPerson> list = new ArrayList<ReadOnlyPerson>();
+        for (Person p : getTypicalPersons()) {
+            list.add(new Person(p));
+        }
+        return list;
+    }
+
+    public List<ReadOnlyPerson> getListWithSomePersons() {
+        List<ReadOnlyPerson> list = getListWithAllPersons();
+        list.remove(0); //remove a person in the list
+        return list;
+    }
 }