Merge pull request #69 from botcity-dev/TST/tests-to-browsers

TST: Test to browsers implements in CI

Author: hhslepicka

.flake8

@@ -6,5 +6,6 @@ exclude =
     dist,
     versioneer.py,
     botcity/maestro/_version.py,
-    docs/source/conf.py
+    docs/source/conf.py,
+    tests
 max-line-length = 115

.github/workflows/ci.yml

@@ -4,6 +4,14 @@ on:
   push:
   pull_request:
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
 jobs:
   build:
     runs-on: ${{ matrix.os }}
@@ -13,9 +21,17 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        python-version: [3.7]
+        python-version: ["3.10"]
+        browser: [firefox, chrome, edge]
+        headless: [true]
+
     steps:
       - uses: actions/checkout@v2
+      - name: Install libgl1
+        run: |
+          sudo dpkg --add-architecture i386
+          sudo apt update
+          sudo apt install libgl1-mesa-dev libgconf-2-4 libatk1.0-0 libatk-bridge2.0-0 libgdk-pixbuf2.0-0 libgtk-3-0 libgbm-dev libnss3-dev libxss-dev libasound2 -y
 
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v2
@@ -30,6 +46,17 @@ jobs:
         run: |
           pip install .
 
-      - name: Run Tests
+      - uses: browser-actions/setup-chrome@latest
+        if: ${{ matrix.browser }} == "chrome"
+        with:
+          chrome-version: stable
+
+      - uses: browser-actions/setup-firefox@latest
+        if: ${{ matrix.browser }} == "firefox"
+
+      - uses: browser-actions/setup-edge@latest
+        if: ${{ matrix.browser }} == "edge"
+
+      - name: Run Tests in ${{ matrix.browser }}
         run: |
-          python run_tests.py
+          pytest -v -vrxs --headless=${{ matrix.headless }} --browser=${{ matrix.browser }}

botcity/web/browsers/edge.py

@@ -14,15 +14,13 @@
 def default_options(headless=False, download_folder_path=None, user_data_dir=None,
                     page_load_strategy="normal") -> EdgeOptions:
     """Retrieve the default options for this browser curated by BotCity.
-
     Args:
         headless (bool, optional): Whether or not to use the headless mode. Defaults to False.
         download_folder_path (str, optional): The default path in which to save files.
             If None, the current directory is used. Defaults to None.
         user_data_dir ([type], optional): The directory to use as user profile.
             If None, a new temporary directory is used. Defaults to None.
         page_load_strategy (str, optional): The page load strategy. Defaults to "normal".
-
     Returns:
         EdgeOptions: The Edge options.
     """
@@ -119,7 +117,6 @@ def default_options(headless=False, download_folder_path=None, user_data_dir=Non
 
 def default_capabilities() -> Dict:
     """Fetch the default capabilities for this browser.
-
     Returns:
         Dict: Dictionary with the default capabilities defined.
     """

conftest.py

@@ -0,0 +1,124 @@
+import os
+import json
+import shutil
+import tempfile
+
+import pytest
+import typing
+import platform
+
+from botcity.web import WebBot, Browser, By, browsers
+from webdriver_manager.chrome import ChromeDriverManager
+from webdriver_manager.firefox import GeckoDriverManager
+from webdriver_manager.microsoft import EdgeChromiumDriverManager
+
+OS_NAME = platform.system()
+
+PROJECT_DIR = os.path.abspath('tests')
+TEST_PAGE = "https://lf2a.github.io/webpage-test/test.html"
+INDEX_PAGE = "https://lf2a.github.io/webpage-test/"
+
+
+def get_fake_bin_path(web: WebBot) -> str:
+    return os.path.join(web.download_folder_path, 'fake.bin')
+
+
+def setup_chrome(headless: bool, tmp_folder: str, download_driver: str) -> WebBot:
+    web = WebBot(headless)
+    web.browser = Browser.CHROME
+
+    web.driver_path = download_driver
+    web.download_folder_path = tmp_folder
+    return web
+
+
+def setup_firefox(headless: bool, tmp_folder: str, download_driver: str) -> WebBot:
+    web = WebBot(headless)
+    web.browser = Browser.FIREFOX
+
+    web.driver_path = download_driver
+    web.download_folder_path = tmp_folder
+
+    return web
+
+
+def setup_edge(headless: bool, tmp_folder: str, download_driver: str) -> WebBot:
+    web = WebBot(headless)
+    web.browser = Browser.EDGE
+
+    web.driver_path = download_driver
+    web.download_folder_path = tmp_folder
+    opt = browsers.edge.default_options(headless=headless, download_folder_path=tmp_folder)
+    opt.set_capability('platform', 'ANY')
+
+    web.options = opt
+    return web
+
+
+def factory_setup_browser(browser: str, is_headless: bool, tmp_folder: str, download_driver: str) -> WebBot:
+    dict_browsers = {
+        'chrome': setup_chrome,
+        'firefox': setup_firefox,
+        'edge': setup_edge
+    }
+
+    setup_browser = dict_browsers.get(browser, None)
+
+    if setup_browser is None:
+        raise ValueError(f'Browser [{browser}] not supported.')
+
+    return setup_browser(headless=is_headless, tmp_folder=tmp_folder, download_driver=download_driver)
+
+
+def factory_driver_manager(browser: str):
+    dict_driver_manager = {
+        'chrome': ChromeDriverManager,
+        'firefox': GeckoDriverManager,
+        'edge': EdgeChromiumDriverManager
+    }
+
+    driver_manager = dict_driver_manager.get(browser, None)
+
+    if dict_driver_manager is None:
+        raise ValueError(f'Driver to [{browser}] not supported.')
+
+    return driver_manager
+
+
+@pytest.fixture
+def tmp_folder() -> str:
+    folder = tempfile.mkdtemp()
+    yield folder
+    shutil.rmtree(folder)
+
+
+@pytest.fixture(autouse=True, scope="session")
+def download_driver(request):
+    folder_driver = tempfile.mkdtemp()
+    browser = request.config.getoption("--browser") or Browser.CHROME
+    manager = factory_driver_manager(browser=browser)
+    installed_driver = manager(path=folder_driver).install()
+    yield installed_driver
+    shutil.rmtree(folder_driver)
+
+
+@pytest.fixture
+def web(request, tmp_folder: str, download_driver: str):
+    browser = request.config.getoption("--browser") or Browser.CHROME
+    is_headless = request.config.getoption("--headless") or "false"
+    is_headless = True if is_headless.lower() == "true" else False
+    web = factory_setup_browser(browser=browser, is_headless=is_headless, tmp_folder=tmp_folder,
+                                download_driver=download_driver)
+    yield web
+    web.stop_browser()
+
+
+def get_event_result(id_event: str, web: WebBot) -> typing.Dict:
+    event_result = web.find_element(id_event, By.ID)
+    return json.loads(event_result.text)
+
+
+def pytest_addoption(parser):
+    parser.addoption('--headless', action='store', default="true")
+    parser.addoption('--browser', action='store', default='chrome')
+

requirements.txt

@@ -4,4 +4,4 @@ msedge-selenium-tools==3.141.3
 numpy
 opencv-python
 pillow
-selenium==3.141
+selenium==3.141

test-requirements.txt

@@ -1 +1,3 @@
 pytest
+pytest-xdist
+webdriver-manager