Merge pull request #6 from Kilynho/copilot/test-compile-linux-kernel

Add kernel compilation testing with automatic cleanup and reporting

Author: Kilynho

COMPILE.md

@@ -0,0 +1,323 @@
+# Módulo de Compilación - Documentación
+
+## Descripción General
+
+El módulo de compilación (`compile.py`) permite verificar que los archivos modificados del kernel Linux compilan correctamente después de aplicar los fixes automáticos. Esta funcionalidad es crucial para asegurar que las correcciones no introduzcan errores de compilación.
+
+## Características Principales
+
+### ✅ Compilación Individual
+- Compila archivos uno por uno usando el sistema de build del kernel (`make`)
+- Solo compila archivos `.c` (los archivos `.h` se incluyen automáticamente)
+- Usa el Makefile del kernel para garantizar compatibilidad
+
+### ✅ Limpieza Automática
+- Elimina archivos `.o` generados después de la compilación
+- También elimina archivos auxiliares (`.cmd`, `.d`)
+- No deja rastro de archivos compilados en el árbol del kernel
+
+### ✅ Gestión de Backups
+- Puede restaurar archivos desde sus backups (`.bak`) antes de compilar
+- Opción para restaurar backups después de compilar
+- Útil para probar compilación sin afectar el código modificado
+
+### ✅ Reportes Completos
+- **HTML**: Reporte visual con estadísticas y detalles de errores
+- **JSON**: Resultados estructurados para procesamiento automático
+- **Consola**: Resumen en tiempo real del progreso
+
+## Uso
+
+### Comando Básico
+
+```bash
+python3 main.py --compile \
+  --json-input json/fixed.json \
+  --kernel-root /path/to/kernel/linux
+```
+
+### Opciones Disponibles
+
+| Opción | Descripción |
+|--------|-------------|
+| `--json-input` | Archivo JSON con lista de archivos a compilar (requerido) |
+| `--kernel-root` | Directorio raíz del kernel Linux (requerido) |
+| `--restore-before` | Restaurar backups antes de compilar |
+| `--restore-after` | Restaurar backups después de compilar |
+| `--no-cleanup` | No limpiar archivos `.o` después de compilar |
+| `--html` | Ruta del archivo HTML de salida (default: `html/compile.html`) |
+| `--json-out` | Ruta del archivo JSON de salida (default: `json/compile.json`) |
+
+### Ejemplos de Uso
+
+#### 1. Compilar y verificar archivos modificados
+
+```bash
+# Después de aplicar fixes, compilar para verificar
+python3 main.py --compile \
+  --json-input json/fixed.json \
+  --kernel-root ~/src/kernel/linux
+```
+
+#### 2. Compilar y restaurar después
+
+```bash
+# Útil para probar sin afectar los archivos
+python3 main.py --compile \
+  --json-input json/fixed.json \
+  --kernel-root ~/src/kernel/linux \
+  --restore-after
+```
+
+#### 3. Compilar sin limpieza (debug)
+
+```bash
+# Mantener .o files para inspección
+python3 main.py --compile \
+  --json-input json/fixed.json \
+  --kernel-root ~/src/kernel/linux \
+  --no-cleanup
+```
+
+## Flujo Completo
+
+El flujo recomendado es:
+
+```bash
+# 1. Analizar archivos
+python3 main.py --analyze /path/to/kernel/linux --paths init
+
+# 2. Aplicar fixes
+python3 main.py --fix --json-input json/checkpatch.json
+
+# 3. Compilar para verificar
+python3 main.py --compile \
+  --json-input json/fixed.json \
+  --kernel-root /path/to/kernel/linux \
+  --restore-after
+
+# O usar el script automatizado
+./run
+```
+
+## Formato del JSON de Entrada
+
+El módulo acepta dos formatos de JSON:
+
+### Formato 1: JSON de Autofix (recomendado)
+
+```json
+{
+  "/path/to/file1.c": {
+    "error": [...],
+    "warning": [...]
+  },
+  "/path/to/file2.c": {
+    "error": [...],
+    "warning": [...]
+  }
+}
+```
+
+Solo compila archivos que tienen al menos un fix aplicado (`fixed: true`).
+
+### Formato 2: JSON de Checkpatch
+
+```json
+[
+  {
+    "file": "/path/to/file1.c",
+    "error": [...],
+    "warning": [...]
+  },
+  {
+    "file": "/path/to/file2.c",
+    "error": [...],
+    "warning": [...]
+  }
+]
+```
+
+Compila todos los archivos listados.
+
+## Formato del JSON de Salida
+
+```json
+{
+  "summary": {
+    "total": 3,
+    "successful": 2,
+    "failed": 1,
+    "success_rate": 66.67,
+    "total_duration": 4.5,
+    "avg_duration": 1.5
+  },
+  "results": [
+    {
+      "file": "/path/to/file1.c",
+      "success": true,
+      "duration": 1.2,
+      "stdout": "CC init/main.o",
+      "stderr": "",
+      "error_message": ""
+    },
+    {
+      "file": "/path/to/file2.c",
+      "success": false,
+      "duration": 0.8,
+      "stdout": "",
+      "stderr": "error: implicit declaration...",
+      "error_message": "error: implicit function declaration"
+    }
+  ]
+}
+```
+
+## Reporte HTML
+
+El reporte HTML incluye:
+
+### Sección de Estadísticas
+- **Total Files**: Número de archivos compilados
+- **Successful**: Archivos compilados exitosamente
+- **Failed**: Archivos con errores de compilación
+- **Success Rate**: Porcentaje de éxito
+- **Total Time**: Tiempo total de compilación
+- **Avg Time**: Tiempo promedio por archivo
+
+### Cajas de Resumen
+- ✅ **Caja verde**: Todos los archivos compilaron exitosamente
+- ⚠️ **Caja roja**: Algunos archivos fallaron
+
+### Detalles por Archivo
+- **Failed Compilations**: Lista de archivos con errores (expandibles)
+  - Muestra mensaje de error
+  - Incluye stderr completo en detalles
+- **Successful Compilations**: Lista de archivos exitosos (expandibles)
+  - Muestra tiempo de compilación
+  - Incluye stdout si está disponible
+
+## Salida en Consola
+
+```
+[COMPILE] Compilando 3 archivos...
+[COMPILE] [1/3] Compiling: init/main.c
+[COMPILE]   ✓ Success (1.2s)
+[COMPILE] [2/3] Compiling: init/version.c
+[COMPILE]   ✗ Failed (0.8s)
+[COMPILE]     Error: error: implicit function declaration
+[COMPILE] [3/3] Compiling: init/calibrate.c
+[COMPILE]   ✓ Success (0.9s)
+
+[CLEANUP] Limpiando 2 archivos compilados...
+[CLEANUP] Removed: init/main.o
+[CLEANUP] Removed: init/calibrate.o
+
+============================================================
+RESUMEN DE COMPILACIÓN
+============================================================
+Total de archivos:     3
+Compilados con éxito:  2 (66.7%)
+Fallidos:              1 (33.3%)
+Tiempo total:          2.9s
+Tiempo promedio:       1.0s
+============================================================
+
+Archivos con errores de compilación:
+  ✗ version.c
+    error: implicit function declaration
+
+[COMPILE] ✓ Informe HTML generado: html/compile.html
+[COMPILE] ✓ JSON generado: json/compile.json
+```
+
+## Requisitos del Sistema
+
+### Kernel Linux
+- Debe tener el sistema de build configurado (`make` debe funcionar)
+- `scripts/checkpatch.pl` debe existir
+- Los archivos a compilar deben estar en el árbol del kernel
+
+### Dependencias Python
+- Python 3.6+
+- Módulo `pathlib` (incluido en Python 3.4+)
+- Módulo `json` (incluido en stdlib)
+- Módulo `subprocess` (incluido en stdlib)
+
+## Manejo de Errores
+
+### Timeout de Compilación
+- Cada archivo tiene un timeout de 5 minutos
+- Si se excede, se marca como fallido con mensaje de timeout
+
+### Errores de Compilación
+- Los errores se capturan del stderr
+- Se muestran las primeras 5 líneas con "error:"
+- El stderr completo está disponible en el reporte HTML
+
+### Archivos No Existentes
+- Si un archivo del JSON no existe, se salta con warning
+
+## Tests Unitarios
+
+El módulo incluye tests completos en `test_compile.py`:
+
+```bash
+# Ejecutar todos los tests
+python3 test_compile.py -v
+
+# Tests incluidos:
+# - CompilationResult creation and serialization
+# - Result summarization
+# - JSON report generation
+# - Backup restoration
+# - Full workflow integration
+```
+
+Todos los tests son independientes y no requieren kernel Linux.
+
+## Integración con Dashboard
+
+El reporte de compilación se integra en el dashboard con:
+- Tab "Compile" en la navegación
+- Breadcrumb: Dashboard → Compile
+- Estilo consistente con analyzer y autofix
+
+## Limitaciones Conocidas
+
+1. **Solo archivos .c**: Los archivos `.h` no se compilan directamente
+2. **Requiere kernel configurado**: El kernel debe tener `.config` generado
+3. **Dependencias del kernel**: Si el archivo depende de módulos no compilados, puede fallar
+4. **Tiempo de compilación**: Puede ser lento para muchos archivos
+
+## Solución de Problemas
+
+### Error: "Kernel root no encontrado"
+- Verificar que la ruta al kernel es correcta
+- Usar ruta absoluta: `--kernel-root ~/src/kernel/linux`
+
+### Error: "make: *** No rule to make target"
+- El archivo puede no estar en el Makefile del kernel
+- Verificar que el archivo es parte del kernel
+
+### Compilación lenta
+- Usar menos archivos en el JSON
+- Verificar que el kernel está configurado correctamente
+
+### No se limpian los .o
+- Verificar que no se usa `--no-cleanup`
+- Verificar permisos de escritura en el directorio
+
+## Mejoras Futuras
+
+- [ ] Compilación paralela de múltiples archivos
+- [ ] Soporte para compilar módulos completos
+- [ ] Detección automática de dependencias
+- [ ] Caché de resultados de compilación
+- [ ] Integración con herramientas de análisis estático
+
+## Referencias
+
+- [Documentación del kernel Linux](https://www.kernel.org/doc/html/latest/)
+- [Sistema de build del kernel (Kbuild)](https://www.kernel.org/doc/html/latest/kbuild/index.html)
+- [Checkpatch.pl](https://www.kernel.org/doc/html/latest/dev-tools/checkpatch.html)