Add first frontend test (#1364)

* Add auto login api

* Add first test in frontend (#392)

* Add frontend tests to github actions

Setup identity before starting the tests

* Install launchpadlib as it is dependency for poetry

* Install keyring as it is dependency for poetry

* Update frontend.yml

* Update frontend.yml

* Update frontend.yml

* Update frontend.yml

* Update base_tests.py

* Update frontend.yml

* Update frontend.yml

* Update frontend tests

* Update frontend tests

* Update frontend tests

* Update frontend.yml

* Update frontend.yml

* Update frontend tests

* Update frontend tests

* Update frontend.yml

* Update frontend.yml

* Update frontend.yml

* Use ip instead of localhost

* Update workflow

* Update frontend.yml

* Update frontend.yml

* Update workflow

* Update workflow

* Update workflow

* Update base_tests.py

* Update workflow

* Update workflow

* Update workflow

* Update workflow

* Update workflow

* Update workflow

* Update workflow

* Cleanup

* Update frontend workflow to run only nightly

* Comment for how to use head mode browser

* Add selenium to workflow

Author: AhmedHanafy725

.github/workflows/frontend.yml

@@ -0,0 +1,38 @@
+name: Frontend
+
+on:
+  schedule:
+    - cron:  '0 0 * * *'
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          ref: development
+      - uses: actions/setup-python@v2
+        with:
+          python-version: '3.8'
+      - uses: dschep/[email protected]
+      - uses: nanasess/setup-chromedriver@master
+      - name: Gathering deps
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y git tmux redis restic nginx cron unzip
+          sudo service redis stop
+          sudo service nginx stop
+          poetry run pip3 install pytest selenium
+
+      - name: Install js-sdk
+        run: |
+          poetry install
+
+      - name: Run tests
+        env:
+          TNAME: ${{ secrets.TNAME }}
+          EMAIL: ${{ secrets.EMAIL }}
+          WORDS: ${{ secrets.WORDS }}
+        run: |
+          sudo setcap CAP_NET_BIND_SERVICE=+eip $(which nginx)
+          poetry run pytest -s tests/frontend/tests

.github/workflows/js-sdk.yml

@@ -21,7 +21,7 @@ jobs:
           sudo service redis stop
           sudo service nginx stop
           sudo pip3 install poetry
-          sudo poetry run pip3 install pytest
+          sudo poetry run pip3 install pytest selenium
       - name: Install
         run: |
           sudo poetry install

jumpscale/packages/auth/bottle/auth.py

@@ -178,6 +178,22 @@ def access_denied():
     return env.get_template("access_denied.html").render(email=email, next_url=next_url)
 
 
+@app.route("/auto_login")
+def auto_login():
+    """Auto login is used for testing for skipping login and use the current user's info instead.
+
+    Returns:
+        Redirect to the admin dashboard.
+    """
+    if j.core.config.get("AUTO_LOGIN"):
+        session = request.environ.get("beaker.session", {})
+        session["username"] = j.core.identity.me.tname
+        session["email"] = j.core.identity.me.email
+        session["authorized"] = True
+
+    return redirect("/admin")
+
+
 def get_user_info():
     """Parse user information from the session object
 

tests/frontend/__init__.py

@@ -0,0 +1,5 @@
+class Base:
+    base_url = "https://localhost"
+
+    def __init__(self, *args, **kwargs):
+        pass

tests/frontend/pages/__init__.py

@@ -0,0 +1,54 @@
+from tests.frontend.pages.base import Base
+from urllib.parse import urljoin
+from selenium.webdriver.common.by import By
+from selenium.webdriver.support.ui import WebDriverWait
+from selenium.webdriver.support import expected_conditions as EC
+
+
+class Wallets(Base):
+    def __init__(self, driver, *args, **kwargs):
+        super().__init__(self, *args, **kwargs)
+        self.driver = driver
+        self.endpoint = "/admin/#/wallets"
+
+    def load(self):
+        url = urljoin(self.base_url, self.endpoint)
+        self.driver.get(url)
+
+    def create(self, name):
+        buttons = self.driver.find_elements_by_class_name("v-btn")
+        create_button = [button for button in buttons if button.text == "CREATE"][0]
+        create_button.click()
+        wallet_name_box = self.driver.find_element_by_class_name("v-text-field__slot")
+        wallet_name_input = wallet_name_box.find_element_by_tag_name("input")
+        wallet_name_input.send_keys(name)
+        buttons = self.driver.find_elements_by_class_name("v-btn")
+        submit_button = [button for button in buttons if button.text == "SUBMIT"][0]
+        submit_button.click()
+        wait = WebDriverWait(self.driver, 60)
+        wait.until(EC.invisibility_of_element_located((By.CLASS_NAME, "v-dialog")))
+
+    def list(self):
+        wallets = {}
+        wallets_class = self.driver.find_element_by_class_name("row")
+        wallets_cards = wallets_class.find_elements_by_class_name("v-card")
+        for wallet_card in wallets_cards:
+            wallet_card_name = wallet_card.find_element_by_class_name("v-card__title")
+            wallet_name = wallet_card_name.text
+            wallets[wallet_name] = wallet_card
+
+        return wallets
+
+    def delete(self, name):
+        wallets = self.list()
+        for wallet in wallets.keys():
+            if wallet == name:
+                wallet_card = wallets[name]
+                delete_icon = wallet_card.find_element_by_class_name("v-btn")
+                delete_icon.click()
+                break
+        else:
+            return
+        buttons = self.driver.find_elements_by_class_name("v-btn")
+        submit_button = [button for button in buttons if button.text == "SUBMIT"][0]
+        submit_button.click()

tests/frontend/pages/base.py

@@ -0,0 +1,89 @@
+import os
+import time
+from unittest import TestCase
+from urllib.parse import urljoin
+
+from selenium import webdriver
+from selenium.webdriver.chrome.options import Options
+
+from jumpscale.core.base import StoredFactory
+from jumpscale.loader import j
+from jumpscale.packages.admin.bottle.models import UserEntry
+from tests.frontend.pages.base import Base
+
+
+class BaseTest(TestCase):
+    @classmethod
+    def setUpClass(cls):
+        # Set auto login config to disable 3bot connect login.
+        j.core.config.set("AUTO_LOGIN", True)
+
+        # Get environment variables to create identity.
+        cls.tname = os.environ.get("TNAME")
+        cls.email = os.environ.get("EMAIL")
+        cls.words = os.environ.get("WORDS")
+        cls.explorer_url = "https://explorer.testnet.grid.tf/api/v1"
+        if not (cls.tname and cls.email and cls.words):
+            raise Exception("Please add (TNAME, EMAIL, WORDS) of your 3bot identity as environment variables")
+
+        # Check if there is identity registered to set it back after the tests are finished.
+        cls.me = None
+        if j.core.identity.list_all() and hasattr(j.core.identity, "me"):
+            cls.me = j.core.identity.me
+
+        # Accept T&C for testing identity.
+        user_factory = StoredFactory(UserEntry)
+        user_entry = user_factory.get(f"{cls.tname.replace('.3bot', '')}")
+        user_entry.has_agreed = True
+        user_entry.tname = cls.tname
+        user_entry.save()
+
+        # Configure test identity and start threebot server.
+        cls.identity_name = j.data.random_names.random_name()
+        identity = j.core.identity.new(
+            cls.identity_name, tname=cls.tname, email=cls.email, words=cls.words, explorer_url=cls.explorer_url
+        )
+        identity.register()
+        j.core.identity.set_default(cls.identity_name)
+        cls.server = j.servers.threebot.get("default")
+        cls.server.start()
+
+    @classmethod
+    def tearDownClass(cls):
+        # Disable auto login after the tests are finished.
+        j.core.config.set("AUTO_LOGIN", False)
+
+        # Stop threebot server and the testing identity.
+        cls.server.stop()
+        j.core.identity.delete(cls.identity_name)
+
+        # Restore the user identity
+        if cls.me:
+            j.core.identity.set_default(cls.me.instance_name)
+
+    def setUp(self):
+        # Configure chrome driver and go to the entrypoint.
+        options = Options()
+        options.add_argument("--no-sandbox")
+        # For browser's head mode comment the next 3 lines
+        options.add_argument("headless")
+        options.add_argument("--disable-gpu")
+        options.add_argument("--disable-dev-shm-usage")
+        options.add_argument("ignore-certificate-errors")
+        self.driver = webdriver.Chrome(options=options)
+        self.driver.implicitly_wait(10)
+        self.driver.maximize_window()
+        self.login_endpoint = "/auth/auto_login"
+        self.driver.get(urljoin(Base.base_url, self.login_endpoint))
+
+    def tearDown(self):
+        # Take screenshot for failure test.
+        if self._outcome.errors:
+            self.driver.save_screenshot(f"{self._testMethodName}.png")
+        self.driver.quit()
+
+    def info(self, msg):
+        j.logger.info(msg)
+
+    def random_str(self):
+        return j.data.random_names.random_name()