Files
mgmt/lang/lang_test.go
James Shubin 790b7199ca lang: New function engine
This mega patch primarily introduces a new function engine. The main
reasons for this new engine are:

1) Massively improved performance with lock-contended graphs.

Certain large function graphs could have very high lock-contention which
turned out to be much slower than I would have liked. This new algorithm
happens to be basically lock-free, so that's another helpful
improvement.

2) Glitch-free function graphs.

The function graphs could "glitch" (an FRP term) which could be
undesirable in theory. In practice this was never really an issue, and
I've not explicitly guaranteed that the new graphs are provably
glitch-free, but in practice things are a lot more consistent.

3) Simpler graph shape.

The new graphs don't require the private channels. This makes
understanding the graphs a lot easier.

4) Branched graphs only run half.

Previously we would run two pure side of an if statement, and while this
was mostly meant as an early experiment, it stayed in for far too long
and now was the right time to remove this. This also means our graphs
are much smaller and more efficient too.

Note that this changed the function API slightly. Everything has been
ported. It's possible that we introduce a new API in the future, but it
is unexpected to cause removal of the two current APIs.

In addition, we finally split out the "schedule" aspect from
world.schedule(). The "pick me" aspects now happen in a separate
resource, rather than as a yucky side-effect in the function. This also
lets us more precisely choose when we're scheduled, and we can observe
without being chosen too.

As usual many thanks to Sam for helping through some of the algorithmic
graph shape issues!
2025-09-11 23:19:45 -04:00

1113 lines
26 KiB
Go

