Para rodar o serviço devops-testes, siga as instruções abaixo:

1. Criar o ambiente virtual:

   python -m venv .venv

2. Ativar o ambiente virtual:

   • No Windows:

     .\.venv\Scripts\activate

   • No macOS ou Linux:

     source .venv/bin/activate

3. Instalar as dependências necessárias:

   pip install -r requirements.txt

   Obs: Caso o projeto não reconheça as dependências instaladas, confira o interpretador Python:

   Ctrl + P e depois `> Python: Select Interpreter`

4. Configurar o VSCode:

   • Crie uma pasta .vscode na raiz do projeto.
   • Dentro da pasta .vscode, crie o arquivo settings.json e adicione:

   {
       "terminal.integrated.env.windows": {
           "PYTHONPYCACHEPREFIX": "${workspaceFolder}/.pycache_global"
       },
       "terminal.integrated.env.linux": {
           "PYTHONPYCACHEPREFIX": "${workspaceFolder}/.pycache_global"
       },
       "terminal.integrated.env.osx": {
           "PYTHONPYCACHEPREFIX": "${workspaceFolder}/.pycache_global"
       }
   }

   • Dentro da pasta .vscode, crie o arquivo launch.json e adicione:

   {
       "version": "0.2.0",
       "configurations": [
           {
               "name": "FastAPI Debug",
               "type": "debugpy",
               "request": "launch",
               "module": "uvicorn",
               "args": [
                   "main:app",
                   "--host",
                   "127.0.0.1",
                   "--port",
                   "5050",
               ],
               "env": {
                   "PYTHONPYCACHEPREFIX": "${workspaceFolder}/.pycache_global"
               },
               "console": "integratedTerminal"
           }
       ]
   }

5. Iniciar o submódulo: Vá para a pasta /services/storage/core - Para inicializar o submódulo, execute o comando: bash git submodule update --init - Para atualizar o submódulo para a última versão, execute: bash git submodule update --remote

6. Iniciando ruff e mypy:

   Antes de cada commit, use os seguintes comandos:

   • Para rodar o ruff e corrigir os problemas encontrados, siga os passos abaixo:

     • Formate o código para o padrão configurado:

     ruff format .

     • Verifique se o código possui algum problema relatado:

     ruff check .

     caso possua:

     ruff check . --fix

     • Para rodar o mypy e corrigir problemas encontrados, siga os passos abaixo:

     mypy .

     Se aparecer problemas, você deve resolvê-los um a um.

7. Instalando Docker:

   • Siga as instruções para instalar o Docker no seu sistema operacional:

     • Windows
     • Linux
     • Mac

   • Rode o comando para criar o container:

   docker run -d --name api-tecsus \
      -e POSTGRES_USER=codenine \
      -e POSTGRES_PASSWORD=codenine2025 \
      -e POSTGRES_DB=tecsus \
      -p 5432:5432 \
       postgres:16

   • Após criado, modifique o arquivo .env colocando a URL do seu container:

     DATABASE_POSTGRES_URL=postgresql+asyncpg://codenine:codenine2025@localhost:5432/tecsus

   • Use o DBeaver para se conectar ao banco de dados.

8. Configurando o Alembic:

   • Inicie o Alembic:

   alembic init alembic

   • Modifique o arquivo alembic/env.py:

   from logging.config import fileConfig
   from alembic import context
   from sqlalchemy.ext.asyncio import create_async_engine
   from sqlalchemy.ext.asyncio import AsyncConnection
   from src.config.settings import settings
   from src.services.storage.core.models.db_model import Base
   import asyncio
   
   # This is the Alembic Config object, which provides
   # access to the values within the .ini file in use.
   config = context.config
   
   # Set the database URL from your settings
   config.set_main_option("sqlalchemy.url", settings.DATABASE_POSTGRES_URL)
   
   # Interpret the config file for Python logging.
   # This line sets up loggers basically.
   if config.config_file_name is not None:
       fileConfig(config.config_file_name)
   
   # Add your model's MetaData object here
   # for 'autogenerate' support
   target_metadata = Base.metadata
   
   def run_migrations_offline() -> None:
       """Run migrations in 'offline' mode."""
       url = config.get_main_option("sqlalchemy.url")
       context.configure(
           url=url,
           target_metadata=target_metadata,
           literal_binds=True,
           dialect_opts={"paramstyle": "named"},
       )
   
       with context.begin_transaction():
           context.run_migrations()
   
   async def run_async_migrations() -> None:
       """Run migrations in 'online' mode using an asynchronous engine."""
       try:
           # Create an asynchronous engine
           connectable = create_async_engine(config.get_main_option("sqlalchemy.url"))
   
           async with connectable.connect() as connection:
               # Configure the context with the connection
               await connection.run_sync(do_run_migrations)
       except ConnectionRefusedError as e:
           print(f"Database connection refused: {e}")
           print("Please check if the database server is running and the connection details are correct.")
           raise
       except Exception as e:
           print(f"An error occurred while running migrations: {e}")
           raise
   
   def do_run_migrations(connection: AsyncConnection) -> None:
       """Run migrations synchronously within an asynchronous context."""
       context.configure(
           connection=connection,
           target_metadata=target_metadata,
           compare_type=True,
           compare_server_default=True,
       )
   
       with context.begin_transaction():
           context.run_migrations()
   
   def run_migrations_online() -> None:
       """Run migrations in 'online' mode."""
       # Run the async migrations
       asyncio.run(run_async_migrations())
   
   if context.is_offline_mode():
       run_migrations_offline()
   else:
       run_migrations_online()

   • Gerar revisão do banco de dados:

       alembic revision --autogenerate -m "frase de exemplo"

   • Rodar as migrações do banco de dados:

       alembic upgrade head

9. Configurar arquivo .env

   DATABASE_POSTGRES_URL=postgresql+asyncpg://<user>:<password>@<host>:<port>/<database>
   DATABASE_MONGO_URL=mongodb+srv://<username>:<password>@cluster0.mongodb.net/test?retryWrites=true&w=majority

10. Rodar a aplicação:

    • Para rodar a aplicação:

    python -m main

    ou

    uvicorn main:app --reload --port 5000

    • Para rodar com o modo debugger, basta apertar F5 no VSCode.