Crear clase Ejecucion y heredar Entrega y ComandoEjecutado de ella.

[software/sercom.git] / sercom / tester.py

diff --git a/sercom/tester.py b/sercom/tester.py
index 49d89ffb95119c341a7817fa40021a6c67b66f66..7cacd44f6d8346ed9a8331ce0d285fe990b94b9e 100644 (file)
--- a/sercom/tester.py
+++ b/sercom/tester.py
@@ -2,6 +2,7 @@
 
 from sercom.model import Entrega, CasoDePrueba
 from sercom.model import TareaFuente, TareaPrueba, ComandoFuente, ComandoPrueba
 
 from sercom.model import Entrega, CasoDePrueba
 from sercom.model import TareaFuente, TareaPrueba, ComandoFuente, ComandoPrueba

+from difflib import unified_diff, HtmlDiff

 from zipfile import ZipFile, BadZipfile
 from cStringIO import StringIO
 from shutil import rmtree
 from zipfile import ZipFile, BadZipfile
 from cStringIO import StringIO
 from shutil import rmtree


@@ -9,8 +10,8 @@ from datetime import datetime
 from os.path import join
 from turbogears import config
 import subprocess as sp
 from os.path import join
 from turbogears import config
 import subprocess as sp

-import os, sys, pwd, grp

 import resource as rsrc
 import resource as rsrc

+import os, sys, pwd, grp

 import logging
 
 log = logging.getLogger('sercom.tester')
 import logging
 
 log = logging.getLogger('sercom.tester')


@@ -72,14 +73,17 @@ sp.CalledProcessError = CalledProcessError
 
 class Error(StandardError): pass
 
 
 class Error(StandardError): pass
 

-class ExecutionFailure(Error, RuntimeError): pass
-
-class RsyncError(Error, EnvironmentError): pass
+class ExecutionFailure(Error, RuntimeError): #{{{
+    def __init__(self, comando, tarea=None, caso_de_prueba=None):
+        self.comando = comando
+        self.tarea = tarea
+        self.caso_de_prueba = caso_de_prueba
+#}}}

 
 #}}}
 
 def unzip(bytes, default_dst='.', specific_dst=dict()): # {{{
 
 #}}}
 
 def unzip(bytes, default_dst='.', specific_dst=dict()): # {{{

-    """Descomprime un buffer de datos en formato ZIP.
+    u"""Descomprime un buffer de datos en formato ZIP.

     Los archivos se descomprimen en default_dst a menos que exista una entrada
     en specific_dst cuya clave sea el nombre de archivo a descomprimir, en
     cuyo caso, se descomprime usando como destino el valor de dicha clave.
     Los archivos se descomprimen en default_dst a menos que exista una entrada
     en specific_dst cuya clave sea el nombre de archivo a descomprimir, en
     cuyo caso, se descomprime usando como destino el valor de dicha clave.


@@ -111,12 +115,16 @@ class SecureProcess(object): #{{{
     uid = config.get('sercom.tester.chroot.user', 65534)
     MB = 1048576
     # XXX probar! make de un solo archivo lleva nproc=100 y nofile=15
     uid = config.get('sercom.tester.chroot.user', 65534)
     MB = 1048576
     # XXX probar! make de un solo archivo lleva nproc=100 y nofile=15

-    def __init__(self, comando, chroot, cwd):
+    def __init__(self, comando, chroot, cwd, close_stdin=False,
+                 close_stdout=False, close_stderr=False):

         self.comando = comando
         self.chroot = chroot
         self.cwd = cwd
         self.comando = comando
         self.chroot = chroot
         self.cwd = cwd

