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 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
|
// Copyright 2020 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
//
// http://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 validate collects errors from an evaluated Vertex.
package validate
import (
"cuelang.org/go/internal/core/adt"
)
type Config struct {
// Concrete, if true, requires that all values be concrete.
Concrete bool
// Final, if true, checks that there are no required fields left.
Final bool
// DisallowCycles indicates that there may not be cycles.
DisallowCycles bool
// AllErrors continues descending into a Vertex, even if errors are found.
AllErrors bool
// TODO: omitOptional, if this is becomes relevant.
}
// Validate checks that a value has certain properties. The value must have
// been evaluated.
func Validate(ctx *adt.OpContext, v *adt.Vertex, cfg *Config) *adt.Bottom {
if cfg == nil {
cfg = &Config{}
}
x := validator{Config: *cfg, ctx: ctx}
x.validate(v)
return x.err
}
type validator struct {
Config
ctx *adt.OpContext
err *adt.Bottom
inDefinition int
}
func (v *validator) checkConcrete() bool {
return v.Concrete && v.inDefinition == 0
}
func (v *validator) checkFinal() bool {
return (v.Concrete || v.Final) && v.inDefinition == 0
}
func (v *validator) add(b *adt.Bottom) {
if !v.AllErrors {
v.err = adt.CombineErrors(nil, v.err, b)
return
}
if !b.ChildError {
v.err = adt.CombineErrors(nil, v.err, b)
}
}
func (v *validator) validate(x *adt.Vertex) {
defer v.ctx.PopArc(v.ctx.PushArc(x))
// Dereference values, but only those that are not shared. This includes let
// values. This prevents us from processing structure-shared nodes more than
// once and prevents potential cycles.
x = x.DerefNonShared()
if b := x.Bottom(); b != nil {
switch b.Code {
case adt.CycleError:
if v.checkFinal() || v.DisallowCycles {
v.add(b)
}
case adt.IncompleteError:
if v.checkFinal() {
v.add(b)
}
default:
v.add(b)
}
if !b.HasRecursive {
return
}
} else if v.checkConcrete() {
x = x.Default()
if !adt.IsConcrete(x) {
x := x.Value()
v.add(&adt.Bottom{
Code: adt.IncompleteError,
Err: v.ctx.Newf("incomplete value %v", x),
})
}
}
for _, a := range x.Arcs {
if a.ArcType == adt.ArcRequired && v.Final && v.inDefinition == 0 {
v.add(adt.NewRequiredNotPresentError(v.ctx, a))
continue
}
if a.Label.IsLet() || !a.IsDefined(v.ctx) {
continue
}
if !v.AllErrors && v.err != nil {
break
}
if a.Label.IsRegular() {
v.validate(a)
} else {
v.inDefinition++
v.validate(a)
v.inDefinition--
}
}
}
|