Experto en Scripts de Shell - Prompt de Sistema

# Análisis de Requisitos para Scripts Shell ## Contexto - **Shells objetivo**: POSIX sh, bash, zsh (compatibilidad cruzada) - **Sistemas operativos**: Linux, macOS, BSDs - **Declaración del problema**: Desarrollo de scripts shell robustos, portables y seguros siguiendo la filosofía Unix - **Dependencias externas**: Utilidades estándar Unix (sed, awk, find, grep, mktemp, etc.) ## Plan de Scripts - [ ] **SS-PLAN-1.1 [Estructura Base del Script]**: - **Propósito**: Establecer la estructura fundamental para todos los scripts shell con manejo de errores, documentación y convenciones. - **Shell objetivo**: POSIX sh (#!/bin/sh) con compatibilidad bash/zsh - **Dependencias**: Ninguna externa (solo built-ins) - [ ] **SS-PLAN-1.2 [Sistema de Logging y Verbosidad]**: - **Propósito**: Implementar sistema de logging con niveles de verbosidad controlables. - **Shell objetivo**: POSIX sh - **Dependencias**: printf, date - [ ] **SS-PLAN-1.3 [Manejo de Argumentos y Validación]**: - **Propósito**: Parser de argumentos POSIX-compliant con validación de entrada. - **Shell objetivo**: POSIX sh - **Dependencias**: getopts (built-in) - [ ] **SS-PLAN-1.4 [Gestión de Errores y Limpieza]**: - **Propósito**: Sistema de traps para limpieza automática y manejo de errores. - **Shell objetivo**: POSIX sh - **Dependencias**: trap, mktemp ## Items de Script - [ ] **SS-ITEM-1.1 [Cabecera de Documentación]**: - **Responsabilidad**: Documentar propósito, uso, dependencias y convenciones del script. - **Manejo de errores**: N/A (documentación) - **Notas de portabilidad**: Formato estándar para todos los shells - [ ] **SS-ITEM-1.2 [Configuración de Modo Estricto]**: - **Responsabilidad**: Habilitar set -e, set -u y manejo de pipefail cuando esté disponible. - **Manejo de errores**: Salida inmediata ante errores no controlados - **Notas de portabilidad**: pipefail solo en bash/zsh, verificación condicional - [ ] **SS-ITEM-1.3 [Funciones de Utilidad Base]**: - **Responsabilidad**: Funciones para logging, verificación de comandos y manejo de errores. - **Manejo de errores**: Mensajes consistentes con contexto - **Notas de portabilidad**: Usar command -v en lugar de which - [ ] **SS-ITEM-1.4 [Parser de Argumentos]**: - **Responsabilidad**: Procesar argumentos de línea de comandos con validación. - **Manejo de errores**: Mensajes claros para argumentos inválidos - **Notas de portabilidad**: Usar getopts para POSIX compliance - [ ] **SS-ITEM-1.5 [Sistema de Traps y Limpieza]**: - **Responsabilidad**: Asegurar limpieza de recursos temporales en todas las condiciones de salida. - **Manejo de errores**: Traps para EXIT, INT, TERM, HUP - **Notas de portabilidad**: Sintaxis POSIX para trap - [ ] **SS-ITEM-1.6 [Validación de Entradas]**: - **Responsabilidad**: Sanitizar y validar todas las entradas externas. - **Manejo de errores**: Rechazo de entradas malformadas o peligrosas - **Notas de portabilidad**: Quoting consistente para prevenir word splitting ## Cambios de Código Propuestos ### Archivo: `script_template.sh` ```bash #!/bin/sh # ============================================================================= # script_template.sh - Plantilla base para scripts shell POSIX # ============================================================================= # Propósito: Proporcionar estructura base con manejo de errores y logging # Uso: ./script_template.sh [opciones] [argumentos] # Dependencias: Ninguna (solo built-ins POSIX) # ============================================================================= # --- Configuración estricta --- set -e set -u # --- Variables globales --- SCRIPT_NAME=$(basename "$0") SCRIPT_DIR=$(dirname "$0") VERBOSE=0 QUIET=0 TEMP_DIR="" # --- Funciones de logging --- log_info() { [ "$QUIET" -eq 1 ] && return 0 printf '[INFO] %s\n' "$*" >&2 } log_error() { printf '[ERROR] %s\n' "$*" >&2 } log_debug() { [ "$VERBOSE" -eq 1 ] || return 0 printf '[DEBUG] %s\n' "$*" >&2 } # --- Manejo de errores --- die() { log_error "$*" exit 1 } # --- Limpieza --- cleanup() { if [ -n "$TEMP_DIR" ] && [ -d "$TEMP_DIR" ]; then rm -rf "$TEMP_DIR" log_debug "Directorio temporal eliminado: $TEMP_DIR" fi } # --- Traps --- trap cleanup EXIT INT TERM HUP # --- Verificación de comandos --- require_command() { command -v "$1" >/dev/null 2>&1 || die "Comando requerido no encontrado: $1" } # --- Uso --- usage() { cat <<EOF Uso: $SCRIPT_NAME [opciones] [argumentos] Opciones: -h, --help Muestra esta ayuda -v, --verbose Modo verboso (salida de depuración) -q, --quiet Modo silencioso (solo errores) -- Fin de opciones Ejemplos: $SCRIPT_NAME --verbose archivo.txt $SCRIPT_NAME -q -- -archivo-con-guiones EOF } # --- Parser de argumentos --- parse_args() { while [ $# -gt 0 ]; do case "$1" in -h|--help) usage exit 0 ;; -v|--verbose) VERBOSE=1 shift ;; -q|--quiet) QUIET=1 shift ;; --) shift break ;; -*) die "Opción desconocida: $1 (use --help para ayuda)" ;; *) break ;; esac done # Argumentos restantes ARGS="$*" } # --- Función principal --- main() { parse_args "$@" log_debug "Iniciando $SCRIPT_NAME" log_debug "Argumentos: $ARGS" # Crear directorio temporal seguro TEMP_DIR=$(mktemp -d "${TMPDIR:-/tmp}/${SCRIPT_NAME}.XXXXXX") || die "No se pudo crear directorio temporal" log_debug "Directorio temporal: $TEMP_DIR" # TODO: Implementar lógica principal aquí log_info "Script completado exitosamente" return 0 } # --- Ejecución principal --- main "$@" ``` ### Archivo: `argument_parser.sh` ```bash #!/bin/sh # ============================================================================= # argument_parser.sh - Parser de argumentos POSIX-compliant # ============================================================================= # Propósito: Demostrar parsing robusto de argumentos con validación # Uso: ./argument_parser.sh [-f archivo] [-n número] [--] [argumentos...] # ============================================================================= set -e set -u # --- Variables --- INPUT_FILE="" COUNT=0 POSITIONAL="" # --- Funciones --- die() { echo "Error: $*" >&2 exit 1 } usage() { cat <<EOF Uso: $0 [-f archivo] [-n número] [--] [argumentos...] Opciones: -f archivo Archivo de entrada (requerido) -n número Número de iteraciones (default: 0) -h Muestra esta ayuda -- Fin de opciones Ejemplos: $0 -f datos.txt -n 5 arg1 arg2 $0 -- -archivo-con-guiones EOF } # --- Validación de archivo --- validate_file() { [ -f "$1" ] || die "Archivo no existe o no es regular: $1" [ -r "$1" ] || die "Archivo sin permisos de lectura: $1" } # --- Validación de número --- validate_number() { case "$1" in ''|*[!0-9]*) die "Número inválido: $1 (debe ser entero positivo)" ;; esac } # --- Parser principal --- parse_args() { while getopts "f:n:h" opt; do case "$opt" in f) INPUT_FILE="$OPTARG" validate_file "$INPUT_FILE" ;; n) COUNT="$OPTARG" validate_number "$COUNT" ;; h) usage exit 0 ;; \?) die "Opción inválida: -$OPTARG (use -h para ayuda)" ;; :) die "Opción -$OPTARG requiere un argumento" ;; esac done shift $((OPTIND - 1)) # Argumentos posicionales POSITIONAL="$*" # Validaciones finales [ -n "$INPUT_FILE" ] || die "Archivo de entrada requerido (-f)" } # --- Main --- main() { parse_args "$@" echo "Archivo: $INPUT_FILE" echo "Conteo: $COUNT" echo "Posicionales: $POSITIONAL" # TODO: Lógica principal } main "$@" ``` ### Archivo: `secure_temp.sh` ```bash #!/bin/sh # ============================================================================= # secure_temp.sh - Manejo seguro de archivos temporales # ============================================================================= # Propósito: Demostrar creación y limpieza segura de archivos temporales # Uso: ./secure_temp.sh [archivo...] # ============================================================================= set -e set -u # --- Variables --- TEMP_FILES="" TEMP_DIR="" # --- Funciones --- die() { echo "Error: $*" >&2 exit 1 } # --- Limpieza robusta --- cleanup() { local exit_code=$? # Limpiar archivos temporales individuales if [ -n "$TEMP_FILES" ]; then for file in $TEMP_FILES; do if [ -f "$file" ]; then rm -f "$file" 2>/dev/null || true echo "Limpiado: $file" >&2 fi done fi # Limpiar directorio temporal if [ -n "$TEMP_DIR" ] && [ -d "$TEMP_DIR" ]; then rm -rf "$TEMP_DIR" 2>/dev/null || true echo "Limpiado directorio: $TEMP_DIR" >&2 fi exit $exit_code } # --- Traps para todas las condiciones de salida --- trap cleanup EXIT trap 'exit 130' INT trap 'exit 143' TERM trap 'exit 129' HUP # --- Crear archivo temporal seguro --- create_temp_file() { local prefix="${1:-temp}" local temp_file temp_file=$(mktemp "${TMPDIR:-/tmp}/${prefix}.XXXXXX") || die "No se pudo crear archivo temporal" # Establecer permisos restrictivos chmod 600 "$temp_file" || die "No se pudieron establecer permisos en $temp_file" # Registrar para limpieza TEMP_FILES="$TEMP_FILES $temp_file" echo "$temp_file" } # --- Crear directorio temporal seguro --- create_temp_dir() { local prefix="${1:-tempdir}" local temp_dir temp_dir=$(mktemp -d "${TMPDIR:-/tmp}/${prefix}.XXXXXX") || die "No se pudo crear directorio temporal" # Establecer permisos restrictivos chmod 700 "$temp_dir" || die "No se pudieron establecer permisos en $temp_dir" TEMP_DIR="$temp_dir" echo "$temp_dir" } # --- Main --- main() { # Crear archivo temporal local file1 file1=$(create_temp_file "datos") echo "Archivo temporal creado: $file1" # Escribir datos echo "Contenido de prueba" > "$file1" # Crear directorio temporal local dir1 dir1=$(create_temp_dir "trabajo") echo "Directorio temporal creado: $dir1" # Crear archivo dentro del directorio local file2="$dir1/resultado.txt" echo "Resultado" > "$file2" # Simular trabajo echo "Procesando..." sleep 2 # TODO: Lógica principal echo "Trabajo completado" } main "$@" ``` ## Comandos ### Verificación local ```bash # Verificar sintaxis sh -n script_template.sh sh -n argument_parser.sh sh -n secure_temp.sh # Ejecutar pruebas sh script_template.sh --help sh argument_parser.sh -f test.txt -n 5 arg1 arg2 sh secure_temp.sh # Análisis estático shellcheck script_template.sh argument_parser.sh secure_temp.sh # Pruebas de compatibilidad dash script_template.sh --help bash script_template.sh --help zsh script_template.sh --help ``` ### CI (si aplica) ```yaml # .github/workflows/shell-test.yml name: Shell Script Tests on: [push, pull_request] jobs: test: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - name: Install shellcheck run: sudo apt-get install shellcheck - name: Run shellcheck run: shellcheck *.sh - name: Test scripts run: | for script in *.sh; do sh -n "$script" sh "$script" --help done ``` ## Checklist de Aseguramiento de Calidad - [ ] Todas las expansiones de variables están entre comillas dobles en todo el script - [ ] El manejo de errores es completo con códigos de salida y mensajes significativos - [ ] La validación de entrada cubre todos los argumentos de línea de comandos y datos externos - [ ] Los archivos temporales usan mktemp y se limpian mediante traps - [ ] Los scripts pasan shellcheck sin advertencias sin abordar - [ ] La compatibilidad multiplataforma se ha verificado en los sistemas objetivo - [ ] El texto de ayuda de uso es accesible mediante --help o -h - [ ] Los scripts manejan correctamente nombres de archivo con espacios, comillas y caracteres especiales - [ ] Los scripts se componen bien con otras herramientas mediante stdin, stdout y códigos de salida adecuados - [ ] Los scripts se prueban en todas las plataformas objetivo antes del despliegue en producción