Tests are crucial to ensuring that bugs don’t slip into the codebase unnoticed. This is especially true for large code bases where a change might lead to unintended behavior.
Let’s verify the correctness of our code by writing some tests!
Of course you can simply add the test cases manually, like you've been doing all along this tutorial. The result would be like the test cases in here. Alternatively, you can get the help of IntelliJ to generate the skeletons of the test cases, as explained in the next section.
Automatically generating tests
The goal is to write effective and efficient tests to ensure that RemarkCommand#execute() behaves as expected.
The convention for test names is methodName_testScenario_expectedResult. An example would be
-execute_filteredList_success.
Let’s create a test for RemarkCommand#execute() to test that adding a remark works. On IntelliJ IDEA you can bring up the context menu and choose to Go To > Test or use the appropriate keyboard shortcut.
Then, create a test for the execute method.
Following convention, let’s change the name of the generated method to execute_addRemarkUnfilteredList_success.
Let’s use the utility functions provided in CommandTestUtil. The functions ensure that commands produce the expected CommandResult and output the correct message. In this case, CommandTestUtil#assertCommandSuccess is the best fit as we are testing that a RemarkCommand will successfully add a Remark.
You should end up with a test that looks something like this.
Conclusion
This concludes the tutorial for adding a new Command to AddressBook.
+execute_filteredList_success.
Let’s create a test for RemarkCommand#execute() to test that adding a remark works. On IntelliJ IDEA you can bring up the context menu and choose to Go To > Test or use the appropriate keyboard shortcut.
Then, create a test for the execute method.
Following convention, let’s change the name of the generated method to execute_addRemarkUnfilteredList_success.
Let’s use the utility functions provided in CommandTestUtil. The functions ensure that commands produce the expected CommandResult and output the correct message. In this case, CommandTestUtil#assertCommandSuccess is the best fit as we are testing that a RemarkCommand will successfully add a Remark.
You should end up with a test that looks something like this.
Conclusion
This concludes the tutorial for adding a new Command to AddressBook.
