Skip to content

Commit 1da9512

Browse files
committed
refactor(test): rename 'TestClass' to 'AnkiTest'
`com.ichi2.anki.libanki.testutils.TestClass` `com.ichi2.anki.libanki.testutils.AnkiTest` This is now for 'LibAnki' only, enforced by the module the name makes the intention of the class much more clear
1 parent dc6ac7b commit 1da9512

File tree

7 files changed

+18
-19
lines changed

7 files changed

+18
-19
lines changed

AnkiDroid/src/test/java/com/ichi2/anki/CardBrowserTest.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ import com.ichi2.anki.libanki.CardType
8282
import com.ichi2.anki.libanki.Note
8383
import com.ichi2.anki.libanki.NotetypeJson
8484
import com.ichi2.anki.libanki.QueueType
85-
import com.ichi2.anki.libanki.testutils.TestClass
85+
import com.ichi2.anki.libanki.testutils.AnkiTest
8686
import com.ichi2.anki.model.CardsOrNotes.CARDS
8787
import com.ichi2.anki.model.CardsOrNotes.NOTES
8888
import com.ichi2.anki.model.SortType
@@ -1688,7 +1688,7 @@ suspend fun CardBrowserViewModel.setFlagFilterSync(flag: Flag) {
16881688
searchJob?.join()
16891689
}
16901690

