arm ttk

Набор инструментов для шаблонов Azure Resource Manager (arm-ttk)

Код в этом репозитории можно использовать для анализа и тестирования шаблонов Azure Resource Manager. Тесты проверят шаблон или набор шаблонов на предмет лучших практик кодирования. Существуют некоторые проверки на наличие простых синтаксических ошибок, но цель не состоит в том, чтобы повторно реализовать тесты или проверки, предоставляемые платформой (например, API /validate).

Примечание. Начиная с версии 0.10, Bicep теперь содержит все тестовые примеры DeploymentTemplate, включенные в TTK. Мы начнем переводить инвестиции в новые тесты в линтер Bicep. TTK останется доступным для поддержки доступных сценариев JSON и createUiDefinition.

Использование ТТК

Подробные инструкции по использованию Arm-ttk см. в этом файле readme. Более подробную информацию можно найти в документации.

Подробное руководство по Arm-ttk можно найти в этом модуле MS LEARN.

Философия

Немного о тестах... Это тесты, которые используются для проверки шаблонов для репозитория Azure QuickStart и 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.

В этом проекте принят Кодекс поведения Microsoft с открытым исходным кодом.

Для получения дополнительной информации см. Часто задаваемые вопросы о Кодексе поведения или свяжитесь с нами по адресу [email protected], если у вас возникнут дополнительные вопросы или комментарии.