Screenshot tests edited

.github/workflows/tutorial.yml

@@ -12,5 +12,5 @@ jobs:
         with:
           python-version: 3.x
       - run: pip install mkdocs-material
-      - run: pip install mkdocs-static-i18n
+      - run: pip install mkdocs-static-i18n==0.56
       - run: mkdocs gh-deploy --force

docs/Tutorial/Screenshot_tests_1.en.md

@@ -4,9 +4,9 @@
 
 ## Продвинутый уровень
 
-Для успешного прохождения предыдущих уроков было достаточно базовых навыков программирования на Kotlin, знания Android разработки при этом не требовались, и успешно пройти все уроки могли как разработчики, так и тестировщики. Но для нашей сегодняшней темы, а также всех последующих, нужно понимание того, как разрабатываются приложения, чем отличаются архитектурные шаблоны MVVM и MVP, как применять Dependency Injection и другое.
+Ранее для успешного прохождения уроков было достаточно базовых навыков программирования на Kotlin, знания Android-разработки не требовались. Однако сегодня мы начинаем углубленное изучение фреймворка Kaspresso, и для последующих тем потребуется более глубокое понимание устройства приложений, архитектурного шаблона MVVM, применения Dependency Injection и других концепций.
 
-Поэтому предполагается, что все дальнейшие действия (или бОльшая их часть), которые мы будем проходить в курсе, находятся в зоне ответственности разработчиков, и эти уроки ориентированы на них. Если же с Android разработкой вы не знакомы, то можете все равно проходить эти уроки, чтобы иметь представление о возможностях Kaspresso, но учитывайте тот факт, что часть материала может быть непонятной.
+Если у вас возникают трудности с пониманием этих тем, вы все равно можете приступить к прохождению уроков, чтобы иметь представление о возможностях Kaspresso. Однако имейте в виду, что часть материала может быть непонятной на данном этапе.
 
 ## Тестирование LoginActivity на разных локалях
 
@@ -32,13 +32,19 @@
 
 Возникшую проблему могут решить скриншот-тесты. Их суть заключается в том, что для всех экранов, где пользователю отображаются строки, создаются так называемые «скриншотилки» – классы, которые делают скриншоты экрана во всех необходимых состояниях и для всех поддерживаемых языков.
 
-После выполнения таких тестов скриншоты складываются в определенные папки. Тогда люди, ответственные за переводы и строки, смогут просмотреть снимки и убедиться, что для всех локалей и для всех состояний используются корректные значения.
+После выполнения таких тестов скриншоты складываются в определенные папки. Затем их можно посмотреть и убедиться, что для всех локалей и для всех состояний используются корректные значения.
 
-Screenshot-тесты будут отличаться от тестов, которые мы писали ранее:
+Для создания screenshot-тестов можно воспользоваться уже написанными ранее тестами, внеся в них несколько изменений. В таком случае будут выполняться те же проверки, что и раньше, но также добавится сохранение скриншотов на определенных этапах. Так можно сделать, но это не считается хорошей практикой.
 
