Fix a nagging inconvenience from my IDE in running tests, due to working directory...
[zxing.git] / core / test / src / com / google / zxing / common / AbstractBlackBoxTestCase.java
index 44a7af7..16dc1bb 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright 2008 Google Inc.
+ * Copyright 2008 ZXing authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -36,10 +36,12 @@ import java.io.FilenameFilter;
 import java.io.IOException;
 import java.io.InputStreamReader;
 import java.util.Hashtable;
-import java.util.Vector;
+import java.util.List;
+import java.util.ArrayList;
+import java.nio.charset.Charset;
 
 /**
- * @author srowen@google.com (Sean Owen)
+ * @author Sean Owen
  * @author dswitkin@google.com (Daniel Switkin)
  */
 public abstract class AbstractBlackBoxTestCase extends TestCase {
@@ -60,14 +62,20 @@ public abstract class AbstractBlackBoxTestCase extends TestCase {
 
   private static class TestResult {
     private final int mustPassCount;
+    private final int tryHarderCount;
     private final float rotation;
-    TestResult(int mustPassCount, float rotation) {
+
+    TestResult(int mustPassCount, int tryHarderCount, float rotation) {
       this.mustPassCount = mustPassCount;
+      this.tryHarderCount = tryHarderCount;
       this.rotation = rotation;
     }
     public int getMustPassCount() {
       return mustPassCount;
     }
+    public int getTryHarderCount() {
+      return tryHarderCount;
+    }
     public float getRotation() {
       return rotation;
     }
@@ -76,25 +84,32 @@ public abstract class AbstractBlackBoxTestCase extends TestCase {
   private final File testBase;
   private final Reader barcodeReader;
   private final BarcodeFormat expectedFormat;
-  private Vector<TestResult> testResults;
+  private final List<TestResult> testResults;
 
-  protected AbstractBlackBoxTestCase(File testBase,
+  protected AbstractBlackBoxTestCase(String testBasePathSuffix,
                                      Reader barcodeReader,
                                      BarcodeFormat expectedFormat) {
+    // A little workaround to prevent aggravation in my IDE
+    File testBase = new File(testBasePathSuffix);
+    if (!testBase.exists()) {
+      // try starting with 'core' since the test base is often given as the project root
+      testBase = new File("core/" + testBasePathSuffix);
+    }
     this.testBase = testBase;
     this.barcodeReader = barcodeReader;
     this.expectedFormat = expectedFormat;
-    testResults = new Vector<TestResult>();
+    testResults = new ArrayList<TestResult>();
   }
 
   /**
    * Adds a new test for the current directory of images.
    *
    * @param mustPassCount The number of images which must decode for the test to pass.
+   * @param tryHarderCount The number of images which must pass using the try harder flag.
    * @param rotation The rotation in degrees clockwise to use for this test.
    */
-  protected void addTest(int mustPassCount, float rotation) {
-    testResults.add(new TestResult(mustPassCount, rotation));
+  protected void addTest(int mustPassCount, int tryHarderCount, float rotation) {
+    testResults.add(new TestResult(mustPassCount, tryHarderCount, rotation));
   }
 
   protected File[] getImageFiles() {
@@ -106,11 +121,17 @@ public abstract class AbstractBlackBoxTestCase extends TestCase {
     return barcodeReader;
   }
 
+  protected Hashtable<DecodeHintType, Object> getHints() {
+    return null;
+  }
+
   public void testBlackBox() throws IOException {
     assertFalse(testResults.isEmpty());
 
     File[] imageFiles = getImageFiles();
-    int[] passedCounts = new int[testResults.size()];
+    int testCount = testResults.size();
+    int[] passedCounts = new int[testCount];
+    int[] tryHarderCounts = new int[testCount];
     for (File testImage : imageFiles) {
       System.out.println("Starting " + testImage.getAbsolutePath());
 
@@ -121,66 +142,78 @@ public abstract class AbstractBlackBoxTestCase extends TestCase {
           testImageFileName.substring(0, testImageFileName.indexOf('.')) + ".txt");
       String expectedText = readFileAsString(expectedTextFile);
 
-      for (int x = 0; x < testResults.size(); x++) {
-        if (doTestOneImage(image, testResults.get(x).getRotation(), expectedText)) {
+      for (int x = 0; x < testCount; x++) {
+        float rotation = testResults.get(x).getRotation();
+        BufferedImage rotatedImage = rotateImage(image, rotation);
+        MonochromeBitmapSource source = new BufferedImageMonochromeBitmapSource(rotatedImage);
+        if (decode(source, rotation, expectedText, false)) {
           passedCounts[x]++;
         }
+        if (decode(source, rotation, expectedText, true)) {
+          tryHarderCounts[x]++;
+        }
       }
     }
 
-    for (int x = 0; x < testResults.size(); x++) {
-      System.out.println("Rotation " + testResults.get(x).getRotation() + " degrees: " + passedCounts[x] +
-          " of " + imageFiles.length + " images passed (" + testResults.get(x).getMustPassCount() +
+    // Print the results of all tests first
+    for (int x = 0; x < testCount; x++) {
+      System.out.println("Rotation " + testResults.get(x).getRotation() + " degrees:");
+      System.out.println("  " + passedCounts[x] + " of " + imageFiles.length + " images passed ("
+          + testResults.get(x).getMustPassCount() + " required)");
+      System.out.println("  " + tryHarderCounts[x] + " of " + imageFiles.length +
+          " images passed with try harder (" + testResults.get(x).getTryHarderCount() +
           " required)");
-      assertTrue("Rotation " + testResults.get(x).getRotation() + " degrees: Too many images failed",
+    }
+
+    // Then run through again and assert if any failed
+    for (int x = 0; x < testCount; x++) {
+      assertTrue("Rotation " + testResults.get(x).getRotation() +
+          " degrees: Too many images failed",
           passedCounts[x] >= testResults.get(x).getMustPassCount());
+      assertTrue("Try harder, Rotation " + testResults.get(x).getRotation() +
+          " degrees: Too many images failed",
+          tryHarderCounts[x] >= testResults.get(x).getTryHarderCount());
     }
   }
 
-  private boolean doTestOneImage(BufferedImage image, float rotationInDegrees, String expectedText) {
-    BufferedImage rotatedImage = rotateImage(image, rotationInDegrees);
-    MonochromeBitmapSource source = new BufferedImageMonochromeBitmapSource(rotatedImage);
+  private boolean decode(MonochromeBitmapSource source, float rotation, String expectedText,
+                         boolean tryHarder) {
     Result result;
+    String suffix = " (" + (tryHarder ? "try harder, " : "") + "rotation: " + rotation + ')';
+
     try {
-      result = barcodeReader.decode(source);
+      Hashtable<DecodeHintType, Object> hints = getHints();
+      if (tryHarder) {
+        if (hints == null) {
+          hints = TRY_HARDER_HINT;
+        } else {
+          hints.put(DecodeHintType.TRY_HARDER, Boolean.TRUE);
+        }
+      }
+      result = barcodeReader.decode(source, hints);
     } catch (ReaderException re) {
-      System.out.println(re + " (rotation: " + rotationInDegrees + ')');
+      System.out.println(re + suffix);
       return false;
     }
 
     if (!expectedFormat.equals(result.getBarcodeFormat())) {
       System.out.println("Format mismatch: expected '" + expectedFormat + "' but got '" +
-          result.getBarcodeFormat() + "' (rotation: " + rotationInDegrees + ')');
+          result.getBarcodeFormat() + '\'' + suffix);
       return false;
     }
 
     String resultText = result.getText();
     if (!expectedText.equals(resultText)) {
       System.out.println("Mismatch: expected '" + expectedText + "' but got '" + resultText +
-          "' (rotation: " + rotationInDegrees + ')');
+          '\'' +  suffix);
       return false;
     }
-
-    // Try "try harder" mode
-    try {
-      result = barcodeReader.decode(source, TRY_HARDER_HINT);
-    } catch (ReaderException re) {
-      fail("Normal mode succeeded but \"try harder\" failed (rotation: " + rotationInDegrees + ')');
-      return false;
-    }
-    if (!expectedFormat.equals(result.getBarcodeFormat())) {
-      System.out.println("Try Harder Format mismatch: expected '" + expectedFormat + "' but got '" +
-          result.getBarcodeFormat() + "' (rotation: " + rotationInDegrees + ')');
-    } else if (!expectedText.equals(resultText)) {
-      System.out.println("Try Harder Mismatch: expected '" + expectedText + "' but got '" +
-          resultText + "' (rotation: " + rotationInDegrees + ')');
-    }
     return true;
   }
 
   private static String readFileAsString(File file) throws IOException {
     StringBuilder result = new StringBuilder((int) file.length());
-    InputStreamReader reader = new InputStreamReader(new FileInputStream(file), "UTF-8");
+    InputStreamReader reader = new InputStreamReader(new FileInputStream(file), Charset.forName("UTF8"));
     try {
       char[] buffer = new char[256];
       int charsRead;
@@ -198,7 +231,7 @@ public abstract class AbstractBlackBoxTestCase extends TestCase {
       return original;
     } else {
       AffineTransform at = new AffineTransform();
-      at.rotate(Math.toRadians(degrees), original.getWidth() / 2.0f, original.getHeight() / 2.0f);
+      at.rotate(Math.toRadians(degrees), original.getWidth() / 2.0, original.getHeight() / 2.0);
       BufferedImageOp op = new AffineTransformOp(at, AffineTransformOp.TYPE_BICUBIC);
       return op.filter(original, null);
     }