arm ttk

Boîte à outils de modèles Azure Resource Manager (arm-ttk)

Le code de ce référentiel peut être utilisé pour analyser et tester les modèles Azure Resource Manager. Les tests vérifieront un modèle ou un ensemble de modèles pour connaître les meilleures pratiques de codage. Il existe quelques vérifications pour les erreurs syntaxiques simples, mais l'intention n'est pas de réimplémenter les tests ou les vérifications fournies par la plate-forme (par exemple, l'API /validate).

Remarque : à partir de la version 0.10, Bicep contient désormais tous les scénarios de test de déploiementTemplate inclus dans le TTK. Nous allons commencer à déplacer l'investissement dans de nouveaux tests vers le linter Biceps. Le TTK restera disponible pour prendre en charge les scénarios JSON et createUiDefinition disponibles.

Utiliser le TTK

Pour des instructions détaillées sur l’utilisation de arm-ttk, consultez ce fichier Lisez-moi. Plus d’informations peuvent être trouvées dans la documentation.

Pour un didacticiel guidé sur arm-ttk, consultez ce module MS LEARN.

Philosophie

Un peu sur les tests... Ce sont les tests qui sont utilisés pour valider les modèles pour Azure QuickStart Repo et Azure Marketplace. L’objectif est de garantir un ensemble standard ou cohérent de pratiques de codage pour faciliter le développement d’une expertise à l’aide du langage modèle (facile à lire, écrire, déboguer).

En ce qui concerne le type, le nombre et la nature des tests, un test doit vérifier quelque chose dans les catégories suivantes (ajoutez-en d'autres au fur et à mesure que vous y pensez :))

• Valider l'intention de l'auteur (paramètres ou variables inutilisés)
• Pratiques de sécurité pour la langue (affichage des secrets en texte brut)
• Utiliser la construction de langage appropriée pour la tâche à accomplir (en utilisant des fonctions environnementales au lieu de valeurs codées en dur)

Tout n’est pas approprié pour un ensemble universel de tests et tous les tests ne s’appliqueront pas à tous les scénarios. Le cadre permet donc une extension facile et une sélection individuelle des tests.

Exécuter des tests unitaires localement avant de demander un PR

Les tests peuvent être exécutés directement dans PowerShell ou à partir de la ligne de commande à l'aide d'un script wrapper.

Vous pouvez exécuter tous les tests unitaires en utilisant .arm-ttk.tests.ps1 .

Cela exécutera la suite complète de tests unitaires sur les fichiers json de tests.

utiliser:

 # 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

Contribuer

Ce projet accueille les contributions et suggestions. La plupart des contributions nécessitent que vous acceptiez un contrat de licence de contributeur (CLA) déclarant que vous avez le droit de nous accorder, et que vous nous accordez effectivement, le droit d'utiliser votre contribution. Pour plus de détails, visitez https://cla.opensource.microsoft.com.

Lorsque vous soumettez une pull request, un robot CLA déterminera automatiquement si vous devez fournir un CLA et décorera le PR de manière appropriée (par exemple, vérification du statut, commentaire). Suivez simplement les instructions fournies par le bot. Vous n’aurez besoin de le faire qu’une seule fois sur tous les référentiels utilisant notre CLA.

Ce projet a adopté le code de conduite Microsoft Open Source.

Pour plus d’informations, consultez la FAQ sur le code de conduite ou contactez [email protected] pour toute question ou commentaire supplémentaire.