feat: Python API and SQL Validator framework

Author: ironidesflj

.github/workflows/ci.yml

@@ -0,0 +1,74 @@
+name: QA Validator CI Pipeline
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  python-api-sql-tests:
+    runs-on: ubuntu-latest
+    name: Python API & SQL Tests
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r tests/python/requirements.txt
+
+      - name: Start API and Database (Docker Compose)
+        run: docker compose up -d --build
+
+      - name: Wait for API to be ready
+        run: |
+          while ! curl -s http://localhost:8000/docs > /dev/null; do
+            echo "Waiting for API..."
+            sleep 2
+          done
+
+      - name: Run Pytest
+        run: pytest tests/python/ -v
+
+      - name: Tear down Docker Compose
+        if: always()
+        run: docker compose down -v
+
+  postman-newman-tests:
+    runs-on: ubuntu-latest
+    name: Postman Zero Code Tests
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Start API and Database (Docker Compose)
+        run: docker compose up -d --build
+
+      - name: Wait for API to be ready
+        run: |
+          while ! curl -s http://localhost:8000/docs > /dev/null; do
+            echo "Waiting for API..."
+            sleep 2
+          done
+
+      - name: Install Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
+      - name: Install Newman
+        run: npm install -g newman
+
+      - name: Run Newman Tests
+        run: newman run tests/postman/postman_collection.json -e tests/postman/postman_environment.json --reporters cli
+
+      - name: Tear down Docker Compose
+        if: always()
+        run: docker compose down -v

.gitignore

@@ -0,0 +1,8 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+.pytest_cache/
+
+# Docker
+.docker/

Dockerfile

@@ -0,0 +1,15 @@
+FROM python:3.11-slim
+
+WORKDIR /app
+
+# Install system dependencies for psycopg2
+RUN apt-get update && apt-get install -y libpq-dev gcc
+
+COPY app/requirements.txt .
+RUN pip install --no-cache-dir -r requirements.txt
+
+COPY app/ ./app/
+
+# Expose port and run uvicorn
+EXPOSE 8000
+CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "8000"]

README.md

@@ -0,0 +1,15 @@
+# QA Framework: Python API & SQL Validator
+
+Este projeto é o núcleo da **Fase 2 do Roadmap de Qualidade**, provando proficiência em testes automatizados integrando as camadas de Contrato (HTTP/REST) e Persistência de Dados (SQL).
+
+O grande diferencial deste framework é unir ferramentas híbridas de QA:
+1. **Zero Code / CI:** Automação de API via Postman/Newman.
+2. **Code / DB:** Automação via Python (`pytest`, `requests`) integrada a validações SQL diretas (`psycopg2`) no banco PostgreSQL.
+
+## 📁 Estrutura da Aplicação (SUT)
+A aplicação local que estamos testando consiste em uma API de Ingestão de Clientes construída em **FastAPI** conectada a um banco **PostgreSQL** provisionado via Docker.
+
+Para subir a infraestrutura:
+```bash
+docker-compose up --build
+```

app/config.py

@@ -0,0 +1,3 @@
+import os
+
+DATABASE_URL = os.getenv("DATABASE_URL", "postgresql://qa_admin:qa_password@localhost:5432/qa_validator_db")

app/database.py

@@ -0,0 +1,7 @@
+import psycopg2
+from app.config import DATABASE_URL
+
+def get_db_connection():
+    """Establishes a connection to the PostgreSQL database."""
+    conn = psycopg2.connect(DATABASE_URL)
+    return conn

app/main.py

@@ -0,0 +1,57 @@
+from fastapi import FastAPI, HTTPException, status
+from pydantic import BaseModel, EmailStr
+from app.database import get_db_connection
+import psycopg2
+
+app = FastAPI(title="QA Validator API")
+
+class CustomerCreate(BaseModel):
+    name: str
+    email: EmailStr
+
+class CustomerResponse(CustomerCreate):
+    id: int
+    status: str
+
+@app.post("/customers", response_model=CustomerResponse, status_code=status.HTTP_201_CREATED)
+def create_customer(customer: CustomerCreate):
+    """Creates a new customer in the database."""
+    conn = get_db_connection()
+    cur = conn.cursor()
+    
+    try:
+        cur.execute(
+            "INSERT INTO customers (name, email) VALUES (%s, %s) RETURNING id, name, email, status;",
+            (customer.name, customer.email)
+        )
+        new_customer = cur.fetchone()
+        conn.commit()
+        
+        return CustomerResponse(
+            id=new_customer[0], 
+            name=new_customer[1], 
+            email=new_customer[2], 
+            status=new_customer[3]
+        )
+    except psycopg2.IntegrityError:
+        conn.rollback()
+        raise HTTPException(status_code=400, detail="Email already exists")
+    finally:
+        cur.close()
+        conn.close()
+
+@app.get("/customers/{customer_id}", response_model=CustomerResponse)
+def get_customer(customer_id: int):
+    """Retrieves a customer by ID."""
+    conn = get_db_connection()
+    cur = conn.cursor()
+    
+    cur.execute("SELECT id, name, email, status FROM customers WHERE id = %s;", (customer_id,))
+    customer = cur.fetchone()
+    cur.close()
+    conn.close()
+    
+    if not customer:
+        raise HTTPException(status_code=404, detail="Customer not found")
+        
+    return CustomerResponse(id=customer[0], name=customer[1], email=customer[2], status=customer[3])

app/requirements.txt

@@ -0,0 +1,4 @@
+fastapi==0.109.2
+uvicorn==0.27.1
+psycopg2-binary==2.9.9
+pydantic==2.6.1

db/init.sql

@@ -0,0 +1,26 @@
+-- Schema definition
+CREATE TABLE IF NOT EXISTS customers (
+    id SERIAL PRIMARY KEY,
+    name VARCHAR(100) NOT NULL,
+    email VARCHAR(100) UNIQUE NOT NULL,
+    status VARCHAR(20) DEFAULT 'ACTIVE',
+    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
+);
+
+CREATE TABLE IF NOT EXISTS orders (
+    id SERIAL PRIMARY KEY,
+    customer_id INT REFERENCES customers(id),
+    amount DECIMAL(10, 2) NOT NULL,
+    order_date TIMESTAMP DEFAULT CURRENT_TIMESTAMP
+);
+
+-- Seed data for SQL Dossier tests
+INSERT INTO customers (name, email, status) VALUES
+('Alice Smith', 'alice@example.com', 'ACTIVE'),
+('Bob Jones', 'bob@example.com', 'INACTIVE'),
+('Charlie Brown', 'charlie@example.com', 'ACTIVE');
+
+-- Alice has an order, Bob does not (useful for JOIN tests)
+INSERT INTO orders (customer_id, amount) VALUES
+(1, 150.00),
+(1, 50.00);

docker-compose.yml

@@ -0,0 +1,28 @@
+version: '3.8'
+
+services:
+  db:
+    image: postgres:15-alpine
+    environment:
+      POSTGRES_USER: qa_admin
+      POSTGRES_PASSWORD: qa_password
+      POSTGRES_DB: qa_validator_db
+    ports:
+      - "5432:5432"
+    volumes:
+      - ./db/init.sql:/docker-entrypoint-initdb.d/init.sql
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U qa_admin -d qa_validator_db"]
+      interval: 5s
+      timeout: 5s
+      retries: 5
+
+  api:
+    build: .
+    ports:
+      - "8000:8000"
+    environment:
+      DATABASE_URL: postgresql://qa_admin:qa_password@db:5432/qa_validator_db
+    depends_on:
+      db:
+        condition: service_healthy