1324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/* 2324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver [The "BSD license"] 3324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Copyright (c) 2007 Kenny MacDermid 4324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver All rights reserved. 5324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 6324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Redistribution and use in source and binary forms, with or without 7324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver modification, are permitted provided that the following conditions 8324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver are met: 9324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1. Redistributions of source code must retain the above copyright 10324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver notice, this list of conditions and the following disclaimer. 11324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 2. Redistributions in binary form must reproduce the above copyright 12324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver notice, this list of conditions and the following disclaimer in the 13324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver documentation and/or other materials provided with the distribution. 14324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 3. The name of the author may not be used to endorse or promote products 15324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver derived from this software without specific prior written permission. 16324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 17324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 18324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 21324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver*/ 28324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverpackage org.antlr.gunit; 29324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverpublic abstract class AbstractTest implements ITestCase { 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // store essential individual test result for string template 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected String header; 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected String actual; 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected boolean hasErrorMsg; 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver private String testedRuleName; 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver private int testCaseIndex; 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // TODO: remove these. They're only used as part of a refactor to keep the 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // code cleaner. It is a mock-instanceOf() replacement. 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public abstract int getType(); 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public abstract String getText(); 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public abstract String getExpected(); 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // return an escaped string of the expected result 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public String getExpectedResult() { 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver String expected = getExpected(); 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( expected!=null ) expected = JUnitCodeGen.escapeForJava(expected); 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return expected; 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public abstract String getResult(gUnitTestResult testResult); 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public String getHeader() { return this.header; } 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public String getActual() { return this.actual; } 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // return an escaped string of the actual result 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public String getActualResult() { 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver String actual = getActual(); 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // there is no need to escape the error message from ANTLR 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( actual!=null && !hasErrorMsg ) actual = JUnitCodeGen.escapeForJava(actual); 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return actual; 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public String getTestedRuleName() { return this.testedRuleName; } 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public int getTestCaseIndex() { return this.testCaseIndex; } 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public void setHeader(String rule, String lexicalRule, String treeRule, int numOfTest, int line) { 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver StringBuffer buf = new StringBuffer(); 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver buf.append("test" + numOfTest + " ("); 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( treeRule!=null ) { 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver buf.append(treeRule+" walks "); 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( lexicalRule!=null ) { 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver buf.append(lexicalRule + ", line"+line+")" + " - "); 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver else buf.append(rule + ", line"+line+")" + " - "); 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.header = buf.toString(); 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public void setActual(String actual) { this.actual = actual; } 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public void setTestedRuleName(String testedRuleName) { this.testedRuleName = testedRuleName; } 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public void setTestCaseIndex(int testCaseIndex) { this.testCaseIndex = testCaseIndex; } 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 84