Feat/generate certificate management command #86

jbpenrath · 2022-03-18T17:08:27Z

Purpose

Now that we are able to retrieve enrollment grade from LMS, we need to be able to generate certificates.
The purpose of this pull request is to add a management command to generate certificate at regular interval through a cron task but also to allow staff users to generate certificates on demand through custom admin actions.

Furthermore, staff users are able to flag course runs as gradable in order to prevent certificate generation.

We added actions to generate certificates into three models (Product, Course and Order). So in this way, staff users are able to generate certificates for:

one or several orders

one or several products

one or several courses

a course - product couple

Proposal

Improve CourseRun model to mark a course run as gradable
Create a management command to generate all certificates available

Related issue: #75

src/backend/joanie/core/admin.py

src/backend/joanie/core/models/products.py

src/backend/joanie/core/management/commands/create_certificates.py

src/backend/joanie/core/admin.py

sampaccoud · 2022-03-31T05:28:17Z

src/backend/joanie/core/admin.py

+        """
+        codes = [course.code for course in queryset]
+        certificate_generated_count = management.call_command(
+            "create_certificates", courses=codes


I don't think it should be done like this... especially as the list of codes may be big. I would be better to factorize the code in a function that can be called by your command and by this function?

Let's try to resume your thought just to be sure I understand your request.

Do you mean, I should not use call_command here but create a function that I'll call here and within the management command?

Then instead to pass a long list of course codes as arguments, I could iterate over selected courses?

About this point, I could write something like this

certificate_generated_count = 0 for course in queryset.iterator(): certificate_generated_count += management.call_command("create_certificates", courses=course.code) summarize_certification_to_user(request, certificate_generated_count)

yes that's what I meant but that's not what you proposed in the second part of your answer? 🤔

Sorry, I misspoke. The code suggestion was only about my second point :

Then instead to pass a long list of course codes as arguments, I could iterate over selected courses?

But I'm not quit sure to understand why I should not use the management command here.

So I create an helpers module with two methods generate_certificate_for_order and generate_certificates_for_orders.

src/backend/joanie/core/admin.py

sampaccoud · 2022-03-31T06:36:25Z

src/backend/joanie/core/management/commands/create_certificates.py

+        course_runs = models.CourseRun.objects.filter(
+            course__in=graded_courses,
+            is_gradable=True,
+            start__lte=timezone.now(),


or end_lte? I don't think we want to grade before the end of the course?

From my point of view, the is_gradable flag should mediate this question. If a course leader wants to allow certification before the end of the course, he could and if he wants to wait the end of the course, he just has to update is_gradable once the course ended.

sampaccoud · 2022-03-31T06:39:25Z

src/backend/joanie/core/management/commands/create_certificates.py

+        )
+
+        enrollments = order.enrollments.filter(
+            course_run__in=course_runs, is_active=True


there is a small trick here: you say "generate for order" but you may select enrollments here that are related to other orders staging the same course run... 🤔 Add a filter clause and a test if I'm right?

I'm using order.enrollments so there is no risk to get enrollment related to other order, nope?

src/backend/joanie/core/management/commands/create_certificates.py

src/backend/joanie/core/admin.py

src/backend/joanie/core/helpers.py

src/backend/joanie/core/management/commands/create_certificates.py

src/backend/joanie/core/admin.py

src/backend/joanie/core/helpers.py

sampaccoud · 2022-04-07T06:09:25Z

src/backend/joanie/tests/test_helpers.py

+        course_run.course.product_relations.update(is_graded=False)
+        course = factories.CourseFactory(products=[product])
+        order = factories.OrderFactory(product=product, course=course)
+        certificate = models.Certificate.objects.filter(order=order)


I think it shouldn't be called certificate when it's a query. Same for other occurences in other test files.

I renamed it certificate_qs

src/backend/joanie/tests/test_helpers.py

src/backend/joanie/tests/test_models_enrollment.py

Makefile

This boolean field allow a course leader to mark its session as gradable. Gradable course runs can be used to generate a certificate.

This property is a shortcut which retrieve the enrollment grade from its related LMS then check if it is passed. To prevent to spam LMS, the setting `JOANIE_ENROLLMENT_GRADE_CACHE_TTL` is used to store grade state in cache. By default, for 10 minutes.

Create a management command which aims to be called by a cron task to generate certificate at a regular interval. This command accepts three options (course, product and order) to restrict review to those resources.

django-object-actions allows us to add custom actions with admin change views.

Create custom actions across all relevant models (products, course and orders) to generate certificates through the bunch of provided resources.

jbpenrath added feature work in progress labels Mar 18, 2022

jbpenrath self-assigned this Mar 18, 2022

sampaccoud reviewed Mar 21, 2022

View reviewed changes

jbpenrath force-pushed the feat/generate-certificate-management-command branch from b263e8f to ee222fe Compare March 29, 2022 14:48

jbpenrath added this to the GRADEO milestone Mar 29, 2022

jbpenrath force-pushed the feat/generate-certificate-management-command branch from ee222fe to 7005e52 Compare March 29, 2022 15:03

jbpenrath requested a review from sampaccoud March 29, 2022 15:03

jbpenrath removed the work in progress label Mar 29, 2022

jbpenrath force-pushed the feat/generate-certificate-management-command branch from 7005e52 to 46249d8 Compare March 29, 2022 15:26

sampaccoud reviewed Mar 31, 2022

View reviewed changes

jbpenrath force-pushed the feat/generate-certificate-management-command branch 2 times, most recently from f9784d9 to 4174c40 Compare April 1, 2022 13:41

jbpenrath requested a review from sampaccoud April 1, 2022 13:45

jbpenrath force-pushed the feat/generate-certificate-management-command branch from bc08ca4 to f1ece51 Compare April 1, 2022 14:52

sampaccoud reviewed Apr 5, 2022

View reviewed changes

jbpenrath requested a review from sampaccoud April 5, 2022 16:20

jbpenrath force-pushed the feat/generate-certificate-management-command branch 2 times, most recently from 190e16a to 42123af Compare April 6, 2022 08:05

sampaccoud reviewed Apr 7, 2022

View reviewed changes

jbpenrath requested a review from sampaccoud April 7, 2022 08:52

sampaccoud approved these changes Apr 7, 2022

View reviewed changes

Makefile Outdated Show resolved Hide resolved

jbpenrath force-pushed the feat/generate-certificate-management-command branch from 1714e42 to f4324e5 Compare April 7, 2022 09:16

jbpenrath added 4 commits April 7, 2022 11:16

🗃️(core) add is_gradable boolean field to CourseRun model

70aede8

This boolean field allow a course leader to mark its session as gradable. Gradable course runs can be used to generate a certificate.

✨(core) create a management command to generate certificates

771751e

Create a management command which aims to be called by a cron task to generate certificate at a regular interval. This command accepts three options (course, product and order) to restrict review to those resources.

➕(deps) install django-object-actions

5958c01

django-object-actions allows us to add custom actions with admin change views.

jbpenrath force-pushed the feat/generate-certificate-management-command branch from f4324e5 to 7cf84f4 Compare April 7, 2022 09:32

✨(admin) add custom actions to generate certificates

7620e67

Create custom actions across all relevant models (products, course and orders) to generate certificates through the bunch of provided resources.

jbpenrath force-pushed the feat/generate-certificate-management-command branch from 7cf84f4 to 7620e67 Compare April 7, 2022 09:36

jbpenrath merged commit c1c98ae into main Apr 7, 2022

jbpenrath deleted the feat/generate-certificate-management-command branch April 7, 2022 09:39

jbpenrath mentioned this pull request Apr 7, 2022

Generate certificate when all enrollment are passed #75

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat/generate certificate management command #86

Feat/generate certificate management command #86

jbpenrath commented Mar 18, 2022 •

edited

Loading

sampaccoud Mar 31, 2022

jbpenrath Mar 31, 2022

sampaccoud Mar 31, 2022

jbpenrath Mar 31, 2022

jbpenrath Apr 1, 2022

sampaccoud Mar 31, 2022

jbpenrath Mar 31, 2022

sampaccoud Mar 31, 2022

jbpenrath Apr 1, 2022

sampaccoud Apr 7, 2022

jbpenrath Apr 7, 2022

Feat/generate certificate management command #86

Feat/generate certificate management command #86

Conversation

jbpenrath commented Mar 18, 2022 • edited Loading

Purpose

one or several orders

one or several products

one or several courses

a course - product couple

Proposal

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jbpenrath commented Mar 18, 2022 •

edited

Loading