Logotipo de Parasoft Buscar

¡Descubre GoogleTest, con certificación TÜV y la tecnología Agentic AI para pruebas de C/C++!
Obtenga los detalles »

Blog de Parasoft

Introducción a la extensión de código de Visual Studio para análisis estático C / C ++

Foto de rostro de Miroslaw Zielinski, Director de Gestión de Productos
By Miroslaw Zielinski • 2 de junio de 2020 • 6 minutos de lectura
2 de junio de 2020 | 6 minutos de lectura
By Miroslaw Zielinski
Introducción a la extensión de código de Visual Studio para análisis estático de C/C++ con imagen de computadora con código fuente a la derecha

Visual Studio Code es un IDE popular. Sin embargo, las tareas de configuración pueden sorprender a los grandes desarrolladores. Uno de ellos es configurar la extensión de VS Code para el análisis de estado de C/C++. Echa un vistazo a esta publicación para conocer una forma comprobada de lograrlo.

En esta publicación de blog, compartiré un par de sugerencias sobre cómo configurar y usar nuestra nueva extensión de análisis estático de prueba C / C ++ para el editor de código de Visual Studio.

La popularidad del editor Visual Studio Code (VS Code) está creciendo a un ritmo vertiginoso. En la última encuesta anual de desarrolladores de Stack Overflow , VS Code dominó la categoría de Entornos y herramientas de desarrollo.

Es rápido, simple, personalizable, extensible y se ejecuta en las tres plataformas de desarrollo líderes: Windows, Linux y Mac. Su popularidad no se limita a los equipos que desarrollan con JavaScript o TypeScript. A menudo lo vemos en uso para desarrollar software C / C ++ crítico para la seguridad.

VS Code es compatible con un vasto ecosistema de extensiones disponibles a través del mercado. Sin embargo, existe un número limitado de extensiones para el análisis estático C / C ++.

Hasta el lanzamiento de la versión 2020.1 de Parasoft C/C++test en abril, no existía ninguna herramienta que permitiera cumplir con los estándares de codificación MISRA, CERT y AUTOSAR C++ sin tener que salir del editor para comprobar los resultados. Si bien la compatibilidad total con los estándares, como Clang-Tidy, es excelente, solo abarca una pequeña parte de estos estándares.

Decidimos llenar este vacío y proporcionar una extensión para este gran editor para ayudar a verificar el código que acaba de escribir con su estándar de codificación preferido, revisar los resultados y corregirlos o suprimirlos, todo dentro del Código VS.

En esta publicación, me centraré en el análisis estático para C / C ++, pero también admitimos C # con la extensión de análisis estático para Parasoft dotTEST.

Comience su viaje con la extensión de prueba C/C++ para el editor de Visual Studio Code.
Ver seminario web bajo demanda

Cómo comenzar con la prueba C / C ++ para VS Code

La forma más sencilla de empezar a usar la extensión de análisis estático de Parasoft para el editor Visual Studio Code es a través de Microsoft Marketplace.

Inicia VS Code y ve a Extensiones (Ctrl + Shift + X). En el campo de búsqueda, escribe "C++test" e instala la extensión.

Después de la instalación, la extensión le dará la bienvenida con el siguiente mensaje:

Mensaje de la extensión de prueba C/C++ en VS Code

El mensaje informa que para ejecutar el análisis estático con la extensión VS Code necesita descargar el estándar de prueba C/C++, que es el motor de análisis estático de línea de comandos que utiliza Visual Studio de prueba C/C++. Extensión de código.

Tras descargar la distribución C/C++test Standard, simplemente descomprímala en el directorio que prefiera e instale la licencia de prueba (o la licencia completa). Su licencia debe incluir la función de línea de comandos. Puede instalar la licencia editando el archivo cpptestcli.properties, ubicado en el directorio principal de la distribución, o bien, colocar dicho archivo en su directorio personal e incluir allí la información de la licencia.

Para este experimento, utilizaremos el proyecto de ejemplo Timer que viene incluido con C/C++test. En VS Code, cambia al Explorador y usa "Agregar carpeta al espacio de trabajo..." para añadir la carpeta <directorio de instalación de C/C++test>/ejemplos/Timer a tu espacio de trabajo.

Para realizar la configuración sencilla de la extensión, haga clic en el inicio rápido de C/C++test en la barra de estado:

Captura de pantalla del inicio rápido de la prueba C/C++ en VS Code.

Verá estas opciones de configuración:

Ejemplos de configuraciones de prueba de C/C++ en VS Code

Configúrelos de la siguiente manera:

  • Seleccione la instalación de prueba de C / C ++: Señale el lugar donde desempaquetó el estándar de prueba C / C ++.
  • Seleccionar la configuración del compilador:Seleccione el compilador más cercano al que está utilizando para su proyecto, por ejemplo "GNU GCC 9.x (x86_64)" si utiliza GCC 9.2.
  • Seleccionar configuración de prueba: Define qué verificadores de análisis estáticos se utilizarán para escanear su proyecto. Quedémonos con el predeterminado.

Para tus proyectos reales, hay una configuración adicional que quizás debas ajustar para comenzar a usar el análisis estático. Lo veremos más adelante. Por ahora, con estas configuraciones hechas, selecciona la carpeta Timer en el Explorador de archivos.

En el menú contextual, seleccione "C/C++test: Analizar archivo(s) seleccionado(s)..." . El panel SALIDA comenzará a mostrar la información sobre los pasos subsiguientes del análisis estático.

