Merge branch 'sio2project:master' into issue288

Author: MasloMaslane

.readthedocs.yaml

@@ -30,5 +30,5 @@ sphinx:
 
 python:
    install:
-   - requirements: rst/requirements.txt
    - requirements: requirements.txt
+   - requirements: rst/requirements.txt

Dockerfile

@@ -22,6 +22,8 @@ RUN apt-get update && \
         sudo \
         libstdc++6 \
         zlib1g \
+        sox \
+        flite \
         locales \
         python3-pip && \
     apt-get clean

easy_toolbox.py

@@ -3,7 +3,7 @@
 # pip requirements:
 #   python ^3.6
 #   inquirer     (only for GUI)
-# 
+#
 # system:
 #   docker
 #   docker-compose
@@ -15,9 +15,9 @@
 # is prepared and should be upgraded or/and extended
 # for any future needs.
 
-import sys
 import os
-
+import sys
+from shlex import quote
 
 BASE_DOCKER_COMMAND = "OIOIOI_UID=$(id -u) docker-compose" + \
                       " -f docker-compose-dev.yml"
@@ -29,19 +29,18 @@
     ("run", "Run server", "{exec} web python3 manage.py runserver 0.0.0.0:8000"),
     ("stop", "Stop all SIO2 containers", "stop"),
     ("bash", "Open command prompt on web container.", "{exec} web bash"),
+    ("exec", "Run a command in the web container.", "{exec} web {extra_args}"),
     ("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 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"),
+    ("test", "Run unit tests.", "{exec} web ../oioioi/test.sh {extra_args}"),
+    ("test-slow", "Run unit tests. (--runslow)", "{exec} web ../oioioi/test.sh --runslow {extra_args}"),
     ("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 {extra_args}"),
     ("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])
@@ -52,15 +51,19 @@ class Help(Exception):
 
 
 class Option:
-    def __init__(self, _arg, _help, _command, _warn=False):
+    def __init__(self, _arg, _help, _command, _warn=False, extra_args=None):
         self.arg = _arg
+        self.extra_args = extra_args
         self.help = _help
         self.command = _command
         self.warn = _warn
 
     # If we use exec we should add -T for GitHub actions (disable tty).
-    def fill_tty(self, disable=False):
-        self.command = self.command.format(exec="exec -T" if disable else "exec")
+    def gen_full_command(self, disable=False):
+        return self.command.format(
+            exec="exec -T" if disable else "exec",
+            extra_args=self.extra_args or "",
+        )
 
     def long_str(self) -> str:
         return f"Option({self.arg}, Description='{self.help}', Command='{self.command}')"
@@ -70,14 +73,10 @@ def __str__(self) -> str:
         return f"[{self.arg}] {' ' * spaces} {self.help}"
 
 
-COMMANDS = [Option(*x) for x in RAW_COMMANDS]
-
-
-def check_commands() -> None:
-    if len(set([opt.arg for opt in COMMANDS])) != len(COMMANDS):
-        raise Exception("Error in COMMANDS. Same name was declared for more then one command.")
-
+# command names are unique
+assert len(RAW_COMMANDS) == len({x[0] for x in RAW_COMMANDS})
 
+COMMANDS = {x[0]: Option(*x) for x in RAW_COMMANDS}
 NO_INPUT = False
 
 
@@ -86,26 +85,28 @@ def get_action_from_args() -> Option:
     arguments = []
 
     for arg in sys.argv[1:]:
-        if arg in ['--help', '-h']:
-            raise Help()
-        elif arg in ['--no-input', '-i']:
+        if arg in ["--help", "-h"]:
+            raise Help
+        elif arg in ["--no-input", "-i"]:
             global NO_INPUT
             NO_INPUT = True
         else:
             arguments.append(arg)
 
     if len(arguments) < 1:
         return None
-    if len(arguments) > 1:
-        raise Exception("Too many arguments!")
 
-    candidates = list(filter(lambda opt: opt.arg == arguments[0], COMMANDS))
-    if len(candidates) < 1:
+    if arguments[0] not in COMMANDS:
         raise Exception("No argument was found!")
-    if len(candidates) > 1:
-        raise Exception("More then one matching argument was found!")
+    opt = COMMANDS[arguments[0]]
+
+    if len(arguments) > 1:
+        if r"{extra_args}" in opt.command:
+            opt.extra_args = " ".join(map(quote, arguments[1:]))
+        else:
+            raise Exception("Too many arguments!")
 
-    return candidates[0]
+    return opt
 
 
 def get_action_from_gui() -> Option:
@@ -114,18 +115,18 @@ def get_action_from_gui() -> Option:
         inquirer.List(
             "action",
             message="Select OIOIOI action",
-            choices=COMMANDS
-        )
+            choices=COMMANDS,
+        ),
     ]
     answers = inquirer.prompt(questions)
     return answers["action"]
 
 
 def run_command(command) -> None:
-    print('Running command', command)
+    print("Running command", command)
     if not NO_INPUT:
         width = os.get_terminal_size().columns
-        print('=' * width)
+        print("=" * width)
     sys.exit(os.WEXITSTATUS(os.system(command)))
 
 
@@ -143,30 +144,34 @@ def warn_user(action: Option) -> bool:
 
 def run() -> None:
     action = get_action_from_args() or get_action_from_gui()
-    action.fill_tty(disable=NO_INPUT)
+    command = action.gen_full_command(disable=NO_INPUT)
     if action.warn and not NO_INPUT:
         if not warn_user(action):
             print("Aborting.")
             return
-    run_command(f'{BASE_DOCKER_COMMAND} {action.command}')
+    run_command(f"{BASE_DOCKER_COMMAND} {command}")
 
 
 def print_help() -> None:
-    print("OIOIOI helper toolbox", "", "This script allows to control OIOIOI with Docker commands.",
-          f"Commands are always being run with '{BASE_DOCKER_COMMAND}' prefix.",
-          f"Aveliable commands are: ", "",
-          *COMMANDS, "", "Example `build`:", f"{sys.argv[0]} build", sep="\n")
+    print(
+        "OIOIOI helper toolbox", "", "This script allows to control OIOIOI with Docker commands.",
+        f"Commands are always being run with '{BASE_DOCKER_COMMAND}' prefix.",
+        "Available commands are: ", "",
+        *COMMANDS.values(), "",
+        "Example `build`:",
+        f"{sys.argv[0]} build",
+        sep="\n",
+    )
 
 
 def main() -> None:
     try:
-        check_commands()
         run()
     except Help:
         print_help()
     except Exception as e:
         print(f"An error occurred during execution: {e}", file=sys.stderr)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

jsconfig.json

@@ -0,0 +1,30 @@
+{
+    "$schema": "https://json.schemastore.org/jsconfig",
+    "compilerOptions": {
+        "target": "ES2022",
+        "moduleResolution": "NodeNext",
+        "module": "NodeNext",
+        "lib": [
+            "ES2022",
+            "DOM",
+            "DOM.Iterable"
+        ],
+        "allowJs": true,
+        "checkJs": true,
+        "noEmit": true,
+        "strict": true,
+        "exactOptionalPropertyTypes": true,
+        // "resolveJsonModule": true,
+        // "noUncheckedIndexedAccess": true, // Broken
+        "skipLibCheck": false // Poorly documented, doesn't check own project files if true (default)
+    },
+    // Files we wish to typecheck
+    "include": [
+        "oioioi/notifications/**/*"
+    ],
+    "typeAcquisition": {
+        "include": [
+            "jquery"
+        ]
+    }
+}