This is an automated email from the ASF dual-hosted git repository.
rec pushed a commit to branch
refactoring/UIMA-6373-Format-UIMA-Core-Java-SDK-codebase
in repository https://gitbox.apache.org/repos/asf/uima-uimaj.git
The following commit(s) were added to
refs/heads/refactoring/UIMA-6373-Format-UIMA-Core-Java-SDK-codebase by this
push:
new d9e96ba [UIMA-6373] Format UIMA Core Java SDK codebase
d9e96ba is described below
commit d9e96ba9f191b1441a77257eefb62047e91e33a4
Author: Richard Eckart de Castilho <[email protected]>
AuthorDate: Thu Feb 10 14:51:20 2022 +0100
[UIMA-6373] Format UIMA Core Java SDK codebase
- Auto-format
---
.../uima/test/junit_extension/FileCompare.java | 177 +++++++++++----------
.../uima/test/junit_extension/JUnitTestRunner.java | 12 +-
.../test/junit_extension/ManageOutputDevice.java | 21 +--
.../PrintExceptionsWhenRunFromCommandLineRule.java | 34 ++--
.../test/junit_extension/UIMAResultPrinter.java | 5 +-
5 files changed, 131 insertions(+), 118 deletions(-)
diff --git
a/uimaj-test-util/src/main/java/org/apache/uima/test/junit_extension/FileCompare.java
b/uimaj-test-util/src/main/java/org/apache/uima/test/junit_extension/FileCompare.java
index fb22e9b..dded4e6 100644
---
a/uimaj-test-util/src/main/java/org/apache/uima/test/junit_extension/FileCompare.java
+++
b/uimaj-test-util/src/main/java/org/apache/uima/test/junit_extension/FileCompare.java
@@ -31,8 +31,8 @@ import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
- * FileCompare class provides a several methods, which compare two files or
input streams.
- * Most methods are static.
+ * FileCompare class provides a several methods, which compare two files or
input streams. Most
+ * methods are static.
*
* It has a facility to incorporate a regex ignore-differences filter
*
@@ -43,11 +43,11 @@ public class FileCompare {
* TODO Currently only tags containing word characters [a-zA-Z_0-9] are
recognised.
*/
// match "<" followed by 1 or more word_chars followed by ">" followed by
"</" followed by
- // (presumably) the same 1 or more word_chars followed by ">"
+ // (presumably) the same 1 or more word_chars followed by ">"
private static final String EMPTY_TAG_REGEX = "(<([\\w]+)>[\\s]*</[\\w]+>)";
private static Pattern emptyTagPattern = Pattern.compile(EMPTY_TAG_REGEX);
-
+
// matches cr if it is followed by a new-line, will be repl with just a new
line
private static Pattern crnlPattern = Pattern.compile("\\r(?=\\n)");
@@ -60,12 +60,13 @@ public class FileCompare {
* filename of the second file
* @return - true if the files have the same content
*
- * @throws IOException -
+ * @throws IOException
+ * -
*/
public static boolean compare(String filename1, String filename2) throws
IOException {
try (InputStream file1 = new FileInputStream(filename1);
- InputStream file2 = new FileInputStream(filename2)) {
+ InputStream file2 = new FileInputStream(filename2)) {
// create file input stream of the two bytes
return compare(file1, file2);
@@ -82,18 +83,18 @@ public class FileCompare {
* second file
* @return - true if the files have the same content
*
- * @throws IOException -
+ * @throws IOException
+ * -
*/
public static boolean compare(File file1, File file2) throws IOException {
try (InputStream inputStream1 = new FileInputStream(file1);
- InputStream inputStream2 = new FileInputStream(file2)) {
+ InputStream inputStream2 = new FileInputStream(file2)) {
// create file input stream of the two bytes
return compare(inputStream1, inputStream2);
}
}
-
/**
* compares two files and return true if the files have the same content.
*
@@ -104,7 +105,8 @@ public class FileCompare {
*
* @return - true if the content is the same
*
- * @throws IOException -
+ * @throws IOException
+ * -
*/
public static boolean compare(String filename1, InputStream in) throws
IOException {
try (InputStream file1 = new FileInputStream(filename1)) {
@@ -145,7 +147,7 @@ public class FileCompare {
}
}
}
-
+
// eof on in1
in2byte = in2.read();
while (in2byte != -1) {
@@ -156,16 +158,19 @@ public class FileCompare {
in2byte = in2.read();
}
if (in2byte != -1) {
- return false; // in2 had more non-whitespace chars after in1 end of
file
+ return false; // in2 had more non-whitespace chars after in1 end of
file
}
}
return true;
}
-
+
/**
* Compare 2 strings, ignoring whitespace characters
- * @param in1 -
- * @param in2 -
+ *
+ * @param in1
+ * -
+ * @param in2
+ * -
* @return -
*/
public static boolean compareStrings(String in1, String in2) {
@@ -173,27 +178,27 @@ public class FileCompare {
int i1 = 0;
int i2 = 0;
-
+
while (i1 < in1.length()) {
-
- c1 = in1.charAt(i1 ++);
+
+ c1 = in1.charAt(i1++);
// check if char is whitespace, and skip it
if (Character.isWhitespace(c1)) {
continue;
}
-
+
while (true) {
if (i2 >= in2.length()) {
- return false; // ran off the end of string 2
+ return false; // ran off the end of string 2
}
- c2 = in2.charAt(i2 ++);
+ c2 = in2.charAt(i2++);
if (!Character.isWhitespace(c2)) {
break;
}
}
-
+
if (c1 != c2) {
return false;
}
@@ -210,7 +215,8 @@ public class FileCompare {
* @param filename2
* Filename of the second XML file.
* @return -
- * @throws IOException -
+ * @throws IOException
+ * -
*/
public static boolean compareXML(String filename1, String filename2) throws
IOException {
File file1 = null;
@@ -248,23 +254,26 @@ public class FileCompare {
}
/**
- * Compares two files and returns true, if both have the same content, after
- * filtering using the supplied Pattern.
- * In addition,
- * \r\n is normalized to \n,
- * multiple spaces and tabs are normalized to a single space
+ * Compares two files and returns true, if both have the same content, after
filtering using the
+ * supplied Pattern. In addition,
+ * <ul>
+ * <li>\r\n is normalized to \n,</li>
+ * <li>multiple spaces and tabs are normalized to a single space</li>
+ * </ul>
*
* @param filename1
* Filename of the first XML file.
* @param filename2
* Filename of the second XML file.
- * @param pattern
- * an instance of Pattern which matches all substrings which should
be filtered out of the match
+ * @param pattern
+ * an instance of Pattern which matches all substrings which should
be filtered out of
+ * the match
* @return true, if both have the same content, after filtering using the
supplied Pattern.
- * @throws IOException -
+ * @throws IOException
+ * -
*/
public static boolean compareWithFilter(String filename1, String filename2,
Pattern pattern)
- throws IOException {
+ throws IOException {
File file1 = null;
File file2 = null;
@@ -277,29 +286,34 @@ public class FileCompare {
// read files into strings
s1 = file2String(file1);
s2 = file2String(file2);
-
+
return compareStringsWithFilter(s1, s2, pattern);
- }
+ }
// match at least 2 spaces
private static final Pattern multipleWhiteSpace = Pattern.compile("[
\\t]{2,}");
-
+
// match nl space nl
private static final Pattern emptyLinePattern = Pattern.compile("(?m)^ $");
-
+
// match 2 or more nl's in a row
private static final Pattern multipleNlPattern = Pattern.compile("\\n{2,}");
-
+
/**
- * Compare 2 strings, showing where they differ in output to system.out,
after
- * doing filtering:
- * normalize cr nl to nl
- * normalize <xmltag:> </xmltag> to <xmltag/>
- * normalize by applying supplied Pattern and deleting anything it matches
- * normalize by converting all 2 or more spaces/tabs to just 1 space
- * @param s1 -
- * @param s2 -
- * @param pattern -
+ * Compare 2 strings, showing where they differ in output to system.out,
after doing filtering:
+ * <ul>
+ * <li>normalize cr nl to nl</li>
+ * <li>normalize <xmltag:> </xmltag> to <xmltag/></li>
+ * <li>normalize by applying supplied Pattern and deleting anything it
matches</li>
+ * <li>normalize by converting all 2 or more spaces/tabs to just 1 space</li>
+ * </ul>
+ *
+ * @param s1
+ * -
+ * @param s2
+ * -
+ * @param pattern
+ * -
* @return -
*/
@@ -323,20 +337,20 @@ public class FileCompare {
// apply nl + spaces + nl -> nl nl
s1 = emptyLinePattern.matcher(s1).replaceAll("");
s2 = emptyLinePattern.matcher(s2).replaceAll("");
-
+
// apply nl nl -> nl
-
+
s1 = multipleNlPattern.matcher(s1).replaceAll("\n");
s2 = multipleNlPattern.matcher(s2).replaceAll("\n");
-
+
// apply get rid of trailing nl
-
+
s1 = removeTrailingNl(s1);
s2 = removeTrailingNl(s2);
return compareStringsWithMsg(s1, s2);
}
-
+
private static String removeTrailingNl(String s) {
int i = s.length() - 1;
if (i >= 0 && s.charAt(i) == '\n') {
@@ -344,13 +358,16 @@ public class FileCompare {
}
return s;
}
-
+
/**
- * Compare two strings, give message indicating where they miscompare,
including
- * approx 10 chars before and after the first miscompare, for context
- * @param s1 first string to compare
- * @param s2 second string to compare
- * @return true if strings have the same charactersS
+ * Compare two strings, give message indicating where they miscompare,
including approx 10 chars
+ * before and after the first miscompare, for context
+ *
+ * @param s1
+ * first string to compare
+ * @param s2
+ * second string to compare
+ * @return true if strings have the same charactersS
*/
public static boolean compareStringsWithMsg(String s1, String s2) {
@@ -358,29 +375,29 @@ public class FileCompare {
for (int i = 0; i < maxI; i++) {
if (s1.charAt(i) != s2.charAt(i)) {
System.out.println("Error: strings differ starting at char: " + i);
- System.out.println("Error: string 1 = " + s1.substring(Math.max(0,
i-100), Math.min(s1.length(), i+100)));
- System.out.println("Error: string 2 = " + s2.substring(Math.max(0,
i-100), Math.min(s2.length(), i+100)));
+ System.out.println("Error: string 1 = "
+ + s1.substring(Math.max(0, i - 100), Math.min(s1.length(), i +
100)));
+ System.out.println("Error: string 2 = "
+ + s2.substring(Math.max(0, i - 100), Math.min(s2.length(), i +
100)));
return false;
}
}
-
-
-
-
+
if (s1.length() != s2.length()) {
System.out.println("Error: strings are different length");
System.out.println(" s1 length = " + s1.length() + "; s2 length = " +
s2.length());
return false;
- }
+ }
return true;
}
-
+
/**
* Helper method that replaces empty XML tags in long notation with the
corresponding short form.
*
* @param xml
* The XML file where the empty tags are to be replaced as string.
- * @param filename -
+ * @param filename
+ * -
* @return The XML file with short empty tags as string.
*/
private static String shortenEmptyTags(String xml, String filename) {
@@ -419,29 +436,29 @@ public class FileCompare {
* @throws IOException
* Various I/O errors. '
*
- * TODO: This is duplicated from org.apache.uima.internal.util.FileUtils in
the uimaj-core
- * package. We can't have a compile dependency on uimaj-core since that
introduces a cycle. Not
- * sure what the best way of handling this is.
+ * TODO: This is duplicated from
org.apache.uima.internal.util.FileUtils in the
+ * uimaj-core package. We can't have a compile dependency on
uimaj-core since that
+ * introduces a cycle. Not sure what the best way of handling this
is.
*/
public static String file2String(File file) throws IOException {
- return reader2String(
- new FileReader(file),
- (int) file.length());
+ return reader2String(new FileReader(file), (int) file.length());
}
-
+
/**
* Read a bufferedReader into a string, using the default platform encoding.
*
- * @param reader to be read in
- * @param bufSize - size of stream, in bytes. Size in chars is ≤ size in
bytes, because
- * chars take 1 or more bytes to encode.
+ * @param reader
+ * to be read in
+ * @param bufSize
+ * - size of stream, in bytes. Size in chars is ≤ size in bytes,
because chars take 1
+ * or more bytes to encode.
* @return String The contents of the stream.
* @throws IOException
* Various I/O errors.
- *
- * TODO: This is duplicated from org.apache.uima.internal.util.FileUtils in
the uimaj-core
- * package. We can't have a compile dependency on uimaj-core since that
introduces a cycle. Not
- * sure what the best way of handling this is.
+ *
+ * TODO: This is duplicated from
org.apache.uima.internal.util.FileUtils in the
+ * uimaj-core package. We can't have a compile dependency on
uimaj-core since that
+ * introduces a cycle. Not sure what the best way of handling this
is.
*/
public static String reader2String(Reader reader, int bufSize) throws
IOException {
char[] buf = new char[bufSize];
diff --git
a/uimaj-test-util/src/main/java/org/apache/uima/test/junit_extension/JUnitTestRunner.java
b/uimaj-test-util/src/main/java/org/apache/uima/test/junit_extension/JUnitTestRunner.java
index 4879bf2..6203d85 100644
---
a/uimaj-test-util/src/main/java/org/apache/uima/test/junit_extension/JUnitTestRunner.java
+++
b/uimaj-test-util/src/main/java/org/apache/uima/test/junit_extension/JUnitTestRunner.java
@@ -224,8 +224,8 @@ public class JUnitTestRunner {
}
// print header
- resultWriter
-
.println("################################################################################################");
+ resultWriter.println(
+
"################################################################################################");
resultWriter.println("# TestSuite: " + suite.getName());
resultWriter.println("# Testcases: " + suite.countTestCases());
resultWriter.println("# Test candidate: " + testName);
@@ -234,8 +234,8 @@ public class JUnitTestRunner {
resultWriter.println("# Console output filename: " + consoleFileName);
resultWriter.println("# Test start directory: " +
System.getProperty("user.dir"));
resultWriter.println("# Test starter: " +
System.getProperty("user.name"));
- resultWriter.println("# OS: " + System.getProperty("os.name") + " "
- + System.getProperty("os.version"));
+ resultWriter.println(
+ "# OS: " + System.getProperty("os.name") + " " +
System.getProperty("os.version"));
resultWriter.println("# Command line run: " +
System.getProperty("isCommandLine", "false"));
// get current date and time
@@ -252,8 +252,8 @@ public class JUnitTestRunner {
resultWriter.println("# Test runs with java version: " +
System.getProperty("java.version"));
resultWriter.println("# JUnitTestRunner version: 1.2");
- resultWriter
-
.println("################################################################################################");
+ resultWriter.println(
+
"################################################################################################");
// run current test
TestResult results = aTestRunner.doRun(suite);
diff --git
a/uimaj-test-util/src/main/java/org/apache/uima/test/junit_extension/ManageOutputDevice.java
b/uimaj-test-util/src/main/java/org/apache/uima/test/junit_extension/ManageOutputDevice.java
index 12d7aa4..7e5a1bb 100644
---
a/uimaj-test-util/src/main/java/org/apache/uima/test/junit_extension/ManageOutputDevice.java
+++
b/uimaj-test-util/src/main/java/org/apache/uima/test/junit_extension/ManageOutputDevice.java
@@ -45,7 +45,8 @@ public class ManageOutputDevice {
*
* @param descriptor
* a full qualified filename, see {@link java.io.File#File(String
pathname)}
- * @throws FileNotFoundException -
+ * @throws FileNotFoundException
+ * -
*/
public static void setSysOutToFile(String descriptor) throws
FileNotFoundException {
File f = new File(descriptor);
@@ -55,8 +56,8 @@ public class ManageOutputDevice {
}
/**
- * sets the <code>System.out</code> to the value, which was set, when the
class was loaded by
- * the VM.
+ * sets the <code>System.out</code> to the value, which was set, when the
class was loaded by the
+ * VM.
*/
public static void setSysOutToDefault() {
System.setOut(sysOutPS);
@@ -72,8 +73,10 @@ public class ManageOutputDevice {
/**
* sets the <code>System.err</code> to a file based
<code>java.io.PrintStream</code>
*
- * @param descriptor -
- * @throws FileNotFoundException -
+ * @param descriptor
+ * -
+ * @throws FileNotFoundException
+ * -
*/
public static void setSysErrToFile(String descriptor) throws
FileNotFoundException {
File f = new File(descriptor);
@@ -83,8 +86,8 @@ public class ManageOutputDevice {
}
/**
- * sets the <code>System.err</code> to the value, which was set, when this
class was loaded by
- * the VM.
+ * sets the <code>System.err</code> to the value, which was set, when this
class was loaded by the
+ * VM.
*/
public static void setSysErrToDefault() {
System.setErr(sysErrPS);
@@ -107,8 +110,8 @@ public class ManageOutputDevice {
}
/**
- * sets the <code>System.err</code> and <code>System.out</code> to their
values, which were
- * set, when this class was loaded.
+ * sets the <code>System.err</code> and <code>System.out</code> to their
values, which were set,
+ * when this class was loaded.
*/
public static void setAllSystemOutputToDefault() {
setSysErrToDefault();
diff --git
a/uimaj-test-util/src/main/java/org/apache/uima/test/junit_extension/PrintExceptionsWhenRunFromCommandLineRule.java
b/uimaj-test-util/src/main/java/org/apache/uima/test/junit_extension/PrintExceptionsWhenRunFromCommandLineRule.java
index edd2932..71cbaa3 100644
---
a/uimaj-test-util/src/main/java/org/apache/uima/test/junit_extension/PrintExceptionsWhenRunFromCommandLineRule.java
+++
b/uimaj-test-util/src/main/java/org/apache/uima/test/junit_extension/PrintExceptionsWhenRunFromCommandLineRule.java
@@ -22,25 +22,19 @@ import org.junit.rules.TestRule;
import org.junit.runner.Description;
import org.junit.runners.model.Statement;
-public class PrintExceptionsWhenRunFromCommandLineRule
- implements TestRule
-{
+public class PrintExceptionsWhenRunFromCommandLineRule implements TestRule {
- @Override
- public Statement apply(Statement aBase, Description aDescription)
- {
- return new Statement()
- {
- @Override
- public void evaluate() throws Throwable
- {
- try {
- aBase.evaluate();
- }
- catch (Exception e) {
- JUnitExtension.handleException(e);
- }
- }
- };
- }
+ @Override
+ public Statement apply(Statement aBase, Description aDescription) {
+ return new Statement() {
+ @Override
+ public void evaluate() throws Throwable {
+ try {
+ aBase.evaluate();
+ } catch (Exception e) {
+ JUnitExtension.handleException(e);
+ }
+ }
+ };
+ }
}
diff --git
a/uimaj-test-util/src/main/java/org/apache/uima/test/junit_extension/UIMAResultPrinter.java
b/uimaj-test-util/src/main/java/org/apache/uima/test/junit_extension/UIMAResultPrinter.java
index dcd1602..b852173 100644
---
a/uimaj-test-util/src/main/java/org/apache/uima/test/junit_extension/UIMAResultPrinter.java
+++
b/uimaj-test-util/src/main/java/org/apache/uima/test/junit_extension/UIMAResultPrinter.java
@@ -151,9 +151,8 @@ public class UIMAResultPrinter extends ResultPrinter
implements TestListener {
} else {
getWriter().println();
getWriter().println("FAILURES!!!");
- getWriter().println(
- "Tests run: " + result.runCount() + ", Failures: " +
result.failureCount()
- + ", Errors: " + result.errorCount());
+ getWriter().println("Tests run: " + result.runCount() + ", Failures: "
+ + result.failureCount() + ", Errors: " + result.errorCount());
}
getWriter().println();
}
