Skip to content

Commit b36bf3d

Browse files
david-allisonmikehardy
authored andcommitted
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 2d8cc5e commit b36bf3d

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
@@ -84,7 +84,7 @@ import com.ichi2.anki.libanki.CardType
8484
import com.ichi2.anki.libanki.Note
8585
import com.ichi2.anki.libanki.NotetypeJson
8686
import com.ichi2.anki.libanki.QueueType
87-
import com.ichi2.anki.libanki.testutils.TestClass
87+
import com.ichi2.anki.libanki.testutils.AnkiTest
8888
import com.ichi2.anki.model.CardsOrNotes.CARDS
8989
import com.ichi2.anki.model.CardsOrNotes.NOTES
9090
import com.ichi2.anki.model.SortType
@@ -1633,7 +1633,7 @@ suspend fun CardBrowserViewModel.setFlagFilterSync(flag: Flag) {
16331633
searchJob?.join()
16341634
}
16351635

1636-
fun TestClass.flagCardForNote(
1636+
fun AnkiTest.flagCardForNote(
16371637
n: Note,
16381638
flag: Flag,
16391639
) {

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.observability.ChangeManager
5151
import com.ichi2.anki.observability.undoableOp
5252
import com.ichi2.anki.preferences.sharedPrefs
@@ -88,7 +88,7 @@ import timber.log.Timber
8888
import kotlin.test.assertNotNull
8989

9090
open class RobolectricTest :
91-
TestClass,
91+
AnkiTest,
9292
AndroidTest {
9393
@Suppress("PLATFORM_CLASS_MAPPED_TO_KOTLIN")
9494
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
@@ -64,7 +64,7 @@ import com.ichi2.anki.libanki.Note
6464
import com.ichi2.anki.libanki.QueueType
6565
import com.ichi2.anki.libanki.QueueType.ManuallyBuried
6666
import com.ichi2.anki.libanki.QueueType.New
67-
import com.ichi2.anki.libanki.testutils.TestClass
67+
import com.ichi2.anki.libanki.testutils.AnkiTest
6868
import com.ichi2.anki.model.CardsOrNotes
6969
import com.ichi2.anki.model.SortType
7070
import com.ichi2.anki.model.SortType.NO_SORTING
@@ -1287,7 +1287,7 @@ internal suspend fun CardBrowserViewModel.invokeInitialSearch() {
12871287
Timber.v("initial search completed")
12881288
}
12891289

1290-
private fun TestClass.assertAllSuspended(context: String) {
1290+
private fun AnkiTest.assertAllSuspended(context: String) {
12911291
val cards = col.findCards("").map { col.getCard(it) }
12921292
assertThat("performance", cards.size, lessThan(10))
12931293

@@ -1300,7 +1300,7 @@ private fun TestClass.assertAllSuspended(context: String) {
13001300
}
13011301
}
13021302

1303-
private fun TestClass.assertAllUnsuspended(context: String) {
1303+
private fun AnkiTest.assertAllUnsuspended(context: String) {
13041304
val cards = col.findCards("").map { col.getCard(it) }
13051305
assertThat("performance", cards.size, lessThan(10))
13061306

@@ -1313,18 +1313,18 @@ private fun TestClass.assertAllUnsuspended(context: String) {
13131313
}
13141314
}
13151315

1316-
private fun TestClass.suspendAll() {
1316+
private fun AnkiTest.suspendAll() {
13171317
col.findCards("").also { cards ->
13181318
col.sched.suspendCards(col.findCards(""))
13191319
Timber.d("suspended %d cards", cards.size)
13201320
}
13211321
}
13221322

1323-
private fun TestClass.suspendCards(vararg cardIds: CardId) {
1323+
private fun AnkiTest.suspendCards(vararg cardIds: CardId) {
13241324
col.sched.suspendCards(ids = cardIds.toList())
13251325
}
13261326

1327-
private fun TestClass.suspendNote(note: Note) {
1327+
private fun AnkiTest.suspendNote(note: Note) {
13281328
col.sched.suspendCards(note.cardIds(col))
13291329
}
13301330

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.observability.ChangeManager
2929
import kotlinx.coroutines.Dispatchers
3030
import kotlinx.coroutines.runBlocking
@@ -44,7 +44,7 @@ import org.robolectric.junit.rules.TimeoutRule
4444
import timber.log.Timber
4545
import timber.log.Timber.Forest.plant
4646

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

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)