(SIO-2489) End-to-end testing with Cypress (#71)

* Initial cypress after patch

* updates for cypress testing

Author: tudny

.github/workflows/cypress.yml

@@ -0,0 +1,52 @@
+name: Cypress nightly tests
+
+on:
+  schedule:
+    - cron: '30 5 * * 1,3,5'
+  workflow_dispatch:
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+#   Kill this job after 60 minutes - used when server fails, but Cypress waits on port.
+    timeout-minutes: 60
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install `easy_toolbox.py` requirements
+        run: |
+          python -m pip install --upgrade pip
+          pip install -U inquirer
+
+      - name: Build OIOIOI
+        run: |
+          python easy_toolbox.py build --no-input
+
+      - name: Containers `up`
+        run: |
+          python easy_toolbox.py up --no-input
+
+      - name: Wait for migrations
+        uses: whatnick/wait-action@master
+        with:
+          time: 30s
+
+      - name: Apply CyPress settings
+        run: |
+          python easy_toolbox.py cypress-apply-settings --no-input
+
+      - name: Run test server
+        run: |
+          python easy_toolbox.py run --no-input &
+
+      - name: Run tests
+        run: |
+          ./test_cypress.sh
+
+      - name: Upload screenshots
+        uses: actions/upload-artifact@v3
+        if: failure()
+        with:
+            name: cypress-screenshots
+            path: oioioi_cypress/cypress/screenshots

.gitignore

@@ -24,3 +24,4 @@
 /deployment/
 /venv*/
 /.idea/
+/.vscode/

easy_toolbox.py

@@ -25,23 +25,24 @@
                       " -f extra/docker/docker-compose-dev-noserver.yml"
 
 RAW_COMMANDS = [
-    ("build", "Build whole OIOIOI from source.", "build", True),
+    ("build", "Build OIOIOI container from source.", "build", True),
     ("up", "Run all SIO2 containers", "up -d"),
     ("down", "Stop all SIO2 containers", "down", True),
-    ("run", "Run server", "exec web python3 manage.py runserver 0.0.0.0:8000"),
-    ("bash", "Open command prompt on web container.", "exec web bash"),
-    ("bash_db", "Open command prompt on database container.", "exec db bash"),
+    ("run", "Run server", "{exec} web python3 manage.py runserver 0.0.0.0:8000"),
+    ("bash", "Open command prompt on web container.", "{exec} web bash"),
+    ("bash-db", "Open command prompt on database container.", "{exec} db bash"),
     # This one CLEARS the database. Use wisely.
-    ("flush-db", "Clear database.", "exec web python manage.py flush --noinput", True),
-    ("add-superuser", "Create admin_admin.", "exec web python manage.py createsuperuser"),
-    ("test", "Run unit tests.", "exec web ../oioioi/test.sh"),
-    ("test-slow", "Run unit tests. (--runslow)", "exec web ../oioioi/test.sh --runslow"),
+    ("flush-db", "Clear database.", "{exec} web python manage.py flush --noinput", True),
+    ("add-superuser", "Create admin_admin.",
+     "{exec} web python manage.py loaddata ../oioioi/oioioi_cypress/cypress/fixtures/admin_admin.json"),
+    ("test", "Run unit tests.", "{exec} web ../oioioi/test.sh"),
+    ("test-slow", "Run unit tests. (--runslow)", "{exec} web ../oioioi/test.sh --runslow"),
     ("test-abc", "Run specific test file. (edit the toolbox)",
-     "exec web ../oioioi/test.sh -v oioioi/problems/tests/test_task_archive.py"),
+     "{exec} web ../oioioi/test.sh -v oioioi/problems/tests/test_task_archive.py"),
     ("test-coverage", "Run coverage tests.",
-     "exec 'web' ../oioioi/test.sh oioioi/problems --cov-report term --cov-report xml:coverage.xml --cov=oioioi"),
+     "{exec} 'web' ../oioioi/test.sh oioioi/problems --cov-report term --cov-report xml:coverage.xml --cov=oioioi"),
     ("cypress-apply-settings", "Apply settings for CyPress.",
-     "exec web bash -c \"echo CAPTCHA_TEST_MODE=True >> settings.py\""),
+     "{exec} web bash -c \"echo CAPTCHA_TEST_MODE=True >> settings.py\""),
 ]
 
 longest_command_arg = max([len(command[0]) for command in RAW_COMMANDS])
