Performance Testing con Karate + Gatling

Framework de pruebas de performance siguiendo las reglas de calidad transversales de Pragma.

Este proyecto implementa un framework robusto de pruebas de performance utilizando Karate para definir escenarios de API y Gatling para ejecutar simulaciones de carga, siguiendo las reglas de calidad transversales de Pragma.

🎯 Características Principales

✅ Configuración por Ambientes - Soporte completo para dev/qa/prod
✅ Variables Dinámicas - Parametrización desde variables de ambiente
✅ Assertions Configurables - Umbrales de performance personalizables
✅ CI/CD Automatizado - Pipeline básico con GitHub Actions
✅ Reportes Detallados - Métricas completas de Gatling
✅ Estructura Modular - Organización siguiendo mejores prácticas

Contenidos • Tecnologías • Estructura • Configuración • Instalación • Ejecución • Reportes • CI/CD

🛠️ Tecnologías

Stack Principal

Java 20+ - Runtime environment (Amazon Corretto)
Karate 1.5.1 - Framework de testing API con BDD
Gatling - Motor de simulación de carga y performance
Gradle - Herramienta de build y gestión de dependencias
GitHub Actions - Pipeline de CI/CD automatizado

Requisitos del Sistema

☕ JDK 20+ (Amazon Corretto recomendado)
🔧 Gradle 7.0+ (incluido wrapper)
🌐 Acceso a internet para dependencias
💾 ~100MB espacio libre para reportes

📁 Estructura del Proyecto

qa-performance-karate-gatling/
├── 📂 .github/workflows/          # Configuración CI/CD
│   └── performance-tests.yml      # Pipeline básico GitHub Actions
├── 📂 src/test/
│   ├── 📂 java/
│   │   ├── 📂 performance/        # Simulaciones Gatling
│   │   │   └── PerformanceTestRunner.java
│   │   └── 📂 utils/              # Utilidades del proyecto
│   │       ├── PasswordEncryptor.java
│   │       └── UuidFormat.java
│   └── 📂 resources/
│       ├── 📂 config/             # ✨ Configuraciones por ambiente
│       │   ├── karate-config-dev.js     # Desarrollo
│       │   ├── karate-config-qa.js      # QA/Testing  
│       │   └── karate-config-prod.js    # Producción
│       ├── 📂 karate/             # Features de prueba
│       │   ├── config.feature     # Carga configuración global
│       │   ├── testPosts.feature  # Pruebas API Posts
│       │   └── testUsers.feature  # Pruebas API Users
│       ├── karate-config.js       # ⚙️ Configurador principal
│       └── logback-test.xml       # Configuración logging
├── 📂 build/reports/gatling/      # 📊 Reportes generados
├── build.gradle                   # Configuración Gradle
└── README.md                      # Documentación del proyecto

⚙️ Configuración por Ambientes

🎛️ Sistema Multi-Ambiente

El proyecto soporta 3 ambientes con configuraciones específicas:

Ambiente	Archivo	Uso	Usuarios	Duración	Response Time
DEV	`karate-config-dev.js`	Desarrollo	5	30s	2000ms
QA	`karate-config-qa.js`	Testing	10	60s	1500ms
PROD	`karate-config-prod.js`	Producción	20	120s	1000ms

🔧 Configuración Principal (`karate-config.js`)

function fn() {
    var env = karate.env || 'prod';  // Ambiente por defecto
    var config;
    
    // Carga configuración específica del ambiente
    if (env === 'qa') {
        config = karate.callSingle('classpath:config/karate-config-qa.js');
    } else if (env === 'prod') {
        config = karate.callSingle('classpath:config/karate-config-prod.js');
    } else {
        config = karate.callSingle('classpath:config/karate-config-dev.js');
    }
    
    return config;
}

📊 Parámetros Configurables

Cada ambiente expone estas variables desde variables de sistema:

performance: {
    rampUsers: parseInt(karate.properties['rampUsers'] || '5'),
    during: parseInt(karate.properties['during'] || '30'),
    thresholds: {
        responseTimeMax: parseInt(karate.properties['responseTimeMax'] || '2000'),
        errorRateMax: parseFloat(karate.properties['errorRateMax'] || '5.0'),
        requestsPerSecMin: parseFloat(karate.properties['requestsPerSecMin'] || '1.0'),
        successfulRequestsMin: parseInt(karate.properties['successfulRequestsMin'] || '50')
    }
}

🚀 Instalación y Configuración

1️⃣ Clonación del Proyecto

git clone https://github.com/somospragma/qa-performance-karate-gatling
cd qa-performance-karate-gatling

2️⃣ Configuración de Ambiente Local

# Verificar Java 20+
java -version

# Construir proyecto
./gradlew clean build

3️⃣ Configuración de Variables (Opcional)

# Linux/Mac
export KARATE_ENV=qa
export rampUsers=15
export during=60

# Windows
set KARATE_ENV=qa
set rampUsers=15
set during=60

📊 Ejecución de Pruebas

🎯 Ejecución Básica

# Ejecutar con configuración por defecto (PROD)
./gradlew gatlingRun

# Ejecutar en ambiente específico
./gradlew gatlingRun -Dkarate.env=dev

# Ejecutar en QA con parámetros personalizados
./gradlew gatlingRun -Dkarate.env=qa -DrampUsers=20 -Dduring=120

⚡ Ejecución con Parámetros Avanzados

