Administración de políticas de análisis de código
- Actualizado: 2024/03/21
Administración de políticas de análisis de código
Las políticas de análisis de código son un conjunto de reglas que puede aplicar a distintos proyectos y que permiten flexibilidad a la hora de introducir normas de codificación.
- Crear políticas con diferentes reglas.
- Aplicar diferentes políticas a diferentes carpetas en la página Automatización.
- Acceder fácilmente a los detalles de las reglas de la política mientras gestiona las políticas de análisis de código.
Habilitar la política de análisis de código
Como administrador, puede habilitar la política de análisis de código accediendo a la pestaña . Haga clic en Editar para habilitar la política de análisis de código. Al habilitar la política de análisis de código:
- El análisis de código se ejecuta automáticamente en todos los bots del espacio de trabajo público que tengan el estado No analizado y residan en carpetas a las que se haya asignado una política de análisis de código. Esto proporciona visibilidad sobre las mejores prácticas de codificación para el bots en el espacio de trabajo público. El análisis del código se ejecuta cada cinco minutos y escanea 1000 archivos bot en cinco minutos.
- El análisis de código se invoca al guardar un bot en el Editor de bots.
- El resumen de los resultados del análisis de código es visible en la página Automatización.
- Los resultados del análisis de código se muestran en la pestaña Asistente.
- El icono Ejecutar el análisis de código está disponible desde la acción de nivel de fila en la página Automatización. Ejecutar el análisis de código desde la página Automatización permite descargar el informe de infracciones del análisis de código.
Cuando se inhabilita la política de análisis de código, las funciones y características de análisis de código no están disponibles.
Impacto en el rendimiento del escaneo en segundo plano
El escaneo automatizado para el análisis de código es un trabajo en segundo plano que se ejecuta en la Control Room. Se ejecuta cada cinco minutos y analiza archivos en lotes de 1000.
Para minimizar el impacto en el rendimiento de la Control Room, el análisis de código automatizado se ejecuta solo en un único nodo de la Control Room (en caso de implementaciones de múltiples nodos). Solo se ejecuta un trabajo de escaneo en segundo plano a la vez, es decir, el trabajo se ejecuta hasta que se completa antes de que se inicie otra instancia del trabajo. El trabajo en segundo plano analiza los archivos secuencialmente uno por uno, por lo que el número máximo de archivos que analiza el trabajo en segundo plano en un momento dado es solo uno.
- La política se agrega a la carpeta de origen.
- La política se aplica a los cambios de la carpeta de origen.
- La política se agrega o cambia en todas las carpetas del repositorio público.
- En el caso de repositorios más grandes, el trabajo de escaneo en segundo plano tardará varias horas en completarse.
- Solo los archivos con estado No escaneado se escanean con un análisis de código automatizado y, si cambia las políticas, todos los archivos dentro de las carpetas que tienen las políticas actualizadas se establecerán en el estado No escaneado.
Independientemente de si el análisis de código está habilitado o inhabilitado, puede crear varias políticas y asignarlas a diferentes carpetas en la página Automatización.
En el siguiente video se muestra cómo habilitar la política de análisis de código:
Crear y asignar una política de análisis de código
Puede configurar varias políticas con nombre para el análisis de código. Con esta característica, puede crear diferentes políticas con diferentes reglas configuradas con diferentes configuraciones y diferentes niveles de gravedad. Puede usar estas políticas de análisis de código con nombre para definir diferentes estándares de calidad del código y aplicarlos a diferentes proyectos de automatización asignando la política a carpetas específicas. Esto proporciona flexibilidad para introducir gradualmente normas de calidad del código en los proyectos existentes y más antiguos, y también para aplicar normas más firmes en los proyectos más nuevos.
Necesita los permisos Ver políticas y Administrar políticas para configurar una política de análisis de código. Estos permisos le permiten ver, editar y asignar políticas que definen cómo los desarrolladores pueden crear automatizaciones. El permiso Administrar políticas permite asignar políticas a las carpetas a las que tiene acceso.
La página tiene dos pestañas; Políticas y Asignar. Puede crear y nombrar estas políticas en la pestaña Políticas. Puede crear cualquier cantidad de políticas. Puede buscar cualquier política usando la herramienta de búsqueda de la parte superior. Puede usar el nombre o la descripción de la política en la ventana del selector de políticas para buscar una política. También puede ver, editar y eliminar cualquier política haciendo clic en el menú de acciones (elipses verticales) de la derecha y seleccionando la acción adecuada.
Use la pestaña Asignar para asignar una política a una carpeta en la página Automatización. Opcionalmente, puede quitar la política asignada en cualquier carpeta haciendo clic en el menú de acciones (elipses verticales) de la derecha y seleccionando Cancelar asignación de política.
Ventana emergente del resumen de la política: La ventana emergente del resumen de la política proporciona una referencia rápida y sencilla de los detalles de las reglas definidas en la política y su gravedad. Con esta ventana emergente, es más sencillo entender qué política se aplica a las diferentes carpetas sin tener que navegar de un lado al otro entre las pestañas de políticas y asignación en el administrador de políticas. También lo ayuda a decidir qué política desea asignar a una carpeta concreta con rapidez.
- Pestaña Política: Haga clic en el número de reglas.
- Pestaña Asignar: Haga clic en la política asignada o en el número de reglas en la opción Asignar política.
Comportamiento de las políticas en las operaciones con carpetas
| Operación de carpeta | Comportamiento de políticas |
|---|---|
| Crear | La carpeta hereda la política de la carpeta primaria más cercana |
| Renombrar | La carpeta mantiene la política actual |
| Mover | La carpeta conserva la política actual o hereda la política de la carpeta principal más cercana |
| Eliminar | Se elimina la política asignada a la carpeta |
Cuando se ejecuta el análisis del código en un bot, se usa la política aplicable para la carpeta (asignada o heredada) en la que se encuentra el bot.