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 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
|
// 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 filetypes
import (
"fmt"
"path/filepath"
"strconv"
"strings"
"cuelang.org/go/cue"
"cuelang.org/go/cue/build"
"cuelang.org/go/cue/errors"
"cuelang.org/go/cue/token"
)
// Mode indicate the base mode of operation and indicates a different set of
// defaults.
type Mode int
const (
Input Mode = iota // The default
Export
Def
Eval
)
func (m Mode) String() string {
switch m {
default:
return "input"
case Eval:
return "eval"
case Export:
return "export"
case Def:
return "def"
}
}
// FileInfo defines the parsing plan for a file.
type FileInfo struct {
*build.File
Definitions bool `json:"definitions"` // include/allow definition fields
Data bool `json:"data"` // include/allow regular fields
Optional bool `json:"optional"` // include/allow definition fields
Constraints bool `json:"constraints"` // include/allow constraints
References bool `json:"references"` // don't resolve/allow references
Cycles bool `json:"cycles"` // cycles are permitted
KeepDefaults bool `json:"keepDefaults"` // select/allow default values
Incomplete bool `json:"incomplete"` // permit incomplete values
Imports bool `json:"imports"` // don't expand/allow imports
Stream bool `json:"stream"` // permit streaming
Docs bool `json:"docs"` // show/allow docs
Attributes bool `json:"attributes"` // include/allow attributes
}
// TODO(mvdan): the funcs below make use of typesValue concurrently,
// even though we clearly document that cue.Values are not safe for concurrent use.
// It seems to be OK in practice, as otherwise we would run into `go test -race` failures.
// FromFile return detailed file info for a given build file.
// Encoding must be specified.
// TODO: mode should probably not be necessary here.
func FromFile(b *build.File, mode Mode) (*FileInfo, error) {
// Handle common case. This allows certain test cases to be analyzed in
// isolation without interference from evaluating these files.
if mode == Input &&
b.Encoding == build.CUE &&
b.Form == "" &&
b.Interpretation == "" {
return &FileInfo{
File: b,
Definitions: true,
Data: true,
Optional: true,
Constraints: true,
References: true,
Cycles: true,
KeepDefaults: true,
Incomplete: true,
Imports: true,
Docs: true,
Attributes: true,
}, nil
}
typesInit()
modeVal := typesValue.LookupPath(cue.MakePath(cue.Str("modes"), cue.Str(mode.String())))
fileVal := modeVal.LookupPath(cue.MakePath(cue.Str("FileInfo")))
fileVal = fileVal.FillPath(cue.Path{}, b)
if b.Encoding == "" {
ext := modeVal.LookupPath(cue.MakePath(cue.Str("extensions"), cue.Str(fileExt(b.Filename))))
if ext.Exists() {
fileVal = fileVal.Unify(ext)
}
}
var errs errors.Error
interpretation, _ := fileVal.LookupPath(cue.MakePath(cue.Str("interpretation"))).String()
if b.Form != "" {
fileVal, errs = unifyWith(errs, fileVal, typesValue, "forms", string(b.Form))
// may leave some encoding-dependent options open in data mode.
} else if interpretation != "" {
// always sets schema form.
fileVal, errs = unifyWith(errs, fileVal, typesValue, "interpretations", interpretation)
}
if interpretation == "" {
s, err := fileVal.LookupPath(cue.MakePath(cue.Str("encoding"))).String()
if err != nil {
return nil, err
}
fileVal, errs = unifyWith(errs, fileVal, modeVal, "encodings", s)
}
fi := &FileInfo{}
if err := fileVal.Decode(fi); err != nil {
return nil, errors.Wrapf(err, token.NoPos, "could not parse arguments")
}
return fi, errs
}
// unifyWith returns the equivalent of `v1 & v2[field][value]`.
func unifyWith(errs errors.Error, v1, v2 cue.Value, field, value string) (cue.Value, errors.Error) {
v1 = v1.Unify(v2.LookupPath(cue.MakePath(cue.Str(field), cue.Str(value))))
if err := v1.Err(); err != nil {
errs = errors.Append(errs,
errors.Newf(token.NoPos, "unknown %s %s", field, value))
}
return v1, errs
}
// ParseArgs converts a sequence of command line arguments representing
// files into a sequence of build file specifications.
//
// The arguments are of the form
//
// file* (spec: file+)*
//
// where file is a filename and spec is itself of the form
//
// tag[=value]('+'tag[=value])*
//
// A file type spec applies to all its following files and until a next spec
// is found.
//
// Examples:
//
// json: foo.data bar.data json+schema: bar.schema
func ParseArgs(args []string) (files []*build.File, err error) {
typesInit()
var modeVal, fileVal cue.Value
qualifier := ""
hasFiles := false
for i, s := range args {
a := strings.Split(s, ":")
switch {
case len(a) == 1 || len(a[0]) == 1: // filename
if !fileVal.Exists() {
if len(a) == 1 && strings.HasSuffix(a[0], ".cue") {
// Handle majority case.
f := *fileForCUE
f.Filename = a[0]
files = append(files, &f)
hasFiles = true
continue
}
modeVal, fileVal, err = parseType("", Input)
if err != nil {
return nil, err
}
}
if s == "" {
return nil, errors.Newf(token.NoPos, "empty file name")
}
f, err := toFile(modeVal, fileVal, s)
if err != nil {
return nil, err
}
files = append(files, f)
hasFiles = true
case len(a) > 2 || a[0] == "":
return nil, errors.Newf(token.NoPos,
"unsupported file name %q: may not have ':'", s)
case a[1] != "":
return nil, errors.Newf(token.NoPos, "cannot combine scope with file")
default: // scope
switch {
case i == len(args)-1:
qualifier = a[0]
fallthrough
case qualifier != "" && !hasFiles:
return nil, errors.Newf(token.NoPos, "scoped qualifier %q without file", qualifier+":")
}
modeVal, fileVal, err = parseType(a[0], Input)
if err != nil {
return nil, err
}
qualifier = a[0]
hasFiles = false
}
}
return files, nil
}
// DefaultTagsForInterpretation returns any tags that would be set by default
// in the given interpretation in the given mode.
func DefaultTagsForInterpretation(interp build.Interpretation, mode Mode) map[string]bool {
if interp == "" {
return nil
}
// TODO this could be done once only.
// This should never fail if called with a legitimate build.Interpretation constant.
mv, fv, err := parseType(string(interp), mode)
if err != nil {
panic(err)
}
f, err := toFile(mv, fv, "-")
if err != nil {
panic(err)
}
return f.BoolTags
}
// ParseFile parses a single-argument file specifier, such as when a file is
// passed to a command line argument.
//
// Example:
//
// cue eval -o yaml:foo.data
func ParseFile(s string, mode Mode) (*build.File, error) {
scope := ""
file := s
if p := strings.LastIndexByte(s, ':'); p >= 0 {
scope = s[:p]
file = s[p+1:]
if scope == "" {
return nil, errors.Newf(token.NoPos, "unsupported file name %q: may not have ':", s)
}
}
if file == "" {
if s != "" {
return nil, errors.Newf(token.NoPos, "empty file name in %q", s)
}
return nil, errors.Newf(token.NoPos, "empty file name")
}
return ParseFileAndType(file, scope, mode)
}
// ParseFileAndType parses a file and type combo.
func ParseFileAndType(file, scope string, mode Mode) (*build.File, error) {
// Quickly discard files which we aren't interested in.
// These cases are very common when loading `./...` in a large repository.
typesInit()
if scope == "" && file != "-" {
ext := fileExt(file)
if ext == "" {
return nil, errors.Newf(token.NoPos, "no encoding specified for file %q", file)
}
f, ok := fileForExt[ext]
if !ok {
return nil, errors.Newf(token.NoPos, "unknown file extension %s", ext)
}
if mode == Input {
f1 := *f
f1.Filename = file
return &f1, nil
}
}
modeVal, fileVal, err := parseType(scope, mode)
if err != nil {
return nil, err
}
return toFile(modeVal, fileVal, file)
}
func hasEncoding(v cue.Value) bool {
enc := v.LookupPath(cue.MakePath(cue.Str("encoding")))
d, _ := enc.Default()
return d.IsConcrete()
}
func toFile(modeVal, fileVal cue.Value, filename string) (*build.File, error) {
if !hasEncoding(fileVal) {
if filename == "-" {
fileVal = fileVal.Unify(modeVal.LookupPath(cue.MakePath(cue.Str("Default"))))
} else if ext := fileExt(filename); ext != "" {
extFile := modeVal.LookupPath(cue.MakePath(cue.Str("extensions"), cue.Str(ext)))
fileVal = fileVal.Unify(extFile)
if err := fileVal.Err(); err != nil {
return nil, errors.Newf(token.NoPos, "unknown file extension %s", ext)
}
} else {
return nil, errors.Newf(token.NoPos, "no encoding specified for file %q", filename)
}
}
// Note that the filename is only filled in the Go value, and not the CUE value.
// This makes no difference to the logic, but saves a non-trivial amount of evaluator work.
f := &build.File{Filename: filename}
if err := fileVal.Decode(&f); err != nil {
return nil, errors.Wrapf(err, token.NoPos,
"could not determine file type")
}
return f, nil
}
func parseType(scope string, mode Mode) (modeVal, fileVal cue.Value, _ error) {
modeVal = typesValue.LookupPath(cue.MakePath(cue.Str("modes"), cue.Str(mode.String())))
fileVal = modeVal.LookupPath(cue.MakePath(cue.Str("FileInfo")))
if scope == "" {
return modeVal, fileVal, nil
}
var otherTags []string
for _, tag := range strings.Split(scope, "+") {
tagName, _, ok := strings.Cut(tag, "=")
if ok {
otherTags = append(otherTags, tag)
} else {
info := typesValue.LookupPath(cue.MakePath(cue.Str("tagInfo"), cue.Str(tagName)))
if info.Exists() {
fileVal = fileVal.Unify(info)
} else {
// The tag might only be available when all the
// other tags have been evaluated.
otherTags = append(otherTags, tag)
}
}
}
if len(otherTags) == 0 {
return modeVal, fileVal, nil
}
// There are tags that aren't mentioned in tagInfo.
// They might still be valid, but just only valid within the file types that
// have been specified above, so look at the schema that we've got
// and see if it specifies any tags.
allowedTags := fileVal.LookupPath(cue.MakePath(cue.Str("tags")))
allowedBoolTags := fileVal.LookupPath(cue.MakePath(cue.Str("boolTags")))
for _, tag := range otherTags {
tagName, tagVal, hasValue := strings.Cut(tag, "=")
tagNamePath := cue.MakePath(cue.Str(tagName)).Optional()
tagSchema := allowedTags.LookupPath(tagNamePath)
if tagSchema.Exists() {
fileVal = fileVal.FillPath(cue.MakePath(cue.Str("tags"), cue.Str(tagName)), tagVal)
continue
}
if !allowedBoolTags.LookupPath(tagNamePath).Exists() {
return cue.Value{}, cue.Value{}, errors.Newf(token.NoPos, "unknown filetype %s", tagName)
}
tagValBool := true
if hasValue {
// It's a boolean tag and an explicit value has been specified.
// Allow the usual boolean string values.
t, err := strconv.ParseBool(tagVal)
if err != nil {
return cue.Value{}, cue.Value{}, fmt.Errorf("invalid boolean value for tag %q", tagName)
}
tagValBool = t
}
fileVal = fileVal.FillPath(cue.MakePath(cue.Str("boolTags"), cue.Str(tagName)), tagValBool)
}
return modeVal, fileVal, nil
}
// fileExt is like filepath.Ext except we don't treat file names starting with "." as having an extension
// unless there's also another . in the name.
func fileExt(f string) string {
e := filepath.Ext(f)
if e == "" || e == filepath.Base(f) {
return ""
}
return e
}
|