Created initial selenium testing framework with pylenium. Added test …

…for user login (#2216)

* Created initial selenium testing framework with pylenium. Added test for user login

* Restoring precommit hook

.github/workflows/test.yml

@@ -106,8 +106,14 @@ jobs:
                   touch ./logs/concordia-celery.log
                   npm install
                   npx gulp build
+                  chromepath=$(npx @puppeteer/browsers install chrome@stable)
+                  chromepath=${chromepath#* }
+                  chromepath=${chromepath%/chrome}
+                  OLDPATH=$PATH
+                  PATH=$PATH:$chromepath
                   pipenv run ./manage.py collectstatic --no-input
                   pipenv run coverage run ./manage.py test
+                  PATH=$OLDPATH
               env:
                   PGPASSWORD: postgres
                   # The hostname used to communicate with the PostgreSQL service container

Pipfile

@@ -53,6 +53,7 @@ locust = "*"
 twisted = {extras = ["http2", "tls"], version = "*"}
 hiredis = "*"
 pyasn1 = "*"
+pyleniumio = "*"
 
 [dev-packages]
 invoke = "*"

concordia/settings_template.py

@@ -402,3 +402,5 @@
 TINYMCE_JS_URL = "https://cdn.tiny.cloud/1/rf486i5f1ww9m8191oolczn7f0ry61mzdtfwbu7maiiiv2kv/tinymce/6/tinymce.min.js"
 
 PYTESSERACT_ALLOWED_LANGUAGES = ["eng"]
+
+PYLENIUM_CONFIG = os.path.join(SITE_ROOT_DIR, "pylenium.json")

concordia/templates/registration/login.html

@@ -15,7 +15,7 @@
             <div class="col-8 col-md-6 col-lg-4 mx-auto my-3">
                 <h2 class="text-center">Welcome back!</h2>
 
-                <form method="post" action="{% url 'login' %}" class="col-10 my-3 mx-auto">
+                <form id="login-form" method="post" action="{% url 'login' %}" class="col-10 my-3 mx-auto">
                     {% csrf_token %}
 
                     {% if next %}
@@ -29,7 +29,7 @@ <h2 class="text-center">Welcome back!</h2>
                             security requirements</a>
                     </p>
                     {% buttons %}
-                        <button type="submit" class="btn btn-primary">
+                        <button id="login" type="submit" class="btn btn-primary">
                             Login
                         </button>
                     {% endbuttons %}

concordia/tests/test_selenium.py

@@ -0,0 +1,60 @@
+import json
+from logging import getLogger
+from secrets import token_hex
+
+from django.conf import settings
+from django.contrib.staticfiles.testing import StaticLiveServerTestCase
+from django.urls import reverse
+from pylenium.config import PyleniumConfig
+from pylenium.driver import Pylenium
+
+from .utils import CreateTestUsers
+
+logger = getLogger(__name__)
+
+
+class SeleniumTests(CreateTestUsers, StaticLiveServerTestCase):
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        try:
+            with open(settings.PYLENIUM_CONFIG) as file:
+                _json = json.load(file)
+            config = PyleniumConfig(**_json)
+        except FileNotFoundError:
+            logger.warning(
+                "settings.PYLENIUM_CONFIG (%s) was not found; using defaults.",
+                settings.PYLENIUM_CONFIG,
+            )
+            config = PyleniumConfig()
+
+        cls.py = Pylenium(config)
+
+    @classmethod
+    def tearDownClass(cls):
+        cls.py.quit()
+        super().tearDownClass()
+
+    def reverse(self, name):
+        return f"{self.live_server_url}{reverse(name)}"
+
+    def test_login(self):
+        self.py.visit(self.reverse("registration_login"))
+        self.py.get("[name='username']").type(token_hex(8))
+        self.py.get("[name='password']").type(token_hex(24))
+        self.py.get("button#login").click()
+        self.assertTrue(
+            self.py.should().have_url(f"{self.live_server_url}/account/login/")
+        )
+        self.assertTrue(
+            self.py.get("form#login-form")
+            .should()
+            .contain_text("Please enter a correct username and password")
+        )
+
+        user = self.create_user("login-test")
+        self.py.visit(self.reverse("registration_login"))
+        self.py.get("[name='username']").type(user.username)
+        self.py.get("[name='password']").type(user._password)
+        self.py.get("button#login").click()
+        self.assertTrue(self.py.should().have_url(f"{self.live_server_url}/"))