Milestone 4

Database Installation

Connection Data Configuration

1. In the file 'milestone4/data/sql/connection_data.conf' edit the username and password to match your sql profile.

Quick Installation

1. You will need to download the 'AISTestData_dump.mysql' file and place it in the 'data/sql' directory.

2. Run the 'quickInstallDatabase.py' for quick install.  

3. Tables must be populated for the tests to work; when prompted, respond 'y' to ensure the tables are populated.

Manual Installation

1. Creating the database and the tables:
Move to the 'data/sql' directory and run the following commands in powershell or bash.

Windows

\> Get-Content AISTestDataCreateTables.mysql | mysql -u \<user> -p --password=\<password>

Mac

>$ mysql -u \<user> -p --password=\<password> < AISTestDataCreateTables.mysql

2. Populating the database:
Download the 'AISTestData_dump.mysql' (not found in this repository), and move it to the 'data/sql' directory.
Or just download and move to the directory wherever you saved the file, and then run the following command in powershell or bash.

Windows

\> Get-Content AISTestData_dump.mysql | mysql -u \<user> -p --password=\<password>

Mac

$ mysql -u \<user> -p --password=\<password> < AISTestData_dump.mysql

Trouble Shooting

Be sure to use the provided AISTestData_dump.sql file

Testing

1. Ensure the data base is unaltered. If you just installed the database, it will be ready to run tests. If you have ran the tests, you will need to reinitialize the database before running the tests again. In the case of running the tests without reinitializing the database, there will be one failed test for delete_msgs_older_5min.

2. Navigate to 'milestone4/data/python' folder

3. Run the 'testDAO.py'

4. The testDAO.py DOES NOT reinitialize the database before or after testing.

5. Reinitialize the database before executing individual functions to ensure you have an unaltered data set.

Trouble Shooting

Ensure database was installed correctly
Ensure AISTestData_dump.sql is in the sql folder
Ensure python is up-to-date
Ensure the mysql-connector-python V 8.0.23 package is installed

Interface Tests

All functions have passing interface tests.

Integration Tests

Integreation tests for these functions are created but assert True.

read_all_ship_positions_from_tile_scale3
read_all_ship_positions_to_port
read_all_ships_headed_to_port

Additional Documentation

You can find more detailed descriptions of the functions and their docstrings by opening this file in your browser.

hunterdurbin / MileStone4