Software-Engineering-Assistantship · fernandapascoal · Dec 16, 2024 · Dec 16, 2024 · Dec 18, 2024 · Dec 18, 2024
diff --git a/.env.example b/.env.example
diff --git a/README.md b/README.md
@@ -1,3 +1,9 @@
+# 🚀 Guia de Integração do Frontend
+
+Este guia explica como configurar, estruturar e integrar o frontend do projeto React com o backend Flask.
+
+---
+
 # ESS Front-end React
 
 This is the Front-end base project in React for the Software and Systems Engineering discipline, offered by the Informatics Center (CIn) of the Federal University of Pernambuco (UFPE).
@@ -46,6 +52,26 @@ npm run
 
 This project uses `.env` files to manage environment variables. You can create a `.env.development` file in the project directory and set the environment variables in the file (iou can create it from .`env.example`). The `env` script in the `package.json` file uses the `env-cmd` package to load the environment variables from the `.env.development` file.
 
+Crie um arquivo .env na raiz do frontend e adicione a URL da API:
+```
+VITE_API_URL=http://127.0.0.1:5000
+```
+
+📂 src/ → Código-fonte do projeto │
+├── 📂 app/ → Páginas principais (leva a estilização das telas) │ ├── 📂 home/ │ │ ├── 📂 pages/ │ │ │ ├── Login.tsx → Tela de Login │ │ │ ├── Cadastro.tsx → Tela de Cadastro │ │ │ ├── Reservas.tsx → Tela após login │
+├── 📂 shared/ → Recursos compartilhados │ ├── 📂 services/ → Serviços de integração com a API │ │ ├── autorizacao.tsx → Requisições de login/cadastro │
+├── App.tsx → Arquivo principal do React onde você adiciona suas rotas criadas nas pages! ├── main.tsx → Ponto de entrada da aplicação │ ├── .env → Configuração da API ├── package.json → Lista de dependências ├── README.md → Você está aqui! 📌
+
+Endereço para se colocar as estilizações próprias de cada tela.
+```
+src\app\home\styles
+```
+
+Endereço onde se pode colocar arquivos css em comum ao sistema
+```
+src\shared\components
+```
+
 ### Running the App
 
 To start the app, run the following command:
@@ -56,6 +82,73 @@ npm run dev
 
 This command will run the React app in development with Vite.js script
 
+
+
+## Rodando  o backend Flask
+
+No powerShell mude para o diretório backend
+```
+cd backend
+```
+Crie arquivos __init__.py em todos diretórios dentro de backend, inclusive nele.
+
+backend/
+   __init__.py
+   main.py
+   testes/
+      __init__.py
+      teste_exemplo.py
+
+MacOS
+Dentro da pasta backend no terminal, execute os seguintes comandos:
+
+```
+export PYTHONPATH=$(pwd)/backend
+export FLASK_APP=main
+flask run
+```
+
+Dentro da pasta backend/testes, execute:
+
+```
+export PYTHONPATH=$(pwd)/backend
+pytest
+Windows (Powershell)
+```
+Dentro da pasta backend no PowerShell, execute os seguintes comandos:
+
+```
+$env:PYTHONPATH = "$(pwd)/backend"
+$env:FLASK_APP = "main"
+flask run
+```
+
+
+Crie a venv
+```
+python -m venv venv
+```
+Ative a venv
+```
+venv\Scripts\activate
+```
+e agora você deve instalar todas as dependencias do projeto 
+
+```
+pip install -r requirements.txt
+```
+
+obs: caso sejam necessárias novas bibliotecas e deseja atualizar o requirements.txt por favor recirar arquivo.
+```
+pip freeze > requirements.txt
+```
+
+Rodando servidor Flask localmente na rota 5000.
+```
+python main.py
+```
+
+
 ## Running the tests
 
 There are two types of tests configured in the base project: unit tests using Vitest with React Testing Library and E2E acceptance tests using Cypress with Cucumber. It's interesting to create the **.env.testing** at the root of the project the same way it was created to run in development, changing the necessary values.

