arm ttk

Kit de herramientas de plantilla de Azure Resource Manager (arm-ttk)

El código de este repositorio se puede usar para analizar y probar plantillas de Azure Resource Manager. Las pruebas verificarán una plantilla o un conjunto de plantillas para conocer las mejores prácticas de codificación. Hay algunas comprobaciones para errores sintácticos simples, pero la intención no es volver a implementar las pruebas o comprobaciones proporcionadas por la plataforma (por ejemplo, la API /validate).

Nota: A partir de la versión 0.10, Bicep ahora contiene todos los casos de prueba de implementaciónTemplate incluidos en TTK. Comenzaremos a trasladar la inversión en nuevas pruebas al linter Bicep. El TTK seguirá estando disponible para admitir escenarios JSON y createUiDefinition disponibles.

Usando el TTK

Para obtener instrucciones detalladas sobre cómo utilizar arm-ttk, consulte este archivo Léame. Puede encontrar más información en la documentación.

Para obtener un tutorial guiado sobre arm-ttk, consulte este módulo de MS LEARN.

Filosofía

Un poco sobre las pruebas... Estas son las pruebas que se utilizan para validar plantillas para Azure QuickStart Repo y Azure Marketplace. El propósito es garantizar un conjunto estándar o consistente de prácticas de codificación para facilitar el desarrollo de experiencia utilizando el lenguaje de plantilla (fácil de leer, escribir y depurar).

En cuanto al tipo, número y naturaleza de las pruebas, una prueba debe verificar algo en las siguientes categorías (agregue más a medida que piense en ellas :))

• Validar la intención del autor (parámetros o variables no utilizados)
• Prácticas de seguridad para el idioma (generación de secretos en texto plano)
• Usar la construcción de lenguaje apropiada para la tarea en cuestión (usar funciones ambientales en lugar de codificar valores)

No todo es apropiado para un conjunto universal de pruebas y no todas las pruebas se aplicarán a todos los escenarios, por lo que el marco permite una fácil expansión y selección individual de pruebas.

Ejecutar pruebas unitarias localmente antes de solicitar un PR

Las pruebas se pueden ejecutar directamente en PowerShell o desde la línea de comandos mediante un script contenedor.

Puede ejecutar todas las pruebas unitarias utilizando .arm-ttk.tests.ps1 .

Esto ejecutará el conjunto completo de pruebas unitarias en los archivos json de pruebas.

usar:

 # set your location in the project directory:
Set-Location -Path "$(YourGithubProjectFolder)arm-ttkunit-tests"

# import the module from the current branch, use -Force to make sure you have imported any code changes
Import-Module ..arm-ttkarm-ttk.psd1 -Force

# These are the same tests that run in the pipeline when doing a commit or a pull request (PR). 
.arm-ttk.tests.ps1

Contribuyendo

Este proyecto agradece contribuciones y sugerencias. La mayoría de las contribuciones requieren que usted acepte un Acuerdo de licencia de colaborador (CLA) que declara que tiene derecho a otorgarnos, y de hecho lo hace, los derechos para usar su contribución. Para obtener más detalles, visite https://cla.opensource.microsoft.com.

Cuando envía una solicitud de extracción, un bot CLA determinará automáticamente si necesita proporcionar un CLA y decorar el PR de manera adecuada (por ejemplo, verificación de estado, comentario). Simplemente siga las instrucciones proporcionadas por el bot. Sólo necesitarás hacer esto una vez en todos los repositorios que utilicen nuestro CLA.

Este proyecto ha adoptado el Código de conducta de código abierto de Microsoft.

Para obtener más información, consulte las preguntas frecuentes sobre el Código de conducta o comuníquese con [email protected] si tiene alguna pregunta o comentario adicional.