https://github.com/codelion/gramtest
GramTest: A tool for Grammar based Test case generation
https://github.com/codelion/gramtest
bnf grammar grammars java
Last synced: 4 months ago
JSON representation
GramTest: A tool for Grammar based Test case generation
- Host: GitHub
- URL: https://github.com/codelion/gramtest
- Owner: codelion
- License: apache-2.0
- Created: 2015-04-20T05:59:37.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-09-23T13:05:37.000Z (about 2 years ago)
- Last Synced: 2025-06-03T18:51:43.431Z (4 months ago)
- Topics: bnf, grammar, grammars, java
- Language: Java
- Homepage:
- Size: 93.8 KB
- Stars: 86
- Watchers: 5
- Forks: 18
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GramTest
This tool allows you to generate test cases based on arbitrary user defined grammars. The input grammar is given in BNF notation. Potential applications include fuzzing and automated testing.
## Instructions
We use maven as our build tool. When you compile the project using maven (`mvn clean package`) it will generate a single all dependencies Jar, that can be run from the command line as follows:
`java -jar gramtest.jar -file grammar.bnf`
To take a look at all the additional options, you can run `java -jar gramtest.jar -h` which will print the details as below.
```
usage: gramtest [options]
-dep maximum depth for recursive rules
-ext file extension for generated tests
-file path to the grammar file (in BNF notation)
-h,--help prints this message
-max maximum size of each generated test
-min minimum size of each generated test
-mingen use minimal sentence generation
(true/false)
-num maximum number of test cases
-tests path to the folder to store generated tests
```
## Bugs found using GramTest
| Project | Reference | Status |
|---------|---------|--------|
| Apache Commons Validator | https://issues.apache.org/jira/browse/VALIDATOR-410 | Open |
| segmentio/is-url | https://github.com/segmentio/is-url/issues/15 | Open |
| gajus/url-regexp | https://github.com/gajus/url-regexp/issues/6 | Open |
| segmentio/is-url | https://github.com/segmentio/is-url/issues/21 | Open |
## Articles
- [Continuous fuzzing of Java projects with GramTest](https://lambdasec.github.io/Fuzzing-Java-Libraries-with-GramTest/)
- [How does grammar-based test case generation work?](https://www.veracode.com/blog/managing-appsec/how-does-grammar-based-test-case-generation-work)
- [Practical tips for implementing grammar-based test case generation](https://www.veracode.com/blog/secure-development/practical-tips-implementing-grammar-based-test-case-generation)
## FAQ
- _Can I use this particular grammar with GramTest?_
As long as the input grammar is described in BNF it is possible to use it with GramTest to generate random strings. Several grammars that you find online are not given in proper BNF format, have comments/text in some productions, or do not have complete clauses. Verify that the grammar you are using doesn't have any bugs before using it.
- _Why did you choose BNF and not EBNF/ABNF/etc. as the input format for GramTest?_
BNF was the simplest of all formats to use, it is certainly possible to implement another input format but it is going to be a non-trivial excercise. You will need to implement your own [generator](https://github.com/codelion/gramtest/blob/master/src/main/java/com/sourceclear/gramtest/GeneratorVisitor.java) that can create strings based on each type of production in the grammar.
- _Where can I find some sample BNF grammars to use?_
Several examples are available in the [test folder](https://github.com/codelion/gramtest/tree/master/src/test/resources). You can refer to the unit tests to see how they can be used.