1691-
fun TestClass.flagCardForNote(
1691+
fun AnkiTest.flagCardForNote(
16921692
n: Note,
16931693
flag: Flag,
16941694
) {

AnkiDroid/src/test/java/com/ichi2/anki/RobolectricTest.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ import com.ichi2.anki.libanki.Collection
4646
import com.ichi2.anki.libanki.Note
4747
import com.ichi2.anki.libanki.NotetypeJson
4848
import com.ichi2.anki.libanki.Storage
49-
import com.ichi2.anki.libanki.testutils.TestClass
49+
import com.ichi2.anki.libanki.testutils.AnkiTest
5050
import com.ichi2.anki.libanki.testutils.TestCollectionManager
5151
import com.ichi2.anki.observability.ChangeManager
5252
import com.ichi2.anki.observability.undoableOp
@@ -87,7 +87,7 @@ import timber.log.Timber
8787
import kotlin.test.assertNotNull
8888

8989
open class RobolectricTest :
90-
TestClass,
90+
AnkiTest,
9191
AndroidTest {
9292
@Suppress("PLATFORM_CLASS_MAPPED_TO_KOTLIN")
9393
private fun Any.wait(timeMs: Long) = (this as Object).wait(timeMs)

AnkiDroid/src/test/java/com/ichi2/anki/browser/CardBrowserViewModelTest.kt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ import com.ichi2.anki.libanki.Note
5858
import com.ichi2.anki.libanki.QueueType
5959
import com.ichi2.anki.libanki.QueueType.ManuallyBuried
6060
import com.ichi2.anki.libanki.QueueType.New
61-
import com.ichi2.anki.libanki.testutils.TestClass
61+
import com.ichi2.anki.libanki.testutils.AnkiTest
6262
import com.ichi2.anki.model.CardsOrNotes
6363
import com.ichi2.anki.model.SortType
6464
import com.ichi2.anki.model.SortType.NO_SORTING
@@ -1163,7 +1163,7 @@ internal suspend fun CardBrowserViewModel.invokeInitialSearch() {
11631163
Timber.v("initial search completed")
11641164
}
11651165

1166-
private fun TestClass.assertAllSuspended(context: String) {
1166+
private fun AnkiTest.assertAllSuspended(context: String) {
11671167
val cards = col.findCards("").map { col.getCard(it) }
11681168
assertThat("performance", cards.size, lessThan(10))
11691169

@@ -1176,7 +1176,7 @@ private fun TestClass.assertAllSuspended(context: String) {
11761176
}
11771177
}
11781178

1179-
private fun TestClass.assertAllUnsuspended(context: String) {
1179+
private fun AnkiTest.assertAllUnsuspended(context: String) {
11801180
val cards = col.findCards("").map { col.getCard(it) }
11811181
assertThat("performance", cards.size, lessThan(10))
11821182

@@ -1189,18 +1189,18 @@ private fun TestClass.assertAllUnsuspended(context: String) {
11891189
}
11901190
}
11911191

1192-
private fun TestClass.suspendAll() {
1192+
private fun AnkiTest.suspendAll() {
11931193
col.findCards("").also { cards ->
11941194
col.sched.suspendCards(col.findCards(""))
11951195
Timber.d("suspended %d cards", cards.size)
11961196
}
11971197
}
11981198

1199-
private fun TestClass.suspendCards(vararg cardIds: CardId) {
1199+
private fun AnkiTest.suspendCards(vararg cardIds: CardId) {
12001200
col.sched.suspendCards(ids = cardIds.toList())
12011201
}
12021202

1203-
private fun TestClass.suspendNote(note: Note) {
1203+
private fun AnkiTest.suspendNote(note: Note) {
12041204
col.sched.suspendCards(note.cardIds(col))
12051205
}
12061206

AnkiDroid/src/test/java/com/ichi2/anki/instanteditor/InstantEditorViewModelTest.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import com.ichi2.anki.RobolectricTest
2323
import com.ichi2.anki.instantnoteeditor.InstantEditorViewModel
2424
import com.ichi2.anki.instantnoteeditor.InstantNoteEditorActivity
2525
import com.ichi2.anki.instantnoteeditor.SaveNoteResult
26-
import com.ichi2.anki.libanki.testutils.TestClass
26+
import com.ichi2.anki.libanki.testutils.AnkiTest
2727
import org.junit.Assert.assertEquals
2828
import org.junit.Assert.assertTrue
2929
import org.junit.Test
@@ -231,7 +231,7 @@ class InstantEditorViewModelTest : RobolectricTest() {
231231
}
232232

233233
companion object {
234-
fun TestClass.runInstantEditorViewModelTest(
234+
fun AnkiTest.runInstantEditorViewModelTest(
235235
initViewModel: () -> InstantEditorViewModel = { InstantEditorViewModel() },
236236
testBody: suspend InstantEditorViewModel.() -> Unit,
237237
) = runTest {

AnkiDroid/src/test/java/com/ichi2/testutils/JvmTest.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import com.ichi2.anki.common.time.TimeManager
2424
import com.ichi2.anki.ioDispatcher
2525
import com.ichi2.anki.libanki.Collection
2626
import com.ichi2.anki.libanki.Storage
27-
import com.ichi2.anki.libanki.testutils.TestClass
27+
import com.ichi2.anki.libanki.testutils.AnkiTest
2828
import com.ichi2.anki.libanki.testutils.TestCollectionManager
2929
import com.ichi2.anki.observability.ChangeManager
3030
import kotlinx.coroutines.Dispatchers
@@ -43,7 +43,7 @@ import org.robolectric.junit.rules.TimeoutRule
4343
import timber.log.Timber
4444
import timber.log.Timber.Forest.plant
4545

46-
open class JvmTest : TestClass {
46+
open class JvmTest : AnkiTest {
4747
@get:Rule
4848
val timeoutRule: TimeoutRule = TimeoutRule.seconds(60)
4949

AnkiDroid/src/test/java/com/ichi2/testutils/ext/TestClass.kt renamed to AnkiDroid/src/test/java/com/ichi2/testutils/ext/AnkiTest.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ import anki.collection.OpChanges
2020
import com.ichi2.anki.libanki.Consts
2121
import com.ichi2.anki.libanki.Note
2222
import com.ichi2.anki.libanki.NotetypeJson
23-
import com.ichi2.anki.libanki.testutils.TestClass
23+
import com.ichi2.anki.libanki.testutils.AnkiTest
2424
import com.ichi2.anki.observability.undoableOp
2525

26-
suspend fun TestClass.addBasicNoteWithOp(
26+
suspend fun AnkiTest.addBasicNoteWithOp(
2727
fields: List<String> = listOf("foo", "bar"),
2828
noteType: NotetypeJson = col.notetypes.byName("Basic")!!,
2929
): Note =

libanki/testutils/src/main/java/com/ichi2/anki/libanki/testutils/TestClass.kt renamed to libanki/testutils/src/main/java/com/ichi2/anki/libanki/testutils/AnkiTest.kt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ import com.ichi2.anki.libanki.NotetypeJson
2828
import com.ichi2.anki.libanki.Notetypes
2929
import com.ichi2.anki.libanki.QueueType
3030
import com.ichi2.anki.libanki.exception.ConfirmModSchemaException
31-
import com.ichi2.anki.libanki.testutils.TestCollectionManager
3231
import com.ichi2.anki.libanki.testutils.ext.addNote
3332
import kotlinx.coroutines.Dispatchers
3433
import kotlinx.coroutines.test.StandardTestDispatcher
@@ -47,7 +46,7 @@ import kotlin.time.Duration.Companion.milliseconds
4746
*
4847
* Android (AnkiDroid/Robolectric) is not required for these tests to run
4948
*/
50-
interface TestClass {
49+
interface AnkiTest {
5150
val col: Collection
5251

5352
val collectionManager: TestCollectionManager
@@ -243,7 +242,7 @@ interface TestClass {
243242
/** Helper method to update a card */
244243
fun Card.update(update: Card.() -> Unit): Card {
245244
update(this)
246-
this@TestClass.col.updateCard(this, skipUndoEntry = true)
245+
this@AnkiTest.col.updateCard(this, skipUndoEntry = true)
247246
return this
248247
}
249248

0 commit comments

Comments
 (0)