prix-r9 1.0.4 → 2.0.1

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) QA Team
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -1,235 +1,225 @@
-# Prix-R9 — Pruebas de Estrés HTTP
+# Prix-R9
+
+CLI para pruebas de carga HTTP/REST con ramp-up, multipart y escenarios encadenados por steps.
+
+## Caracteristicas
+
+- Ejecuta pruebas de carga con `rate` fijo o `startRate -> targetRate`.
+- Soporta requests JSON y multipart con archivo.
+- Permite escenarios encadenados dentro de una misma iteracion usando `steps`.
+- Extrae valores del response JSON y los reutiliza en los siguientes steps.
+- Soporta escenarios simples de un solo request y escenarios encadenados por steps.
+- Genera `reporte.txt` con metricas generales del escenario y metricas por step.
+
+## Instalacion
+
+```bash
+npm install -g prix-r9
+```
+
+## Comandos
+
+```bash
+prix-r9 --config mi-config.json
+prix-r9 --prompt
+prix-r9-curl -i mi-curl.txt -o casos/mi-endpoint.json
+```
+
+## Flujo recomendado desde cURL
+
+1. Exporta cada request funcional como `cURL` desde browser, Postman o Swagger.
+2. Convierte cada cURL a un JSON base:
+   ```bash
+   prix-r9-curl -i curl-upload.txt -o upload.json
+   prix-r9-curl -i curl-execute.txt -o execute.json
+   ```
+3. Toma esos JSON generados y unelos manualmente dentro de `steps`.
+4. En el step 1 agrega `extract` con la ruta exacta del valor devuelto.
+5. En el step 2 reemplaza el valor fijo por un placeholder `{{variableExtraida}}`.
+6. Ejecuta el escenario encadenado con `prix-r9 --config escenario.json`.
+
+El importador `prix-r9-curl` genera configuraciones simples de un solo request. Eso es intencional: sirven como bloque base para construir escenarios multi-step.
+
+## Variables dinamicas
+
+Se pueden usar en `url`, `headers`, `body`, `file` y `filekey`.
+
+- `{{uuid}}`
+- `{{timestamp}}`
+- `{{random_number}}`
+
+## Formato simple de un request
+
+Este formato sigue funcionando sin cambios:
+
+```json
+{
+  "url": "https://api.tuempresa.com/v1/usuarios",
+  "method": "POST",
+  "startRate": 5,
+  "targetRate": 50,
+  "rampUpTime": 5,
+  "duration": 10,
+  "headers": {
+    "Authorization": "Bearer tu_token",
+    "X-Request-ID": "{{uuid}}"
+  },
+  "body": {
+    "id_unico": "{{uuid}}",
+    "correo_usuario": "prueba_{{timestamp}}@empresa.com"
+  }
+}
+```
+
+Este formato representa un escenario de endpoint unico.
+
+## Formato recomendado para escenarios encadenados
+
+La forma mas simple es usar `steps` con el mismo formato que genera `prix-r9-curl`, sin obligarte a anidar `request`.
+
+```json
+{
+  "name": "Carga encadenada confirmacion de pago",
+  "startRate": 2,
+  "targetRate": 5,
+  "rampUpTime": 5,
+  "duration": 10,
+  "steps": [
+    {
+      "name": "uploadProcess",
+      "url": "https://qa.miapi.com/mdl03/api/blob/uploadProcess",
+      "method": "post",
+      "headers": {
+        "Accept": "application/json, text/plain, */*",
+        "Authorization": "Bearer tu_token"
+      },
+      "file": "./Plantillas/PlantillaMovimientoManual.csv",
+      "filekey": "File",
+      "body": {
+        "TypeFile": "1",
+        "ReasonProcess": "Carga MovimientoManualV2",
+        "CreatedBy": "Alek Rutherford",
+        "TypeProcessId": "2efff14a-94cf-4928-a6a9-ad210b487205"
+      },
+      "extract": {
+        "uploadFileProcessId": "$.uploadFileProcessId"
+      }
+    },
+    {
+      "name": "executeLoadProcess",
+      "url": "https://qa.miapi.com/mdl03/api/AZ/ExecuteLoadProcess",
+      "method": "post",
+      "headers": {
+        "Accept": "application/json, text/plain, */*",
+        "Content-Type": "application/json",
+        "apiKey": "tu_api_key"
+      },
+      "body": {
+        "UploadFileProcessId": "{{uploadFileProcessId}}",
+        "AprovalStatus": 1,
+        "ApprovedBy": "Alek Rutherford"
+      }
+    }
+  ]
+}
+```
+
+Tambien se acepta la forma anidada con `request`, pero la forma directa suele ser mas facil de mantener cuando vienes desde cURL.
+
+## Reglas de ejecucion
+
+- Cada iteracion crea su propio contexto.
+- `variables` define valores iniciales opcionales por iteracion.
+- `extract` guarda valores del response JSON para los steps siguientes.
+- Si un step falla por HTTP, red o extraccion, la iteracion termina y los steps restantes quedan omitidos por cascade.
+- En escenarios multi-step, el rate representa iteraciones por segundo.
+
+## Extraccion de valores
+
+`extract` acepta un mapa `nombreVariable -> ruta`.
+
+```json
+{
+  "extract": {
+    "uploadFileProcessId": "$.uploadFileProcessId",
+    "primerDetalle": "$.data[0].id"
+  }
+}
+```
+
+Rutas soportadas:
+
+- `$.propiedad`
+- `$.objeto.hijo`
+- `$.items[0].id`
+- `$['propiedad-rara']`
+
+Las rutas son case-sensitive. Si el response trae `uploadFileProcessId`, entonces `$.UploadFileProcessId` va a fallar.
+
+## Multipart
+
+Para multipart:
+
+- define `file` con la ruta del archivo
+- define `filekey` exactamente como lo espera el backend
+- manda los campos extra en `body`
+- no copies manualmente `Content-Type: multipart/form-data; boundary=...`; el CLI lo genera solo
+
+Ejemplo:
+
+```json
+{
+  "url": "https://api/upload",
+  "method": "post",
+  "headers": {
+    "Authorization": "Bearer tu_token"
+  },
+  "file": "./foto.jpg",
+  "filekey": "File",
+  "body": {
+    "TypeFile": "1",
+    "ReasonProcess": "Carga {{timestamp}}"
+  }
+}
+```
+
+## Metricas generadas
+
+Al finalizar, el CLI imprime un resumen y guarda `reporte.txt` con:
+
+- iteraciones totales, exitosas y fallidas
+- requests ejecutados
+- throughput real en `iter/s` y `req/s`
+- latencia por iteracion
+- latencia agregada por request
+- metricas por step: ejecutado, exitoso, errores, omitido por cascade, latencia y codigos de estado
+
+## Prompt de informe
+
+```bash
+prix-r9 --prompt
+```
+
+Copia `promptInforme.txt` al directorio actual. El template ya esta orientado a analizar escenarios multi-step y distinguir entre metricas por iteracion y metricas por step.
+
+## Publicacion en npm
+
+Antes de publicar:
+
+```bash
+npm run check
+npm run pack:dry-run
+```
+
+Si todo sale bien:
+
+```bash
+npm login
+npm publish --access public
+```
+
+## Version actual
+
+`2.0.1`
 
