Repository: crawler-commons/crawler-commons
Pull request #254 (2019-07-16 18:24:06)

Updated the tests to use parameterizedTest, separating each test
Updated the tests to use parameterizedTest, thus making the test file more readable and each normalized pair is now a test in itself, thus making it much easier to identify exactly failure points, and make the rest of the tests pass


Patch:
diff --git a/pom.xml b/pom.xml
index ec3f87c..d684c0f 100644
--- a/pom.xml
+++ b/pom.xml
@@ -372,6 +372,13 @@
 			<scope>test</scope>
 		</dependency>
 
+		<dependency>
+			<groupId>org.junit.jupiter</groupId>
+			<artifactId>junit-jupiter-params</artifactId>
+			<version>${junit.version}</version>
+			<scope>test</scope>
+		</dependency>
+
 		<dependency>
 			<groupId>org.slf4j</groupId>
 			<artifactId>slf4j-log4j12</artifactId>


Test patch:
diff --git a/src/test/java/crawlercommons/filters/basic/BasicURLNormalizerTest.java b/src/test/java/crawlercommons/filters/basic/BasicURLNormalizerTest.java
index 481184c..971f6d1 100644
--- a/src/test/java/crawlercommons/filters/basic/BasicURLNormalizerTest.java
+++ b/src/test/java/crawlercommons/filters/basic/BasicURLNormalizerTest.java
@@ -17,149 +17,22 @@
 package crawlercommons.filters.basic;
 
 import org.junit.jupiter.api.Assertions;