-        log.debug('Proceso segurizado: chroot=%s, cwd=%s, user=%s, cpu=%s, '
-            'as=%sMiB, fsize=%sMiB, nofile=%s, nproc=%s, memlock=%s',
+        self.close_stdin = close_stdin
+        self.close_stdout = close_stdout
+        self.close_stderr = close_stderr
+        log.debug(_(u'Proceso segurizado: chroot=%s, cwd=%s, user=%s, cpu=%s, '
+            u'as=%sMiB, fsize=%sMiB, nofile=%s, nproc=%s, memlock=%s'),

             self.chroot, self.cwd, self.uid, self.max_tiempo_cpu,
             self.max_memoria, self.max_tam_archivo, self.max_cant_archivos,
             self.max_cant_procesos, self.max_locks_memoria)
             self.chroot, self.cwd, self.uid, self.max_tiempo_cpu,
             self.max_memoria, self.max_tam_archivo, self.max_cant_archivos,
             self.max_cant_procesos, self.max_locks_memoria)


@@ -126,6 +134,12 @@ class SecureProcess(object): #{{{
         return config.get('sercom.tester.limits.' + name, self.default[name])
     def __call__(self):
         x2 = lambda x: (x, x)
         return config.get('sercom.tester.limits.' + name, self.default[name])
     def __call__(self):
         x2 = lambda x: (x, x)

+        if self.close_stdin:
+            os.close(0)
+        if self.close_stdout:
+            os.close(1)
+        if self.close_stderr:
+            os.close(2)

         os.chroot(self.chroot)
         os.chdir(self.cwd)
         uinfo = UserInfo(self.uid)
         os.chroot(self.chroot)
         os.chdir(self.cwd)
         uinfo = UserInfo(self.uid)


@@ -151,10 +165,10 @@ class Tester(object): #{{{
         self.home = home
         self.queue = queue
         # Ahora somos mortales (oid mortales)
         self.home = home
         self.queue = queue
         # Ahora somos mortales (oid mortales)

-        log.debug(_(u'Cambiando usuario y grupo efectivos a %s:%s (%s:%s)'),
-            user_info.user, user_info.group, user_info.uid, user_info.gid)

         os.setegid(user_info.gid)
         os.seteuid(user_info.uid)
         os.setegid(user_info.gid)
         os.seteuid(user_info.uid)

+        log.debug(_(u'usuario y grupo efectivos cambiados a %s:%s (%s:%s)'),
+            user_info.user, user_info.group, user_info.uid, user_info.gid)

 
     @property
     def build_path(self):
 
     @property
     def build_path(self):


@@ -186,7 +200,7 @@ class Tester(object): #{{{
 
     def test(self, entrega): #{{{
         log.debug(_(u'Tester.test(entrega=%s)'), entrega)
 
     def test(self, entrega): #{{{
         log.debug(_(u'Tester.test(entrega=%s)'), entrega)

-        entrega.inicio_tareas = datetime.now()
+        entrega.inicio = datetime.now()

         try:
             try:
                 self.setup_chroot(entrega)
         try:
             try:
                 self.setup_chroot(entrega)


@@ -194,20 +208,20 @@ class Tester(object): #{{{
                 self.ejecutar_tareas_prueba(entrega)
                 self.clean_chroot(entrega)
             except ExecutionFailure, e:
                 self.ejecutar_tareas_prueba(entrega)
                 self.clean_chroot(entrega)
             except ExecutionFailure, e:

-                entrega.correcta = False
+                entrega.exito = False

                 log.info(_(u'Entrega incorrecta: %s'), entrega)
             except Exception, e:
                 if isinstance(e, SystemExit): raise
                 entrega.observaciones += error_interno
                 log.info(_(u'Entrega incorrecta: %s'), entrega)
             except Exception, e:
                 if isinstance(e, SystemExit): raise
                 entrega.observaciones += error_interno

-                log.exception(_(u'Hubo una excepción inesperada: %s'), e)
+                log.exception(_('Hubo una excepcion inesperada')) # FIXME encoding

             except:
                 entrega.observaciones += error_interno
             except:
                 entrega.observaciones += error_interno

-                log.exception(_(u'Hubo una excepción inesperada desconocida'))
+                log.exception(_('Hubo una excepcion inesperada desconocida')) # FIXME encoding

             else:
             else:

-                entrega.correcta = True
+                entrega.exito = True

                 log.debug(_(u'Entrega correcta: %s'), entrega)
         finally:
                 log.debug(_(u'Entrega correcta: %s'), entrega)
         finally:

