1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
|
// Copyright 2025 CUE Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package yaml
import (
"errors"
"io"
"cuelang.org/go/cue"
"cuelang.org/go/internal/core/adt"
"cuelang.org/go/internal/pkg"
"cuelang.org/go/internal/value"
)
// Validate validates YAML and confirms it is an instance of schema.
// If the YAML source is a stream, every object must match v.
//
// If Validate is called in a broader context, like a validation or function
// call, the cycle context of n should be accumulated in c before this call.
// This can be done by using the Expr method on the CallContext.
func Validate(c *adt.OpContext, b []byte, v cue.Value) (bool, error) {
d := NewDecoder("yaml.Validate", b)
r := v.Context()
for {
expr, err := d.Decode()
if err != nil {
if err == io.EOF {
return true, nil
}
return false, err
}
x := r.BuildExpr(expr)
if err := x.Err(); err != nil {
return false, err
}
// TODO: consider using subsumption again here.
// Alternatives:
// - allow definition of non-concrete list,
// like list.Of(int), or []int.
// - Introduce ! in addition to ?, allowing:
// list!: [...]
// if err := v.Subsume(inst.Value(), cue.Final()); err != nil {
// return false, err
// }
vx := adt.Unify(c, value.Vertex(x), value.Vertex(v))
x = value.Make(c, vx)
if err := x.Err(); err != nil {
return false, err
}
if err := x.Validate(cue.Concrete(true)); err != nil {
// Strip error codes: incomplete errors are terminal in this case.
var b pkg.Bottomer
if errors.As(err, &b) {
err = b.Bottom().Err
}
return false, err
}
}
}
// ValidatePartial validates YAML and confirms it matches the constraints
// specified by v using unification. This means that b must be consistent with,
// but does not have to be an instance of v. If the YAML source is a stream,
// every object must match v.
func ValidatePartial(c *adt.OpContext, b []byte, v cue.Value) (bool, error) {
d := NewDecoder("yaml.ValidatePartial", b)
r := v.Context()
for {
expr, err := d.Decode()
if err != nil {
if err == io.EOF {
return true, nil
}
return false, err
}
x := r.BuildExpr(expr)
if err := x.Err(); err != nil {
return false, err
}
vx := adt.Unify(c, value.Vertex(x), value.Vertex(v))
x = value.Make(c, vx)
if err := x.Err(); err != nil {
return false, err
}
}
}
|