git-svn-id: http://zxing.googlecode.com/svn/trunk@574 59b500cc-1b3d-0410-9834-0bbf25f...
[zxing.git] / core / test / src / com / google / zxing / common / AbstractBlackBoxTestCase.java
index 9bf121f..b66ef9c 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.
@@ -17,6 +17,7 @@
 package com.google.zxing.common;
 
 import com.google.zxing.BarcodeFormat;
+import com.google.zxing.DecodeHintType;
 import com.google.zxing.MonochromeBitmapSource;
 import com.google.zxing.Reader;
 import com.google.zxing.ReaderException;
@@ -25,92 +26,175 @@ import com.google.zxing.client.j2se.BufferedImageMonochromeBitmapSource;
 import junit.framework.TestCase;
 
 import javax.imageio.ImageIO;
+import java.awt.geom.AffineTransform;
+import java.awt.image.AffineTransformOp;
 import java.awt.image.BufferedImage;
+import java.awt.image.BufferedImageOp;
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.FilenameFilter;
 import java.io.IOException;
 import java.io.InputStreamReader;
-import java.net.URL;
+import java.util.Hashtable;
+import java.util.List;
+import java.util.ArrayList;
 
 /**
  * @author srowen@google.com (Sean Owen)
+ * @author dswitkin@google.com (Daniel Switkin)
  */
 public abstract class AbstractBlackBoxTestCase extends TestCase {
 
+  protected static final Hashtable<DecodeHintType, Object> TRY_HARDER_HINT;
+  static {
+    TRY_HARDER_HINT = new Hashtable<DecodeHintType, Object>();
+    TRY_HARDER_HINT.put(DecodeHintType.TRY_HARDER, Boolean.TRUE);
+  }
+
   private static final FilenameFilter IMAGE_NAME_FILTER = new FilenameFilter() {
     public boolean accept(File dir, String name) {
       String lowerCase = name.toLowerCase();
-      return
-          lowerCase.endsWith(".jpg") || lowerCase.endsWith(".jpeg") ||
-              lowerCase.endsWith(".gif") || lowerCase.endsWith(".png") ||
-              lowerCase.endsWith(".url");
+      return lowerCase.endsWith(".jpg") || lowerCase.endsWith(".jpeg") ||
+             lowerCase.endsWith(".gif") || lowerCase.endsWith(".png");
     }
   };
 
+  private static class TestResult {
+    private final int mustPassCount;
+    private final int tryHarderCount;
+    private final 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;
+    }
+  }
+
   private final File testBase;
   private final Reader barcodeReader;
-  private final double passPercent;
   private final BarcodeFormat expectedFormat;
+  private final List<TestResult> testResults;
 
   protected AbstractBlackBoxTestCase(File testBase,
                                      Reader barcodeReader,
-                                     double passPercent,
                                      BarcodeFormat expectedFormat) {
     this.testBase = testBase;
     this.barcodeReader = barcodeReader;
-    this.passPercent = passPercent;
     this.expectedFormat = expectedFormat;
+    testResults = new ArrayList<TestResult>();
   }
 
-  public void testBlackBox() throws IOException {
+  /**
+   * 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, int tryHarderCount, float rotation) {
+    testResults.add(new TestResult(mustPassCount, tryHarderCount, rotation));
+  }
 
+  protected File[] getImageFiles() {
     assertTrue("Please run from the 'core' directory", testBase.exists());
+    return testBase.listFiles(IMAGE_NAME_FILTER);
+  }
+
+  protected Reader getReader() {
+    return barcodeReader;
+  }
+
+  public void testBlackBox() throws IOException {
+    assertFalse(testResults.isEmpty());
 
-    File[] imageFiles = testBase.listFiles(IMAGE_NAME_FILTER);
-    int passedCount = 0;
+    File[] imageFiles = getImageFiles();
+    int testCount = testResults.size();
+    int[] passedCounts = new int[testCount];
+    int[] tryHarderCounts = new int[testCount];
     for (File testImage : imageFiles) {
       System.out.println("Starting " + testImage.getAbsolutePath());
 
-      BufferedImage image;
-      if (testImage.getName().endsWith(".url")) {
-        String urlString = readFileAsString(testImage);
-        image = ImageIO.read(new URL(urlString));
-      } else {
-        image = ImageIO.read(testImage);
-      }
-      MonochromeBitmapSource source = new BufferedImageMonochromeBitmapSource(image);
-      Result result;
-      try {
-        result = barcodeReader.decode(source);
-      } catch (ReaderException re) {
-        System.out.println(re);
-        continue;
-      }
-
-      assertEquals(expectedFormat, result.getBarcodeFormat());
+      BufferedImage image = ImageIO.read(testImage);
 
       String testImageFileName = testImage.getName();
-      File expectedTextFile =
-          new File(testBase, testImageFileName.substring(0, testImageFileName.indexOf('.')) + ".txt");
+      File expectedTextFile = new File(testBase,
+          testImageFileName.substring(0, testImageFileName.indexOf('.')) + ".txt");
       String expectedText = readFileAsString(expectedTextFile);
-      String resultText = result.getText();
 
-      if (expectedText.equals(resultText)) {
-        passedCount++;
-      } else {
-        System.out.println("Mismatch: expected '" + expectedText + "' but got '" + resultText + '\'');
+      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]++;
+        }
       }
+    }
+
+    // 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)");
+    }
+
+    // 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 decode(MonochromeBitmapSource source, float rotation, String expectedText,
+                         boolean tryHarder) {
+    Result result;
+    String suffix = " (" + (tryHarder ? "try harder, " : "") + "rotation: " + rotation + ')';
+
+    try {
+      result = barcodeReader.decode(source, tryHarder ? TRY_HARDER_HINT : null);
+    } catch (ReaderException re) {
+      System.out.println(re + suffix);
+      return false;
+    }
+
+    if (!expectedFormat.equals(result.getBarcodeFormat())) {
+      System.out.println("Format mismatch: expected '" + expectedFormat + "' but got '" +
+          result.getBarcodeFormat() + "'" + suffix);
+      return false;
     }
 
-    System.out.println(passedCount + " of " + imageFiles.length + " images passed");
-    assertTrue("Too many images failed", passedCount >= (int) (imageFiles.length * passPercent));
+    String resultText = result.getText();
+    if (!expectedText.equals(resultText)) {
+      System.out.println("Mismatch: expected '" + expectedText + "' but got '" + resultText +
+          "'" +  suffix);
+      return false;
+    }
+    return true;
   }
 
   private static String readFileAsString(File file) throws IOException {
-    StringBuilder result = new StringBuilder();
-    InputStreamReader reader = new InputStreamReader(new FileInputStream(file), "UTF-8");
+    StringBuilder result = new StringBuilder((int) file.length());
+    InputStreamReader reader = new InputStreamReader(new FileInputStream(file), "UTF8");
     try {
       char[] buffer = new char[256];
       int charsRead;
@@ -123,4 +207,15 @@ public abstract class AbstractBlackBoxTestCase extends TestCase {
     return result.toString();
   }
 
+  protected static BufferedImage rotateImage(BufferedImage original, float degrees) {
+    if (degrees == 0.0f) {
+      return original;
+    } else {
+      AffineTransform at = new AffineTransform();
+      at.rotate(Math.toRadians(degrees), original.getWidth() / 2.0f, original.getHeight() / 2.0f);
+      BufferedImageOp op = new AffineTransformOp(at, AffineTransformOp.TYPE_BICUBIC);
+      return op.filter(original, null);
+    }
+  }
+
 }
\ No newline at end of file