ANTLR和StringTemplate实例:自动生成单元测试类
1. ANTLR语法
要想自动生成单元测试,首先第一步就是分析被测试类。这里以Java代码为例,用ANTLR对Java代码进行分析。要想靠自己完全手写出一门语言的ANTLR语法文件的复杂程度难以想象,很贴心的是在ANTLR的GitHub网站上列出了很多常见语言的语法文件,例如Java,Sqlite和MySQL的SQL语法等。
有了.g4语法文件,按照Antlr v4入门教程和实例中的步骤,就能自动生成出解析器的代码,这里就不再详述了。
2. StringTemplate基础
StringTemplate(简称ST)也是ANTLR提供的一个非常好用的工具。它的功能类似于Velocity、FreeMaker等模板引擎,可以根据事先定义好的模板,在运行时根据不同的传值渲染出不同的网页、邮件、代码等。但从名称中的String就能看出,它是比较轻量级的。试用了一下的确如此,支持在Java中硬编码简单的模板。
但试用过程中还是碰到了有不少问题,总感觉它的模板语法有些复杂啊!而且最新的ST4的API与之前版本发生了很大变化,网上找的很多例子都不好用了。具体还是参考官网的教程吧,以及这个CheatSheet表格。当然,还有花了不少时间调试好的本文的代码示例!
3. 单元测试生成器
首先来看Main方法。输入文本就是code变量表示的一个Java类,里面有两个方法。然后使用自动生成出的ANTLR代码,构建起语义分析器和解析器的处理链,并传入UnitTestGenerator
监听器对输入文本进行遍历。
public class JavaCodeParseTest {
public static void main(String[] args) {
String code =
"package com.jcache.store;" +
"public class CacheStore {" +
"Object getCache(int a) {" +
"if (a == 1)" +
"return 1;" +
"else " +
"return 2;" +
"}" +
"void setCache(int a) {" +
"return;" +
"}" +
"}";
// 1.Lexical analysis
JavaLexer lexer