Merge branch 'main' into shortcut-to-exam

Author: FSadrieh

.gitattributes

@@ -0,0 +1,7 @@
+# Since text files will be used in a linux environment where LF is expected, git shouldn't change line endings to CRLF on windows machines
+* text=auto eol=lf
+
+# things that fail without this:
+# * bash autocompletion (.sh): -bash: /etc/bash_completion.d/manage_autocompletion.sh: line 8: syntax error near unexpected token `$'\r''
+# * running python files: /usr/bin/env: ‘python3\r’: No such file or directory
+# Since that's a huge part of the code base, it doesn't really make sense to allow automatic EOL conversion for the rest of the files.

.gitmodules

@@ -1,3 +1,4 @@
 [submodule "evap/static/bootstrap"]
 	path = evap/static/bootstrap
 	url = https://github.com/twbs/bootstrap.git
+	shallow = true

README.md

@@ -12,39 +12,37 @@ EvaP is the course evaluation system used internally at Hasso Plattner Institute
 For the documentation, please see our [wiki](https://github.com/e-valuation/EvaP/wiki).
 
 
-## Installation
+## Installation (for Development)
 
 The easiest setup using [Vagrant](https://www.vagrantup.com) is shown here.
 
-0. Install [git](https://git-scm.com/downloads), [Vagrant](https://www.vagrantup.com/downloads.html), and one of [VirtualBox](https://www.virtualbox.org/wiki/Downloads) (recommended) or [Docker](https://docs.docker.com/engine/install/) (for ARM systems).
+1. Install [git](https://git-scm.com/downloads), [Vagrant](https://www.vagrantup.com/downloads.html), and one of [VirtualBox](https://www.virtualbox.org/wiki/Downloads) (recommended) or [Docker](https://docs.docker.com/engine/install/) (for ARM systems).
 
-1. Fork the EvaP repository (using the Fork-button in the upper right corner on GitHub).
+2. Run the following commands on the command line to clone the repository, create the Vagrant VM and run the Django development server.
+   * If you are familiar with the fork-based open source workflow, create a fork and clone that (using SSH if you prefer that).
 
-2. Windows users only (might not apply for the Linux subsystem):
-   * Line endings: git's [`core.autocrlf` setting](https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration#_core_autocrlf) has to be `false` or `input` so git does not convert line endings on checkout, because the code will be used in a Linux VM. We suggest using this command in Git Bash:
+   * Windows users: We have observed [weird](https://www.github.com/git-for-windows/git/issues/4705) [behavior](https://www.github.com/git-for-windows/git/issues/4704) with SSH in Git Bash on Windows and thus recommend using PowerShell instead.
 
-     ```bash
-     git config --global core.autocrlf input
-     ```
+   * To use Docker, replace `vagrant up` with `vagrant up --provider docker && vagrant provision`.
 
-3. Run the following commands on the command line to clone the repository, create the Vagrant VM and run the Django development server.
-   To use Docker, replace `vagrant up` with `vagrant up --provider docker && vagrant provision`.
    ```bash
-   git clone --recurse-submodules https://github.com/<your_github_username>/EvaP.git
+   git clone --recurse-submodules https://github.com/e-valuation/EvaP.git
    cd EvaP
    vagrant up
    vagrant ssh
+   ```
+   and, after the last command opened an SSH session in the development machine:
+   ```bash
    ./manage.py run
    ```
 
-4. Open your browser at http://localhost:8000/ and login with email `evap@institution.example.com` and password `evap`.
-
+3. Open your browser at http://localhost:8000/ and login with email `evap@institution.example.com` and password `evap`.
 
 That's it!
 
 ## Contributing
 
-We'd love to see contributions, feel free to fork! You should probably branch off `main`, the branch `release` is used for stable revisions.
+We'd love to see contributions! PRs solving existing issues are most helpful to us. It's best if you ask to be assigned for the issue so we won't have multiple people working on the same issue. Feel free to open issues for bugs, setup problems, or feature requests. If you have other questions, feel free to contact the [organization members](https://github.com/orgs/e-valuation/people). You should probably branch off `main`, the branch `release` is used for stable revisions.
 
 Before committing, run the following commands:
 - `./manage.py test` (runs the test suite)
@@ -55,6 +53,22 @@ or, to combine all three, simply run `./manage.py precommit`.
 
 You can also set up `pylint`, `isort`, `black` and `prettier` in your IDE to avoid doing this manually all the time.
 
+### Creating a Pull Request (Workflow Suggestion)
+1. (once) [Fork](https://github.com/e-valuation/EvaP/fork) the repository so you have a GitHub repo that you have write access to.
+
+2. (once) Set up some authentication for GitHub that allows push access. A common option is using [SSH keys](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/about-ssh), the remaining instructions assume an SSH key setup. An alternative is using the [GitHub CLI tool](https://cli.github.com/).
+
+3. (once) Ensure your [git remotes](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes) are setup to use SSH. To fetch the up-to-date state of the official repo, it's useful to have an "upstream" remote configured:
+   ```bash
+   git remote set-url origin git@github.com:<your-username>/EvaP.git
+   git remote add upstream git@github.com:e-valuation/EvaP.git
+   ```
+
+4. Create a branch (`git switch -c <your-branch-name>`), commit your changes (`git add` and `git commit`), and push them (`git push`). "Push" will ask you to specify an upstream branch (`git push -u origin <your-branch-name>`).
+
+5. GitHub should now ask you whether you want to open a pull request ("PR"). If the PR solves an issue, use one of GitHub's [magic keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) (like "fixes") in the pull request description to create a link between your PR and the issue. If necessary, please also provide a short summary of your changes in the description.
+
+
 ## License
 
 MIT, see [LICENSE.md](LICENSE.md).

Vagrantfile

@@ -18,6 +18,12 @@ Vagrant.configure("2") do |config|
     end
   end
 
+  if Vagrant::Util::Platform.windows? then
+    # workaround for git bash not automatically allocating a tty on windows in some scenarios
+    # see https://github.com/hashicorp/vagrant/issues/9143#issuecomment-401088752
+    config.ssh.extra_args = "-tt"
+  end
+
   config.vm.provider :docker do |d, override|
     d.image = "ubuntu:jammy"
     # Docker container really are supposed to be used differently. Hacky way to make it into a "VM".

evap/contributor/tests/test_views.py

@@ -1,4 +1,6 @@
+import xlrd
 from django.core import mail
+from django.urls import reverse
 from django_webtest import WebTest
 from model_bakery import baker
 
@@ -284,3 +286,17 @@ def test_display_request_buttons(self):
         page = self.app.get(self.url, user=self.responsible)
         self.assertEqual(page.body.decode().count("Request changes"), 0)
         self.assertEqual(page.body.decode().count("Request creation of new account"), 2)
+
+
+class TestContributorResultsExportView(WebTest):
+    @classmethod
+    def setUpTestData(cls):
+        result = create_evaluation_with_responsible_and_editor()
+        cls.url = reverse("contributor:export")
+        cls.user = result["responsible"]
+
+    def test_concise_header(self):
+        response = self.app.get(self.url, user=self.user)
+
+        workbook = xlrd.open_workbook(file_contents=response.content)
+        self.assertEqual(workbook.sheets()[0].row_values(0)[0], f"Evaluation\n{self.user.full_name}")

evap/contributor/views.py

@@ -288,6 +288,7 @@ def export_contributor_results(contributor):
         include_not_enough_voters=True,
         include_unpublished=False,
         contributor=contributor,
+        verbose_heading=False,
     )
     return response
 

evap/development/fixtures/test_data.json

@@ -132980,7 +132980,7 @@
     "title": "",
     "first_name_given": "",
     "first_name_chosen": "",
-    "last_name": "",
+    "last_name": "reviewer",
     "language": "",
     "is_proxy_user": false,
     "login_key": null,
@@ -133008,7 +133008,7 @@
     "title": "",
     "first_name_given": "",
     "first_name_chosen": "",
-    "last_name": "",
+    "last_name": "proxy",
     "language": "",
     "is_proxy_user": true,
     "login_key": null,
@@ -133043,7 +133043,7 @@
     "title": "",
     "first_name_given": "",
     "first_name_chosen": "",
-    "last_name": "",
+    "last_name": "proxy_delegate",
     "language": "",
     "is_proxy_user": false,
     "login_key": null,
@@ -133071,7 +133071,79 @@
     "title": "",
     "first_name_given": "",
     "first_name_chosen": "",
-    "last_name": "",
+    "last_name": "proxy_delegate_2",
+    "language": "",
+    "is_proxy_user": false,
+    "login_key": null,
+    "login_key_valid_until": null,
+    "is_active": true,
+    "notes": "",
+    "startpage": "DE",
+    "groups": [],
+    "user_permissions": [],
+    "delegates": [],
+    "cc_users": []
+  }
+},
+{
+  "model": "evaluation.userprofile",
+  "fields": {
+    "password": "eZAyFmtqHydCIFtGdbevAxiVjiRpqMtmaVUCrmkcfXdoJDigmGWPVNHeoYYyRojokKUJjsgPSPvZkjiiIHSIQlBfOKtQFDbZlPEyKnrQRrHdPtEhUYHqJauIlyIkYpBM",
+    "last_login": null,
+    "is_superuser": false,
+    "email": "vincenzo.boston@student.institution.example.com",
+    "title": "",
+    "first_name_given": "Vincenzo Alfredo",
+    "first_name_chosen": "",
+    "last_name": "Boston",
+    "language": "",
+    "is_proxy_user": false,
+    "login_key": null,
+    "login_key_valid_until": null,
+    "is_active": true,
+    "notes": "",
+    "startpage": "DE",
+    "groups": [],
+    "user_permissions": [],
+    "delegates": [],
+    "cc_users": []
+  }
+},
+{
+  "model": "evaluation.userprofile",
+  "fields": {
+    "password": "utAhMBbTpirVqtaoPpadEHdamaehnXWbEsliMMSnwDBYJcTnHluinAxkTeEupPoBzpuDBMYeXbpwmockMtQNYegbMuxkUBEBKqWGkOEFAWxzUFjdxevtIwYzvAgHCAwD",
+    "last_login": null,
+    "is_superuser": false,
+    "email": "bud.ledbetter@student.institution.example.com",
+    "title": "",
+    "first_name_given": "Bud",
+    "first_name_chosen": "",
+    "last_name": "LedBetter",
+    "language": "",
+    "is_proxy_user": false,
+    "login_key": null,
+    "login_key_valid_until": null,
+    "is_active": true,
+    "notes": "",
+    "startpage": "DE",
+    "groups": [],
+    "user_permissions": [],
+    "delegates": [],
+    "cc_users": []
+  }
+},
+{
+  "model": "evaluation.userprofile",
+  "fields": {
+    "password": "naFmzOVrFhXrVVLsIGFYceDAarTGwDRFZKGJwBvKhNFCpupezBrwhorUHsyQSpUxLFKSQuOurcIyoBBYRjARXjzcJCbqYRiKRMOwvdTqwNjAbYDhUKbopBPDYhANXUkI",
+    "last_login": null,
+    "is_superuser": false,
+    "email": "melody.large@student.institution.example.com",
+    "title": "",
+    "first_name_given": "Melody",
+    "first_name_chosen": "",
+    "last_name": "Large",
     "language": "",
     "is_proxy_user": false,
     "login_key": null,

evap/development/management/commands/dump_testdata.py

@@ -1,9 +1,10 @@
 import os
 
 from django.conf import settings
-from django.core.management import call_command
 from django.core.management.base import BaseCommand
 
+from evap.evaluation.management.commands.tools import logged_call_command
+
 
 class Command(BaseCommand):
     args = ""
@@ -12,7 +13,8 @@ class Command(BaseCommand):
 
     def handle(self, *args, **options):
         outfile_name = os.path.join(settings.BASE_DIR, "development", "fixtures", "test_data.json")
-        call_command(
+        logged_call_command(
+            self.stdout,
             "dumpdata",
             "auth.group",
             "evaluation",

evap/development/management/commands/reload_testdata.py

@@ -1,7 +1,6 @@
-from django.core.management import call_command
 from django.core.management.base import BaseCommand
 
-from evap.evaluation.management.commands.tools import confirm_harmful_operation
+from evap.evaluation.management.commands.tools import confirm_harmful_operation, logged_call_command
 
 
 class Command(BaseCommand):
@@ -14,24 +13,18 @@ def handle(self, *args, **options):
         if not confirm_harmful_operation(self.stdout):
             return
 
-        self.stdout.write('Executing "python manage.py reset_db"')
-        call_command("reset_db", interactive=False)
+        logged_call_command(self.stdout, "reset_db", interactive=False)
 
-        self.stdout.write('Executing "python manage.py migrate"')
-        call_command("migrate")
+        logged_call_command(self.stdout, "migrate")
 
         # clear any data the migrations created.
         # their pks might differ from the ones in the dump, which results in errors on loaddata
-        self.stdout.write('Executing "python manage.py flush"')
-        call_command("flush", interactive=False)
+        logged_call_command(self.stdout, "flush", interactive=False)
 
-        self.stdout.write('Executing "python manage.py loaddata test_data"')
-        call_command("loaddata", "test_data")
+        logged_call_command(self.stdout, "loaddata", "test_data")
 
-        self.stdout.write('Executing "python manage.py clear_cache --all -v=1"')
-        call_command("clear_cache", "--all", "-v=1")
+        logged_call_command(self.stdout, "clear_cache", "--all", "-v=1")
 
-        self.stdout.write('Executing "python manage.py refresh_results_cache"')
-        call_command("refresh_results_cache")
+        logged_call_command(self.stdout, "refresh_results_cache")
 
         self.stdout.write("Done.")

evap/development/management/commands/translate.py

@@ -1,11 +1,20 @@
-from django.core.management import call_command
 from django.core.management.base import BaseCommand
 
+from evap.evaluation.management.commands.tools import logged_call_command
+
 
 class Command(BaseCommand):
     args = ""
     help = 'Execute "makemessages --locale=de --ignore=node_modules/*"'
 
     def handle(self, *args, **options):
-        self.stdout.write('Executing "manage.py makemessages --locale=de --ignore=node_modules/*"')
-        call_command("makemessages", "--locale=de", "--ignore=node_modules/*")
+        logged_call_command(self.stdout, "makemessages", "--locale=de", "--ignore=node_modules/*")
+        logged_call_command(
+            self.stdout,
+            "makemessages",
+            "--domain=djangojs",
+            "--extension=js,ts",
+            "--locale=de",
+            "--ignore=node_modules/*",
+            "--ignore=evap/static/js/*.min.js",
+        )

evap/development/tests/test_commands.py

@@ -10,7 +10,7 @@
 class TestDumpTestDataCommand(TestCase):
     @staticmethod
     def test_dumpdata_called():
-        with patch("evap.development.management.commands.dump_testdata.call_command") as mock:
+        with patch("evap.evaluation.management.commands.tools.call_command") as mock:
             management.call_command("dump_testdata")
 
         outfile_name = os.path.join(settings.BASE_DIR, "development", "fixtures", "test_data.json")
@@ -31,7 +31,7 @@ def test_dumpdata_called():
 
 class TestReloadTestdataCommand(TestCase):
     @patch("builtins.input")
-    @patch("evap.development.management.commands.reload_testdata.call_command")
+    @patch("evap.evaluation.management.commands.tools.call_command")
     def test_aborts(self, mock_call_command, mock_input):
         mock_input.return_value = "not yes"
 
@@ -40,7 +40,7 @@ def test_aborts(self, mock_call_command, mock_input):
         self.assertEqual(mock_call_command.call_count, 0)
 
     @patch("builtins.input")
-    @patch("evap.development.management.commands.reload_testdata.call_command")
+    @patch("evap.evaluation.management.commands.tools.call_command")
     def test_executes_key_commands(self, mock_call_command, mock_input):
         mock_input.return_value = "yes"
 

evap/evaluation/management/commands/tools.py

@@ -2,6 +2,7 @@
 import sys
 
 from django.conf import settings
+from django.core.management import call_command
 
 logger = logging.getLogger(__name__)
 
@@ -40,3 +41,9 @@ def handle(self, *args, **options):
                 raise
 
     return NewClass
+
+
+def logged_call_command(stdout, *args, **kwargs):
+    """Log execution of management command with all args."""
+    stdout.write("Executing python manage.py " + " ".join(list(args) + [f"{a}={b}" for a, b in kwargs.items()]))
+    call_command(*args, **kwargs)

evap/evaluation/migrations/0142_alter_evaluation_state.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.7 on 2023-11-13 20:59
+
+from django.db import migrations
+import django_fsm
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("evaluation", "0141_userprofile_notes"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="evaluation",
+            name="state",
+            field=django_fsm.FSMIntegerField(default=10, protected=True, verbose_name="state"),
+        ),
+    ]