CST8277 (22W) Assignment 3: BloodBank (JPA Mapping & JUnit Tests)
Theme for Assignment 3:
After completing this assignment, you will have achieved the following:
- Gain experience in mapping a real-world database schema to POJOs
- Gain experience in creating complex JPA queries
- Gain experience in building JUnit test cases
- Use the Maven ‘Surefire’ plugin to generate a pass-fail report for all test cases
Download and importing the project to your Eclipse workspace: - Download BloodBank-JPA-Mapping-Junit-Skeleton.zip
- Unzip the content to some location
- Go to File menu, choose Open Projects from File System
- On the Import source, choose the location of the project folder
- Make sure that there is a check mark beside the project folder
- Click Finish
- To generate the
_.java files, right-click on the project name, select Properties - Select JPA on the left, and on Canonical metamodel (JPA 2.0), on the Source folder dropdown,
select src/main/java, and finally click Apply and Close; after you fix the errors on the classes, the_.java files will be auto-generated
After you have imported the project to your Eclipse workspace, do the following steps to view all the
TODOs/tasks and hints for this assignment: - Go to Window menu, select Preferences
- Type “task” on the “type filter text” textbox on the left
- Under Java Compiler, you should see “Task Tags”
- Select Task Tags and on the right, make sure the Enable project specific settings is checked, and
then click New… - On the Tag text box, type “Hint”
- On the Priority dropdown, select Low and click OK
- Click Apply (Note: you have to let Eclipse rebuild your project if it asks) and then click Apply and
Close - If you don’t see the Tasks on your Eclipse, do the following:
a. Go to Window menu, select Show View, select Other…
b. Under General, select Tasks and click Open - To filter the tasks, do the following:
a. On the Tasks bar, select the filter icon on the right
b. It should bring up the Filters window
c. Make sure that Show all items is not checked
d. Make sure that TODOs is checked
e. Under Scope, make sure that On elements in selected projects is selected
f. Then click New…, select New Configuration, click Rename, enter “Hints” on the
Configuration Name pop-up, and then click OK
g. Again, make sure that On elements in selected projects is selected for Hints
h. Then under Description, type in “Hint” beside Text: contains and click Apply and Close
i. Then make sure that Show all items checkbox is checked on the Filters window
Approach for this assignment: - First of all, finish all the TODOs in the models (e.g. Person, Phone, DonationRecord,
BloodDonation, BloodBank, PrivateBloodBank, PublicBloodBank, etc.); you may use the Address
and Contact entities as guides/references in completing the other entities/models - Refer to the attached ER and class diagrams (BloodBank-Diagrams.pdf) to understand how the
entities and tables are related to each other; you must annotate the classes/entities based on
how they are related as shown in BloodBank-Diagrams.pdf - After finishing the TODOs in the models, next is to write your test cases for the rest of the
models (a sample has already been provided for Contact (i.e. TestCRUDContactOriginal.java));
Note: You should be able to run TestCRUDContactOriginal.java after fixing the models. - At the very least, you have to write test cases for Person, Address, Phone, & DonationRecord
- Note that you have to also finish the TODOs in JUnitBase.java; the methods getTotalCount(),
getAll(), getWithId(), and getCountWithId() are all optional and you do not have to complete
them…however, they will greatly help reduce code repetition once you have completed them
and used them in your own JUnit test classes
Note: The BloodBankDriver.java is the driver class for the project. It is a basic class and you do not have
to do anything here. When it is executed, it initializes the database for the project. It also populates the
database with some data as can be seen inside the addSampleData() method. The driver class uses the
following files to initialize the database:
src/main/resources/META-INF/persistence.xml
src/main/resources/META-INF/sql/bloodbank-drop.sql
src/main/resources/META-INF/sql/bloodbank-create.sql
Inside persistence.xml file, it defines the following properties:
As can be seen above, every time the application is run, it first drops the database (using the script
bloodbank-drop.sql) and then creates it (using the script bloodbank-create.sql).
JUnit tests:
In this assignment, JUnitBase should serve as the base class of your JUnit test classes that you will
create. The following methods are required to be implemented:
deleteAllData()
deleteAllFrom() – this method is called by deleteAllData() several times to delete the contents of
tables in the database
The following methods below are not required to be implemented. However, completing and invoking
them will greatly help reduce code repetition in completing this assignment.
getTotalCount()
getAll()
getWithId()
getCountWithId()
Once the above 4 methods are implemented, you can invoke them in your JUnit test classes.
Note: Method setupAll() (annotated with @BeforeAll) is invoked before all test cases are executed and
method tearDownAll() (annotated with @AfterAll) is called after all test cases are performed.
Please refer to TestCRUDContactOriginal.java on how to write your JUnit test classes for the remaining
entities.
To order your test cases, use the following annotations in your JUnit test class (please also see
TestCRUDContactOriginal.java):
@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
@Order(1), @Order(2), @Order(3), …
Ideally, each test case should be completely independent of other test cases.
Note that for each JUnit test class that you write, it should contain around eight (8) individual test cases
(similar to TestCRUDContactOriginal.java).
Once you have completed the tasks above, do the following to build and test your assignment:
- Right-click on your BloodBankDriver.java and choose Run As and then choose Java Application
- Make sure there are no errors reported on the console
- Then, run your JUnit tests:
a. To run your JUnit tests individually, right-click on your JUnit test class (e.g.
TestCRUDContactOriginal.java) and choose Run As and then choose JUnit Test; make
sure that all your test cases passed
b. To build your project and run all the test cases, right-click on your project, choose Run
As, select Maven build…, on the Goals text box type (without the double-quotes):
“clean install test surefire-report:report site -DgenerateReports=false”
c. The above will generate target/site/surefire-report.html file which will show the results
of the test cases when opened with a web browser
Submission:
Zip your entire project folder (Note: please do not include the target sub-folder) and submit the zip file
on Brightspace/Activities/Assignments/Assignment 3. Name your zip file as follows:_22WAssignment3.zip
Example: yap_teddy_12345_22WAssignment3.zip
– End –