-Herramienta CLI ligera para pruebas de carga y rendimiento de APIs REST. Permite realizar envíos concurrentes de alto volumen simulando usuarios simultáneos con escalado progresivo (**Ramp-Up**) e inyección de **variables dinámicas** para evitar colisiones de datos en bases de datos.
 
----
-
-## Instalación
-
-```bash
-npm install -g prix-r9
-```
-
----
-
-## Cómo Empezar
-
-```bash
-prix-r9 --config mi-config.json
-```
-
-Toda la configuración (URL, cabeceras, métodos y tiempos) reside dentro del archivo JSON que le pases como parámetro. Esto te permite guardar un historial de todos los servicios estresados.
-
----
-
-## Importador Automático desde cURL
-
-No tienes que escribir el archivo JSON a mano. Si tienes una petición que ya funciona en **Postman, Swagger o en tu Navegador**, simplemente cópiala como formato `cURL` y la herramienta creará el JSON por ti.
-
-```bash
-# 1. Guarda tu comando cURL en un archivo de texto
-#    (Click derecho en Network tab del navegador → Copy as cURL)
-
-# 2. Convierte a config JSON
-prix-r9-curl -i mi-curl.txt -o casos/mi-endpoint.json
-
-# 3. Lanza la prueba
-prix-r9 --config casos/mi-endpoint.json
-```
-
-**¿Qué hace?**
-- Extrae la URL y el Método HTTP automáticamente.
-- Extrae todas las cabeceras (Tokens, ApiKeys).
-- Detecta si es un envío JSON regular (`--data`) o un envío de Archivo pesado (`--form`). Si es archivo, automáticamente separa la ruta física local (`file` / `filekey`) y construye el `body` con los campos extra.
-- Le inyecta un **Ramp-Up predeterminado** (5 a 50 req/s en 5 segundos), listo para que lo afines.
-
----
-
-## Organización por Casos de Prueba (Recomendado)
-
-Para no perder la configuración de un WebService que probaste y que podrías volver a ocupar en meses, guarda los archivos JSON divididos por carpetas:
-
-```text
-mi-proyecto/
- └── casos/
-      ├── modulo-usuarios/
-      │    └── crear-usuario.json
-      ├── modulo-reportes/
-      │    └── generar-reporte.json
-      └── modulo-archivos/
-           └── upload-csv.json
-```
-
-> **IMPORTANTE:** Tú y tu equipo deciden cómo nombrar las carpetas. Pueden ser por Producto, Módulo, Ambiente de QA o Sprint.
-
----
-
-## Motor de Carga (Rate & Ramp-Up)
-
-La herramienta permite moldear cómo las peticiones van entrando a tu API a través del tiempo usando cuatro valores clave:
-
-* **`startRate`** (Ej: `5`): Peticiones por segundo al inicio de la prueba.
-* **`targetRate`** (Ej: `50`): Máximo de peticiones por segundo al que se quiere llegar.
-* **`rampUpTime`** (Ej: `5`): Segundos que toma escalar de `startRate` a `targetRate`.
-* **`duration`** (Ej: `10`): Duración total de la prueba en segundos.
-
-### Fórmula de cálculo por segundo
-
-```
-Si s < rampUpTime:
-  rate(s) = PISO( startRate + (targetRate - startRate) * (s / rampUpTime) )
-
-Si s >= rampUpTime:
-  rate(s) = targetRate
-```
-
-**Ejemplo con `startRate: 3, targetRate: 5, rampUpTime: 10, duration: 15`:**
-
-| Segundo (s) | Fracción = s ÷ 10 | Incremento = (5-3) × fracción | rate = 3 + incremento | Redondeado |
-|:-----------:|:-----------------:|:-----------------------------:|:---------------------:|:----------:|
-| 1           | 0.1               | 0.2                           | 3.2                   | **3**      |
-| 2           | 0.2               | 0.4                           | 3.4                   | **3**      |
-| 3           | 0.3               | 0.6                           | 3.6                   | **3**      |
-| 4           | 0.4               | 0.8                           | 3.8                   | **3**      |
-| 5           | 0.5               | 1.0                           | 4.0                   | **4**      |
-| 6           | 0.6               | 1.2                           | 4.2                   | **4**      |
-| 7           | 0.7               | 1.4                           | 4.4                   | **4**      |
-| 8           | 0.8               | 1.6                           | 4.6                   | **4**      |
-| 9           | 0.9               | 1.8                           | 4.8                   | **4**      |
-| 10          | 1.0               | 2.0                           | 5.0                   | **5**      |
-| 11 – 15     | —                 | tope alcanzado                | 5 pet/s × 5 seg       | **25**     |
-| **TOTAL**   |                   |                               |                       | **62**     |
-
----
-
-## Variables Dinámicas `{{ }}`
-
-Para evitar colisiones por restricciones `UNIQUE` en base de datos, puedes usar variables dinámicas en el `body` y `headers`:
-
-- **`{{uuid}}`**: Cadena alfanumérica única (ej: `123e4567-e89b-12d3...`).
-- **`{{timestamp}}`**: Tiempo actual en milisegundos (ej: `1702939129124`).
-- **`{{random_number}}`**: Número aleatorio del 0 al 9999.
-
----
-
-## Ejemplo 1: Carga JSON
-
-```json
-{
-  "url": "https://api.tuempresa.com/v1/usuarios",
-  "method": "POST",
-  "startRate": 5,
-  "targetRate": 50,
-  "rampUpTime": 5,
-  "duration": 10,
-  "headers": {
-    "Authorization": "Bearer tu_token",
-    "X-Request-ID": "{{uuid}}"
-  },
-  "body": {
-    "id_unico": "{{uuid}}",
-    "correo_usuario": "prueba_{{timestamp}}@empresa.com",
-    "edad": "{{random_number}}"
-  }
-}
-```
-
----
-
-## Ejemplo 2: Subida de Archivos (Multipart)
-
-```json
-{
-  "url": "https://api.tuempresa.com/v1/upload-foto",
-  "method": "POST",
-  "startRate": 2,
-  "targetRate": 10,
-  "rampUpTime": 2,
-  "duration": 5,
-  "headers": {
-    "Authorization": "Bearer tu_token"
-  },
-  "file": "./foto-pesada.jpg",
-  "filekey": "foto",
-  "body": {
-    "TypeFile": "1",
-    "ReasonProcess": "Carga desde V{{random_number}}"
-  }
-}
-```
-
-- **`file`:** Ruta del archivo a adjuntar en cada petición.
-- **`filekey`:** Nombre del campo que espera el backend (el `name` del `<input type="file">`).
-- **`body`:** Campos extra que acompañan al archivo en el `FormData`.
-
----
-
-## Métricas Generadas
-
-Al terminar la prueba se imprime un resumen y se guarda en `reporte.txt`:
-
-```text
-===========================================
-RESUMEN DE LA PRUEBA
-===========================================
-Peticiones Totales  : 410
-Conexiones Máximas  : 50
-Rendimiento / Rate  : 23.50 Req/s
-
-DESGLOSE DE RESULTADOS:
-Exitosas (2xx)      : 410
-Errores Cliente (4xx): 0
-Errores Server (5xx): 0
-
-TIEMPOS DE RESPUESTA (Latencia en ms):
-   Mínimo : 60.88 ms
-   Máximo : 165.25 ms
-   Promedio: 75.93 ms
-   P95    : 88.99 ms
-
-CÓDIGOS DE ESTADO HTTP:
-   [200] -> 410 veces
-===========================================
-```
-
-> **P95**: El 95% de las peticiones tardó igual o menos que ese tiempo.
-> **Rendimiento**: Throughput real (Req/s) que el servidor procesó durante toda la prueba.
-
----
-
-## Template para Informe con IA
-
-El paquete incluye el archivo `promptInforme.txt`, un template profesional para generar informes técnicos de rendimiento usando cualquier IA (ChatGPT, Claude, etc.).
-
-**Cómo usarlo:**
-1. Copia el template a tu directorio de trabajo:
-   ```bash
-   prix-r9 --prompt
-   ```
-2. Corre uno o varios escenarios de estrés con `prix-r9`
-3. Copia el contenido de cada `reporte.txt` generado
-4. Abre `promptInforme.txt` y pega los reportes en las secciones marcadas
-5. Envía el prompt completo a tu IA preferida
-
-El informe generado incluirá: resumen ejecutivo, tabla comparativa, análisis por escenario, diagnóstico del servidor, recomendaciones y semáforo de salud del sistema.
-
----
-
-## Referencia Rápida
-
-```bash
-# Instalar globalmente
-npm install -g prix-r9
-
-# Convertir cURL a config JSON
-prix-r9-curl -i mi-curl.txt -o casos/endpoint.json
-
-# Ejecutar prueba de estrés
-prix-r9 --config casos/endpoint.json
-
-# Copiar template de informe IA al directorio actual
-prix-r9 --prompt
-
-# Ver versión
-prix-r9 --version
-```

