Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matheus-srego/challenge_brmalls
This challenge was developed as part of the selection process for the Java Developer position at brMalls.
https://github.com/matheus-srego/challenge_brmalls
api docker docker-compose hibernate java maven mysql postman spring-boot
Last synced: 28 days ago
JSON representation
This challenge was developed as part of the selection process for the Java Developer position at brMalls.
- Host: GitHub
- URL: https://github.com/matheus-srego/challenge_brmalls
- Owner: matheus-srego
- License: mit
- Created: 2021-06-10T01:48:01.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-11T02:31:37.000Z (3 months ago)
- Last Synced: 2024-09-12T07:37:31.841Z (3 months ago)
- Topics: api, docker, docker-compose, hibernate, java, maven, mysql, postman, spring-boot
- Language: Java
- Homepage:
- Size: 224 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Back-end Challenge - brMalls
[](https://github.com/matheus-srego/challenge_brmalls/actions/workflows/ci.yaml)
[➜ Leia-me em Português](tools/readme/README.pt-BR.md)
## Table of Contents
- [Stack](#stack)
- [Project tree](#project-tree)
- [About the Challenge and the Project](#about-the-challenge-and-the-project)
- [Solution Details](#solution-details)
- [How to Run the Project](#how-to-run-the-project)
- [Running Unit Tests](#running-unit-tests)
- [Placeholder Substitution](#placeholder-substitution)
- [License](#license)
- [Acknowledgment](#acknowledgment)
## Stack
- `Java 17`
- `Spring Boot 3.3.2`
- `Maven 3.8.4`
- `Hibernate 6.5.2`
- `JUnit 5.10.3`
- `MySQL 8.0`
- `RestTemplate` (for API integration)
- `RegEx`
- `Docker`
- `Postman`
Project tree
```bash
.
├── LICENSE
├── README.md
├── docker-compose.yml
├── mysql
│ ├── Dockerfile
│ └── queries
│ ├── 0.database.sql
│ ├── 1.table_empresa.sql
│ └── 2.insert_data.sql
├── tools
│ ├── postman
│ │ └── challange_brmalls.postman_collection.json
│ ├── readme
│ │ └── README.pt-BR.md
│ └── scripts
│ ├── clean.sh
│ ├── docker_java.sh
│ ├── docker_mysql.sh
│ └── wait-for-mysql.sh
└── xpto
├── Dockerfile
├── mvnw
├── mvnw.cmd
├── pom.xml
└── src
├── main
│ ├── java
│ │ └── br
│ │ └── com
│ │ └── brmalls
│ │ └── xpto
│ │ ├── XptoApplication.java
│ │ ├── controllers
│ │ │ ├── CompanyController.java
│ │ │ └── TestDockerController.java
│ │ ├── daos
│ │ │ └── CompanyDAO.java
│ │ ├── dtos
│ │ │ ├── CompanyDataResponseDTO.java
│ │ │ └── ErrorResponseDTO.java
│ │ ├── exceptions
│ │ │ └── GlobalExceptionHandler.java
│ │ ├── models
│ │ │ ├── AbstractModel.java
│ │ │ └── CompanyModel.java
│ │ ├── services
│ │ │ ├── CompanyService.java
│ │ │ └── impls
│ │ │ └── CompanyServiceImpl.java
│ │ └── utils
│ │ ├── CNPJUtils.java
│ │ ├── CONSTANTS.java
│ │ ├── FormatUtils.java
│ │ └── logs
│ │ ├── ControllerLoggingAspect.java
│ │ ├── OriginalClassName.java
│ │ └── ServiceLoggingAspect.java
│ └── resources
│ └── application.properties
└── test
└── java
└── br
└── com
└── brmalls
└── xpto
├── XptoApplicationTests.java
├── controllers
│ └── CompanyControllerTest.java
├── daos
│ └── CompanyDAOTest.java
├── exceptions
│ └── GlobalExceptionHandlerTest.java
├── services
│ └── impls
│ └── CompanyServiceImplTest.java
└── utils
├── CNPJUtilsTest.java
└── FormatUtilsTest.java
```
## About the Challenge and the Project
XPTO company is developing a new sales system and has requested the *Integration Team* to create an *API* to retrieve customer data when creating a sales order. The *API* follows these rules:
- It should return the following data: Company Name and Trade Name;
- The parameter used for the search will be the company's CNPJ, without special characters;
- The information should be retrieved primarily from the "COMPANY" table in the customer registration system's database;
- When the CNPJ is not found in the database, the system should attempt to retrieve this information from a third-party service, creating this new record in the "COMPANY" table before returning the result in the request.
**Note:** You are not prohibited from adding "something extra" to your project, feel free to showcase all your creativity and knowledge, but keep in mind that the evaluation focuses on quality rather than the number of features. For this test, the use of **Java** and the *Spring framework* is *mandatory*, but any *relational database* is *allowed*. If you're unfamiliar with any public service for CNPJ data query, we suggest ReceitaWS (https://www.receitaws.com.br/), which currently offers a free service option sufficient for this test. The source code should be shared in a git repository.
This project was developed as part of a technical challenge for a Java Developer position at brMalls. The task involves creating an API to retrieve customer data using Java and Spring Boot, with support for database queries and external service integration.
## Solution Details
The API was designed to be modular and extensible, following a layered architecture. The application performs the following:
1. **CNPJ Validation:** The provided CNPJ is validated and formatted before being used in queries.
2. **Database Query:** Initially, the API attempts to retrieve the company's data from the "COMPANY" table. If the CNPJ is not found, the application makes a second attempt using an external service.
3. **External Service Integration:** The suggested service, ReceitaWS, is used to retrieve data for companies that are not in the local database. After the query, the data is stored for future requests.
## How to Run the Project
Note
Before running the project, you need to go to the application.properties file, MySQL Dockerfile, and docker-compose.yml and modify the following:
-
PLACEHOLDER_DB_USERNAME: Replace with the database username "root". -
PLACEHOLDER_DB_PASSWORD: Replace with the desired database password.
**Step 0:** Clone the repository
```bash
git clone https://github.com/matheus-srego/challenge_brmalls.git
```
**Step 1:** Open the project folder
```bash
cd challenge_brmalls
```
**Step 2:** Running with Docker
**Java Application**
- **Build the application image**
```bash
docker build -f Dockerfile -t openjdk .
```
- **Run the application container**
```bash
docker run -d --name api -p 8080:8080 -t openjdk
```
- **Run the application container in debug mode**
```bash
docker run -d --name api_debug -p 8080:8080 -p 5005:5005 -e DEBUG=true openjdk
```
**MySQL Database**
- **Build the database image**
```bash
docker build -f Dockerfile -t mysql .
```
- **Run the database container**
```bash
docker run -d --name database -p 3306:3306 -t mysql
```
**Docker Compose**
- **Run Docker Compose in debug mode**
```bash
DEBUG=true docker-compose -p xpto up -d --build
```
- **Run Docker Compose without debug mode**
```bash
DEBUG=false docker-compose -p xpto up -d --build
```
**Step 3:** Check running containers
```bash
docker ps
```
## Running Unit Tests
> **Note:** Ensure that all placeholders are replaced before running the tests.
Placeholder Substitution
For tests to run properly, placeholders in the tests need to be replaced. Below is each file with its placeholders.
CompanyControllerTest
-
CNPJ_PLACEHOLDER: Replace with a valid CNPJ. -
SOCIAL_NAME_PLACEHOLDER: Replace with the company name corresponding to the CNPJ. -
INVALID_CNPJ_PLACEHOLDER: Replace with an invalid CNPJ.
CompanyServiceImplTest
-
CNPJ_PLACEHOLDER: Replace with a valid CNPJ. -
SOCIAL_NAME_PLACEHOLDER: Replace with the company name corresponding to the CNPJ. -
FANTASY_NAME_PLACEHOLDER: Replace with the trade name of the company corresponding to the CNPJ.
CompanyDAOTest
-
PLACEHOLDER_DB_USERNAME: Replace with the database username (e.g., "root"). -
PLACEHOLDER_DB_PASSWORD: Replace with the database password. -
CNPJ_PLACEHOLDER: Replace with a valid CNPJ. -
INVALID_CNPJ_PLACEHOLDER: Replace with an invalid CNPJ.
GlobalExceptionHandlerTest
-
CNPJ_PLACEHOLDER: Replace with a valid CNPJ.
CNPJUtilsTest
-
CNPJ_PLACEHOLDER: Replace with a valid CNPJ.
FormatUtilsTest
-
CNPJ_VARIABLE: Replace with a valid CNPJ.
The tests were written to ensure the integrity of the application, including CNPJ validation and external service integration. Below is how to run them:
**Run all tests**
```bash
mvn test
```
**Run specific tests**
```bash
mvn -Dtest=TestName test
```
## License
This repository is licensed under the [MIT Licensed](https://github.com/matheus-srego/challenge_brmalls/blob/main/LICENSE).
---
### Acknowledgment
I used ChatGPT to assist me in improving the translation of this README to English.