Tests are running

Author: sofakingforever

analytics/build.gradle

@@ -37,17 +37,32 @@ android {
         }
     }
 
+//    testOptions {
+//        unitTests.returnDefaultValues = true
+//    }
 }
 
 dependencies {
+
     implementation fileTree(dir: 'libs', include: ['*.jar'])
 
+    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
+
     implementation 'com.android.support:appcompat-v7:28.0.0-rc01'
     testImplementation 'junit:junit:4.12'
+
+
     androidTestImplementation 'com.android.support.test:runner:1.0.2'
     androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
-    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
-
+    // required if you want to use Mockito for unit tests
+    testImplementation 'org.mockito:mockito-core:2.7.22'
+    // required if you want to use Mockito for Android tests
+    androidTestImplementation 'org.mockito:mockito-android:2.7.22'
+
+//    testCompile 'org.powermock:powermock:1.6.5'
+//    testCompile 'org.powermock:powermock-module-junit4:1.6.5'
+//
+//    testCompile 'org.powermock:powermock-api-mockito:1.6.5'
 
 
 }

analytics/src/main/java/com/sofakingforever/analytics/Analytics.kt

@@ -3,6 +3,7 @@ package com.sofakingforever.analytics
 import android.content.Context
 import android.util.Log
 import com.sofakingforever.analytics.events.base.Event
