2 * Copyright 2008 ZXing authors
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 package com.google.zxing.common;
19 import com.google.zxing.BarcodeFormat;
20 import com.google.zxing.DecodeHintType;
21 import com.google.zxing.MonochromeBitmapSource;
22 import com.google.zxing.Reader;
23 import com.google.zxing.ReaderException;
24 import com.google.zxing.Result;
25 import com.google.zxing.client.j2se.BufferedImageMonochromeBitmapSource;
26 import junit.framework.TestCase;
28 import javax.imageio.ImageIO;
29 import java.awt.geom.AffineTransform;
30 import java.awt.image.AffineTransformOp;
31 import java.awt.image.BufferedImage;
32 import java.awt.image.BufferedImageOp;
34 import java.io.FileInputStream;
35 import java.io.FilenameFilter;
36 import java.io.IOException;
37 import java.io.InputStreamReader;
38 import java.util.Hashtable;
39 import java.util.List;
40 import java.util.ArrayList;
41 import java.nio.charset.Charset;
45 * @author dswitkin@google.com (Daniel Switkin)
47 public abstract class AbstractBlackBoxTestCase extends TestCase {
49 protected static final Hashtable<DecodeHintType, Object> TRY_HARDER_HINT;
51 TRY_HARDER_HINT = new Hashtable<DecodeHintType, Object>();
52 TRY_HARDER_HINT.put(DecodeHintType.TRY_HARDER, Boolean.TRUE);
55 private static final FilenameFilter IMAGE_NAME_FILTER = new FilenameFilter() {
56 public boolean accept(File dir, String name) {
57 String lowerCase = name.toLowerCase();
58 return lowerCase.endsWith(".jpg") || lowerCase.endsWith(".jpeg") ||
59 lowerCase.endsWith(".gif") || lowerCase.endsWith(".png");
63 private static class TestResult {
64 private final int mustPassCount;
65 private final int tryHarderCount;
66 private final float rotation;
68 TestResult(int mustPassCount, int tryHarderCount, float rotation) {
69 this.mustPassCount = mustPassCount;
70 this.tryHarderCount = tryHarderCount;
71 this.rotation = rotation;
73 public int getMustPassCount() {
76 public int getTryHarderCount() {
77 return tryHarderCount;
79 public float getRotation() {
84 private final File testBase;
85 private final Reader barcodeReader;
86 private final BarcodeFormat expectedFormat;
87 private final List<TestResult> testResults;
89 protected AbstractBlackBoxTestCase(File testBase,
91 BarcodeFormat expectedFormat) {
92 this.testBase = testBase;
93 this.barcodeReader = barcodeReader;
94 this.expectedFormat = expectedFormat;
95 testResults = new ArrayList<TestResult>();
99 * Adds a new test for the current directory of images.
101 * @param mustPassCount The number of images which must decode for the test to pass.
102 * @param tryHarderCount The number of images which must pass using the try harder flag.
103 * @param rotation The rotation in degrees clockwise to use for this test.
105 protected void addTest(int mustPassCount, int tryHarderCount, float rotation) {
106 testResults.add(new TestResult(mustPassCount, tryHarderCount, rotation));
109 protected File[] getImageFiles() {
110 assertTrue("Please run from the 'core' directory", testBase.exists());
111 return testBase.listFiles(IMAGE_NAME_FILTER);
114 protected Reader getReader() {
115 return barcodeReader;
118 protected Hashtable<DecodeHintType, Object> getHints() {
122 public void testBlackBox() throws IOException {
123 assertFalse(testResults.isEmpty());
125 File[] imageFiles = getImageFiles();
126 int testCount = testResults.size();
127 int[] passedCounts = new int[testCount];
128 int[] tryHarderCounts = new int[testCount];
129 for (File testImage : imageFiles) {
130 System.out.println("Starting " + testImage.getAbsolutePath());
132 BufferedImage image = ImageIO.read(testImage);
134 String testImageFileName = testImage.getName();
135 File expectedTextFile = new File(testBase,
136 testImageFileName.substring(0, testImageFileName.indexOf('.')) + ".txt");
137 String expectedText = readFileAsString(expectedTextFile);
139 for (int x = 0; x < testCount; x++) {
140 float rotation = testResults.get(x).getRotation();
141 BufferedImage rotatedImage = rotateImage(image, rotation);
142 MonochromeBitmapSource source = new BufferedImageMonochromeBitmapSource(rotatedImage);
143 if (decode(source, rotation, expectedText, false)) {
146 if (decode(source, rotation, expectedText, true)) {
147 tryHarderCounts[x]++;
152 // Print the results of all tests first
153 for (int x = 0; x < testCount; x++) {
154 System.out.println("Rotation " + testResults.get(x).getRotation() + " degrees:");
155 System.out.println(" " + passedCounts[x] + " of " + imageFiles.length + " images passed ("
156 + testResults.get(x).getMustPassCount() + " required)");
157 System.out.println(" " + tryHarderCounts[x] + " of " + imageFiles.length +
158 " images passed with try harder (" + testResults.get(x).getTryHarderCount() +
162 // Then run through again and assert if any failed
163 for (int x = 0; x < testCount; x++) {
164 assertTrue("Rotation " + testResults.get(x).getRotation() +
165 " degrees: Too many images failed",
166 passedCounts[x] >= testResults.get(x).getMustPassCount());
167 assertTrue("Try harder, Rotation " + testResults.get(x).getRotation() +
168 " degrees: Too many images failed",
169 tryHarderCounts[x] >= testResults.get(x).getTryHarderCount());
173 private boolean decode(MonochromeBitmapSource source, float rotation, String expectedText,
176 String suffix = " (" + (tryHarder ? "try harder, " : "") + "rotation: " + rotation + ')';
179 Hashtable<DecodeHintType, Object> hints = getHints();
182 hints = TRY_HARDER_HINT;
184 hints.put(DecodeHintType.TRY_HARDER, Boolean.TRUE);
187 result = getReader().decode(source, hints);
188 } catch (ReaderException re) {
189 System.out.println(re + suffix);
193 if (!expectedFormat.equals(result.getBarcodeFormat())) {
194 System.out.println("Format mismatch: expected '" + expectedFormat + "' but got '" +
195 result.getBarcodeFormat() + "'" + suffix);
199 String resultText = result.getText();
200 if (!expectedText.equals(resultText)) {
201 System.out.println("Mismatch: expected '" + expectedText + "' but got '" + resultText +
208 private static String readFileAsString(File file) throws IOException {
209 StringBuilder result = new StringBuilder((int) file.length());
210 InputStreamReader reader = new InputStreamReader(new FileInputStream(file), Charset.forName("UTF8"));
212 char[] buffer = new char[256];
214 while ((charsRead = reader.read(buffer)) > 0) {
215 result.append(buffer, 0, charsRead);
220 return result.toString();
223 protected static BufferedImage rotateImage(BufferedImage original, float degrees) {
224 if (degrees == 0.0f) {
227 AffineTransform at = new AffineTransform();
228 at.rotate(Math.toRadians(degrees), original.getWidth() / 2.0f, original.getHeight() / 2.0f);
229 BufferedImageOp op = new AffineTransformOp(at, AffineTransformOp.TYPE_BICUBIC);
230 return op.filter(original, null);