Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/austinadodo/the_ride_backend
The Back-End for a Ride sharing simulation application.
https://github.com/austinadodo/the_ride_backend
api-rest domain-driven-design efficient-algorithm java repository-pattern spring-data-jpa spring-mvc sql testing transactional
Last synced: about 1 month ago
JSON representation
The Back-End for a Ride sharing simulation application.
- Host: GitHub
- URL: https://github.com/austinadodo/the_ride_backend
- Owner: AustinAdodo
- Created: 2024-03-21T16:52:49.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-11-26T09:51:20.000Z (3 months ago)
- Last Synced: 2024-11-26T10:59:57.678Z (3 months ago)
- Topics: api-rest, domain-driven-design, efficient-algorithm, java, repository-pattern, spring-data-jpa, spring-mvc, sql, testing, transactional
- Language: Java
- Homepage:
- Size: 94.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TheRideBackEnd
This project was completely written with Java (Spring MVC).
## Development server
Run the project in development mode on JetBrains Intellij IDEA or your Preferred IDE and Navigate to `http://localhost:8080/`. The application will automatically reload if you change any of the source files.
It is advisable to have the back-end running first before the front end.
RabbitMQ uses `port 5672` on localhost and websocket endpoint is `http://localhost:8080/ws` .I strongly advise you leave this port open and have TCP enabled on your local machine or development server.
## RabbitMQ Integration
Ensure Erlang and RabbitMQ are both installed on your development machine and the installation is done with the administrator account to avoid complexities, by convention Erlang is installed before RabbitMQ.
You can find the solution to a common issue when configuring RabbitMQ [here](https://groups.google.com/g/rabbitmq-users/c/a6sqrAUX_Fg). This is an issue I encountered and successfully handled.
## Testing
It is important to note that H2 databases do not support UUID primary key persistence,if your preference is to configure an
internal memory for unit testing. MSSQL was utilised for testing for this reason.
- ### Unit Tests
Unit Tests were configured using the inbuilt `@SpringBootTest` also ensure you use `@TestInstance(TestInstance.Lifecycle.PER_CLASS)`
to handle test class instances more efficiently. Mocking was utilised for full isolation of the repository class.
The test below simply checks if the `IsOnlyMySexAllowed` in the `Customer` class is correctly populated.
See the unit test [here](https://github.com/AustinAdodo/The_Ride_BackEnd/blob/main/src/test/java/the_ride/the_ride_backend/TheRideUnitTests.java)
- ### Integration Tests
`The MockMvc` library ws used for mocking REST verbs ('GET','POST','PUT' etc.) for integration tests.
These tests have been completely isolated from the main classes (in this case the class `Test_Customers` was used)
but a real database was utilised.
The integration tests check the `HTTPPOST` `HTTPPUT` methods at a controller level.
See the integration tests [here](https://github.com/AustinAdodo/The_Ride_BackEnd/blob/main/src/test/java/the_ride/the_ride_backend/TheRideBackEndApplicationTests.java)
Ensure dependencies for integration test are singleton where possible (meaning one instance per Spring IoC container).For performance, consistency and simplicity.
## Entity Relationship Diagram
Below is a diagram showing the relationship between entities.
## See:
https://docs.spring.io/spring-framework/reference/core/beans/factory-scopes.html