Ambiente de Desenvolvimento

Instalação

Arquivos de instalação do MySQL

Arquivos necessários para a instalação do MySQL:

• MySQL Installer 8.0.34
• MySQL Workbench 8.0.34

Instalando o MySQL Installer

Para instalar o MySQL Installer e Workbench, siga os seguintes passos indicados nas imagens:

Configurando o MySQL Workbench

Para configurar o MySQL Workbench, siga os seguintes passos:

Criando a Database

Para criar a Database, siga os seguintes passos:

Python

Linux:

sudo apt install python3.11

Para Windows:

• Instalador .exe versão 3.11.0

Execute o arquivo executável e siga os passos:

Após seguir os passos acima, abra um terminal e execute o seguinte comando para verificar se o Python foi instalado:

python --version

Configuração

Baixar API

Acesse o repositório e baixe via HTTPS ou via Zip.

• HTTPS: https://github.com/V-Perotto/AxyaTest_API.git

O diretório da API consiste nesse modelo:

- AxyaTest_API/
    - controllers/
    - models/
    - tests/
    - app.py
    - config.py
    - requirements.txt

Criar Virtualenv

Após verificada a instalação do Python, baixe o virtualenv

pip install virtualenv

Acesse o diretório da API, abra um terminal e crie um ambiente virtual usando o seguinte comando:

venv api

O diretório pode ficar separado do diretório do ambiente virtual, como no exemplo abaixo:

- api/ (ambiente virtual)
- AxyaTest_API/
    - controllers/
    - models/
    - tests/
    - app.py
    - config.py
    - requirements.txt

Ativar Virtualenv

Ainda no mesmo diretório e terminal acesse o diretório do ambiente virtual e ative-o com o seguinte comando:

• No terminal do Git Bash ou Linux:

source api/Scripts/activate

• No Windows:

cd api/Scripts/
activate

Ao ativar o ambiente virtual, ele deverá ficar parecido com a seguinte imagem, indicando que está ativo.

Baixar as bibliotecas

IMPORTANTE: Para baixar as bibliotecas e requisitos necessários para rodar, você deverá estar com o ambiente virtual ativo.

Instale as bibliotecas usando o seguinte comando:

python pip install -r requirements.txt

Todas as bibliotecas e respectivas versões estão indicadas no arquivo requirements.txt.

Inicialização

Para poder inicializar ambos API e testes, será necessário abrir um terminal para cada e rodar os seguintes comandos:

Ativar a API

Primeiro altere as seguintes variáveis no arquivo app.py.

Variáveis:

• (str) host: host da aplicação. Ex.: "localhost"
• (int) port: porta da aplicação. Ex.: 3306
• (str) user: usuário do banco de dados. Ex.: "root"
• (str) pwd: senha do usuário do banco de dados.
• (str) db: database criada no banco de dados.

app = create_app(<host>, <port>, <user>, <pwd>, <db>)

Após inserir os seguintes dados, execute a linha de comando abaixo em um terminal separado.

python app.py 

Rodar os Testes

Usando TDD com RobotFramework

Para rodar os testes, acesse o diretório TDD/ em um terminal separado.

IMPORTANTE: A API deverá estar ativa para os testes funcionarem.

Para rodar os testes via terminal, use:

robot test.robot

Seu retorno deverá ser igual a imagem abaixo:

Para mais informações do log detalhado do RobotFramework, acesse o Log no seu navegador.

Ele deverá ser semelhante à imagem abaixo:

Usando Python

Para rodar os testes, acesse o diretório tests/ em um terminal separado.

IMPORTANTE: A API deverá estar ativa para os testes funcionarem.

Como utilizar os testes via terminal:

Variáveis:

• [método]: será a opção que você testará na API. Ex.: create

• [*argumentos]: será os argumentos desse método que você irá passar. Alguns métodos exigem diferentes tipos e quantidade de dados para poderem ser executados.

Argumentos disponíveis:

• create [nome] [sobrenome] [email] [telefone]

• read [id]

• ¹update [id] [nome] e/ou [sobrenome] e/ou [email] e/ou [telefone]

• delete [id]

• search [nome]

¹No caso de update, você poderá passar somente 1 valor, desde que utilize . para indicar que não deseja passar o respectivo valor (mesmo assim, deverá seguir a ordem).

Utilize o teste com o seguinte comando:

python test.py [método] [*argumentos]