-            entrega.fin_tareas = datetime.now()
+            entrega.fin = datetime.now()

     #}}}
 
     def setup_chroot(self, entrega): #{{{ y clean_chroot()
     #}}}
 
     def setup_chroot(self, entrega): #{{{ y clean_chroot()


@@ -221,10 +235,10 @@ class Tester(object): #{{{
         try:
             sp.check_call(rsync)
         finally:
         try:
             sp.check_call(rsync)
         finally:

-            log.debug(_(u'Cambiando usuario y grupo efectivos a %s:%s (%s:%s)'),
-                user_info.user, user_info.group, user_info.uid, user_info.gid)

             os.setegid(user_info.gid) # Mortal de nuevo
             os.seteuid(user_info.uid)
             os.setegid(user_info.gid) # Mortal de nuevo
             os.seteuid(user_info.uid)

+            log.debug(_(u'Usuario y grupo efectivos cambiados a %s:%s (%s:%s)'),
+                user_info.user, user_info.group, user_info.uid, user_info.gid)

         unzip(entrega.archivos, self.build_path)
 
     def clean_chroot(self, entrega):
         unzip(entrega.archivos, self.build_path)
 
     def clean_chroot(self, entrega):


@@ -264,7 +278,7 @@ def ejecutar_caso_de_prueba(self, path, entrega): #{{{
             if self.rechazar_si_falla:
                 entrega.exito = False
             if self.terminar_si_falla:
             if self.rechazar_si_falla:
                 entrega.exito = False
             if self.terminar_si_falla:

-                raise ExecutionError(e.comando, e.tarea, prueba)
+                raise ExecutionFailure(e.comando, e.tarea, self)

         else:
             prueba.exito = True
     finally:
         else:
             prueba.exito = True
     finally:


@@ -282,7 +296,7 @@ def ejecutar_tarea_fuente(self, path, entrega): #{{{
         if self.rechazar_si_falla:
             entrega.exito = False
         if self.terminar_si_falla:
         if self.rechazar_si_falla:
             entrega.exito = False
         if self.terminar_si_falla:

-            raise ExecutionError(e.comando, tarea)
+            raise ExecutionFailure(e.comando, self)

 TareaFuente.ejecutar = ejecutar_tarea_fuente
 #}}}
 
 TareaFuente.ejecutar = ejecutar_tarea_fuente
 #}}}
 


@@ -296,33 +310,50 @@ def ejecutar_tarea_prueba(self, path, prueba): #{{{
         if self.rechazar_si_falla:
             prueba.exito = False
         if self.terminar_si_falla:
         if self.rechazar_si_falla:
             prueba.exito = False
         if self.terminar_si_falla:

-            raise ExecutionError(e.comando, tarea)
+            raise ExecutionFailure(e.comando, self)

 TareaPrueba.ejecutar = ejecutar_tarea_prueba
 #}}}
 
 def ejecutar_comando_fuente(self, path, entrega): #{{{
     log.debug(_(u'ComandoFuente.ejecutar(path=%s, entrega=%s)'), path,
         entrega.shortrepr())
 TareaPrueba.ejecutar = ejecutar_tarea_prueba
 #}}}
 
 def ejecutar_comando_fuente(self, path, entrega): #{{{
     log.debug(_(u'ComandoFuente.ejecutar(path=%s, entrega=%s)'), path,
         entrega.shortrepr())

-    unzip(self.archivos_entrada, path) # TODO try/except
-    comando_ejecutado = entrega.add_comando_ejecutado(self)
-    # Abro archivos para fds básicos (FIXME)
+    comando_ejecutado = entrega.add_comando_ejecutado(self) # TODO debería rodear solo la ejecución del comando
+    basetmp = '/tmp/sercom.tester.fuente' # FIXME TODO /var/run/sercom?
+    unzip(self.archivos_entrada, path, # TODO try/except
+        {self.STDIN: '%s.%s.stdin' % (basetmp, comando_ejecutado.id)})

     options = dict(
         close_fds=True,
     options = dict(
         close_fds=True,

-        stdin=None,

         shell=True,
         preexec_fn=SecureProcess(self, 'var/chroot_pepe', '/home/sercom/build')
     )
         shell=True,
         preexec_fn=SecureProcess(self, 'var/chroot_pepe', '/home/sercom/build')
     )

