aboutsummaryrefslogtreecommitdiffstats
path: root/pkg/aflow/template.go
blob: 7dd213517e9c52c0eb2c41da91e17ab6d0203154 (plain)
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
// Copyright 2025 syzkaller project authors. All rights reserved.
// Use of this source code is governed by Apache 2 LICENSE that can be found in the LICENSE file.

package aflow

import (
	"bytes"
	"fmt"
	"io"
	"reflect"
	"strings"
	"text/template"
	"text/template/parse"
)

// formatTemplate formats template 'text' using the standard text/template logic.
// Panics on any errors, but these panics shouldn't happen if verifyTemplate
// was called for the template before.
func formatTemplate(text string, state map[string]any) string {
	templ, err := parseTemplate(text)
	if err != nil {
		panic(err)
	}
	w := new(bytes.Buffer)
	if err := templ.Execute(w, state); err != nil {
		panic(err)
	}
	return w.String()
}

// verifyTemplate checks that the template 'text' can be executed with the variables 'vars'.
// Returns the set of variables that are actually used in the template.
func verifyTemplate(text string, vars map[string]reflect.Type) (map[string]bool, error) {
	templ, err := parseTemplate(text)
	if err != nil {
		return nil, err
	}
	used := make(map[string]bool)
	walkTemplate(templ.Root, used, &err)
	if err != nil {
		return nil, err
	}
	vals := make(map[string]any)
	for name := range used {
		typ, ok := vars[name]
		if !ok {
			return nil, fmt.Errorf("input %v is not provided", name)
		}
		vals[name] = reflect.Zero(typ).Interface()
	}
	// Execute once just to make sure.
	if err := templ.Execute(io.Discard, vals); err != nil {
		return nil, err
	}
	return used, nil
}

// walkTemplate recursively walks template nodes collecting used variables.
// It does not handle all node types, but enough to support reasonably simple templates.
func walkTemplate(n parse.Node, used map[string]bool, errp *error) {
	if reflect.ValueOf(n).IsNil() {
		return
	}
	switch n := n.(type) {
	case *parse.ListNode:
		for _, c := range n.Nodes {
			walkTemplate(c, used, errp)
		}
	case *parse.IfNode:
		walkTemplate(n.Pipe, used, errp)
		walkTemplate(n.List, used, errp)
		walkTemplate(n.ElseList, used, errp)
	case *parse.RangeNode:
		walkTemplate(n.Pipe, used, errp)
		walkTemplate(n.List, used, errp)
		walkTemplate(n.ElseList, used, errp)
	case *parse.ActionNode:
		walkTemplate(n.Pipe, used, errp)
	case *parse.PipeNode:
		for _, c := range n.Decl {
			walkTemplate(c, used, errp)
		}
		for _, c := range n.Cmds {
			walkTemplate(c, used, errp)
		}
	case *parse.CommandNode:
		for _, c := range n.Args {
			walkTemplate(c, used, errp)
		}
	case *parse.FieldNode:
		if len(n.Ident) != 1 {
			noteError(errp, "compound values are not supported: .%v", strings.Join(n.Ident, "."))
		}
		used[n.Ident[0]] = true
	case *parse.VariableNode:
	case *parse.TextNode:
	default:
		noteError(errp, "unhandled node type %T", n)
	}
}

func parseTemplate(prompt string) (*template.Template, error) {
	return template.New("").Option("missingkey=error").Parse(prompt)
}