@@ -59,9 +60,8 @@ def __init__(self, _arg, _help, _command, _warn=False):
         self.warn = _warn
 
     # If we use exec we should add -T for GitHub actions (disable tty).
-    def disable_tty(self):
-        if (self.command.startswith("exec")):
-            self.command = self.command.replace("exec", "exec -T", 1)
+    def fill_tty(self, disable=False):
+        self.command = self.command.format(exec="exec -T" if disable else "exec")
 
     def long_str(self) -> str:
         return f"Option({self.arg}, Description='{self.help}', Command='{self.command}')"
@@ -83,7 +83,8 @@ def check_commands() -> None:
 
 
 def get_action_from_args() -> Option:
-    no_flag = []
+    # not flags
+    arguments = []
 
     for arg in sys.argv[1:]:
         if arg in ['--help', '-h']:
@@ -92,14 +93,14 @@ def get_action_from_args() -> Option:
             global NO_INPUT
             NO_INPUT = True
         else:
-            no_flag.append(arg)
+            arguments.append(arg)
 
-    if len(no_flag) < 1:
+    if len(arguments) < 1:
         return None
-    if len(no_flag) > 1:
+    if len(arguments) > 1:
         raise Exception("Too many arguments!")
 
-    candidates = list(filter(lambda opt: opt.arg == no_flag[0], COMMANDS))
+    candidates = list(filter(lambda opt: opt.arg == arguments[0], COMMANDS))
     if len(candidates) < 1:
         raise Exception("No argument was found!")
     if len(candidates) > 1:
@@ -132,18 +133,17 @@ def warn_user(action: Option) -> bool:
     print(f"You are going to execute command [{action.command}] marked as `dangerous`. Are you sure? [y/N]")
     while True:
         choice = input().lower()
-        if len(choice) == 0 or "no"[:len(choice)] == choice:
+        if not choice or "no".startswith(choice):
             return False
-        elif "yes"[:len(choice)] == choice:
+        elif "yes".startswith(choice):
             return True
         else:
             print("Please answer [yes] or [no].")
 
 
 def run() -> None:
     action = get_action_from_args() or get_action_from_cli()
-    if NO_INPUT:
-        action.disable_tty()
+    action.fill_tty(disable=NO_INPUT)
     if action.warn and not NO_INPUT:
         if not warn_user(action):
             print("Aborting.")

oioioi/cypress_settings.py