-    if self.guardar_stdouterr:
-        options['stdout'] = file('/tmp/sercom.tester.%s.stdouterr'
-            % comando_ejecutado.id, 'w') #TODO /var/lib/sercom?
+    if os.path.exists('%s.%s.stdin' % (basetmp, comando_ejecutado.id)):
+        options['stdin'] = file('%s.%s.stdin' % (basetmp, comando_ejecutado.id),
+            'r')
+    else:
+        options['preexec_fn'].close_stdin = True
+    a_guardar = set(self.archivos_a_guardar)
+    if self.archivos_a_comparar:
+        zip_a_comparar = ZipFile(StringIO(self.archivos_a_comparar), 'r')
+        a_comparar = set(zip_a_comparar.namelist())
+    else:
+        zip_a_comparar = None
+        a_comparar = frozenset()
+    a_usar = frozenset(a_guardar | a_comparar)
+    if self.STDOUTERR in a_usar:
+        options['stdout'] = file('%s.%s.stdouterr' % (basetmp,
+            comando_ejecutado.id), 'w')

         options['stderr'] = sp.STDOUT
     else:
         options['stderr'] = sp.STDOUT
     else:

-        if self.guardar_stdout:
-            options['stdout'] = file('/tmp/sercom.tester.%s.stdout'
-                % comando_ejecutado.id, 'w') #TODO /var/lib/sercom?
-        if self.guardar_stderr:
-            options['stderr'] = file('/tmp/sercom.tester.%s.stderr'
-                % comando_ejecutado.id, 'w') #TODO /var/lib/sercom?
+        if self.STDOUT in a_usar:
+            options['stdout'] = file('%s.%s.stdout' % (basetmp,
+                comando_ejecutado.id), 'w')
+        else:
+            options['preexec_fn'].close_stdout = True
+        if self.STDERR in a_usar:
+            options['stderr'] = file('%s.%s.stderr' % (basetmp,
+                comando_ejecutado.id), 'w')
+        else:
+            options['preexec_fn'].close_stderr = True

     log.debug(_(u'Ejecutando como root: %s'), self.comando)
     os.seteuid(0) # Dios! (para chroot)
     os.setegid(0)
     log.debug(_(u'Ejecutando como root: %s'), self.comando)
     os.seteuid(0) # Dios! (para chroot)
     os.setegid(0)


@@ -330,55 +361,141 @@ def ejecutar_comando_fuente(self, path, entrega): #{{{
         try:
             proc = sp.Popen(self.comando, **options)
         finally:
         try:
             proc = sp.Popen(self.comando, **options)
         finally:

-            log.debug(_(u'Cambiando usuario y grupo efectivos a %s:%s (%s:%s)'),
-                user_info.user, user_info.group, user_info.uid, user_info.gid)

             os.setegid(user_info.gid) # Mortal de nuevo
             os.seteuid(user_info.uid)
             os.setegid(user_info.gid) # Mortal de nuevo
             os.seteuid(user_info.uid)

+            log.debug(_(u'Usuario y grupo efectivos cambiados a %s:%s (%s:%s)'),
+                user_info.user, user_info.group, user_info.uid, user_info.gid)

     except Exception, e:
         if hasattr(e, 'child_traceback'):
             log.error(_(u'Error en el hijo: %s'), e.child_traceback)
         raise
     proc.wait() #TODO un sleep grande nos caga todo, ver sercom viejo
     except Exception, e:
         if hasattr(e, 'child_traceback'):
             log.error(_(u'Error en el hijo: %s'), e.child_traceback)
         raise
     proc.wait() #TODO un sleep grande nos caga todo, ver sercom viejo

