moving aroudn test cases for integration

tests/common/AbstractNegativeBlackBoxTestCase.java

@@ -0,0 +1,159 @@
+/*
+ * 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.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.zxing.common;
+
+import com.google.zxing.BinaryBitmap;
+import com.google.zxing.BufferedImageLuminanceSource;
+import com.google.zxing.DecodeHintType;
+import com.google.zxing.LuminanceSource;
+import com.google.zxing.MultiFormatReader;
+import com.google.zxing.ReaderException;
+import com.google.zxing.RXingResult;
+import org.junit.Test;
+
+import javax.imageio.ImageIO;
+import java.awt.image.BufferedImage;
+import java.io.IOException;
+import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.EnumMap;
+import java.util.List;
+import java.util.Map;
+import java.util.logging.Logger;
+
+/**
+ * This abstract class looks for negative results, i.e. it only allows a certain number of false
+ * positives in images which should not decode. This helps ensure that we are not too lenient.
+ *
+ * @author dswitkin@google.com (Daniel Switkin)
+ */
+public abstract class AbstractNegativeBlackBoxTestCase extends AbstractBlackBoxTestCase {
+
+  private static final Logger log = Logger.getLogger(AbstractNegativeBlackBoxTestCase.class.getSimpleName());
+
+  private final List<TestRXingResult> testRXingResults;
+
+  private static final class TestRXingResult {
+    private final int falsePositivesAllowed;
+    private final float rotation;
+
+    TestRXingResult(int falsePositivesAllowed, float rotation) {
+      this.falsePositivesAllowed = falsePositivesAllowed;
+      this.rotation = rotation;
+    }
+
+    int getFalsePositivesAllowed() {
+      return falsePositivesAllowed;
+    }
+
+    float getRotation() {
+      return rotation;
+    }
+  }
+
+  // Use the multiformat reader to evaluate all decoders in the system.
+  protected AbstractNegativeBlackBoxTestCase(String testBasePathSuffix) {
+    super(testBasePathSuffix, new MultiFormatReader(), null);
+    testRXingResults = new ArrayList<>();
+  }
+
+  protected final void addTest(int falsePositivesAllowed, float rotation) {
+    testRXingResults.add(new TestRXingResult(falsePositivesAllowed, rotation));
+  }
+
+  @Override
+  @Test
+  public void testBlackBox() throws IOException {
+    assertFalse(testRXingResults.isEmpty());
+
+    List<Path> imageFiles = getImageFiles();
+    int[] falsePositives = new int[testRXingResults.size()];
+    for (Path testImage : imageFiles) {
+      log.info(String.format("Starting %s", testImage));
+      BufferedImage image = ImageIO.read(testImage.toFile());
+      if (image == null) {
+        throw new IOException("Could not read image: " + testImage);
+      }
+      for (int x = 0; x < testRXingResults.size(); x++) {
+        TestRXingResult testRXingResult = testRXingResults.get(x);
+        if (!checkForFalsePositives(image, testRXingResult.getRotation())) {
+          falsePositives[x]++;
+        }
+      }
+    }
+
+    int totalFalsePositives = 0;
+    int totalAllowed = 0;
+
+    for (int x = 0; x < testRXingResults.size(); x++) {
+      TestRXingResult testRXingResult = testRXingResults.get(x);
+      totalFalsePositives += falsePositives[x];
+      totalAllowed += testRXingResult.getFalsePositivesAllowed();
+    }
+
+    if (totalFalsePositives < totalAllowed) {
+      log.warning(String.format("+++ Test too lax by %d images", totalAllowed - totalFalsePositives));
+    } else if (totalFalsePositives > totalAllowed) {
+      log.warning(String.format("--- Test failed by %d images", totalFalsePositives - totalAllowed));
+    }
+
+    for (int x = 0; x < testRXingResults.size(); x++) {
+      TestRXingResult testRXingResult = testRXingResults.get(x);
+      log.info(String.format("Rotation %d degrees: %d of %d images were false positives (%d allowed)",
+                             (int) testRXingResult.getRotation(), falsePositives[x], imageFiles.size(),
+                             testRXingResult.getFalsePositivesAllowed()));
+      assertTrue("Rotation " + testRXingResult.getRotation() + " degrees: Too many false positives found",
+                 falsePositives[x] <= testRXingResult.getFalsePositivesAllowed());
+    }
+  }
+
+  /**
+   * Make sure ZXing does NOT find a barcode in the image.
+   *
+   * @param image The image to test
+   * @param rotationInDegrees The amount of rotation to apply
+   * @return true if nothing found, false if a non-existent barcode was detected
+   */
+  private boolean checkForFalsePositives(BufferedImage image, float rotationInDegrees) {
+    BufferedImage rotatedImage = rotateImage(image, rotationInDegrees);
+    LuminanceSource source = new BufferedImageLuminanceSource(rotatedImage);
+    BinaryBitmap bitmap = new BinaryBitmap(new HybridBinarizer(source));
+    RXingResult result;
+    try {
+      result = getReader().decode(bitmap);
+      log.info(String.format("Found false positive: '%s' with format '%s' (rotation: %d)",
+                              result.getText(), result.getBarcodeFormat(), (int) rotationInDegrees));
+      return false;
+    } catch (ReaderException re) {
+      // continue
+    }
+
+    // Try "try harder" getMode
+    Map<DecodeHintType,Object> hints = new EnumMap<>(DecodeHintType.class);
+    hints.put(DecodeHintType.TRY_HARDER, Boolean.TRUE);
+    try {
+      result = getReader().decode(bitmap, hints);
+      log.info(String.format("Try harder found false positive: '%s' with format '%s' (rotation: %d)",
+                              result.getText(), result.getBarcodeFormat(), (int) rotationInDegrees));
+      return false;
+    } catch (ReaderException re) {
+      // continue
+    }
+    return true;
+  }
+
+}