Merge pull request #237 from thejoeba/add-database-testing

Issue-236 added unit test for database DataSnapshot children count

Author: nbransby

firebase-database/build.gradle.kts

@@ -10,6 +10,7 @@ version = project.property("firebase-database.version") as String
 plugins {
     id("com.android.library")
     kotlin("multiplatform")
+    kotlin("plugin.serialization") version "1.5.31"
 }
 
 repositories {
@@ -22,11 +23,17 @@ android {
     defaultConfig {
         minSdk = property("minSdkVersion") as Int
         targetSdk = property("targetSdkVersion") as Int
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+        multiDexEnabled = true
     }
     sourceSets {
         getByName("main") {
             manifest.srcFile("src/androidMain/AndroidManifest.xml")
         }
+        getByName("androidTest"){
+            java.srcDir(file("src/androidAndroidTest/kotlin"))
+            manifest.srcFile("src/androidAndroidTest/AndroidManifest.xml")
+        }
     }
     testOptions {
         unitTests.apply {

firebase-database/src/androidAndroidTest/kotlin/dev/gitlive/firebase/database/database.kt

@@ -0,0 +1,15 @@
+/*
+ * Copyright (c) 2020 GitLive Ltd.  Use of this source code is governed by the Apache 2.0 license.
+ */
+
+@file:JvmName("tests")
+package dev.gitlive.firebase.database
+
+import androidx.test.platform.app.InstrumentationRegistry
+import kotlinx.coroutines.runBlocking
+
+actual val emulatorHost: String = "10.0.2.2"
+
+actual val context: Any = InstrumentationRegistry.getInstrumentation().targetContext
+
+actual fun runTest(test: suspend () -> Unit) = runBlocking { test() }

firebase-database/src/commonTest/kotlin/dev.gitlive.firebase.database/database.kt

@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) 2020 GitLive Ltd.  Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package dev.gitlive.firebase.database
+
+import dev.gitlive.firebase.*
+import kotlinx.coroutines.flow.first
+import kotlinx.serialization.*
+import kotlin.test.*
+
+expect val emulatorHost: String
+expect val context: Any
+expect fun runTest(test: suspend () -> Unit)
+
+class database {
+
+    @Serializable
+    data class FirebaseDatabaseChildTest(val prop1: String? = null, val time: Double = 0.0)
+
+    @BeforeTest
+    fun initializeFirebase() {
+        Firebase
+            .takeIf { Firebase.apps(context).isEmpty() }
+            ?.apply {
+                initialize(
+                    context,
+                    FirebaseOptions(
+                        applicationId = "1:846484016111:ios:dd1f6688bad7af768c841a",
+                        apiKey = "AIzaSyCK87dcMFhzCz_kJVs2cT2AVlqOTLuyWV0",
+                        databaseUrl = "https://fir-kotlin-sdk.firebaseio.com",
+                        storageBucket = "fir-kotlin-sdk.appspot.com",
+                        projectId = "fir-kotlin-sdk",
+                        gcmSenderId = "846484016111"
+                    )
+                )
+                Firebase.database.useEmulator(emulatorHost, 9000)
+            }
+    }
+
+    @Test
+    fun testChildCount() = runTest {
+        setupRealtimeData()
+        val dataSnapshot = Firebase.database
+            .reference("FirebaseRealtimeDatabaseTest")
+            .valueEvents
+            .first()
+
+        val firebaseDatabaseChildCount = dataSnapshot.children.count()
+        assertEquals(3, firebaseDatabaseChildCount)
+    }
+
+    private suspend fun setupRealtimeData() {
+        val firebaseDatabaseTestReference = Firebase.database
+            .reference("FirebaseRealtimeDatabaseTest")
+
+        val firebaseDatabaseChildTest1 = FirebaseDatabaseChildTest("aaa")
+        val firebaseDatabaseChildTest2 = FirebaseDatabaseChildTest("bbb")
+        val firebaseDatabaseChildTest3 = FirebaseDatabaseChildTest("ccc")
+
+        firebaseDatabaseTestReference.child("1").setValue(firebaseDatabaseChildTest1)
+        firebaseDatabaseTestReference.child("2").setValue(firebaseDatabaseChildTest2)
+        firebaseDatabaseTestReference.child("3").setValue(firebaseDatabaseChildTest3)
+    }
+}

firebase-database/src/iosTest/kotlin/dev/gitlive/firebase/database/database.kt

@@ -0,0 +1,24 @@
+/*
+ * Copyright (c) 2020 GitLive Ltd.  Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package dev.gitlive.firebase.database
+
+import kotlinx.coroutines.*
+import platform.Foundation.*
+
+actual val emulatorHost: String = "localhost"
+
+actual val context: Any = Unit
+
+actual fun runTest(test: suspend () -> Unit) = runBlocking {
+    val testRun = MainScope().async { test() }
+    while (testRun.isActive) {
+        NSRunLoop.mainRunLoop.runMode(
+            NSDefaultRunLoopMode,
+            beforeDate = NSDate.create(timeInterval = 1.0, sinceDate = NSDate())
+        )
+        yield()
+    }
+    testRun.await()
+}

firebase-database/src/jsTest/kotlin/dev.gitlive.firebase.database/database.kt

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2020 GitLive Ltd.  Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package dev.gitlive.firebase.database
+
+import kotlinx.coroutines.GlobalScope
+import kotlinx.coroutines.promise
+
+actual val emulatorHost: String = "localhost"
+
+actual val context: Any = Unit
+
+actual fun runTest(test: suspend () -> Unit) = GlobalScope
+    .promise {
+        try {
+            test()
+        } catch (e: Throwable) {
+            e.log()
+            throw e
+        }
+    }.asDynamic()
+
+internal fun Throwable.log() {
+    console.error(this)
+    cause?.let {
+        console.error("Caused by:")
+        it.log()
+    }
+}
+

test/database.rules.json

@@ -0,0 +1,6 @@
+{
+  "rules": {
+    ".read": true,
+    ".write": true
+  }
+}

test/firebase.json

@@ -2,12 +2,18 @@
   "firestore": {
     "rules": "firestore.rules"
   },
+  "database": {
+    "rules": "database.rules.json"
+  },
   "emulators": {
     "auth": {
       "port": 9099
     },
     "firestore": {
       "port": 8080
+    },
+    "database": {
+      "port": 9000
     }
   }
 }