Files
mgmt/lang/interpolate/interpolate_test.go
James Shubin 3e31ee9455 legal: Additional permission under GNU GPL version 3 section 7
With the recent merging of embedded package imports and the entry CLI
package, it is now possible for users to build in mcl code into a single
binary. This additional permission makes it explicitly clear that this
is permitted to make it easier for those users. The condition is phrased
so that the terms can be "patched" by the original author if it's
necessary for the project. For example, if the name of the language
(mcl) changes, has a differently named new version, someone finds a
phrasing improvement or a legal loophole, or for some other
reasonable circumstance. Now go write some beautiful embedded tools!
2024-03-05 01:04:09 -05:00

833 lines
18 KiB
Go

// Mgmt
// Copyright (C) 2013-2024+ 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 <http://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 interpolate
import (
"fmt"
"reflect"
"strings"
"testing"
"github.com/purpleidea/mgmt/lang/ast"
"github.com/purpleidea/mgmt/lang/funcs"
"github.com/purpleidea/mgmt/lang/interfaces"
"github.com/purpleidea/mgmt/lang/parser"
"github.com/purpleidea/mgmt/util"
"github.com/davecgh/go-spew/spew"
"github.com/kylelemons/godebug/pretty"
"github.com/sanity-io/litter"
)
func TestInterpolate0(t *testing.T) {
type test struct { // an individual test
name string
code string
fail bool
ast interfaces.Stmt
}
testCases := []test{}
// NOTE: to run an individual test, first run: `go test -v` to list the
// names, and then run `go test -run <pattern>` with the name(s) to run.
{
xast := &ast.StmtProg{
Body: []interfaces.Stmt{},
}
testCases = append(testCases, test{ // 0
"nil",
``,
false,
xast,
})
}
{
xast := &ast.StmtProg{
Body: []interfaces.Stmt{
&ast.StmtRes{
Kind: "test",
Name: &ast.ExprStr{
V: "t1",
},
Contents: []ast.StmtResContents{
&ast.StmtResField{
Field: "stringptr",
Value: &ast.ExprStr{
V: "foo",
},
},
},
},
},
}
testCases = append(testCases, test{
name: "basic string",
code: `
test "t1" {
stringptr => "foo",
}
`,
fail: false,
ast: xast,
})
}
{
fieldName := &ast.ExprCall{
Name: funcs.ConcatFuncName,
Args: []interfaces.Expr{
&ast.ExprStr{
V: "foo-",
},
&ast.ExprVar{
Name: "x",
},
},
}
xast := &ast.StmtProg{
Body: []interfaces.Stmt{
&ast.StmtRes{
Kind: "test",
Name: &ast.ExprStr{
V: "t1",
},
Contents: []ast.StmtResContents{
&ast.StmtResField{
Field: "stringptr",
Value: fieldName,
},
},
},
},
}
testCases = append(testCases, test{
name: "basic expansion",
code: `
#$x = "hello" # not actually needed to test interpolation
test "t1" {
stringptr => "foo-${x}",
}
`,
fail: false,
ast: xast,
})
}
{
xast := &ast.StmtProg{
Body: []interfaces.Stmt{
&ast.StmtRes{
Kind: "test",
Name: &ast.ExprStr{
V: "t1",
},
Contents: []ast.StmtResContents{
&ast.StmtResField{
Field: "stringptr",
Value: &ast.ExprStr{
V: "${hello}",
},
},
},
},
},
}
testCases = append(testCases, test{
name: "variable escaping 1",
code: `
test "t1" {
stringptr => "\${hello}",
}
`,
fail: false,
ast: xast,
})
}
{
xast := &ast.StmtProg{
Body: []interfaces.Stmt{
&ast.StmtRes{
Kind: "test",
Name: &ast.ExprStr{
V: "t1",
},
Contents: []ast.StmtResContents{
&ast.StmtResField{
Field: "stringptr",
Value: &ast.ExprStr{
V: `\` + `$` + `{hello}`,
},
},
},
},
},
}
testCases = append(testCases, test{
name: "variable escaping 2",
code: `
test "t1" {
stringptr => "` + `\\` + `\$` + "{hello}" + `",
}
`,
fail: false,
ast: xast,
})
}
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)
t.Run(fmt.Sprintf("test #%d (%s)", index, tc.name), func(t *testing.T) {
code, fail, exp := tc.code, tc.fail, tc.ast
str := strings.NewReader(code)
ast, err := parser.LexParse(str)
if err != nil {
t.Errorf("test #%d: FAIL", index)
t.Errorf("test #%d: lex/parse failed with: %+v", index, err)
return
}
t.Logf("test #%d: AST: %+v", index, ast)
data := &interfaces.Data{
// TODO: add missing fields here if/when needed
StrInterpolater: StrInterpolate,
Debug: testing.Verbose(), // set via the -test.v flag to `go test`
Logf: func(format string, v ...interface{}) {
t.Logf("ast: "+format, v...)
},
}
// some of this might happen *after* interpolate in SetScope or Unify...
if err := ast.Init(data); err != nil {
t.Errorf("test #%d: FAIL", index)
t.Errorf("test #%d: could not init and validate AST: %+v", index, err)
return
}
iast, err := ast.Interpolate()
if !fail && err != nil {
t.Errorf("test #%d: FAIL", index)
t.Errorf("test #%d: interpolate failed with: %+v", index, err)
return
}
if fail && err == nil {
t.Errorf("test #%d: FAIL", index)
t.Errorf("test #%d: interpolate expected error, not nil", index)
return
}
// init exp so that the match will look identical...
if !fail {
if err := exp.Init(data); err != nil {
t.Errorf("test #%d: FAIL", index)
t.Errorf("test #%d: match init failed with: %+v", index, err)
return
}
}
if reflect.DeepEqual(iast, exp) {
return
}
// double check because DeepEqual is different since the logf exists
lo := &litter.Options{
//Compact: false,
StripPackageNames: true,
HidePrivateFields: true,
HideZeroValues: true,
//FieldExclusions: regexp.MustCompile(`^(data)$`),
//FieldFilter func(reflect.StructField, reflect.Value) bool
//HomePackage string
//Separator string
}
if lo.Sdump(iast) == lo.Sdump(exp) { // simple diff
return
}
diff := pretty.Compare(iast, exp)
if diff == "" { // bonus
return
}
t.Errorf("test #%d: AST did not match expected", index)
// TODO: consider making our own recursive print function
t.Logf("test #%d: actual: \n%s", index, lo.Sdump(iast))
t.Logf("test #%d: expected: \n%s", index, lo.Sdump(exp))
t.Logf("test #%d: diff:\n%s", index, diff)
})
}
}
func TestInterpolateBasicStmt(t *testing.T) {
type test struct { // an individual test
name string
ast interfaces.Stmt
fail bool
exp interfaces.Stmt
}
testCases := []test{}
// this causes a panic, so it can't be used
//{
// testCases = append(testCases, test{
// "nil",
// nil,
// false,
// nil,
// })
//}
{
xast := &ast.StmtProg{
Body: []interfaces.Stmt{
&ast.StmtRes{
Kind: "test",
Name: &ast.ExprStr{
V: "t1",
},
Contents: []ast.StmtResContents{
&ast.StmtResField{
Field: "stringptr",
Value: &ast.ExprStr{
V: "foo",
},
},
},
},
},
}
exp := &ast.StmtProg{
Body: []interfaces.Stmt{
&ast.StmtRes{
Kind: "test",
Name: &ast.ExprStr{
V: "t1",
},
Contents: []ast.StmtResContents{
&ast.StmtResField{
Field: "stringptr",
Value: &ast.ExprStr{
V: "foo",
},
},
},
},
},
}
testCases = append(testCases, test{
name: "basic resource",
ast: xast,
fail: false,
exp: exp,
})
}
{
xast := &ast.StmtProg{
Body: []interfaces.Stmt{
&ast.StmtRes{
Kind: "test",
Name: &ast.ExprStr{
V: "t${blah}",
},
Contents: []ast.StmtResContents{
&ast.StmtResField{
Field: "stringptr",
Value: &ast.ExprStr{
V: "foo",
},
},
},
},
},
}
resName := &ast.ExprCall{
Name: funcs.ConcatFuncName,
Args: []interfaces.Expr{
&ast.ExprStr{
V: "t",
},
&ast.ExprVar{
Name: "blah",
},
},
}
exp := &ast.StmtProg{
Body: []interfaces.Stmt{
&ast.StmtRes{
Kind: "test",
Name: resName,
Contents: []ast.StmtResContents{
&ast.StmtResField{
Field: "stringptr",
Value: &ast.ExprStr{
V: "foo",
},
},
},
},
},
}
testCases = append(testCases, test{
name: "expanded resource",
ast: xast,
fail: false,
exp: exp,
})
}
{
xast := &ast.StmtProg{
Body: []interfaces.Stmt{
&ast.StmtRes{
Kind: "test",
Name: &ast.ExprStr{
V: "t${42}", // incorrect type
},
Contents: []ast.StmtResContents{
&ast.StmtResField{
Field: "stringptr",
Value: &ast.ExprStr{
V: "foo",
},
},
},
},
},
}
resName := &ast.ExprCall{
Name: funcs.ConcatFuncName,
// incorrect sig for this function, and now invalid interpolation
Args: []interfaces.Expr{
&ast.ExprStr{
V: "t",
},
&ast.ExprInt{
V: 42,
},
},
}
exp := &ast.StmtProg{
Body: []interfaces.Stmt{
&ast.StmtRes{
Kind: "test",
Name: resName,
Contents: []ast.StmtResContents{
&ast.StmtResField{
Field: "stringptr",
Value: &ast.ExprStr{
V: "foo",
},
},
},
},
},
}
_ = exp // historical
testCases = append(testCases, test{
name: "expanded invalid resource name",
ast: xast,
fail: true,
//exp: exp,
})
}
names := []string{}
for index, tc := range testCases { // run all the tests
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)
t.Run(fmt.Sprintf("test #%d (%s)", index, tc.name), func(t *testing.T) {
ast, fail, exp := tc.ast, tc.fail, tc.exp
data := &interfaces.Data{
// TODO: add missing fields here if/when needed
StrInterpolater: StrInterpolate,
Debug: testing.Verbose(), // set via the -test.v flag to `go test`
Logf: func(format string, v ...interface{}) {
t.Logf("ast: "+format, v...)
},
}
// some of this might happen *after* interpolate in SetScope or Unify...
if err := ast.Init(data); err != nil {
t.Errorf("test #%d: FAIL", index)
t.Errorf("test #%d: could not init and validate AST: %+v", index, err)
return
}
iast, err := ast.Interpolate()
if !fail && err != nil {
t.Errorf("test #%d: FAIL", index)
t.Errorf("test #%d: interpolate failed with: %+v", index, err)
return
}
if fail && err == nil {
t.Errorf("test #%d: FAIL", index)
t.Errorf("test #%d: interpolate expected error, not nil", index)
return
}
// init exp so that the match will look identical...
if !fail {
if err := exp.Init(data); err != nil {
t.Errorf("test #%d: FAIL", index)
t.Errorf("test #%d: match init failed with: %+v", index, err)
return
}
}
if reflect.DeepEqual(iast, exp) {
return
}
// double check because DeepEqual is different since the logf exists
diff := pretty.Compare(iast, exp)
if diff == "" { // bonus
return
}
t.Errorf("test #%d: AST did not match expected", index)
// TODO: consider making our own recursive print function
t.Logf("test #%d: actual: \n%s", index, spew.Sdump(iast))
t.Logf("test #%d: expected: \n%s", index, spew.Sdump(exp))
t.Logf("test #%d: diff:\n%s", index, diff)
})
}
}
func TestInterpolateBasicExpr(t *testing.T) {
type test struct { // an individual test
name string
ast interfaces.Expr
fail bool
exp interfaces.Expr
}
testCases := []test{}
// this causes a panic, so it can't be used
//{
// testCases = append(testCases, test{
// "nil",
// nil,
// false,
// nil,
// })
//}
{
xast := &ast.ExprStr{
V: "hello",
}
exp := &ast.ExprStr{
V: "hello",
}
testCases = append(testCases, test{
name: "basic string",
ast: xast,
fail: false,
exp: exp,
})
}
{
xast := &ast.ExprStr{
V: "hello ${person_name}",
}
exp := &ast.ExprCall{
Name: funcs.ConcatFuncName,
Args: []interfaces.Expr{
&ast.ExprStr{
V: "hello ",
},
&ast.ExprVar{
Name: "person_name",
},
},
}
testCases = append(testCases, test{
name: "basic expansion",
ast: xast,
fail: false,
exp: exp,
})
}
{
xast := &ast.ExprStr{
V: "hello ${x ${y} z}",
}
testCases = append(testCases, test{
name: "invalid expansion",
ast: xast,
fail: true,
})
}
// TODO: patterns like what are shown below are supported by the `hil`
// library, but are not yet supported by our translation layer, nor do
// they necessarily work or make much sense at this point in time...
//{
// xast := &ast.ExprStr{
// V: `hello ${func("hello ${var.foo}")}`,
// }
// exp := nil // TODO: add this
// testCases = append(testCases, test{
// name: "double expansion",
// ast: xast,
// fail: false,
// exp: exp,
// })
//}
{
xast := &ast.ExprStr{
V: "sweetie${3.14159}", // invalid
}
exp := &ast.ExprCall{
Name: funcs.ConcatFuncName,
Args: []interfaces.Expr{
&ast.ExprStr{
V: "sweetie",
},
&ast.ExprFloat{
V: 3.14159,
},
},
}
_ = exp // historical
testCases = append(testCases, test{
name: "float expansion",
ast: xast,
fail: true,
})
}
{
xast := &ast.ExprStr{
V: "i am: ${sys.hostname()}",
}
exp := &ast.ExprCall{
Name: funcs.ConcatFuncName,
Args: []interfaces.Expr{
&ast.ExprStr{
V: "i am: ",
},
&ast.ExprCall{
Name: "sys.hostname",
Args: []interfaces.Expr{},
},
},
}
_ = exp // historical
testCases = append(testCases, test{
name: "function expansion",
ast: xast,
fail: true,
})
}
{
xast := &ast.ExprStr{
V: "i am: ${blah(21, 12.3)}",
}
exp := &ast.ExprCall{
Name: funcs.ConcatFuncName,
Args: []interfaces.Expr{
&ast.ExprStr{
V: "i am: ",
},
&ast.ExprCall{
Name: "blah",
Args: []interfaces.Expr{
&ast.ExprInt{
V: 21,
},
&ast.ExprFloat{
V: 12.3,
},
},
},
},
}
_ = exp // historical
testCases = append(testCases, test{
name: "function expansion arg",
ast: xast,
fail: true,
})
}
// FIXME: i am broken, i don't deal well with negatives for some reason
//{
// xast := &ast.ExprStr{
// V: "i am: ${blah(21, -12.3)}",
// }
// exp := &ast.ExprCall{
// Name: funcs.ConcatFuncName,
// Args: []interfaces.Expr{
// &ast.ExprStr{
// V: "i am: ",
// },
// &ast.ExprCall{
// Name: "blah",
// Args: []interfaces.Expr{
// &ast.ExprInt{
// V: 21,
// },
// &ast.ExprFloat{
// V: -12.3,
// },
// },
// },
// },
// }
// testCases = append(testCases, test{
// name: "function expansion arg negative",
// ast: xast,
// fail: false,
// exp: exp,
// })
//}
// FIXME: i am broken :(
//{
// xast := &ast.ExprStr{
// V: "sweetie${-3.14159}", // FIXME: only the negative breaks this
// }
// exp := &ast.ExprCall{
// Name: funcs.ConcatFuncName,
// Args: []interfaces.Expr{
// &ast.ExprStr{
// V: "sweetie",
// },
// &ast.ExprFloat{
// V: -3.14159,
// },
// },
// }
// testCases = append(testCases, test{
// name: "negative float expansion",
// ast: xast,
// fail: false,
// exp: exp,
// })
//}
// FIXME: i am also broken, but less important
//{
// xast := &ast.ExprStr{
// V: `i am: ${blah(42, "${foo}")}`,
// }
// exp := &ast.ExprCall{
// Name: funcs.ConcatFuncName,
// Args: []interfaces.Expr{
// &ast.ExprStr{
// V: "i am: ",
// },
// &ast.ExprCall{
// Name: "blah",
// Args: []interfaces.Expr{
// &ast.ExprInt{
// V: 42,
// },
// &ast.ExprVar{
// Name: "foo",
// },
// },
// },
// },
// }
// testCases = append(testCases, test{
// name: "function expansion arg with var",
// ast: xast,
// fail: false,
// exp: exp,
// })
//}
names := []string{}
for index, tc := range testCases { // run all the tests
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)
t.Run(fmt.Sprintf("test #%d (%s)", index, tc.name), func(t *testing.T) {
ast, fail, exp := tc.ast, tc.fail, tc.exp
data := &interfaces.Data{
// TODO: add missing fields here if/when needed
StrInterpolater: StrInterpolate,
Debug: testing.Verbose(), // set via the -test.v flag to `go test`
Logf: func(format string, v ...interface{}) {
t.Logf("ast: "+format, v...)
},
}
// some of this might happen *after* interpolate in SetScope or Unify...
if err := ast.Init(data); err != nil {
t.Errorf("test #%d: FAIL", index)
t.Errorf("test #%d: could not init and validate AST: %+v", index, err)
return
}
iast, err := ast.Interpolate()
if !fail && err != nil {
t.Errorf("test #%d: FAIL", index)
t.Errorf("test #%d: interpolate failed with: %+v", index, err)
return
}
if fail && err == nil {
t.Errorf("test #%d: FAIL", index)
t.Errorf("test #%d: interpolate expected error, not nil", index)
return
}
// init exp so that the match will look identical...
if !fail {
if err := exp.Init(data); err != nil {
t.Errorf("test #%d: FAIL", index)
t.Errorf("test #%d: match init failed with: %+v", index, err)
return
}
}
if reflect.DeepEqual(iast, exp) {
return
}
// double check because DeepEqual is different since the logf exists
diff := pretty.Compare(iast, exp)
if diff == "" { // bonus
return
}
t.Errorf("test #%d: AST did not match expected", index)
// TODO: consider making our own recursive print function
t.Logf("test #%d: actual: \n%s", index, spew.Sdump(iast))
t.Logf("test #%d: expected: \n%s", index, spew.Sdump(exp))
t.Logf("test #%d: diff:\n%s", index, diff)
})
}
}