Una vez realizado el análisis, el panel PROBLEMAS mostrará todos los hallazgos informados por el análisis estático. Debería verse como a continuación:

Captura de pantalla de la extensión de prueba C/C++ en VS Code

Puedes analizar los resultados haciendo clic en las líneas del panel PROBLEMAS. Al seleccionar un resultado, la extensión C/C++test te llevará al código fuente, donde podrás ver por qué se reporta el problema.

Si el motivo no está claro, haga clic con el botón derecho en el hallazgo en el panel PROBLEMAS y seleccione "Mostrar la documentación de <regla de análisis estático>" . Allí encontrará la descripción detallada.

Si prefiere ignorar el hallazgo, haga clic con el botón derecho y seleccione "Suprimir infracción de <regla>" . Esta operación añadirá un comentario especial al archivo fuente, lo que impedirá que el analizador informe de este hallazgo en el futuro.

También puedes "Eliminar la infracción de <regla>" de la vista y no preocuparte por ello en esta ejecución. Estas opciones de menú se muestran en la imagen superior.

Establecer líneas de comando de compilación para análisis estático

Mencioné que para tus proyectos reales quizás necesites configurar una opción adicional para comenzar a trabajar con el análisis estático. Se trata de la información de compilación , más específicamente, de las líneas de comando de compilación.

El motor de análisis estático necesita conocer las líneas de comando de compilación para cada archivo que se va a analizar. Dependiendo de cómo se construya su proyecto, puede aplicar diferentes estrategias para proporcionar esta información.

Veamos cómo sucedió para nuestro ejemplo de Timer.

Cambie al panel SALIDA, que aún debería contener la salida de nuestra ejecución de análisis.

Desplácese hacia arriba. En la segunda línea de la salida, debería ver la línea de comandos para C/C++test Standard ejecutada por la extensión. Comenzará con "cpptestcli". Lo interesante está al final de esta línea de comandos.

Captura de pantalla del panel Salida en VS Code después de ejecutar el análisis estático mediante la extensión de prueba C/C++

En este caso, se le indicó al motor de análisis estático de C/C++test que rastreara la compilación para obtener la información necesaria sobre las líneas de comandos de compilación. Esta estrategia también se puede aplicar a otros sistemas de compilación. Funciona correctamente:

Cpptestcli ejecuta el comando de compilación especificado después de la opción -trace. La información de compilación se analiza automáticamente y se guarda en el archivo cpptest.bdf, que ahora está visible en la carpeta "Timer" y se utiliza como entrada para el análisis estático.

Todo perfecto, pero ¿ qué pasa si quiero volver a ejecutar el análisis estático? Bueno, con la configuración predeterminada, C/C++test volverá a ejecutar la compilación. No es una buena opción para proyectos reales.

Así es como puede cambiarlo.

  • Abra la configuración de la extensión.
  • Presiona Ctr + Shift + P.
  • Escribe "C/C++test: Inicio rápido" y selecciona "Abrir configuración..." (O usa el inicio rápido de C/C++test en la barra de estado).

Verá la configuración de la extensión como se muestra aquí:

Configuración de la extensión de prueba C/C++ en VS Code

La configuración de la información de compilación forma parte de la configuración del patrón de línea de comandos. En el panel de configuración, seleccione Temporizador (junto a Usuario y Espacio de trabajo) para modificar la configuración únicamente de la carpeta Temporizador.

Vaya al patrón de línea de comandos , desplácese hasta el final y personalice el patrón para reemplazar "-trace make clean all" con "-input ${workspaceFolder}/cpptest.bdf" como se muestra a continuación:

Captura de pantalla de la configuración del patrón de línea de comando en la prueba C/C++ en VS Code IDE

Con esta configuración, cada vez que ejecute el análisis estático, C/C++test no volverá a ejecutar el proceso de compilación, sino que simplemente cargará el contenido del archivo cpptest.bdf generado durante la primera compilación y realizará el análisis mucho más rápido. Puede obtener más información sobre los archivos de datos de compilación aquí.

Configuración para CMake

Para quienes usan CMake en sus proyectos , existe una opción adicional para simplificar el proceso de configuración. C/C++test puede usar el archivo compile_commands.json, generado automáticamente por CMake, como entrada para el análisis.

En este artículo, configuramos la generación de archivos compile_commands.json para nuestro ejemplo de temporizador.

Cuando hayas terminado, vuelve a visitar el panel de configuración (Ctrl+Mayús+P, escribe "C/C++test: Inicio rápido" y selecciona "Abrir configuración..." o utiliza el inicio rápido "C/C++test" en la barra de estado).

Vaya al campo Patrón de línea de comandos y modifíquelo como se muestra a continuación:

¡Eso es! Puede utilizar el archivo generado automáticamente por la compilación de CMake y simplificar su configuración.

Hay un par de otras opciones y comandos interesantes disponibles en la extensión, que te invito a explorar. Por ejemplo, puede importar los resultados del análisis estático del archivo que se genera como parte de su canalización de CI / CD y revisarlo localmente.

Comience su viaje con la extensión de prueba C/C++ para el editor de Visual Studio Code.
Ver seminario web bajo demanda

«MISRA», «MISRA C» y el logotipo triangular son marcas registradas de The MISRA Consortium Limited. ©The MISRA Consortium Limited, 2021. Todos los derechos reservados.