php-parser/node/stmt/t_visitor_test.go

531 lines
11 KiB
Go
Raw Normal View History

2018-02-06 17:11:47 +00:00
package stmt_test
import (
"reflect"
"testing"
2018-02-08 21:10:56 +00:00
"github.com/z7zmey/php-parser/node/expr"
"github.com/z7zmey/php-parser/node/stmt"
"github.com/kylelemons/godebug/pretty"
2018-02-06 17:11:47 +00:00
"github.com/z7zmey/php-parser/node"
"github.com/z7zmey/php-parser/walker"
)
var nodesToTest = []struct {
node node.Node // node
expectedVisitedKeys []string // visited keys
expectedAttributes map[string]interface{}
}{
{
&stmt.AltIf{
Cond: &stmt.Expression{},
Stmt: &stmt.StmtList{},
ElseIf: []node.Node{&stmt.ElseIf{}},
Else: &stmt.Else{},
},
[]string{"Cond", "Stmt", "ElseIf", "Else"},
map[string]interface{}{},
},
{
&stmt.AltElse{
2018-02-08 21:10:56 +00:00
Stmt: &stmt.StmtList{},
2018-02-06 17:11:47 +00:00
},
[]string{"Stmt"},
map[string]interface{}{},
},
{
&stmt.AltElseIf{
2018-02-08 21:10:56 +00:00
Cond: &stmt.Expression{},
Stmt: &stmt.StmtList{},
2018-02-06 17:11:47 +00:00
},
[]string{"Cond", "Stmt"},
map[string]interface{}{},
},
{
&stmt.Break{
2018-02-08 21:10:56 +00:00
Expr: &stmt.Expression{},
2018-02-06 17:11:47 +00:00
},
[]string{"Expr"},
map[string]interface{}{},
},
{
&stmt.Case{
2018-02-08 21:10:56 +00:00
Cond: &stmt.Expression{},
Stmts: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
},
[]string{"Cond", "Stmts"},
map[string]interface{}{},
},
{
&stmt.Catch{
2018-02-08 21:10:56 +00:00
Types: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
Variable: &expr.Variable{},
2018-02-08 21:10:56 +00:00
Stmts: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
},
[]string{"Types", "Variable", "Stmts"},
map[string]interface{}{},
},
{
&stmt.ClassConstList{
2018-02-08 21:10:56 +00:00
Modifiers: []node.Node{&stmt.Expression{}},
Consts: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
},
[]string{"Modifiers", "Consts"},
map[string]interface{}{},
},
{
&stmt.ClassMethod{
ReturnsRef: true,
PhpDocComment: "/** */",
MethodName: &node.Identifier{},
2018-02-08 21:10:56 +00:00
Modifiers: []node.Node{&stmt.Expression{}},
Params: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
ReturnType: &node.Identifier{},
2018-02-08 21:10:56 +00:00
Stmts: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
},
[]string{"MethodName", "Modifiers", "Params", "ReturnType", "Stmts"},
map[string]interface{}{"ReturnsRef": true, "PhpDocComment": "/** */"},
},
{
&stmt.Class{
PhpDocComment: "/** */",
ClassName: &node.Identifier{},
2018-02-08 21:10:56 +00:00
Modifiers: []node.Node{&stmt.Expression{}},
Args: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
Extends: &node.Identifier{},
2018-02-08 21:10:56 +00:00
Implements: []node.Node{&stmt.Expression{}},
Stmts: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
},
[]string{"ClassName", "Modifiers", "Args", "Extends", "Implements", "Stmts"},
map[string]interface{}{"PhpDocComment": "/** */"},
},
{
&stmt.ConstList{
2018-02-08 21:10:56 +00:00
Consts: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
},
[]string{"Consts"},
map[string]interface{}{},
},
{
&stmt.Constant{
PhpDocComment: "/** */",
ConstantName: &node.Identifier{},
Expr: &stmt.Expression{},
},
[]string{"ConstantName", "Expr"},
map[string]interface{}{"PhpDocComment": "/** */"},
},
{
&stmt.Continue{
2018-02-08 21:10:56 +00:00
Expr: &stmt.Expression{},
2018-02-06 17:11:47 +00:00
},
[]string{"Expr"},
map[string]interface{}{},
},
{
&stmt.Declare{
2018-02-08 21:10:56 +00:00
Consts: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
Stmt: &stmt.StmtList{},
},
[]string{"Consts", "Stmt"},
map[string]interface{}{},
},
{
&stmt.Default{
2018-02-08 21:10:56 +00:00
Stmts: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
},
[]string{"Stmts"},
map[string]interface{}{},
},
{
&stmt.Do{
Stmt: &stmt.StmtList{},
Cond: &expr.Variable{},
},
[]string{"Stmt", "Cond"},
map[string]interface{}{},
},
{
&stmt.Do{
Stmt: &stmt.StmtList{},
Cond: &expr.Variable{},
},
[]string{"Stmt", "Cond"},
map[string]interface{}{},
},
{
&stmt.Echo{
2018-02-08 21:10:56 +00:00
Exprs: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
},
[]string{"Exprs"},
map[string]interface{}{},
},
{
&stmt.If{
Cond: &stmt.Expression{},
Stmt: &stmt.StmtList{},
ElseIf: []node.Node{&stmt.ElseIf{}},
Else: &stmt.Else{},
},
[]string{"Cond", "Stmt", "ElseIf", "Else"},
map[string]interface{}{},
},
{
&stmt.Else{
2018-02-08 21:10:56 +00:00
Stmt: &stmt.StmtList{},
2018-02-06 17:11:47 +00:00
},
[]string{"Stmt"},
map[string]interface{}{},
},
{
&stmt.ElseIf{
2018-02-08 21:10:56 +00:00
Cond: &stmt.Expression{},
Stmt: &stmt.StmtList{},
2018-02-06 17:11:47 +00:00
},
[]string{"Cond", "Stmt"},
map[string]interface{}{},
},
{
&stmt.Expression{
2018-02-08 21:10:56 +00:00
Expr: &stmt.Expression{},
2018-02-06 17:11:47 +00:00
},
[]string{"Expr"},
map[string]interface{}{},
},
{
&stmt.Finally{
2018-02-08 21:10:56 +00:00
Stmts: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
},
[]string{"Stmts"},
map[string]interface{}{},
},
{
&stmt.For{
2018-02-08 21:10:56 +00:00
Init: []node.Node{&stmt.Expression{}},
Cond: []node.Node{&stmt.Expression{}},
Loop: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
Stmt: &stmt.StmtList{},
},
[]string{"Init", "Cond", "Loop", "Stmt"},
map[string]interface{}{},
},
2018-02-18 17:57:54 +00:00
{
&stmt.AltFor{
Init: []node.Node{&stmt.Expression{}},
Cond: []node.Node{&stmt.Expression{}},
Loop: []node.Node{&stmt.Expression{}},
Stmt: &stmt.StmtList{},
},
[]string{"Init", "Cond", "Loop", "Stmt"},
map[string]interface{}{},
},
2018-02-06 17:11:47 +00:00
{
&stmt.Foreach{
ByRef: true,
Expr: &stmt.Expression{},
Key: &expr.Variable{},
Variable: &expr.Variable{},
Stmt: &stmt.StmtList{},
},
[]string{"Expr", "Key", "Variable", "Stmt"},
map[string]interface{}{"ByRef": true},
2018-02-18 18:29:33 +00:00
},
{
&stmt.AltForeach{
ByRef: true,
Expr: &stmt.Expression{},
Key: &expr.Variable{},
Variable: &expr.Variable{},
Stmt: &stmt.StmtList{},
},
[]string{"Expr", "Key", "Variable", "Stmt"},
map[string]interface{}{"ByRef": true},
2018-02-06 17:11:47 +00:00
},
{
&stmt.Function{
ReturnsRef: true,
2018-02-08 21:10:56 +00:00
PhpDocComment: "/** */",
2018-02-06 17:11:47 +00:00
FunctionName: &node.Identifier{},
2018-02-08 21:10:56 +00:00
Params: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
ReturnType: &node.Identifier{},
2018-02-08 21:10:56 +00:00
Stmts: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
},
[]string{"FunctionName", "Params", "ReturnType", "Stmts"},
map[string]interface{}{"ReturnsRef": true, "PhpDocComment": "/** */"},
},
{
&stmt.Global{
2018-02-08 21:10:56 +00:00
Vars: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
},
[]string{"Vars"},
map[string]interface{}{},
},
{
&stmt.Goto{
Label: &node.Identifier{},
},
[]string{"Label"},
map[string]interface{}{},
},
{
&stmt.GroupUse{
UseType: &node.Identifier{},
Prefix: &node.Identifier{},
2018-02-08 21:10:56 +00:00
UseList: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
},
[]string{"UseType", "Prefix", "UseList"},
map[string]interface{}{},
},
{
&stmt.HaltCompiler{},
[]string{},
map[string]interface{}{},
},
{
&stmt.InlineHtml{
2018-02-08 21:10:56 +00:00
Value: "hello",
2018-02-06 17:11:47 +00:00
},
[]string{},
map[string]interface{}{"Value": "hello"},
},
{
&stmt.Interface{
PhpDocComment: "/** */",
InterfaceName: &node.Identifier{},
2018-02-08 21:10:56 +00:00
Extends: []node.Node{&stmt.Expression{}},
Stmts: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
},
[]string{"InterfaceName", "Extends", "Stmts"},
map[string]interface{}{"PhpDocComment": "/** */"},
},
{
&stmt.Label{
LabelName: &node.Identifier{},
},
[]string{"LabelName"},
map[string]interface{}{},
},
{
&stmt.Namespace{
NamespaceName: &node.Identifier{},
2018-02-08 21:10:56 +00:00
Stmts: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
},
[]string{"NamespaceName", "Stmts"},
map[string]interface{}{},
},
{
&stmt.Nop{},
[]string{},
map[string]interface{}{},
},
{
&stmt.PropertyList{
2018-02-08 21:10:56 +00:00
Modifiers: []node.Node{&stmt.Expression{}},
Properties: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
},
[]string{"Modifiers", "Properties"},
map[string]interface{}{},
},
{
&stmt.Property{
2018-02-08 21:10:56 +00:00
PhpDocComment: "/** */",
2018-02-06 17:11:47 +00:00
Variable: &expr.Variable{},
Expr: &stmt.Expression{},
},
[]string{"Variable", "Expr"},
map[string]interface{}{"PhpDocComment": "/** */"},
},
{
&stmt.Return{
Expr: &stmt.Expression{},
},
[]string{"Expr"},
map[string]interface{}{},
},
{
&stmt.StaticVar{
Variable: &expr.Variable{},
Expr: &stmt.Expression{},
},
[]string{"Variable", "Expr"},
map[string]interface{}{},
},
{
&stmt.Static{
2018-02-08 21:10:56 +00:00
Vars: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
},
[]string{"Vars"},
map[string]interface{}{},
},
{
&stmt.Switch{
Cond: &expr.Variable{},
2018-02-08 21:10:56 +00:00
Cases: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
},
[]string{"Cond", "Cases"},
map[string]interface{}{},
},
{
&stmt.Throw{
Expr: &stmt.Expression{},
},
[]string{"Expr"},
map[string]interface{}{},
},
{
&stmt.TraitMethodRef{
Trait: &node.Identifier{},
Method: &node.Identifier{},
},
[]string{"Trait", "Method"},
map[string]interface{}{},
},
{
&stmt.TraitUseAlias{
Ref: &node.Identifier{},
Modifier: &node.Identifier{},
Alias: &node.Identifier{},
},
[]string{"Ref", "Modifier", "Alias"},
map[string]interface{}{},
},
{
&stmt.TraitUsePrecedence{
Ref: &node.Identifier{},
2018-02-09 12:48:10 +00:00
Insteadof: []node.Node{&node.Identifier{}},
2018-02-06 17:11:47 +00:00
},
[]string{"Ref", "Insteadof"},
map[string]interface{}{},
},
{
&stmt.TraitUse{
2018-02-08 21:10:56 +00:00
Traits: []node.Node{&stmt.Expression{}},
Adaptations: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
},
[]string{"Traits", "Adaptations"},
map[string]interface{}{},
},
{
&stmt.Trait{
PhpDocComment: "/** */",
TraitName: &node.Identifier{},
2018-02-08 21:10:56 +00:00
Stmts: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
},
[]string{"TraitName", "Stmts"},
map[string]interface{}{"PhpDocComment": "/** */"},
},
{
&stmt.Try{
2018-02-08 21:10:56 +00:00
Stmts: []node.Node{&stmt.Expression{}},
Catches: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
Finally: &stmt.Finally{},
},
[]string{"Stmts", "Catches", "Finally"},
map[string]interface{}{},
},
{
&stmt.Unset{
2018-02-08 21:10:56 +00:00
Vars: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
},
[]string{"Vars"},
map[string]interface{}{},
},
{
&stmt.UseList{
UseType: &node.Identifier{},
2018-02-08 21:10:56 +00:00
Uses: []node.Node{&stmt.Expression{}},
2018-02-06 17:11:47 +00:00
},
[]string{"UseType", "Uses"},
map[string]interface{}{},
},
{
&stmt.Use{
UseType: &node.Identifier{},
Use: &node.Identifier{},
Alias: &node.Identifier{},
},
[]string{"UseType", "Use", "Alias"},
map[string]interface{}{},
},
{
&stmt.While{
2018-02-08 21:10:56 +00:00
Cond: &expr.Variable{},
Stmt: &stmt.StmtList{},
2018-02-06 17:11:47 +00:00
},
[]string{"Cond", "Stmt"},
map[string]interface{}{},
},
2018-02-18 17:44:17 +00:00
{
&stmt.AltWhile{
Cond: &expr.Variable{},
Stmt: &stmt.StmtList{},
},
[]string{"Cond", "Stmt"},
map[string]interface{}{},
},
2018-02-09 12:11:08 +00:00
{
&stmt.StmtList{
Stmts: []node.Node{&stmt.Expression{}},
},
[]string{"Stmts"},
map[string]interface{}{},
},
2018-02-06 17:11:47 +00:00
}
type visitorMock struct {
visitChildren bool
visitedKeys []string
}
func (v *visitorMock) EnterNode(n walker.Walker) bool { return v.visitChildren }
func (v *visitorMock) GetChildrenVisitor(key string) walker.Visitor {
v.visitedKeys = append(v.visitedKeys, key)
return &visitorMock{v.visitChildren, nil}
}
func (v *visitorMock) LeaveNode(n walker.Walker) {}
func TestVisitorDisableChildren(t *testing.T) {
for _, tt := range nodesToTest {
v := &visitorMock{false, nil}
tt.node.Walk(v)
expected := []string{}
actual := v.visitedKeys
diff := pretty.Compare(expected, actual)
if diff != "" {
t.Errorf("%s diff: (-expected +actual)\n%s", reflect.TypeOf(tt.node), diff)
}
}
}
func TestVisitor(t *testing.T) {
for _, tt := range nodesToTest {
v := &visitorMock{true, nil}
tt.node.Walk(v)
expected := tt.expectedVisitedKeys
actual := v.visitedKeys
diff := pretty.Compare(expected, actual)
if diff != "" {
t.Errorf("%s diff: (-expected +actual)\n%s", reflect.TypeOf(tt.node), diff)
}
}
}
// test Attributes()
func TestNameAttributes(t *testing.T) {
for _, tt := range nodesToTest {
expected := tt.expectedAttributes
actual := tt.node.Attributes()
diff := pretty.Compare(expected, actual)
if diff != "" {
t.Errorf("%s diff: (-expected +actual)\n%s", reflect.TypeOf(tt.node), diff)
}
}
}