https://github.com/yotsuba1022/the-crud
Just CRUD
https://github.com/yotsuba1022/the-crud
bdd crud cucumber cucumber-jvm docker-compose gherkin h2-database jasypt java junit lombok maven mybatis mysql spring-boot swagger2 tdd travis-ci
Last synced: about 1 month ago
JSON representation
Just CRUD
- Host: GitHub
- URL: https://github.com/yotsuba1022/the-crud
- Owner: yotsuba1022
- License: apache-2.0
- Created: 2018-10-13T09:27:36.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-01-25T07:44:09.000Z (3 months ago)
- Last Synced: 2025-01-25T08:24:34.577Z (3 months ago)
- Topics: bdd, crud, cucumber, cucumber-jvm, docker-compose, gherkin, h2-database, jasypt, java, junit, lombok, maven, mybatis, mysql, spring-boot, swagger2, tdd, travis-ci
- Language: Java
- Size: 104 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# The CRUD
[]()
[]()
The general lifestyle of the web developer. No matter how professional/hard the techniques you used. You're still doing the CRUD, this repository is just a side project which wants to demo the technical diversity of CRUD in Java ecosystem. You can CRUD this way, CRUD that way. It's just the CRUD, which gives us a job and money.
## Modules
This side project contains the following modules:
- User module: Dealing with user related business logic.
## Environment, Technical Stack and Components
- Operating System: macOS (Mojave)
- Container Platform: Docker (18.09.2)
- Development Language: Java (Amazon Corretto - 17)
- [Download Link](https://docs.aws.amazon.com/corretto/latest/corretto-11-ug/downloads-list.html)
- Web Container: Tomcat (Spring-boot embedded)
- Application Framework: Spring Boot (3.0.5 RELEASE)
- Database:
- MySQL (8.0.20)
- H2 (For test purpose only)
- Persistence layer: [MyBatis](http://www.mybatis.org/mybatis-3/) (3.5.17)
- Cryptography: [Jasypt](http://www.jasypt.org/) (3.0.5)
- Unit Test: [JUnit](https://junit.org/junit5/) (jupiter)
- Build Tool: [Maven](https://maven.apache.org/) (3.9.9)
- API Documentation: [Swagger](https://swagger.io/)
## Setup Commands for Docker Environment
Before executing the commands in this block, please ensure that you already installed docker on your local machine.
1. Clone this repository with the following command:
```
https://github.com/yotsuba1022/the-crud.git
```
2. Move into the root path of the project you cloned.
3. Execute the following command to build image then start all containers as daemon process.
```
$ docker-compose down; docker-compose up --build -d; docker rmi $(docker images -q -f "dangling=true" -f "label=autodelete=true");
```
3.1 The last part of the preceding command:
```
$ docker rmi $(docker images -q -f "dangling=true" -f "label=autodelete=true")
```
- Means that to remove all intermediate/dangling images.
4. Fnish all containers by the following command when you want to shut down all of them:
```
$ docker-compose down
```
5. Remember to clean up the MySQL data folder with cleanup-mysql-data.sh (not mandatory)
```
$ sh cleanup-mysql-data.sh
```
## Setup Commands for Local Environment
1. Compile, build, and test the Spring Boot app:
```
$ mvn clean test package
```
2. Launch the service:
```
$ mvn spring-boot:run
```
## Sample CURL Commands
###### Create User
```
$ curl -v -H "Content-Type:application/json" -X POST "http://localhost:8080/the-crud/api/v1/users" -d '{"username":"rabido1022","password":"!QAZ2wsx","firstName":"Rabido","lastName":"JOJO","birthday":"1988-10-22T09:15:01","age":30,"gender":"MALE","registrationDate":"2019-01-03T23:15:01","test":false,"admin":true,"suspended":false,"vip":true}'
```
###### Update User
```
$ curl -v -H "Content-Type:application/json" -X PUT "http://localhost:8080/the-crud/api/v1/users/26" -d '{"firstName":"JOJO", "lastName":"Lue", "birthday":"1988-10-22T23:15:15", "age":30, "gender":"MALE", "admin":true, "vip":true, "test":true, "suspended":true}'
```
###### Get User
```
$ curl -v -X GET "http://localhost:8080/the-crud/api/v1/users/1"
```
###### Query Users
```
$ curl -v -X GET "http://localhost:8080/the-crud/api/v1/users?id=1"
$ curl -v -X GET "http://localhost:8080/the-crud/api/v1/users?isVip=true&firstName=Rabido"
```
###### Delete User
```
$ curl -v -X DELETE "http://localhost:8080/the-crud/api/v1/users/23"
```
## Automation Test Scripts
### Bruno Collections
- Please refer to the Bruno collection under `the-crud/client-scripts/bruno` folder, the RESTful collections will be arranged by modules.
### Current modules
| Module Name |
|-------------|
| user_module |
### How to Perform the Automation Test?
- Launch the whole app environment via docker compose and make sure it works as expected.
- Download bruno from the [official site](https://www.usebruno.com/) (It's free and will not expose your data in the could).
- Import the test module you want to try.
- Move to the automation test folder under the bruno module, click the option menu of the test, then choose "Run".
- 
- Adjust the test parameters according to your needs, then click "Run".
- 
- Then, you should be able to see the result.
## Swagger UI Links
- [Default Link](http://localhost:8080/the-crud/swagger-ui.html#/)