diff --git a/backend/__init__.py b/backend/__init__.py
diff --git a/backend/__pycache__/__init__.cpython-313.pyc b/backend/__pycache__/__init__.cpython-313.pyc
diff --git a/backend/__pycache__/blueprints.cpython-313.pyc b/backend/__pycache__/blueprints.cpython-313.pyc
diff --git a/backend/__pycache__/config.cpython-313.pyc b/backend/__pycache__/config.cpython-313.pyc
diff --git a/backend/__pycache__/main.cpython-313.pyc b/backend/__pycache__/main.cpython-313.pyc
diff --git a/backend/blueprints.py b/backend/blueprints.py
@@ -0,0 +1,38 @@
+from backend.rotas.login import login_bp
+from backend.rotas.cadastro import cadastro_bp
+from backend.rotas.logout import logout_bp
+from backend.rotas.criar_solicitacao_manutencao import criar_manutencao_bp
+from backend.rotas.criar_solicitacao_recursos import criar_recursos_bp
+from backend.rotas.excluir_solicitacao_manutencao import excluir_manutencao_bp
+from backend.rotas.excluir_solicitacao_recursos import excluir_recursos_bp
+from backend.rotas.editar_solicitacao_manutencao import editar_manutencao_bp
+from backend.rotas.editar_solicitacao_recursos import editar_recursos_bp
+from backend.rotas.reservas import reservas_bp
+from backend.rotas.salas import salas_bp
+from backend.rotas.usuario import usuarios_bp
+from backend.rotas.criarReview import criar_review_bp
+from backend.rotas.atualizarReview import atualizar_review_bp
+from backend.rotas.deletarReview import deletar_review_bp
+from backend.rotas.obterReview import obter_review_bp
+from backend.rotas.listarReview import listar_reviews_bp
+from flask_cors import CORS
+
+# Registra os Blueprints
+def registrarBlueprints(app):
+    blueprints = [
+       login_bp, cadastro_bp, logout_bp, criar_manutencao_bp, criar_recursos_bp, excluir_manutencao_bp, excluir_recursos_bp, editar_recursos_bp, editar_manutencao_bp, 
+       salas_bp, usuarios_bp, reservas_bp, criar_review_bp, listar_reviews_bp, obter_review_bp, deletar_review_bp, atualizar_review_bp
+    ]
+
+    for blueprint in blueprints:
+        CORS(blueprint)
+        app.register_blueprint(blueprint)
+
+    CORS(app, supports_credentials=True)
+
+    @app.after_request
+    def add_cors_headers(response):
+        response.headers["Access-Control-Allow-Origin"] = "*"
+        response.headers["Access-Control-Allow-Methods"] = "GET, POST, PUT, DELETE, OPTIONS"
+        response.headers["Access-Control-Allow-Headers"] = "Content-Type, Authorization"
+        return response
diff --git a/backend/config.py b/backend/config.py
@@ -0,0 +1,7 @@
+import os
+
+class Config:
+    SECRET_KEY = os.urandom(24)
+    SQLALCHEMY_DATABASE_URI = "sqlite:///users.db"
+    SQLALCHEMY_TRACK_MODIFICATIONS = False
+
diff --git a/backend/features/atualizarReview.feature b/backend/features/atualizarReview.feature
@@ -0,0 +1,13 @@
+Feature: Atualizar avaliação
+
+  Scenario: Atualizar uma avaliação existente
+    Given o professor Suruagy deseja editar uma avaliação feita anteriormente
+    When ele envia uma requisição PUT "/api/reviews/1" especificando o id "1" da avaliação que deseja editar
+    And modifica a nota de "4" para "5" e o comentário de "Sala boa, mas com algumas falhas." para "Modificações feitas, a sala está impecável agora!"
+    Then o sistema retorna a mensagem "Avaliação atualizada com sucesso." e o status 200 OK
+
+  Scenario: Tentar atualizar uma avaliação que não existe
+    Given o professor Suruagy deseja editar uma avaliação cuja qual não está presente no sistema
+    When ele envia uma requisição PUT "/api/reviews/1" especificando o id "1" da avaliação que deseja editar
+    And modifica a nota de "4" para "5" e o comentário de "Sala boa, mas com algumas falhas." para "Falhas corrigidas, a sala está impecável!"
+    Then o sistema retorna a mensagem "Avaliação não encontrada para o ID fornecido." e o status 404 NOT FOUND
diff --git a/backend/features/cadastroServico.feature b/backend/features/cadastroServico.feature
@@ -0,0 +1,100 @@
+Feature: Serviço de Cadastro de Usuários
+
+  Scenario: Sucesso no cadastro de usuário
+    Given o usuário deseja se cadastrar
+    When ele informa o nome "Demosténes"
+    And ele informa o CPF "126.455.789-00"
+    And ele informa o email "demostenessouza@example.com"
+    And ele informa se é professor "N"
+    And ele informa a senha "SecurePassword123"
+    And ele informa a confirmação da senha "SecurePassword123"
+    And ele envia uma requisição POST para "/cadastro"
+    Then a resposta deve conter a mensagem "Cadastro criado com sucesso!"
+    And o status code deve ser "201"
+
+  Scenario: Sucesso no cadastro de professor
+    Given o usuário deseja se cadastrar
+    When ele informa o nome "Tatiana"
+    And ele informa o CPF "331.879.789-33"
+    And ele informa o email "vanessasilva@example.com"
+    And ele informa se é professor "S"
+    And ele informa o SIAPE "101110"
+    And ele informa a senha "12345678"
+    And ele informa a confirmação da senha "12345678"
+    And ele envia uma requisição POST para "/cadastro"
+    Then a resposta deve conter a mensagem "Cadastro criado com sucesso!"
+    And o status code deve ser "201"
+
+  Scenario: Fracasso no cadastro por campos obrigatórios não preenchidos
+    Given o usuário deseja se cadastrar
+    When ele informa o nome "João"
+    And ele informa o CPF "987.654.321-00"
+    And ele informa o email "joao@iat.com"
+    And ele informa se é professor "N"
+    And ele informa a senha "Password123"
+    And ele deixa o campo "Confirmar Senha" com ""
+    And ele envia uma requisição POST para "/cadastro"
+    Then a resposta deve conter a mensagem "Confirmar Senha é obrigatório."
+    And o status code deve ser "400"
+
+  Scenario: Fracasso no cadastro por duplicação de ID única
+    Given o usuário deseja se cadastrar
+    When ele informa o nome "Carlos Mendes"
+    And ele informa o CPF "126.456.789-00"
+    And ele informa o email "demostenes@example.com"
+    And ele informa se é professor "S"
+    And ele informa o SIAPE "010101"
+    And ele informa a senha "Password456"
+    And ele informa a confirmação da senha "Password456"
+    And ele envia uma requisição POST para "/cadastro"
+    Then a resposta deve conter a mensagem "Erro: email/cpf já está registrado."
+    And o status code deve ser "409"
+
+  Scenario: Fracasso no cadastro por senhas que não coincidem
+    Given o usuário deseja se cadastrar
+    When ele informa o nome "Beatriz"
+    And ele informa o CPF "789.456.123-00"
+    And ele informa o email "Beatriz.oliveira@example.com"
+    And ele informa se é professor "N"
+    And ele informa a senha "MyPassword123"
+    And ele informa a confirmação da senha "DifferentPassword123"
+    And ele envia uma requisição POST para "/cadastro"
+    Then a resposta deve conter a mensagem "As senhas não coincidem."
+    And o status code deve ser "400"
+
+    Scenario: Fracasso no cadastro por formato inválido de email
+    Given o usuário deseja se cadastrar
+    When ele informa o nome "Lucas"
+    And ele informa o CPF "987.654.321-00"
+    And ele informa o email "lucas.example.com"
+    And ele informa se é professor "N"
+    And ele informa a senha "SenhaForte123"
+    And ele informa a confirmação da senha "SenhaForte123"
+    And ele envia uma requisição POST para "/cadastro"
+    Then a resposta deve conter a mensagem "Formato de email inválido. Use um email válido, como exemplo@dominio.com."
+    And o status code deve ser "400"
+
+  Scenario: Fracasso no cadastro por formato inválido de CPF
+    Given o usuário deseja se cadastrar
+    When ele informa o nome "Fabricio"
+    And ele informa o CPF "123"
+    And ele informa o email "fabricio@example.com"
+    And ele informa se é professor "N"
+    And ele informa a senha "SenhaSegura456"
+    And ele informa a confirmação da senha "SenhaSegura456"
+    And ele envia uma requisição POST para "/cadastro"
+    Then a resposta deve conter a mensagem "CPF inválido. Digite um CPF válido no formato XXX.XXX.XXX-XX."
+    And o status code deve ser "400"
+
+  Scenario: Fracasso no cadastro por siape já registrado
+    Given o usuário deseja se cadastrar
+    When ele informa o nome "Max"
+    And ele informa o CPF "987.654.321-00"
+    And ele informa o email "max@gmail.com"
+    And ele informa se é professor "S"
+    And ele informa o SIAPE "101010"
+    And ele informa a senha "Senha123"
+    And ele informa a confirmação da senha "Senha123"
+    And ele envia uma requisição POST para "/cadastro"
+    Then a resposta deve conter a mensagem "Erro: siape já está registrado."
+    And o status code deve ser "409"
diff --git a/backend/features/criarReview.feature b/backend/features/criarReview.feature
@@ -0,0 +1,26 @@
+Feature: Criação de Review
+
+  Scenario: Criação bem-sucedida de review
+    Given que o professor Suruagy deseja fazer uma avaliação pós reserva com reserva_id "1" para a sala_id "2"
+    When ele envia uma requisição POST para "/api/reviews" com os dados reserva_id "1", sala_id "2", usuario_id "3", nota "4" e comentário "Sala boa, mas com algumas falhas."
+    Then o sistema retorna "Avaliação criada com sucesso!" com o status 201
+
+  Scenario: Falha ao criar review sem nota
+    Given que o professor Suruagy deseja fazer uma avaliação pós reserva com reserva_id "1" para a sala_id "2"
+    When ele envia uma requisição POST para "/api/reviews" com os dados reserva_id "1", sala_id "2", usuario_id "3", nota "" e comentário "Sala boa, mas sem computador!"
+    Then o sistema retorna "A nota é obrigatória para avaliar a sala." com o status 400
+
+  Scenario: Falha ao criar review sem sala_id
+    Given que o professor Suruagy deseja fazer uma avaliação pós reserva com reserva_id "1" para a sala_id ""
+    When ele envia uma requisição POST para "/api/reviews" com os dados reserva_id "1", sala_id "", usuario_id "3", nota "4" e comentário "Sala boa, mas sem computador!"
+    Then o sistema retorna "O ID da Sala é obrigatório para avaliar a sala." com o status 400
+
+  Scenario: Falha ao criar review sem usuario_id
+    Given que o professor Suruagy deseja fazer uma avaliação pós reserva com reserva_id "1" para a sala_id "2"
+    When ele envia uma requisição POST para "/api/reviews" com os dados reserva_id "1", sala_id "2", usuario_id "", nota "4" e comentário "Sala boa, mas sem computador!"
+    Then o sistema retorna "O ID do Usuário é obrigatório para avaliar a sala." com o status 400
+
+  Scenario: Falha ao criar review sem reserva_id
+    Given que o professor Suruagy deseja fazer uma avaliação pós reserva com reserva_id ""
+    When ele envia uma requisição POST para "/api/reviews" com os dados reserva_id "", sala_id "2", usuario_id "3", nota "4" e comentário "Sala boa, mas sem computador!"
+    Then o sistema retorna "O ID da Reserva é obrigatório para avaliar a sala." com o status 400
diff --git a/backend/features/deletarReview.feature b/backend/features/deletarReview.feature
@@ -0,0 +1,11 @@
+Feature: Deletar Avaliação
+
+  Scenario: Deletar avaliação existente
+    Given o professor Suruagy deseja deletar uma avaliação feita anteriormente
+    When ele envia uma requisição DELETE para "/api/reviews/1" especificando o id "1" da avaliação que deseja deletar
+    Then o sistema retorna a mensagem "Avaliação deletada com sucesso!" e o status 200 OK
+
+  Scenario: Deletar avaliação que não existe
+    Given o professor Suruagy deseja deletar uma avaliação que não existe
+    When ele envia uma requisição DELETE para "/api/reviews/1" especificando o id "1" da avaliação que deseja deletar
+    Then o sistema retorna a mensagem "Avaliação não encontrada para o ID fornecido." e o status 404 NOT FOUND
diff --git a/backend/features/listarReview.feature b/backend/features/listarReview.feature
@@ -0,0 +1,12 @@
+Feature: Listar Avaliações
+
+  Scenario: Listar avaliações quando há avaliações no sistema
+    Given o professor Suruagy deseja consultar as avaliações presentes no sistema e existem avaliações cadastradas
+    When ele envia uma requisição GET para "/api/reviews"
+    Then o sistema lista todas as avaliações que foram postadas anteriormente para todas as salas com o status 200 OK
+
+  Scenario: Listar avaliações quando não há nenhuma avaliação
+    Given o professor Suruagy deseja consultar as avaliações presentes no sistema e não existem avaliações cadastradas
+    When ele envia uma requisição GET para "/api/reviews"
+    Then o sistema não encontra nenhuma avaliação no sistema
+    And exibe a mensagem de erro "Nenhuma avaliação encontrada." com o status 404 NOT FOUND
diff --git a/backend/features/loginServico.feature b/backend/features/loginServico.feature
@@ -0,0 +1,21 @@
+Feature: Autenticação de usuários
+
+  Scenario: Sucesso no login
+    Given o usuário possui o email "demostenes@example.com" e a senha "SecurePassword123" válidos
+    When ele envia uma requisição POST para "/api/login" com os dados "demostenes@example.com" e "SecurePassword123"
+    Then a resposta deve conter o email "demostenes@example.com" e a mensagem "success" igual a True
+    And o status code deve ser "200"
+
+  Scenario: Fracasso no login por senha incorreta
+    Given o usuário possui o email "demostenes@example.com" válido e a senha "SecureIncorreta123" inválida
+    When ele envia uma requisição POST para "/api/login" com os dados "demostenes@example.com" e "SecureIncorreta123"
+    Then a resposta deve conter a mensagem "Usuário ou senha inválidos."
+    And o status code deve ser "401"
+
+  Scenario: Fracasso no login por falta de email ou senha
+    Given o usuário envia uma requisição sem email ou senha
+    When ele envia uma requisição POST para "/api/login" com os dados " " e " "
+    Then a resposta deve conter a mensagem "Usuário e senha são obrigatórios."
+    And o status code deve ser "400"
+
+
diff --git a/backend/features/manutencao.feature b/backend/features/manutencao.feature
@@ -0,0 +1,28 @@
+Feature: Criar/remover solicitação de manutenção de sala
+
+    Scenario: sucesso ao criar uma solicitação de manutenção para uma reserva concluída
+    Given o professor possui uma reserva de sala reserva_id "1" que já foi encerrada
+    When ele envia uma requisição POST /solicitacoes/manutencao com os dados: reserva_id: "1", descricao: "Mesa quebrada."
+    Then o sistema retorna "mensagem" "Parabéns, sua solicitação de manutenção foi criada!" e um status "201"
+    And a reserva reserva_id: "1" possui uma solicitação de manutenção com descricao: "Mesa quebrada."
+
+    Scenario: fracasso ao criar uma solicitação de manutenção sem preencher o campo descricao
+    Given o professor possui uma reserva de sala reserva_id "1" que já foi encerrada
+    When ele envia uma requisição POST /solicitacoes/manutencao com os dados: reserva_id: "1", descricao: " "
+    Then o sistema retorna "erro" "O campo 'descricao' não pode estar vazio." e um status "400"
+
+    Scenario: sucesso ao editar uma solicitação de manutenção existente
+    Given o professor já criou uma solicitação de manutenção associada a reserva_id "1"
+    When ele envia uma requisição PUT /solicitacoes/manutencao/"1" contendo o ID da solicitação de manutenção e a alteração descricao: "Mesa e cadeira quebradas."
+    Then o sistema retorna "mensagem" "Solicitação de manutenção atualizada com sucesso" e um status "200"
+    And o sistema atualiza os detalhes da solicitação com descricao: "Mesa e cadeira quebradas."
+
+    Scenario: fracasso ao editar solicitação de manutenção sem preencher o campo descricao
+    Given o professor já criou uma solicitação de manutenção associada a reserva_id "1"
+    When ele envia uma requisição PUT /solicitacoes/manutencao/"1" contendo o ID da solicitação de manutenção e a alteração descricao: " "
+    Then o sistema retorna "erro" "A descrição da manutenção não pode ser vazia" e um status "400"
+
+    Scenario: sucesso ao excluir uma solicitação de manutenção existente
+    Given o professor já criou uma solicitação de manutenção associada a reserva_id "1"
+    When ele envia uma requisição DELETE /solicitacoes/manutencao/"1",
+    Then o sistema remove a solicitação do banco de dados e retorna um status "204"
diff --git a/backend/features/obterReview.feature b/backend/features/obterReview.feature
@@ -0,0 +1,12 @@
+Feature: Consultar Avaliação
+
+  Scenario: Consulta de avaliação existente
+    Given o professor Suruagy deseja consultar uma avaliação presente no sistema
+    When ele envia uma requisição GET para "/api/reviews/1"
+    Then o sistema retorna a avaliação com comentário "Sala excelente, as mudanças foram feitas e ficou ótima.", data_avaliacao "Sat, 15 Feb 2025 16:31:37 GMT", id "1", nota "5", reserva_id "1", sala_id "2", usuario_id "3" com o status 200 OK
+
+  Scenario: Consulta de avaliação inexistente
+    Given o professor Suruagy deseja consultar uma avaliação presente no sistema
+    When ele envia uma requisição GET para "/api/reviews/1"
+    Then o sistema não encontra avaliação presente com o ID especificado
+    And retorna a mensagem de erro "Avaliação não encontrada para o ID fornecido." com o status 404 NOT FOUND