This README.md document provides guidance for the automated deployment of a DevOps project designed for a hackathon.
The project focuses on creating a backend service with CRUD operations, establishing a basic application structure and an automated database for data querying and insertion.
The application's architecture revolves around managing trips and includes entities such as locations (origin and destination types), products, drivers, vehicles, and carriers.
Key Features:
-
Running Postman collection tests against the backend with detailed HTML report generation. Objectives:
-
Adopting coding standards and design patterns.
-
Utilizing code formatters.
-
Implementing Javadoc.
-
Securing the application with authentication.
-
Developing the frontend.
-
Expanding with new entities.
-
Integrating CI/CD, cloud solutions, observability, and enhancing application logic and business rules.
The ultimate goal is to enhance skills across DevOps, Development, QA, and SRE domains.
Below is the code for the creation of the tables as automated in the Ansible Playbooks:
-- Creating the Brazil states table
CREATE TABLE brazilian_states (
id SERIAL PRIMARY KEY,
uf_code varchar(100) NOT NULL UNIQUE,
uf varchar(100) NOT NULL UNIQUE,
uf_name varchar(100) NOT NULL UNIQUE,
state VARCHAR(10) CHECK (state IN ('active', 'inactive'))
);
-- Creating the Logistic roles table
CREATE TABLE logistic_roles (
id SERIAL PRIMARY KEY,
logistic_type varchar(100) CHECK (logistic_type IN ('distribution', 'production', 'reversed', 'supply')) NOT NULL UNIQUE,
state VARCHAR(10) CHECK (state IN ('active', 'inactive'))
);
-- Creating the Locality table
CREATE TABLE locality (
id SERIAL PRIMARY KEY,
uf_id int REFERENCES brazilian_states(id) ON DELETE NO ACTION,
logistic_type_id int REFERENCES logistic_roles(id) ON DELETE NO ACTION,
cnpj VARCHAR(100) NOT NULL,
name VARCHAR(100) NOT NULL,
type VARCHAR(10) CHECK (type IN ('origin', 'destination')) NOT NULL,
state VARCHAR(10) CHECK (state IN ('active', 'inactive')) NOT NULL
);
-- Creating the Product category table
CREATE TABLE products_category (
id SERIAL PRIMARY KEY,
category VARCHAR(100) NOT NULL,
state VARCHAR(10) CHECK (state IN ('active', 'inactive')) NOT NULL
);
-- Creating the Product table
CREATE TABLE product (
id SERIAL PRIMARY KEY,
product_category_id int REFERENCES products_category(id) ON DELETE NO ACTION,
nome VARCHAR(100) NOT NULL,
description VARCHAR(100) NOT NULL,
state VARCHAR(10) CHECK (state IN ('active', 'inactive')) NOT NULL
);
-- Creating the License plate table
CREATE TABLE license_plate (
id SERIAL PRIMARY KEY,
license_plate VARCHAR(100) NOT NULL,
state VARCHAR(10) CHECK (state IN ('active', 'inactive')) NOT NULL
);
-- Creating the Vehicle type table
CREATE TABLE vehicle_type (
id SERIAL PRIMARY KEY,
vehicle_type VARCHAR(10) CHECK (vehicle_type IN ('bitrem', 'bau', 'van', 'carreta, 'outros')) NOT NULL UNIQUE,
state VARCHAR(10) CHECK (state IN ('active', 'inactive')) NOT NULL
);
-- Creating the Vehicle fleet table
CREATE TABLE vehicles_fleet (
id SERIAL PRIMARY KEY,
fleet_name NOT NULL UNIQUE,
state VARCHAR(10) CHECK (state IN ('active', 'inactive')) NOT NULL
);
-- Creating the Vehicles table
CREATE TABLE vehicle (
id SERIAL PRIMARY KEY,
vehicle_license_plate_id int REFERENCES license_plate(id) ON DELETE NO ACTION,
vehicle_type_id int REFERENCES vehicle_type(id) ON DELETE NO ACTION
vehicle_fleet_id int REFERENCES vehicles_fleet(id) ON DELETE NO ACTION
document_number VARCHAR(100) NOT NULL UNIQUE,
model VARCHAR(100) NOT NULL,
state VARCHAR(10) CHECK (state IN ('active', 'inactive')) NOT NULL
);
-- Creating the Carrier table
CREATE TABLE carrier (
id SERIAL PRIMARY KEY,
fleet_id int REFERENCES vehicles_Fleet(id) ON DELETE NO ACTION,
uf_id int REFERENCES brazilian_states(id) ON DELETE NO ACTION,
cnpj VARCHAR(100) NOT NULL UNIQUE,
nome VARCHAR(100) NOT NULL,
contact VARCHAR(100) not null,
state VARCHAR(10) CHECK (state IN ('active', 'inactive')) NOT NULL
);
-- Creating the Driver table
CREATE TABLE driver (
id SERIAL PRIMARY KEY,
cpf VARCHAR(100) NOT NULL UNIQUE,
nome VARCHAR(100) NOT NULL,
contact VARCHAR(100) not null,
state VARCHAR(10) CHECK (state IN ('active', 'inactive')) NOT NULL
);
-- Creating the Trip table
CREATE TABLE trip (
id SERIAL PRIMARY KEY,
origin_id INT REFERENCES locality(id) ON DELETE NO ACTION,
destination_id INT REFERENCES locality(id) ON DELETE NO ACTION,
product_id INT REFERENCES product(id),
carrier_id INT REFERENCES carrier(id),
vehicle_id INT REFERENCES vehicle(id),
driver_id INT REFERENCES driver(id),
leaving_date TIMESTAMP NOT NULL,
arrival_date TIMESTAMP NOT NULL,
status VARCHAR(10) CHECK (state IN ('planned', 'released', 'in execution', 'finished', 'canceled')) NOT NULL
);
-
docker: 24.0;
-
docker compose: 2.17;
-
a postgres dbms server and populate the database project structure, running the ansible playbook rodaroda.yml,
ansible-playbook -vv -e "ansible_user=ansible" -K rodaroda.yml
from the project: https://github.com/rubenschagas/ansibleAutomatedPlaybooks
Note: Ansible playbooks automate the infrastructure setup of the rodaroda application. This includes creating the DBMS running in a Docker container, creating the database, and finally, creating the tables.
-
a postgres dbms client, like DBeaver: >=23.x (optional);
-
npm: ^8.11;
-
node: ^16.16;
-
ts-node: ^10.9.
On the rodaroda project folder, open a terminal and run the following command:
npm install
Additionally, install the following dependencies:
npm install -g newman newman-reporter-htmlextra
Newman will execute the Postman collection against the backend, and the newman-reporter-htmlextra will generate a beautiful HTML report for the test run.
Start the server:
It has a Command Line Interface e helping a user or a pipeline cloud to inform specific runtime parameters.
You can start the server by executing the following command in the terminal within the project directory:
ts-node rodaroda.ts
Make sure the Node.js server is running.
This project supports some customized parameters, such as: both tenant and environment of the YMS; user and password credentials; video generation for the scenarios; and so on.
A useful menu help with all possible parameters can be viewed with following command:
> ts-node rodaroda.ts --help
Thus, a menu with supported parameters will be showed (some are optional, having a default value):
Usage: ts-node rodaroda.ts [-appp 3000] [-dbh localhost] [-dbp 5432] [-dbn
rodaroda] [-dbu postgres] [-dbw postgres]
Options:
--help Show help [boolean]
--version Show version number [boolean]
-p, --appp The application server port number. E.G.: 3000
[string] [default: "3000"]
-h, --dbh The database server hostname. E.G.: localhost|127.0.0.1
[string] [default: "localhost"]
-t, --dbp The database server port number. E.G.: 5432
[string] [default: "5432"]
-n, --dbn The database name. E.G.: rodaroda[string] [default: "rodaroda"]
-u, --dbu The database username. E.G.: postgres
[string] [default: "postgres"]
-w, --dbw The database username. E.G.: p******s
[string] [default: "postgres"]
It is possible to send requests through Postman to test the CRUD endpoints created in the previous example.
The default port is 3000.
Here are some steps to test the GET and POST endpoints for the locality entity:
Open the Postman application.
Import the collection file available at assets/collections folder.
Open the Consult localities request.
Send a GET request to list localities:
Select the GET method.
Enter the URL: http://localhost:3000/localities
Click "Send" to submit the request.
Send a POST request to create a locality:
Select the POST method.
Enter the URL: http://localhost:3000/localities
Go to the "Body" tab and select the raw format.
Insert the locality data in the request body, json, for example:
{
"name": "Locality Test",
"type": "origin"
}
Click "Send" to submit the request.
The tests cover the project endpoints, and users can interpret the results through a report.
For a description of what the Postman collection covers or what kind of scenarios it tests please open the collection file itself to see them, or see the visual evidence below.
Run the collection tests:
newman run assets/collections/rodaroda-postman-collection.json -r htmlextra --reporter-htmlextra-browserTitle "Rodaroda API Report Test" --reporter-htmlextra-title "Rodaroda API Report Test"
A folder named Newmanwill be created with a html report file as follows:
This project is release with a public license.
