DevOps Bootcamp · 课时

Terraform `validate` 与 `fmt`

使用 Terraform 内置命令，例如用于检查配置语法的 `validate`，以及用于统一代码格式的 `fmt`。

Terraform `validate` 与 `fmt` 是 CoddyKit 上的免费 DevOps Bootcamp 课时。这是第 1 节课，共 4 节。你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。这是 DevOps Bootcamp 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 DevOps Bootcamp 课程共包含 4 节课。

基础设施即代码的代码质量

优秀的代码不仅要具备功能，还要易于阅读且正确。对于基础设施即代码（IaC）而言，这一点更加重要，因为错误可能导致代价高昂的基础设施问题。

Terraform 提供了有助于实现这一点的内置工具：validate 和 fmt。它们可以确保配置在语法上正确，并采用一致的格式。

尽早发现错误

terraform validate 命令会检查配置文件中的语法错误和内部一致性。它可以确保代码在您尝试应用之前具有正确的结构。

这包括验证变量类型、资源参数和提供程序配置。这是一种快速发现错误的方法，无需与云提供商交互。

有效的配置

让我们来看一个简单且有效的 Terraform 配置。这段代码声明了一个 AWS S3 存储桶。

对其运行 terraform validate 将会成功，表示不存在语法或基本配置问题。

resource "aws_s3_bucket" "my_bucket" {
  bucket = "my-unique-coddykit-bucket-123"
  acl    = "private"

  tags = {
    Environment = "Dev"
    Project     = "CoddyKit"
  }
}

发现拼写错误

如果我们犯了错误怎么办？这里的 acl 参数被误拼为 accl。

terraform validate 会立即标记此错误，告知您 accl 不是 S3 存储桶资源可识别的参数。

resource "aws_s3_bucket" "my_bucket" {
  bucket = "my-unique-coddykit-bucket-456"
  accl   = "private" # Intentional typo!

  tags = {
    Environment = "Dev"
  }
}

如何使用 `validate`

要验证配置，请在终端中进入包含 .tf 文件的目录。然后直接运行：

terraform validate

它会针对当前工作目录执行检查。如果验证通过，它会静默退出并显示成功消息。如果验证失败，它会提供清晰的错误消息。

一致性是关键

您是否曾经在一个每个人格式化代码的方式都不同的团队中工作过？这会使代码难以阅读和维护。terraform fmt（格式化）可以解决这个问题！

它会自动将 Terraform 配置文件重写为规范的格式和样式，确保整个代码库和团队保持一致。

未格式化的代码

看看这个配置。缩进不一致，空格也不规范。它虽然有效，但很难快速浏览。

多人处理同一批文件时，很容易出现这种格式问题。

resource "aws_s3_bucket" "another_bucket" {
    bucket = "coddykit-unformatted-bucket"
        acl = "private"
      tags = {
          Project = "CoddyKit"
        Env = "Test"
      }
}

优美的格式

现在，想象一下对前面的代码运行 terraform fmt。它会自动调整空格和缩进，使其符合 Terraform 的标准样式。

这样可以让代码整洁得多，也更易于阅读。这是一个很小的更改，却能对协作产生很大的影响！

resource "aws_s3_bucket" "another_bucket" {
  bucket = "coddykit-unformatted-bucket"
  acl    = "private"
  tags = {
    Project = "CoddyKit"
    Env     = "Test"
  }
}

团队使用 fmt

要格式化文件，请在配置目录中运行 terraform fmt。它会直接修改文件。

对于持续集成/持续交付流水线，您可以使用 terraform fmt -check=true，在不修改文件的情况下验证文件是否格式正确。也可以使用 -diff 查看拟议的更改。

测试您的知识

以下关于 terraform validate 和 terraform fmt 的说法哪些是 TRUE？

验证并格式化您的代码！

在本课中，您学习了两个重要的 Terraform 命令：

terraform validate：确保配置具有正确的语法和内部一致性，尽早发现错误。
terraform fmt：自动将代码格式化为一致的样式，提高可读性并促进协作。

定期使用这些工具有助于维护高质量、无错误且易于阅读的基础设施即代码。接下来，我们将探索更高级的测试策略！

常见问题解答

「Terraform `validate` 与 `fmt`」课时是免费的吗？

是的 — 「Terraform `validate` 与 `fmt`」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 DevOps Bootcamp 课程的其余内容，请升级到 CoddyKit PRO。 DevOps Bootcamp 课程共包含 4 节课。

「Terraform `validate` 与 `fmt`」这节课中我会学到什么？

使用 Terraform 内置命令，例如用于检查配置语法的 `validate`，以及用于统一代码格式的 `fmt`。你通过在浏览器中直接运行的动手代码来练习 DevOps Bootcamp，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 DevOps Bootcamp 需要有经验吗？

无需任何先前经验。CoddyKit 上的 DevOps Bootcamp 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。这是第 1 节课，共 4 节。

「Terraform `validate` 与 `fmt`」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 DevOps Bootcamp 课中编写并运行代码吗？

能。每节 DevOps Bootcamp 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

← 返回 DevOps Bootcamp