`validate` и `fmt` в Terraform

Хороший код — это не только функциональность, но и понятность и корректность. Для инфраструктуры как кода (IaC) это ещё важнее, поскольку ошибки могут привести к дорогостоящим проблемам с инфраструктурой.

Terraform предоставляет встроенные инструменты: validate и fmt. Они обеспечивают синтаксическую корректность и единообразное форматирование конфигураций.

Команда terraform validate проверяет файлы конфигурации на наличие синтаксических ошибок и внутреннюю согласованность. Она гарантирует структурную корректность кода до попытки его применения.

Проверяются, в частности, типы переменных, аргументы ресурсов и конфигурации провайдеров. Это быстрый способ обнаружить ошибки без взаимодействия с Вашим облачным провайдером.

Рассмотрим простую корректную конфигурацию Terraform. Этот код объявляет сегмент AWS S3.

Выполнение terraform validate для неё завершится успешно, что указывает на отсутствие синтаксических и базовых конфигурационных проблем.

Что произойдёт, если мы допустим ошибку? Здесь аргумент acl написан с опечаткой — accl.

terraform validate немедленно укажет на эту ошибку и сообщит, что accl не является распознаваемым аргументом ресурса сегмента S3.

Чтобы проверить конфигурацию, перейдите в терминале в каталог, содержащий Ваши файлы .tf. Затем просто выполните:

terraform validate

Команда выполняет проверки в текущем рабочем каталоге. Если проверка проходит успешно, команда завершает работу без вывода, сообщая об успехе. При ошибке она выводит понятные сообщения об ошибках.

Работали ли Вы когда-нибудь в команде, где каждый форматирует код по-своему? Такой код может быть трудным для чтения и сопровождения. Команда terraform fmt (форматирование) решает эту проблему!

Она автоматически переписывает файлы конфигурации Terraform в каноническом формате и стиле. Это обеспечивает единообразие во всей кодовой базе и у всей команды.

Посмотрите на эту конфигурацию. Отступы в ней непоследовательны, а интервалы заданы неправильно. Она корректна, но её трудно быстро просмотреть.

Такое форматирование легко возникает, когда несколько человек работают с одними и теми же файлами.

Теперь представьте, что Вы выполняете terraform fmt для предыдущего кода. Команда автоматически скорректирует интервалы и отступы в соответствии со стандартным стилем Terraform.

Код станет гораздо чище и удобнее для чтения. Это небольшое изменение, которое существенно улучшает совместную работу!

Чтобы отформатировать файлы, выполните terraform fmt в каталоге конфигурации. Команда изменяет файлы непосредственно на месте.

Для конвейеров CI/CD можно использовать terraform fmt -check=true, чтобы проверить, отформатированы ли файлы правильно, не изменяя их. Или -diff, чтобы просмотреть предлагаемые изменения.

На этом уроке Вы узнали о двух важных командах Terraform:

• terraform validate: Проверяет синтаксическую корректность и внутреннюю согласованность конфигурации, помогая рано обнаруживать ошибки.
• terraform fmt: Автоматически форматирует код в едином стиле, улучшая читаемость и совместную работу.

Регулярное использование этих инструментов помогает поддерживать качественную, безошибочную и понятную инфраструктуру как код. Далее мы рассмотрим более продвинутые стратегии тестирования!