如何扩展Hadolint标签Schema：自定义LabelType的完整指南-开发者社区

如何扩展Hadolint标签Schema：自定义LabelType的完整指南

【免费下载链接】hadolintDockerfile linter, validate inline bash, written in Haskell项目地址: https://gitcode.com/gh_mirrors/ha/hadolint

Hadolint作为一款强大的Dockerfile lint工具，能够帮助开发者检测Dockerfile中的潜在问题并提供优化建议。本文将详细介绍如何扩展Hadolint的标签Schema，实现自定义LabelType，让Dockerfile标签验证更符合项目需求。

为什么需要自定义LabelType？

Docker镜像标签（Labels）是元数据的重要载体，用于描述镜像的作者、版本、许可证等信息。Hadolint默认支持多种LabelType验证，包括邮箱、Git哈希、URL等标准格式。但在实际项目中，我们可能需要验证自定义格式的标签，例如内部版本号、部门标识等特殊格式。

图1：Hadolint对Dockerfile标签进行验证的示例界面

认识Hadolint的LabelType系统

Hadolint的LabelType定义在src/Hadolint/Rule.hs文件中，当前支持以下几种内置类型：

Email：验证邮箱格式
GitHash：验证Git提交哈希
RawText：纯文本，不进行格式验证
Rfc3339：验证RFC3339日期格式
SemVer：验证语义化版本号
Spdx：验证SPDX许可证标识符
Url：验证URL格式

这些类型通过readEitherLabelType函数进行解析和验证，代码如下：

readEitherLabelType :: Text -> Either Text LabelType readEitherLabelType "email" = Right Email readEitherLabelType "hash" = Right GitHash readEitherLabelType "text" = Right RawText readEitherLabelType "rfc3339" = Right Rfc3339 readEitherLabelType "semver" = Right SemVer readEitherLabelType "spdx" = Right Spdx readEitherLabelType "url" = Right Url readEitherLabelType "" = Right RawText readEitherLabelType t = Left ("invalid label type: " <> t)

实现自定义LabelType的步骤

步骤1：扩展LabelType数据类型

首先需要在src/Hadolint/Rule.hs中扩展LabelType数据类型，添加自定义类型。例如，添加一个InternalVersion类型用于验证内部版本号：

data LabelType = Email | GitHash | RawText | Rfc3339 | SemVer | Spdx | Url | InternalVersion -- 新增自定义类型 deriving (Eq, Show)

步骤2：实现解析逻辑

在同一文件中，修改readEitherLabelType函数，添加自定义类型的解析逻辑：

readEitherLabelType "internal-version" = Right InternalVersion -- 新增解析规则 readEitherLabelType t = Left ("invalid label type: " <> t)

步骤3：实现验证逻辑

为新的LabelType实现验证逻辑。创建一个新的规则文件，例如src/Hadolint/Rule/DL3099.hs，实现对InternalVersion格式的验证：

module Hadolint.Rule.DL3099 (rule) where import Hadolint.Rule (Rule, customRule, failOn) import Hadolint.Shell (ParsedShell) import qualified Hadolint.Rule as R rule :: Rule ParsedShell rule = customRule checkLabelType R.simpleState where checkLabelType line state (Label labelName labelValue) = if labelName == "org.example.internal-version" && not (isValidInternalVersion labelValue) then state |> failOn line "DL3099" "Invalid internal version format" else state checkLabelType _ state _ = state isValidInternalVersion v = -- 实现自定义验证逻辑，例如检查格式为"vX.Y.Z-build" Text.match (regex [r|^v\d+\.\d+\.\d+-\w+$|]) v

步骤4：更新Pretty实例

为了确保新类型能正确显示，需要在src/Hadolint/Rule.hs中更新Pretty LabelType实例：

instance Pretty LabelType where pretty RawText = "text" pretty Url = "url" pretty Spdx = "spdx" pretty GitHash = "hash" pretty Rfc3339 = "rfc3339" pretty SemVer = "semver" pretty Email = "email" pretty InternalVersion = "internal-version" -- 新增Pretty实例

步骤5：配置文件中使用自定义类型

在配置文件中（如contrib/hadolint.json），可以像使用内置类型一样使用自定义LabelType：

{ "label-schema": { "org.example.internal-version": "internal-version" } }

测试自定义LabelType

为确保自定义LabelType正常工作，需要编写相应的测试用例。创建测试文件test/Hadolint/Rule/DL3099Spec.hs，包含以下内容：

module Hadolint.Rule.DL3099Spec (spec) where import Hadolint.Rule (RuleCode(..)) import Helpers (hadolint) import Test.Hspec spec :: Spec spec = do describe "DL3099" $ do it "fails when internal-version label has invalid format" $ hadolint "LABEL org.example.internal-version=invalid" `shouldBe` ["DL3099"] it "passes when internal-version label has valid format" $ hadolint "LABEL org.example.internal-version=v1.2.3-beta" `shouldBe` []