msyds/gf-rgl
1
0
Fork 0
forked from GitHub/gf-rgl
Code Pull Requests Activity

unittest: create README.md as main documentation

Browse Source
This commit is contained in:
John J. Camilleri
2019-08-05 10:57:26 +02:00
parent 26442cdbd0
commit 2d3d382a41
2 changed files with 29 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
unittest/README.md Normal file
View File

@@ -0,0 +1,28 @@
# Python script for unit testing RGL grammars
## Usage
```
python path-to-script.py path/to/testfile.gftest (...)
```
The script must be located in a sibling directory
to the RGL `src` directory to work properly.
## Test format
The test file should look something like this:
```
LangSwe: jag sover i huset
LangEng: I sleep in the house
LangSwe: huset verkar stort
Lang: PhrUtt NoPConj (UttS (UseCl (TTAnt TPres ASimul) PPos (PredVP ...
```
This contains two tests: Every test should be separated by empty lines.
Every line starts with a language, followed by ":" and the sentence
(or the abstract syntax tree if the abstract grammar is specified).
You can also see an example in the file [`unittest-example.gftest`](unittest-example.gftest).

12
unittest/unittest.py
View File

@@ -5,17 +5,7 @@ Usage: python path-to-script.py path/to/testfile.gftest (...)
The script must be located in a sibling directory
to the RGL 'src' directory to work properly.
The test file should look something like this:
LangSwe: jag sover i huset
LangEng: I sleep in the house
LangSwe: huset verkar stort
Lang: PhrUtt NoPConj (UttS (UseCl (TTAnt TPres ASimul) PPos (PredVP ...
This contains two tests: Every test should be separated by empty lines.
Every line starts with a language, followed by ":" and the sentence
(or the abstract syntax tree if the abstract grammar is specified).
For for information see README.md
"""
from __future__ import print_function