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(String testBasePathSuffix,
91 BarcodeFormat expectedFormat) {
92 // A little workaround to prevent aggravation in my IDE
93 File testBase = new File(testBasePathSuffix);
94 if (!testBase.exists()) {
95 // try starting with 'core' since the test base is often given as the project root
96 testBase = new File("core/" + testBasePathSuffix);
98 this.testBase = testBase;
99 this.barcodeReader = barcodeReader;
100 this.expectedFormat = expectedFormat;
101 testResults = new ArrayList<TestResult>();
105 * Adds a new test for the current directory of images.
107 * @param mustPassCount The number of images which must decode for the test to pass.
108 * @param tryHarderCount The number of images which must pass using the try harder flag.
109 * @param rotation The rotation in degrees clockwise to use for this test.
111 protected void addTest(int mustPassCount, int tryHarderCount, float rotation) {
112 testResults.add(new TestResult(mustPassCount, tryHarderCount, rotation));
115 protected File[] getImageFiles() {
116 assertTrue("Please run from the 'core' directory", testBase.exists());
117 return testBase.listFiles(IMAGE_NAME_FILTER);
120 protected Reader getReader() {
121 return barcodeReader;
124 protected Hashtable<DecodeHintType, Object> getHints() {
128 public void testBlackBox() throws IOException {
129 assertFalse(testResults.isEmpty());
131 File[] imageFiles = getImageFiles();
132 int testCount = testResults.size();
133 int[] passedCounts = new int[testCount];
134 int[] tryHarderCounts = new int[testCount];
135 for (File testImage : imageFiles) {
136 System.out.println("Starting " + testImage.getAbsolutePath());
138 BufferedImage image = ImageIO.read(testImage);
140 String testImageFileName = testImage.getName();
141 File expectedTextFile = new File(testBase,
142 testImageFileName.substring(0, testImageFileName.indexOf('.')) + ".txt");
143 String expectedText = readFileAsString(expectedTextFile);
145 for (int x = 0; x < testCount; x++) {
146 float rotation = testResults.get(x).getRotation();
147 BufferedImage rotatedImage = rotateImage(image, rotation);
148 MonochromeBitmapSource source = new BufferedImageMonochromeBitmapSource(rotatedImage);
149 if (decode(source, rotation, expectedText, false)) {
152 if (decode(source, rotation, expectedText, true)) {
153 tryHarderCounts[x]++;
158 // Print the results of all tests first
159 for (int x = 0; x < testCount; x++) {
160 System.out.println("Rotation " + testResults.get(x).getRotation() + " degrees:");
161 System.out.println(" " + passedCounts[x] + " of " + imageFiles.length + " images passed ("
162 + testResults.get(x).getMustPassCount() + " required)");
163 System.out.println(" " + tryHarderCounts[x] + " of " + imageFiles.length +
164 " images passed with try harder (" + testResults.get(x).getTryHarderCount() +
168 // Then run through again and assert if any failed
169 for (int x = 0; x < testCount; x++) {
170 assertTrue("Rotation " + testResults.get(x).getRotation() +
171 " degrees: Too many images failed",
172 passedCounts[x] >= testResults.get(x).getMustPassCount());
173 assertTrue("Try harder, Rotation " + testResults.get(x).getRotation() +
174 " degrees: Too many images failed",
175 tryHarderCounts[x] >= testResults.get(x).getTryHarderCount());
179 private boolean decode(MonochromeBitmapSource source, float rotation, String expectedText,
182 String suffix = " (" + (tryHarder ? "try harder, " : "") + "rotation: " + rotation + ')';
185 Hashtable<DecodeHintType, Object> hints = getHints();
188 hints = TRY_HARDER_HINT;
190 hints.put(DecodeHintType.TRY_HARDER, Boolean.TRUE);
193 result = barcodeReader.decode(source, hints);
194 } catch (ReaderException re) {
195 System.out.println(re + suffix);
199 if (!expectedFormat.equals(result.getBarcodeFormat())) {
200 System.out.println("Format mismatch: expected '" + expectedFormat + "' but got '" +
201 result.getBarcodeFormat() + '\'' + suffix);
205 String resultText = result.getText();
206 if (!expectedText.equals(resultText)) {
207 System.out.println("Mismatch: expected '" + expectedText + "' but got '" + resultText +
214 private static String readFileAsString(File file) throws IOException {
215 StringBuilder result = new StringBuilder((int) file.length());
216 InputStreamReader reader = new InputStreamReader(new FileInputStream(file), Charset.forName("UTF8"));
218 char[] buffer = new char[256];
220 while ((charsRead = reader.read(buffer)) > 0) {
221 result.append(buffer, 0, charsRead);
226 return result.toString();
229 protected static BufferedImage rotateImage(BufferedImage original, float degrees) {
230 if (degrees == 0.0f) {
233 AffineTransform at = new AffineTransform();
234 at.rotate(Math.toRadians(degrees), original.getWidth() / 2.0, original.getHeight() / 2.0);
235 BufferedImageOp op = new AffineTransformOp(at, AffineTransformOp.TYPE_BICUBIC);
236 return op.filter(original, null);