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
|
// 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 load
import (
"crypto/rand"
"encoding/hex"
"os"
"os/user"
"runtime"
"strings"
"sync"
"time"
"cuelang.org/go/cue"
"cuelang.org/go/cue/ast"
"cuelang.org/go/cue/build"
"cuelang.org/go/cue/errors"
"cuelang.org/go/cue/token"
"cuelang.org/go/internal"
"cuelang.org/go/internal/buildattr"
"cuelang.org/go/internal/cli"
)
type tagger struct {
cfg *Config
// tagMap holds true for all the tags in cfg.Tags that
// are not associated with a value.
tagMap map[string]bool
// tags keeps a record of all the @tag attibutes found in files.
tags []*tag // tags found in files
replacements map[ast.Node]ast.Node
// mu guards the usedTags map.
mu sync.Mutex
// usedTags keeps a record of all the tag attributes found in files.
usedTags map[string]bool
}
func newTagger(c *Config) *tagger {
tagMap := map[string]bool{}
for _, t := range c.Tags {
if !strings.ContainsRune(t, '=') {
tagMap[t] = true
}
}
return &tagger{
cfg: c,
tagMap: tagMap,
usedTags: make(map[string]bool),
}
}
// tagIsSet reports whether the tag with the given key
// is enabled. It also updates t.usedTags to
// reflect that the tag has been seen.
func (tg *tagger) tagIsSet(key string) bool {
tg.mu.Lock()
tg.usedTags[key] = true
tg.mu.Unlock()
return tg.tagMap[key]
}
// A TagVar represents an injection variable.
type TagVar struct {
// Func returns an ast for a tag variable. It is only called once
// per evaluation of a configuration.
Func func() (ast.Expr, error)
// Description documents this TagVar.
Description string
}
const rfc3339 = "2006-01-02T15:04:05.999999999Z"
// DefaultTagVars creates a new map with a set of supported injection variables.
func DefaultTagVars() map[string]TagVar {
return map[string]TagVar{
"now": {
Func: func() (ast.Expr, error) {
return ast.NewString(time.Now().UTC().Format(rfc3339)), nil
},
},
"os": {
Func: func() (ast.Expr, error) {
return ast.NewString(runtime.GOOS), nil
},
},
"arch": {
Func: func() (ast.Expr, error) {
return ast.NewString(runtime.GOARCH), nil
},
},
"cwd": {
Func: func() (ast.Expr, error) {
return varToString(os.Getwd())
},
},
"username": {
Func: func() (ast.Expr, error) {
u, err := user.Current()
if err != nil {
return nil, err
}
return ast.NewString(u.Username), nil
},
},
"hostname": {
Func: func() (ast.Expr, error) {
return varToString(os.Hostname())
},
},
"rand": {
Func: func() (ast.Expr, error) {
var b [16]byte
_, err := rand.Read(b[:])
if err != nil {
return nil, err
}
var hx [34]byte
hx[0] = '0'
hx[1] = 'x'
hex.Encode(hx[2:], b[:])
return ast.NewLit(token.INT, string(hx[:])), nil
},
},
}
}
func varToString(s string, err error) (ast.Expr, error) {
if err != nil {
return nil, err
}
x := ast.NewString(s)
return x, nil
}
// A tag binds an identifier to a field to allow passing command-line values.
//
// A tag is of the form
//
// @tag(<name>,[type=(string|int|number|bool)][,short=<shorthand>+])
//
// The name is mandatory and type defaults to string. Tags are set using the -t
// option on the command line. -t name=value will parse value for the type
// defined for name and set the field for which this tag was defined to this
// value. A tag may be associated with multiple fields.
//
// Tags also allow shorthands. If a shorthand bar is declared for a tag with
// name foo, then -t bar is identical to -t foo=bar.
//
// It is a deliberate choice to not allow other values to be associated with
// shorthands than the shorthand name itself. Doing so would create a powerful
// mechanism that would assign different values to different fields based on the
// same shorthand, duplicating functionality that is already available in CUE.
type tag struct {
key string
kind cue.Kind
shorthands []string
vars string // -T flag
hasReplacement bool
field *ast.Field
}
func parseTag(pos token.Pos, body string) (t *tag, err errors.Error) {
t = &tag{}
t.kind = cue.StringKind
a := internal.ParseAttrBody(pos, body)
t.key, _ = a.String(0)
if !ast.IsValidIdent(t.key) {
return t, errors.Newf(pos, "invalid identifier %q", t.key)
}
if s, ok, _ := a.Lookup(1, "type"); ok {
switch s {
case "string":
case "int":
t.kind = cue.IntKind
case "number":
t.kind = cue.NumberKind
case "bool":
t.kind = cue.BoolKind
default:
return t, errors.Newf(pos, "invalid type %q", s)
}
}
if s, ok, _ := a.Lookup(1, "short"); ok {
for _, s := range strings.Split(s, "|") {
if !ast.IsValidIdent(t.key) {
return t, errors.Newf(pos, "invalid identifier %q", s)
}
t.shorthands = append(t.shorthands, s)
}
}
if s, ok, _ := a.Lookup(1, "var"); ok {
t.vars = s
}
return t, nil
}
func (t *tag) inject(value string, tg *tagger) errors.Error {
e, err := cli.ParseValue(token.NoPos, t.key, value, t.kind)
t.injectValue(e, tg)
return err
}
func (t *tag) injectValue(x ast.Expr, tg *tagger) {
injected := ast.NewBinExpr(token.AND, t.field.Value, x)
if tg.replacements == nil {
tg.replacements = make(map[ast.Node]ast.Node)
}
tg.replacements[t.field.Value] = injected
t.field.Value = injected
t.hasReplacement = true
}
// findTags defines which fields may be associated with tags.
//
// TODO: should we limit the depth at which tags may occur?
func findTags(b *build.Instance) (tags []*tag, errs errors.Error) {
findInvalidTags := func(x ast.Node, msg string) {
ast.Walk(x, nil, func(n ast.Node) {
if f, ok := n.(*ast.Field); ok {
for _, a := range f.Attrs {
if key, _ := a.Split(); key == "tag" {
errs = errors.Append(errs, errors.Newf(a.Pos(), "%s", msg))
// TODO: add position of x.
}
}
}
})
}
for _, f := range b.Files {
ast.Walk(f, func(n ast.Node) bool {
switch x := n.(type) {
case *ast.ListLit:
findInvalidTags(n, "@tag not allowed within lists")
return false
case *ast.Comprehension:
findInvalidTags(n, "@tag not allowed within comprehension")
return false
case *ast.Field:
// TODO: allow optional fields?
_, _, err := ast.LabelName(x.Label)
_, ok := internal.ConstraintToken(x)
if err != nil || ok {
findInvalidTags(n, "@tag not allowed within field constraint")
return false
}
for _, a := range x.Attrs {
key, body := a.Split()
if key != "tag" {
continue
}
t, err := parseTag(a.Pos(), body)
if err != nil {
errs = errors.Append(errs, err)
continue
}
t.field = x
tags = append(tags, t)
}
}
return true
}, nil)
}
return tags, errs
}
func (tg *tagger) injectTags(tags []string) errors.Error {
// Parses command line args
for _, s := range tags {
name, val, ok := strings.Cut(s, "=")
found := tg.usedTags[s]
if ok { // key-value
for _, t := range tg.tags {
if t.key == name {
found = true
if err := t.inject(val, tg); err != nil {
return err
}
}
}
if !found {
return errors.Newf(token.NoPos, "no tag for %q", name)
}
} else { // shorthand
for _, t := range tg.tags {
for _, sh := range t.shorthands {
if sh == s {
found = true
if err := t.inject(s, tg); err != nil {
return err
}
}
}
}
if !found {
return errors.Newf(token.NoPos, "tag %q not used in any file", s)
}
}
}
if tg.cfg.TagVars != nil {
vars := map[string]ast.Expr{}
// Inject tag variables if the tag wasn't already set.
for _, t := range tg.tags {
if t.hasReplacement || t.vars == "" {
continue
}
x, ok := vars[t.vars]
if !ok {
tv, ok := tg.cfg.TagVars[t.vars]
if !ok {
return errors.Newf(token.NoPos,
"tag variable '%s' not found", t.vars)
}
tag, err := tv.Func()
if err != nil {
return errors.Wrapf(err, token.NoPos,
"error getting tag variable '%s'", t.vars)
}
x = tag
vars[t.vars] = tag
}
if x != nil {
t.injectValue(x, tg)
}
}
}
return nil
}
func shouldBuildFile(f *ast.File, tagIsSet func(key string) bool) errors.Error {
ok, attr, err := buildattr.ShouldBuildFile(f, tagIsSet)
if err != nil {
return err
}
if ok {
return nil
}
if key, body := attr.Split(); key == "if" {
return excludeError{errors.Newf(attr.Pos(), "@if(%s) did not match", body)}
} else {
return excludeError{errors.Newf(attr.Pos(), "@ignore() attribute found")}
}
}
|