使用 Golang 对 YAML 模式进行验证（语义检查）。

Question

使用 Golang 对 YAML 模式进行验证（语义检查）。

7

我们有一个工具需要读取特定结构的YAML文件。当我们获取到YAML文件后，我们需要知道以下信息：

检查YAML文件是否符合某些指南 - 语义检查

如果有语法错误，需要知道错误位置

例如，这是我们需要处理的验证示例。

 _version:  {required: true}
   id: {required: true, pattern: '/^[A-Za_\-\.]+$/'}   
   release-version: {required: true}
   type:   

   builds:
     type:seq
     sequence:
       -type:map
     mapping:
        name:{required: true, unique: true, pattern: '/^[A-Za-z0-3_\-\.]+$/'}
        params: 
          type: map
          mapping: { =: {type: any} }

映射是一个键值对象，seq 可以有多个构建版本，类型为 any 的键值对。我们使用这个开源工具来解析 yaml：https://github.com/go-yaml/yaml。一个好的想法是将其转换为 json，然后通过验证库进行验证。在我的环境中，任何示例都将非常有帮助：https://github.com/xeipuuv/gojsonschema。但我不确定如何处理。

Type map
Type seq

- user8557463

为什么要使用 docker 标签？ - BMitch

@BMitch - 我认为Docker和K8s有相同的任务，即验证部署的YAML模式，不是吗？所以也许我可以使用相同的想法... - user8557463

2个回答

3

您可以使用go-yaml与jsonschema一起工作。参见此问题：https://github.com/santhosh-tekuri/jsonschema/issues/5 简而言之：

创建一个自定义的yaml解析器，生成兼容的输出类型，如此问题所示。
使用该自定义解析器将yaml解析为interface{}
使用jsonschema.ValidateInterface进行验证。

（一旦发布了yaml.v3，可以用配置选项替换自定义解析器）

最初我使用了被接受答案的方法，将其解析为结构并编写代码来手动验证结构是否符合规范。这很快变得非常丑陋 - 上述方法允许使用干净的单独规范，并对其进行可靠的验证。

- Michael

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Pandemonium · Accepted Answer

这里是你可以尝试的方法。

按照预期的yaml数据的格式建立一个结构体：

type Config struct {
        Version struct {
                Required bool
        }
        ID struct {
                Required bool
                Pattern string
        }
        ReleaseVersion struct {
                Required bool
        }
        Type interface{}
        Builds struct {
                Type []interface{} `yaml:"type"`
                Sequence struct {
                        Type string
                }
                Mapping struct {
                        Name map[string]interface{}
                        Params struct {
                                Type string `yaml:"type"`
                                Mapping struct {
                                        To map[string]string `yaml:"="`
                                }
                        }
                } `yaml:"mapping"`              
        }
}

为了标识我们感兴趣的yaml数据字段名称，添加了yaml标志yaml：“somefield”。

此外，许多类型未知/未确定的字段可以声明为空接口(interface{})，或者如果要“强制执行”基础形式为键值对对象，则可以将其声明为map[string]interface{}或另一个结构体。

然后，我们将yaml数据解组为该结构：

cfg := Config{}
err := yaml.Unmarshal([]byte(data), &cfg)
if err != nil {
        log.Fatalf("error: %v", err)
}

由于我们将字段建模为匿名结构体或映射，因此我们可以通过检查其等于nil来测试特定字段是否具有“键值”值。

// Mapping is a key value object
if (Mapping != nil) {
        // Mapping is a key-value object, since it's not nil.
}


// type any is and key value
// Mapping.To is declared with map[string]string type
// so if it's not nil we can say there's a map there.
if (Mapping.To != nil) {
        // Mapping.To is a map
}

在编组/解组中，映射和结构体基本可以互换使用。结构体的好处是可以预先定义字段名称，而将解组结果解组为映射时，其键名并不清晰明了。