Unit Testing

.github/workflows/android_test.yml

@@ -23,4 +23,4 @@ jobs:
         run: chmod +x ./gradlew
 
       - name: Run Tests with Gradle
-        run: ./gradlew test
+        run: ./gradlew clean testDebugUnitTest

app/src/main/java/com/shifthackz/aisdv1/app/di/ProvidersModule.kt

@@ -7,6 +7,7 @@ import com.shifthackz.aisdv1.core.common.appbuild.BuildVersion
 import com.shifthackz.aisdv1.core.common.file.FileProviderDescriptor
 import com.shifthackz.aisdv1.core.common.links.LinksProvider
 import com.shifthackz.aisdv1.core.common.schedulers.SchedulersProvider
+import com.shifthackz.aisdv1.core.common.time.TimeProvider
 import com.shifthackz.aisdv1.domain.entity.ServerSource
 import com.shifthackz.aisdv1.domain.feature.auth.AuthorizationCredentials
 import com.shifthackz.aisdv1.domain.feature.auth.AuthorizationStore
@@ -24,6 +25,7 @@ import io.reactivex.rxjava3.core.Scheduler
 import io.reactivex.rxjava3.schedulers.Schedulers
 import org.koin.android.ext.koin.androidApplication
 import org.koin.dsl.module
+import java.util.Date
 import java.util.concurrent.Executor
 import java.util.concurrent.Executors
 
@@ -134,6 +136,14 @@ val providersModule = module {
         }
     }
 