./gradlew gatlingRun \
  -Dkarate.env=qa \
  -DrampUsers=25 \
  -Dduring=300 \
  -DresponseTimeMax=1500 \
  -DerrorRateMax=3.0 \
  -DrequestsPerSecMin=10.0 \
  -DsuccessfulRequestsMin=200

🎮 Simulaciones Disponibles

Escenario	Feature	Tags	Descripción
Posts API	`testPosts.feature`	`@posts`	CRUD operations en posts
Users API	`testUsers.feature`	-	Gestión de usuarios

📈 Reportes y Métricas

📊 Ubicación de Reportes

build/reports/gatling/
├── performancetestrunner-{timestamp}/
│   ├── index.html                    # 🎯 Reporte principal
│   ├── req_posts-stats.html         # Estadísticas Posts API  
│   ├── req_users-stats.html         # Estadísticas Users API
│   └── js/stats.json               # Datos en JSON

📋 Métricas Capturadas

✅ Response Time - Percentiles 50, 75, 95, 99
✅ Throughput - Requests por segundo
✅ Error Rate - Porcentaje de errores
✅ Success Count - Número de requests exitosos
✅ Connection Time - Tiempo de establecimiento de conexión
✅ Active Users - Usuarios concurrentes por momento

🎯 Assertions Automáticas

El runner valida automáticamente:

.assertions(
    forAll().requestsPerSec().gte(Double.parseDouble(requestsPerSecMin)),
    forAll().failedRequests().percent().lte(Double.parseDouble(errorRateMax)),
    forAll().responseTime().max().lt(Integer.parseInt(responseTimeMax)),
    forAll().successfulRequests().count().gte(Long.parseLong(successfulRequestsMin))
);

🔧 CI/CD con GitHub Actions

⚙️ Pipeline Automatizado

Archivo: .github/workflows/performance-tests.yml

name: Basic CI - Performance Tests

on:
  push:
    branches: [ main ]        # Auto-ejecución en push
  pull_request:
    branches: [ main ]        # Validación en PR  
  workflow_dispatch:          # Ejecución manual

🎯 Flujo de Trabajo

Checkout - Descarga código fuente
Setup JDK 20 - Configura Amazon Corretto
Make gradlew executable - Permisos de ejecución
Build project - Compilación con Gradle
Run performance tests - Ejecución de simulaciones
Upload reports - Almacenamiento de resultados

📥 Artifacts Generados

Nombre: performance-reports
Contenido: Reportes completos de Gatling
Retención: 90 días
Disponible: Siempre (incluso si las pruebas fallan)

▶️ Ejecución Manual

Ve a Actions en tu repositorio
Selecciona Basic CI - Performance Tests
Click Run workflow
Descarga los reportes desde Artifacts

📝 Variables de Configuración

🎛️ Variables Principales

Variable	Descripción	Default DEV	Default QA	Default PROD
`karate.env`	Ambiente de ejecución	`dev`	`qa`	`prod`
`rampUsers`	Usuarios concurrentes	`5`	`10`	`20`
`during`	Duración en segundos	`30`	`60`	`120`
`urlBase`	URL base del servicio	`jsonplaceholder.typicode.com`	-	-

📊 Variables de Thresholds

Variable	Descripción	Unidad	DEV	QA	PROD
`responseTimeMax`	Tiempo máximo respuesta	ms	2000	1500	1000
`errorRateMax`	Porcentaje máximo errores	%	5.0	3.0	1.0
`requestsPerSecMin`	Mínimo requests/segundo	req/s	1.0	5.0	10.0
`successfulRequestsMin`	Mínimo requests exitosos	count	50	100	500

💡 Ejemplo de Configuración Custom

# Para una prueba de stress en QA
./gradlew gatlingRun \
  -Dkarate.env=qa \
  -DrampUsers=50 \
  -Dduring=600 \
  -DresponseTimeMax=3000 \
  -DerrorRateMax=8.0

👥 Autores

_{Mauro L. Ibarra P.}	_{Cristian Millán}

🔗 Enlaces Relacionados

Karate Documentation - Framework principal
Gatling Documentation - Motor de performance
Pragma QA Guidelines - Reglas de calidad transversales
Serenity BDD Project - Proyecto base Web

🗺️ Roadmap

Mejora Sintaxis BDD - Implementar features con mejor sintaxis Gherkin
Datos de Prueba - Sistema de generación y gestión de test data
Métricas Avanzadas - Dashboard en tiempo real con Grafana
Pruebas de Seguridad - Integración con herramientas de security testing
Multi-protocolo - Soporte para WebSockets y GraphQL
Reportes Personalizados - Templates custom para diferentes stakeholders

🚀 ¡Listo para ejecutar pruebas de performance de clase mundial!

¿Tienes preguntas? Abre un issue o contacta al equipo de QA

Name		Name	Last commit message	Last commit date
Latest commit History 31 Commits
.github/workflows		.github/workflows
build		build
gradle/wrapper		gradle/wrapper
logs		logs
reports/MCP		reports/MCP
src/test		src/test
.gitignore		.gitignore
README.md		README.md
build.gradle		build.gradle
gradlew		gradlew
gradlew.bat		gradlew.bat
performance-test.iml		performance-test.iml
settings.gradle		settings.gradle

somospragma/qa-performance-karate-gatling

Folders and files

Latest commit

History

Repository files navigation