package/import-curl.js

@@ -5,8 +5,8 @@ const { program } = require('commander');
 const { toJsonString } = require('curlconverter');
 
 program
-  .version('1.0.0')
-  .description('Herramienta de importación de cURL a config.json para Pruebas de Estrés')
+  .version('2.0.1')
+  .description('Importador de cURL a config JSON base para pruebas de carga')
   .requiredOption('-i, --input <path>', 'Archivo de texto (.txt) que contiene el comando cURL crudo')
   .requiredOption('-o, --output <path>', 'Ruta de destino para el config JSON de la prueba (ej: casos/az/nuevo-endpoint.json)')
   .parse(process.argv);
@@ -105,11 +105,13 @@ try {
   fs.writeFileSync(destPath, JSON.stringify(outputConfig, null, 2), 'utf8');
   
   console.log(`✅ ¡Éxito!`);
-  console.log(`Tu comando cURL ha sido convertido a una configuración de carga.`);
-  console.log(`Archivo generado: ${destPath}`);
+  console.log(`Tu comando cURL ha sido convertido a una configuracion base de carga.`);
+  console.log(`Archivo base generado: ${destPath}`);
   console.log(`\nPuedes ejecutar la prueba ahora usando:`);
   console.log(`prix-r9 --config ${outputPath}`);
 
 } catch (err) {
   console.error(`💥 Error al procesar el cURL:`, err.message);
 }
+
+