-Во-первых, нас интересуют только строки на определенном экране, поэтому нет необходимости проходить весь процесс от старта приложения до открытия нужного экрана. Вместо этого, в тесте мы сразу будем открывать [Activity]( https://developer.android.com/reference/android/app/Activity) или [Fragment]( https://developer.android.com/guide/fragments), скриншоты которого хотим получить.
+Дело в том, что screenshot-тесты предназначены для того, чтобы предоставить снимки определенного экрана во всех возможных состояниях и для всех локалей. В некоторых случаях получение всех возможных состояний экрана может занять длительное время.
 
-Во-вторых, мы хотим получить снимки всех возможных состояний экрана для каждой локали, поэтому добавлять проверки элементов или выполнять шаги, имитирующие действия пользователя, как мы делали ранее, мы не будем. Наша цель –
+К примеру, вам нужно узнать, как будет выглядеть экран, если пользователь только что прошел процесс регистрации. Тогда, для того чтобы получить снимок экрана, вам придется проходить регистрацию заново, причем делать это для каждой локали. Тогда один прогон теста может занять несколько минут вместо двух-трех секунд.
+
+По этой причине screenshot-тесты обычно делают максимально "легковесными":
+
+Во-первых, вместо того, чтобы проходить весь процесс от старта приложения до открытия нужного экрана, мы сразу будем открывать [Activity]( https://developer.android.com/reference/android/app/Activity) или [Fragment]( https://developer.android.com/guide/fragments), скриншоты которого хотим получить.
+
+Во-вторых, мы не будем добавлять проверки элементов или выполнять шаги, имитирующие действия пользователя, как мы делали ранее. Наши цели –
 
 <ol>
 <li>Открыть экран</li>
@@ -49,7 +55,7 @@ Screenshot-тесты будут отличаться от тестов, кот
 
 Дальше нужно поменять локаль и повторить все перечисленные действия.
 
-Подробнее про состояния (или стейты, как их часто называют), и как их правильно устанавливать, мы поговорим позже, а сейчас напишем простой screenshot-тест, который откроет экран LoginActivity, сделает скриншот, затем сменит язык на устройстве на французский и снова сделает скриншот.
+Подробнее про состояния (или стейты, как их часто называют), и как их правильно устанавливать, мы поговорим в следующем уроке, а сейчас напишем простой screenshot-тест, который откроет экран LoginActivity, сделает скриншот, затем сменит язык на устройстве на французский и снова сделает скриншот.
 
 ## Простой screenshot-тест
 
@@ -122,15 +128,15 @@ class LoginActivityScreenshots : DocLocScreenshotTestCase(locales = "en, fr") {
 
     @Test
     fun takeScreenshots() = run {
-        step("Take screenshots initial state") {
+        step("Take initial state screenshots") {
 
         }
     }
 }
 
 ```
 
-Для того чтобы сделать скриншоты, и чтобы эти скриншоты были сохранены в правильные папки на устройстве, необходимо вызвать метод `captureScreenshot`. В качестве параметра методу необходимо передать название файла, это может быть любая строка – по этому имени вы сможете найти скриншот на устройстве.
+Чтобы сделать скриншоты и сохранить их в правильные папки на устройстве, необходимо вызвать метод `captureScreenshot`. В качестве параметра методу необходимо передать название файла, это может быть любая строка – по этому имени вы сможете найти скриншот на устройстве.
 
 ```kotlin
 package com.kaspersky.kaspresso.tutorial.screenshot_tests
@@ -148,48 +154,19 @@ class LoginActivityScreenshots : DocLocScreenshotTestCase(locales = "en, fr") {
 
     @Test
     fun takeScreenshots() = run {
-        step("Take screenshots initial state") {
+        step("Take initial state screenshots") {
             captureScreenshot("Initial state")
         }
     }
 }
 
 ```
 
-Разрешение на доступ к файлам здесь давать не нужно, это реализовано «под капотом». На данном этапе мы сделали все, что нужно, чтобы получить скриншоты экрана и посмотреть, как выглядит приложение на разных локалях, но желательно сделать еще одно изменение.
+Разрешение на доступ к файлам здесь давать не нужно, это реализовано «под капотом». На данном этапе мы сделали все необходимое, чтобы получить скриншоты экрана и посмотреть, как выглядит приложение на разных локалях, но желательно сделать еще одно изменение.
 
 Сейчас у нас открывается нужный экран, и сразу делается скриншот, поэтому есть вероятность, что какие-то данные на экране не успеют загрузиться, и снимок будет сделан до того, как мы увидим нужные нам элементы.
 
-Чтобы решить эту проблему, давайте в Page Object `Login Screen` мы добавим метод, который дождется загрузки всех необходимых элементов интерфейса. В этом методе мы просто для всех объектов сделаем проверку на `isVisible`. Это проверка в своей реализации использует `flakySafely`, поэтому даже если данные мгновенно загружены не будут, то тест будет ждать, пока условие не выполнится в течение нескольких секунд.
-
-Добавляем метод, назовем его `waitForScreen`:
-
-```kotlin
-package com.kaspersky.kaspresso.tutorial.screen
-
-import com.kaspersky.kaspresso.screens.KScreen
-import com.kaspersky.kaspresso.tutorial.R
-import io.github.kakaocup.kakao.edit.KEditText
-import io.github.kakaocup.kakao.text.KButton
-
-object LoginScreen : KScreen<LoginScreen>() {
-
-    override val layoutId: Int? = null
-    override val viewClass: Class<*>? = null
-
-    val inputUsername = KEditText { withId(R.id.input_username) }
-    val inputPassword = KEditText { withId(R.id.input_password) }
-    val loginButton = KButton { withId(R.id.login_btn) }
-
-    fun waitForScreen() {
-        inputUsername.isVisible()
-        inputPassword.isVisible()
-        loginButton.isVisible()
-    }
-}
-
-```
-В тестовом классе можем вызвать этот метод перед тем, как сделать скриншот:
+Чтобы решить эту проблему, перед тем, как делать скриншот, мы дождемся загрузки всех необходимых элементов интерфейса. Для всех объектов `LoginScreen` мы сделаем проверку на `isVisible`. Это проверка в своей реализации использует `flakySafely`, поэтому даже если данные мгновенно загружены не будут, то тест будет ждать, пока условие не выполнится в течение нескольких секунд.
 
 ```kotlin
 package com.kaspersky.kaspresso.tutorial.screenshot_tests
@@ -208,26 +185,27 @@ class LoginActivityScreenshots : DocLocScreenshotTestCase(locales = "en, fr") {
 
     @Test
     fun takeScreenshots() = run {
-        step("Take screenshots initial state") {
+        step("Take initial state screenshots") {
             LoginScreen {
-                waitForScreen()
+                inputUsername.isVisible()
+                inputPassword.isVisible()
+                loginButton.isVisible()
                 captureScreenshot("Initial state")
             }
         }
     }
 }
 ```
 
-Запускаем тест. Тест пройден успешно, и в `Device File Explorer` в папке `sdcard/Documents/screenshots` вы сможете найти все скриншоты, при этом для каждой локали была создана своя папка и вы сможете просмотреть, как выглядит ваше приложение на разных языках.
+Запускаем тест. Тест пройден успешно. В `Device File Explorer` в папке `sdcard/Documents/screenshots` вы сможете найти все скриншоты, при этом для каждой локали была создана своя папка, и вы сможете просмотреть, как выглядит ваше приложение на разных языках.
 
 <img src="../images/screenshot_tests_1/screenshot_test.png" alt="Screenshot test results"/>
 
 <img src="../images/screenshot_tests_1/initial_en.png" alt="Initial state en" width="300"/>
 
 <img src="../images/screenshot_tests_1/initial_fr.png" alt="Initial state fr" width="300"/>
 
-
-Теперь, просмотрев скриншоты, можно увидеть проблему в приложении, что не все строки были добавлены корректно, и разработчик может исправить ошибку, добавив необходимые значения в файл `values-fr/strings.xml`.
+Теперь, просмотрев скриншоты, можно увидеть проблему в приложении из-за отсутствия необходимых переводов строк и исправить ошибку, добавив необходимые значения в файл `values-fr/strings.xml`.
 
 !!! info
     Возможно, на некоторых устройствах при смене локали у вас возникнет проблема с заголовком экрана – весь контент на экране будет корректно переведен на необходимый язык, а заголовок останется прежним. Проблема связана с [багом в библиотеке Google]( https://issuetracker.google.com/issues/246092030). Его уже пофиксили, как только опубликуют соответствующий релиз, внесем изменения в Kaspresso.
@@ -237,7 +215,6 @@ class LoginActivityScreenshots : DocLocScreenshotTestCase(locales = "en, fr") {
 
 В данном уроке мы рассмотрели: зачем нужны скриншот-тесты, как их писать и где смотреть результаты выполнения тестов.
 
-Тема screenshot-тестов довольно обширная, и для более комфортного освоения мы ее разбили на несколько частей. Для более углубленного изучения переходите к следующему уроку
-
+Тема screenshot-тестов довольно обширная, и для более комфортного освоения мы ее разбили на несколько частей. В следующем уроке мы более подробно разберем тему стейтов, как их правильно устанавливать, и что нужно учитывать при разработке приложения, чтобы его можно было покрыть тестами.