Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cache test #10

Merged
merged 8 commits into from Sep 9, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion buildSrc/src/main/kotlin/AppConfig.kt
Expand Up @@ -10,4 +10,6 @@ object AppConfig {
const val versionCode: Int = 1

const val versionName: String = "1.0"
}

const val testInstrumentationRunner: String = "androidx.test.runner.AndroidJUnitRunner"
}
4 changes: 4 additions & 0 deletions buildSrc/src/main/kotlin/Library.kt
Expand Up @@ -55,6 +55,10 @@ object Library {

// Mockito
const val mockito = "org.mockito.kotlin:mockito-kotlin:${Version.mockito}"

// AndroidXTest
const val androidXTest: String = "androidx.test.ext:junit:${Version.testExt}"
const val robolectric: String = "org.robolectric:robolectric:${Version.robolectric}"
}

object Project {
Expand Down
4 changes: 4 additions & 0 deletions buildSrc/src/main/kotlin/Version.kt
Expand Up @@ -33,6 +33,10 @@ object Version {
// Mockito
const val mockito: String = "3.2.0"

// AndroidXTest
const val testExt: String = "1.1.3"
const val robolectric: String = "4.5.1"

// ktlint
const val ktlint: String = "0.42.1"
}
1 change: 1 addition & 0 deletions buildSrc/src/main/kotlin/extensions/AndroidAppExtension.kt
Expand Up @@ -22,6 +22,7 @@ private class AndroidAppExtension : ProjectExtension {
minSdk = AppConfig.minSdkVersion
versionCode(AppConfig.versionCode)
versionName(AppConfig.versionName)
testInstrumentationRunner = AppConfig.testInstrumentationRunner
}

buildTypes {
Expand Down
8 changes: 2 additions & 6 deletions buildSrc/src/main/kotlin/plugin/AndroidLibraryPlugin.kt
Expand Up @@ -25,19 +25,15 @@ class AndroidLibraryPlugin : BasePlugin() {
get() = {
implementation(
Library.daggerHiltAndroid,
Library.coroutines,
Library.room
Library.coroutines
)
testImplementation(
Library.junit,
Library.truth,
Library.mockito,
Library.coroutinesTest
)
kapt(
Library.daggerHiltCompiler,
Library.roomCompiler
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Try not to add module specific dependencies to the general Android Library plugin

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, thank you

)
kapt(Library.daggerHiltCompiler)
}

override val extensions: Array<ProjectExtension>
Expand Down
10 changes: 10 additions & 0 deletions cache/build.gradle.kts
@@ -1,3 +1,13 @@
plugins {
androidLib
}

dependencies {
implementation(Library.room)
kapt(Library.roomCompiler)

testImplementation(
Library.androidXTest,
Library.robolectric
)
}
Expand Up @@ -2,24 +2,25 @@ package com.example.expenselogger.cache.dao

import androidx.room.Dao
import androidx.room.Insert
import androidx.room.OnConflictStrategy
import androidx.room.Query
import androidx.room.Update
import com.example.expenselogger.cache.entity.ExpenseEntity

@Dao
internal interface ExpenseDao {
@Insert
fun insertExpense(expense: ExpenseEntity)
@Insert(onConflict = OnConflictStrategy.REPLACE)
suspend fun insertExpense(expense: ExpenseEntity): Long

@Update
fun updateExpense(expense: ExpenseEntity)
suspend fun updateExpense(expense: ExpenseEntity)

@Query("SELECT * FROM expense WHERE id = :id")
fun getExpense(id: Long): ExpenseEntity
suspend fun getExpense(id: Long): ExpenseEntity?

@Query("SELECT * FROM expense ORDER BY date ASC")
public fun getExpenses(): List<ExpenseEntity>
suspend fun getExpenses(): List<ExpenseEntity>

@Query("DELETE FROM expense WHERE id = :id")
fun deleteExpense(id: Long)
suspend fun deleteExpense(id: Long)
}
Expand Up @@ -6,15 +6,15 @@ import androidx.room.PrimaryKey

@Entity(tableName = "expense")
public data class ExpenseEntity(
@PrimaryKey(autoGenerate = true)
@ColumnInfo(name = "id")
val id: Long,
@ColumnInfo(name = "name")
val name: String,
@ColumnInfo(name = "amount")
val amount: Double,
@ColumnInfo(name = "date")
val date: Long,
@ColumnInfo(name = "info")
val info: String
val info: String,
@PrimaryKey(autoGenerate = true)
@ColumnInfo(name = "id")
val id: Long = 0L
)
Expand Up @@ -3,10 +3,9 @@ package com.example.expenselogger.cache.repository
import com.example.expenselogger.cache.entity.ExpenseEntity

public interface ExpenseRepository {

public fun insertExpense(expenseEntity: ExpenseEntity)
public fun updateExpense(expenseEntity: ExpenseEntity)
public fun getExpense(id: Long): ExpenseEntity?
public fun getExpenses(): List<ExpenseEntity>
public fun deleteExpense(id: Long)
public suspend fun insertExpense(expenseEntity: ExpenseEntity): Long
public suspend fun updateExpense(expenseEntity: ExpenseEntity)
public suspend fun getExpense(id: Long): ExpenseEntity?
public suspend fun getExpenses(): List<ExpenseEntity>
public suspend fun deleteExpense(id: Long)
}
Expand Up @@ -8,23 +8,21 @@ internal class ExpenseRepositoryImpl @Inject constructor(
private val expenseDao: ExpenseDao
) : ExpenseRepository {

override fun insertExpense(expenseEntity: ExpenseEntity) {
expenseDao.insertExpense(expenseEntity)
}
override suspend fun insertExpense(
expenseEntity: ExpenseEntity
): Long = expenseDao.insertExpense(expenseEntity)

override fun updateExpense(expenseEntity: ExpenseEntity) {
expenseDao.updateExpense(expenseEntity)
}
override suspend fun updateExpense(
expenseEntity: ExpenseEntity
) = expenseDao.updateExpense(expenseEntity)

override fun getExpense(id: Long): ExpenseEntity? {
return expenseDao.getExpense(id)
}
override suspend fun getExpense(
id: Long
): ExpenseEntity? = expenseDao.getExpense(id)

override fun getExpenses(): List<ExpenseEntity> {
return expenseDao.getExpenses()
}
override suspend fun getExpenses(): List<ExpenseEntity> = expenseDao.getExpenses()

override fun deleteExpense(id: Long) {
override suspend fun deleteExpense(id: Long) {
expenseDao.deleteExpense(id)
}
}
@@ -0,0 +1,13 @@
package com.example.expenselogger.cache.entity

import java.util.Date

internal object DummyData {

val expenseEntity: ExpenseEntity = ExpenseEntity(
name = "Valentine outing",
amount = 13_500.00,
date = Date(1613311218000).time, // February 14th 2021
info = "Valentine outing with bae"
)
}
@@ -0,0 +1,88 @@
package com.example.expenselogger.cache.repository

import androidx.room.Room
import androidx.test.core.app.ApplicationProvider
import androidx.test.ext.junit.runners.AndroidJUnit4
import com.example.expenselogger.cache.ExpenseDatabase
import com.example.expenselogger.cache.entity.DummyData
import com.google.common.truth.Truth.assertThat
import kotlinx.coroutines.runBlocking
import org.junit.After
import org.junit.Before
import org.junit.Test
import org.junit.runner.RunWith

@RunWith(AndroidJUnit4::class)
internal class ExpenseRepositoryTest {

private lateinit var expenseRepository: ExpenseRepository
private lateinit var expenseDatabase: ExpenseDatabase

@Before
fun setup() {
expenseDatabase = Room.inMemoryDatabaseBuilder(
ApplicationProvider.getApplicationContext(),
ExpenseDatabase::class.java
).allowMainThreadQueries().build()

expenseRepository = ExpenseRepositoryImpl(
expenseDatabase.expenseDao
)
}

@After
fun `tearDown()`() {
expenseDatabase.close()
}

@Test
fun `verify that insertExpense inserts Expense into database`(): Unit =
runBlocking {
val expenseEntity = DummyData.expenseEntity
val id = expenseRepository.insertExpense(expenseEntity)
val actual = expenseRepository.getExpense(id)
assertThat(actual).isEqualTo(expenseEntity.copy(id = id))
}

@Test
fun `verify that updateExpense updates an Expense in the database`(): Unit =
runBlocking {
val expenseEntity = DummyData.expenseEntity
val id = expenseRepository.insertExpense(expenseEntity)
val newInfo = "Valentine outing with now ex bae"
val expenseEntityUpdate = expenseEntity.copy(id = id, info = newInfo)
expenseRepository.updateExpense(expenseEntityUpdate)
val actual = expenseRepository.getExpense(id)
assertThat(actual).isEqualTo(expenseEntityUpdate)
}

@Test
fun `verify that getExpenses gets list of expenses`(): Unit = runBlocking {
val expense = DummyData.expenseEntity
val id = expenseRepository.insertExpense(expense)
val id2 = expenseRepository.insertExpense(expense)
Comment on lines +62 to +63
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't really understand inserting the expense into the database twice. Is it like to sort of simulate multiple entries?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, all clear now. Thank you

val actual = expenseRepository.getExpenses()
val expected = listOf(
expense.copy(id = id),
expense.copy(id = id2)
)
assertThat(actual).isEqualTo(expected)
}

@Test
fun `verify that getExpense gets an expense`(): Unit = runBlocking {
val expenseEntity = DummyData.expenseEntity
val id = expenseRepository.insertExpense(expenseEntity)
val actual = expenseRepository.getExpense(id)
assertThat(actual).isEqualTo(expenseEntity.copy(id = id))
}

@Test
fun `verify that deleteExpense deletes an expense`(): Unit = runBlocking {
val expenseEntity = DummyData.expenseEntity
val id = expenseRepository.insertExpense(expenseEntity)
expenseRepository.deleteExpense(id)
val actual = expenseRepository.getExpense(id)
assertThat(actual).isNull()
}
}