-import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.CsvFileSource;
 
 /** Unit tests for BasicURLNormalizer. */
 public class BasicURLNormalizerTest {
-    private BasicURLNormalizer normalizer;
+    private static BasicURLNormalizer normalizer;
 
-    public BasicURLNormalizerTest() {
+    @BeforeAll
+    public static void setup() {
         normalizer = new BasicURLNormalizer();
     }
 
-    @Test
-    public void testNUTCH1098() throws Exception {
-        // check that % encoding is normalized
-        normalizeTest("http://foo.com/%66oo.html", "http://foo.com/foo.html");
-
-        // check that % encoding works correctly at end of URL
-        normalizeTest("http://foo.com/%66oo.htm%6c", "http://foo.com/foo.html");
-        normalizeTest("http://foo.com/%66oo.ht%6dl", "http://foo.com/foo.html");
-
-        // check that % decoder do not overlap strings
-        normalizeTest("http://foo.com/%66oo.ht%6d%6c", "http://foo.com/foo.html");
-
-        // check that % decoder leaves high bit chars alone
-        normalizeTest("http://foo.com/%66oo.htm%C0", "http://foo.com/foo.htm%C0");
-
-        // check that % decoder leaves control chars alone
-        normalizeTest("http://foo.com/%66oo.htm%1A", "http://foo.com/foo.htm%1A");
-
-        // check that % decoder converts to upper case letters
-        normalizeTest("http://foo.com/%66oo.htm%c0", "http://foo.com/foo.htm%C0");
-
-        // check that % decoder leaves encoded spaces alone
-        normalizeTest("http://foo.com/you%20too.html", "http://foo.com/you%20too.html");
-
-        // check that spaces are encoded into %20
-        normalizeTest("http://foo.com/you too.html", "http://foo.com/you%20too.html");
-
-        // check that encoded # are not decoded
-        normalizeTest("http://foo.com/file.html%23cz", "http://foo.com/file.html%23cz");
-
-        // check that encoded / are not decoded
-        normalizeTest("http://foo.com/fast/dir%2fcz", "http://foo.com/fast/dir%2Fcz");
-
-        // check that control chars are encoded
-        normalizeTest("http://foo.com/\u001a!", "http://foo.com/%1A!");
-
-        // check that control chars are always encoded into 2 digits
-        normalizeTest("http://foo.com/\u0001!", "http://foo.com/%01!");
-
-        // check encoding of spanish chars
-        normalizeTest("http://mydomain.com/en Espa\u00F1ol.aspx", "http://mydomain.com/en%20Espa%C3%B1ol.aspx");
-    }
-
-    @Test
-    public void testNUTCH2064() throws Exception {
-        // Ampersand and colon and other punctuation characters are not to be
-        // unescaped
-        normalizeTest("http://x.com/s?q=a%26b&m=10", "http://x.com/s?q=a%26b&m=10");
-        normalizeTest("http://x.com/show?http%3A%2F%2Fx.com%2Fb", "http://x.com/show?http%3A%2F%2Fx.com%2Fb");
-        normalizeTest("http://google.com/search?q=c%2B%2B", "http://google.com/search?q=c%2B%2B");
-        // do also not touch the query part which is
-        // application/x-www-form-urlencoded
-        normalizeTest("http://x.com/s?q=a+b", "http://x.com/s?q=a+b");
-        // and keep Internationalized domain names
-        // http://bücher.de/ may be http://xn--bcher-kva.de/
-        // but definitely not http://b%C3%BCcher.de/
-        normalizeTest("http://b\u00fccher.de/", "http://b\u00fccher.de/");
-        // test whether percent-encoding works together with other
-        // normalizations
-        normalizeTest("http://x.com/./a/../%66.html", "http://x.com/f.html");
-        // [ and ] need escaping as well
-        normalizeTest("http://x.com/?x[y]=1", "http://x.com/?x%5By%5D=1");
-        // boundary test for first character outside the ASCII range (U+0080)
-        normalizeTest("http://x.com/foo\u0080", "http://x.com/foo%C2%80");
-        normalizeTest("http://x.com/foo%c2%80", "http://x.com/foo%C2%80");
-    }
-
-    @Test
-    public void testNormalizer() throws Exception {
-        // check that leading and trailing spaces are removed
-        normalizeTest(" http://foo.com/ ", "http://foo.com/");
-
-        // check that protocol is lower cased
-        normalizeTest("HTTP://foo.com/", "http://foo.com/");
-
-        // check that host is lower cased
-        normalizeTest("http://Foo.Com/index.html", "http://foo.com/index.html");
-        normalizeTest("http://Foo.Com/index.html", "http://foo.com/index.html");
-
-        // check that port number is normalized
-        normalizeTest("http://foo.com:80/index.html", "http://foo.com/index.html");
-        normalizeTest("http://foo.com:81/", "http://foo.com:81/");
-        // check that empty port is removed
-        normalizeTest("http://example.com:/", "http://example.com/");
-        normalizeTest("https://example.com:/foobar.html", "https://example.com/foobar.html");
-
-        // check that null path is normalized
-        normalizeTest("http://foo.com", "http://foo.com/");
-
-        // check that references are removed
-        normalizeTest("http://foo.com/foo.html#ref", "http://foo.com/foo.html");
-
-        // // check that encoding is normalized
-        // normalizeTest("http://foo.com/%66oo.html",
-        // "http://foo.com/foo.html");
-
-        // check that unnecessary "../" are removed
-        normalizeTest("http://foo.com/aa/./foo.html", "http://foo.com/aa/foo.html");
-        normalizeTest("http://foo.com/aa/../", "http://foo.com/");
-        normalizeTest("http://foo.com/aa/bb/../", "http://foo.com/aa/");
-        normalizeTest("http://foo.com/aa/..", "http://foo.com/");
-        normalizeTest("http://foo.com/aa/bb/cc/../../foo.html", "http://foo.com/aa/foo.html");
-        normalizeTest("http://foo.com/aa/bb/../cc/dd/../ee/foo.html", "http://foo.com/aa/cc/ee/foo.html");
-        normalizeTest("http://foo.com/../foo.html", "http://foo.com/foo.html");
-        normalizeTest("http://foo.com/../../foo.html", "http://foo.com/foo.html");
-        normalizeTest("http://foo.com/../aa/../foo.html", "http://foo.com/foo.html");
-        normalizeTest("http://foo.com/aa/../../foo.html", "http://foo.com/foo.html");
-        normalizeTest("http://foo.com/aa/../bb/../foo.html/../../", "http://foo.com/");
-        normalizeTest("http://foo.com/../aa/foo.html", "http://foo.com/aa/foo.html");
-        normalizeTest("http://foo.com/../aa/../foo.html", "http://foo.com/foo.html");
-        normalizeTest("http://foo.com/a..a/foo.html", "http://foo.com/a..a/foo.html");
-        normalizeTest("http://foo.com/a..a/../foo.html", "http://foo.com/foo.html");
-        normalizeTest("http://foo.com/foo.foo/../foo.html", "http://foo.com/foo.html");
-        normalizeTest("http://foo.com//aa/bb/foo.html", "http://foo.com/aa/bb/foo.html");
-        normalizeTest("http://foo.com/aa//bb/foo.html", "http://foo.com/aa/bb/foo.html");
-        normalizeTest("http://foo.com/aa/bb//foo.html", "http://foo.com/aa/bb/foo.html");
-        normalizeTest("http://foo.com//aa//bb//foo.html", "http://foo.com/aa/bb/foo.html");
-        normalizeTest("http://foo.com////aa////bb////foo.html", "http://foo.com/aa/bb/foo.html");
-        normalizeTest("http://foo.com/aa?referer=http://bar.com", "http://foo.com/aa?referer=http://bar.com");
-
-        // check URLs without host (authority)
-        normalizeTest("file:///foo/bar.txt", "file:///foo/bar.txt");
-        normalizeTest("ftp:/", "ftp:/");
-        normalizeTest("http:", "http:/");
-        normalizeTest("http:////", "http:/");
-        normalizeTest("http:///////", "http:/");
-    }
-
-    private void normalizeTest(String weird, String normal) throws Exception {
-        Assertions.assertEquals(normal, normalizer.filter(weird), "normalizing: " + weird);
-    }
-
-    public static void main(String[] args) throws Exception {
-        new BasicURLNormalizerTest().testNormalizer();
+    @ParameterizedTest
+    @CsvFileSource(resources = "/normalizer/weirdToNormalizedUrls.csv")
+    void testBasicNormalizer(String weirdUrl, String expectedNormalizedUrl) throws Exception {
+      Assertions.assertEquals(expectedNormalizedUrl, normalizer.filter(weirdUrl), "normalizing: " + weirdUrl);
     }
-}
+}
\ No newline at end of file
diff --git a/src/test/resources/normalizer/weirdToNormalizedUrls.csv b/src/test/resources/normalizer/weirdToNormalizedUrls.csv
new file mode 100644
index 0000000..4afb2a1
--- /dev/null
+++ b/src/test/resources/normalizer/weirdToNormalizedUrls.csv
@@ -0,0 +1,129 @@
+# Weird URL, Normalized URL
+
+# testNUTCH1098
+# -------------
+# check that % encoding is normalized
+http://foo.com/%66oo.html, http://foo.com/foo.html
+
+# check that % encoding works correctly at end of URL
+http://foo.com/%66oo.htm%6c, http://foo.com/foo.html
+http://foo.com/%66oo.ht%6dl, http://foo.com/foo.html
+
+# check that % decoder do not overlap strings
+http://foo.com/%66oo.ht%6d%6c, http://foo.com/foo.html
+
+# check that % decoder leaves high bit chars alone
+http://foo.com/%66oo.htm%C0, http://foo.com/foo.htm%C0
+
+# check that % decoder leaves control chars alone
+http://foo.com/%66oo.htm%1A, http://foo.com/foo.htm%1A
+
+# check that % decoder converts to upper case letters
+http://foo.com/%66oo.htm%c0, http://foo.com/foo.htm%C0
+
+# check that % decoder leaves encoded spaces alone
+http://foo.com/you%20too.html, http://foo.com/you%20too.html
+
+# check that spaces are encoded into %20
+http://foo.com/you too.html, http://foo.com/you%20too.html
+
+# check that encoded # are not decoded
+http://foo.com/file.html%23cz, http://foo.com/file.html%23cz
+
+# check that encoded / are not decoded
+http://foo.com/fast/dir%2fcz, http://foo.com/fast/dir%2Fcz
+
+# check that control chars are encoded
+#http://foo.com/\u001a!, http://foo.com/%1A!
+
+# check that control chars are always encoded into 2 digits
+#http://foo.com/\u0001!, http://foo.com/%01!
+
+# check encoding of spanish chars
+#http://mydomain.com/en Espa\u00F1ol.aspx, http://mydomain.com/en%20Espa%C3%B1ol.aspx
+
+
+# testNUTCH2064
+# -------------
+# Ampersand and colon and other punctuation characters are not to be unescaped
+http://x.com/s?q=a%26b&m=10, http://x.com/s?q=a%26b&m=10
+http://x.com/show?http%3A%2F%2Fx.com%2Fb, http://x.com/show?http%3A%2F%2Fx.com%2Fb
+http://google.com/search?q=c%2B%2B, http://google.com/search?q=c%2B%2B
+
+# do also not touch the query part which is application/x-www-form-urlencoded
+http://x.com/s?q=a+b, http://x.com/s?q=a+b
+
+# and keep Internationalized domain names http://bücher.de/ may be http://xn--bcher-kva.de/
+# but definitely not http://b%C3%BCcher.de/
+http://b\u00fccher.de/, http://b\u00fccher.de/
+
+# test whether percent-encoding works together with other normalizations
+http://x.com/./a/../%66.html, http://x.com/f.html
+
+# [ and ] need escaping as well
+http://x.com/?x[y]=1, http://x.com/?x%5By%5D=1
+
+# boundary test for first character outside the ASCII range (U+0080)
+#http://x.com/foo\u0080, http://x.com/foo%C2%80
+http://x.com/foo%c2%80, http://x.com/foo%C2%80
+
+
+# testNormalizer
+# --------------
+# check that leading and trailing spaces are removed
+http://foo.com/ , http://foo.com/
+
+# check that protocol is lower cased
+http://foo.com/, http://foo.com/
+
+# check that host is lower cased
+http://Foo.Com/index.html, http://foo.com/index.html
+http://Foo.Com/index.html, http://foo.com/index.html
+
+# check that port number is normalized
+http://foo.com:80/index.html, http://foo.com/index.html
+http://foo.com:81/, http://foo.com:81/
+
+# check that empty port is removed
+http://example.com:/, http://example.com/
+https://example.com:/foobar.html, https://example.com/foobar.html
+
+# check that null path is normalized
+http://foo.com, http://foo.com/
+
+# check that references are removed
+http://foo.com/foo.html#ref, http://foo.com/foo.html
+
+# check that encoding is normalized
+http://foo.com/%66oo.html, http://foo.com/foo.html
+
+# check that unnecessary ../ are removed
+http://foo.com/aa/./foo.html, http://foo.com/aa/foo.html
+http://foo.com/aa/../, http://foo.com/
+http://foo.com/aa/bb/../, http://foo.com/aa/
+http://foo.com/aa/.., http://foo.com/
+http://foo.com/aa/bb/cc/../../foo.html, http://foo.com/aa/foo.html
+http://foo.com/aa/bb/../cc/dd/../ee/foo.html, http://foo.com/aa/cc/ee/foo.html
+http://foo.com/../foo.html, http://foo.com/foo.html
+http://foo.com/../../foo.html, http://foo.com/foo.html
+http://foo.com/../aa/../foo.html, http://foo.com/foo.html
+http://foo.com/aa/../../foo.html, http://foo.com/foo.html
+http://foo.com/aa/../bb/../foo.html/../../, http://foo.com/
+http://foo.com/../aa/foo.html, http://foo.com/aa/foo.html
+http://foo.com/../aa/../foo.html, http://foo.com/foo.html
+http://foo.com/a..a/foo.html, http://foo.com/a..a/foo.html
+http://foo.com/a..a/../foo.html, http://foo.com/foo.html
+http://foo.com/foo.foo/../foo.html, http://foo.com/foo.html
+http://foo.com//aa/bb/foo.html, http://foo.com/aa/bb/foo.html
+http://foo.com/aa//bb/foo.html, http://foo.com/aa/bb/foo.html
+http://foo.com/aa/bb//foo.html, http://foo.com/aa/bb/foo.html
+http://foo.com//aa//bb//foo.html, http://foo.com/aa/bb/foo.html
+http://foo.com////aa////bb//foo.html, http://foo.com/aa/bb/foo.html
+http://foo.com/aa?referer=http://bar.com, http://foo.com/aa?referer=http://bar.com
+
+# check URLs without host (authority)
+file:///foo/bar.txt, file:///foo/bar.txt
+ftp:/, ftp:/
+http:, http:/
+http:////, http:/
+http:///////, http:/
\ No newline at end of file