123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517 |
- /* *******************************************************************
- * Copyright (c) 1999-2001 Xerox Corporation,
- * 2002 Palo Alto Research Center, Incorporated (PARC).
- * All rights reserved.
- * This program and the accompanying materials are made available
- * under the terms of the Eclipse Public License v1.0
- * which accompanies this distribution and is available at
- * http://www.eclipse.org/legal/epl-v10.html
- *
- * Contributors:
- * Xerox/PARC initial implementation
- * ******************************************************************/
-
- package org.aspectj.testing.util;
-
- import java.io.File;
- import java.util.Comparator;
-
- import org.aspectj.bridge.IMessage;
- import org.aspectj.bridge.ISourceLocation;
- import org.aspectj.bridge.Message;
- import org.aspectj.bridge.MessageUtil;
- import org.aspectj.bridge.SourceLocation;
- import org.aspectj.testing.run.IRunStatus;
- import org.aspectj.testing.run.RunValidator;
- import org.aspectj.util.FileUtil;
-
- /**
- *
- */
- public class BridgeUtil {
-
- // private static final String INDENT = " ";
-
- /** result value when writeMessage is passed null */
- private static final String NULL_MESSAGE_OUTPUT = "<null message output>";
-
- /** result value when readMessage is passed null */
- private static final IMessage NULL_MESSAGE_INPUT = null;
-
- private static final String KIND_DELIM = ": \"";
- private static final String MESSAGE_DELIM = "\" - ";
-
-
- public static ISourceLocation makeSourceLocation(UtilLineReader reader) {
- LangUtil.throwIaxIfNull(reader, "reader");
- int line = reader.getLineNumber();
-
- return new SourceLocation(reader.getFile(), line, line, 0);
- }
-
-
- /**
- * Method readSourceLocation.
- * @param sourceLocStr
- * @return ISourceLocation
- */
- private static ISourceLocation readSourceLocation(String sourceLocStr) {
- return BridgeUtil.makeSourceLocation(sourceLocStr);
- }
- // public static IMessage makeMessage(String message, IMessage.Kind kind,
- // Throwable thrown, LineReader reader) {
- // ISourceLocation sl = (null == reader ? null : MessageUtil.makeSourceLocation(reader));
- // if (null == kind) kind = IMessage.INFO;
- // return new Message(message, kind, thrown, sl);
- // }
-
- /**
- * Read a message from a string written by writeMessage(IMessage).
- * Does not handle exceptions at all or source location well. XXX
- * @param message the String representation of a message
- * @return IMessage
- */
- public static IMessage readMessage(String message) {
- if (null == message) {
- return NULL_MESSAGE_INPUT;
- }
- if (NULL_MESSAGE_OUTPUT.equals(message)) {
- return null;
- }
- int kindEnd = message.indexOf(KIND_DELIM);
- int messageEnd = message.indexOf(MESSAGE_DELIM);
- int messageStart = kindEnd+KIND_DELIM.length();
- int sourceLocStart = messageEnd+MESSAGE_DELIM.length();
- String kindStr = message.substring(0, kindEnd);
- String text = message.substring(messageStart, messageEnd);
- String sourceLocStr = message.substring(sourceLocStart);
- IMessage.Kind kind = MessageUtil.getKind(kindStr);
- ISourceLocation loc = readSourceLocation(sourceLocStr);
- return new Message(text, kind, null, loc);
- }
-
-
- /**
- * Write a message to a string to be read by readMessage(String)
- * @param message the String representation of a message
- * @return IMessage
- */
- public static String writeMessage(IMessage message) {
- if (null == message) {
- return NULL_MESSAGE_OUTPUT;
- }
- return message.getKind()
- + KIND_DELIM
- + message.getMessage()
- + MESSAGE_DELIM
- + message.getSourceLocation(); // XXX implement
- }
-
-
- public static class Comparators {
- /**
- * Compare based solely on null-inequality:
- * -1 if one is not null and two is null,
- * 1 if one is null and two is not null,
- * 0 otherwise.
- */
- static int compareNull(Object one, Object two) {
- return (null == one
- ? (null == two ? 0 : 1)
- : (null == two ? -1 : 0));
- }
-
- /**
- * Soft comparison of String returns 0 if either is empty
- * or a substring of the other, and the case-insensitive
- * ordering otherwise.
- * @param lhs_s
- * @param rhs_s
- * @return
- */
- static int compareStringsSoftly(String lhs_s, String rhs_s) {
- if (LangUtil.isEmpty(lhs_s)
- || LangUtil.isEmpty(rhs_s)) {
- return 0;
- }
- if ((-1 != lhs_s.indexOf(rhs_s))
- || (-1 != rhs_s.indexOf(lhs_s))) {
- return 0;
- }
- return String.CASE_INSENSITIVE_ORDER.compare(lhs_s, rhs_s);
- }
-
- /**
- * This returns 0 if one file path is a suffix of the other
- * or a case-insensitive string comparison otherwise.
- * WARNING: it returns 0 if either file is
- * ISourceLocation.NO_FILE to permit tests to
- * not specify file paths.
- *
- * Use only for sorts, not to maintain maps.
- */
- public static final Comparator<File> WEAK_File = new Comparator<File>() {
- public int compare(File o1, File o2) {
- if ((o1 == o2)
- || (o1 == ISourceLocation.NO_FILE)
- || (o2 == ISourceLocation.NO_FILE) ) {
- return 0;
- }
- int result = compareNull(o1, o2);
- if (0 != result) {
- return result;
- }
- File one = (File) o1;
- File two = (File) o2;
- String s1 = one.getPath();
- String s2 = two.getPath();
- // check if normalize needed
- if (s1.endsWith(s2) || s2.endsWith(s1)) {
- return 0;
- }
- s1 = FileUtil.weakNormalize(s1);
- s2 = FileUtil.weakNormalize(s2);
- if (s1.endsWith(s2) || s2.endsWith(s1)) {
- return 0;
- }
- return String.CASE_INSENSITIVE_ORDER.compare(s1, s2);
-
- }
- };
- /**
- * Ordering only uses line number.
- * Use only for sorts, not to maintain maps.
- */
- public static final Comparator<ISourceLocation> WEAK_ISourceLocation = new Comparator<ISourceLocation>() {
- public int compare(ISourceLocation o1, ISourceLocation o2) {
- if (o1 == o2) {
- return 0;
- }
- int result = compareNull(o1, o2);
- if (0 != result) {
- return result;
- }
- ISourceLocation one = (ISourceLocation) o1;
- ISourceLocation two = (ISourceLocation) o2;
- int i1 = one.getLine();
- int i2 = two.getLine();
- return i1 - i2;
- }
- };
-
- /**
- * Like WEAK_ISourceLocation, except it also
- * uses WEAK_FILE on the sourceFile.
- * Use only for sorts, not to maintain maps.
- */
- public static final Comparator<ISourceLocation> MEDIUM_ISourceLocation = new Comparator<ISourceLocation>() {
- public int compare(ISourceLocation o1, ISourceLocation o2) {
- int result = WEAK_ISourceLocation.compare(o1, o2);
- if (0 != result) {
- return result;
- }
- ISourceLocation one = (ISourceLocation) o1;
- ISourceLocation two = (ISourceLocation) o2;
- result = compareNull(one, two);
- if (0 != result) { // one but not other is null
- return result;
- }
- if (null == one) { // both null
- return 0;
- }
- // neither null
- return WEAK_File.compare(one.getSourceFile(), two.getSourceFile());
- }
- };
-
- /**
- * Ordering uses kind and weak source location,
- * and ignores message
- * so use only for sorts, not to maintain maps
- */
- public static final Comparator<IMessage> WEAK_IMessage = new Comparator<IMessage>() {
- public int compare(IMessage o1, IMessage o2) {
- if (o1 == o2) {
- return 0;
- }
- int result = compareNull(o1, o2);
- if (0 != result) {
- return result;
- }
- IMessage one = (IMessage) o1;
- IMessage two = (IMessage) o2;
- IMessage.Kind kind1 = one.getKind();
- IMessage.Kind kind2= two.getKind();
- result = IMessage.Kind.COMPARATOR.compare(kind1, kind2);
- if (0 != result) {
- return result;
- }
- ISourceLocation sl1 = one.getSourceLocation();
- ISourceLocation sl2 = two.getSourceLocation();
- return WEAK_ISourceLocation.compare(sl1, sl2);
- }
- };
-
- /**
- * Ordering uses line and weak filename and message
- * (message matches if either is a substring of the other,
- * or if either is empty, i.e., none specified).
- * so use only for sorts, not to maintain maps
- */
- public static final Comparator<IMessage> MEDIUM_IMessage = new Comparator<IMessage>() {
- public int compare(IMessage o1, IMessage o2) {
- int result = WEAK_IMessage.compare(o1, o2);
- if (0 != result) {
- return result;
- }
- IMessage rhs_m= (IMessage) o1;
- IMessage lhs_m = (IMessage) o2;
- ISourceLocation rhs_sl = rhs_m.getSourceLocation();
- ISourceLocation lhs_sl = lhs_m.getSourceLocation();
- result = MEDIUM_ISourceLocation.compare(lhs_sl, rhs_sl);
- if (0 != result) {
- return result;
- }
- String lhs_s =lhs_m.getMessage();
- String rhs_s = rhs_m.getMessage();
- return compareStringsSoftly(lhs_s, rhs_s);
- }
- };
- }
- public static SourceLocation makeSourceLocation(String input) { // XXX only for testing, not production
- return makeSourceLocation(input, (File) null);
- }
-
- public static SourceLocation makeSourceLocation(String input, String path) {
- return makeSourceLocation(input, (null == path ? null : new File(path)));
- }
-
- /** attempt to create a source location from the input */
- public static SourceLocation makeSourceLocation(String input, File defaultFile) {
- /*
- * Forms interpreted:
- * # - line
- * file - file
- * file:# - file, line
- * #:# - if defaultFile is not null, then file, line, column
- * file:#:# - file, line, column
- * file:#:#:? - file, line, column, message
- */
- // SourceLocation result = null;
- if ((null == input) || (0 == input.length())) {
- if (null == defaultFile) {
- return null;
- } else {
- return new SourceLocation(defaultFile, 0, 0, 0);
- }
- }
- input = input.trim();
-
- String path = null;
- int line = 0;
- int endLine = 0;
- int column = 0;
- // String message = null;
-
- // first try line only
- line = convert(input);
- if (-1 != line) {
- return new SourceLocation(defaultFile, line, line, 0);
- }
-
- // if not a line - must be > 2 characters
- if (3 > input.length()) {
- return null; // throw new IllegalArgumentException("too short: " + input);
- }
- final String fixTag = "FIXFIX";
- if (input.charAt(1) == ':') { // windows drive ambiguates ":" file:line:col separator
- input = fixTag + input.substring(0,1) + input.substring(2);
- }
- // expecting max: path:line:column:message
- // if 1 colon, delimits line (to second colon or end of string)
- // if 2 colon, delimits column (to third colon or end of string)
- // if 3 colon, delimits column (to fourth colon or end of string)
- // todo: use this instead??
- final int colon1 = input.indexOf(":",2); // 2 to get past windows drives...
- final int colon2 = (-1 == colon1?-1:input.indexOf(":", colon1+1));
- final int colon3 = (-1 == colon2?-1:input.indexOf(":", colon2+1));
- String s;
- if (-1 == colon1) { // no colon; only path (number handled above)
- path = input;
- } else { // 1+ colon => file:line // XXX later or line:column
- path = input.substring(0, colon1);
- s = input.substring(colon1+1,(-1!=colon2?colon2:input.length())).trim();
- line = convert(s);
- if (-1 == line) {
- return null;
- //line = "expecting line(number) at \"" + line + "\" in " + input;
- //throw new IllegalArgumentException(line);
- } else if (-1 != colon2) { // 2+ colon => col
- s = input.substring(colon2+1,(-1!=colon3?colon3:input.length())).trim();
- column = convert(s);
- if (-1 == column) {
- return null;
- //col = "expecting col(number) at \"" + col + "\" in " + input;
- //throw new IllegalArgumentException(col);
- } else if (-1 != colon3) { // 3 colon => message
- input.substring(colon3+1); // do not trim message
- }
- }
- }
-
- if (path.startsWith(fixTag)) {
- int len = fixTag.length();
- path = path.substring(len, 1+len) + ":" +
- path.substring(1+len);
- }
- if ((endLine == 0) && (line != 0)) {
- endLine = line;
- }
- // XXX removed message/comment
- return new SourceLocation(new File(path), line, endLine, column);
- }
-
- // XXX reconsider convert if used in production code
- /**
- * Convert String to int using ascii and optionally
- * tolerating text
- * @param s the String to convert
- * @param permitText if true, pick a sequence of numbers
- * within a possibly non-numeric String
- * @param last if permitText, then if this is true the
- * last sequence is used - otherwise the first is used
- * XXX only default u.s. encodings..
- * @return -1 or value if a valid, totally-numeric positive string 0..MAX_WIDTH
- */
- private static int convert(String s) {
- return convert(s, false, false);
- }
-
- // XXX reconsider convert if used in production code
- /**
- * Convert String to int using ascii and optionally
- * tolerating text
- * @param s the String to convert
- * @param permitText if true, pick a sequence of numbers
- * within a possibly non-numeric String
- * @param last if permitText, then if this is true the
- * last sequence is used - otherwise the first is used
- * XXX only default u.s. encodings..
- * @return -1 or value if a valid, positive string 0..MAX_WIDTH
- */
- private static int convert(String s, boolean permitText,
- boolean first) {
- int result = -1;
- int last = -1;
- int max = s.length();
- boolean reading = false;
- for (int i = 0; i < max; i++) {
- char c = s.charAt(i);
- if ((c >= '0') && (c <= '9')) {
- if (-1 == result) { // prefix loop
- result = 0;
- reading = true;
- }
- result = ((result * 10) + (c - '0'));
- } else if (!permitText) {
- return -1;
- } else if (reading) { // from numeric -> non-numeric
- if (first) {
- return result;
- } else {
- last = result;
- }
- reading = false;
- }
- }
- if (permitText && !first && (-1 != last) && (-1 == result)) {
- result = last;
- }
- return ((0 < result) && (result < ISourceLocation.MAX_LINE) ? result : -1);
- }
-
- private BridgeUtil() {}
-
- /** @return String for status header, counting children passed/failed */
- public static String childString(IRunStatus runStatus, int numSkips, int numIncomplete) {
- if (null == runStatus) {
- return "((RunStatus) null)";
- }
- if (0 > numSkips) {
- numSkips = 0;
- }
- if (0 > numIncomplete) {
- numIncomplete = 0;
- }
- StringBuffer sb = new StringBuffer();
- if (RunValidator.NORMAL.runPassed(runStatus)) {
- sb.append("PASS ");
- } else {
- sb.append("FAIL ");
- }
- Object id = runStatus.getIdentifier();
- if (null != id) {
- sb.append(id.toString() + " ");
- }
- IRunStatus[] children = runStatus.getChildren();
- final int numChildren = (null == children ? 0 : children.length);
- final int numTests = numIncomplete + numChildren + numSkips;
- int numFails = 0;
- if (!LangUtil.isEmpty(children)) {
- for (int i = 0; i < children.length; i++) {
- if (!RunValidator.NORMAL.runPassed(children[i])) {
- numFails++;
- }
- }
- }
- final int numPass = children.length - numFails;
- sb.append(numTests + " tests");
- if (0 < numTests) {
- sb.append(" (");
- }
- if (0 < numSkips) {
- sb.append(numSkips + " skipped");
- if (0 < (numFails + numPass + numIncomplete)) {
- sb.append(", ");
- }
- }
- if (0 < numIncomplete) {
- sb.append(numIncomplete + " incomplete");
- if (0 < (numFails + numPass)) {
- sb.append(", ");
- }
- }
- if (0 < numFails) {
- sb.append(numFails + " failed");
- if (0 < numPass) {
- sb.append(", ");
- }
- }
- if (0 < numPass) {
- sb.append(numPass + " passed)");
- } else if (0 < numTests) {
- sb.append(")");
- }
- return sb.toString().trim();
- }
-
- /** @return String for status header */
- public static String toShortString(IRunStatus runStatus) {
- if (null == runStatus) {
- return "((RunStatus) null)";
- }
- StringBuffer sb = new StringBuffer();
- if (RunValidator.NORMAL.runPassed(runStatus)) {
- sb.append("PASS ");
- } else {
- sb.append("FAIL ");
- }
- Object id = runStatus.getIdentifier();
- if (null != id) {
- sb.append(id.toString() + " ");
- }
- sb.append(MessageUtil.renderCounts(runStatus));
- return sb.toString().trim();
- }
-
- }
|