Merge pull request #768 from litetex/junit-5

JUnit 5

Author: Stypox

build.gradle

@@ -29,7 +29,7 @@ allprojects {
     ext {
         nanojsonVersion = "1d9e1aea9049fc9f85e68b43ba39fe7be1c1f751"
         spotbugsVersion = "4.5.2"
-        junitVersion = "4.13.2"
+        junitVersion = "5.8.2"
     }
 }
 

extractor/build.gradle

@@ -3,6 +3,7 @@ test {
     if (System.properties.containsKey('downloader')) {
         systemProperty('downloader', System.getProperty('downloader'))
     }
+    useJUnitPlatform()
 }
 
 dependencies {
@@ -14,7 +15,11 @@ dependencies {
     implementation "com.github.spotbugs:spotbugs-annotations:$spotbugsVersion"
     implementation 'org.nibor.autolink:autolink:0.10.0'
 
-    testImplementation "junit:junit:$junitVersion"
+    testImplementation platform("org.junit:junit-bom:$junitVersion")
+    testImplementation 'org.junit.jupiter:junit-jupiter-api'
+    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine'
+    testImplementation 'org.junit.jupiter:junit-jupiter-params'
+
     testImplementation "com.squareup.okhttp3:okhttp:3.12.13"
     testImplementation 'com.google.code.gson:gson:2.8.9'
 }

extractor/src/main/java/org/schabi/newpipe/extractor/services/soundcloud/SoundcloudParsingHelper.java

@@ -41,7 +41,7 @@
 
 public class SoundcloudParsingHelper {
     static final String HARDCODED_CLIENT_ID =
-            "1NKODbzHzEpoowFHxTAmS7oB08DObPuK"; // Updated on 08/12/21
+            "JpcTFmpEz9lMPDrM6TDAC9izag7Be06D"; // Updated on 2022-01-07
     private static String clientId;
     public static final String SOUNDCLOUD_API_V2_URL = "https://api-v2.soundcloud.com/";
 

extractor/src/main/java/org/schabi/newpipe/extractor/services/soundcloud/extractors/SoundcloudSearchExtractor.java

@@ -20,13 +20,14 @@
 import java.net.URL;
 import java.util.Collections;
 import java.util.List;
+import java.util.function.IntUnaryOperator;
 
 import static org.schabi.newpipe.extractor.services.soundcloud.linkHandler.SoundcloudSearchQueryHandlerFactory.ITEMS_PER_PAGE;
 import static org.schabi.newpipe.extractor.utils.Utils.EMPTY_STRING;
 import static org.schabi.newpipe.extractor.utils.Utils.isNullOrEmpty;
 
 public class SoundcloudSearchExtractor extends SearchExtractor {
-    private JsonArray searchCollection;
+    private JsonArray initialSearchCollection;
 
     public SoundcloudSearchExtractor(final StreamingService service,
                                      final SearchQueryHandler linkHandler) {
@@ -53,8 +54,9 @@ public List<MetaInfo> getMetaInfo() {
     @Nonnull
     @Override
     public InfoItemsPage<InfoItem> getInitialPage() throws IOException, ExtractionException {
-        return new InfoItemsPage<>(collectItems(searchCollection), getNextPageFromCurrentUrl(
-                getUrl()));
+        return new InfoItemsPage<>(
+                collectItems(initialSearchCollection),
+                getNextPageFromCurrentUrl(getUrl(), currentOffset -> ITEMS_PER_PAGE));
     }
 
     @Override
@@ -65,6 +67,7 @@ public InfoItemsPage<InfoItem> getPage(final Page page) throws IOException,
         }
 
         final Downloader dl = getDownloader();
+        final JsonArray searchCollection;
         try {
             final String response = dl.get(page.getUrl(), getExtractorLocalization())
                     .responseBody();
@@ -73,8 +76,9 @@ public InfoItemsPage<InfoItem> getPage(final Page page) throws IOException,
             throw new ParsingException("Could not parse json response", e);
         }
 
-        return new InfoItemsPage<>(collectItems(searchCollection), getNextPageFromCurrentUrl(page
-                .getUrl()));
+        return new InfoItemsPage<>(
+                collectItems(searchCollection),
+                getNextPageFromCurrentUrl(page.getUrl(), currentOffset -> currentOffset + ITEMS_PER_PAGE));
     }
 
     @Override
@@ -84,12 +88,12 @@ public void onFetchPage(@Nonnull final Downloader downloader) throws IOException
         final String url = getUrl();
         try {
             final String response = dl.get(url, getExtractorLocalization()).responseBody();
-            searchCollection = JsonParser.object().from(response).getArray("collection");
+            initialSearchCollection = JsonParser.object().from(response).getArray("collection");
         } catch (final JsonParserException e) {
             throw new ParsingException("Could not parse json response", e);
         }
 
-        if (searchCollection.isEmpty()) {
+        if (initialSearchCollection.isEmpty()) {
             throw new SearchExtractor.NothingFoundException("Nothing found");
         }
     }
@@ -118,12 +122,14 @@ private InfoItemsCollector<InfoItem, InfoItemExtractor> collectItems(
         return collector;
     }
 
-    private Page getNextPageFromCurrentUrl(final String currentUrl)
+    private Page getNextPageFromCurrentUrl(final String currentUrl, final IntUnaryOperator newPageOffsetCalculator)
             throws MalformedURLException, UnsupportedEncodingException {
-        final int pageOffset = Integer.parseInt(
-                Parser.compatParseMap(new URL(currentUrl).getQuery()).get("offset"));
+        final int currentPageOffset = Integer.parseInt(
+                    Parser.compatParseMap(new URL(currentUrl).getQuery()).get("offset"));
 
-        return new Page(currentUrl.replace("&offset=" + pageOffset, "&offset="
-                + (pageOffset + ITEMS_PER_PAGE)));
+        return new Page(
+                currentUrl.replace(
+                        "&offset=" + currentPageOffset,
+                        "&offset=" + newPageOffsetCalculator.applyAsInt(currentPageOffset)));
     }
 }

extractor/src/test/java/org/schabi/newpipe/MockOnly.java

@@ -4,18 +4,16 @@
 import java.net.URL;
 import java.util.ArrayList;
 import java.util.Collections;
-import java.util.Comparator;
 import java.util.List;
 
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 
-import static org.junit.Assert.assertArrayEquals;
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.assertNull;
-import static org.junit.Assert.assertTrue;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 public class ExtractorAsserts {
     public static void assertEmptyErrors(String message, List<Throwable> errors) {
@@ -44,7 +42,7 @@ public static void assertIsValidUrl(String url) {
 
     public static void assertIsSecureUrl(String urlToCheck) {
         URL url = urlFromString(urlToCheck);
-        assertEquals("Protocol of URL is not secure", "https", url.getProtocol());
+        assertEquals("https", url.getProtocol(), "Protocol of URL is not secure");
     }
 
     public static void assertNotEmpty(String stringToCheck) {
@@ -53,7 +51,7 @@ public static void assertNotEmpty(String stringToCheck) {
 
     public static void assertNotEmpty(@Nullable String message, String stringToCheck) {
         assertNotNull(message, stringToCheck);
-        assertFalse(message, stringToCheck.isEmpty());
+        assertFalse(stringToCheck.isEmpty(), message);
     }
 
     public static void assertEmpty(String stringToCheck) {
@@ -62,12 +60,56 @@ public static void assertEmpty(String stringToCheck) {
 
     public static void assertEmpty(@Nullable String message, String stringToCheck) {
         if (stringToCheck != null) {
-            assertTrue(message, stringToCheck.isEmpty());
+            assertTrue(stringToCheck.isEmpty(), message);
         }
     }
 
-    public static void assertAtLeast(long expected, long actual) {
-        assertTrue(actual + " is not at least " + expected, actual >= expected);
+    public static void assertGreater(final long expected, final long actual) {
+        assertGreater(expected, actual, actual + " is not > " + expected);
+    }
+
+    public static void assertGreater(
+            final long expected,
+            final long actual,
+            final String message
+    ) {
+        assertTrue(actual > expected, message);
+    }
+
+    public static void assertGreaterOrEqual(final long expected, final long actual) {
+        assertGreaterOrEqual(expected, actual, actual + " is not >= " + expected);
+    }
+
+    public static void assertGreaterOrEqual(
+            final long expected,
+            final long actual,
+            final String message
+    ) {
+        assertTrue(actual >= expected, message);
+    }
+
+    public static void assertLess(final long expected, final long actual) {
+        assertLess(expected, actual, actual + " is not < " + expected);
+    }
+
+    public static void assertLess(
+            final long expected,
+            final long actual,
+            final String message
+    ) {
+        assertTrue(actual < expected, message);
+    }
+
+    public static void assertLessOrEqual(final long expected, final long actual) {
+        assertLessOrEqual(expected, actual, actual + " is not <= " + expected);
+    }
+
+    public static void assertLessOrEqual(
+            final long expected,
+            final long actual,
+            final String message
+    ) {
+        assertTrue(actual <= expected, message);
     }
 
     // this assumes that sorting a and b in-place is not an issue, so it's only intended for tests
@@ -85,4 +127,13 @@ public static void assertEqualsOrderIndependent(final List<String> expected,
         // using new ArrayList<> to make sure the type is the same
         assertEquals(new ArrayList<>(expected), new ArrayList<>(actual));
     }
+
+    public static void assertContains(
+            final String shouldBeContained,
+            final String container) {
+        assertNotNull(shouldBeContained, "shouldBeContained is null");
+        assertNotNull(container, "container is null");
+        assertTrue(container.contains(shouldBeContained),
+                "'" + shouldBeContained + "' should be contained inside '" + container +"'");
+    }
 }

extractor/src/test/java/org/schabi/newpipe/MockOnlyRule.java

@@ -1,10 +1,10 @@
 package org.schabi.newpipe.extractor;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 import java.util.HashSet;
 
-import static org.junit.Assert.*;
+import static org.junit.jupiter.api.Assertions.*;
 import static org.schabi.newpipe.extractor.NewPipe.getServiceByUrl;
 import static org.schabi.newpipe.extractor.ServiceList.SoundCloud;
 import static org.schabi.newpipe.extractor.ServiceList.YouTube;
@@ -19,9 +19,11 @@ public void getAllServicesTest() throws Exception {
     public void testAllServicesHaveDifferentId() throws Exception {
         HashSet<Integer> servicesId = new HashSet<>();
         for (StreamingService streamingService : NewPipe.getServices()) {
-            String errorMsg = "There are services with the same id = " + streamingService.getServiceId() + " (current service > " + streamingService.getServiceInfo().getName() + ")";
+            final String errorMsg =
+                    "There are services with the same id = " + streamingService.getServiceId()
+                            + " (current service > " + streamingService.getServiceInfo().getName() + ")";
 
-            assertTrue(errorMsg, servicesId.add(streamingService.getServiceId()));
+            assertTrue(servicesId.add(streamingService.getServiceId()), errorMsg);
         }
     }
 

extractor/src/test/java/org/schabi/newpipe/extractor/ExtractorAsserts.java

@@ -1,11 +1,11 @@
 package org.schabi.newpipe.extractor.services;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 import org.schabi.newpipe.extractor.Extractor;
+import org.schabi.newpipe.extractor.ExtractorAsserts;
 import org.schabi.newpipe.extractor.StreamingService;
 
-import static org.hamcrest.CoreMatchers.*;
-import static org.junit.Assert.*;
+import static org.junit.jupiter.api.Assertions.*;
 import static org.schabi.newpipe.extractor.ExtractorAsserts.assertIsSecureUrl;
 
 public abstract class DefaultExtractorTest<T extends Extractor> implements BaseExtractorTest {
@@ -40,14 +40,14 @@ public void testId() throws Exception {
     public void testUrl() throws Exception {
         final String url = extractor().getUrl();
         assertIsSecureUrl(url);
-        assertThat(url, containsString(expectedUrlContains()));
+        ExtractorAsserts.assertContains(expectedUrlContains(), url);
     }
 
     @Test
     @Override
     public void testOriginalUrl() throws Exception {
         final String originalUrl = extractor().getOriginalUrl();
         assertIsSecureUrl(originalUrl);
-        assertThat(originalUrl, containsString(expectedOriginalUrlContains()));
+        ExtractorAsserts.assertContains(expectedOriginalUrlContains(), originalUrl);
     }
 }

extractor/src/test/java/org/schabi/newpipe/extractor/NewPipeTest.java

@@ -1,6 +1,6 @@
 package org.schabi.newpipe.extractor.services;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 import org.schabi.newpipe.extractor.InfoItem;
 import org.schabi.newpipe.extractor.ListExtractor;