arm ttk

Azure Resource Manager-Vorlagen-Toolkit (arm-ttk)

Der Code in diesem Repository kann zum Analysieren und Testen von Azure Resource Manager-Vorlagen verwendet werden. Bei den Tests wird eine Vorlage oder eine Reihe von Vorlagen auf Best Practices für die Codierung überprüft. Es gibt einige Prüfungen auf einfache syntaktische Fehler, aber die Absicht besteht nicht darin, von der Plattform bereitgestellte Tests oder Prüfungen (z. B. die /validate-API) erneut zu implementieren.

Hinweis: Ab der Version 0.10 enthält Bicep nun alle im TTK enthaltenen DeploymentTemplate-Testfälle. Wir werden damit beginnen, die Investition in neue Tests auf den Bicep-Linter zu verlagern. Das TTK bleibt verfügbar, um verfügbare JSON- und createUiDefinition-Szenarien zu unterstützen.

Verwendung des TTK

Ausführliche Anweisungen zur Verwendung des arm-ttk finden Sie in dieser Readme-Datei. Weitere Informationen finden Sie in der Dokumentation.

Eine geführte Anleitung zum arm-ttk finden Sie in diesem MS LEARN-Modul.

Philosophie

Ein wenig über die Tests... Dies sind die Tests, die zur Validierung von Vorlagen für das Azure QuickStart Repo und den Azure Marketplace verwendet werden. Der Zweck besteht darin, einen standardisierten oder konsistenten Satz von Codierungspraktiken sicherzustellen, um die Entwicklung von Fachwissen mithilfe der Vorlagensprache (einfach zu lesen, zu schreiben, zu debuggen) zu erleichtern.

Was die Art, Anzahl und Art der Tests betrifft, sollte ein Test auf etwas in den folgenden Kategorien prüfen (fügen Sie weitere hinzu, wenn Sie darüber nachdenken :))

• Validierung der Absicht des Autors (nicht verwendete Parameter oder Variablen)
• Sicherheitspraktiken für die Sprache (Geheimnisse im Klartext ausgeben)
• Verwendung des geeigneten Sprachkonstrukts für die jeweilige Aufgabe (Verwendung von Umgebungsfunktionen anstelle von fest codierten Werten)

Nicht alles ist für einen universellen Testsatz geeignet und nicht jeder Test lässt sich auf jedes Szenario anwenden, sodass das Framework eine einfache Erweiterung und individuelle Auswahl von Tests ermöglicht.

Führen Sie Unit-Tests lokal aus, bevor Sie eine PR anfordern

Tests können direkt in PowerShell oder über die Befehlszeile mithilfe eines Wrapper-Skripts ausgeführt werden.

Sie können alle Komponententests ausführen, indem Sie .arm-ttk.tests.ps1 verwenden.

Dadurch wird die gesamte Suite von Komponententests für die JSON-Dateien des Tests ausgeführt.

verwenden:

 # 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

Mitwirken

Dieses Projekt freut sich über Beiträge und Vorschläge. Für die meisten Beiträge müssen Sie einem Contributor License Agreement (CLA) zustimmen, in dem Sie erklären, dass Sie das Recht haben, uns die Rechte zur Nutzung Ihres Beitrags zu gewähren, und dies auch tatsächlich tun. Weitere Informationen finden Sie unter https://cla.opensource.microsoft.com.

Wenn Sie eine Pull-Anfrage einreichen, ermittelt ein CLA-Bot automatisch, ob Sie eine CLA bereitstellen müssen, und schmückt die PR entsprechend (z. B. Statusprüfung, Kommentar). Folgen Sie einfach den Anweisungen des Bots. Sie müssen dies nur einmal in allen Repositorys tun, die unsere CLA verwenden.

Dieses Projekt hat den Microsoft Open Source Verhaltenskodex übernommen.

Weitere Informationen finden Sie in den FAQ zum Verhaltenskodex oder wenden Sie sich bei weiteren Fragen oder Kommentaren an [email protected].