-    comando_ejecutado.fin = datetime.now()
-    buffer = StringIO()
-    zip = ZipFile(buffer, 'w')
-    if self.guardar_stdouterr:
-        zip.write('/tmp/sercom.tester.%s.stdouterr'
-            % comando_ejecutado.id, '__stdouterr__')
-    else:
-        if self.guardar_stdout:
-            azipwrite('/tmp/sercom.tester.%s.stdout'
-                % comando_ejecutado.id, '__stdout__')
-        if self.guardar_stderr:
-            zip.write('/tmp/sercom.tester.%s.stderr'
-                % comando_ejecutado.id, '__stderr__')
-    zip.close()
-    comando_ejecutado.archivos_guardados = buffer.getvalue()
+    comando_ejecutado.fin = datetime.now() # TODO debería rodear solo la ejecución del comando
+    if self.retorno != self.RET_ANY:
+        if self.retorno == self.RET_FAIL:
+            if proc.returncode == 0:
+                if self.rechazar_si_falla:
+                    entrega.exito = False
+                comando_ejecutado.exito = False
+                comando_ejecutado.observaciones += _(u'Se esperaba que el '
+                    u'programa termine con un error (código de retorno '
+                    u'distinto de 0) pero terminó bien (código de retorno '
+                    u'0).\n')
+                log.debug(_(u'Se esperaba que el programa termine '
+                    u'con un error (código de retorno distinto de 0) pero '
+                    u'terminó bien (código de retorno 0).\n'))
+        elif self.retorno != proc.returncode:
+            if self.rechazar_si_falla:
+                entrega.exito = False
+            comando_ejecutado.exito = False
+            if proc.returncode < 0:
+                comando_ejecutado.observaciones += _(u'Se esperaba terminar '
+                    u'con un código de retorno %s pero se obtuvo una señal %s '
+                    u'(%s).\n') % (self.retorno, -proc.returncode,
+                        -proc.returncode) # TODO poner con texto
+                log.debug(_(u'Se esperaba terminar con un código '
+                    u'de retorno %s pero se obtuvo una señal %s (%s).\n'),
+                    self.retorno, -proc.returncode, -proc.returncode)
+            else:
+                comando_ejecutado.observaciones += _(u'Se esperaba terminar '
+                    u'con un código de retorno %s pero se obtuvo %s.\n') \
+                    % (self.retorno, proc.returncode)
+                log.debug(_(u'Se esperaba terminar con un código de retorno '
+                    u'%s pero se obtuvo %s.\n'), self.retorno, proc.returncode)
+    if comando_ejecutado.exito is None:
+        log.debug(_(u'Código de retorno OK'))
+    if a_guardar:
+        buffer = StringIO()
+        zip = ZipFile(buffer, 'w')
+        # Guardamos stdout/stderr
+        if self.STDOUTERR in a_guardar:
+            a_guardar.remove(self.STDOUTERR)
+            zip.write('%s.%s.stdouterr' % (basetmp, comando_ejecutado.id),
+                self.STDOUTERR)
+        else:
+            if self.STDOUT in a_guardar:
+                a_guardar.remove(self.STDOUT)
+                zip.write('%s.%s.stdout' % (basetmp, comando_ejecutado.id),
+                    self.STDOUT)
+            if self.STDERR in a_guardar:
+                a_guardar.remove(self.STDERR)
+                zip.write('%s.%s.stderr' % (basetmp, comando_ejecutado.id),
+                    self.STDERR)
+        # Guardamos otros
+        for f in a_guardar:
+            if not os.path.exists(join(path, f)):
+                if self.rechazar_si_falla:
+                    entrega.exito = False
+                comando_ejecutado.exito = False
+                comando_ejecutado.observaciones += _(u'Se esperaba un archivo '
+                    u'"%s" para guardar pero no fue encontrado.\n') % f
+                log.debug(_(u'Se esperaba un archivo "%s" para guardar pero '
+                    u'no fue encontrado'), f)
+            else:
+                zip.write(join(path, f), f)
+        zip.close()
+        comando_ejecutado.archivos = buffer.getvalue()
+    def diff(new, zip_in, zip_out, name, longname=None, origname='correcto',
+             newname='entregado'):
+        if longname is None:
+            longname = name
+        new = file(new, 'r').readlines()
+        orig = zip_in.read(name).split('\n')
+        udiff = ''.join(list(unified_diff(orig, new, fromfile=name+'.'+origname,
+            tofile=name+'.'+newname)))
+        if udiff:
+            if self.rechazar_si_falla:
+                entrega.exito = False
+            comando_ejecutado.exito = False
+            comando_ejecutado.observaciones += _(u'%s no coincide con lo '
+                u'esperado (archivo "%s.diff").\n') % (longname, name)
+            log.debug(_(u'%s no coincide con lo esperado (archivo "%s.diff")'),
+                longname, name)
+            htmldiff = HtmlDiff().make_file(orig, new,
+                fromdesc=name+'.'+origname, todesc=name+'.'+newname,
+                context=True, numlines=3)
+            zip_out.writestr(name + '.diff', udiff)
+            zip_out.writestr(name + '.diff.html', htmldiff)
+            return True
+        else:
+            return False
+    if a_comparar:
+        buffer = StringIO()
+        zip = ZipFile(buffer, 'w')
+        # Comparamos stdout/stderr
+        if self.STDOUTERR in a_comparar:
+            a_comparar.remove(self.STDOUTERR)
+            diff('%s.%s.stdouterr' % (basetmp, comando_ejecutado.id),
+                zip_a_comparar, zip, self.STDOUTERR,
+                _(u'La salida estándar y de error combinada'))
+        else:
+            if self.STDOUT in a_comparar:
+                a_comparar.remove(self.STDOUT)
+                diff('%s.%s.stdout' % (basetmp, comando_ejecutado.id),
+                    zip_a_comparar, zip, self.STDOUT, _(u'La salida estándar'))
+            if self.STDERR in a_comparar:
+                a_comparar.remove(self.STDERR)
+                diff('%s.%s.stderr' % (basetmp, comando_ejecutado.id),
+                    zip_a_comparar, zip, self.STDERR, _(u'La salida de error'))
+        # Comparamos otros
+        for f in a_comparar:
+            if not os.path.exists(join(path, f)):
+                if self.rechazar_si_falla:
+                    entrega.exito = False
+                comando_ejecutado.exito = False
+                comando_ejecutado.observaciones += _(u'Se esperaba un archivo '
+                    u'"%s" para comparar pero no fue encontrado') % f
+                log.debug(_(u'Se esperaba un archivo "%s" para comparar pero '
+                    u'no fue encontrado'), f)
+            else:
+                diff(join(path, f), zip_a_comparar, zip, f)
+        zip.close()
+        comando_ejecutado.diferencias = buffer.getvalue()
+    if comando_ejecutado.exito is None:
+        comando_ejecutado.exito = True
+    elif self.terminar_si_falla:
+        raise ExecutionFailure(self)

 
 

