forked from ankidroid/Anki-Android
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
test(reviewer): accept different view names, allow retries on custom …
…scheduler without this, `./gradlew jacocoAndroidTestReport` would not work on the command line, but the tests would work in Android Studio, which is quite bizarre adding the retry rule then allowed it to pass on the command line 5 of 5 times
- Loading branch information
Showing
1 changed file
with
209 additions
and
176 deletions.
There are no files selected for viewing
385 changes: 209 additions & 176 deletions
385
AnkiDroid/src/androidTest/java/com/ichi2/anki/ReviewerTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,176 +1,209 @@ | ||
| /* | ||
| * Copyright (c) 2023 | ||
| * | ||
| * This program is free software; you can redistribute it and/or modify it under | ||
| * the terms of the GNU General Public License as published by the Free Software | ||
| * Foundation; either version 3 of the License, or (at your option) any later | ||
| * version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, but WITHOUT ANY | ||
| * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A | ||
| * PARTICULAR PURPOSE. See the GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License along with | ||
| * this program. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
| package com.ichi2.anki | ||
|
|
||
| import androidx.recyclerview.widget.RecyclerView | ||
| import androidx.test.espresso.Espresso.onView | ||
| import androidx.test.espresso.action.ViewActions.click | ||
| import androidx.test.espresso.assertion.ViewAssertions.matches | ||
| import androidx.test.espresso.contrib.RecyclerViewActions | ||
| import androidx.test.espresso.matcher.ViewMatchers.hasDescendant | ||
| import androidx.test.espresso.matcher.ViewMatchers.isDisplayed | ||
| import androidx.test.espresso.matcher.ViewMatchers.withId | ||
| import androidx.test.espresso.matcher.ViewMatchers.withText | ||
| import androidx.test.ext.junit.rules.ActivityScenarioRule | ||
| import androidx.test.ext.junit.runners.AndroidJUnit4 | ||
| import com.ichi2.anki.tests.InstrumentedTest | ||
| import com.ichi2.anki.testutil.GrantStoragePermission.storagePermission | ||
| import com.ichi2.anki.testutil.grantPermissions | ||
| import com.ichi2.anki.testutil.notificationPermission | ||
| import com.ichi2.libanki.Collection | ||
| import com.ichi2.testutils.Flaky | ||
| import com.ichi2.testutils.OS | ||
| import org.hamcrest.MatcherAssert.assertThat | ||
| import org.hamcrest.Matchers.equalTo | ||
| import org.junit.Rule | ||
| import org.junit.Test | ||
| import org.junit.runner.RunWith | ||
| import java.util.concurrent.TimeUnit | ||
|
|
||
| @RunWith(AndroidJUnit4::class) | ||
| class ReviewerTest : InstrumentedTest() { | ||
|
|
||
| // Launch IntroductionActivity instead of DeckPicker activity because in CI | ||
| // builds, it seems to create IntroductionActivity after the DeckPicker, | ||
| // causing the DeckPicker activity to be destroyed. As a consequence, this | ||
| // will throw RootViewWithoutFocusException when Espresso tries to interact | ||
| // with an already destroyed activity. By launching IntroductionActivity, we | ||
| // ensure that IntroductionActivity is launched first and navigate to the | ||
| // DeckPicker -> Reviewer activities | ||
| @get:Rule | ||
| val activityScenarioRule = ActivityScenarioRule(IntroductionActivity::class.java) | ||
|
|
||
| @get:Rule | ||
| val runtimePermissionRule = grantPermissions(storagePermission, notificationPermission) | ||
|
|
||
| @Test | ||
| @Flaky(os = OS.ALL, "Fails on CI with timing issues frequently") | ||
| fun testCustomSchedulerWithCustomData() { | ||
| col.cardStateCustomizer = | ||
| """ | ||
| states.good.normal.review.easeFactor = 3.0; | ||
| states.good.normal.review.scheduledDays = 123; | ||
| customData.good.c += 1; | ||
| """ | ||
| val note = addNoteUsingBasicModel("foo", "bar") | ||
| val card = note.firstCard(col) | ||
| val deck = col.decks.get(note.notetype.did)!! | ||
| card.moveToReviewQueue() | ||
| col.backend.updateCards( | ||
| listOf( | ||
| card.toBackendCard().toBuilder().setCustomData("""{"c":1}""").build() | ||
| ), | ||
| true | ||
| ) | ||
|
|
||
| closeGetStartedScreenIfExists() | ||
| closeBackupCollectionDialogIfExists() | ||
| reviewDeckWithName(deck.name) | ||
|
|
||
| var cardFromDb = col.getCard(card.id).toBackendCard() | ||
| assertThat(cardFromDb.easeFactor, equalTo(card.factor)) | ||
| assertThat(cardFromDb.interval, equalTo(card.ivl)) | ||
| assertThat(cardFromDb.customData, equalTo("""{"c":1}""")) | ||
|
|
||
| clickShowAnswerAndAnswerGood() | ||
|
|
||
| cardFromDb = col.getCard(card.id).toBackendCard() | ||
| assertThat(cardFromDb.easeFactor, equalTo(3000)) | ||
| assertThat(cardFromDb.interval, equalTo(123)) | ||
| assertThat(cardFromDb.customData, equalTo("""{"c":2}""")) | ||
| } | ||
|
|
||
| @Test | ||
| @Flaky(os = OS.ALL, "Fails on CI with timing issues frequently") | ||
| fun testCustomSchedulerWithRuntimeError() { | ||
| // Issue 15035 - runtime errors weren't handled | ||
| col.cardStateCustomizer = "states.this_is_not_defined.normal.review = 12;" | ||
| addNoteUsingBasicModel() | ||
|
|
||
| closeGetStartedScreenIfExists() | ||
| closeBackupCollectionDialogIfExists() | ||
| reviewDeckWithName("Default") | ||
|
|
||
| clickShowAnswer() | ||
|
|
||
| ensureAnswerButtonsAreDisplayed() | ||
| } | ||
|
|
||
| private fun clickOnDeckWithName(deckName: String) { | ||
| onView(withId(R.id.files)).checkWithTimeout(matches(hasDescendant(withText(deckName)))) | ||
| onView(withId(R.id.files)).perform( | ||
| RecyclerViewActions.actionOnItem<RecyclerView.ViewHolder>( | ||
| hasDescendant(withText(deckName)), | ||
| click() | ||
| ) | ||
| ) | ||
| } | ||
|
|
||
| private fun clickOnStudyButtonIfExists() { | ||
| onView(withId(R.id.studyoptions_start)) | ||
| .withFailureHandler { _, _ -> } | ||
| .perform(click()) | ||
| } | ||
|
|
||
| private fun reviewDeckWithName(deckName: String) { | ||
| clickOnDeckWithName(deckName) | ||
| // Adding cards directly to the database while in the Deck Picker screen | ||
| // will not update the page with correct card counts. Hence, clicking | ||
| // on the deck will bring us to the study options page where we need to | ||
| // click on the Study button. If we have added cards to the database | ||
| // before the Deck Picker screen has fully loaded, then we skip clicking | ||
| // the Study button | ||
| clickOnStudyButtonIfExists() | ||
| } | ||
|
|
||
| private fun clickShowAnswerAndAnswerGood() { | ||
| clickShowAnswer() | ||
| ensureAnswerButtonsAreDisplayed() | ||
| onView(withId(R.id.flashcard_layout_ease3)).perform(click()) | ||
| } | ||
|
|
||
| private fun clickShowAnswer() { | ||
| onView(withId(R.id.flashcard_layout_flip)).perform(click()) | ||
| } | ||
|
|
||
| private fun ensureAnswerButtonsAreDisplayed() { | ||
| // We need to wait for the card to fully load to allow enough time for | ||
| // the messages to be passed in and out of the WebView when evaluating | ||
| // the custom JS scheduler code. The ease buttons are hidden until the | ||
| // custom scheduler has finished running | ||
| onView(withId(R.id.flashcard_layout_ease3)).checkWithTimeout( | ||
| matches(isDisplayed()), | ||
| 100, | ||
| // Increase to a max of 30 seconds because CI builds can be very | ||
| // slow | ||
| TimeUnit.SECONDS.toMillis(30) | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| private var Collection.cardStateCustomizer: String? | ||
| get() = config.get("cardStateCustomizer") | ||
| set(value) { config.set("cardStateCustomizer", value) } | ||
|
|
||
| fun closeGetStartedScreenIfExists() { | ||
| onView(withId(R.id.get_started)).withFailureHandler { _, _ -> }.perform(click()) | ||
| } | ||
|
|
||
| fun closeBackupCollectionDialogIfExists() { | ||
| onView(withText(R.string.button_backup_later)) | ||
| .withFailureHandler { _, _ -> } | ||
| .perform(click()) | ||
| } | ||
| /* | ||
| * Copyright (c) 2023 | ||
| * | ||
| * This program is free software; you can redistribute it and/or modify it under | ||
| * the terms of the GNU General Public License as published by the Free Software | ||
| * Foundation; either version 3 of the License, or (at your option) any later | ||
| * version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, but WITHOUT ANY | ||
| * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A | ||
| * PARTICULAR PURPOSE. See the GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License along with | ||
| * this program. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
| package com.ichi2.anki | ||
|
|
||
| import androidx.recyclerview.widget.RecyclerView | ||
| import androidx.test.espresso.Espresso.onView | ||
| import androidx.test.espresso.NoMatchingViewException | ||
| import androidx.test.espresso.action.ViewActions.click | ||
| import androidx.test.espresso.assertion.ViewAssertions.matches | ||
| import androidx.test.espresso.contrib.RecyclerViewActions | ||
| import androidx.test.espresso.matcher.ViewMatchers.hasDescendant | ||
| import androidx.test.espresso.matcher.ViewMatchers.isDisplayed | ||
| import androidx.test.espresso.matcher.ViewMatchers.withId | ||
| import androidx.test.espresso.matcher.ViewMatchers.withResourceName | ||
| import androidx.test.espresso.matcher.ViewMatchers.withText | ||
| import androidx.test.ext.junit.rules.ActivityScenarioRule | ||
| import androidx.test.ext.junit.runners.AndroidJUnit4 | ||
| import com.ichi2.anki.tests.InstrumentedTest | ||
| import com.ichi2.anki.tests.libanki.RetryRule | ||
| import com.ichi2.anki.testutil.GrantStoragePermission.storagePermission | ||
| import com.ichi2.anki.testutil.ThreadUtils | ||
| import com.ichi2.anki.testutil.grantPermissions | ||
| import com.ichi2.anki.testutil.notificationPermission | ||
| import com.ichi2.libanki.Collection | ||
| import com.ichi2.testutils.Flaky | ||
| import com.ichi2.testutils.OS | ||
| import org.hamcrest.MatcherAssert.assertThat | ||
| import org.hamcrest.Matchers.equalTo | ||
| import org.junit.Rule | ||
| import org.junit.Test | ||
| import org.junit.runner.RunWith | ||
| import java.lang.AssertionError | ||
|
|
||
| @RunWith(AndroidJUnit4::class) | ||
| class ReviewerTest : InstrumentedTest() { | ||
|
|
||
| // Launch IntroductionActivity instead of DeckPicker activity because in CI | ||
| // builds, it seems to create IntroductionActivity after the DeckPicker, | ||
| // causing the DeckPicker activity to be destroyed. As a consequence, this | ||
| // will throw RootViewWithoutFocusException when Espresso tries to interact | ||
| // with an already destroyed activity. By launching IntroductionActivity, we | ||
| // ensure that IntroductionActivity is launched first and navigate to the | ||
| // DeckPicker -> Reviewer activities | ||
| @get:Rule | ||
| val activityScenarioRule = ActivityScenarioRule(IntroductionActivity::class.java) | ||
|
|
||
| @get:Rule | ||
| val runtimePermissionRule = grantPermissions(storagePermission, notificationPermission) | ||
|
|
||
| @get:Rule | ||
| val retry = RetryRule(3) | ||
|
|
||
| @Test | ||
| @Flaky(os = OS.ALL, "Fails on CI with timing issues frequently") | ||
| fun testCustomSchedulerWithCustomData() { | ||
| col.cardStateCustomizer = | ||
| """ | ||
| states.good.normal.review.easeFactor = 3.0; | ||
| states.good.normal.review.scheduledDays = 123; | ||
| customData.good.c += 1; | ||
| """ | ||
| val note = addNoteUsingBasicModel("foo", "bar") | ||
| val card = note.firstCard(col) | ||
| val deck = col.decks.get(note.notetype.did)!! | ||
| card.moveToReviewQueue() | ||
| col.backend.updateCards( | ||
| listOf( | ||
| card.toBackendCard().toBuilder().setCustomData("""{"c":1}""").build() | ||
| ), | ||
| true | ||
| ) | ||
|
|
||
| closeGetStartedScreenIfExists() | ||
| closeBackupCollectionDialogIfExists() | ||
| reviewDeckWithName(deck.name) | ||
|
|
||
| var cardFromDb = col.getCard(card.id).toBackendCard() | ||
| assertThat(cardFromDb.easeFactor, equalTo(card.factor)) | ||
| assertThat(cardFromDb.interval, equalTo(card.ivl)) | ||
| assertThat(cardFromDb.customData, equalTo("""{"c":1}""")) | ||
|
|
||
| clickShowAnswerAndAnswerGood() | ||
|
|
||
| cardFromDb = col.getCard(card.id).toBackendCard() | ||
| try { | ||
| assertThat(cardFromDb.easeFactor, equalTo(3000)) | ||
| assertThat(cardFromDb.interval, equalTo(123)) | ||
| assertThat(cardFromDb.customData, equalTo("""{"c":2}""")) | ||
| } catch (e: Exception) { | ||
| ThreadUtils.sleep(2000) | ||
| cardFromDb = col.getCard(card.id).toBackendCard() | ||
| assertThat(cardFromDb.easeFactor, equalTo(3000)) | ||
| assertThat(cardFromDb.interval, equalTo(123)) | ||
| assertThat(cardFromDb.customData, equalTo("""{"c":2}""")) | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| @Flaky(os = OS.ALL, "Fails on CI with timing issues frequently") | ||
| fun testCustomSchedulerWithRuntimeError() { | ||
| // Issue 15035 - runtime errors weren't handled | ||
| col.cardStateCustomizer = "states.this_is_not_defined.normal.review = 12;" | ||
| addNoteUsingBasicModel() | ||
|
|
||
| closeGetStartedScreenIfExists() | ||
| closeBackupCollectionDialogIfExists() | ||
| reviewDeckWithName("Default") | ||
|
|
||
| clickShowAnswer() | ||
|
|
||
| ensureAnswerButtonsAreDisplayed() | ||
| } | ||
|
|
||
| private fun clickOnDeckWithName(deckName: String) { | ||
| onView(withId(R.id.files)).checkWithTimeout(matches(hasDescendant(withText(deckName)))) | ||
| onView(withId(R.id.files)).perform( | ||
| RecyclerViewActions.actionOnItem<RecyclerView.ViewHolder>( | ||
| hasDescendant(withText(deckName)), | ||
| click() | ||
| ) | ||
| ) | ||
| } | ||
|
|
||
| private fun clickOnStudyButtonIfExists() { | ||
| onView(withId(R.id.studyoptions_start)) | ||
| .withFailureHandler { _, _ -> } | ||
| .perform(click()) | ||
| } | ||
|
|
||
| private fun reviewDeckWithName(deckName: String) { | ||
| clickOnDeckWithName(deckName) | ||
| // Adding cards directly to the database while in the Deck Picker screen | ||
| // will not update the page with correct card counts. Hence, clicking | ||
| // on the deck will bring us to the study options page where we need to | ||
| // click on the Study button. If we have added cards to the database | ||
| // before the Deck Picker screen has fully loaded, then we skip clicking | ||
| // the Study button | ||
| clickOnStudyButtonIfExists() | ||
| } | ||
|
|
||
| private fun clickShowAnswerAndAnswerGood() { | ||
| clickShowAnswer() | ||
| ensureAnswerButtonsAreDisplayed() | ||
| try { | ||
| // ...on the command line it has resource name "good_button"... | ||
| onView(withResourceName("good_button")).perform(click()) | ||
| } catch (e: NoMatchingViewException) { | ||
| // ...but in Android Studio it has resource name "flashcard_layout_ease3" !? | ||
| onView(withResourceName("flashcard_layout_ease3")).perform(click()) | ||
| } | ||
| } | ||
|
|
||
| private fun clickShowAnswer() { | ||
| try { | ||
| // ... on the command line, it has resource name "show_answer"... | ||
| onView(withResourceName("show_answer")).perform(click()) | ||
| } catch (e: NoMatchingViewException) { | ||
| // ... but in Android Studio it has resource name "flashcard_layout_flip" !? | ||
| onView(withResourceName("flashcard_layout_flip")).perform(click()) | ||
| } | ||
| } | ||
|
|
||
| private fun ensureAnswerButtonsAreDisplayed() { | ||
| // We need to wait for the card to fully load to allow enough time for | ||
| // the messages to be passed in and out of the WebView when evaluating | ||
| // the custom JS scheduler code. The ease buttons are hidden until the | ||
| // custom scheduler has finished running | ||
| try { | ||
| // ...on the command line it has resource name "good_button"... | ||
| onView(withResourceName("good_button")).checkWithTimeout( | ||
| matches(isDisplayed()), | ||
| 100 | ||
| ) | ||
| } catch (e: AssertionError) { | ||
| // ...but in Android Studio it has resource name "flashcard_layout_ease3" !? | ||
| onView(withResourceName("flashcard_layout_ease3")).checkWithTimeout( | ||
| matches(isDisplayed()), | ||
| 100 | ||
| ) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private var Collection.cardStateCustomizer: String? | ||
| get() = config.get("cardStateCustomizer") | ||
| set(value) { config.set("cardStateCustomizer", value) } | ||
|
|
||
| fun closeGetStartedScreenIfExists() { | ||
| onView(withId(R.id.get_started)).withFailureHandler { _, _ -> }.perform(click()) | ||
| } | ||
|
|
||
| fun closeBackupCollectionDialogIfExists() { | ||
| onView(withText(R.string.button_backup_later)) | ||
| .withFailureHandler { _, _ -> } | ||
| .perform(click()) | ||
| } |