diff --git a/README.md b/README.md index 4a18e94..d3c0007 100644 --- a/README.md +++ b/README.md @@ -19,15 +19,17 @@ docker compose up * `/admin/grafana` - графана * `/docs` - обучающие материалы по анализу данных -После запуска по методу выше создается пользователь в админке (`/admin/`) с данными ниже:`admin` -- `admin` - логин -- `proooooood` - пароль +После запуска по методу выше создается пользователь в админке (`/admin/`) с данными ниже: +* `admin` - логин +* `proooooood` - пароль ## Тесты -Написаны unit-тесты (на базе Django TestCase) и E2E (Postman коллекция) +Написаны unit-тесты (на базе Django TestCase) и E2E (Postman коллекция). Они покрывают flow регистрации, просмотра и участия в соревновании. ![Postman data](img/postman.gif) -![django test]() +Ниже можно увидеть Coverage тестами бекенда данного приложения + +![django test](img/superduperdjangotests.png) diff --git a/img/superduperdjangotests.png b/img/superduperdjangotests.png new file mode 100644 index 0000000..d329283 Binary files /dev/null and b/img/superduperdjangotests.png differ diff --git a/services/backend/Dockerfile.staticfiles b/services/backend/Dockerfile.staticfiles index 21ac3a0..3916708 100644 --- a/services/backend/Dockerfile.staticfiles +++ b/services/backend/Dockerfile.staticfiles @@ -24,6 +24,6 @@ FROM docker.io/nginx:latest COPY --from=builder /app/static /usr/share/nginx/html -COPY ../checker/checker_requirements.txt . +COPY ../checker/checker_requirements.txt /usr/share/nginx/html CMD ["nginx", "-g", "daemon off;"] diff --git a/services/backend/apps/core/management/commands/generate_pretty_data.py b/services/backend/apps/core/management/commands/generate_pretty_data.py index bbcd67c..1de2cb5 100644 --- a/services/backend/apps/core/management/commands/generate_pretty_data.py +++ b/services/backend/apps/core/management/commands/generate_pretty_data.py @@ -14,7 +14,8 @@ from apps.review.models import Reviewer from apps.task.models import ( CompetitionTask, CompetitionTaskCriteria, - CompetitionTaskSubmission, CompetitionTaskAttachment, + CompetitionTaskSubmission, + CompetitionTaskAttachment, ) from apps.user.models import User, UserRole @@ -44,6 +45,15 @@ dataset2 = ContentFile( name=f"dataset-{uuid.uuid4().hex}.csv", ) +correct_answer_file = ContentFile( + b"42", + name=f"answer.txt", +) +correct2_answer_file = ContentFile( + b"it is a dataset", + name=f"answer.txt", +) + now = timezone.now() image_dir = f"{settings.BASE_DIR}/apps/core/contents/images" @@ -103,10 +113,11 @@ E — коэффициент чувствительности количеств { "obj": None, "title": "Задача 2", - "description": "Найдите максимальную зарплату программиста из датасета на питоне", + "description": "Найдите максимальную зарплату программиста из датасета на питоне. Программа должна вывести содержимое файла по пути /dataset", "type": CompetitionTask.CompetitionTaskType.CHECKER.value, + "correct_answer_file": correct2_answer_file, "attachment": dataset, - "attachment_path": "dataset", + "attachment_path": "/dataset", "points": 25, "submission_reviewers_count": 2, "max_attempts": 50, @@ -115,7 +126,7 @@ E — коэффициент чувствительности количеств "obj": None, "title": "Задача 3", "attachment": dataset2, - "attachment_path": "dataset2", + "attachment_path": "/dataset2", "description": """ Небольшой интернет-магазин собрал данные о действиях пользователей на своем сайте за последние несколько месяцев. @@ -317,9 +328,10 @@ B — пользователи, которым доступен только о и его характеристики. Однако оплатить товар можно и без захода на карточку товара. Задача: сравните группы по каждой метрике и сделайте вывод о том, стоит ли -продолжить внедрение обновленного магазина или нужно вернуть старый +продолжить внедрение обновленного магазина или нужно вернуть старый. Ответ 42. """.strip(), "type": CompetitionTask.CompetitionTaskType.CHECKER.value, + "correct_answer_file": correct_answer_file, "points": 30, "submission_reviewers_count": 2, }, @@ -338,7 +350,7 @@ B — пользователи, которым доступен только о "tasks": [ { "obj": None, - "title": "Анализ трендов", # TODO сюда добавить бд + "title": "Анализ трендов", # TODO сюда добавить бд "description": """ Скачайте базу данных со специальной страницы (https://dano.hse.ru/data), изучите ее более внимательно: посмотрите на переменные, посчитайте описательные статистики, постройте @@ -373,7 +385,7 @@ B — пользователи, которым доступен только о "submission_reviewers_count": 3, "max_attempts": 2, "attachment": dataset, - "attachment_path": "dataset", + "attachment_path": "/dataset", "criteries": [ { "obj": None, @@ -412,9 +424,8 @@ B — пользователи, которым доступен только о """.strip(), "type": CompetitionTask.CompetitionTaskType.INPUT.value, "points": 15, - "submission_reviewers_count": 2, "max_attempts": 50, - "correct_answer_file": ans3 + "correct_answer_file": ans3, }, { "obj": None, @@ -422,7 +433,6 @@ B — пользователи, которым доступен только о "description": "Сколько будет 6 * 7?", "type": CompetitionTask.CompetitionTaskType.INPUT.value, "points": 5, - "submission_reviewers_count": 2, "max_attempts": 10, "correct_answer_file": ans3, }, @@ -510,8 +520,8 @@ users = [ "role": UserRole.STUDENT.value, }, { - "email": "oleg-tinkov@gmail.com", - "username": "oleg-tinkov", + "email": "s.bliznyuk@tbank.ru", + "username": "s_bliznyuk", "password": "password123!", "role": UserRole.STUDENT.value, }, @@ -601,6 +611,7 @@ reviewers = [ }, ] + class Command(BaseCommand): help = "Generate sample data for Users, Competitions, Tasks, Submissions, and States." @@ -619,9 +630,9 @@ class Command(BaseCommand): def create_reviewers(self, count): reviewers_objs = [] for reviewer in reviewers: - name = reviewer['name'] - surname = reviewer['surname'] - token = reviewer['token'] + name = reviewer["name"] + surname = reviewer["surname"] + token = reviewer["token"] reviewer_obj = Reviewer(name=name, surname=surname, token=token) reviewer_obj.save() reviewers_objs.append(reviewer_obj) @@ -631,11 +642,11 @@ class Command(BaseCommand): users_objs = [] for user in users: user_obj, created = User.objects.get_or_create( - email=user['email'], + email=user["email"], defaults={ - "username": user['username'], - "password": make_password(user['password']), - "status": user['role'], + "username": user["username"], + "password": make_password(user["password"]), + "status": user["role"], }, ) users_objs.append(user_obj) @@ -646,20 +657,23 @@ class Command(BaseCommand): competitions_objs = [] for i, competition in enumerate(competitions): - competition_obj = Competition.objects.create( - title=competition['title'], - description=competition['description'], - start_date=competition['start_date'], - end_date=competition['end_date'], - type=competition['type'], - participation_type=competition['participation_type'], - ) + try: + competition_obj = Competition.objects.create( + title=competition["title"], + description=competition["description"], + start_date=competition["start_date"], + end_date=competition["end_date"], + type=competition["type"], + participation_type=competition["participation_type"], + ) + except Exception as e: + print(competition) if competition.get("image"): - competition_obj.image_url = competition['image'] + competition_obj.image_url = competition["image"] competition_obj.save() - competitions[i]['obj'] = competition_obj + competitions[i]["obj"] = competition_obj competition_obj.participants.add(*users) competitions_objs.append(competition_obj) self.stdout.write(f"Created competition: {competition['title']}") @@ -673,45 +687,53 @@ class Command(BaseCommand): CompetitionTask.CompetitionTaskType.INPUT.value, ] for i, competition in enumerate(competitions): - for j, task in enumerate(competition['tasks']): + for j, task in enumerate(competition["tasks"]): task_obj = CompetitionTask.objects.create( - in_competition_position=j+1, - competition=competition['obj'], - title=task['title'], - description=task['description'], - type=task['type'], - points=task['points'], - submission_reviewers_count=task['submission_reviewers_count'], - max_attempts=task.get('max_attempts'), + in_competition_position=j + 1, + competition=competition["obj"], + title=task["title"], + description=task["description"], + type=task["type"], + points=task["points"], + submission_reviewers_count=task[ + "submission_reviewers_count" + ] if task["type"] == CompetitionTask.CompetitionTaskType.REVIEW.value else None, + correct_answer_file=task["correct_answer_file"] if task["type"] != CompetitionTask.CompetitionTaskType.REVIEW.value else None, + max_attempts=task.get("max_attempts"), ) - competitions[i]['tasks'][j]['obj'] = task_obj + competitions[i]["tasks"][j]["obj"] = task_obj + - if task['type'] == CompetitionTask.CompetitionTaskType.INPUT.value: - task_obj.correct_answer_file = task['correct_answer_file'] if task.get("attachment"): CompetitionTaskAttachment.objects.create( task=task_obj, - file=task['attachment'], - bind_at=task['attachment_path'], - public=True + file=task["attachment"], + bind_at=task["attachment_path"], + public=True, ) if ( - task['type'] + task["type"] == CompetitionTask.CompetitionTaskType.REVIEW.value ): - for k, criteria in enumerate(task['criteries']): + for k, criteria in enumerate(task["criteries"]): criteria_obj = CompetitionTaskCriteria.objects.create( task=task_obj, - name=criteria['name'], - slug=criteria['slug'], - description=criteria['description'], - max_value=criteria['max_value'], + name=criteria["name"], + slug=criteria["slug"], + description=criteria["description"], + max_value=criteria["max_value"], + ) + competitions[i]["tasks"][j]["criteries"][k]["obj"] = ( + criteria_obj + ) + self.stdout.write( + f"Created criteria: {criteria['slug']}" ) - competitions[i]['tasks'][j]['criteries'][k]['obj'] = criteria_obj - self.stdout.write(f"Created criteria: {criteria['slug']}") tasks_objs.append(task_obj) - self.stdout.write(f"Created task: {task['title']} (type: {task['type']})") + self.stdout.write( + f"Created task: {task['title']} (type: {task['type']})" + ) self.add_reviewers_to_task(tasks_objs) return tasks_objs @@ -723,22 +745,29 @@ class Command(BaseCommand): def create_incorrect_submissions(self, tasks, users): for user in users: for task in tasks: - if task.type == CompetitionTask.CompetitionTaskType.REVIEW.value: + if ( + task.type + == CompetitionTask.CompetitionTaskType.REVIEW.value + ): num_submissions = random.randint(1, 3) for m in range(num_submissions): dummy_content_txt = ContentFile( - b"otvet: 112 sto proc" , + b"otvet: 112 sto proc", name=f"submission_{uuid.uuid4().hex}.txt", ) content_dir = f"{settings.BASE_DIR}/apps/core/contents" - with open(f"{content_dir}/presentation.pptx", "rb") as f: + with open( + f"{content_dir}/presentation.pptx", "rb" + ) as f: pptx = File(f, name="presentation.pptx") files = [pptx, pptx, dummy_content_txt] - submission = CompetitionTaskSubmission.objects.create( - user=user, - task=task, - content=random.choice(files), + submission = ( + CompetitionTaskSubmission.objects.create( + user=user, + task=task, + content=random.choice(files), + ) ) submission.save() submission.send_on_review() @@ -754,9 +783,10 @@ class Command(BaseCommand): competition=comp, defaults={ "state": "started", - "changed_at": timezone.now() - timedelta(days=random.randint(1, 30)), + "changed_at": timezone.now() + - timedelta(days=random.randint(1, 30)), }, ) self.stdout.write( f"Created state '{state_obj.state}' for user '{user.username}' in competition '{comp.title}'" - ) \ No newline at end of file + ) diff --git a/services/backend/apps/task/models.py b/services/backend/apps/task/models.py index 435f5b3..3752c34 100644 --- a/services/backend/apps/task/models.py +++ b/services/backend/apps/task/models.py @@ -3,6 +3,7 @@ from uuid import uuid4 from django.db import models from django.db.models import Count, Q +from django.core.validators import RegexValidator from django.core.exceptions import ValidationError from mdeditor.fields import MDTextField @@ -90,7 +91,7 @@ class CompetitionTask(BaseModel): raise ValidationError({ "correct_answer_file": "Загрузите правильный ответ" }) - + # if self.answer_file_path and not self.type == "checker": # raise ValidationError({ # "type": "Укажите другой тип задания: этот не совместим с путем правильного ответа" @@ -99,7 +100,7 @@ class CompetitionTask(BaseModel): raise ValidationError({ "answer_file_path": "Введите путь правильного ответа - это нужно для корректной работы чекера" }) - + if not self.reviewers and self.type == "review": raise ValidationError({ "reviewers": "Загрузите ревьюверов - кто будет проверять задания, если не они?" @@ -109,7 +110,6 @@ class CompetitionTask(BaseModel): # "type": "Проверьте тип - вы ввели ревьюверов, но задание не является ручным" # }) - def __str__(self): return self.title @@ -149,7 +149,16 @@ class CompetitionTaskAttachment(BaseModel): related_name="attachments", ) file = models.FileField(upload_to=file_upload_at, verbose_name="файл") - bind_at = models.CharField(verbose_name="путь сохранения", max_length=255) + bind_at = models.CharField( + verbose_name="путь сохранения", + max_length=255, + validators=[ + RegexValidator( + r"^(?:[a-zA-Z]:\\(?:[^<>:\"\/\\|?*]*\\)*|/(?:[^<>:\"\/\\|?*]+/?)*)$", + message="Введите абсолютный путь до папки", + ) + ], + ) public = models.BooleanField(default=False, verbose_name="публичный") class Meta: diff --git a/services/backend/apps/task/tasks.py b/services/backend/apps/task/tasks.py index 522bf3a..98d3842 100644 --- a/services/backend/apps/task/tasks.py +++ b/services/backend/apps/task/tasks.py @@ -35,7 +35,7 @@ def analyze_data_task(self, submission_id): "code": base64.b64encode(code).decode("utf-8"), "answer_file_path": submission.task.answer_file_path, "expected_hash": hashlib.sha256( - submission.task.correct_answer_file.read() + submission.task.correct_answer_file.read().decode("utf-8") ).hexdigest(), }, timeout=30,