From 1046d28092508fc9d4300729f762191369dd7676 Mon Sep 17 00:00:00 2001 From: Jannat Patel Date: Wed, 11 Oct 2023 12:25:46 +0530 Subject: [PATCH 01/33] feat: quiz refactor --- lms/hooks.py | 1 - lms/lms/doctype/lms_question/__init__.py | 0 lms/lms/doctype/lms_question/lms_question.js | 8 + .../doctype/lms_question/lms_question.json | 221 ++++++++++++++++++ lms/lms/doctype/lms_question/lms_question.py | 48 ++++ .../doctype/lms_question/test_lms_question.py | 9 + lms/lms/doctype/lms_quiz/lms_quiz.py | 79 +------ .../lms_quiz_question/lms_quiz_question.json | 195 +--------------- lms/patches.txt | 4 +- lms/patches/v1_0/create_quiz_questions.py | 52 +++++ .../mark_confirmation_for_batch_students.py | 9 + lms/www/batches/batch.js | 2 +- 12 files changed, 358 insertions(+), 270 deletions(-) create mode 100644 lms/lms/doctype/lms_question/__init__.py create mode 100644 lms/lms/doctype/lms_question/lms_question.js create mode 100644 lms/lms/doctype/lms_question/lms_question.json create mode 100644 lms/lms/doctype/lms_question/lms_question.py create mode 100644 lms/lms/doctype/lms_question/test_lms_question.py create mode 100644 lms/patches/v1_0/create_quiz_questions.py create mode 100644 lms/patches/v1_0/mark_confirmation_for_batch_students.py diff --git a/lms/hooks.py b/lms/hooks.py index 0c82242b..dbfd815f 100644 --- a/lms/hooks.py +++ b/lms/hooks.py @@ -98,7 +98,6 @@ override_doctype_class = { doc_events = { "Discussion Reply": {"after_insert": "lms.lms.utils.create_notification_log"}, - "Course Lesson": {"on_update": "lms.lms.doctype.lms_quiz.lms_quiz.update_lesson_info"}, } # Scheduled Tasks diff --git a/lms/lms/doctype/lms_question/__init__.py b/lms/lms/doctype/lms_question/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/lms/lms/doctype/lms_question/lms_question.js b/lms/lms/doctype/lms_question/lms_question.js new file mode 100644 index 00000000..74a28732 --- /dev/null +++ b/lms/lms/doctype/lms_question/lms_question.js @@ -0,0 +1,8 @@ +// Copyright (c) 2023, Frappe and contributors +// For license information, please see license.txt + +// frappe.ui.form.on("LMS Question", { +// refresh(frm) { + +// }, +// }); diff --git a/lms/lms/doctype/lms_question/lms_question.json b/lms/lms/doctype/lms_question/lms_question.json new file mode 100644 index 00000000..c91f4937 --- /dev/null +++ b/lms/lms/doctype/lms_question/lms_question.json @@ -0,0 +1,221 @@ +{ + "actions": [], + "allow_rename": 1, + "autoname": "format:QTS-{YYYY}-{#####}", + "creation": "2023-10-10 10:24:14.035772", + "default_view": "List", + "doctype": "DocType", + "editable_grid": 1, + "engine": "InnoDB", + "field_order": [ + "question", + "type", + "multiple", + "section_break_ytxi", + "option_1", + "is_correct_1", + "column_break_fpvl", + "explanation_1", + "section_break_eiaa", + "option_2", + "is_correct_2", + "column_break_akwy", + "explanation_2", + "section_break_cwqv", + "option_3", + "is_correct_3", + "column_break_atpl", + "explanation_3", + "section_break_yqel", + "option_4", + "is_correct_4", + "column_break_lknb", + "explanation_4", + "section_break_hkfe", + "possible_answer_1", + "possible_answer_3", + "column_break_wpjr", + "possible_answer_2", + "possible_answer_4" + ], + "fields": [ + { + "fieldname": "question", + "fieldtype": "Text Editor", + "in_list_view": 1, + "label": "Question" + }, + { + "fieldname": "type", + "fieldtype": "Select", + "in_list_view": 1, + "label": "Type", + "options": "Choices\nUser Input" + }, + { + "depends_on": "eval:doc.type == \"Choices\";", + "fieldname": "section_break_ytxi", + "fieldtype": "Section Break" + }, + { + "fieldname": "option_1", + "fieldtype": "Small Text", + "label": "Option 1", + "mandatory_depends_on": "eval: doc.type == 'Choices'" + }, + { + "default": "0", + "fieldname": "is_correct_1", + "fieldtype": "Check", + "label": "Is Correct" + }, + { + "fieldname": "column_break_fpvl", + "fieldtype": "Column Break" + }, + { + "fieldname": "explanation_1", + "fieldtype": "Small Text", + "label": "Explanation" + }, + { + "depends_on": "eval:doc.type == \"Choices\";", + "fieldname": "section_break_eiaa", + "fieldtype": "Section Break" + }, + { + "fieldname": "option_2", + "fieldtype": "Small Text", + "label": "Option 2", + "mandatory_depends_on": "eval: doc.type == 'Choices'" + }, + { + "default": "0", + "fieldname": "is_correct_2", + "fieldtype": "Check", + "label": "Is Correct" + }, + { + "fieldname": "column_break_akwy", + "fieldtype": "Column Break" + }, + { + "fieldname": "explanation_2", + "fieldtype": "Small Text", + "label": "Explanation " + }, + { + "depends_on": "eval: doc.type == 'Choices'", + "fieldname": "section_break_cwqv", + "fieldtype": "Section Break" + }, + { + "fieldname": "option_3", + "fieldtype": "Small Text", + "label": "Option 3" + }, + { + "default": "0", + "fieldname": "is_correct_3", + "fieldtype": "Check", + "label": "Is Correct" + }, + { + "fieldname": "column_break_atpl", + "fieldtype": "Column Break" + }, + { + "fieldname": "explanation_3", + "fieldtype": "Small Text", + "label": "Explanation" + }, + { + "depends_on": "eval: doc.type == 'Choices'", + "fieldname": "section_break_yqel", + "fieldtype": "Section Break" + }, + { + "fieldname": "option_4", + "fieldtype": "Small Text", + "label": "Option 4" + }, + { + "default": "0", + "fieldname": "is_correct_4", + "fieldtype": "Check", + "label": "Is Correct" + }, + { + "fieldname": "column_break_lknb", + "fieldtype": "Column Break" + }, + { + "fieldname": "explanation_4", + "fieldtype": "Small Text", + "label": "Explanation" + }, + { + "default": "0", + "fieldname": "multiple", + "fieldtype": "Check", + "hidden": 1, + "label": "Multiple Correct Answers" + }, + { + "depends_on": "eval: doc.type == 'User Input'", + "fieldname": "section_break_hkfe", + "fieldtype": "Section Break" + }, + { + "fieldname": "possible_answer_1", + "fieldtype": "Small Text", + "label": "Possible Answer 1", + "mandatory_depends_on": "eval: doc.type == 'User Input'" + }, + { + "fieldname": "possible_answer_3", + "fieldtype": "Small Text", + "label": "Possible Answer 3" + }, + { + "fieldname": "column_break_wpjr", + "fieldtype": "Column Break" + }, + { + "fieldname": "possible_answer_2", + "fieldtype": "Small Text", + "label": "Possible Answer 2" + }, + { + "fieldname": "possible_answer_4", + "fieldtype": "Small Text", + "label": "Possible Answer 4" + } + ], + "index_web_pages_for_search": 1, + "links": [], + "modified": "2023-10-10 16:03:38.776125", + "modified_by": "Administrator", + "module": "LMS", + "name": "LMS Question", + "naming_rule": "Expression", + "owner": "Administrator", + "permissions": [ + { + "create": 1, + "delete": 1, + "email": 1, + "export": 1, + "print": 1, + "read": 1, + "report": 1, + "role": "System Manager", + "share": 1, + "write": 1 + } + ], + "sort_field": "modified", + "sort_order": "DESC", + "states": [], + "title_field": "question" +} \ No newline at end of file diff --git a/lms/lms/doctype/lms_question/lms_question.py b/lms/lms/doctype/lms_question/lms_question.py new file mode 100644 index 00000000..f2076284 --- /dev/null +++ b/lms/lms/doctype/lms_question/lms_question.py @@ -0,0 +1,48 @@ +# Copyright (c) 2023, Frappe and contributors +# For license information, please see license.txt + +import frappe +from frappe import _ +from frappe.model.document import Document + + +class LMSQuestion(Document): + def validate(self): + self.validate_correct_answers() + + +def validate_correct_answers(question): + if question.type == "Choices": + validate_duplicate_options(question) + validate_correct_options(question) + + +def validate_duplicate_options(question): + options = [] + + for num in range(1, 5): + if question.get(f"option_{num}"): + options.append(question.get(f"option_{num}")) + + if len(set(options)) != len(options): + frappe.throw(_("Duplicate options found for this question.")) + + +def validate_correct_options(question): + correct_options = get_correct_options(question) + + if len(correct_options) > 1: + question.multiple = 1 + + if not len(correct_options): + frappe.throw(_("At least one option must be correct for this question.")) + + +def get_correct_options(question): + correct_option_fields = [ + "is_correct_1", + "is_correct_2", + "is_correct_3", + "is_correct_4", + ] + return list(filter(lambda x: question.get(x) == 1, correct_option_fields)) diff --git a/lms/lms/doctype/lms_question/test_lms_question.py b/lms/lms/doctype/lms_question/test_lms_question.py new file mode 100644 index 00000000..0832daa9 --- /dev/null +++ b/lms/lms/doctype/lms_question/test_lms_question.py @@ -0,0 +1,9 @@ +# Copyright (c) 2023, Frappe and Contributors +# See license.txt + +# import frappe +from frappe.tests.utils import FrappeTestCase + + +class TestLMSQuestion(FrappeTestCase): + pass diff --git a/lms/lms/doctype/lms_quiz/lms_quiz.py b/lms/lms/doctype/lms_quiz/lms_quiz.py index 9cb5789c..facbffca 100644 --- a/lms/lms/doctype/lms_quiz/lms_quiz.py +++ b/lms/lms/doctype/lms_quiz/lms_quiz.py @@ -7,6 +7,7 @@ from frappe import _ from frappe.model.document import Document from frappe.utils import cstr from lms.lms.utils import generate_slug, has_course_moderator_role, can_create_courses +from lms.lms.doctype.lms_question.lms_question import validate_correct_answers class LMSQuiz(Document): @@ -14,9 +15,6 @@ class LMSQuiz(Document): if not self.name: self.name = generate_slug(self.title, "LMS Quiz") - def validate(self): - validate_correct_answers(self.questions) - def get_last_submission_details(self): """Returns the latest submission for this user.""" user = frappe.session.user @@ -35,78 +33,6 @@ class LMSQuiz(Document): return result[0] -def get_correct_options(question): - correct_option_fields = [ - "is_correct_1", - "is_correct_2", - "is_correct_3", - "is_correct_4", - ] - return list(filter(lambda x: question.get(x) == 1, correct_option_fields)) - - -def validate_correct_answers(questions): - for question in questions: - if question.type == "Choices": - validate_duplicate_options(question) - validate_correct_options(question) - else: - validate_possible_answer(question) - - -def validate_duplicate_options(question): - options = [] - - for num in range(1, 5): - if question.get(f"option_{num}"): - options.append(question.get(f"option_{num}")) - - if len(set(options)) != len(options): - frappe.throw( - _("Duplicate options found for this question: {0}").format( - frappe.bold(question.question) - ) - ) - - -def validate_correct_options(question): - correct_options = get_correct_options(question) - - if len(correct_options) > 1: - question.multiple = 1 - - if not len(correct_options): - frappe.throw( - _("At least one option must be correct for this question: {0}").format( - frappe.bold(question.question) - ) - ) - - -def validate_possible_answer(question): - possible_answers_fields = [ - "possibility_1", - "possibility_2", - "possibility_3", - "possibility_4", - ] - possible_answers = list(filter(lambda x: question.get(x), possible_answers_fields)) - - if not len(possible_answers): - frappe.throw( - _("Add at least one possible answer for this question: {0}").format( - frappe.bold(question.question) - ) - ) - - -def update_lesson_info(doc, method): - if doc.quiz_id: - frappe.db.set_value( - "LMS Quiz", doc.quiz_id, {"lesson": doc.name, "course": doc.course} - ) - - @frappe.whitelist() def quiz_summary(quiz, results): score = 0 @@ -171,7 +97,8 @@ def save_quiz( @frappe.whitelist() def save_question(quiz, values, index): values = frappe._dict(json.loads(values)) - validate_correct_answers([values]) + for value in values: + validate_correct_answers(value) if values.get("name"): doc = frappe.get_doc("LMS Quiz Question", values.get("name")) diff --git a/lms/lms/doctype/lms_quiz_question/lms_quiz_question.json b/lms/lms/doctype/lms_quiz_question/lms_quiz_question.json index 8e815ee3..52cd5664 100644 --- a/lms/lms/doctype/lms_quiz_question/lms_quiz_question.json +++ b/lms/lms/doctype/lms_quiz_question/lms_quiz_question.json @@ -5,209 +5,22 @@ "editable_grid": 1, "engine": "InnoDB", "field_order": [ - "question", - "type", - "options_section", - "option_1", - "is_correct_1", - "column_break_5", - "explanation_1", - "section_break_5", - "option_2", - "is_correct_2", - "column_break_10", - "explanation_2", - "column_break_4", - "option_3", - "is_correct_3", - "column_break_15", - "explanation_3", - "section_break_11", - "option_4", - "is_correct_4", - "column_break_20", - "explanation_4", - "section_break_mnhr", - "possibility_1", - "possibility_3", - "column_break_vnaj", - "possibility_2", - "possibility_4", - "section_break_c1lf", - "multiple" + "question" ], "fields": [ { "fieldname": "question", - "fieldtype": "Text Editor", + "fieldtype": "Link", "in_list_view": 1, "label": "Question", + "options": "LMS Question", "reqd": 1 - }, - { - "fieldname": "option_1", - "fieldtype": "Small Text", - "label": "Option 1", - "mandatory_depends_on": "eval: doc.type == 'Choices'" - }, - { - "fieldname": "option_2", - "fieldtype": "Small Text", - "label": "Option 2", - "mandatory_depends_on": "eval: doc.type == 'Choices'" - }, - { - "fieldname": "option_3", - "fieldtype": "Small Text", - "label": "Option 3" - }, - { - "fieldname": "option_4", - "fieldtype": "Small Text", - "label": "Option 4" - }, - { - "default": "0", - "depends_on": "option_1", - "fieldname": "is_correct_1", - "fieldtype": "Check", - "label": "Is Correct" - }, - { - "default": "0", - "depends_on": "option_2", - "fieldname": "is_correct_2", - "fieldtype": "Check", - "label": "Is Correct" - }, - { - "default": "0", - "depends_on": "option_3", - "fieldname": "is_correct_3", - "fieldtype": "Check", - "label": "Is Correct" - }, - { - "default": "0", - "depends_on": "option_4", - "fieldname": "is_correct_4", - "fieldtype": "Check", - "label": "Is Correct" - }, - { - "default": "0", - "fieldname": "multiple", - "fieldtype": "Check", - "hidden": 1, - "label": "Multiple Correct Answers", - "read_only": 1 - }, - { - "depends_on": "eval: doc.type == 'Choices'", - "fieldname": "options_section", - "fieldtype": "Section Break" - }, - { - "depends_on": "eval: doc.type == 'Choices'", - "fieldname": "column_break_4", - "fieldtype": "Section Break" - }, - { - "depends_on": "eval: doc.type == 'Choices'", - "fieldname": "section_break_5", - "fieldtype": "Section Break" - }, - { - "depends_on": "eval: doc.type == 'Choices'", - "fieldname": "section_break_11", - "fieldtype": "Section Break" - }, - { - "depends_on": "option_1", - "fieldname": "explanation_1", - "fieldtype": "Data", - "label": "Explanation" - }, - { - "depends_on": "option_2", - "fieldname": "explanation_2", - "fieldtype": "Data", - "label": "Explanation" - }, - { - "depends_on": "option_3", - "fieldname": "explanation_3", - "fieldtype": "Data", - "label": "Explanation" - }, - { - "depends_on": "option_4", - "fieldname": "explanation_4", - "fieldtype": "Data", - "label": "Explanation" - }, - { - "fieldname": "column_break_5", - "fieldtype": "Column Break" - }, - { - "fieldname": "column_break_10", - "fieldtype": "Column Break" - }, - { - "fieldname": "column_break_15", - "fieldtype": "Column Break" - }, - { - "fieldname": "column_break_20", - "fieldtype": "Column Break" - }, - { - "fieldname": "type", - "fieldtype": "Select", - "in_list_view": 1, - "label": "Type", - "options": "Choices\nUser Input" - }, - { - "depends_on": "eval: doc.type == 'User Input'", - "fieldname": "section_break_mnhr", - "fieldtype": "Section Break" - }, - { - "fieldname": "possibility_1", - "fieldtype": "Small Text", - "label": "Possible Answer 1", - "mandatory_depends_on": "eval: doc.type == 'User Input'" - }, - { - "fieldname": "possibility_2", - "fieldtype": "Small Text", - "label": "Possible Answer 2" - }, - { - "fieldname": "possibility_3", - "fieldtype": "Small Text", - "label": "Possible Answer 3" - }, - { - "fieldname": "possibility_4", - "fieldtype": "Small Text", - "label": "Possible Answer 4" - }, - { - "fieldname": "section_break_c1lf", - "fieldtype": "Section Break" - }, - { - "fieldname": "column_break_vnaj", - "fieldtype": "Column Break" } ], "index_web_pages_for_search": 1, "istable": 1, "links": [], - "modified": "2023-07-04 16:43:49.837134", + "modified": "2023-10-10 15:42:51.791902", "modified_by": "Administrator", "module": "LMS", "name": "LMS Quiz Question", diff --git a/lms/patches.txt b/lms/patches.txt index 86e4a840..60acee23 100644 --- a/lms/patches.txt +++ b/lms/patches.txt @@ -71,4 +71,6 @@ lms.patches.v1_0.publish_batches lms.patches.v1_0.publish_certificates lms.patches.v1_0.change_naming_for_batch_course #14-09-2023 execute:frappe.permissions.reset_perms("LMS Enrollment") -lms.patches.v1_0.create_student_role \ No newline at end of file +lms.patches.v1_0.create_student_role +lms.patches.v1_0.mark_confirmation_for_batch_students +lms.patches.v1_0.create_quiz_questions \ No newline at end of file diff --git a/lms/patches/v1_0/create_quiz_questions.py b/lms/patches/v1_0/create_quiz_questions.py new file mode 100644 index 00000000..c53a7c00 --- /dev/null +++ b/lms/patches/v1_0/create_quiz_questions.py @@ -0,0 +1,52 @@ +import frappe + + +def execute(): + frappe.reload_doc("lms", "doctype", "lms_question") + frappe.reload_doc("lms", "doctype", "lms_quiz_question") + + questions = frappe.get_all( + "LMS Quiz Question", + fields=[ + "name", + "question", + "type", + "multiple", + "option_1", + "is_correct_1", + "explanation_1", + "option_2", + "is_correct_2", + "explanation_2", + "option_3", + "is_correct_3", + "explanation_3", + "option_4", + "is_correct_4", + "explanation_4", + ], + ) + + for question in questions: + doc = frappe.new_doc("LMS Question") + doc.update( + { + "question": question.question, + "type": question.type, + "multiple": question.multiple, + } + ) + + for num in range(1, 5): + if question.get(f"option_{num}"): + doc.update( + { + f"option_{num}": question[f"option_{num}"], + f"is_correct_{num}": question[f"is_correct_{num}"], + f"explanation_{num}": question[f"explanation_{num}"], + } + ) + + doc.save() + + frappe.db.set_value("LMS Quiz Question", question.name, "question", doc.name) diff --git a/lms/patches/v1_0/mark_confirmation_for_batch_students.py b/lms/patches/v1_0/mark_confirmation_for_batch_students.py new file mode 100644 index 00000000..f73e0a90 --- /dev/null +++ b/lms/patches/v1_0/mark_confirmation_for_batch_students.py @@ -0,0 +1,9 @@ +import frappe + + +def execute(): + frappe.reload_doc("lms", "doctype", "batch_student") + students = frappe.get_all("Batch Student", pluck="name") + + for student in students: + frappe.db.set_value("Batch Student", student, "confirmation_email_sent", 1) diff --git a/lms/www/batches/batch.js b/lms/www/batches/batch.js index 1f4cd60d..e67e74c6 100644 --- a/lms/www/batches/batch.js +++ b/lms/www/batches/batch.js @@ -653,7 +653,7 @@ const setup_calendar = (events) => { const options = get_calendar_options(element, calendar_id); const calendar = new Calendar(container, options); this.calendar_ = calendar; - console.log(options); + create_events(calendar, events); add_links_to_events(calendar, events); scroll_to_date(calendar, events); From a0255e174370b27590277e180571c89029aefe70 Mon Sep 17 00:00:00 2001 From: Jannat Patel Date: Wed, 11 Oct 2023 12:58:07 +0530 Subject: [PATCH 02/33] feat: send email to batch students --- .../doctype/lms_assignment/lms_assignment.py | 4 ++-- lms/lms/doctype/lms_course/lms_course.py | 2 +- lms/lms/doctype/lms_quiz/lms_quiz.py | 8 +++++-- lms/lms/utils.py | 22 +++++++++++++++---- lms/www/assignments/assignment.py | 4 ++-- lms/www/batch/quiz.py | 4 ++-- lms/www/batch/quiz_list.py | 4 ++-- lms/www/courses/course.py | 2 +- lms/www/courses/create.py | 2 +- lms/www/courses/index.py | 7 ++++-- 10 files changed, 40 insertions(+), 19 deletions(-) diff --git a/lms/lms/doctype/lms_assignment/lms_assignment.py b/lms/lms/doctype/lms_assignment/lms_assignment.py index 647833de..b4aaedbf 100644 --- a/lms/lms/doctype/lms_assignment/lms_assignment.py +++ b/lms/lms/doctype/lms_assignment/lms_assignment.py @@ -3,7 +3,7 @@ import frappe from frappe.model.document import Document -from lms.lms.utils import can_create_courses +from lms.lms.utils import has_course_moderator_role, has_course_instructor_role class LMSAssignment(Document): @@ -12,7 +12,7 @@ class LMSAssignment(Document): @frappe.whitelist() def save_assignment(assignment, title, type, question): - if not can_create_courses(): + if not has_course_moderator_role() or not has_course_instructor_role(): return if assignment: diff --git a/lms/lms/doctype/lms_course/lms_course.py b/lms/lms/doctype/lms_course/lms_course.py index 74ccc51a..9065b639 100644 --- a/lms/lms/doctype/lms_course/lms_course.py +++ b/lms/lms/doctype/lms_course/lms_course.py @@ -216,7 +216,7 @@ def save_course( course_price=None, currency=None, ): - if not can_create_courses(): + if not can_create_courses(course): return if course: diff --git a/lms/lms/doctype/lms_quiz/lms_quiz.py b/lms/lms/doctype/lms_quiz/lms_quiz.py index 9cb5789c..e6794843 100644 --- a/lms/lms/doctype/lms_quiz/lms_quiz.py +++ b/lms/lms/doctype/lms_quiz/lms_quiz.py @@ -6,7 +6,11 @@ import frappe from frappe import _ from frappe.model.document import Document from frappe.utils import cstr -from lms.lms.utils import generate_slug, has_course_moderator_role, can_create_courses +from lms.lms.utils import ( + generate_slug, + has_course_moderator_role, + has_course_instructor_role, +) class LMSQuiz(Document): @@ -148,7 +152,7 @@ def quiz_summary(quiz, results): def save_quiz( quiz_title, max_attempts=1, quiz=None, show_answers=1, show_submission_history=0 ): - if not can_create_courses(): + if not has_course_moderator_role() or not has_course_instructor_role(): return values = { diff --git a/lms/lms/utils.py b/lms/lms/utils.py index b3d4e1b9..f7dbe489 100644 --- a/lms/lms/utils.py +++ b/lms/lms/utils.py @@ -521,21 +521,35 @@ def has_course_instructor_role(member=None): ) -def can_create_courses(member=None): +def can_create_courses(course, member=None): if not member: member = frappe.session.user + instructors = frappe.get_all( + "Course Instructor", + { + "parent": course, + }, + pluck="instructor", + ) + if frappe.session.user == "Guest": return False - if has_course_instructor_role(member) or has_course_moderator_role(member): + if has_course_moderator_role(member): + return True + + if has_course_instructor_role(member) and member in instructors: return True portal_course_creation = frappe.db.get_single_value( "LMS Settings", "portal_course_creation" ) - return portal_course_creation == "Anyone" + if portal_course_creation == "Anyone" and member in instructors: + return True + + return False def has_course_moderator_role(member=None): @@ -727,7 +741,7 @@ def get_chart_data(chart_name, timespan, timegrain, from_date, to_date): } -@frappe.whitelist() +@frappe.whitelist(allow_guest=True) def get_course_completion_data(): all_membership = frappe.db.count("LMS Enrollment") completed = frappe.db.count("LMS Enrollment", {"progress": ["like", "%100%"]}) diff --git a/lms/www/assignments/assignment.py b/lms/www/assignments/assignment.py index 9b1c299d..ec8cc543 100644 --- a/lms/www/assignments/assignment.py +++ b/lms/www/assignments/assignment.py @@ -1,12 +1,12 @@ import frappe from frappe import _ -from lms.lms.utils import can_create_courses +from lms.lms.utils import has_course_moderator_role, has_course_instructor_role def get_context(context): context.no_cache = 1 - if not can_create_courses(): + if not has_course_moderator_role() or not has_course_instructor_role(): message = "You do not have permission to access this page." if frappe.session.user == "Guest": message = "Please login to access this page." diff --git a/lms/www/batch/quiz.py b/lms/www/batch/quiz.py index f88aaef5..52d0634f 100644 --- a/lms/www/batch/quiz.py +++ b/lms/www/batch/quiz.py @@ -1,13 +1,13 @@ import frappe from frappe.utils import cstr from frappe import _ -from lms.lms.utils import can_create_courses +from lms.lms.utils import has_course_instructor_role, has_course_moderator_role def get_context(context): context.no_cache = 1 - if not can_create_courses(): + if not has_course_moderator_role() or not has_course_instructor_role(): message = "You do not have permission to access this page." if frappe.session.user == "Guest": message = "Please login to access this page." diff --git a/lms/www/batch/quiz_list.py b/lms/www/batch/quiz_list.py index ae8df7fc..ee4321a7 100644 --- a/lms/www/batch/quiz_list.py +++ b/lms/www/batch/quiz_list.py @@ -1,12 +1,12 @@ import frappe -from lms.lms.utils import can_create_courses, has_course_moderator_role +from lms.lms.utils import has_course_instructor_role, has_course_moderator_role from frappe import _ def get_context(context): context.no_cache = 1 - if not can_create_courses(): + if not has_course_moderator_role() or not has_course_instructor_role(): message = "You do not have permission to access this page." if frappe.session.user == "Guest": message = "Please login to access this page." diff --git a/lms/www/courses/course.py b/lms/www/courses/course.py index b4aa476c..b64395eb 100644 --- a/lms/www/courses/course.py +++ b/lms/www/courses/course.py @@ -23,7 +23,7 @@ def get_context(context): redirect_to_courses_list() if course_name == "new-course": - if not can_create_courses(): + if not can_create_courses(course_name): message = "You do not have permission to access this page." if frappe.session.user == "Guest": message = "Please login to access this page." diff --git a/lms/www/courses/create.py b/lms/www/courses/create.py index 901ce1f2..7b83f3f5 100644 --- a/lms/www/courses/create.py +++ b/lms/www/courses/create.py @@ -15,7 +15,7 @@ def get_context(context): except KeyError: redirect_to_courses_list() - if not can_create_courses(): + if not can_create_courses(course_name): message = "You do not have permission to access this page." if frappe.session.user == "Guest": message = "Please login to access this page." diff --git a/lms/www/courses/index.py b/lms/www/courses/index.py index d887e1ca..62474be0 100644 --- a/lms/www/courses/index.py +++ b/lms/www/courses/index.py @@ -1,7 +1,6 @@ import frappe from frappe import _ from lms.lms.utils import ( - can_create_courses, check_profile_restriction, get_restriction_details, has_course_moderator_role, @@ -21,7 +20,11 @@ def get_context(context): context.created_courses = get_authored_courses(None, False) context.review_courses = get_courses_under_review() context.restriction = check_profile_restriction() - context.show_creators_section = can_create_courses() + + portal_course_creation = frappe.db.get_single_value( + "LMS Settings", "portal_course_creation" + ) + context.show_creators_section = True if portal_course_creation == "Anyone" else False context.show_review_section = ( has_course_moderator_role() and frappe.session.user != "Guest" ) From f3d6ad6c849fa20f1c9a1d9f34274b7a5e3495c5 Mon Sep 17 00:00:00 2001 From: Jannat Patel Date: Wed, 11 Oct 2023 13:40:07 +0530 Subject: [PATCH 03/33] fix: course permissions --- lms/www/courses/index.py | 9 ++++++++- lms/www/courses/outline.py | 2 +- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/lms/www/courses/index.py b/lms/www/courses/index.py index 62474be0..7df2a960 100644 --- a/lms/www/courses/index.py +++ b/lms/www/courses/index.py @@ -7,6 +7,7 @@ from lms.lms.utils import ( get_courses_under_review, get_average_rating, check_multicurrency, + has_course_instructor_role, ) from lms.overrides.user import get_enrolled_courses, get_authored_courses @@ -24,7 +25,13 @@ def get_context(context): portal_course_creation = frappe.db.get_single_value( "LMS Settings", "portal_course_creation" ) - context.show_creators_section = True if portal_course_creation == "Anyone" else False + context.show_creators_section = ( + True + if portal_course_creation == "Anyone" + or has_course_moderator_role() + or has_course_instructor_role() + else False + ) context.show_review_section = ( has_course_moderator_role() and frappe.session.user != "Guest" ) diff --git a/lms/www/courses/outline.py b/lms/www/courses/outline.py index ad8f18d9..f01a71af 100644 --- a/lms/www/courses/outline.py +++ b/lms/www/courses/outline.py @@ -10,7 +10,7 @@ def get_context(context): if not frappe.db.exists("LMS Course", course_name): redirect_to_courses_list() - if not can_create_courses(): + if not can_create_courses(course_name): message = "You do not have permission to access this page." if frappe.session.user == "Guest": message = "Please login to access this page." From a7dbdd844b2a9d2e13752edb1c90f211b95bd8c3 Mon Sep 17 00:00:00 2001 From: Jannat Patel Date: Thu, 12 Oct 2023 21:20:36 +0530 Subject: [PATCH 04/33] feat: batch customisations --- .github/workflows/ci.yml | 2 +- lms/lms/doctype/lms_batch/lms_batch.js | 110 ++++++++++++------ lms/lms/doctype/lms_batch/lms_batch.json | 18 ++- .../doctype/lms_timetable_legend/__init__.py | 0 .../lms_timetable_legend.js | 8 ++ .../lms_timetable_legend.json | 52 +++++++++ .../lms_timetable_legend.py | 9 ++ .../test_lms_timetable_legend.py | 9 ++ .../lms_timetable_template.js | 14 +++ .../lms_timetable_template.json | 11 +- lms/www/batches/batch.html | 4 +- lms/www/batches/batch.js | 30 +++-- lms/www/batches/batch.py | 28 ++--- 13 files changed, 226 insertions(+), 69 deletions(-) create mode 100644 lms/lms/doctype/lms_timetable_legend/__init__.py create mode 100644 lms/lms/doctype/lms_timetable_legend/lms_timetable_legend.js create mode 100644 lms/lms/doctype/lms_timetable_legend/lms_timetable_legend.json create mode 100644 lms/lms/doctype/lms_timetable_legend/lms_timetable_legend.py create mode 100644 lms/lms/doctype/lms_timetable_legend/test_lms_timetable_legend.py diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index aafbfa01..1c0c28c7 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -21,7 +21,7 @@ jobs: ports: - 12000:6379 mariadb: - image: anandology/mariadb-utf8mb4:10.3 + image: mariadb:10.6 ports: - 3306:3306 env: diff --git a/lms/lms/doctype/lms_batch/lms_batch.js b/lms/lms/doctype/lms_batch/lms_batch.js index f7273fc1..1a95c493 100644 --- a/lms/lms/doctype/lms_batch/lms_batch.js +++ b/lms/lms/doctype/lms_batch/lms_batch.js @@ -12,12 +12,16 @@ frappe.ui.form.on("LMS Batch", { }); frm.set_query("reference_doctype", "timetable", function () { - let doctypes = [ - "Course Lesson", - "LMS Quiz", - "LMS Assignment", - "LMS Live Class", - ]; + let doctypes = ["Course Lesson", "LMS Quiz", "LMS Assignment"]; + return { + filters: { + name: ["in", doctypes], + }, + }; + }); + + frm.set_query("reference_doctype", "timetable_legends", function () { + let doctypes = ["Course Lesson", "LMS Quiz", "LMS Assignment"]; return { filters: { name: ["in", doctypes], @@ -27,36 +31,41 @@ frappe.ui.form.on("LMS Batch", { }, timetable_template: function (frm) { - if (frm.doc.timetable_template) { - frm.clear_table("timetable"); - frm.refresh_fields(); - - frappe.call({ - method: "frappe.client.get_list", - args: { - doctype: "LMS Batch Timetable", - parent: "LMS Timetable Template", - fields: [ - "reference_doctype", - "reference_docname", - "day", - "start_time", - "end_time", - "duration", - ], - filters: { - parent: frm.doc.timetable_template, - }, - order_by: "idx", - }, - callback: (data) => { - add_timetable_rows(frm, data.message); - }, - }); - } + set_timetable(frm); }, }); +const set_timetable = (frm) => { + if (frm.doc.timetable_template) { + frm.clear_table("timetable"); + frm.refresh_fields(); + + frappe.call({ + method: "frappe.client.get_list", + args: { + doctype: "LMS Batch Timetable", + parent: "LMS Timetable Template", + fields: [ + "reference_doctype", + "reference_docname", + "day", + "start_time", + "end_time", + "duration", + ], + filters: { + parent: frm.doc.timetable_template, + parenttype: "LMS Timetable Template", + }, + order_by: "idx", + }, + callback: (data) => { + add_timetable_rows(frm, data.message); + }, + }); + } +}; + const add_timetable_rows = (frm, timetable) => { timetable.forEach((row) => { let child = frm.add_child("timetable"); @@ -75,5 +84,40 @@ const add_timetable_rows = (frm, timetable) => { child.duration = row.duration; }); frm.refresh_field("timetable"); + + set_legends(frm); +}; + +const set_legends = (frm) => { + if (frm.doc.timetable_template) { + frm.clear_table("timetable_legends"); + frm.refresh_fields(); + frappe.call({ + method: "frappe.client.get_list", + args: { + doctype: "LMS Timetable Legend", + parent: "LMS Timetable Template", + fields: ["reference_doctype", "label", "color"], + filters: { + parent: frm.doc.timetable_template, + parenttype: "LMS Timetable Template", + }, + order_by: "idx", + }, + callback: (data) => { + add_legend_rows(frm, data.message); + }, + }); + } +}; + +const add_legend_rows = (frm, legends) => { + legends.forEach((row) => { + let child = frm.add_child("timetable_legends"); + child.reference_doctype = row.reference_doctype; + child.label = row.label; + child.color = row.color; + }); + frm.refresh_field("timetable_legends"); frm.save(); }; diff --git a/lms/lms/doctype/lms_batch/lms_batch.json b/lms/lms/doctype/lms_batch/lms_batch.json index 4cdb1e0a..f0838a4b 100644 --- a/lms/lms/doctype/lms_batch/lms_batch.json +++ b/lms/lms/doctype/lms_batch/lms_batch.json @@ -35,8 +35,10 @@ "timetable_template", "column_break_anya", "show_live_class", + "allow_future", "section_break_ontp", "timetable", + "timetable_legends", "pricing_tab", "section_break_gsac", "paid_batch", @@ -220,7 +222,7 @@ "default": "0", "fieldname": "show_live_class", "fieldtype": "Check", - "label": "Show Live Class" + "label": "Show live class" }, { "fieldname": "section_break_ontp", @@ -263,11 +265,23 @@ "fieldtype": "Code", "label": "Custom Script (JavaScript)", "options": "Javascript" + }, + { + "fieldname": "timetable_legends", + "fieldtype": "Table", + "label": "Timetable Legends", + "options": "LMS Timetable Legend" + }, + { + "default": "1", + "fieldname": "allow_future", + "fieldtype": "Check", + "label": "Allow accessing future dates" } ], "index_web_pages_for_search": 1, "links": [], - "modified": "2023-09-28 12:18:34.418812", + "modified": "2023-10-12 12:53:37.351989", "modified_by": "Administrator", "module": "LMS", "name": "LMS Batch", diff --git a/lms/lms/doctype/lms_timetable_legend/__init__.py b/lms/lms/doctype/lms_timetable_legend/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/lms/lms/doctype/lms_timetable_legend/lms_timetable_legend.js b/lms/lms/doctype/lms_timetable_legend/lms_timetable_legend.js new file mode 100644 index 00000000..7a8a3684 --- /dev/null +++ b/lms/lms/doctype/lms_timetable_legend/lms_timetable_legend.js @@ -0,0 +1,8 @@ +// Copyright (c) 2023, Frappe and contributors +// For license information, please see license.txt + +// frappe.ui.form.on("LMS Timetable Legend", { +// refresh(frm) { + +// }, +// }); diff --git a/lms/lms/doctype/lms_timetable_legend/lms_timetable_legend.json b/lms/lms/doctype/lms_timetable_legend/lms_timetable_legend.json new file mode 100644 index 00000000..6ae0ffe4 --- /dev/null +++ b/lms/lms/doctype/lms_timetable_legend/lms_timetable_legend.json @@ -0,0 +1,52 @@ +{ + "actions": [], + "allow_rename": 1, + "autoname": "hash", + "creation": "2023-10-11 16:36:45.079267", + "default_view": "List", + "doctype": "DocType", + "editable_grid": 1, + "engine": "InnoDB", + "field_order": [ + "reference_doctype", + "label", + "color" + ], + "fields": [ + { + "fieldname": "reference_doctype", + "fieldtype": "Link", + "in_list_view": 1, + "label": "Reference DocType", + "options": "DocType", + "reqd": 1 + }, + { + "fieldname": "color", + "fieldtype": "Color", + "in_list_view": 1, + "label": "Color", + "reqd": 1 + }, + { + "fieldname": "label", + "fieldtype": "Data", + "in_list_view": 1, + "label": "Label", + "reqd": 1 + } + ], + "index_web_pages_for_search": 1, + "istable": 1, + "links": [], + "modified": "2023-10-11 17:15:37.039139", + "modified_by": "Administrator", + "module": "LMS", + "name": "LMS Timetable Legend", + "naming_rule": "Random", + "owner": "Administrator", + "permissions": [], + "sort_field": "modified", + "sort_order": "DESC", + "states": [] +} \ No newline at end of file diff --git a/lms/lms/doctype/lms_timetable_legend/lms_timetable_legend.py b/lms/lms/doctype/lms_timetable_legend/lms_timetable_legend.py new file mode 100644 index 00000000..c842e3a2 --- /dev/null +++ b/lms/lms/doctype/lms_timetable_legend/lms_timetable_legend.py @@ -0,0 +1,9 @@ +# Copyright (c) 2023, Frappe and contributors +# For license information, please see license.txt + +# import frappe +from frappe.model.document import Document + + +class LMSTimetableLegend(Document): + pass diff --git a/lms/lms/doctype/lms_timetable_legend/test_lms_timetable_legend.py b/lms/lms/doctype/lms_timetable_legend/test_lms_timetable_legend.py new file mode 100644 index 00000000..816b1793 --- /dev/null +++ b/lms/lms/doctype/lms_timetable_legend/test_lms_timetable_legend.py @@ -0,0 +1,9 @@ +# Copyright (c) 2023, Frappe and Contributors +# See license.txt + +# import frappe +from frappe.tests.utils import FrappeTestCase + + +class TestLMSTimetableLegend(FrappeTestCase): + pass diff --git a/lms/lms/doctype/lms_timetable_template/lms_timetable_template.js b/lms/lms/doctype/lms_timetable_template/lms_timetable_template.js index a9bff04e..b5ec2d9b 100644 --- a/lms/lms/doctype/lms_timetable_template/lms_timetable_template.js +++ b/lms/lms/doctype/lms_timetable_template/lms_timetable_template.js @@ -11,5 +11,19 @@ frappe.ui.form.on("LMS Timetable Template", { }, }; }); + + frm.set_query("reference_doctype", "timetable_legends", function () { + let doctypes = [ + "Course Lesson", + "LMS Quiz", + "LMS Assignment", + "LMS Live Class", + ]; + return { + filters: { + name: ["in", doctypes], + }, + }; + }); }, }); diff --git a/lms/lms/doctype/lms_timetable_template/lms_timetable_template.json b/lms/lms/doctype/lms_timetable_template/lms_timetable_template.json index 99c88628..3b016b7a 100644 --- a/lms/lms/doctype/lms_timetable_template/lms_timetable_template.json +++ b/lms/lms/doctype/lms_timetable_template/lms_timetable_template.json @@ -8,7 +8,8 @@ "engine": "InnoDB", "field_order": [ "title", - "timetable" + "timetable", + "timetable_legends" ], "fields": [ { @@ -21,11 +22,17 @@ "fieldtype": "Table", "label": "Timetable", "options": "LMS Batch Timetable" + }, + { + "fieldname": "timetable_legends", + "fieldtype": "Table", + "label": "Timetable Legends", + "options": "LMS Timetable Legend" } ], "index_web_pages_for_search": 1, "links": [], - "modified": "2023-09-18 17:57:15.819072", + "modified": "2023-10-11 17:09:05.096243", "modified_by": "Administrator", "module": "LMS", "name": "LMS Timetable Template", diff --git a/lms/www/batches/batch.html b/lms/www/batches/batch.html index 2f78e0c6..86cb1202 100644 --- a/lms/www/batches/batch.html +++ b/lms/www/batches/batch.html @@ -552,7 +552,7 @@ {% for legend in legends %}
-
{{ legend.title }}
+
{{ legend.label }}
{% endfor %} @@ -574,6 +574,8 @@ diff --git a/lms/www/batches/batch.js b/lms/www/batches/batch.js index 1f4cd60d..6fb088a8 100644 --- a/lms/www/batches/batch.js +++ b/lms/www/batches/batch.js @@ -653,7 +653,6 @@ const setup_calendar = (events) => { const options = get_calendar_options(element, calendar_id); const calendar = new Calendar(container, options); this.calendar_ = calendar; - console.log(options); create_events(calendar, events); add_links_to_events(calendar, events); scroll_to_date(calendar, events); @@ -698,8 +697,8 @@ const get_calendar_options = (element, calendar_id) => { const create_events = (calendar, events, calendar_id) => { let calendar_events = []; - events.forEach((event, idx) => { + let clr = get_background_color(event.reference_doctype); calendar_events.push({ id: `event${idx}`, calendarId: calendar_id, @@ -707,7 +706,7 @@ const create_events = (calendar, events, calendar_id) => { start: `${event.date}T${event.start_time}`, end: `${event.date}T${event.end_time}`, isAllday: event.start_time ? false : true, - borderColor: get_background_color(event.reference_doctype), + borderColor: clr, backgroundColor: "var(--fg-color)", customStyle: { borderRadius: "var(--border-radius-md)", @@ -724,10 +723,21 @@ const create_events = (calendar, events, calendar_id) => { calendar.createEvents(calendar_events); }; -const add_links_to_events = (calendar, events) => { +const add_links_to_events = (calendar) => { calendar.on("clickEvent", ({ event }) => { - const el = document.getElementById("clicked-event"); - window.open(event.raw.url, "_blank"); + let event_date = event.start.d.d; + event_date = moment(event_date).format("YYYY-MM-DD"); + + let current_date = moment().format("YYYY-MM-DD"); + console.log(current_date, event_date); + console.log( + allow_future, + moment(event_date).isSameOrBefore(current_date) + ); + if (allow_future || moment(event_date).isSameOrBefore(current_date)) { + console.log("in here"); + window.open(event.raw.url, "_blank"); + } }); }; @@ -764,10 +774,10 @@ const set_calendar_range = (calendar, events) => { }; const get_background_color = (doctype) => { - if (doctype == "Course Lesson") return "var(--blue-400)"; - if (doctype == "LMS Quiz") return "var(--green-400)"; - if (doctype == "LMS Assignment") return "var(--orange-400)"; - if (doctype == "LMS Live Class") return "var(--purple-400)"; + const match = legends.filter((legend) => { + return legend.reference_doctype == doctype; + }); + if (match.length) return match[0].color; }; const email_to_students = () => { diff --git a/lms/www/batches/batch.py b/lms/www/batches/batch.py index 5e408c84..bb3ad307 100644 --- a/lms/www/batches/batch.py +++ b/lms/www/batches/batch.py @@ -42,6 +42,7 @@ def get_context(context): "currency", "batch_details", "published", + "allow_future", ], as_dict=True, ) @@ -96,7 +97,7 @@ def get_context(context): "parent": batch_name, }, ) - context.legends = get_legends() + context.legends = get_legends(batch_name) custom_tabs = frappe.get_hooks("lms_batch_tabs") @@ -261,22 +262,9 @@ def get_course_progress(batch_courses, student_details): student_details.courses[course.course] = 0 -def get_legends(): - return [ - { - "title": "Lesson", - "color": "var(--blue-400)", - }, - { - "title": "Quiz", - "color": "var(--green-400)", - }, - { - "title": "Assignment", - "color": "var(--orange-400)", - }, - { - "title": "Live Class", - "color": "var(--purple-400)", - }, - ] +def get_legends(batch): + return frappe.get_all( + "LMS Timetable Legend", + filters={"parenttype": "LMS Batch", "parent": batch}, + fields=["reference_doctype", "color", "label"], + ) From 55feb419985258da8a253bcb0e4085bec9fe0467 Mon Sep 17 00:00:00 2001 From: Jannat Patel Date: Fri, 13 Oct 2023 10:59:44 +0530 Subject: [PATCH 05/33] feat: timetable customisations --- lms/www/batches/batch.js | 6 ------ 1 file changed, 6 deletions(-) diff --git a/lms/www/batches/batch.js b/lms/www/batches/batch.js index 6fb088a8..9614a924 100644 --- a/lms/www/batches/batch.js +++ b/lms/www/batches/batch.js @@ -729,13 +729,7 @@ const add_links_to_events = (calendar) => { event_date = moment(event_date).format("YYYY-MM-DD"); let current_date = moment().format("YYYY-MM-DD"); - console.log(current_date, event_date); - console.log( - allow_future, - moment(event_date).isSameOrBefore(current_date) - ); if (allow_future || moment(event_date).isSameOrBefore(current_date)) { - console.log("in here"); window.open(event.raw.url, "_blank"); } }); From 1e458921e8af81e2ca114e70f11fbccca6cb5878 Mon Sep 17 00:00:00 2001 From: Jannat Patel Date: Fri, 13 Oct 2023 11:17:41 +0530 Subject: [PATCH 06/33] ci: fix server tests script --- .github/workflows/ci.yml | 39 ++++++++++++++++++++++++++------------- 1 file changed, 26 insertions(+), 13 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 1c0c28c7..a4ad07e9 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -28,26 +28,32 @@ jobs: MYSQL_ROOT_PASSWORD: root options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3 steps: + - name: Clone - uses: actions/checkout@v2 - - name: setup python + + - name: Setup Python uses: actions/setup-python@v2 with: python-version: '3.10' - - name: setup node + + - name: Setup Node uses: actions/setup-node@v2 with: node-version: '18' check-latest: true - - name: setup cache for bench + + - name: Setup ache for bench uses: actions/cache@v2 with: path: ~/bench-cache key: ${{ runner.os }} - - name: install bench + + - name: Install Bench run: | pip3 install frappe-bench which bench - - name: bench init + + - name: Bench Init run: | if [ -d ~/bench-cache/bench.tgz ] then @@ -57,25 +63,32 @@ jobs: mkdir -p ~/bench-cache (cd && tar czf ~/bench-cache/bench.tgz frappe-bench) fi - - name: add lms app to bench + + - name: Add LMS app to bench working-directory: /home/runner/frappe-bench run: bench get-app lms $GITHUB_WORKSPACE - - name: create bench site + + - name: Create bench site working-directory: /home/runner/frappe-bench - run: bench new-site --mariadb-root-password root --admin-password admin frappe.local - - name: install lms app + run: bench new-site --mariadb-root-password root --character-set-server utf8mb4 --collation-server utf8mb4_unicode_ci --admin-password admin frappe.local + + - name: Install LMS app working-directory: /home/runner/frappe-bench run: bench --site frappe.local install-app lms - - name: setup requirements + + - name: Setup Requirements working-directory: /home/runner/frappe-bench run: bench setup requirements --dev - - name: allow tests + + - name: Allow Tests working-directory: /home/runner/frappe-bench run: bench --site frappe.local set-config allow_tests true - - name: bench build + + - name: Build working-directory: /home/runner/frappe-bench run: bench --site frappe.local build - - name: run tests + + - name: Run Tests working-directory: /home/runner/frappe-bench run: bench --site frappe.local run-tests --app lms From d840d2fc18e021a097d7417151aa14e426475e76 Mon Sep 17 00:00:00 2001 From: Jannat Patel Date: Fri, 13 Oct 2023 11:19:27 +0530 Subject: [PATCH 07/33] ci: fixed step in server tests script --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index a4ad07e9..439c6613 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -29,7 +29,7 @@ jobs: options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3 steps: - name: Clone - - uses: actions/checkout@v2 + uses: actions/checkout@v2 - name: Setup Python uses: actions/setup-python@v2 From bf5cc5e1d167ba76c3cf981e92b19fe4dd3f9176 Mon Sep 17 00:00:00 2001 From: Jannat Patel Date: Fri, 13 Oct 2023 11:24:58 +0530 Subject: [PATCH 08/33] ci: fixed mariadb options --- .github/workflows/ci.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 439c6613..dc73014d 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -26,7 +26,7 @@ jobs: - 3306:3306 env: MYSQL_ROOT_PASSWORD: root - options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3 + options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3 --character-set-server utf8mb4 --collation-server utf8mb4_unicode_ci steps: - name: Clone uses: actions/checkout@v2 @@ -70,7 +70,7 @@ jobs: - name: Create bench site working-directory: /home/runner/frappe-bench - run: bench new-site --mariadb-root-password root --character-set-server utf8mb4 --collation-server utf8mb4_unicode_ci --admin-password admin frappe.local + run: bench new-site --mariadb-root-password root --admin-password admin frappe.local - name: Install LMS app working-directory: /home/runner/frappe-bench From a1bb7962bcd3186d2ec88e4a3e8300d70f899368 Mon Sep 17 00:00:00 2001 From: Jannat Patel Date: Fri, 13 Oct 2023 11:40:17 +0530 Subject: [PATCH 09/33] ci: added collation server for mariadb --- .github/workflows/ci.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index dc73014d..9a1061a1 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -24,9 +24,11 @@ jobs: image: mariadb:10.6 ports: - 3306:3306 + with: + collation server: 'utf8mb4_unicode_ci' env: MYSQL_ROOT_PASSWORD: root - options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3 --character-set-server utf8mb4 --collation-server utf8mb4_unicode_ci + options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3 steps: - name: Clone uses: actions/checkout@v2 From 3f5c3e89c8784404ddc4cfa047629d9748016587 Mon Sep 17 00:00:00 2001 From: Jannat Patel Date: Fri, 13 Oct 2023 11:45:42 +0530 Subject: [PATCH 10/33] ci: added collation server for mariadb --- .github/workflows/ci.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 9a1061a1..e02c1ba8 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -24,8 +24,7 @@ jobs: image: mariadb:10.6 ports: - 3306:3306 - with: - collation server: 'utf8mb4_unicode_ci' + collation server: 'utf8mb4_unicode_ci' env: MYSQL_ROOT_PASSWORD: root options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3 From 2ff3d83d8f84ca08f099b56d5609a59e43c3ab18 Mon Sep 17 00:00:00 2001 From: Jannat Patel Date: Fri, 13 Oct 2023 11:52:38 +0530 Subject: [PATCH 11/33] ci: added collation server for mariadb --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index e02c1ba8..03f6e315 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -24,7 +24,7 @@ jobs: image: mariadb:10.6 ports: - 3306:3306 - collation server: 'utf8mb4_unicode_ci' + command: mysqld --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci env: MYSQL_ROOT_PASSWORD: root options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3 From bf0cb25a8804a0085e8b1f368e578c356d575f0a Mon Sep 17 00:00:00 2001 From: Jannat Patel Date: Fri, 13 Oct 2023 12:33:16 +0530 Subject: [PATCH 12/33] ci: added collation server for mariadb --- .github/workflows/ci.yml | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 03f6e315..7ee6f555 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -20,18 +20,20 @@ jobs: image: redis:alpine ports: - 12000:6379 - mariadb: - image: mariadb:10.6 - ports: - - 3306:3306 - command: mysqld --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci - env: - MYSQL_ROOT_PASSWORD: root - options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3 + steps: - name: Clone uses: actions/checkout@v2 + - name: Start MariaDB + uses: getong/mariadb-action@v1.1 + host port: 3306 + container port: 3306 + character set server: 'utf8mb4' + collation server: 'utf8_general_ci' + mariadb version: '10.6' + mysql root password: root + - name: Setup Python uses: actions/setup-python@v2 with: From f592cf08d88f08fda93ea6ef51e30e03ebbafa02 Mon Sep 17 00:00:00 2001 From: Jannat Patel Date: Fri, 13 Oct 2023 12:47:36 +0530 Subject: [PATCH 13/33] ci: added collation server for mariadb --- .github/workflows/ci.yml | 159 +++++++++++++++++++-------------------- 1 file changed, 78 insertions(+), 81 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 7ee6f555..5a485f16 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,97 +1,94 @@ name: Server Tests on: - push: - branches: - - main - pull_request: {} + push: + branches: + - main + pull_request: {} jobs: - tests: - runs-on: ubuntu-latest - services: - redis-cache: - image: redis:alpine - ports: - - 13000:6379 - redis-queue: - image: redis:alpine - ports: - - 11000:6379 - redis-socketio: - image: redis:alpine - ports: - - 12000:6379 - - steps: - - name: Clone - uses: actions/checkout@v2 + tests: + runs-on: ubuntu-latest + services: + redis-cache: + image: redis:alpine + ports: + - 13000:6379 + redis-queue: + image: redis:alpine + ports: + - 11000:6379 + redis-socketio: + image: redis:alpine + ports: + - 12000:6379 + mysql: + image: mariadb:10.6 + env: + MARIADB_ROOT_PASSWORD: "root" + ports: + - 3306:3306 + options: --health-cmd="mariadb-admin ping" --health-interval=5s --health-timeout=2s --health-retries=3 - - name: Start MariaDB - uses: getong/mariadb-action@v1.1 - host port: 3306 - container port: 3306 - character set server: 'utf8mb4' - collation server: 'utf8_general_ci' - mariadb version: '10.6' - mysql root password: root + steps: + - name: Clone + uses: actions/checkout@v2 - - name: Setup Python - uses: actions/setup-python@v2 - with: - python-version: '3.10' + - name: Setup Python + uses: actions/setup-python@v2 + with: + python-version: "3.10" - - name: Setup Node - uses: actions/setup-node@v2 - with: - node-version: '18' - check-latest: true + - name: Setup Node + uses: actions/setup-node@v2 + with: + node-version: 18 + check-latest: true - - name: Setup ache for bench - uses: actions/cache@v2 - with: - path: ~/bench-cache - key: ${{ runner.os }} + - name: Setup ache for bench + uses: actions/cache@v2 + with: + path: ~/bench-cache + key: ${{ runner.os }} - - name: Install Bench - run: | - pip3 install frappe-bench - which bench + - name: Install Bench + run: | + pip3 install frappe-bench + which bench - - name: Bench Init - run: | - if [ -d ~/bench-cache/bench.tgz ] - then - (cd && tar xzf ~/bench-cache/bench.tgz) - else - bench init ~/frappe-bench --skip-redis-config-generation --skip-assets --python "$(which python)" - mkdir -p ~/bench-cache - (cd && tar czf ~/bench-cache/bench.tgz frappe-bench) - fi + - name: Bench Init + run: | + if [ -d ~/bench-cache/bench.tgz ] + then + (cd && tar xzf ~/bench-cache/bench.tgz) + else + bench init ~/frappe-bench --skip-redis-config-generation --skip-assets --python "$(which python)" + mkdir -p ~/bench-cache + (cd && tar czf ~/bench-cache/bench.tgz frappe-bench) + fi - - name: Add LMS app to bench - working-directory: /home/runner/frappe-bench - run: bench get-app lms $GITHUB_WORKSPACE + - name: Add LMS app to bench + working-directory: /home/runner/frappe-bench + run: bench get-app lms $GITHUB_WORKSPACE - - name: Create bench site - working-directory: /home/runner/frappe-bench - run: bench new-site --mariadb-root-password root --admin-password admin frappe.local + - name: Create bench site + working-directory: /home/runner/frappe-bench + run: bench new-site --mariadb-root-password root --admin-password admin frappe.local - - name: Install LMS app - working-directory: /home/runner/frappe-bench - run: bench --site frappe.local install-app lms + - name: Install LMS app + working-directory: /home/runner/frappe-bench + run: bench --site frappe.local install-app lms - - name: Setup Requirements - working-directory: /home/runner/frappe-bench - run: bench setup requirements --dev + - name: Setup Requirements + working-directory: /home/runner/frappe-bench + run: bench setup requirements --dev - - name: Allow Tests - working-directory: /home/runner/frappe-bench - run: bench --site frappe.local set-config allow_tests true + - name: Allow Tests + working-directory: /home/runner/frappe-bench + run: bench --site frappe.local set-config allow_tests true - - name: Build - working-directory: /home/runner/frappe-bench - run: bench --site frappe.local build - - - name: Run Tests - working-directory: /home/runner/frappe-bench - run: bench --site frappe.local run-tests --app lms + - name: Build + working-directory: /home/runner/frappe-bench + run: bench --site frappe.local build + - name: Run Tests + working-directory: /home/runner/frappe-bench + run: bench --site frappe.local run-tests --app lms From 4c83264c4a4d0869daa649a16428f261a733e6af Mon Sep 17 00:00:00 2001 From: Jannat Patel Date: Fri, 13 Oct 2023 13:14:35 +0530 Subject: [PATCH 14/33] ci: added collation server for mariadb --- .github/workflows/ci.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 5a485f16..6dd16f80 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -20,10 +20,11 @@ jobs: image: redis:alpine ports: - 12000:6379 - mysql: + mariadb: image: mariadb:10.6 env: - MARIADB_ROOT_PASSWORD: "root" + MYSQL_ROOT_PASSWORD: "root" + COLLATION_SERVER: "utf8mb4_unicode_ci" ports: - 3306:3306 options: --health-cmd="mariadb-admin ping" --health-interval=5s --health-timeout=2s --health-retries=3 From c20fa7e093869adcd4b43ff4629ab429f9f0c3dc Mon Sep 17 00:00:00 2001 From: Jannat Patel Date: Fri, 13 Oct 2023 14:50:50 +0530 Subject: [PATCH 15/33] ci: added collation server for mariadb --- .github/workflows/ci.yml | 102 +++++++++++++++++++++------------------ 1 file changed, 54 insertions(+), 48 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 6dd16f80..ee4a2cd7 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -31,65 +31,71 @@ jobs: steps: - name: Clone - uses: actions/checkout@v2 + uses: actions/checkout@v4 - name: Setup Python - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 with: - python-version: "3.10" + python-version: "3.11" + + - name: Check for valid Python & Merge Conflicts + run: | + python -m compileall -q -f "${GITHUB_WORKSPACE}" + if grep -lr --exclude-dir=node_modules "^<<<<<<< " "${GITHUB_WORKSPACE}" + then echo "Found merge conflicts" + exit 1 + fi - name: Setup Node - uses: actions/setup-node@v2 + uses: actions/setup-node@v3 with: node-version: 18 check-latest: true - - name: Setup ache for bench - uses: actions/cache@v2 + - name: Add to Hosts + run: | + echo "127.0.0.1 lms.test" | sudo tee -a /etc/hosts + + - name: Cache pip + uses: actions/cache@v3 with: - path: ~/bench-cache - key: ${{ runner.os }} + path: ~/.cache/pip + key: ${{ runner.os }}-pip-${{ hashFiles('**/*requirements.txt', '**/pyproject.toml', '**/setup.py') }} + restore-keys: | + ${{ runner.os }}-pip- + ${{ runner.os }}- - - name: Install Bench + - name: Get yarn cache directory path + id: yarn-cache-dir-path + run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT + + - uses: actions/cache@v3 + id: yarn-cache + with: + path: ${{ steps.yarn-cache-dir-path.outputs.dir }} + key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} + restore-keys: | + ${{ runner.os }}-yarn- + + - name: Install Dependencies run: | - pip3 install frappe-bench - which bench - - - name: Bench Init - run: | - if [ -d ~/bench-cache/bench.tgz ] - then - (cd && tar xzf ~/bench-cache/bench.tgz) - else - bench init ~/frappe-bench --skip-redis-config-generation --skip-assets --python "$(which python)" - mkdir -p ~/bench-cache - (cd && tar czf ~/bench-cache/bench.tgz frappe-bench) - fi - - - name: Add LMS app to bench - working-directory: /home/runner/frappe-bench - run: bench get-app lms $GITHUB_WORKSPACE - - - name: Create bench site - working-directory: /home/runner/frappe-bench - run: bench new-site --mariadb-root-password root --admin-password admin frappe.local - - - name: Install LMS app - working-directory: /home/runner/frappe-bench - run: bench --site frappe.local install-app lms - - - name: Setup Requirements - working-directory: /home/runner/frappe-bench - run: bench setup requirements --dev - - - name: Allow Tests - working-directory: /home/runner/frappe-bench - run: bench --site frappe.local set-config allow_tests true - - - name: Build - working-directory: /home/runner/frappe-bench - run: bench --site frappe.local build + bash ${GITHUB_WORKSPACE}/.github/helper/install_dependencies.sh + bash ${GITHUB_WORKSPACE}/.github/helper/install.sh + env: + BEFORE: ${{ env.GITHUB_EVENT_PATH.before }} + AFTER: ${{ env.GITHUB_EVENT_PATH.after }} + TYPE: server + DB: ${{ matrix.db }} - name: Run Tests - working-directory: /home/runner/frappe-bench - run: bench --site frappe.local run-tests --app lms + run: cd ~/frappe-bench/ && bench --site lms.test run-parallel-tests --app lms --total-builds 4 --build-number ${{ matrix.container }} + env: + SITE: lms.test + CI_BUILD_ID: ${{ github.run_id }} + BUILD_NUMBER: ${{ matrix.container }} + TOTAL_BUILDS: 2 + + - name: Show bench output + if: ${{ always() }} + run: cat ~/frappe-bench/bench_start.log || true + From 12c5ad54e722e1976ad03c4066b13831690fa364 Mon Sep 17 00:00:00 2001 From: Jannat Patel Date: Fri, 13 Oct 2023 15:24:12 +0530 Subject: [PATCH 16/33] ci: added collation server for mariadb --- .github/workflows/ci.yml | 168 +++++++++++++++++++-------------------- 1 file changed, 82 insertions(+), 86 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index ee4a2cd7..7ae67c73 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,101 +1,97 @@ name: Server Tests + on: - push: - branches: - - main - pull_request: {} + push: + branches: + - main + pull_request: {} + jobs: - tests: - runs-on: ubuntu-latest - services: - redis-cache: - image: redis:alpine - ports: - - 13000:6379 - redis-queue: - image: redis:alpine - ports: - - 11000:6379 - redis-socketio: - image: redis:alpine - ports: - - 12000:6379 - mariadb: - image: mariadb:10.6 - env: - MYSQL_ROOT_PASSWORD: "root" - COLLATION_SERVER: "utf8mb4_unicode_ci" - ports: - - 3306:3306 - options: --health-cmd="mariadb-admin ping" --health-interval=5s --health-timeout=2s --health-retries=3 + tests: + runs-on: ubuntu-latest + services: + redis-cache: + image: redis:alpine + ports: + - 13000:6379 + redis-queue: + image: redis:alpine + ports: + - 11000:6379 + redis-socketio: + image: redis:alpine + ports: + - 12000:6379 + mariadb: + image: mariadb:10.6 + ports: + - 3306:3306 + env: + MARIADB_ROOT_PASSWORD: root + MARIADB_CHARACTER_SET: utf8mb4 + MARIADB_COLLATION_SERVER: utf8mb4_unicode_ci + options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3 + steps: + - name: Checkout code + uses: actions/checkout@v2 - steps: - - name: Clone - uses: actions/checkout@v4 + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: '3.11' - - name: Setup Python - uses: actions/setup-python@v4 - with: - python-version: "3.11" + - name: Set up Node + uses: actions/setup-node@v2 + with: + node-version: 18 + check-latest: true - - name: Check for valid Python & Merge Conflicts - run: | - python -m compileall -q -f "${GITHUB_WORKSPACE}" - if grep -lr --exclude-dir=node_modules "^<<<<<<< " "${GITHUB_WORKSPACE}" - then echo "Found merge conflicts" - exit 1 - fi + - name: Cache Bench + uses: actions/cache@v2 + with: + path: ~/bench-cache + key: ${{ runner.os }} - - name: Setup Node - uses: actions/setup-node@v3 - with: - node-version: 18 - check-latest: true + - name: Install Bench + run: | + pip3 install frappe-bench + which bench - - name: Add to Hosts - run: | - echo "127.0.0.1 lms.test" | sudo tee -a /etc/hosts + - name: Initialize Bench + run: | + if [ -d ~/bench-cache/bench.tgz ] + then + (cd && tar xzf ~/bench-cache/bench.tgz) + else + bench init ~/frappe-bench --skip-redis-config-generation --skip-assets --python "$(which python)" + mkdir -p ~/bench-cache + (cd && tar czf ~/bench-cache/bench.tgz frappe-bench) + fi - - name: Cache pip - uses: actions/cache@v3 - with: - path: ~/.cache/pip - key: ${{ runner.os }}-pip-${{ hashFiles('**/*requirements.txt', '**/pyproject.toml', '**/setup.py') }} - restore-keys: | - ${{ runner.os }}-pip- - ${{ runner.os }}- + - name: Add LMS App + working-directory: /home/runner/frappe-bench + run: bench get-app lms $GITHUB_WORKSPACE - - name: Get yarn cache directory path - id: yarn-cache-dir-path - run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT + - name: Create Bench Site + working-directory: /home/runner/frappe-bench + run: bench new-site --mariadb-root-password root --admin-password admin frappe.local - - uses: actions/cache@v3 - id: yarn-cache - with: - path: ${{ steps.yarn-cache-dir-path.outputs.dir }} - key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} - restore-keys: | - ${{ runner.os }}-yarn- + - name: Install LMS App + working-directory: /home/runner/frappe-bench + run: bench --site frappe.local install-app lms - - name: Install Dependencies - run: | - bash ${GITHUB_WORKSPACE}/.github/helper/install_dependencies.sh - bash ${GITHUB_WORKSPACE}/.github/helper/install.sh - env: - BEFORE: ${{ env.GITHUB_EVENT_PATH.before }} - AFTER: ${{ env.GITHUB_EVENT_PATH.after }} - TYPE: server - DB: ${{ matrix.db }} + - name: Setup Requirements + working-directory: /home/runner/frappe-bench + run: bench setup requirements --dev - - name: Run Tests - run: cd ~/frappe-bench/ && bench --site lms.test run-parallel-tests --app lms --total-builds 4 --build-number ${{ matrix.container }} - env: - SITE: lms.test - CI_BUILD_ID: ${{ github.run_id }} - BUILD_NUMBER: ${{ matrix.container }} - TOTAL_BUILDS: 2 + - name: Allow Tests + working-directory: /home/runner/frappe-bench + run: bench --site frappe.local set-config allow_tests true - - name: Show bench output - if: ${{ always() }} - run: cat ~/frappe-bench/bench_start.log || true + - name: Build + working-directory: /home/runner/frappe-bench + run: bench --site frappe.local build + - name: Run Tests + working-directory: /home/runner/frappe-bench + run: bench --site frappe.local run-tests --app lms From 8e12cae91f1ca1681a16d3c1e9f2c43e75d227da Mon Sep 17 00:00:00 2001 From: Jannat Patel Date: Fri, 13 Oct 2023 15:58:07 +0530 Subject: [PATCH 17/33] ci: added collation server for mariadb --- .github/workflows/ci.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 7ae67c73..f4838e75 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -46,6 +46,10 @@ jobs: node-version: 18 check-latest: true + - name: Change MariaDB Collation + run: | + mysql -h 127.0.0.1 -P 3306 -uroot -proot -e "ALTER DATABASE dbname CHARACTER SET = utf8mb4 COLLATE = utf8mb4_unicode_ci" + - name: Cache Bench uses: actions/cache@v2 with: From eecc9b53df8284b848d456ddf905c666630f5494 Mon Sep 17 00:00:00 2001 From: Jannat Patel Date: Fri, 13 Oct 2023 16:07:01 +0530 Subject: [PATCH 18/33] ci: added collation server for mariadb --- .github/workflows/ci.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index f4838e75..550d823e 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -28,8 +28,7 @@ jobs: - 3306:3306 env: MARIADB_ROOT_PASSWORD: root - MARIADB_CHARACTER_SET: utf8mb4 - MARIADB_COLLATION_SERVER: utf8mb4_unicode_ci + MARIADB_DATABASE: dbname options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3 steps: - name: Checkout code From caf967f2e2352f0bcf1b05eac9dfea027210b35d Mon Sep 17 00:00:00 2001 From: Jannat Patel Date: Fri, 13 Oct 2023 16:13:45 +0530 Subject: [PATCH 19/33] ci: added collation server for mariadb --- .github/workflows/ci.yml | 88 +++++++++++++++++++--------------------- 1 file changed, 41 insertions(+), 47 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 550d823e..49978e98 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -28,7 +28,6 @@ jobs: - 3306:3306 env: MARIADB_ROOT_PASSWORD: root - MARIADB_DATABASE: dbname options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3 steps: - name: Checkout code @@ -45,56 +44,51 @@ jobs: node-version: 18 check-latest: true - - name: Change MariaDB Collation - run: | - mysql -h 127.0.0.1 -P 3306 -uroot -proot -e "ALTER DATABASE dbname CHARACTER SET = utf8mb4 COLLATE = utf8mb4_unicode_ci" + - name: Add to Hosts + run: echo "127.0.0.1 lms.test" | sudo tee -a /etc/hosts - - name: Cache Bench + - name: Cache pip uses: actions/cache@v2 with: - path: ~/bench-cache - key: ${{ runner.os }} + path: ~/.cache/pip + key: ${{ runner.os }}-pip-${{ hashFiles('**/*requirements.txt', '**/pyproject.toml') }} + restore-keys: | + ${{ runner.os }}-pip- + ${{ runner.os }}- - - name: Install Bench + - name: Cache node modules + uses: actions/cache@v2 + env: + cache-name: cache-node-modules + with: + path: ~/.npm + key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }} + restore-keys: | + ${{ runner.os }}-build-${{ env.cache-name }}- + ${{ runner.os }}-build- + ${{ runner.os }}- + + - name: Get yarn cache directory path + id: yarn-cache-dir-path + run: echo "::set-output name=dir::$(yarn cache dir)" + + - uses: actions/cache@v2 + id: yarn-cache + with: + path: ${{ steps.yarn-cache-dir-path.outputs.dir }} + key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} + restore-keys: | + ${{ runner.os }}-yarn- + + - name: Install run: | - pip3 install frappe-bench - which bench - - - name: Initialize Bench - run: | - if [ -d ~/bench-cache/bench.tgz ] - then - (cd && tar xzf ~/bench-cache/bench.tgz) - else - bench init ~/frappe-bench --skip-redis-config-generation --skip-assets --python "$(which python)" - mkdir -p ~/bench-cache - (cd && tar czf ~/bench-cache/bench.tgz frappe-bench) - fi - - - name: Add LMS App - working-directory: /home/runner/frappe-bench - run: bench get-app lms $GITHUB_WORKSPACE - - - name: Create Bench Site - working-directory: /home/runner/frappe-bench - run: bench new-site --mariadb-root-password root --admin-password admin frappe.local - - - name: Install LMS App - working-directory: /home/runner/frappe-bench - run: bench --site frappe.local install-app lms - - - name: Setup Requirements - working-directory: /home/runner/frappe-bench - run: bench setup requirements --dev - - - name: Allow Tests - working-directory: /home/runner/frappe-bench - run: bench --site frappe.local set-config allow_tests true - - - name: Build - working-directory: /home/runner/frappe-bench - run: bench --site frappe.local build + bash ${GITHUB_WORKSPACE}/.github/helper/install.sh + env: + BRANCH_TO_CLONE: ${{ env.HR_BRANCH }} - name: Run Tests - working-directory: /home/runner/frappe-bench - run: bench --site frappe.local run-tests --app lms + run: cd ~/frappe-bench/ && bench --site lms.test run-parallel-tests --app lms --total-builds 2 --build-number ${{ matrix.container }} + env: + TYPE: server + CI_BUILD_ID: ${{ github.run_id }} + ORCHESTRATOR_URL: http://test-orchestrator.frappe.io From f27eecce1fcf639570be8f87c6277154cda5fabf Mon Sep 17 00:00:00 2001 From: Jannat Patel Date: Fri, 13 Oct 2023 16:17:58 +0530 Subject: [PATCH 20/33] ci: added collation server for mariadb --- .github/helper/install.sh | 4 ++++ .github/workflows/ci.yml | 2 -- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/helper/install.sh b/.github/helper/install.sh index b5661726..198ead37 100644 --- a/.github/helper/install.sh +++ b/.github/helper/install.sh @@ -2,6 +2,10 @@ set -e cd ~ || exit +sudo apt update +sudo apt remove mysql-server mysql-client +sudo apt install libcups2-dev redis-server mariadb-client-10.6 + echo "Setting Up Bench..." pip install frappe-bench diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 49978e98..6703541e 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -83,8 +83,6 @@ jobs: - name: Install run: | bash ${GITHUB_WORKSPACE}/.github/helper/install.sh - env: - BRANCH_TO_CLONE: ${{ env.HR_BRANCH }} - name: Run Tests run: cd ~/frappe-bench/ && bench --site lms.test run-parallel-tests --app lms --total-builds 2 --build-number ${{ matrix.container }} From f2432d78ee3cf98ff1ad0f0f1f22feb2aa1d5cf5 Mon Sep 17 00:00:00 2001 From: Jannat Patel Date: Fri, 13 Oct 2023 16:29:47 +0530 Subject: [PATCH 21/33] ci: added collation server for mariadb --- .github/helper/install.sh | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/.github/helper/install.sh b/.github/helper/install.sh index 198ead37..b6b9d354 100644 --- a/.github/helper/install.sh +++ b/.github/helper/install.sh @@ -23,14 +23,16 @@ mkdir ~/frappe-bench/sites/lms.test cp "${GITHUB_WORKSPACE}/.github/helper/site_config.json" ~/frappe-bench/sites/lms.test/site_config.json -mariadb --host 127.0.0.1 --port 3306 -u root -p123 -e "SET GLOBAL character_set_server = 'utf8mb4'"; -mariadb --host 127.0.0.1 --port 3306 -u root -p123 -e "SET GLOBAL collation_server = 'utf8mb4_unicode_ci'"; +mariadb --host 127.0.0.1 --port 3306 -u root -proot -e "SET GLOBAL character_set_server = 'utf8mb4'"; +mariadb --host 127.0.0.1 --port 3306 -u root -proot -e "SET GLOBAL collation_server = 'utf8mb4_unicode_ci'"; -mariadb --host 127.0.0.1 --port 3306 -u root -p123 -e "CREATE DATABASE test_lms"; -mariadb --host 127.0.0.1 --port 3306 -u root -p123 -e "CREATE USER 'test_lms'@'localhost' IDENTIFIED BY 'test_lms'"; -mariadb --host 127.0.0.1 --port 3306 -u root -p123 -e "GRANT ALL PRIVILEGES ON \`test_lms\`.* TO 'test_lms'@'localhost'"; +mariadb --host 127.0.0.1 --port 3306 -u root -proot -e "CREATE DATABASE test_lms"; +mariadb --host 127.0.0.1 --port 3306 -u root -proot -e "CREATE USER 'test_lms'@'localhost' IDENTIFIED BY 'test_lms'"; +mariadb --host 127.0.0.1 --port 3306 -u root -proot -e "GRANT ALL PRIVILEGES ON \`test_lms\`.* TO 'test_lms'@'localhost'"; -mariadb --host 127.0.0.1 --port 3306 -u root -p123 -e "FLUSH PRIVILEGES"; +mariadb --host 127.0.0.1 --port 3306 -u root -proot -e "FLUSH PRIVILEGES"; + +cd ~/frappe-bench || exit echo "Setting Up Procfile..." @@ -40,11 +42,10 @@ sed -i 's/^schedule:/# schedule:/g' Procfile echo "Starting Bench..." bench start &> bench_start.log & - CI=Yes bench build & -build_pid=$! - bench --site lms.test reinstall --yes -bench --site lms.test install-app lms -wait $build_pid +bench get-app hrms + +bench --site lms.test install-app lms +bench setup requirements --dev From bc2dc679a8b26454f646f4fd3ed2cbd9435329b1 Mon Sep 17 00:00:00 2001 From: Jannat Patel Date: Fri, 13 Oct 2023 18:15:49 +0530 Subject: [PATCH 22/33] fix: revert ci changes --- .github/helper/install.sh | 27 +++++----- .github/workflows/ci.yml | 100 +++++++++++++++++--------------------- 2 files changed, 55 insertions(+), 72 deletions(-) diff --git a/.github/helper/install.sh b/.github/helper/install.sh index b6b9d354..21bb9d9a 100644 --- a/.github/helper/install.sh +++ b/.github/helper/install.sh @@ -2,10 +2,6 @@ set -e cd ~ || exit -sudo apt update -sudo apt remove mysql-server mysql-client -sudo apt install libcups2-dev redis-server mariadb-client-10.6 - echo "Setting Up Bench..." pip install frappe-bench @@ -23,16 +19,14 @@ mkdir ~/frappe-bench/sites/lms.test cp "${GITHUB_WORKSPACE}/.github/helper/site_config.json" ~/frappe-bench/sites/lms.test/site_config.json -mariadb --host 127.0.0.1 --port 3306 -u root -proot -e "SET GLOBAL character_set_server = 'utf8mb4'"; -mariadb --host 127.0.0.1 --port 3306 -u root -proot -e "SET GLOBAL collation_server = 'utf8mb4_unicode_ci'"; +mariadb --host 127.0.0.1 --port 3306 -u root -p123 -e "SET GLOBAL character_set_server = 'utf8mb4'"; +mariadb --host 127.0.0.1 --port 3306 -u root -p123 -e "SET GLOBAL collation_server = 'utf8mb4_unicode_ci'"; -mariadb --host 127.0.0.1 --port 3306 -u root -proot -e "CREATE DATABASE test_lms"; -mariadb --host 127.0.0.1 --port 3306 -u root -proot -e "CREATE USER 'test_lms'@'localhost' IDENTIFIED BY 'test_lms'"; -mariadb --host 127.0.0.1 --port 3306 -u root -proot -e "GRANT ALL PRIVILEGES ON \`test_lms\`.* TO 'test_lms'@'localhost'"; +mariadb --host 127.0.0.1 --port 3306 -u root -p123 -e "CREATE DATABASE test_lms"; +mariadb --host 127.0.0.1 --port 3306 -u root -p123 -e "CREATE USER 'test_lms'@'localhost' IDENTIFIED BY 'test_lms'"; +mariadb --host 127.0.0.1 --port 3306 -u root -p123 -e "GRANT ALL PRIVILEGES ON \`test_lms\`.* TO 'test_lms'@'localhost'"; -mariadb --host 127.0.0.1 --port 3306 -u root -proot -e "FLUSH PRIVILEGES"; - -cd ~/frappe-bench || exit +mariadb --host 127.0.0.1 --port 3306 -u root -p123 -e "FLUSH PRIVILEGES"; echo "Setting Up Procfile..." @@ -42,10 +36,11 @@ sed -i 's/^schedule:/# schedule:/g' Procfile echo "Starting Bench..." bench start &> bench_start.log & + CI=Yes bench build & +build_pid=$! + bench --site lms.test reinstall --yes - -bench get-app hrms - bench --site lms.test install-app lms -bench setup requirements --dev + +wait $build_pid \ No newline at end of file diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 6703541e..01ee036a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,11 +1,9 @@ name: Server Tests - on: push: branches: - main pull_request: {} - jobs: tests: runs-on: ubuntu-latest @@ -23,70 +21,60 @@ jobs: ports: - 12000:6379 mariadb: - image: mariadb:10.6 + image: anandology/mariadb-utf8mb4:10.3 ports: - 3306:3306 env: - MARIADB_ROOT_PASSWORD: root + MYSQL_ROOT_PASSWORD: root options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3 steps: - - name: Checkout code - uses: actions/checkout@v2 - - - name: Set up Python + - uses: actions/checkout@v2 + - name: setup python uses: actions/setup-python@v2 with: - python-version: '3.11' - - - name: Set up Node + python-version: '3.10' + - name: setup node uses: actions/setup-node@v2 with: - node-version: 18 + node-version: '18' check-latest: true - - - name: Add to Hosts - run: echo "127.0.0.1 lms.test" | sudo tee -a /etc/hosts - - - name: Cache pip + - name: setup cache for bench uses: actions/cache@v2 with: - path: ~/.cache/pip - key: ${{ runner.os }}-pip-${{ hashFiles('**/*requirements.txt', '**/pyproject.toml') }} - restore-keys: | - ${{ runner.os }}-pip- - ${{ runner.os }}- - - - name: Cache node modules - uses: actions/cache@v2 - env: - cache-name: cache-node-modules - with: - path: ~/.npm - key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }} - restore-keys: | - ${{ runner.os }}-build-${{ env.cache-name }}- - ${{ runner.os }}-build- - ${{ runner.os }}- - - - name: Get yarn cache directory path - id: yarn-cache-dir-path - run: echo "::set-output name=dir::$(yarn cache dir)" - - - uses: actions/cache@v2 - id: yarn-cache - with: - path: ${{ steps.yarn-cache-dir-path.outputs.dir }} - key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} - restore-keys: | - ${{ runner.os }}-yarn- - - - name: Install + path: ~/bench-cache + key: ${{ runner.os }} + - name: install bench run: | - bash ${GITHUB_WORKSPACE}/.github/helper/install.sh - - - name: Run Tests - run: cd ~/frappe-bench/ && bench --site lms.test run-parallel-tests --app lms --total-builds 2 --build-number ${{ matrix.container }} - env: - TYPE: server - CI_BUILD_ID: ${{ github.run_id }} - ORCHESTRATOR_URL: http://test-orchestrator.frappe.io + pip3 install frappe-bench + which bench + - name: bench init + run: | + if [ -d ~/bench-cache/bench.tgz ] + then + (cd && tar xzf ~/bench-cache/bench.tgz) + else + bench init ~/frappe-bench --skip-redis-config-generation --skip-assets --python "$(which python)" + mkdir -p ~/bench-cache + (cd && tar czf ~/bench-cache/bench.tgz frappe-bench) + fi + - name: add lms app to bench + working-directory: /home/runner/frappe-bench + run: bench get-app lms $GITHUB_WORKSPACE + - name: create bench site + working-directory: /home/runner/frappe-bench + run: bench new-site --mariadb-root-password root --admin-password admin frappe.local + - name: install lms app + working-directory: /home/runner/frappe-bench + run: bench --site frappe.local install-app lms + - name: setup requirements + working-directory: /home/runner/frappe-bench + run: bench setup requirements --dev + - name: allow tests + working-directory: /home/runner/frappe-bench + run: bench --site frappe.local set-config allow_tests true + - name: bench build + working-directory: /home/runner/frappe-bench + run: bench --site frappe.local build + - name: run tests + working-directory: /home/runner/frappe-bench + run: bench --site frappe.local run-tests --app lms \ No newline at end of file From 12bec14c92fa8e943c74d9f2906b1612c18ac5de Mon Sep 17 00:00:00 2001 From: Jannat Patel Date: Mon, 16 Oct 2023 19:52:36 +0530 Subject: [PATCH 23/33] feat: quiz validations and marks --- .../doctype/lms_question/lms_question.json | 26 ++++++++-------- lms/lms/doctype/lms_quiz/lms_quiz.json | 25 ++++++++++++++- lms/lms/doctype/lms_quiz/lms_quiz.py | 21 ++++++++++--- .../lms_quiz_question/lms_quiz_question.json | 16 ++++++++-- .../lms_quiz_result/lms_quiz_result.json | 23 ++++++++++++-- lms/patches.txt | 3 +- lms/patches/v1_0/add_default_marks.py | 16 ++++++++++ lms/patches/v1_0/create_quiz_questions.py | 31 +++++++------------ lms/plugins.py | 23 +++++++++++++- lms/templates/quiz/quiz.html | 3 +- 10 files changed, 140 insertions(+), 47 deletions(-) create mode 100644 lms/patches/v1_0/add_default_marks.py diff --git a/lms/lms/doctype/lms_question/lms_question.json b/lms/lms/doctype/lms_question/lms_question.json index c91f4937..a7852390 100644 --- a/lms/lms/doctype/lms_question/lms_question.json +++ b/lms/lms/doctype/lms_question/lms_question.json @@ -32,11 +32,11 @@ "column_break_lknb", "explanation_4", "section_break_hkfe", - "possible_answer_1", - "possible_answer_3", + "possibility_1", + "possibility_3", "column_break_wpjr", - "possible_answer_2", - "possible_answer_4" + "possibility_2", + "possibility_4" ], "fields": [ { @@ -167,34 +167,34 @@ "fieldtype": "Section Break" }, { - "fieldname": "possible_answer_1", + "fieldname": "column_break_wpjr", + "fieldtype": "Column Break" + }, + { + "fieldname": "possibility_1", "fieldtype": "Small Text", "label": "Possible Answer 1", "mandatory_depends_on": "eval: doc.type == 'User Input'" }, { - "fieldname": "possible_answer_3", + "fieldname": "possibility_3", "fieldtype": "Small Text", "label": "Possible Answer 3" }, { - "fieldname": "column_break_wpjr", - "fieldtype": "Column Break" - }, - { - "fieldname": "possible_answer_2", + "fieldname": "possibility_2", "fieldtype": "Small Text", "label": "Possible Answer 2" }, { - "fieldname": "possible_answer_4", + "fieldname": "possibility_4", "fieldtype": "Small Text", "label": "Possible Answer 4" } ], "index_web_pages_for_search": 1, "links": [], - "modified": "2023-10-10 16:03:38.776125", + "modified": "2023-10-16 11:39:39.757008", "modified_by": "Administrator", "module": "LMS", "name": "LMS Question", diff --git a/lms/lms/doctype/lms_quiz/lms_quiz.json b/lms/lms/doctype/lms_quiz/lms_quiz.json index dbbea28b..c5d97764 100644 --- a/lms/lms/doctype/lms_quiz/lms_quiz.json +++ b/lms/lms/doctype/lms_quiz/lms_quiz.json @@ -12,6 +12,10 @@ "column_break_gaac", "max_attempts", "show_submission_history", + "section_break_hsiv", + "passing_percentage", + "column_break_rocd", + "total_marks", "section_break_sbjx", "questions", "section_break_3", @@ -90,11 +94,30 @@ "fieldname": "show_submission_history", "fieldtype": "Check", "label": "Show Submission History" + }, + { + "fieldname": "section_break_hsiv", + "fieldtype": "Section Break" + }, + { + "fieldname": "passing_percentage", + "fieldtype": "Int", + "label": "Passing Percentage" + }, + { + "fieldname": "column_break_rocd", + "fieldtype": "Column Break" + }, + { + "fieldname": "total_marks", + "fieldtype": "Int", + "label": "Total Marks", + "read_only": 1 } ], "index_web_pages_for_search": 1, "links": [], - "modified": "2023-07-04 15:26:24.457745", + "modified": "2023-10-16 17:21:33.932981", "modified_by": "Administrator", "module": "LMS", "name": "LMS Quiz", diff --git a/lms/lms/doctype/lms_quiz/lms_quiz.py b/lms/lms/doctype/lms_quiz/lms_quiz.py index d91490f8..0f2ef9db 100644 --- a/lms/lms/doctype/lms_quiz/lms_quiz.py +++ b/lms/lms/doctype/lms_quiz/lms_quiz.py @@ -5,7 +5,7 @@ import json import frappe from frappe import _ from frappe.model.document import Document -from frappe.utils import cstr +from frappe.utils import cstr, comma_and from lms.lms.doctype.lms_question.lms_question import validate_correct_answers from lms.lms.utils import ( generate_slug, @@ -15,6 +15,17 @@ from lms.lms.utils import ( class LMSQuiz(Document): + def validate(self): + self.validate_duplicate_questions() + + def validate_duplicate_questions(self): + questions = [row.question for row in self.questions] + rows = [i + 1 for i, x in enumerate(questions) if questions.count(x) > 1] + if len(rows): + frappe.throw( + _("Rows {0} have the duplicate questions.").format(frappe.bold(comma_and(rows))) + ) + def autoname(self): if not self.name: self.name = generate_slug(self.title, "LMS Quiz") @@ -44,11 +55,13 @@ def quiz_summary(quiz, results): for result in results: correct = result["is_correct"][0] - result["question"] = frappe.db.get_value( + question_name = frappe.db.get_value( "LMS Quiz Question", {"parent": quiz, "idx": result["question_index"] + 1}, ["question"], ) + result["question_name"] = question_name + result["question"] = frappe.db.get_value("LMS Question", question_name, "question") for point in result["is_correct"]: correct = correct and point @@ -184,9 +197,7 @@ def check_choice_answers(question, answers): fields.append(f"option_{cstr(num)}") fields.append(f"is_correct_{cstr(num)}") - question_details = frappe.db.get_value( - "LMS Quiz Question", question, fields, as_dict=1 - ) + question_details = frappe.db.get_value("LMS Question", question, fields, as_dict=1) for num in range(1, 5): if question_details[f"option_{num}"] in answers: diff --git a/lms/lms/doctype/lms_quiz_question/lms_quiz_question.json b/lms/lms/doctype/lms_quiz_question/lms_quiz_question.json index 52cd5664..4be1f88e 100644 --- a/lms/lms/doctype/lms_quiz_question/lms_quiz_question.json +++ b/lms/lms/doctype/lms_quiz_question/lms_quiz_question.json @@ -5,22 +5,34 @@ "editable_grid": 1, "engine": "InnoDB", "field_order": [ - "question" + "question", + "marks" ], "fields": [ { "fieldname": "question", "fieldtype": "Link", "in_list_view": 1, + "in_preview": 1, "label": "Question", "options": "LMS Question", "reqd": 1 + }, + { + "default": "1", + "fieldname": "marks", + "fieldtype": "Int", + "in_list_view": 1, + "in_preview": 1, + "label": "Marks", + "non_negative": 1, + "reqd": 1 } ], "index_web_pages_for_search": 1, "istable": 1, "links": [], - "modified": "2023-10-10 15:42:51.791902", + "modified": "2023-10-16 19:51:03.893143", "modified_by": "Administrator", "module": "LMS", "name": "LMS Quiz Question", diff --git a/lms/lms/doctype/lms_quiz_result/lms_quiz_result.json b/lms/lms/doctype/lms_quiz_result/lms_quiz_result.json index 93487a38..72aeaef6 100644 --- a/lms/lms/doctype/lms_quiz_result/lms_quiz_result.json +++ b/lms/lms/doctype/lms_quiz_result/lms_quiz_result.json @@ -6,8 +6,11 @@ "engine": "InnoDB", "field_order": [ "question", - "answer", - "is_correct" + "section_break_fztv", + "question_name", + "is_correct", + "column_break_flus", + "answer" ], "fields": [ { @@ -31,12 +34,26 @@ "in_list_view": 1, "label": "Is Correct", "read_only": 1 + }, + { + "fieldname": "section_break_fztv", + "fieldtype": "Section Break" + }, + { + "fieldname": "question_name", + "fieldtype": "Link", + "label": "Question Name", + "options": "LMS Question" + }, + { + "fieldname": "column_break_flus", + "fieldtype": "Column Break" } ], "index_web_pages_for_search": 1, "istable": 1, "links": [], - "modified": "2022-11-24 11:15:45.931119", + "modified": "2023-10-16 15:25:03.380843", "modified_by": "Administrator", "module": "LMS", "name": "LMS Quiz Result", diff --git a/lms/patches.txt b/lms/patches.txt index 60acee23..5a28133a 100644 --- a/lms/patches.txt +++ b/lms/patches.txt @@ -73,4 +73,5 @@ lms.patches.v1_0.change_naming_for_batch_course #14-09-2023 execute:frappe.permissions.reset_perms("LMS Enrollment") lms.patches.v1_0.create_student_role lms.patches.v1_0.mark_confirmation_for_batch_students -lms.patches.v1_0.create_quiz_questions \ No newline at end of file +lms.patches.v1_0.create_quiz_questions +lms.patches.v1_0.add_default_marks #16-10-2023 \ No newline at end of file diff --git a/lms/patches/v1_0/add_default_marks.py b/lms/patches/v1_0/add_default_marks.py new file mode 100644 index 00000000..fb35a0f6 --- /dev/null +++ b/lms/patches/v1_0/add_default_marks.py @@ -0,0 +1,16 @@ +import frappe + + +def execute(): + questions = frappe.get_all("LMS Quiz Question", pluck="name") + + for question in questions: + frappe.db.set_value("LMS Quiz Question", question, "marks", 1) + + quizzes = frappe.get_all("LMS Quiz", pluck="name") + + for quiz in quizzes: + questions_count = frappe.db.count("LMS Quiz Question", {"parent": quiz}) + frappe.db.set_value( + "LMS Quiz", quiz, {"total_marks": questions_count, "passing_percentage": 100} + ) diff --git a/lms/patches/v1_0/create_quiz_questions.py b/lms/patches/v1_0/create_quiz_questions.py index c53a7c00..12779cbd 100644 --- a/lms/patches/v1_0/create_quiz_questions.py +++ b/lms/patches/v1_0/create_quiz_questions.py @@ -3,31 +3,21 @@ import frappe def execute(): frappe.reload_doc("lms", "doctype", "lms_question") - frappe.reload_doc("lms", "doctype", "lms_quiz_question") + + fields = ["name", "question", "type", "multiple"] + for num in range(1, 5): + fields.append(f"option_{num}") + fields.append(f"is_correct_{num}") + fields.append(f"explanation_{num}") + fields.append(f"possibility_{num}") questions = frappe.get_all( "LMS Quiz Question", - fields=[ - "name", - "question", - "type", - "multiple", - "option_1", - "is_correct_1", - "explanation_1", - "option_2", - "is_correct_2", - "explanation_2", - "option_3", - "is_correct_3", - "explanation_3", - "option_4", - "is_correct_4", - "explanation_4", - ], + fields=fields, ) for question in questions: + print(question.name) doc = frappe.new_doc("LMS Question") doc.update( { @@ -44,9 +34,10 @@ def execute(): f"option_{num}": question[f"option_{num}"], f"is_correct_{num}": question[f"is_correct_{num}"], f"explanation_{num}": question[f"explanation_{num}"], + f"possibility_{num}": question[f"possibility_{num}"], } ) doc.save() - + print(doc.name) frappe.db.set_value("LMS Quiz Question", question.name, "question", doc.name) diff --git a/lms/plugins.py b/lms/plugins.py index b0f40cd2..00569484 100644 --- a/lms/plugins.py +++ b/lms/plugins.py @@ -109,7 +109,28 @@ def quiz_renderer(quiz_name): ) +"" - quiz = frappe.get_doc("LMS Quiz", quiz_name) + quiz = frappe.db.get_value( + "LMS Quiz", + quiz_name, + ["name", "title", "max_attempts", "show_answers", "show_submission_history"], + as_dict=True, + ) + quiz.questions = [] + fields = ["name", "question", "type", "multiple"] + for num in range(1, 5): + fields.append(f"option_{num}") + fields.append(f"is_correct_{num}") + fields.append(f"explanation_{num}") + fields.append(f"possibility_{num}") + + questions = frappe.get_all( + "LMS Quiz Question", {"parent": quiz.name}, pluck="question", order_by="idx" + ) + + for question in questions: + details = frappe.db.get_value("LMS Question", question, fields, as_dict=1) + quiz.questions.append(details) + no_of_attempts = frappe.db.count( "LMS Quiz Submission", {"owner": frappe.session.user, "quiz": quiz_name} ) diff --git a/lms/templates/quiz/quiz.html b/lms/templates/quiz/quiz.html index 41e9cf7f..082f7d38 100644 --- a/lms/templates/quiz/quiz.html +++ b/lms/templates/quiz/quiz.html @@ -51,7 +51,8 @@ data-multi="{{ question.multiple }}" data-qt-index="{{ loop.index }}">
- {{ _("Question ") }}{{ loop.index }}: {{ instruction }}
+ {{ _("Question ") }}{{ loop.index }}: {{ instruction }} +
{{ question.question }}
From 0111ff9c99c1adb2d903b2ea366056bcf9ee8859 Mon Sep 17 00:00:00 2001 From: Jannat Patel Date: Tue, 17 Oct 2023 20:06:04 +0530 Subject: [PATCH 24/33] feat: quiz marks and passing percentage --- .../doctype/course_lesson/course_lesson.py | 8 ++- lms/lms/doctype/lms_quiz/lms_quiz.json | 12 ++-- lms/lms/doctype/lms_quiz/lms_quiz.py | 47 ++++++++++++---- .../lms_quiz_result/lms_quiz_result.json | 14 ++++- .../lms_quiz_submission.json | 39 +++++++++++-- .../lms_quiz_submission.py | 7 ++- lms/plugins.py | 17 +++++- lms/public/css/style.css | 13 +++-- lms/templates/quiz/quiz.html | 15 ++++- lms/templates/quiz/quiz.js | 8 ++- .../assignment_submission.py | 2 +- lms/www/batch/edit.js | 4 +- lms/www/batch/quiz.html | 13 +++-- lms/www/batch/quiz.js | 55 +++++++++++++++++++ lms/www/batch/quiz.py | 3 +- 15 files changed, 210 insertions(+), 47 deletions(-) diff --git a/lms/lms/doctype/course_lesson/course_lesson.py b/lms/lms/doctype/course_lesson/course_lesson.py index b2f2475f..d7b53fd4 100644 --- a/lms/lms/doctype/course_lesson/course_lesson.py +++ b/lms/lms/doctype/course_lesson/course_lesson.py @@ -99,8 +99,14 @@ def save_progress(lesson, course, status): quizzes = [value for name, value in macros if name == "Quiz"] for quiz in quizzes: + passing_percentage = frappe.db.get_value("LMS Quiz", quiz, "passing_percentage") if not frappe.db.exists( - "LMS Quiz Submission", {"quiz": quiz, "owner": frappe.session.user} + "LMS Quiz Submission", + { + "quiz": quiz, + "owner": frappe.session.user, + "percentage": [">=", passing_percentage], + }, ): return 0 diff --git a/lms/lms/doctype/lms_quiz/lms_quiz.json b/lms/lms/doctype/lms_quiz/lms_quiz.json index c5d97764..202667f5 100644 --- a/lms/lms/doctype/lms_quiz/lms_quiz.json +++ b/lms/lms/doctype/lms_quiz/lms_quiz.json @@ -47,7 +47,7 @@ "read_only": 1 }, { - "default": "1", + "default": "0", "fieldname": "max_attempts", "fieldtype": "Int", "label": "Max Attempts" @@ -102,7 +102,9 @@ { "fieldname": "passing_percentage", "fieldtype": "Int", - "label": "Passing Percentage" + "label": "Passing Percentage", + "non_negative": 1, + "reqd": 1 }, { "fieldname": "column_break_rocd", @@ -112,12 +114,14 @@ "fieldname": "total_marks", "fieldtype": "Int", "label": "Total Marks", - "read_only": 1 + "non_negative": 1, + "read_only": 1, + "reqd": 1 } ], "index_web_pages_for_search": 1, "links": [], - "modified": "2023-10-16 17:21:33.932981", + "modified": "2023-10-17 15:25:25.830927", "modified_by": "Administrator", "module": "LMS", "name": "LMS Quiz", diff --git a/lms/lms/doctype/lms_quiz/lms_quiz.py b/lms/lms/doctype/lms_quiz/lms_quiz.py index 0f2ef9db..fa1fe0e8 100644 --- a/lms/lms/doctype/lms_quiz/lms_quiz.py +++ b/lms/lms/doctype/lms_quiz/lms_quiz.py @@ -17,6 +17,7 @@ from lms.lms.utils import ( class LMSQuiz(Document): def validate(self): self.validate_duplicate_questions() + self.set_total_marks() def validate_duplicate_questions(self): questions = [row.question for row in self.questions] @@ -26,6 +27,13 @@ class LMSQuiz(Document): _("Rows {0} have the duplicate questions.").format(frappe.bold(comma_and(rows))) ) + def set_total_marks(self): + marks = 0 + for question in self.questions: + marks += question.marks + + self.total_marks = marks + def autoname(self): if not self.name: self.name = generate_slug(self.title, "LMS Quiz") @@ -55,27 +63,42 @@ def quiz_summary(quiz, results): for result in results: correct = result["is_correct"][0] - question_name = frappe.db.get_value( - "LMS Quiz Question", - {"parent": quiz, "idx": result["question_index"] + 1}, - ["question"], - ) - result["question_name"] = question_name - result["question"] = frappe.db.get_value("LMS Question", question_name, "question") - for point in result["is_correct"]: correct = correct and point result["is_correct"] = correct - score += correct + + question_details = frappe.db.get_value( + "LMS Quiz Question", + {"parent": quiz, "idx": result["question_index"] + 1}, + ["question", "marks"], + as_dict=1, + ) + + result["question_name"] = question_details.question + result["question"] = frappe.db.get_value( + "LMS Question", question_details.question, "question" + ) + marks = question_details.marks if correct else 0 + + result["marks"] = marks + score += marks + del result["question_index"] + quiz_details = frappe.db.get_value( + "LMS Quiz", quiz, ["total_marks", "passing_percentage"], as_dict=1 + ) + score_out_of = quiz_details.total_marks + percentage = (score / score_out_of) * 100 + submission = frappe.get_doc( { "doctype": "LMS Quiz Submission", "quiz": quiz, "result": results, "score": score, + "score_out_of": score_out_of, "member": frappe.session.user, } ) @@ -83,7 +106,9 @@ def quiz_summary(quiz, results): return { "score": score, + "score_out_of": score_out_of, "submission": submission.name, + "pass": percentage == quiz_details.passing_percentage, } @@ -213,9 +238,7 @@ def check_input_answers(question, answer): for num in range(1, 5): fields.append(f"possibility_{cstr(num)}") - question_details = frappe.db.get_value( - "LMS Quiz Question", question, fields, as_dict=1 - ) + question_details = frappe.db.get_value("LMS Question", question, fields, as_dict=1) for num in range(1, 5): current_possibility = question_details[f"possibility_{num}"] if current_possibility and current_possibility.lower() == answer.lower(): diff --git a/lms/lms/doctype/lms_quiz_result/lms_quiz_result.json b/lms/lms/doctype/lms_quiz_result/lms_quiz_result.json index 72aeaef6..7c8fcfac 100644 --- a/lms/lms/doctype/lms_quiz_result/lms_quiz_result.json +++ b/lms/lms/doctype/lms_quiz_result/lms_quiz_result.json @@ -8,9 +8,10 @@ "question", "section_break_fztv", "question_name", - "is_correct", + "answer", "column_break_flus", - "answer" + "marks", + "is_correct" ], "fields": [ { @@ -48,12 +49,19 @@ { "fieldname": "column_break_flus", "fieldtype": "Column Break" + }, + { + "fieldname": "marks", + "fieldtype": "Int", + "in_list_view": 1, + "label": "Marks", + "read_only": 1 } ], "index_web_pages_for_search": 1, "istable": 1, "links": [], - "modified": "2023-10-16 15:25:03.380843", + "modified": "2023-10-17 11:55:25.641214", "modified_by": "Administrator", "module": "LMS", "name": "LMS Quiz Result", diff --git a/lms/lms/doctype/lms_quiz_submission/lms_quiz_submission.json b/lms/lms/doctype/lms_quiz_submission/lms_quiz_submission.json index 80ca9ffd..735d87a0 100644 --- a/lms/lms/doctype/lms_quiz_submission/lms_quiz_submission.json +++ b/lms/lms/doctype/lms_quiz_submission/lms_quiz_submission.json @@ -6,11 +6,15 @@ "engine": "InnoDB", "field_order": [ "quiz", - "score", "course", "column_break_3", "member", "member_name", + "section_break_dkpn", + "score", + "score_out_of", + "column_break_gkip", + "percentage", "section_break_6", "result" ], @@ -31,9 +35,11 @@ }, { "fieldname": "score", - "fieldtype": "Data", + "fieldtype": "Int", "in_list_view": 1, - "label": "Score" + "label": "Score", + "read_only": 1, + "reqd": 1 }, { "fieldname": "member", @@ -65,12 +71,37 @@ "label": "Course", "options": "LMS Course", "read_only": 1 + }, + { + "fetch_from": "quiz.total_marks", + "fieldname": "score_out_of", + "fieldtype": "Int", + "label": "Score Out Of", + "non_negative": 1, + "read_only": 1, + "reqd": 1 + }, + { + "fieldname": "section_break_dkpn", + "fieldtype": "Section Break" + }, + { + "fieldname": "column_break_gkip", + "fieldtype": "Column Break" + }, + { + "fieldname": "percentage", + "fieldtype": "Int", + "label": "Percentage", + "non_negative": 1, + "read_only": 1, + "reqd": 1 } ], "in_create": 1, "index_web_pages_for_search": 1, "links": [], - "modified": "2022-11-15 15:27:07.770945", + "modified": "2023-10-17 13:07:27.979974", "modified_by": "Administrator", "module": "LMS", "name": "LMS Quiz Submission", diff --git a/lms/lms/doctype/lms_quiz_submission/lms_quiz_submission.py b/lms/lms/doctype/lms_quiz_submission/lms_quiz_submission.py index d8eeba65..e481d57e 100644 --- a/lms/lms/doctype/lms_quiz_submission/lms_quiz_submission.py +++ b/lms/lms/doctype/lms_quiz_submission/lms_quiz_submission.py @@ -6,4 +6,9 @@ from frappe.model.document import Document class LMSQuizSubmission(Document): - pass + def before_insert(self): + self.set_percentage() + + def set_percentage(self): + if self.score and self.score_out_of: + self.percentage = (self.score / self.score_out_of) * 100 diff --git a/lms/plugins.py b/lms/plugins.py index 00569484..e3241244 100644 --- a/lms/plugins.py +++ b/lms/plugins.py @@ -112,7 +112,14 @@ def quiz_renderer(quiz_name): quiz = frappe.db.get_value( "LMS Quiz", quiz_name, - ["name", "title", "max_attempts", "show_answers", "show_submission_history"], + [ + "name", + "title", + "max_attempts", + "show_answers", + "show_submission_history", + "passing_percentage", + ], as_dict=True, ) quiz.questions = [] @@ -124,11 +131,15 @@ def quiz_renderer(quiz_name): fields.append(f"possibility_{num}") questions = frappe.get_all( - "LMS Quiz Question", {"parent": quiz.name}, pluck="question", order_by="idx" + "LMS Quiz Question", + filters={"parent": quiz.name}, + fields=["question", "marks"], + order_by="idx", ) for question in questions: - details = frappe.db.get_value("LMS Question", question, fields, as_dict=1) + details = frappe.db.get_value("LMS Question", question.question, fields, as_dict=1) + details["marks"] = question.marks quiz.questions.append(details) no_of_attempts = frappe.db.count( diff --git a/lms/public/css/style.css b/lms/public/css/style.css index c62f3de4..aa02192b 100644 --- a/lms/public/css/style.css +++ b/lms/public/css/style.css @@ -785,12 +785,13 @@ input[type=checkbox] { } .breadcrumb { - display: flex; - align-items: center; - font-size: var(--text-base); - line-height: 20px; - color: var(--gray-900); - padding: 0; + display: flex; + align-items: center; + font-size: var(--text-base); + line-height: 20px; + color: var(--gray-900); + padding: 0; + border-radius: 0; } .course-details-outline { diff --git a/lms/templates/quiz/quiz.html b/lms/templates/quiz/quiz.html index 082f7d38..84caaf50 100644 --- a/lms/templates/quiz/quiz.html +++ b/lms/templates/quiz/quiz.html @@ -6,6 +6,15 @@ {{ _("This quiz consists of {0} questions.").format(quiz.questions | length) }} + {% if quiz.passing_percentage %} +
  • + {{ _("You will have to get {0}% correct answers in order to pass the quiz.").format(quiz.passing_percentage) }} +
    • +
  • + {{ _("Without passing the quiz you won't be able to complete the lesson.") }} +
    • + {% endif %} + {% if quiz.max_attempts %} {% set suffix = "times" if quiz.max_attempts > 1 else "time" %}
  • @@ -18,8 +27,7 @@ {{ _("The quiz has a time limit. For each question you will be given {0} seconds.").format(quiz.time) }}
    • {% endif %} - - +
    @@ -50,6 +58,9 @@
    +
    + {{ question.marks }} {{ _("Marks") }} +
    {{ _("Question ") }}{{ loop.index }}: {{ instruction }}
    diff --git a/lms/templates/quiz/quiz.js b/lms/templates/quiz/quiz.js index 1de0b05a..ed37a030 100644 --- a/lms/templates/quiz/quiz.js +++ b/lms/templates/quiz/quiz.js @@ -120,7 +120,6 @@ const enable_check = (e) => { const quiz_summary = (e = undefined) => { e && e.preventDefault(); let quiz_name = $("#quiz-title").data("name"); - let total_questions = $(".question").length; let self = this; frappe.call({ @@ -136,13 +135,16 @@ const quiz_summary = (e = undefined) => { $("#quiz-form").prepend( `
    ${__("Your score is")} ${data.message.score} - ${__("out of")} ${total_questions} + ${__("out of")} ${data.message.score_out_of}
    ` ); $("#try-again").attr("data-submission", data.message.submission); $("#try-again").removeClass("hide"); self.quiz_submitted = true; - if (this.hasOwnProperty("marked_as_complete")) { + if ( + this.hasOwnProperty("marked_as_complete") && + data.message.pass + ) { mark_progress(); } }, diff --git a/lms/www/assignment_submission/assignment_submission.py b/lms/www/assignment_submission/assignment_submission.py index 93ecb2f7..d1631a88 100644 --- a/lms/www/assignment_submission/assignment_submission.py +++ b/lms/www/assignment_submission/assignment_submission.py @@ -7,7 +7,7 @@ def get_context(context): context.no_cache = 1 if frappe.session.user == "Guest": - raise frappe.PermissionError(_("You don't have permission to access this page.")) + raise frappe.PermissionError(_("Please login to submit the assignment.")) context.is_moderator = has_course_moderator_role() submission = frappe.form_dict["submission"] diff --git a/lms/www/batch/edit.js b/lms/www/batch/edit.js index 65318ccc..13010356 100644 --- a/lms/www/batch/edit.js +++ b/lms/www/batch/edit.js @@ -429,9 +429,9 @@ class Quiz { } render_quiz(quiz) { - return `
    + return ` Quiz: ${quiz} -
    `; + `; } validate(savedData) { diff --git a/lms/www/batch/quiz.html b/lms/www/batch/quiz.html index ad302f78..6c829989 100644 --- a/lms/www/batch/quiz.html +++ b/lms/www/batch/quiz.html @@ -21,11 +21,12 @@
    {{ _("Questions") }}
    -
    +
    + @@ -109,7 +110,7 @@ {{ _("Show Answers") }} -
    - {% if quiz.name %} - - {% endif %} @@ -99,11 +86,23 @@ {{ _("Enter the maximum number of times a user can attempt this quiz") }}
    - {% set max_attempts = quiz.max_attempts if quiz.name else 1 %} + {% set max_attempts = quiz.max_attempts if quiz.name else 0 %}
    +
    +
    + {{ _("Passing Percentage") }} +
    +
    + {{ _("Minimum percentage required to pass this quiz.") }} +
    +
    + +
    +
    +
    {% set show_answers = quiz.show_answers or not quiz.name %}