Среди тех, кто регулярно пишет код, +существует определенное соглашение о "стиле кода". +Стиль кода — это всё то, что не относится к его функциональности: +форматирование, имена переменных, функций, констант и так далее. +Python прекрасен тем, что его очень легко читать, +но даже такой простой для понимания язык в своём коде можно превратить +в нечитаемую кашу. Нечитаемая каша опасна тем, что вы не разберетесь +в своем коде уже через пару недель, а другой человек не разберется никогда. +Хорошо написанный код экономит время при починке тестов, +при внедрении нового человека в команду, да и при написании нового кода тоже. +В общем, это очень важная тема, и следует всегда помнить о читабельности кода.
+ +Мы совсем немного затронули эту тему в предыдущих модулях, а теперь, раз уж мы потихоньку идём в сторону большей абстракции, настало время поговорить об этом чуть более подробно.
+ +Отступы являются частью синтаксиса в Python и означают вложенность блока, будь то тело функции условного выражения, цикла, и так далее. Самое важное для нас в будущих шагах, что все функции внутри класса так же должны быть отделены отступом:
+ +
+@pytest.mark.regression
+# test out of scope of a class
+def test_student_can_see_lesson_name_in_lesson_in_course_after_joining(self, driver):
+ # lines inside the scope of the test method with indent
+ page = CoursePromoPage(url=self.course.url, driver=driver)
+ page.open()
+
+
+class TestLessonNameInCourseForTeacher():
+ @pytest.mark.regression
+ # test inside the class
+ def test_teacher_can_see_lesson_name_in_lesson_in_course(self, driver):
+ page = LessonPlayerPage(url=self.lesson_url, driver=driver)
+ page.open()
+ try:
+ # indent for any new scope
+ dangerous_function()
+ except:
+ close_something()
+
+
diff --git a/test_frameworks/pytest_configuration_params/task_localizations/tests/__init__.py b/page_object/what_is_po/code style in tests/__init__.py
similarity index 100%
rename from test_frameworks/pytest_configuration_params/task_localizations/tests/__init__.py
rename to page_object/what_is_po/code style in tests/__init__.py
diff --git a/page_object/what_is_po/code style in tests/main.py b/page_object/what_is_po/code style in tests/main.py
new file mode 100644
index 0000000..0a9300d
--- /dev/null
+++ b/page_object/what_is_po/code style in tests/main.py
@@ -0,0 +1,3 @@
+if __name__ == "__main__":
+ # Write your solution here
+ pass
diff --git a/page_object/what_is_po/code style in tests/task-info.yaml b/page_object/what_is_po/code style in tests/task-info.yaml
new file mode 100644
index 0000000..d987e14
--- /dev/null
+++ b/page_object/what_is_po/code style in tests/task-info.yaml
@@ -0,0 +1,7 @@
+type: theory
+custom_name: 'code style in tests '
+files:
+- name: main.py
+ visible: true
+- name: __init__.py
+ visible: false
diff --git a/page_object/what_is_po/code style in tests/task.md b/page_object/what_is_po/code style in tests/task.md
new file mode 100644
index 0000000..faab4f6
--- /dev/null
+++ b/page_object/what_is_po/code style in tests/task.md
@@ -0,0 +1,27 @@
+Здесь мы попытались собрать важные принципы написания автотестов:
+ +def should_be_reply_comment()test_guest_can_see_teach_button() — обратите внимание на явное указание на роль пользователя.Если у вас нет большого опыта в написании кода, в статьях по ссылкам вы можете найти дополнительные рекомендации по оформлению кода.
+ +Английский язык:
+ +https://docs.python-guide.org/writing/style/
+ +https://www.python.org/dev/peps/pep-0008/
diff --git a/page_object/what_is_po/code style/__init__.py b/page_object/what_is_po/code style/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/page_object/what_is_po/code style/main.py b/page_object/what_is_po/code style/main.py new file mode 100644 index 0000000..0a9300d --- /dev/null +++ b/page_object/what_is_po/code style/main.py @@ -0,0 +1,3 @@ +if __name__ == "__main__": + # Write your solution here + pass diff --git a/page_object/what_is_po/code style/task-info.yaml b/page_object/what_is_po/code style/task-info.yaml new file mode 100644 index 0000000..ca3a333 --- /dev/null +++ b/page_object/what_is_po/code style/task-info.yaml @@ -0,0 +1,7 @@ +type: theory +custom_name: "code style: basic principles" +files: +- name: main.py + visible: true +- name: __init__.py + visible: false diff --git a/page_object/what_is_po/code style/task.md b/page_object/what_is_po/code style/task.md new file mode 100644 index 0000000..4f3f498 --- /dev/null +++ b/page_object/what_is_po/code style/task.md @@ -0,0 +1,32 @@ +Одним из самых важных аспектов читаемого кода является именование: будь то объявление переменных, описание функций, названия классов и так далее. Очень важно, чтобы все имена, которые вы присваивали сущностям, были осмысленными и отражали реальную суть этого объекта. Избегайте однобуквенных и бессмысленных названий типа var1, x, y, my_function, class2 и так далее. Идеальный код — самодокументируемый, к которому не нужны дополнительные пояснения. Если вы чувствуете, что вам хочется написать поясняющий комментарий, это повод переписать код так, чтобы комментарий не понадобился.
+ +Обычно внутри каждой компании есть дополнительные внутренние соглашения о том, как именовать переменные, но общие правила в индустрии примерно одинаковые.
+ +Функции пишутся через_нижнее_подчеркивание:
+ +def test_guest_can_see_lesson_name_in_lesson_without_course(self, driver):
Классы пишут с помощью CamelCase:
+ +class TestLessonNameWithoutCourseForGuest():
Константы пишут в стиле UPPERCASE:
+ +MAIN_PAGE = "/catalog"
Здесь нам на помощь приходят известные принципы написания кода DRY (Don't repeat yourself) и KISS (Keep it simple, stupid).
+ +Page Object Model или кратко Page Object — это паттерн программирования, который очень популярен в автоматизации тестирования и является одним из стандартов при автоматизации тестирования веб-продуктов. Это также один из удобных способов структурировать свой код таким образом, чтобы его было удобно поддерживать, менять и работать с ним.
+ +Основная идея состоит в том, что каждую страницу веб-приложения можно описать в виде объекта класса. Способы взаимодействия пользователя со страницей можно описать с помощью методов класса. В идеале тест, который будет использовать Page Object, должен описывать бизнес-логику тестового сценария и скрывать Selenium-методы взаимодействия с браузером и страницей. При изменениях в верстке страницы не придется исправлять тесты, связанные с этой страницей. Вместо этого нужно будет поправить только класс, описывающий страницу.
+ +То есть здесь применяются те же принципы, что и в разработке: мы хотим повысить читаемость кода и вынести в абстрактные методы все детали. Тесты должны быть просто и понятно написаны, а повторяющиеся куски кода выделены в отдельные функции. В Page Object мы отделяем логику действий, например, авторизовать пользователя, от конкретной реализации (найти поле почты, ввести туда данные, найти поле пароля, ввести туда данные, найти кнопку и т.д.).
+ +Рассмотрим такой простой тест-кейс:
+ +Ожидаемый результат:
+ +Открыта страница логина
+ ++ +
Давайте посмотрим на кусочек кода теста из предыдущего модуля, который реализует первую часть этого теста:
+ +test_main_page.py:
+ +link = "http://selenium1py.pythonanywhere.com/"
+
+
+def test_guest_can_go_to_login_page(browser):
+ browser.get(link)
+ login_link = browser.find_element(By.CSS_SELECTOR, "#login_link")
+ login_link.click()
+Что здесь происходит?
+ +Мы открываем ссылку, находим элемент с определенным селектором и нажимаем на этот элемент.
+ +Что мы на самом деле имеем в виду семантически?
+ +Мы хотим открыть страницу логина. +Давайте выделим это действие в отдельную функцию с понятным названием, пока все в том же файле test_main_page.py :
+ +def go_to_login_page(browser):
+ login_link = browser.find_element(By.CSS_SELECTOR, "#login_link")
+ login_link.click()и наш тест упрощается:
+ +def test_guest_can_go_to_login_page(browser):
+ browser.get(link)
+ go_to_login_page(browser) При написании следующих тестов, когда нам понадобится перейти к странице логина с главной страницы, нам не нужно будет копировать этот кусочек кода или писать заново — мы сможем переиспользовать уже написанный метод.
+ +Пока что мы только выделили в абстрактный метод логическое действие пользователя, которое можно переиспользовать. +В следующих шагах мы разберем как создать из этого Page Object.
+ +Дополнительно про Page Object вы можете почитать здесь:
+ +https://github.com/SeleniumHQ/selenium/wiki/PageObjects
+ +https://martinfowler.com/bliki/PageObject.html
+ +https://medium.com/tech-tajawal/page-object-model-pom-design-pattern-f9588630800b
\ No newline at end of file diff --git a/page_object/what_is_po/why page object/__init__.py b/page_object/what_is_po/why page object/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/page_object/what_is_po/why page object/main.py b/page_object/what_is_po/why page object/main.py new file mode 100644 index 0000000..f880148 --- /dev/null +++ b/page_object/what_is_po/why page object/main.py @@ -0,0 +1,6 @@ +def test_add_to_cart(browser): + page = ProductPage(url="", browser) # initializing page object + page.open() # opening page in the browser + page.should_be_add_to_cart_button() # asserting button is on the page + page.add_product_to_cart() # pressing button + page.should_be_success_message() # asserting message with text is on the page \ No newline at end of file diff --git a/page_object/what_is_po/why page object/task-info.yaml b/page_object/what_is_po/why page object/task-info.yaml new file mode 100644 index 0000000..6bd1069 --- /dev/null +++ b/page_object/what_is_po/why page object/task-info.yaml @@ -0,0 +1,6 @@ +type: theory +files: +- name: main.py + visible: true +- name: __init__.py + visible: false diff --git a/page_object/what_is_po/why page object/task.md b/page_object/what_is_po/why page object/task.md new file mode 100644 index 0000000..a08456c --- /dev/null +++ b/page_object/what_is_po/why page object/task.md @@ -0,0 +1,33 @@ +Можно, конечно, хранить всю логику наших тестов в одном файле под каким-нибудь условным названием steps.py, и для начала это уже неплохо. Но если мы тестируем большой веб-продукт с множеством разных состояний и переходов, этот файл может разрастись до огромных размеров, и найти в нем нужный метод будет непросто. Еще бывают ситуации, когда на разных страницах логически один и тот же метод имеет разную реализацию. Например, у нашего интернет-магазина может быть метод "добавить в корзину". Но пользователь может добавлять товар в корзину как со страницы каталога, так и со страницы самого товара.
+ +Было бы удобно выделить все методы, которые логически относятся к одной веб-странице в нашем продукте, в отдельный класс в нашем коде. Отсюда и название Page Object — это абстрактный объект, который содержит в себе методы для работы с конкретной веб-страницей.
+ +Важно! Обычно методы у Page Object бывают двух типов: сделать что-то и проверить что-то.
+ +Рассмотрим страницу товара в интернет магазине http://selenium1py.pythonanywhere.com/catalogue/the-shellcoders-handbook_209/.
+ +Какие могут быть методы у Page Object, ассоциированного с такой страницей? Запишем основные сценарии:
+ +Обратите внимание, что все проверки у нас тоже становятся отдельными методами. В самом тест-кейсе не остается никаких вспомогательных слов типа assert, только описание шагов. Прямо как в нашей тестовой документации.
+ +Тесты будут выглядеть примерно так:
+ +def test_add_to_cart(browser):
+ page = ProductPage(url="", browser) # initializing page object
+ page.open() # opening page in the browser
+ page.should_be_add_to_cart_button() # asserting button is on the page
+ page.add_product_to_cart() # pressing button
+ page.should_be_success_message() # asserting message with text is on the page
+To find the moment when the rent drops to $100, use the text_to_be_present_in_element method from the expected_conditions library.
diff --git a/test_frameworks/pytest_configuration_params/__init__.py b/test_frameworks/pytest_configuration_params/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/test_frameworks/pytest_configuration_params/lesson-info.yaml b/test_frameworks/pytest_configuration_params/lesson-info.yaml index 043a349..b537c2b 100644 --- a/test_frameworks/pytest_configuration_params/lesson-info.yaml +++ b/test_frameworks/pytest_configuration_params/lesson-info.yaml @@ -8,4 +8,4 @@ content: - parameters from commandline - pytest plugins - running tests for different localizations -- task_localizations +- task_localization diff --git a/test_frameworks/pytest_configuration_params/running tests for different localizations/languages.png b/test_frameworks/pytest_configuration_params/running tests for different localizations/languages.png new file mode 100644 index 0000000..72bfbd4 Binary files /dev/null and b/test_frameworks/pytest_configuration_params/running tests for different localizations/languages.png differ diff --git a/test_frameworks/pytest_configuration_params/running tests for different localizations/task.md b/test_frameworks/pytest_configuration_params/running tests for different localizations/task.md index c1a319f..c54a08d 100644 --- a/test_frameworks/pytest_configuration_params/running tests for different localizations/task.md +++ b/test_frameworks/pytest_configuration_params/running tests for different localizations/task.md @@ -4,7 +4,9 @@In one of our previous steps, we've already run automated tests for various languages. We used parametrization with different links, but such an approach is hard to scale up onto a large number of tests. Let's make the server decide what interface language to use depending on the browser data. The browser sends the information about the user's language via requests to the server, indicating the accept-language parameter in the header. If the server receives a request with the header {accept-language: ru, en}, it will display the Russian-language site interface. If Russian is not supported, the next language in the list will be used – in our case, English. That is actually similar to defining the preferable language in your browser's settings:
-To choose the browser's language with WebDriver, use the Options class and the add_experimental_option method, like in the example below:
@@ -22,4 +24,4 @@ fp.set_preference("intl.accept_languages", user_language) browser = webdriver.Firefox(firefox_profile=fp) -You can add different arguments to the webdriver.Chrome or webdriver.Firefox constructor, which expands the opportunities for testing your web applications: tou can define a proxy server for network traffic control or start different browser versions, indicating the local path to the browser file. We expect that later you will need these options and that you will be able to find the respective settings.
\ No newline at end of file +You can add different arguments to the webdriver.Chrome or webdriver.Firefox constructor, which expands the opportunities for testing your web applications: tou can define a proxy server for network traffic control or start different browser versions, indicating the local path to the browser file. We expect that later you will need these options and that you will be able to find the respective settings.
diff --git a/test_frameworks/pytest_configuration_params/task_localization/__init__.py b/test_frameworks/pytest_configuration_params/task_localization/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/test_frameworks/pytest_configuration_params/task_localization/conftest.py b/test_frameworks/pytest_configuration_params/task_localization/conftest.py new file mode 100644 index 0000000..5827407 --- /dev/null +++ b/test_frameworks/pytest_configuration_params/task_localization/conftest.py @@ -0,0 +1,36 @@ +import pytest +from selenium import webdriver +from selenium.webdriver.chrome.options import Options + + +def pytest_addoption(parser): + parser.addoption('--browser_name', action='store', default="chrome", + help="Choose browser: chrome or firefox") + parser.addoption('--language', action='store', default="en", + help="Choose language: en, ru, es") + + +@pytest.fixture(scope="function") +def browser(request): + browser_name = request.config.getoption("browser_name") + browser = None + user_language = request.config.getoption("language") + if browser_name == "chrome": + + options = Options() + options.add_experimental_option('prefs', {'intl.accept_languages': user_language}) + + print("\nstart chrome browser for test..") + browser = webdriver.Chrome(options=options) + browser.implicitly_wait(10) + + elif browser_name == "firefox": + print("\nstart firefox browser for test..") + fp = webdriver.FirefoxProfile() + fp.set_preference("intl.accept_languages", user_language) + browser = webdriver.Firefox(firefox_profile=fp) + else: + raise pytest.UsageError("--browser_name should be chrome or firefox") + yield browser + print("\nquit browser..") + browser.quit() diff --git a/test_frameworks/pytest_configuration_params/task_localization/task-info.yaml b/test_frameworks/pytest_configuration_params/task_localization/task-info.yaml new file mode 100644 index 0000000..a558f99 --- /dev/null +++ b/test_frameworks/pytest_configuration_params/task_localization/task-info.yaml @@ -0,0 +1,26 @@ +type: edu +files: +- name: test_items.py + visible: true + placeholders: + - offset: 223 + length: 144 + placeholder_text: '# TODO' +- name: tests/test_task.py + visible: false +- name: __init__.py + visible: false +- name: tests/__init__.py + visible: false +- name: conftest.py + visible: false + placeholders: + - offset: 101 + length: 287 + placeholder_text: '# TODO - add parameters for command-line' + - offset: 391 + length: 890 + placeholder_text: "# TODO - add browser fixture, that starts browser with options\ + \ got from command-line" +- name: test_items_hidden.py + visible: false diff --git a/test_frameworks/pytest_configuration_params/task_localization/task.md b/test_frameworks/pytest_configuration_params/task_localization/task.md new file mode 100644 index 0000000..97688ee --- /dev/null +++ b/test_frameworks/pytest_configuration_params/task_localization/task.md @@ -0,0 +1,19 @@ +Мы хотим, чтобы разрабатываемый нами интернет-магазин работал одинаково хорошо для пользователей из любой страны. +Чтобы убедиться в работоспособности решения с поддержкой разных языков, +мы планируем запускать набор автотестов для каждого языка. +Вам как разработчику автотестов нужно реализовать решение, которое позволит запускать автотесты для разных языков пользователей, +передавая нужный язык в командной строке при запуске тестов.
+ +
+pytest --language=es test_items.py
+ и проходить успешно. Достаточно, чтобы код работал только для браузера Сhrome.