+import com.sofakingforever.analytics.exceptions.EventNotTrackedException
 
 /**
  * The *Analytics* class is in charge of tracking any *Event* implementation.
@@ -47,8 +48,7 @@ class Analytics(context: Context, private vararg val dispatchers: AnalyticsDispa
                 try {
                     dispatcher.track(it)
                 } catch (e: Exception) {
-                    Log.e("Analytics", "${dispatcher.kit.name} dispatcher couldn't fire \"${it.javaClass.name}\" event", e)
-                    settings.exceptionHandler?.onException(e)
+                    settings.exceptionHandler?.onException(EventNotTrackedException(dispatcher, it, e))
                 }
             }
 
@@ -58,18 +58,10 @@ class Analytics(context: Context, private vararg val dispatchers: AnalyticsDispa
 
     fun setKitEnabled(kit: AnalyticsKit, enabled: Boolean) {
         enabledKitMap[kit] = enabled
-//        dispatchers.filter { d -> d.kit == kit }
-//                .forEach { dispatcher ->
-//
-//                }
     }
 
     fun setDispatcherEnabled(dispatcherName: String, enabled: Boolean) {
         enabledDispatcherMap[dispatcherName] = enabled
-//        dispatchers.filter { d -> d.dispatcherName == dispatcherName }
-//                .forEach { dispatcher ->
-//                    dispatcher.enabled = enabled
-//                }
     }
 
 }

analytics/src/main/java/com/sofakingforever/analytics/exceptions/EventNotTrackedException.kt

@@ -0,0 +1,10 @@
+package com.sofakingforever.analytics.exceptions
+
+import com.sofakingforever.analytics.AnalyticsDispatcher
+import com.sofakingforever.analytics.events.base.Event
+
+class EventNotTrackedException(message: String?, cause: Throwable?) : RuntimeException(message, cause) {
+
+    constructor(dispatcher: AnalyticsDispatcher, event: Event, t: Throwable) : this("${dispatcher.dispatcherName} dispatcher couldn't fire \"${event.javaClass.name}\" event", t)
+
+}

analytics/src/test/java/com/sofakingforever/library/AnalyticsUnitTest.kt

@@ -1,36 +1,47 @@
 package com.sofakingforever.library
 
-import android.app.Application
+import android.content.Context
+import android.util.Log
 import com.sofakingforever.analytics.Analytics
 import com.sofakingforever.analytics.AnalyticsSettings
+import com.sofakingforever.analytics.exceptions.EventNotTrackedException
 import com.sofakingforever.analytics.exceptions.UnsupportedEventException
 import com.sofakingforever.library.dispatcher.TestKit
 import com.sofakingforever.library.dispatcher.TestableDispatcher
-import com.sofakingforever.library.events.TestEvent
+import com.sofakingforever.library.events.InitDispatcherEvent
+import com.sofakingforever.library.events.TestContentViewEvent
+import com.sofakingforever.library.events.TestCustomEvent
 import com.sofakingforever.library.events.UnsupportedEvent
 import org.junit.Test
+import org.mockito.Mockito
+import org.mockito.Mockito.mock
 
 class AnalyticsUnitTest {
 
+    private val contextMock = mock(Context::class.java)
 
-    private val dispatcher = TestableDispatcher()
-    private val analytics = Analytics(Application(), dispatcher).apply {
-
-        // todo - java.lang.RuntimeException: Method e in android.util.Log not mocked. See http://g.co/androidstudio/not-mocked for details.
-        this.log = false
+    private lateinit var analytics: Analytics
 
-        this.settings.exceptionHandler = object : AnalyticsSettings.ExceptionHandler {
-            override fun onException(e: Exception) {
-                raisedException = e
-            }
+    private val dispatcher = TestableDispatcher()
+    private var raisedException: Exception? = null
 
-        }
+    init {
+        Mockito.`when`(contextMock.applicationContext).thenReturn(contextMock)
     }
-    private var raisedException: Exception? = null
 
     @Test
     fun testAnalytics() {
 
+        analytics = Analytics(contextMock, dispatcher).apply {
+
+            this.settings.exceptionHandler = object : AnalyticsSettings.ExceptionHandler {
+                override fun onException(e: Exception) {
+                    raisedException = e
+                }
+
+            }
+        }
+
         // track some events
         trackTestEvents()
 
@@ -43,31 +54,35 @@ class AnalyticsUnitTest {
         // track an unsupported event
         analytics.track(UnsupportedEvent())
 
-
-        assert(raisedException != null && raisedException is UnsupportedEventException)
+        // assert UnsupportedEventException was raised
+        assert(raisedException != null)
+        assert(raisedException is EventNotTrackedException)
+        assert((raisedException as EventNotTrackedException).cause is UnsupportedEventException)
 
     }
 
 
     private fun trackTestEvents() {
 
-        analytics.track(TestEvent(1))
+        analytics.track(TestCustomEvent(1))
 
         analytics.setDispatcherEnabled(TestableDispatcher.DispatcherName, false)
 
-        analytics.track(TestEvent(2))
+        analytics.track(TestCustomEvent(2))
 
         analytics.setDispatcherEnabled(TestableDispatcher.DispatcherName, true)
 
-        analytics.track(TestEvent(3))
+        analytics.track(TestCustomEvent(3))
 
         analytics.setKitEnabled(TestKit.instance, false)
 
-        analytics.track(TestEvent(4))
+        analytics.track(TestCustomEvent(4))
 
         analytics.setKitEnabled(TestKit.instance, true)
 
-        analytics.track(TestEvent(5))
+        analytics.track(TestCustomEvent(5))
+
+        analytics.track(TestContentViewEvent(1))
 
     }
 
@@ -77,11 +92,12 @@ class AnalyticsUnitTest {
 
         val eventList = dispatcher.eventList
 
-        // expect to find 3 events + init event
-        assert(eventList.size == 4)
-        assert(eventList[0] is TestableDispatcher.InitEvent)
-        assert((eventList[1] as TestEvent).number == 1)
-        assert((eventList[2] as TestEvent).number == 3)
-        assert((eventList[3] as TestEvent).number == 5)
+        // expect to find 3 custom events , 1 contentview and 1 init event
+        assert(eventList.size == 5)
+        assert(eventList[0] is InitDispatcherEvent)
+        assert((eventList[1] as TestCustomEvent).number == 1)
+        assert((eventList[2] as TestCustomEvent).number == 3)
+        assert((eventList[3] as TestCustomEvent).number == 5)
+        assert((eventList[4] as TestContentViewEvent).number == 1)
     }
 }

analytics/src/test/java/com/sofakingforever/library/DispatcherTest.kt

@@ -1,11 +1,9 @@
 package com.sofakingforever.library
 
 import android.app.Application
-import com.sofakingforever.analytics.Analytics
-import com.sofakingforever.analytics.AnalyticsSettings
-import com.sofakingforever.library.dispatcher.TestKit
 import com.sofakingforever.library.dispatcher.TestableDispatcher
-import com.sofakingforever.library.events.TestEvent
+import com.sofakingforever.library.events.InitDispatcherEvent
+import com.sofakingforever.library.events.TestCustomEvent
 import org.junit.Test
 
 
@@ -20,22 +18,22 @@ class DispatcherTest {
 
         dispatcher.initDispatcher(Application())
 
-        dispatcher.track(TestEvent(1))
+        dispatcher.track(TestCustomEvent(1))
 
-        dispatcher.track(TestEvent(2))
+        dispatcher.track(TestCustomEvent(2))
 
-        dispatcher.track(TestEvent(3))
+        dispatcher.track(TestCustomEvent(3))
 
-        dispatcher.track(TestEvent(4))
+        dispatcher.track(TestCustomEvent(4))
 
-        dispatcher.track(TestEvent(5))
+        dispatcher.track(TestCustomEvent(5))
 
         val eventList = dispatcher.eventList
 
         // expect to find 5 events + init event
         assert(eventList.size == 6)
-        assert(eventList[0] is TestableDispatcher.InitEvent)
-        assert((eventList[1] as TestEvent).number == 1)
+        assert(eventList[0] is InitDispatcherEvent)
+        assert((eventList[1] as TestCustomEvent).number == 1)
 
         // that's enough
 

analytics/src/test/java/com/sofakingforever/library/dispatcher/TestKit.kt

@@ -5,7 +5,6 @@ import com.sofakingforever.analytics.AnalyticsKit
 class TestKit private constructor() : AnalyticsKit {
     override val name: String = "Test Kit"
 
-
     private object Holder {
         val INSTANCE = TestKit()
     }

analytics/src/test/java/com/sofakingforever/library/dispatcher/TestableDispatcher.kt

@@ -8,7 +8,7 @@ import com.sofakingforever.analytics.events.CustomEvent
 import com.sofakingforever.analytics.events.InviteEvent
 import com.sofakingforever.analytics.events.SetUserProperty
 import com.sofakingforever.analytics.events.base.Event
-import com.sofakingforever.library.events.InitTestEvent
+import com.sofakingforever.library.events.InitDispatcherEvent
 
 class TestableDispatcher : AnalyticsDispatcher {
 
@@ -18,11 +18,10 @@ class TestableDispatcher : AnalyticsDispatcher {
 
     override val dispatcherName: String = DispatcherName
 
-
     val eventList: MutableList<Event> = mutableListOf()
 
     override fun initDispatcher(context: Context) {
-        track(InitTestEvent())
+        track(InitDispatcherEvent())
     }
 
     override fun trackContentView(contentView: ContentViewEvent) {
@@ -42,7 +41,7 @@ class TestableDispatcher : AnalyticsDispatcher {
     }
 
     override fun track(event: Event) {
-        if (event is InitTestEvent) {
+        if (event is InitDispatcherEvent) {
             eventList.add(event)
         } else {
             super.track(event)

analytics/src/test/java/com/sofakingforever/library/events/InitTestEvent.kt renamed to analytics/src/test/java/com/sofakingforever/library/events/InitDispatcherEvent.kt

@@ -2,4 +2,4 @@ package com.sofakingforever.library.events
 
 import com.sofakingforever.analytics.events.base.Event
 
-class InitTestEvent : Event
+class InitDispatcherEvent : Event

analytics/src/test/java/com/sofakingforever/library/events/TestContentViewEvent.kt

@@ -0,0 +1,9 @@
+package com.sofakingforever.library.events
+
+import com.sofakingforever.analytics.AnalyticsKit
+import com.sofakingforever.analytics.events.ContentViewEvent
+
+class TestContentViewEvent(val number: Int) : ContentViewEvent {
+    override fun getViewName(kit: AnalyticsKit): String = "Content View #$number"
+
+}

analytics/src/test/java/com/sofakingforever/library/events/TestCustomEvent.kt

@@ -0,0 +1,17 @@
+package com.sofakingforever.library.events
+
+import com.sofakingforever.analytics.AnalyticsKit
+import com.sofakingforever.analytics.events.CustomEvent
+
+class TestCustomEvent(val number: Int) : CustomEvent {
+    override fun getEventName(kit: AnalyticsKit): String = "Custom Event #$number"
+
+    override fun getParameters(kit: AnalyticsKit): MutableMap<String, Any> {
+        val parameters = super.getParameters(kit)
+        parameters["int"] = -2
+        parameters["long"] = +2L
+        parameters["boolean"] = true
+        parameters["string"] = "fun #$number"
+        return parameters
+    }
+}