+    single<TimeProvider> {
+        object : TimeProvider {
+            override fun nanoTime(): Long = System.nanoTime()
+            override fun currentTimeMillis(): Long = System.currentTimeMillis()
+            override fun currentDate(): Date = Date()
+        }
+    }
+
     single<FileProviderDescriptor> {
         object : FileProviderDescriptor {
             override val providerPath: String = "${androidApplication().packageName}.fileprovider"

core/common/src/main/java/com/shifthackz/aisdv1/core/common/extensions/StringExtensions.kt

@@ -3,13 +3,6 @@ package com.shifthackz.aisdv1.core.common.extensions
 private const val PROTOCOL_DELIMITER = "://"
 private const val PROTOCOL_HOLDER = "[[_PROTOCOL_]]"
 
-fun String.withoutUrlProtocol(): String {
-    if (!this.contains(PROTOCOL_DELIMITER)) return this
-    val decomposed = this.split(PROTOCOL_DELIMITER)
-    if (decomposed.size < 2) return this
-    return decomposed.last()
-}
-
 fun String.fixUrlSlashes(): String = this
     .replace(PROTOCOL_DELIMITER, PROTOCOL_HOLDER)
     .replace(Regex("/{2,}"), "/")

core/common/src/main/java/com/shifthackz/aisdv1/core/common/time/TimeProvider.kt

@@ -0,0 +1,9 @@
+package com.shifthackz.aisdv1.core.common.time
+
+import java.util.Date
+
+interface TimeProvider {
+    fun nanoTime(): Long
+    fun currentTimeMillis(): Long
+    fun currentDate(): Date
+}

domain/src/test/java/com/shifthackz/aisdv1/domain/entity/AppVersionTest.kt → core/common/src/test/java/com/shifthackz/aisdv1/core/common/appbuild/BuildVersionTest.kt

@@ -1,10 +1,9 @@
-package com.shifthackz.aisdv1.domain.entity
+package com.shifthackz.aisdv1.core.common.appbuild
 
-import com.shifthackz.aisdv1.core.common.appbuild.BuildVersion
 import org.junit.Assert
 import org.junit.Test
 
-class AppVersionTest {
+class BuildVersionTest {
 
     @Test
     fun `Parse 1_0_0, expected success`() {

core/common/src/test/java/com/shifthackz/aisdv1/core/common/extensions/DateExtensionsTest.kt

@@ -0,0 +1,33 @@
+package com.shifthackz.aisdv1.core.common.extensions
+
+import org.junit.Assert
+import org.junit.Test
+import java.util.Date
+
+class DateExtensionsTest {
+
+    companion object {
+        private val date = Date(894333955000) // 1998-05-05 05:05:55
+    }
+
+    @Test
+    fun `given date 05_05_1998, then getRawDay, expected 5`() {
+        val expected = 5
+        val actual = date.getRawDay()
+        Assert.assertEquals(expected, actual)
+    }
+
+    @Test
+    fun `given date 05_05_1998, then getRawMonth, expected 5`() {
+        val expected = 5
+        val actual = date.getRawMonth()
+        Assert.assertEquals(expected, actual)
+    }
+
+    @Test
+    fun `given date 05_05_1998, then getRawYear, expected 1998`() {
+        val expected = 1998
+        val actual = date.getRawYear()
+        Assert.assertEquals(expected, actual)
+    }
+}

core/common/src/test/java/com/shifthackz/aisdv1/core/common/extensions/KotlinExtensionsTest.kt

@@ -0,0 +1,41 @@
+package com.shifthackz.aisdv1.core.common.extensions
+
+import org.junit.Assert
+import org.junit.Test
+
+class KotlinExtensionsTest {
+
+    @Test
+    fun `given TestClass with null value, then applyIf with true predicate, expected test value changed`() {
+        class TestClass {
+            var testValue: String? = null
+        }
+
+        val instance = TestClass()
+        val predicate = true
+        instance.applyIf(predicate) {
+            testValue = "5598"
+        }
+
+        val expected = "5598"
+        val actual = instance.testValue
+        Assert.assertEquals(expected, actual)
+    }
+
+    @Test
+    fun `given TestClass with null value, then applyIf with false predicate, expected test value NOT changed`() {
+        class TestClass {
+            var testValue: String? = null
+        }
+
+        val instance = TestClass()
+        val predicate = false
+        instance.applyIf(predicate) {
+            testValue = "5598"
+        }
+
+        val expected = null
+        val actual = instance.testValue
+        Assert.assertEquals(expected, actual)
+    }
+}

core/common/src/test/java/com/shifthackz/aisdv1/core/common/math/MathUtilsTest.kt

@@ -0,0 +1,23 @@
+package com.shifthackz.aisdv1.core.common.math
+
+import org.junit.Assert
+import org.junit.Test
+
+class MathUtilsTest {
+
+    @Test
+    fun `given Double with 8 fraction digits, then roundTo(2), expected Double with 2 fraction digits`() {
+        val value = 55.98238462
+        val expected = 55.98.toString()
+        val actual = value.roundTo(2).toString()
+        Assert.assertEquals(expected, actual)
+    }
+
+    @Test
+    fun `given Float with 6 fraction digits, then roundTo(2), expected Float with 2 fraction digits`() {
+        val value = 55.982384f
+        val expected = 55.98f.toString()
+        val actual = value.roundTo(2).toString()
+        Assert.assertEquals(expected, actual)
+    }
+}

core/validation/build.gradle

@@ -12,4 +12,6 @@ android {
 dependencies {
     implementation di.koinCore
     implementation reactive.rxkotlin
+    testImplementation test.junit
+    testImplementation test.mockk
 }

core/validation/src/main/java/com/shifthackz/aisdv1/core/validation/horde/CommonStringValidator.kt → core/validation/src/main/java/com/shifthackz/aisdv1/core/validation/common/CommonStringValidator.kt

@@ -1,4 +1,4 @@
-package com.shifthackz.aisdv1.core.validation.horde
+package com.shifthackz.aisdv1.core.validation.common
 
 import com.shifthackz.aisdv1.core.validation.ValidationResult
 

core/validation/src/main/java/com/shifthackz/aisdv1/core/validation/horde/CommonStringValidatorImpl.kt → core/validation/src/main/java/com/shifthackz/aisdv1/core/validation/common/CommonStringValidatorImpl.kt

@@ -1,4 +1,4 @@
-package com.shifthackz.aisdv1.core.validation.horde
+package com.shifthackz.aisdv1.core.validation.common
 
 import com.shifthackz.aisdv1.core.validation.ValidationResult
 

core/validation/src/main/java/com/shifthackz/aisdv1/core/validation/di/ValidatorsModule.kt

@@ -1,9 +1,9 @@
 package com.shifthackz.aisdv1.core.validation.di
 
+import com.shifthackz.aisdv1.core.validation.common.CommonStringValidator
+import com.shifthackz.aisdv1.core.validation.common.CommonStringValidatorImpl
 import com.shifthackz.aisdv1.core.validation.dimension.DimensionValidator
 import com.shifthackz.aisdv1.core.validation.dimension.DimensionValidatorImpl
-import com.shifthackz.aisdv1.core.validation.horde.CommonStringValidator
-import com.shifthackz.aisdv1.core.validation.horde.CommonStringValidatorImpl
 import com.shifthackz.aisdv1.core.validation.url.UrlValidator
 import com.shifthackz.aisdv1.core.validation.url.UrlValidatorImpl
 import org.koin.core.module.dsl.factoryOf
@@ -13,7 +13,7 @@ import org.koin.dsl.module
 val validatorsModule = module {
     // !!! Do not use [factoryOf] for DimensionValidatorImpl, it has 2 default Ints in constructor
     factory<DimensionValidator> { DimensionValidatorImpl() }
+    factory<UrlValidator> { UrlValidatorImpl() }
 
-    factoryOf(::UrlValidatorImpl) bind UrlValidator::class
     factoryOf(::CommonStringValidatorImpl) bind CommonStringValidator::class
 }

core/validation/src/main/java/com/shifthackz/aisdv1/core/validation/url/UrlValidatorImpl.kt

@@ -4,8 +4,11 @@ import android.util.Patterns
 import android.webkit.URLUtil
 import com.shifthackz.aisdv1.core.validation.ValidationResult
 import java.net.URI
+import java.util.regex.Pattern
 
-internal class UrlValidatorImpl : UrlValidator {
+internal class UrlValidatorImpl(
+    private val webUrlPattern: Pattern = Patterns.WEB_URL,
+) : UrlValidator {
 
     override operator fun invoke(input: String?): ValidationResult<UrlValidator.Error> = when {
         input == null -> ValidationResult(
@@ -32,7 +35,7 @@ internal class UrlValidatorImpl : UrlValidator {
             isValid = false,
             validationError = UrlValidator.Error.Invalid,
         )
-        !Patterns.WEB_URL.matcher(input).matches() -> ValidationResult(
+        !webUrlPattern.matcher(input).matches() -> ValidationResult(
             isValid = false,
             validationError = UrlValidator.Error.Invalid,
         )

core/validation/src/test/java/com/shifthackz/aisdv1/core/validation/common/CommonStringValidatorImplTest.kt

@@ -0,0 +1,47 @@
+package com.shifthackz.aisdv1.core.validation.common
+
+import com.shifthackz.aisdv1.core.validation.ValidationResult
+import org.junit.Assert
+import org.junit.Test
+
+class CommonStringValidatorImplTest {
+
+    private val validator = CommonStringValidatorImpl()
+
+    @Test
+    fun `given input is null, expected not valid with Empty error`() {
+        val expected = ValidationResult<CommonStringValidator.Error>(
+            isValid = false,
+            validationError = CommonStringValidator.Error.Empty,
+        )
+        val actual = validator(null)
+        Assert.assertEquals(expected, actual)
+    }
+
+    @Test
+    fun `given input is empty, expected not valid with Empty error`() {
+        val expected = ValidationResult<CommonStringValidator.Error>(
+            isValid = false,
+            validationError = CommonStringValidator.Error.Empty,
+        )
+        val actual = validator("")
+        Assert.assertEquals(expected, actual)
+    }
+
+    @Test
+    fun `given input is blank, expected not valid with Empty error`() {
+        val expected = ValidationResult<CommonStringValidator.Error>(
+            isValid = false,
+            validationError = CommonStringValidator.Error.Empty,
+        )
+        val actual = validator(" ")
+        Assert.assertEquals(expected, actual)
+    }
+
+    @Test
+    fun `given input is non empty string, expected valid`() {
+        val expected = ValidationResult<CommonStringValidator.Error>(true)
+        val actual = validator("5598 is my favorite")
+        Assert.assertEquals(expected, actual)
+    }
+}

core/validation/src/test/java/com/shifthackz/aisdv1/core/validation/dimension/DimensionValidatorImplTest.kt

@@ -0,0 +1,72 @@
+package com.shifthackz.aisdv1.core.validation.dimension
+
+import com.shifthackz.aisdv1.core.validation.ValidationResult
+import org.junit.Assert
+import org.junit.Test
+
+class DimensionValidatorImplTest {
+
+    private val validator = DimensionValidatorImpl(MIN, MAX)
+
+    @Test
+    fun `given input is null, expected not valid with Empty error`() {
+        val expected = ValidationResult<DimensionValidator.Error>(
+            isValid = false,
+            validationError = DimensionValidator.Error.Empty,
+        )
+        val actual = validator(null)
+        Assert.assertEquals(expected, actual)
+    }
+
+    @Test
+    fun `given input is empty, expected not valid with Empty error`() {
+        val expected = ValidationResult<DimensionValidator.Error>(
+            isValid = false,
+            validationError = DimensionValidator.Error.Empty,
+        )
+        val actual = validator("")
+        Assert.assertEquals(expected, actual)
+    }
+
+    @Test
+    fun `given input is unparsable to int, expected not valid with Unexpected error`() {
+        val expected = ValidationResult<DimensionValidator.Error>(
+            isValid = false,
+            validationError = DimensionValidator.Error.Unexpected,
+        )
+        val actual = validator("5598❤")
+        Assert.assertEquals(expected, actual)
+    }
+
+    @Test
+    fun `given input is less than minimum allowed value, expected not valid with LessThanMinimum error`() {
+        val expected = ValidationResult<DimensionValidator.Error>(
+            isValid = false,
+            validationError = DimensionValidator.Error.LessThanMinimum(MIN),
+        )
+        val actual = validator("55")
+        Assert.assertEquals(expected, actual)
+    }
+
+    @Test
+    fun `given input is bigger than maximum allowed value, expected not valid with BiggerThanMaximum error`() {
+        val expected = ValidationResult<DimensionValidator.Error>(
+            isValid = false,
+            validationError = DimensionValidator.Error.BiggerThanMaximum(MAX),
+        )
+        val actual = validator("5598")
+        Assert.assertEquals(expected, actual)
+    }
+
+    @Test
+    fun `given input is valid parsable int value, expected valid`() {
+        val expected = ValidationResult<DimensionValidator.Error>(true)
+        val actual = validator("1024")
+        Assert.assertEquals(expected, actual)
+    }
+
+    companion object {
+        private const val MIN = 64
+        private const val MAX = 2048
+    }
+}