mock external calls for all crawlers

cloudsftp · Jun 7, 2024 · db6c076 · db6c076
1 parent 1f43b24
commit db6c076
Show file tree

Hide file tree

Showing 15 changed files with 684 additions and 41 deletions.
diff --git a/app/src/main/java/nz/badradio/badradio/model/metadata/art/BandcampCrawler.kt b/app/src/main/java/nz/badradio/badradio/model/metadata/art/BandcampCrawler.kt
@@ -8,6 +8,9 @@ import okhttp3.Request
 import java.io.IOException
 
 class BandcampCrawler(val baseUrl: String) : IStreamingServiceCrawler {
+    companion object {
+        val canon = BandcampCrawler("https://bandcamp.com/")
+    }
 
     // search query: https://bandcamp.com/search?q=come%20and%20see%20cassyb&item_type=t
 

diff --git a/app/src/main/java/nz/badradio/badradio/model/metadata/art/ITunesCrawler.kt b/app/src/main/java/nz/badradio/badradio/model/metadata/art/ITunesCrawler.kt
@@ -8,16 +8,17 @@ import nz.badradio.badradio.utilities.moshi
 import okhttp3.Request
 import java.io.IOException
 
-object ITunesCrawler : IStreamingServiceCrawler {
+class ITunesCrawler(val baseUrl: String) : IStreamingServiceCrawler {
+    companion object {
+        val canon = ITunesCrawler("https://itunes.apple.com/search")
+    }
 
     // search query: https://itunes.apple.com/search?term=come%20and%20see%20cassyb&media=music&limit=1
 
-    private const val urlBase = "https://itunes.apple.com/search"
-
     @Throws(IOException::class, IndexOutOfBoundsException::class)
     override fun search(parent: IStreamingServiceDataObserver, songMetadata: SongMetadata) {
         val searchUrl = buildSearchUrl(
-            urlBase,
+            baseUrl,
             "term",
             songMetadata,
             mapOf(

diff --git a/app/src/main/java/nz/badradio/badradio/model/metadata/art/SoundcloudCrawler.kt b/app/src/main/java/nz/badradio/badradio/model/metadata/art/SoundcloudCrawler.kt
@@ -7,12 +7,14 @@ import nz.badradio.badradio.utilities.firstMatch
 import okhttp3.Request
 import java.io.IOException
 
-object SoundcloudCrawler : IStreamingServiceCrawler {
+class SoundcloudCrawler(val baseUrl: String) : IStreamingServiceCrawler {
 
     // search query: https://soundcloud.com/search/sounds?q=come%20and%20see%20cassyb
 
-    private const val urlBase = "https://soundcloud.com"
-    private const val searchEndpoint = "search/sounds"
+    companion object {
+        val canon = SoundcloudCrawler("https://soundcloud.com")
+        val searchEndpoint = "search/sounds"
+    }
 
     @Throws(IOException::class)
     override fun search(parent: IStreamingServiceDataObserver, songMetadata: SongMetadata) {
@@ -28,7 +30,7 @@ object SoundcloudCrawler : IStreamingServiceCrawler {
     @Throws(IOException::class)
     fun getSongUrl(parent: IStreamingServiceDataObserver, songMetadata: SongMetadata): String {
         val searchURL = buildSearchUrl(
-            "$urlBase/$searchEndpoint",
+            "$baseUrl/$searchEndpoint",
             "q",
             songMetadata,
         )
@@ -52,7 +54,7 @@ object SoundcloudCrawler : IStreamingServiceCrawler {
         }
 
         val songUrlSuffix = match.groupValues[1]
-        return "$urlBase$songUrlSuffix"
+        return "$baseUrl$songUrlSuffix"
     }
 
     @Throws(IOException::class)

diff --git a/app/src/main/java/nz/badradio/badradio/model/metadata/art/StreamingServiceCrawler.kt b/app/src/main/java/nz/badradio/badradio/model/metadata/art/StreamingServiceCrawler.kt
@@ -8,13 +8,10 @@ import nz.badradio.badradio.model.metadata.SongMetadata
 import java.io.IOException
 
 class StreamingServiceCrawler : IStreamingServiceDataObserver {
-
-    private val bandcampBaseUrl = "https://bandcamp.com/"
-
     private val crawlers = listOf(
         // ITunesCrawler, TODO: re-enable
-        BandcampCrawler(bandcampBaseUrl),
-        SoundcloudCrawler,
+        BandcampCrawler.canon,
+        SoundcloudCrawler.canon,
     )
 
     private val albumArtUrls = mutableListOf<String>()

diff --git a/...data/art/bandcamp/BandcampCrawlerTests.kt → ...odel/metadata/art/BandcampCrawlerTests.kt b/...data/art/bandcamp/BandcampCrawlerTests.kt → ...odel/metadata/art/BandcampCrawlerTests.kt
@@ -1,8 +1,7 @@
-package nz.badradio.badradio.model.metadata.art.bandcamp
+package nz.badradio.badradio.model.metadata.art
 
 import nz.badradio.badradio.model.metadata.SongMetadata
-import nz.badradio.badradio.model.metadata.art.BandcampCrawler
-import nz.badradio.badradio.model.metadata.art.IStreamingServiceDataObserver
+import nz.badradio.badradio.model.metadata.art.StreamingServiceCrawlerTests.Companion.testDataDirectory
 import okhttp3.HttpUrl
 import okhttp3.mockwebserver.MockResponse
 import okhttp3.mockwebserver.MockWebServer
@@ -29,19 +28,17 @@ class BandcampCrawlerTests {
         mockWebServer.shutdown()
     }
 
-    val responsesFilesDirectory = "src/test/java/nz/badradio/badradio/model/metadata/art/bandcamp"
-
     @Test
     fun testGetImageUrl() {
         var mockSearchResponseContent = File(
-            "${responsesFilesDirectory}/bandcamp_search_response.html",
+            "${testDataDirectory}/bandcamp_search_response.html",
         ).readText(Charsets.UTF_8)
         mockSearchResponseContent = mockSearchResponseContent
             .replace("https://cassyb.bandcamp.com", baseUrl.toString())
         val mockSearchResponse = MockResponse().setBody(mockSearchResponseContent)
         mockWebServer.enqueue(mockSearchResponse)
 
-        val mockSongPageResponseContent = File("${responsesFilesDirectory}/bandcamp_song_page.html")
+        val mockSongPageResponseContent = File("${testDataDirectory}/bandcamp_song_page.html")
             .readText(Charsets.UTF_8)
         val mockSongPageResponse = MockResponse().setBody(mockSongPageResponseContent)
         mockWebServer.enqueue(mockSongPageResponse)
@@ -64,7 +61,7 @@ class BandcampCrawlerTests {
     @Test
     fun testGetSongUrl() {
         val mockSearchResponseContent = File(
-            "${responsesFilesDirectory}/bandcamp_search_response.html",
+            "${testDataDirectory}/bandcamp_search_response.html",
         ).readText(Charsets.UTF_8)
         val mockSearchResponse = MockResponse().setBody(mockSearchResponseContent)
         mockWebServer.enqueue(mockSearchResponse)

diff --git a/app/src/test/java/nz/badradio/badradio/model/metadata/art/ITunesCrawlerTests.kt b/app/src/test/java/nz/badradio/badradio/model/metadata/art/ITunesCrawlerTests.kt
@@ -1,14 +1,41 @@
 package nz.badradio.badradio.model.metadata.art
 
 import nz.badradio.badradio.model.metadata.SongMetadata
+import okhttp3.HttpUrl
+import okhttp3.mockwebserver.MockResponse
+import okhttp3.mockwebserver.MockWebServer
+import org.junit.After
+import org.junit.Before
 import org.junit.Test
+import java.io.File
+import java.io.IOException
 
 class ITunesCrawlerTests {
+    lateinit var mockWebServer: MockWebServer
+    lateinit var baseUrl: HttpUrl
+    @Before
+    @Throws(IOException::class)
+    fun setUp() {
+        mockWebServer = MockWebServer()
+        baseUrl = mockWebServer.url("/")
+    }
+
+    @After
+    @Throws(IOException::class)
+    fun tearDown() {
+        mockWebServer.shutdown()
+    }
 
     @Test
     fun testGetImageUrl() {
+        val mockSearchResponseContent = File(
+            "${StreamingServiceCrawlerTests.testDataDirectory}/itunes_search_response.html",
+        ).readText(Charsets.UTF_8)
+        val mockSearchResponse = MockResponse().setBody(mockSearchResponseContent)
+        mockWebServer.enqueue(mockSearchResponse)
+
         var imageUrl = ""
-        ITunesCrawler.search(
+        ITunesCrawler(baseUrl.toString()).search(
             object : IStreamingServiceDataObserver {
                 override fun notifyOfAlbumArtUrl(url: String) { imageUrl = url }
                 override fun notifyOfSoundcloudUrl(url: String) { }

diff --git a/app/src/test/java/nz/badradio/badradio/model/metadata/art/SoundcloudCrawlerTests.kt b/app/src/test/java/nz/badradio/badradio/model/metadata/art/SoundcloudCrawlerTests.kt
@@ -1,14 +1,46 @@
 package nz.badradio.badradio.model.metadata.art
 
 import nz.badradio.badradio.model.metadata.SongMetadata
+import okhttp3.HttpUrl
+import okhttp3.mockwebserver.MockResponse
+import okhttp3.mockwebserver.MockWebServer
+import org.junit.After
+import org.junit.Before
 import org.junit.Test
+import java.io.File
+import java.io.IOException
 
 class SoundcloudCrawlerTests {
+    lateinit var mockWebServer: MockWebServer
+    lateinit var baseUrl: HttpUrl
+    @Before
+    @Throws(IOException::class)
+    fun setUp() {
+        mockWebServer = MockWebServer()
+        baseUrl = mockWebServer.url("/")
+    }
+
+    @After
+    @Throws(IOException::class)
+    fun tearDown() {
+        mockWebServer.shutdown()
+    }
 
     @Test
     fun testGetImageUrl() {
+        var mockSearchResponseContent = File(
+            "${StreamingServiceCrawlerTests.testDataDirectory}/soundcloud_search_response.html",
+        ).readText(Charsets.UTF_8)
+        val mockSearchResponse = MockResponse().setBody(mockSearchResponseContent)
+        mockWebServer.enqueue(mockSearchResponse)
+
+        val mockSongPageResponseContent = File("${StreamingServiceCrawlerTests.testDataDirectory}/soundcloud_song_page.html")
+            .readText(Charsets.UTF_8)
+        val mockSongPageResponse = MockResponse().setBody(mockSongPageResponseContent)
+        mockWebServer.enqueue(mockSongPageResponse)
+
         var imageUrl = ""
-        SoundcloudCrawler.search(
+        SoundcloudCrawler(baseUrl.toString()).search(
             object : IStreamingServiceDataObserver {
                 override fun notifyOfAlbumArtUrl(url: String) { imageUrl = url }
                 override fun notifyOfSoundcloudUrl(url: String) { }
@@ -24,15 +56,21 @@ class SoundcloudCrawlerTests {
 
     @Test
     fun testGetSongUrl() {
-        val songUrl = SoundcloudCrawler.getSongUrl(
+        val mockSearchResponseContent = File(
+            "${StreamingServiceCrawlerTests.testDataDirectory}/soundcloud_search_response.html",
+        ).readText(Charsets.UTF_8)
+        val mockSearchResponse = MockResponse().setBody(mockSearchResponseContent)
+        mockWebServer.enqueue(mockSearchResponse)
+
+        val songUrl = SoundcloudCrawler(baseUrl.toString()).getSongUrl(
             object : IStreamingServiceDataObserver {
                 override fun notifyOfAlbumArtUrl(url: String) { }
                 override fun notifyOfSoundcloudUrl(url: String) { }
                 override fun notifyOfBandcampUrl(url: String) { }
             },
             SongMetadata("come and see", "cassyb, north posse"),
         )
-        assert(songUrl == "https://soundcloud.com/xxcassyb/come-and-see") {
+        assert(songUrl == "${baseUrl}/xxcassyb/come-and-see") {
             println("was $songUrl")
         }
     }

diff --git a/app/src/test/java/nz/badradio/badradio/model/metadata/art/StreamingServiceCrawlerTests.kt b/app/src/test/java/nz/badradio/badradio/model/metadata/art/StreamingServiceCrawlerTests.kt
@@ -20,4 +20,7 @@ class StreamingServiceCrawlerTests {
         assert(runSongMatchesMetadata("thissong", "thissong feat. collaborator"))
     }
 
+    companion object {
+        val testDataDirectory = "src/test/res"
+    }
 }
diff --git a/...src/test/java/nz/badradio/badradio/model/metadata/art/bandcamp/test_bandcamp_responses.sh b/...src/test/java/nz/badradio/badradio/model/metadata/art/bandcamp/test_bandcamp_responses.sh
diff --git a/...rt/bandcamp/bandcamp_search_response.html → ...rc/test/res/bandcamp_search_response.html b/...rt/bandcamp/bandcamp_search_response.html → ...rc/test/res/bandcamp_search_response.html
diff --git a/...data/art/bandcamp/bandcamp_song_page.html → app/src/test/res/bandcamp_song_page.html b/...data/art/bandcamp/bandcamp_song_page.html → app/src/test/res/bandcamp_song_page.html
diff --git a/app/src/test/res/itunes_search_response.html b/app/src/test/res/itunes_search_response.html
@@ -0,0 +1,11 @@
+
+
+
+{
+ "resultCount":1,
+ "results": [
+{"wrapperType":"track", "kind":"song", "artistId":1530227322, "collectionId":1616796837, "trackId":1616797117, "artistName":"North Posse", "collectionName":"Paris Robbery II", "trackName":"Come and See (feat. Cassyb)", "collectionCensoredName":"Paris Robbery II", "trackCensoredName":"Come and See (feat. Cassyb)", "artistViewUrl":"https://music.apple.com/us/artist/north-posse/1530227322?uo=4", "collectionViewUrl":"https://music.apple.com/us/album/come-and-see-feat-cassyb/1616796837?i=1616797117&uo=4", "trackViewUrl":"https://music.apple.com/us/album/come-and-see-feat-cassyb/1616796837?i=1616797117&uo=4", 
+"previewUrl":"https://audio-ssl.itunes.apple.com/itunes-assets/AudioPreview122/v4/db/1d/0d/db1d0d79-c2c7-be9c-80b0-af55b98b28cd/mzaf_11468037081690366165.plus.aac.p.m4a", "artworkUrl30":"https://is1-ssl.mzstatic.com/image/thumb/Music112/v4/b8/67/6d/b8676dfc-a60d-45b3-8136-a3e02e5db168/artwork.jpg/30x30bb.jpg", "artworkUrl60":"https://is1-ssl.mzstatic.com/image/thumb/Music112/v4/b8/67/6d/b8676dfc-a60d-45b3-8136-a3e02e5db168/artwork.jpg/60x60bb.jpg", "artworkUrl100":"https://is1-ssl.mzstatic.com/image/thumb/Music112/v4/b8/67/6d/b8676dfc-a60d-45b3-8136-a3e02e5db168/artwork.jpg/100x100bb.jpg", "collectionPrice":9.90, "trackPrice":0.99, "releaseDate":"2022-03-09T12:00:00Z", "collectionExplicitness":"explicit", "trackExplicitness":"explicit", "discCount":1, "discNumber":1, "trackCount":10, "trackNumber":10, "trackTimeMillis":165010, "country":"USA", "currency":"USD", "primaryGenreName":"Hip-Hop/Rap", "contentAdvisoryRating":"Explicit", "isStreamable":true}]
+}
+
+