Merge pull request #436 from OSLL/395_selenium

395 selenium

Author: HadronCollider

.dockerignore

@@ -6,4 +6,3 @@ venv
 __pycache__
 Dockerfile*
 app/playground
-tests/selenium

.github/workflows/main.yml

@@ -22,14 +22,15 @@ jobs:
 
     - name: Build docker-compose
       run: |
-        docker compose build
+        docker compose -f docker-compose.yml -f docker-compose-selenium.yml build
 
     - name: Run docker-compose
       run:
-        APP_CONF=../app_conf/testing.ini docker compose up -d
+        APP_CONF=../app_conf/testing.ini docker compose -f docker-compose.yml -f docker-compose-selenium.yml up -d
 
     - name: Run tests
       run: |
         docker ps -a
         docker compose logs
-        docker exec web_speech_trainer-web-1 bash -c 'cd /project/tests && pytest .'
+        docker exec web_speech_trainer-web-1 bash -c 'cd /project/tests && pytest --ignore=selenium'
+        docker exec web_speech_trainer-selenium-tests-1 bash -c 'pytest .'

.gitignore

@@ -1,6 +1,5 @@
 .venv
 venv
-.venv
 .idea
 ssl
 __pycache__

Dockerfile_selenium

@@ -0,0 +1,22 @@
+FROM selenium/standalone-chrome:137.0-chromedriver-137.0-grid-4.33.0-20250606
+
+WORKDIR /usr/src/project
+
+USER root
+RUN apt-get update && \
+    apt-get install -y python3 python3-pip && \
+    rm -rf /var/lib/apt/lists/*
+
+COPY tests/requirements.txt requirements.txt
+RUN pip install -r requirements.txt
+
+COPY tests/selenium selenium
+COPY tests/test_data test_data
+COPY tests/simple_phrases_russian.wav simple_phrases_russian.wav
+
+COPY app/config.py app/config.py
+COPY app_conf/testing.ini app_conf/testing.ini
+
+ENV PYTHONPATH='/usr/src/project/:/usr/src/project/app/'
+
+# CMD ["pytest", "-s", "."]

Dockerfile_test

@@ -23,6 +23,7 @@ def lti():
         an empty dictionary with 404 HTTP return code if access was denied.
     """
     params = request.form
+
     consumer_key = params.get('oauth_consumer_key', '')
     consumer_secret = ConsumersDBManager().get_secret(consumer_key)
     request_info = dict(

app/routes/lti.py

@@ -6,9 +6,9 @@ let gumStream,
     timer;
 
 function startRecording() {
-    console.log("call startRecording(). Try to call navigator.mediaDevices.getUserMedia")
-    console.log(navigator)
-    console.log(navigator.mediaDevices)
+    console.log("call startRecording(). Try to call navigator.mediaDevices.getUserMedia");
+    console.log("navigator", navigator);
+    console.log("navigator.mediaDevices", navigator.mediaDevices);
     $("#alert").hide()
     $("#record-contain").show();
     navigator.mediaDevices.getUserMedia({audio: true, video: false}).then(function (stream) {

app/static/js/recording.js

@@ -0,0 +1,12 @@
+version: '2'
+
+services:
+  selenium-tests:
+    build:
+      context: .
+      dockerfile: Dockerfile_selenium
+    shm_size: 2g
+    depends_on:
+      - web
+    networks:
+      - default

docker-compose-selenium.yml

@@ -0,0 +1,46 @@
+### Юнит тесты
+#### Сборка и запуск проекта
+Собираем и запускаем проект с конфигом `config.ini` или `testing.ini`
+```bash
+$ docker compose build
+
+$ APP_CONF=../app_conf/testing.ini docker compose up
+```
+
+#### Запуск тестов
+Запускаем тесты следующей командой
+```bash
+$ docker exec web_speech_trainer-web-1 bash -c 'cd /project/tests && pytest --ignore=selenium'
+```
+
+`--ignore=selenium` необходим (`pytest -s . -k 'not selenium'` не сработает), чтобы pytest не смотрел на selenium тесты, которые будут собраны в другом контейнере, иначе будут ошибки (selenium тесты будут ссылаться на отсутствующие в текущем контейнере зависимости)
+### Selenium тесты
+
+#### Сборка и запуск проекта
+Сборка и запуск проекта с selenium тестами осуществляется c конфигом `testing.ini` следующим образом
+```bash
+$ docker compose -f docker-compose.yml -f docker-compose-selenium.yml build
+
+$ APP_CONF=../app_conf/testing.ini docker compose -f docker-compose.yml -f docker-compose-selenium.yml up
+```
+#### Запуск тестов
+Чтобы запустить selenium тесты необходимо выполнить следующую команду
+```bash
+$ docker exec web_speech_trainer-selenium-tests-1 bash -c 'pytest .'
+```
+От сюда же можно запустить и юнит тесты, описанным в разделе юнит тестов способом
+#### Структура selenium тестов
+##### Selenium session
+Запускаемые тесты используют фикстуру `selenium_session` со `scope="module"`, объявленную в `conftest.py`. Она регистрируется в системе и возвращает экземпляр класса `SeleniumSession` с запущенным и настроенным драйвером. В нашем случае `scope="module"` значит, что для всех тестов в одном модуле будет использоваться один экземпляр `SeleniumSession` (не будет пересоздаваться от теста к тесту в одном модуле).
+
+При необходимости можно объявлять другие фикстуры с другими настройками драйвера, например убрать симуляцию аудиопотока.
+##### Training session
+Класс `TrainingSession` является надстройкой над `SeleniumSession`. Можно сказать, что это API взаимодействия с любой тренировкой. Причем `SeleniumSession` может передаваться между такими надстройками, что позволяет создавать различные сценарии для тестирования. 
+
+Например, после завершения тренировки, использовать API для другой странички, чтобы полистать страничку со всеми тренировками и убедиться в наличии новой тренировки.
+##### Test Main
+`test_main.py` - входная точка тестирования, содержащая класс `TestMain`, который назовем сценарием тестирования. Данный класс может наследоваться от других сценариев тестирования, которые в данном контексте уже будут подсценариями. Например в `TestMain` используется подсценарий `SimpleTraining` проверяющий простую тренировку, но после тренировки можно использовать и другие подсценарии.
+
+Исполнение тестов будет идти в порядке наследования, причем названия наследуемых классов не должны иметь префикс `Test`, иначе тесты могут дублироваться (вроде как принято использовать префикс `Base` для таких классов).
+
+Наследование позволяет создавать различные сценарии тестирования. Каждый сценарий лучше описывать в отдельном файле вида `test_<название модуля с тестами>.py`, а их подсценарии либо в этом же файле, либо в файле без префикса `test_`, если планируется использование в других сценариях.

tests/README.md

@@ -1,3 +1,2 @@
 pytest==8.0.2
-selenium==4.16.0
-webdriver-manager==4.0.1
+selenium==4.33.0