-#    if no_anda_ejecucion: # TODO
-#        comando_ejecutado.exito = False
-#        comando_ejecutado.observaciones += 'No anduvo xxx' # TODO mas info
-#        if self.rechazar_si_falla:
-#            entrega.exito = False
-#        if self.terminar_si_falla: # TODO
-#            raise ExecutionFailure(self)
-    # XXX ESTO EN REALIDAD EN COMANDOS FUENTE NO IRIA
-    # XXX SOLO HABRÍA QUE CAPTURAR stdout/stderr
-    # XXX PODRIA TENER ARCHIVOS DE SALIDA PERO SOLO PARA MOSTRAR COMO RESULTADO
-#    for archivo in self.archivos_salida:
-#        pass # TODO hacer diff
-#    if archivos_mal: # TODO
-#        comando_ejecutado.exito = False
-#        comando_ejecutado.observaciones += 'No anduvo xxx' # TODO mas info
-#        if self.rechazar_si_falla:
-#            entrega.exito = False
-#        if self.terminar_si_falla: # TODO
-#            raise ExecutionFailure(self)
-#    else:
-#        comando_ejecutado.exito = True
-#        comando_ejecutado.observaciones += 'xxx OK' # TODO
-    comando_ejecutado.exito = True
-    comando_ejecutado.observaciones += 'xxx OK' # TODO

 ComandoFuente.ejecutar = ejecutar_comando_fuente
 #}}}
 
 ComandoFuente.ejecutar = ejecutar_comando_fuente
 #}}}