Skip to main content

Pruebas de consultas de CodeQL en Visual Studio Code

También puede analizar consultas de CodeQL mediante la extensión de Visual Studio Code.

Acerca de la prueba de consultas en Visual Studio Code

Para asegurarse de que las consultas de CodeQL generan los resultados esperados, puede ejecutar pruebas que comparen los resultados de la consulta esperados con los resultados reales.

La extensión CodeQL se registra automáticamente con la vista “Pruebas”. Esta vista muestra todas las pruebas que se encuentran en el área de trabajo actual y proporciona una interfaz de usuario para explorar y ejecutar pruebas en el área de trabajo.

Para obtener más información sobre la creación de pruebas de CodeQL, consulte “Pruebas de consultas personalizadas”.

Para ver un resultado más detallado de la ejecución de pruebas unitarias, abra el registro de pruebas de CodeQL. Para más información, consulta "Acceso a los registros".

Prueba de los resultados de las consultas

  1. En Visual Studio Code, abra la vista “Pruebas” en la barra lateral.

  2. Para ejecutar una prueba específica, mantenga el ratón sobre el nombre del archivo o de la carpeta y haga clic en el botón Reproducir. Para ejecutar todas las pruebas del área de trabajo, haga clic en el botón Reproducir situado en la parte superior de la vista. Si una prueba tarda demasiado tiempo en ejecutarse, puede hacer clic en el botón Detener situado en la parte superior de la vista para cancelar la prueba.

    Captura de pantalla de la vista “Pruebas”, con el botón “Ejecutar prueba” (para ejecutar todas las pruebas) que se resalta en naranja oscuro.

  3. Los iconos muestran si se ha superado o no una prueba. Si se produce un error, haga clic en la prueba en “Resultados de las pruebas” para mostrar las diferencias entre el resultado esperado y el resultado real.

    Captura de pantalla de la vista “Resultados de las pruebas” en la que se muestran las diferencias entre el resultado esperado y el resultado real de una prueba.

  4. Compare los resultados. Si desea actualizar la prueba con el resultado real, haga clic con el botón derecho en la prueba en la vista “Pruebas” y haga clic en Aceptar resultado de la prueba.

Supervisión del rendimiento de las consultas

El rendimiento de las consultas es importante cuando desea ejecutar una consulta en bases de datos grandes o como parte del sistema de integración continua.

Si desea examinar el rendimiento de las consultas, habilite la configuración “Ejecución de consultas: depurar” para incluir los recuentos de tiempo y tupla. A continuación, se mostrará en los registros de la pestaña “Servidor de consultas” de CodeQL de la vista “Resultado”. El recuento de tuplas es útil porque indica el tamaño de los predicados calculados por la consulta. Para obtener más información sobre la configuración, consulte “Personalización de la configuración”.

Cuando se evalúa una consulta, el servidor de consultas almacena en caché los predicados que calcula. Por lo tanto, cuando quiera comparar el rendimiento de dos evaluaciones, debe ejecutar CodeQL: Borrar caché para borrar la memoria caché del servidor de consultas antes de cada ejecución. De esta manera, se garantiza que está comparando datos equivalentes.

Para obtener más información sobre cómo supervisar el rendimiento de las consultas de CodeQL, consulte “Solución de problemas de rendimiento de consultas” y “Evaluación de programas QL” en la documentación de CodeQL.

Pasos siguientes

Cuando esté seguro de que la consulta encuentra los resultados que desea identificar, puede usar el análisis de variantes para ejecutarlo a gran escala. Para obtener información sobre cómo ejecutar análisis a gran escala en muchas bases de datos CodeQL, consulte “Ejecución de consultas CodeQL a gran escala con análisis de variantes de varios repositorios”.