Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Conformance tests for the runtime and generated lexers.
The goal is to have a single lexer definition that exercises all the functionality of the stateful lexer and generated equivalent. See #264
- Loading branch information
1 parent
0d264e9
commit fa71ac8
Showing
8 changed files
with
254 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| //go:build generated | ||
|
|
||
| package conformance_test | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/alecthomas/participle/v2/lexer/internal/conformance" | ||
| ) | ||
|
|
||
| // This should only be run by TestLexerConformanceGenerated. | ||
| func TestLexerConformanceGeneratedInternal(t *testing.T) { | ||
| testLexer(t, conformance.GeneratedConformanceLexer) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| package conformance_test | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "flag" | ||
| "fmt" | ||
| "os" | ||
| "os/exec" | ||
| "path/filepath" | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "github.com/alecthomas/assert/v2" | ||
| "github.com/alecthomas/participle/v2/lexer" | ||
| ) | ||
|
|
||
| var conformanceLexer = lexer.MustStateful(lexer.Rules{ | ||
| "Root": { | ||
| {"String", `"`, lexer.Push("String")}, | ||
| // {"Heredoc", `<<(\w+\b)`, lexer.Push("Heredoc")}, | ||
| }, | ||
| "String": { | ||
| {"Escaped", `\\.`, nil}, | ||
| {"StringEnd", `"`, lexer.Pop()}, | ||
| {"Expr", `\${`, lexer.Push("Expr")}, | ||
| {"Char", `[^$"\\]+`, nil}, | ||
| }, | ||
| "Expr": { | ||
| lexer.Include("Root"), | ||
| {`Whitespace`, `\s+`, nil}, | ||
| {`Oper`, `[-+/*%]`, nil}, | ||
| {"Ident", `\w+`, lexer.Push("Reference")}, | ||
| {"ExprEnd", `}`, lexer.Pop()}, | ||
| }, | ||
| "Reference": { | ||
| {"Dot", `\.`, nil}, | ||
| {"Ident", `\w+`, nil}, | ||
| lexer.Return(), | ||
| }, | ||
| // "Heredoc": { | ||
| // {"End", `\b\1\b`, lexer.Pop()}, | ||
| // lexer.Include("Expr"), | ||
| // }, | ||
| }) | ||
|
|
||
| type token struct { | ||
| Type string | ||
| Value string | ||
| } | ||
|
|
||
| func testLexer(t *testing.T, lex lexer.Definition) { | ||
| t.Helper() | ||
| tests := []struct { | ||
| name string | ||
| input string | ||
| expected []token | ||
| }{ | ||
| {"Push", `"${"Hello ${name + "!"}"}"`, []token{ | ||
| {"String", "\""}, | ||
| {"Expr", "${"}, | ||
| {"String", "\""}, | ||
| {"Char", "Hello "}, | ||
| {"Expr", "${"}, | ||
| {"Ident", "name"}, | ||
| {"Whitespace", " "}, | ||
| {"Oper", "+"}, | ||
| {"Whitespace", " "}, | ||
| {"String", "\""}, | ||
| {"Char", "!"}, | ||
| {"StringEnd", "\""}, | ||
| {"ExprEnd", "}"}, | ||
| {"StringEnd", "\""}, | ||
| {"ExprEnd", "}"}, | ||
| {"StringEnd", "\""}, | ||
| }}, | ||
| {"Reference", `"${user.name}"`, []token{ | ||
| {"String", "\""}, | ||
| {"Expr", "${"}, | ||
| {"Ident", "user"}, | ||
| {"Dot", "."}, | ||
| {"Ident", "name"}, | ||
| {"ExprEnd", "}"}, | ||
| {"StringEnd", "\""}, | ||
| }}, | ||
| } | ||
| symbols := lexer.SymbolsByRune(lex) | ||
| for _, test := range tests { | ||
| t.Run(test.name, func(t *testing.T) { | ||
| l, err := lex.Lex(test.name, strings.NewReader(test.input)) | ||
| assert.NoError(t, err) | ||
| tokens, err := lexer.ConsumeAll(l) | ||
| assert.NoError(t, err) | ||
| actual := make([]token, len(tokens)-1) | ||
| for i, t := range tokens { | ||
| if t.Type == lexer.EOF { | ||
| continue | ||
| } | ||
| actual[i] = token{Type: symbols[t.Type], Value: t.Value} | ||
| } | ||
| assert.Equal(t, test.expected, actual) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestLexerConformanceGenerated(t *testing.T) { | ||
| genLexer(t) | ||
| args := []string{"test", "-run", "TestLexerConformanceGeneratedInternal", "-tags", "generated"} | ||
| // Propagate test flags. | ||
| flag.CommandLine.VisitAll(func(f *flag.Flag) { | ||
| if f.Value.String() != f.DefValue { | ||
| args = append(args, fmt.Sprintf("-%s=%s", f.Name, f.Value.String())) | ||
| } | ||
| }) | ||
| cmd := exec.Command("go", args...) | ||
| cmd.Stdout = os.Stdout | ||
| cmd.Stderr = os.Stderr | ||
| err := cmd.Run() | ||
| assert.NoError(t, err) | ||
| } | ||
|
|
||
| func TestLexerConformance(t *testing.T) { | ||
| testLexer(t, conformanceLexer) | ||
| } | ||
|
|
||
| func genLexer(t *testing.T) { | ||
| t.Helper() | ||
| lexerJSON, err := json.Marshal(conformanceLexer) | ||
| assert.NoError(t, err) | ||
| cwd, err := os.Getwd() | ||
| assert.NoError(t, err) | ||
| generatedConformanceLexer := filepath.Join(cwd, "conformance_lexer_gen.go") | ||
| t.Cleanup(func() { | ||
| _ = os.Remove(generatedConformanceLexer) | ||
| }) | ||
| cmd := exec.Command( | ||
| "../../../scripts/participle", | ||
| "gen", "lexer", "conformance", | ||
| "--tags", "generated", | ||
| "--name", "GeneratedConformance", | ||
| "--output", generatedConformanceLexer) | ||
| cmd.Stdout = os.Stdout | ||
| cmd.Stderr = os.Stderr | ||
| w, err := cmd.StdinPipe() | ||
| assert.NoError(t, err) | ||
| defer w.Close() | ||
| err = cmd.Start() | ||
| assert.NoError(t, err) | ||
| _, err = w.Write(lexerJSON) | ||
| assert.NoError(t, err) | ||
| err = w.Close() | ||
| assert.NoError(t, err) | ||
| err = cmd.Wait() | ||
| assert.NoError(t, err) | ||
| } |
Oops, something went wrong.