forked from nus-cs2103-AY1617S1/addressbook-level4
-
Notifications
You must be signed in to change notification settings - Fork 0
/
LogicManagerTest.java
500 lines (417 loc) · 19.4 KB
/
LogicManagerTest.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
package seedu.address.logic;
import com.google.common.eventbus.Subscribe;
import org.junit.After;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import seedu.address.commons.core.EventsCenter;
import seedu.address.logic.commands.*;
import seedu.address.commons.events.ui.JumpToListRequestEvent;
import seedu.address.commons.events.ui.ShowHelpRequestEvent;
import seedu.address.commons.events.model.AddressBookChangedEvent;
import seedu.address.model.AddressBook;
import seedu.address.model.Model;
import seedu.address.model.ModelManager;
import seedu.address.model.ReadOnlyAddressBook;
import seedu.address.model.person.*;
import seedu.address.model.tag.Tag;
import seedu.address.model.tag.UniqueTagList;
import seedu.address.storage.StorageManager;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.TimeZone;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static seedu.address.commons.core.Messages.*;
public class LogicManagerTest {
/**
* See https://github.com/junit-team/junit4/wiki/rules#temporaryfolder-rule
*/
@Rule
public TemporaryFolder saveFolder = new TemporaryFolder();
private Model model;
private Logic logic;
//These are for checking the correctness of the events raised
private ReadOnlyAddressBook latestSavedAddressBook;
private boolean helpShown;
private int targetedJumpIndex;
@Subscribe
private void handleLocalModelChangedEvent(AddressBookChangedEvent abce) {
latestSavedAddressBook = new AddressBook(abce.data);
}
@Subscribe
private void handleShowHelpRequestEvent(ShowHelpRequestEvent she) {
helpShown = true;
}
@Subscribe
private void handleJumpToListRequestEvent(JumpToListRequestEvent je) {
targetedJumpIndex = je.targetIndex;
}
@Before
public void setup() {
model = new ModelManager();
String tempAddressBookFile = saveFolder.getRoot().getPath() + "TempAddressBook.xml";
String tempPreferencesFile = saveFolder.getRoot().getPath() + "TempPreferences.json";
logic = new LogicManager(model, new StorageManager(tempAddressBookFile, tempPreferencesFile));
EventsCenter.getInstance().registerHandler(this);
latestSavedAddressBook = new AddressBook(model.getAddressBook()); // last saved assumed to be up to date before.
helpShown = false;
targetedJumpIndex = -1; // non yet
}
@After
public void teardown() {
EventsCenter.clearSubscribers();
}
@Test
public void execute_invalid() throws Exception {
String invalidCommand = " ";
assertCommandBehavior(invalidCommand,
String.format(MESSAGE_INVALID_COMMAND_FORMAT, HelpCommand.MESSAGE_USAGE));
}
/**
* Executes the command and confirms that the result message is correct.
* Both the 'address book' and the 'last shown list' are expected to be empty.
* @see #assertCommandBehavior(String, String, ReadOnlyAddressBook, List)
*/
private void assertCommandBehavior(String inputCommand, String expectedMessage) throws Exception {
assertCommandBehavior(inputCommand, expectedMessage, new AddressBook(), Collections.emptyList());
}
/**
* Executes the command and confirms that the result message is correct and
* also confirms that the following three parts of the LogicManager object's state are as expected:<br>
* - the internal address book data are same as those in the {@code expectedAddressBook} <br>
* - the backing list shown by UI matches the {@code shownList} <br>
* - {@code expectedAddressBook} was saved to the storage file. <br>
*/
private void assertCommandBehavior(String inputCommand, String expectedMessage,
ReadOnlyAddressBook expectedAddressBook,
List<? extends ReadOnlyTask> expectedShownList) throws Exception {
//Execute the command
CommandResult result = logic.execute(inputCommand);
//Confirm the ui display elements should contain the right data
assertEquals(expectedMessage, result.feedbackToUser);
assertEquals(expectedShownList, model.getFilteredPersonList());
//Confirm the state of data (saved and in-memory) is as expected
assertEquals(expectedAddressBook, model.getAddressBook());
assertEquals(expectedAddressBook, latestSavedAddressBook);
}
@Test
public void execute_unknownCommandWord() throws Exception {
String unknownCommand = "uicfhmowqewca";
assertCommandBehavior(unknownCommand, MESSAGE_UNKNOWN_COMMAND);
}
@Test
public void execute_help() throws Exception {
assertCommandBehavior("help", HelpCommand.SHOWING_HELP_MESSAGE);
assertTrue(helpShown);
}
@Test
public void execute_exit() throws Exception {
assertCommandBehavior("exit", ExitCommand.MESSAGE_EXIT_ACKNOWLEDGEMENT);
}
@Test
public void execute_clear() throws Exception {
TestDataHelper helper = new TestDataHelper();
model.addPerson(helper.generatePerson(1));
model.addPerson(helper.generatePerson(2));
model.addPerson(helper.generatePerson(3));
assertCommandBehavior("clear", ClearCommand.MESSAGE_SUCCESS, new AddressBook(), Collections.emptyList());
}
@Test
public void execute_add_invalidArgsFormat() throws Exception {
String expectedMessage = String.format(MESSAGE_INVALID_COMMAND_FORMAT, AddCommand.MESSAGE_USAGE);
assertCommandBehavior(
"add Valid Name 12345 e/valid@email.butNoPhonePrefix a/valid, address", expectedMessage);
assertCommandBehavior(
"add Valid Name p/12345 valid@email.butNoPrefix a/valid, address", expectedMessage);
assertCommandBehavior(
"add Valid Name p/12345 e/valid@email.butNoAddressPrefix valid, address", expectedMessage);
}
@Test
public void execute_add_invalidPersonData() throws Exception {
assertCommandBehavior(
"add []\\[;] d/12345 date/11-11-2018 1111", Name.MESSAGE_NAME_CONSTRAINTS);
assertCommandBehavior(
"add Valid Name d/can_be_anything date/ab-cd-ef", Date.MESSAGE_DATE_CONSTRAINTS);
//TODO assertCommandBehavior(
// "add Valid Name d/can_be_anything date/11-11-2018 5678pm", Time.MESSAGE_TIME_CONSTRAINTS);
assertCommandBehavior(
"add Valid Name d/can_be_anything date/11-11-2018 1111 t/invalid_-[.tag", Tag.MESSAGE_TAG_CONSTRAINTS);
}
@Test
public void execute_add_successful() throws Exception {
// setup expectations
TestDataHelper helper = new TestDataHelper();
Task toBeAdded = helper.adam();
AddressBook expectedAB = new AddressBook();
expectedAB.addPerson(toBeAdded);
// execute command and verify result
assertCommandBehavior(helper.generateAddCommand(toBeAdded),
String.format(AddCommand.MESSAGE_SUCCESS, toBeAdded),
expectedAB,
expectedAB.getPersonList());
}
@Test
public void execute_addDuplicate_notAllowed() throws Exception {
// setup expectations
TestDataHelper helper = new TestDataHelper();
Task toBeAdded = helper.adam();
AddressBook expectedAB = new AddressBook();
expectedAB.addPerson(toBeAdded);
// setup starting state
model.addPerson(toBeAdded); // person already in internal address book
// execute command and verify result
assertCommandBehavior(
helper.generateAddCommand(toBeAdded),
AddCommand.MESSAGE_DUPLICATE_PERSON,
expectedAB,
expectedAB.getPersonList());
}
/**
* Confirms the 'invalid argument index number behaviour' for the given command
* targeting a single person in the shown list, using visible index.
* @param commandWord to test assuming it targets a single person in the last shown list based on visible index.
*/
private void assertIncorrectIndexFormatBehaviorForCommand(String commandWord, String expectedMessage) throws Exception {
assertCommandBehavior(commandWord , expectedMessage); //index missing
assertCommandBehavior(commandWord + " +1", expectedMessage); //index should be unsigned
assertCommandBehavior(commandWord + " -1", expectedMessage); //index should be unsigned
assertCommandBehavior(commandWord + " 0", expectedMessage); //index cannot be 0
assertCommandBehavior(commandWord + " not_a_number", expectedMessage);
}
/**
* Confirms the 'invalid argument index number behaviour' for the given command
* targeting a single person in the shown list, using visible index.
* @param commandWord to test assuming it targets a single person in the last shown list based on visible index.
*/
private void assertIndexNotFoundBehaviorForCommand(String commandWord) throws Exception {
String expectedMessage = MESSAGE_INVALID_PERSON_DISPLAYED_INDEX;
TestDataHelper helper = new TestDataHelper();
List<Task> personList = helper.generatePersonList(2);
// set AB state to 2 persons
model.resetData(new AddressBook());
for (Task p : personList) {
model.addPerson(p);
}
assertCommandBehavior(commandWord + " 3", expectedMessage, model.getAddressBook(), personList);
}
@Test
public void execute_selectInvalidArgsFormat_errorMessageShown() throws Exception {
String expectedMessage = String.format(MESSAGE_INVALID_COMMAND_FORMAT, SelectCommand.MESSAGE_USAGE);
assertIncorrectIndexFormatBehaviorForCommand("select", expectedMessage);
}
@Test
public void execute_selectIndexNotFound_errorMessageShown() throws Exception {
assertIndexNotFoundBehaviorForCommand("select");
}
@Test
public void execute_select_jumpsToCorrectPerson() throws Exception {
TestDataHelper helper = new TestDataHelper();
List<Task> threePersons = helper.generatePersonList(3);
AddressBook expectedAB = helper.generateAddressBook(threePersons);
helper.addToModel(model, threePersons);
assertCommandBehavior("select 2",
String.format(SelectCommand.MESSAGE_SELECT_PERSON_SUCCESS, 2),
expectedAB,
expectedAB.getPersonList());
assertEquals(1, targetedJumpIndex);
assertEquals(model.getFilteredPersonList().get(1), threePersons.get(1));
}
@Test
public void execute_deleteInvalidArgsFormat_errorMessageShown() throws Exception {
String expectedMessage = String.format(MESSAGE_INVALID_COMMAND_FORMAT, DeleteCommand.MESSAGE_USAGE);
assertIncorrectIndexFormatBehaviorForCommand("delete", expectedMessage);
}
@Test
public void execute_deleteIndexNotFound_errorMessageShown() throws Exception {
assertIndexNotFoundBehaviorForCommand("delete");
}
@Test
public void execute_delete_removesCorrectPerson() throws Exception {
TestDataHelper helper = new TestDataHelper();
List<Task> threePersons = helper.generatePersonList(3);
AddressBook expectedAB = helper.generateAddressBook(threePersons);
expectedAB.removePerson(threePersons.get(1));
helper.addToModel(model, threePersons);
assertCommandBehavior("delete 12",
String.format(DeleteCommand.MESSAGE_DELETE_PERSON_SUCCESS, threePersons.get(1)),
expectedAB,
expectedAB.getPersonList());
}
@Test
public void execute_find_invalidArgsFormat() throws Exception {
String expectedMessage = String.format(MESSAGE_INVALID_COMMAND_FORMAT, FindCommand.MESSAGE_USAGE);
assertCommandBehavior("find ", expectedMessage);
}
@Test
public void execute_find_onlyMatchesFullWordsInNames() throws Exception {
TestDataHelper helper = new TestDataHelper();
Task pTarget1 = helper.generatePersonWithName("bla bla KEY bla");
Task pTarget2 = helper.generatePersonWithName("bla KEY bla bceofeia");
Task p1 = helper.generatePersonWithName("KE Y");
Task p2 = helper.generatePersonWithName("KEYKEYKEY sduauo");
List<Task> fourPersons = helper.generatePersonList(p1, pTarget1, p2, pTarget2);
AddressBook expectedAB = helper.generateAddressBook(fourPersons);
List<Task> expectedList = helper.generatePersonList(pTarget1, pTarget2);
helper.addToModel(model, fourPersons);
assertCommandBehavior("find KEY",
Command.getMessageForPersonListShownSummary(expectedList.size()),
expectedAB,
expectedList);
}
@Test
public void execute_find_isNotCaseSensitive() throws Exception {
TestDataHelper helper = new TestDataHelper();
Task p1 = helper.generatePersonWithName("bla bla KEY bla");
Task p2 = helper.generatePersonWithName("bla KEY bla bceofeia");
Task p3 = helper.generatePersonWithName("key key");
Task p4 = helper.generatePersonWithName("KEy sduauo");
List<Task> fourPersons = helper.generatePersonList(p3, p1, p4, p2);
AddressBook expectedAB = helper.generateAddressBook(fourPersons);
List<Task> expectedList = fourPersons;
helper.addToModel(model, fourPersons);
assertCommandBehavior("find KEY",
Command.getMessageForPersonListShownSummary(expectedList.size()),
expectedAB,
expectedList);
}
@Test
public void execute_find_matchesIfAnyKeywordPresent() throws Exception {
TestDataHelper helper = new TestDataHelper();
Task pTarget1 = helper.generatePersonWithName("bla bla KEY bla");
Task pTarget2 = helper.generatePersonWithName("bla rAnDoM bla bceofeia");
Task pTarget3 = helper.generatePersonWithName("key key");
Task p1 = helper.generatePersonWithName("sduauo");
List<Task> fourPersons = helper.generatePersonList(pTarget1, p1, pTarget2, pTarget3);
AddressBook expectedAB = helper.generateAddressBook(fourPersons);
List<Task> expectedList = helper.generatePersonList(pTarget1, pTarget2, pTarget3);
helper.addToModel(model, fourPersons);
assertCommandBehavior("find key rAnDoM",
Command.getMessageForPersonListShownSummary(expectedList.size()),
expectedAB,
expectedList);
}
/**
* A utility class to generate test data.
*/
class TestDataHelper{
Task adam() throws Exception {
Name name = new Name("Adam Brown");
Description privatePhone = new Description("111111");
List<java.util.Date> dateList =
(new com.joestelmach.natty.Parser(TimeZone.getDefault())).parse("11-11-2011 1111").get(0).getDates();
Date email = new Date(dateList);
Time privateAddress = new Time(dateList);
Tag tag1 = new Tag("tag1");
Tag tag2 = new Tag("tag2");
UniqueTagList tags = new UniqueTagList(tag1, tag2);
return new Task(name, privatePhone, email, privateAddress, tags);
}
/**
* Generates a valid person using the given seed.
* Running this function with the same parameter values guarantees the returned person will have the same state.
* Each unique seed will generate a unique Person object.
*
* @param seed used to generate the person data field values
*/
Task generatePerson(int seed) throws Exception {
return new Task(
new Name("Person " + seed),
new Description("" + Math.abs(seed)),
new Date("11.11.201" + seed),
new Time("111" + seed),
new UniqueTagList(new Tag("tag" + Math.abs(seed)), new Tag("tag" + Math.abs(seed + 1)))
);
}
/** Generates the correct add command based on the person given */
String generateAddCommand(Task p) {
StringBuffer cmd = new StringBuffer();
cmd.append("add ");
cmd.append(p.getName().toString());
cmd.append(" d/").append(p.getDescription());
cmd.append(" date/").append(p.getDate().toString().replace('.', '-'));
cmd.append(" ").append(p.getTime());
UniqueTagList tags = p.getTags();
for(Tag t: tags){
cmd.append(" t/").append(t.tagName);
}
return cmd.toString();
}
/**
* Generates an AddressBook with auto-generated persons.
*/
AddressBook generateAddressBook(int numGenerated) throws Exception{
AddressBook addressBook = new AddressBook();
addToAddressBook(addressBook, numGenerated);
return addressBook;
}
/**
* Generates an AddressBook based on the list of Persons given.
*/
AddressBook generateAddressBook(List<Task> persons) throws Exception{
AddressBook addressBook = new AddressBook();
addToAddressBook(addressBook, persons);
return addressBook;
}
/**
* Adds auto-generated Person objects to the given AddressBook
* @param addressBook The AddressBook to which the Persons will be added
*/
void addToAddressBook(AddressBook addressBook, int numGenerated) throws Exception{
addToAddressBook(addressBook, generatePersonList(numGenerated));
}
/**
* Adds the given list of Persons to the given AddressBook
*/
void addToAddressBook(AddressBook addressBook, List<Task> personsToAdd) throws Exception{
for(Task p: personsToAdd){
addressBook.addPerson(p);
}
}
/**
* Adds auto-generated Person objects to the given model
* @param model The model to which the Persons will be added
*/
void addToModel(Model model, int numGenerated) throws Exception{
addToModel(model, generatePersonList(numGenerated));
}
/**
* Adds the given list of Persons to the given model
*/
void addToModel(Model model, List<Task> personsToAdd) throws Exception{
for(Task p: personsToAdd){
model.addPerson(p);
}
}
/**
* Generates a list of Persons based on the flags.
*/
List<Task> generatePersonList(int numGenerated) throws Exception{
List<Task> persons = new ArrayList<>();
for(int i = 1; i <= numGenerated; i++){
persons.add(generatePerson(i));
}
return persons;
}
List<Task> generatePersonList(Task... persons) {
return Arrays.asList(persons);
}
/**
* Generates a Person object with given name. Other fields will have some dummy values.
*/
Task generatePersonWithName(String name) throws Exception {
List<java.util.Date> dateList =
(new com.joestelmach.natty.Parser(TimeZone.getDefault())).parse("10-11-2019 1111").get(0).getDates();
return new Task(
new Name(name),
new Description("Describes task"),
new Date(dateList),
new Time(dateList),
new UniqueTagList(new Tag("tag"))
);
}
}
}