arm ttk

Azure 資源管理器範本工具包 (arm-ttk)

此儲存庫中的程式碼可用於分析和測試 Azure 資源管理器範本。測試將檢查一個或一組模板的編碼最佳實踐。有一些針對簡單語法錯誤的檢查，但目的不是重新實作平台提供的測試或檢查（例如/validate api）。

注意：從 0.10 版本開始，Bicep 現在包含 TTK 中包含的所有部署模板測試案例。我們將開始將新測試的投資轉移到 Bicep linter。 TTK 將仍然可用以支援可用的 JSON 和 createUiDefinition 方案。

使用TTK

有關如何使用arm-ttk的詳細說明，請參閱此自述文件。更多資訊可以在文件中找到。

有關 arm-ttk 的指導教學課程，請查看此 MS LEARN 模組。

哲學

關於測試的一些資訊...這些測試用於驗證 Azure QuickStart Repo 和 Azure Marketplace 的範本。目的是確保一套標準或一致的編碼實踐，以便更輕鬆地使用模板語言開發專業知識（易於閱讀、編寫、調試）。

至於測驗的類型、數量和性質，測驗應該檢查以下類別中的某些內容（根據您的想法添加更多:)）

• 驗證作者的意圖（未使用的參數或變數）
• 語言的安全實踐（以純文字形式輸出秘密）
• 使用適合手邊任務的語言建構（使用環境函數而不是硬編碼值）

並非所有內容都適合通用測試集，也不是每個測試都適用於每個場景，因此該框架允許輕鬆擴展和單獨選擇測試。

在請求 PR 之前在本地運行單元測試

測試可以直接在 PowerShell 中執行，也可以使用包裝腳本從命令列執行。

您可以使用.arm-ttk.tests.ps1來執行所有單元測試。

這將針對測試 json 檔案執行全套單元測試。

使用：

 # 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

貢獻

該項目歡迎貢獻和建議。大多數貢獻都要求您同意貢獻者授權協議 (CLA)，聲明您有權並且實際上授予我們使用您的貢獻的權利。有關詳細信息，請訪問 https://cla.opensource.microsoft.com。

當您提交拉取請求時，CLA 機器人將自動確定您是否需要提供 CLA 並適當地修飾 PR（例如，狀態檢查、評論）。只需按照機器人提供的說明進行操作即可。您只需使用我們的 CLA 在所有儲存庫中執行一次此操作。

該專案採用了微軟開源行為準則。

有關詳細信息，請參閱行為準則常見問題解答或聯繫 [email protected] 提出任何其他問題或意見。