// Mgmt
// Copyright (C) James Shubin and the project contributors
// Written by James Shubin <james@shubin.ca> and the project contributors
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
//
// Additional permission under GNU GPL version 3 section 7
//
// If you modify this program, or any covered work, by linking or combining it
// with embedded mcl code and modules (and that the embedded mcl code and
// modules which link with this program, contain a copy of their source code in
// the authoritative form) containing parts covered by the terms of any other
// license, the licensors of this program grant you additional permission to
// convey the resulting work. Furthermore, the licensors of this program grant
// the original author, James Shubin, additional permission to update this
// additional permission if he deems it necessary to achieve the goals of this
// additional permission.
//go:build !root
package lang
import (
"context"
"fmt"
"sync"
"testing"
"github.com/purpleidea/mgmt/engine"
"github.com/purpleidea/mgmt/engine/resources"
_ "github.com/purpleidea/mgmt/lang/core" // import so the funcs register
"github.com/purpleidea/mgmt/lang/inputs"
"github.com/purpleidea/mgmt/lang/interfaces"
"github.com/purpleidea/mgmt/pgraph"
"github.com/purpleidea/mgmt/util"
"github.com/purpleidea/mgmt/util/errwrap"
"github.com/spf13/afero"
)
// TODO: unify with the other function like this...
// TODO: where should we put our test helpers?
func runGraphCmp(t *testing.T, g1, g2 *pgraph.Graph) {
err := g1.GraphCmp(g2, vertexCmpFn, edgeCmpFn)
if err != nil {
t.Logf(" actual (g1): %v%s", g1, fullPrint(g1))
t.Logf("expected (g2): %v%s", g2, fullPrint(g2))
t.Errorf("cmp error:\n%v", err)
}
}
// TODO: unify with the other function like this...
func fullPrint(g *pgraph.Graph) (str string) {
if g == nil {
return "<nil>"
}
str += "\n"
for v := range g.Adjacency() {
str += fmt.Sprintf("* v: %s\n", v)
}
for v1 := range g.Adjacency() {
for v2, e := range g.Adjacency()[v1] {
str += fmt.Sprintf("* e: %s -> %s # %s\n", v1, v2, e)
}
}
return
}
func vertexCmpFn(v1, v2 pgraph.Vertex) (bool, error) {
if v1.String() == "" || v2.String() == "" {
return false, fmt.Errorf("oops, empty vertex")
}
r1, r2 := v1.(engine.Res), v2.(engine.Res)
if err := r1.Cmp(r2); err != nil {
//fmt.Printf("r1: %+v\n", *(r1.(*resources.TestRes).Int64Ptr))
//fmt.Printf("r2: %+v\n", *(r2.(*resources.TestRes).Int64Ptr))
return false, nil
}
m1, m2 := r1.MetaParams(), r2.MetaParams()
if err := m1.Cmp(m2); err != nil {
return false, nil
}
return v1.String() == v2.String(), nil
}
func edgeCmpFn(e1, e2 pgraph.Edge) (bool, error) {
if e1.String() == "" || e2.String() == "" {
return false, fmt.Errorf("oops, empty edge")
}
return e1.String() == e2.String(), nil
}
func runInterpret(t *testing.T, code string) (_ *pgraph.Graph, reterr error) {
logf := func(format string, v ...interface{}) {
t.Logf("test: lang: "+format, v...)
}
mmFs := afero.NewMemMapFs()
afs := &afero.Afero{Fs: mmFs} // wrap so that we're implementing ioutil
fs := &util.AferoFs{Afero: afs}
output, err := inputs.ParseInput(code, fs) // raw code can be passed in
if err != nil {
return nil, errwrap.Wrapf(err, "ParseInput failed")
}
for _, fn := range output.Workers {
if err := fn(fs); err != nil {
return nil, err
}
}
tree, err := util.FsTree(fs, "/")
if err != nil {
return nil, err
}
logf("tree:\n%s", tree)
wg := &sync.WaitGroup{}
defer wg.Wait()
ctx, cancel := context.WithCancel(context.Background()) // TODO: get it from parent
defer cancel()
lang := &Lang{
Fs: fs,
Input: "/" + interfaces.MetadataFilename, // start path in fs
Data: &Data{
UnificationStrategy: make(map[string]string), // empty
},
Debug: testing.Verbose(), // set via the -test.v flag to `go test`
Logf: logf,
}
if err := lang.Init(ctx); err != nil {
return nil, errwrap.Wrapf(err, "init failed")
}
defer lang.Cleanup()
wg.Add(1)
go func() {
defer wg.Done()
if err := lang.Run(ctx); err != nil && err != context.Canceled {
reterr = errwrap.Append(reterr, err)
}
}()
defer cancel() // shutdown the Run
// we only wait for the first event, instead of the continuous stream
var graph *pgraph.Graph
var ok bool
select {
case graph, ok = <-lang.Stream(ctx):
if !ok {
return nil, fmt.Errorf("stream closed without event")
}
}
return graph, nil
}
// TODO: empty code is not currently allowed, should we allow it?
//func TestInterpret0(t *testing.T) {
// code := ``
// graph, err := runInterpret(t, code)
// if err != nil {
// t.Errorf("runInterpret failed: %+v", err)
// return
// }
// expected := &pgraph.Graph{}
// runGraphCmp(t, graph, expected)
//}
func TestInterpret1(t *testing.T) {
code := `noop "n1" {}`
graph, err := runInterpret(t, code)
if err != nil {
t.Errorf("runInterpret failed: %+v", err)
return
}
n1, _ := engine.NewNamedResource("noop", "n1")
expected := &pgraph.Graph{}
expected.AddVertex(n1)
runGraphCmp(t, graph, expected)
}
func TestInterpret2(t *testing.T) {
code := `
noop "n1" {}
noop "n2" {}
`
graph, err := runInterpret(t, code)
if err != nil {
t.Errorf("runInterpret failed: %+v", err)
return
}
n1, _ := engine.NewNamedResource("noop", "n1")
n2, _ := engine.NewNamedResource("noop", "n2")
expected := &pgraph.Graph{}
expected.AddVertex(n1)
expected.AddVertex(n2)
runGraphCmp(t, graph, expected)
}
func TestInterpret3(t *testing.T) {
// should overflow int8
code := `
test "t1" {
int8 => 88888888,
}
`
_, err := runInterpret(t, code)
if err == nil {
t.Errorf("expected overflow failure, but it passed")
}
}
func TestInterpret4(t *testing.T) {
// str => " !#$%&'()*+,-./0123456790:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_abcdefghijklmnopqrstuvwxyz{|}~",
code := `
# comment 1
test "t1" { # comment 2
stringptr => " !\"#$%&'()*+,-./0123456790:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_abcdefghijklmnopqrstuvwxyz{|}~",
int64 => 42,
boolptr => true,
# comment 3
int8ptr => 99, # comment 5
comment => "☺\thello\nwo\"rld\\2", # must escape these
}
`
graph, err := runInterpret(t, code)
if err != nil {
t.Errorf("runInterpret failed: %+v", err)
return
}
t1, _ := engine.NewNamedResource("test", "t1")
x := t1.(*resources.TestRes)
str := " !\"#$%&'()*+,-./0123456790:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_abcdefghijklmnopqrstuvwxyz{|}~"
x.StringPtr = &str
x.Int64 = 42
b := true
x.BoolPtr = &b
int8ptr := int8(99)
x.Int8Ptr = &int8ptr
x.Comment = "☺\thello\nwo\"rld\\2" // must escape the escaped chars
expected := &pgraph.Graph{}
expected.AddVertex(x)
runGraphCmp(t, graph, expected)
}
func TestInterpret5(t *testing.T) {
code := `
if true {
test "t1" {
int64 => 42,
stringptr => "hello!",
}
}
`
graph, err := runInterpret(t, code)
if err != nil {
t.Errorf("runInterpret failed: %+v", err)
return
}
t1, _ := engine.NewNamedResource("test", "t1")
x := t1.(*resources.TestRes)
x.Int64 = 42
str := "hello!"
x.StringPtr = &str
expected := &pgraph.Graph{}
expected.AddVertex(x)
runGraphCmp(t, graph, expected)
}
func TestInterpret6(t *testing.T) {
code := `
$b = true
if $b {
test "t1" {
int64 => 42,
stringptr => "hello",
}
}
if $b {
test "t2" {
int64 => 13,
stringptr => "world",
}
}
`
graph, err := runInterpret(t, code)
if err != nil {
t.Errorf("runInterpret failed: %+v", err)
return
}
expected := &pgraph.Graph{}
{
r, _ := engine.NewNamedResource("test", "t1")
x := r.(*resources.TestRes)
x.Int64 = 42
str := "hello"
x.StringPtr = &str
expected.AddVertex(x)
}
{
r, _ := engine.NewNamedResource("test", "t2")
x := r.(*resources.TestRes)
x.Int64 = 13
str := "world"
x.StringPtr = &str
expected.AddVertex(x)
}
runGraphCmp(t, graph, expected)
}
func TestInterpretMany(t *testing.T) {
type test struct { // an individual test
name string
code string
fail bool
graph *pgraph.Graph
}
testCases := []test{}
// TODO: empty code is not currently allowed, should we allow it?
//{
// graph, _ := pgraph.NewGraph("g")
// testCases = append(testCases, test{ // 0
// "nil",
// ``,
// false,
// graph,
// })
//}
//{
// graph, _ := pgraph.NewGraph("g")
// testCases = append(testCases, test{ // 1
// name: "empty",
// code: ``,
// fail: false,
// graph: graph,
// })
//}
{
graph, _ := pgraph.NewGraph("g")
r, _ := engine.NewNamedResource("test", "t")
x := r.(*resources.TestRes)
i := int64(42 + 13)
x.Int64Ptr = &i
graph.AddVertex(x)
testCases = append(testCases, test{
name: "simple addition",
code: `
test "t" {
int64ptr => 42 + 13,
}
`,
fail: false,
graph: graph,
})
}
{
graph, _ := pgraph.NewGraph("g")
r, _ := engine.NewNamedResource("test", "t")
x := r.(*resources.TestRes)
i := int64(42 + 13 + 99)
x.Int64Ptr = &i
graph.AddVertex(x)
testCases = append(testCases, test{
name: "triple addition",
code: `
test "t" {
int64ptr => 42 + 13 + 99,
}
`,
fail: false,
graph: graph,
})
}
{
graph, _ := pgraph.NewGraph("g")
r, _ := engine.NewNamedResource("test", "t")
x := r.(*resources.TestRes)
i := int64(42 + 13 - 99)
x.Int64Ptr = &i
graph.AddVertex(x)
testCases = append(testCases, test{
name: "triple addition/subtraction",
code: `
test "t" {
int64ptr => 42 + 13 - 99,
}
`,
fail: false,
graph: graph,
})
}
{
graph, _ := pgraph.NewGraph("g")
r1, _ := engine.NewNamedResource("test", "t1")
x1 := r1.(*resources.TestRes)
s1 := "hello"
x1.StringPtr = &s1
graph.AddVertex(x1)
testCases = append(testCases, test{
name: "single include",
code: `
class c1($a, $b) {
test $a {
stringptr => $b,
}
}
include c1("t1", "hello")
`,
fail: false,
graph: graph,
})
}
{
graph, _ := pgraph.NewGraph("g")
r1, _ := engine.NewNamedResource("test", "t1")
r2, _ := engine.NewNamedResource("test", "t2")
x1 := r1.(*resources.TestRes)
x2 := r2.(*resources.TestRes)
s1, s2 := "hello", "world"
x1.StringPtr = &s1
x2.StringPtr = &s2
graph.AddVertex(x1, x2)
testCases = append(testCases, test{
name: "double include",
code: `
class c1($a, $b) {
test $a {
stringptr => $b,
}
}
include c1("t1", "hello")
include c1("t2", "world")
`,
fail: false,
graph: graph,
})
}
{
//graph, _ := pgraph.NewGraph("g")
//r1, _ := engine.NewNamedResource("test", "t1")
//r2, _ := engine.NewNamedResource("test", "t2")
//x1 := r1.(*resources.TestRes)
//x2 := r2.(*resources.TestRes)
//s1, i2 := "hello", int64(42)
//x1.StringPtr = &s1
//x2.Int64Ptr = &i2
//graph.AddVertex(x1, x2)
testCases = append(testCases, test{
name: "double include different types error",
code: `
class c1($a, $b) {
if $a == "t1" {
test $a {
stringptr => $b,
}
} else {
test $a {
int64ptr => $b,
}
}
}
include c1("t1", "hello")
include c1("t2", 42)
`,
fail: true, // should not be able to type check this!
//graph: graph,
})
}
{
graph, _ := pgraph.NewGraph("g")
r1, _ := engine.NewNamedResource("test", "t1")
r2, _ := engine.NewNamedResource("test", "t2")
x1 := r1.(*resources.TestRes)
x2 := r2.(*resources.TestRes)
s1, s2 := "testing", "testing"
x1.StringPtr = &s1
x2.StringPtr = &s2
graph.AddVertex(x1, x2)
testCases = append(testCases, test{
name: "double include different types allowed",
code: `
class c1($a, $b) {
if $b == $b { # for example purposes
test $a {
stringptr => "testing",
}
}
}
include c1("t1", "hello")
include c1("t2", 42) # this has a different sig
`,
fail: false,
graph: graph,
})
}
// TODO: add this test once printf supports %v
//{
// graph, _ := pgraph.NewGraph("g")
// r1, _ := engine.NewNamedResource("test", "t1")
// r2, _ := engine.NewNamedResource("test", "t2")
// x1 := r1.(*resources.TestRes)
// x2 := r2.(*resources.TestRes)
// s1, s2 := "value is: hello", "value is: 42"
// x1.StringPtr = &s1
// x2.StringPtr = &s2
// graph.AddVertex(x1, x2)
// testCases = append(testCases, test{
// name: "double include different printf types allowed",
// code: `
// import "fmt"
// class c1($a, $b) {
// test $a {
// stringptr => fmt.printf("value is: %v", $b),
// }
// }
// include c1("t1", "hello")
// include c1("t2", 42)
// `,
// fail: false,
// graph: graph,
// })
//}
{
graph, _ := pgraph.NewGraph("g")
r1, _ := engine.NewNamedResource("test", "t1")
r2, _ := engine.NewNamedResource("test", "t2")
x1 := r1.(*resources.TestRes)
x2 := r2.(*resources.TestRes)
s1, s2 := "hey", "hey"
x1.StringPtr = &s1
x2.StringPtr = &s2
graph.AddVertex(x1, x2)
testCases = append(testCases, test{
name: "double include with variable in parent scope",
code: `
$foo = "hey"
class c1($a) {
test $a {
stringptr => $foo,
}
}
include c1("t1")
include c1("t2")
`,
fail: false,
graph: graph,
})
}
{
graph, _ := pgraph.NewGraph("g")
r1, _ := engine.NewNamedResource("test", "t1")
r2, _ := engine.NewNamedResource("test", "t2")
x1 := r1.(*resources.TestRes)
x2 := r2.(*resources.TestRes)
s1, s2 := "hey", "hey"
x1.StringPtr = &s1
x2.StringPtr = &s2
graph.AddVertex(x1, x2)
testCases = append(testCases, test{
name: "double include with out of order variable in parent scope",
code: `
include c1("t1")
include c1("t2")
class c1($a) {
test $a {
stringptr => $foo,
}
}
$foo = "hey"
`,
fail: false,
graph: graph,
})
}
{
graph, _ := pgraph.NewGraph("g")
r1, _ := engine.NewNamedResource("test", "hey1")
r2, _ := engine.NewNamedResource("test", "hey2")
x1 := r1.(*resources.TestRes)
x2 := r2.(*resources.TestRes)
s1, s2 := "hey", "hey"
x1.StringPtr = &s1
x2.StringPtr = &s2
graph.AddVertex(x1, x2)
testCases = append(testCases, test{
name: "double include with out of order variable in parent scope and scoped var",
code: `
include c1($foo + "1")
include c1($foo + "2")
class c1($a) {
test "${a}" {
stringptr => $foo,
}
}
$foo = "hey"
`,
fail: false,
graph: graph,
})
}
{
graph, _ := pgraph.NewGraph("g")
r1, _ := engine.NewNamedResource("test", "t1")
x1 := r1.(*resources.TestRes)
s1 := "hello"
x1.StringPtr = &s1
graph.AddVertex(x1)
testCases = append(testCases, test{
name: "duplicate include identical",
code: `
include c1("t1", "hello")
class c1($a, $b) {
test $a {
stringptr => $b,
}
}
include c1("t1", "hello") # this is an identical dupe
`,
fail: false,
graph: graph,
})
}
{
graph, _ := pgraph.NewGraph("g")
r1, _ := engine.NewNamedResource("test", "t1")
x1 := r1.(*resources.TestRes)
s1 := "hello"
x1.StringPtr = &s1
graph.AddVertex(x1)
testCases = append(testCases, test{
name: "duplicate include non-identical",
code: `
include c1("t1", "hello")
class c1($a, $b) {
if $a == "t1" {
test $a {
stringptr => $b,
}
} else {
test "t1" {
stringptr => $b,
}
}
}
include c1("t?", "hello") # should cause an identical dupe
`,
fail: false,
graph: graph,
})
}
{
testCases = append(testCases, test{
name: "duplicate include incompatible",
code: `
include c1("t1", "hello")
class c1($a, $b) {
test $a {
stringptr => $b,
}
}
include c1("t1", "world") # incompatible
`,
fail: true, // incompatible resources
})
}
{
testCases = append(testCases, test{
name: "class wrong number of args 1",
code: `
include c1("hello") # missing second arg
class c1($a, $b) {
test $a {
stringptr => $b,
}
}
`,
fail: true, // but should NOT panic
})
}
{
testCases = append(testCases, test{
name: "class wrong number of args 2",
code: `
include c1("hello", 42) # added second arg
class c1($a) {
test $a {
stringptr => "world",
}
}
`,
fail: true, // but should NOT panic
})
}
{
graph, _ := pgraph.NewGraph("g")
r1, _ := engine.NewNamedResource("test", "t1")
r2, _ := engine.NewNamedResource("test", "t2")
x1 := r1.(*resources.TestRes)
x2 := r2.(*resources.TestRes)
s1, s2 := "hello is 42", "world is 13"
x1.StringPtr = &s1
x2.StringPtr = &s2
graph.AddVertex(x1, x2)
testCases = append(testCases, test{
name: "nested classes 1",
code: `
import "fmt"
include c1("t1", "hello") # test["t1"] -> hello is 42
include c1("t2", "world") # test["t2"] -> world is 13
class c1($a, $b) {
# nested class definition
class c2($c) {
test $a {
stringptr => fmt.printf("%s is %d", $b, $c),
}
}
if $a == "t1" {
include c2(42)
} else {
include c2(13)
}
}
`,
fail: false,
graph: graph,
})
}
{
testCases = append(testCases, test{
name: "nested classes out of scope 1",
code: `
import "fmt"
include c1("t1", "hello") # test["t1"] -> hello is 42
include c2(99) # out of scope
class c1($a, $b) {
# nested class definition
class c2($c) {
test $a {
stringptr => fmt.printf("%s is %d", $b, $c),
}
}
if $a == "t1" {
include c2(42)
} else {
include c2(13)
}
}
`,
fail: true,
})
}
// TODO: recursive classes are not currently supported (should they be?)
//{
// graph, _ := pgraph.NewGraph("g")
// testCases = append(testCases, test{
// name: "recursive classes 0",
// code: `
// include c1(0) # start at zero
// class c1($count) {
// if $count != 3 {
// include c1($count + 1)
// }
// }
// `,
// fail: false,
// graph: graph, // produces no output
// })
//}
// TODO: recursive classes are not currently supported (should they be?)
//{
// graph, _ := pgraph.NewGraph("g")
// r0, _ := engine.NewNamedResource("test", "done")
// x0 := r0.(*resources.TestRes)
// s0 := "count is 3"
// x0.StringPtr = &s0
// graph.AddVertex(x0)
// testCases = append(testCases, test{
// name: "recursive classes 1",
// code: `
// import "fmt"
// $max = 3
// include c1(0) # start at zero
// # test["done"] -> count is 3
// class c1($count) {
// if $count == $max {
// test "done" {
// stringptr => fmt.printf("count is %d", $count),
// }
// } else {
// include c1($count + 1)
// }
// }
// `,
// fail: false,
// graph: graph,
// })
//}
// TODO: recursive classes are not currently supported (should they be?)
//{
// graph, _ := pgraph.NewGraph("g")
// r0, _ := engine.NewNamedResource("test", "zero")
// r1, _ := engine.NewNamedResource("test", "ix:1")
// r2, _ := engine.NewNamedResource("test", "ix:2")
// r3, _ := engine.NewNamedResource("test", "ix:3")
// x0 := r0.(*resources.TestRes)
// x1 := r1.(*resources.TestRes)
// x2 := r2.(*resources.TestRes)
// x3 := r3.(*resources.TestRes)
// s0, s1, s2, s3 := "count is 0", "count is 1", "count is 2", "count is 3"
// x0.StringPtr = &s0
// x1.StringPtr = &s1
// x2.StringPtr = &s2
// x3.StringPtr = &s3
// graph.AddVertex(x0, x1, x2, x3)
// testCases = append(testCases, test{
// name: "recursive classes 2",
// code: `
// import "fmt"
// include c1("ix", 3)
// # test["ix:3"] -> count is 3
// # test["ix:2"] -> count is 2
// # test["ix:1"] -> count is 1
// # test["zero"] -> count is 0
// class c1($name, $count) {
// if $count == 0 {
// test "zero" {
// stringptr => fmt.printf("count is %d", $count),
// }
// } else {
// include c1($name, $count - 1)
// test "${name}:${count}" {
// stringptr => fmt.printf("count is %d", $count),
// }
// }
// }
// `,
// fail: false,
// graph: graph,
// })
//}
// TODO: remove this test if we ever support recursive classes
{
testCases = append(testCases, test{
name: "recursive classes fail 1",
code: `
import "fmt"
$max = 3
include c1(0) # start at zero
class c1($count) {
if $count == $max {
test "done" {
stringptr => fmt.printf("count is %d", $count),
}
} else {
include c1($count + 1) # recursion not supported atm
}
}
`,
fail: true,
})
}
// TODO: remove this test if we ever support recursive classes
{
testCases = append(testCases, test{
name: "recursive classes fail 2",
code: `
import "fmt"
$max = 5
include c1(0) # start at zero
class c1($count) {
if $count == $max {
test "done" {
stringptr => fmt.printf("count is %d", $count),
}
} else {
include c2($count + 1) # recursion not supported atm
}
}
class c2($count) {
if $count == $max {
test "done" {
stringptr => fmt.printf("count is %d", $count),
}
} else {
include c1($count + 1) # recursion not supported atm
}
}
`,
fail: true,
})
}
{
graph, _ := pgraph.NewGraph("g")
r1, _ := engine.NewNamedResource("test", "t1")
x1 := r1.(*resources.TestRes)
s1 := "the answer is: 42"
x1.StringPtr = &s1
graph.AddVertex(x1)
testCases = append(testCases, test{
name: "simple import 1",
code: `
import "fmt"
test "t1" {
stringptr => fmt.printf("the answer is: %d", 42),
}
`,
fail: false,
graph: graph,
})
}
{
graph, _ := pgraph.NewGraph("g")
r1, _ := engine.NewNamedResource("test", "t1")
x1 := r1.(*resources.TestRes)
s1 := "the answer is: 42"
x1.StringPtr = &s1
graph.AddVertex(x1)
testCases = append(testCases, test{
name: "simple import 2",
code: `
import "fmt" as foo
test "t1" {
stringptr => foo.printf("the answer is: %d", 42),
}
`,
fail: false,
graph: graph,
})
}
{
graph, _ := pgraph.NewGraph("g")
r1, _ := engine.NewNamedResource("test", "t1")
x1 := r1.(*resources.TestRes)
s1 := "the answer is: 42"
x1.StringPtr = &s1
graph.AddVertex(x1)
testCases = append(testCases, test{
name: "simple import 3",
code: `
import "fmt" as *
test "t1" {
stringptr => printf("the answer is: %d", 42),
}
`,
fail: false,
graph: graph,
})
}
{
graph, _ := pgraph.NewGraph("g")
r1, _ := engine.NewNamedResource("pkg", "cowsay")
x1 := r1.(*resources.PkgRes)
x1.State = "newest"
graph.AddVertex(x1)
// this second vertex gets merged in because they're compatible
//r2, _ := engine.NewNamedResource("pkg", "cowsay")
//x2 := r2.(*resources.PkgRes)
//x2.State = "installed"
//graph.AddVertex(x2)
testCases = append(testCases, test{
name: "duplicate compatible pkg resource",
code: `
pkg "cowsay" {
state => "newest",
}
pkg "cowsay" {
state => "installed",
}
`,
fail: false,
graph: graph,
})
}
{
// this test ensures that edges are preserved appropriately when
// two or more compatible resources and merged together in graph
graph, _ := pgraph.NewGraph("g")
t1, _ := engine.NewNamedResource("test", "t1")
t2, _ := engine.NewNamedResource("test", "t2")
t3, _ := engine.NewNamedResource("test", "t3")
t4, _ := engine.NewNamedResource("test", "t4")
r1, _ := engine.NewNamedResource("pkg", "cowsay")
x1 := r1.(*resources.PkgRes)
x1.State = "newest"
graph.AddVertex(t1, t2, t3, t4, x1)
// this second vertex gets merged in because they're compatible
//r2, _ := engine.NewNamedResource("pkg", "cowsay")
//x2 := r2.(*resources.PkgRes)
//x2.State = "installed"
//graph.AddVertex(x2)
graph.AddEdge(x1, t1, &engine.Edge{Name: "pkg[cowsay] -> test[t1]"}) // cowsay -> t1
graph.AddEdge(t2, x1, &engine.Edge{Name: "test[t2] -> pkg[cowsay]"}) // t2 -> cowsay
graph.AddEdge(x1, t3, &engine.Edge{Name: "pkg[cowsay] -> test[t3]"}) // cowsay -> t3
graph.AddEdge(t4, x1, &engine.Edge{Name: "test[t4] -> pkg[cowsay]"}) // t4 -> cowsay
testCases = append(testCases, test{
name: "duplicate compatible pkg resource with edges",
code: `
test "t1" {}
test "t2" {}
test "t3" {}
test "t4" {}
pkg "cowsay" {
state => "newest",
Before => Test["t1"], # cowsay -> t1
Depend => Test["t2"], # t2 -> cowsay
}
pkg "cowsay" {
state => "installed",
Before => Test["t3"], # cowsay -> t3
Depend => Test["t4"], # t4 -> cowsay
}
`,
fail: false,
graph: graph,
})
}
names := []string{}
for index, tc := range testCases { // run all the tests
if tc.name == "" {
t.Errorf("test #%d: not named", index)
continue
}
if util.StrInList(tc.name, names) {
t.Errorf("test #%d: duplicate sub test name of: %s", index, tc.name)
continue
}
names = append(names, tc.name)
//if index != 3 { // hack to run a subset (useful for debugging)
//if tc.name != "nil" {
// continue
//}
t.Run(fmt.Sprintf("test #%d (%s)", index, tc.name), func(t *testing.T) {
name, code, fail, exp := tc.name, tc.code, tc.fail, tc.graph
t.Logf("\n\ntest #%d (%s) ----------------\n\n", index, name)
graph, err := runInterpret(t, code)
if !fail && err != nil {
t.Errorf("test #%d: FAIL", index)
t.Errorf("test #%d: runInterpret failed with: %+v", index, err)
return
}
if fail && err == nil {
t.Errorf("test #%d: FAIL", index)
t.Errorf("test #%d: runInterpret passed, expected fail", index)
return
}
if fail { // can't process graph if it's nil
return
}
t.Logf("test #%d: graph: %+v", index, graph)
// TODO: improve: https://github.com/purpleidea/mgmt/issues/199
if err := graph.GraphCmp(exp, vertexCmpFn, edgeCmpFn); err != nil {
t.Errorf("test #%d: FAIL", index)
t.Logf("test #%d: actual: %v%s", index, graph, fullPrint(graph))
t.Logf("test #%d: expected: %v%s", index, exp, fullPrint(exp))
t.Errorf("test #%d: cmp error:\n%v", index, err)
return
}
})
}
}