Merge branch 'master' into notifications-python

Author: stopnoanime

.git-blame-ignore-revs

@@ -0,0 +1,18 @@
+name: Ruff
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v3
+        with:
+          src: "./oioioi"
+          version: 0.11.12

.github/workflows/ruff.yml

@@ -0,0 +1,8 @@
+repos:
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.12
+    hooks:
+    -   id: ruff-check
+        files: ^oioioi/
+        args: [ --fix, --exit-non-zero-on-fix ]
+    -   id: ruff-format

.pep8rc

@@ -47,16 +47,13 @@ RUN rm /bin/sh && ln -s /bin/bash /bin/sh && \
 RUN sed -i -e "s/# en_US.UTF-8 UTF-8/en_US.UTF-8 UTF-8/" /etc/locale.gen && \
     locale-gen
 
-COPY ./entrypoint_checks.sh /entrypoint_checks.sh
-RUN chmod +x /entrypoint_checks.sh && chown oioioi /entrypoint_checks.sh
-
 # Installing python dependencies
 USER oioioi
 
 ENV PATH $PATH:/home/oioioi/.local/bin/
 
 ENV BERKELEYDB_DIR /usr
-RUN pip3 install --user psycopg2-binary==2.9.5 twisted uwsgi
+RUN pip3 install --user psycopg2-binary twisted uwsgi
 RUN pip3 install --user bsddb3==6.2.7
 
 WORKDIR /sio2/oioioi
@@ -65,6 +62,7 @@ COPY --chown=oioioi:oioioi setup.py requirements.txt ./
 RUN pip3 install -r requirements.txt --user filetracker[server]
 COPY --chown=oioioi:oioioi requirements_static.txt ./
 RUN pip3 install -r requirements_static.txt --user
+RUN pip3 install --user -U "gevent==25.5.1"  # override version of gevent
 
 # Installing node dependencies
 ENV PATH $PATH:/sio2/oioioi/node_modules/.bin

.pre-commit-config.yaml

@@ -85,27 +85,6 @@ you are connected to after using docker exec -it “web” /bin/bash. The defaul
     docker compose -f docker-compose-dev.yml exec "web" ../oioioi/test.sh
     docker compose -f docker-compose-dev.yml exec "web" ../oioioi/test.sh oioioi/{name_of_the_app}/
 
-Running static code analysis tools locally (requires Docker)
-~~~~~~~~~~~~~~~~~~~~~~~
-
-The static code analysis tools currently in use for python code are black, isort, pep8 and pylint.
-All of them can be run locally using the `run_static.sh` shell script.
-In order for the script to work the `web` container from docker-compose-dev.yml needs to be running.
-The docker image for the project needs to be rebuild if you are migrating from and older Dockerfile version (rebuild the image if you are getting error messages that isort or black are not installed).
-Commands for building the image and starting up the containers are listed in the paragraphs above.
-
-When running all tools at once or when running pep8 and pylint independently only the recently modified files (files modified in the most recent commit or staged changes) will be processed.
-
-To run all tools at once::
-
-    ./run_static.sh
-
-To run one of the tools::
-
-    ./run_static.sh black
-    ./run_static.sh isort
-    ./run_static.sh pylint
-    ./run_static.sh pep8
 
 Script toolbox for Docker (development)
 ~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -121,6 +100,37 @@ Developer environment can be easily set up by running::
 
 For system requirements check `easy_toolbox.py`.
 
+Running static code analysis tools locally
+~~~~~~~~~~~~~~~~~~~~~~~
+.. _ruff: https://github.com/astral-sh/ruff
+
+The static code analysis tool (linter and formatter) currently in use for Python code is `ruff`_.
+
+It can can be run locally using the::
+
+    ./easy_toolbox.py ruff
+
+In order for the script to work the `web` container from `docker-compose-dev.yml` needs to be running.
+
+To allow ruff to fix the errors, add the `--fix` flag::
+
+    ./easy_toolbox.py ruff --fix
+
+To avoid having to run this command every time before committing, you can install `pre-commit` along with ruff::
+
+    pip install -r requirements_static.txt
+
+Then simply run the following command::
+
+    pre-commit install
+
+From now on, ruff will run automatically before each commit - just keep in mind
+that ruff will only run on the files you have modified.
+
+If you want to check all files, not just the modified ones, you can run::
+
+     pre-commit run --all-files
+
 Manual installation (deprecated)
 ~~~~~~~~~~~~~~~~~~~
 

.pylintrc

@@ -8,11 +8,8 @@
 
 
 def pytest_addoption(parser):
-    parser.addoption(
-        '--runslow', action='store_true', default=False, help="run slow tests"
-    )
-    parser.addoption(
-        '--strict-template-vars', action='store_true', help="Raise errors for undefined template variables")
+    parser.addoption("--runslow", action="store_true", default=False, help="run slow tests")
+    parser.addoption("--strict-template-vars", action="store_true", help="Raise errors for undefined template variables")
 
 
 # called for running each test
@@ -24,12 +21,12 @@ def pytest_runtest_setup(item):
 def pytest_configure(config):
     if config.getoption("--strict-template-vars"):
         # this will raise an error if a template variable is not defined
-        settings.TEMPLATES[0]['OPTIONS']['string_if_invalid'] = '{% templatetag openvariable %} INVALID_VAR: %s {% templatetag closevariable %}'
-        
+        settings.TEMPLATES[0]["OPTIONS"]["string_if_invalid"] = "{% templatetag openvariable %} INVALID_VAR: %s {% templatetag closevariable %}"
+
 
 def pytest_collection_modifyitems(config, items):
     # --runslow flag: do not skip slow tests
-    if config.getoption('--runslow', False):
+    if config.getoption("--runslow", False):
         return
     skip_slow = pytest.mark.skip(reason="need --runslow option to run")
     for item in items:
@@ -47,3 +44,12 @@ def pytest_html_results_table_header(cells):
 @pytest.hookimpl(optionalhook=True)
 def pytest_html_results_table_row(report, cells):
     cells.pop()
+
+
+@pytest.fixture()
+def require_migrations_flag(request):
+    config = request.config
+    nomigrations_enabled_flag = config.getoption("nomigrations")
+
+    if nomigrations_enabled_flag:
+        pytest.skip("Test requires the --migrations flag to run.")