Junhao Lin, Ruize Li, Ken Xiong, Jianyang Duan
Link to our second iteration client repository We decide to demo personal user related use case, i.e. personal end users can view the feed, make money requests/transfers to someone else, view their user profile and deposit/withdraw money. You can think of venmo/zelle as a real-life example. For details about end-to-end tests, please go to the README of the client repository.
Our service has integrated authentication service along with additional money services targeting different types of users and use cases. Third party developers need to first setup using our auth service, and handle unauthorized errors properly in the client, as most of our services are not available without logging in. One exception is that the search service does not require auth, and developers should gate it properly for DoS reasons.
We provided some common money service apis that are mostly extensible, clients can achieve more complex features by extending our services with their own code, or even other services. For example, the addresses can be integrated with some auto complete address service, and same thing for the telephones, emails, and so on. In our setting, one user has one bank account, and clients can further this and can potentially integerate it with some banking service to include multiple bank accounts.
We set up GitHub Actions and run all tests (unit tests, integration tests, SonarQube scan and Postman API tests) using JUnit, JaCoCo
coverage report, SonarCloud plugin and newman. The actions workflow will update two badges, as shown at the very top of the Readme: one is showing the branch coverages, and the other one is the overall coverage. The workflow will also update the report on SonarCloud which can be viewed by clicking on the bugs badge above. For more test outputs, go to the Actions tab, select a run and then click on "run_tests" on the left.
To check the coverage locally, you can use Intellij client to open this repo, and configure JaCoCo coverage report, and run all tests with coverage.
- Install JDK 17 and MySQL server (version >= 8)
- Create a schema named "4156db" in your local MySQL server
- Enter the username and the password of your local MySQL server in src/main/resources/application.properties
- By default, the service runs on port 8080. If you wish to use a different port, enter
server.port=<port no.>in src/main/resources/application.properties - Run
./mvnw - Run
java -jar ./target/easymoney-0.0.1-SNAPSHOT.war
- Restart the application, or manually clear all entries in your local database.
- Open Postman web and go to your workspace
- Select "Collections" on the left, and then click "Import"
- Click "Upload files", select system_tests.postman_collection.json in this repository, and click "Import"
- Once the collection is imported to your workspace, take a look at the test requests within:
- Create different types of users
- Deposit money
- Create, accept, decline and retrieve money requests
- Create a group with different types of users
- Personal users can get a list of ads from the business users within the same group
- Get user profiles by id or search text
- Add and accept friendship (only available to personal users)
- Get personal feed which includes friend activities
- Create, accept, decline and retrieve loan requests (a loan request must be from a personal user to a financial user)
- Before you can execute the test requests, you may need to install Postman desktop agent. Just follow the instructions from Postman.
- Execute the test requests IN ORDER. You should observe that the HTTP status codes will be either 200 or 201, and the response bodies (sometimes empty because our client implementation will check HTTP status code first).
- If you'd like to rerun all the test requests, redo step 1.
- Create a schema named "4156dbtest" in your local MySQL server
- Enter the username and the password of your local MySQL server in src/test/resources/application.properties
- By default, the service runs on port 8080. If you wish to use a different port, enter
server.port=<port no.>in src/test/resources/application.properties - Install Maven (>=3.8.6 recommended) if you haven't done so
- Run
mvn clean test
You can view an online version here.
Alternatively, if you'd like to see immediate documentation update after you change the local code: Run the service locally, and then open your browser. The API documentation can be viewed in 3 ways (change the port below if needed):
- UI (recommended): http://localhost:8080/swagger-ui/index.html
- JSON: http://localhost:8080/api-docs
- Download the YAML: http://localhost:8080/api-docs.yaml
These are mostly defined in pom.xml and downloaded by Maven.
- Spring: Handles client requests, returns responses to clients, and manages beans. Used everywhere.
- Spring validation: Validates data fields in client requests. Mainly used in src/main/java/com/lgtm/easymoney/models.
- JPA: Interacts with the database. Mainly used under src/main/java/com/lgtm/easymoney/repositories.
- lombok: Simplifies the code by avoiding manually writing getters, setters, etc. Mainly used in src/main/java/com/lgtm/easymoney/models and src/main/java/com/lgtm/easymoney/payload.
We also utilized Spring Security and the JWT implementation from https://github.com/isopropylcyanide/Jwt-Spring-Security-JPA/tree/master/src/main/java/com/accolite/pru/health/AuthApp/security which is in src/main/java/com/lgtm/easymoney/security.
We follow style rules of Google checks. You may see warnings/errors if you run style checking with other configs.
Below is the screenshot for checking entire project using checkstyle plugin from intellij, no errors occured.
Our service is hosted on http://easymoneytest-env.eba-gxycxg4j.us-east-1.elasticbeanstalk.com/.
This repo also includes a collection of Postman test requests for the deployed service. You can import it to your Postman workspace by following steps 2-4 of the instructions above, but keep in mind that these are just API invocation examples. Before sending requests to the remote server, many of the request parameters need to be modified as the remote database may already contain relevant records.