@@ -0,0 +1,73 @@
+# pylint: disable=wildcard-import
+from settings import *
+
+# Enable optional modules.
+INSTALLED_APPS = (
+    'oioioi.teachers',
+    'oioioi.ipdnsauth',
+    'oioioi.zeus',
+    'oioioi.oireports',
+    'oioioi.oisubmit',
+    'oioioi.complaints',
+    'oioioi.exportszu',
+    'oioioi.similarsubmits',
+    'oioioi.disqualification',
+    'oioioi.submitservice',
+    'oioioi.amppz',
+    'oioioi.teams',
+    'oioioi.pa',
+    'oioioi.notifications',
+    'oioioi.mailsubmit',
+    'oioioi.portals',
+    'oioioi.newsfeed',
+    'oioioi.simpleui',
+    'oioioi.livedata',
+) + INSTALLED_APPS
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'ATOMIC_REQUESTS': True,
+    }
+}
+
+TEMPLATES[0]['OPTIONS']['context_processors'] += [
+    'oioioi.portals.processors.portal_processor',
+]
+
+AUTHENTICATION_BACKENDS += (
+    'oioioi.base.tests.IgnorePasswordAuthBackend',
+    'oioioi.teachers.auth.TeacherAuthBackend',
+)
+
+MIDDLEWARE += ('oioioi.base.tests.FakeTimeMiddleware',)
+
+TESTS = True
+MOCK_RANKINGSD = True
+
+SECRET_KEY = 'no_secret'
+OISUBMIT_MAGICKEY = 'abcdef'
+USE_UNSAFE_EXEC = True
+USE_UNSAFE_CHECKER = True
+
+COMPLAINTS_EMAIL = '[email protected]'
+COMPLAINTS_SUBJECT_PREFIX = '[oioioi-complaints] '
+
+WARN_ABOUT_REPEATED_SUBMISSION = False
+
+PROBLEM_SOURCES += ('oioioi.zeus.problem_sources.ZeusProblemSource',)
+
+ZEUS_INSTANCES = {
+    'dummy': ('__use_object__', 'oioioi.zeus.tests.ZeusDummyServer', ('', '', '')),
+}
+
+CACHES = {'default': {'BACKEND': 'django.core.cache.backends.locmem.LocMemCache'}}
+
+# Do not print migrations DEBUG to console.
+LOGGING['loggers']['django.db.backends.schema'] = {
+    'handlers': ['console'],
+    'level': 'INFO',
+}
+
+CAPTCHA_TEST_MODE = True
+DEBUG = True

oioioi_cypress/.gitignore

@@ -0,0 +1,31 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+/.vscode
+/cypress/screenshots
+
+/.idea
+*.iml
+package-lock.json
+

oioioi_cypress/cypress.json

@@ -0,0 +1,5 @@
+{
+  "chromeWebSecurity": false,
+  "browser": "electron",
+  "video": false
+}

oioioi_cypress/cypress/fixtures/admin_admin.json

@@ -0,0 +1,20 @@
+[
+  {
+    "pk": 1,
+    "model": "auth.user",
+    "fields": {
+      "username": "admin",
+      "first_name": "Admin",
+      "last_name": "Admin",
+      "is_active": true,
+      "is_superuser": true,
+      "is_staff": true,
+      "last_login": "2012-07-31T20:27:58.768Z",
+      "groups": [],
+      "user_permissions": [],
+      "password": "pbkdf2_sha256$10000$xWTWx2IvUptP$s1g7RDNT2Be2fvDbp+XK+DBTstDGOKY66w9x65n/l/Y=",
+      "email": "[email protected]",
+      "date_joined": "2012-07-31T20:27:58.768Z"
+    }
+  }
+]

oioioi_cypress/cypress/fixtures/credentials.json

@@ -0,0 +1,13 @@
+{
+  "admin": {
+    "username": "admin",
+    "password": "admin"
+  },
+  "user": {
+    "username": "test_username",
+    "first_name": "test_name",
+    "last_name": "test_surname",
+    "email": "[email protected]",
+    "password": "test_password"
+  }
+}

oioioi_cypress/cypress/fixtures/inw.cpp

@@ -0,0 +1,25 @@
+/* Zadanie: Inwazja kosmitów
+   Autor: Tomasz Idziaszek
+   AMPPZ 2012
+
+   Rozwiązanie wzorcowe O(n)
+*/
+
+#include <cstdio>
+#include <algorithm>
+using namespace std;
+
+const int N=1000000;
+int n,a[N];
+long long d[N+1];
+
+int main() {
+   scanf("%d",&n);
+   for(int i=0; i<n; ++i)
+      scanf("%d",&a[i]);
+   d[0] = 0;
+   d[1] = a[0];
+   for(int i=1; i<n; ++i)
+      d[i+1] = max(d[i], d[i-1] + a[i]);
+   printf("%lld\n", d[n]);
+}