Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consolidate mastery criteria #3426

Merged
merged 6 commits into from
Jun 16, 2022
Merged

Consolidate mastery criteria #3426

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
011be89
standardize extra_fields
ozer550 Jun 7, 2022
c7a4c2b
Tests for completion_criteria
ozer550 Jun 11, 2022
878fc03
added proper tests for completion_criteria
ozer550 Jun 14, 2022
86bf229
removed extraneous print statement
ozer550 Jun 16, 2022
41b44f8
added extra mastrey_model condition
ozer550 Jun 16, 2022
23675f6
removed options from old format
ozer550 Jun 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 106 additions & 17 deletions contentcuration/contentcuration/tests/viewsets/test_contentnode.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
from django_concurrent_tests.helpers import make_concurrent_calls
from le_utils.constants import completion_criteria
from le_utils.constants import content_kinds
from le_utils.constants import exercises
from le_utils.constants import roles
from le_utils.constants.labels.accessibility_categories import ACCESSIBILITYCATEGORIESLIST
from le_utils.constants.labels.subjects import SUBJECTSLIST
Expand Down Expand Up @@ -587,36 +588,113 @@ def test_cannot_update_contentnode(self):
models.ContentNode.objects.get(id=contentnode.id).title, new_title
)

def test_update_contentnode_extra_fields(self):
def test_update_extra_fields_completion_criteria_set(self):
user = testdata.user()
contentnode = models.ContentNode.objects.create(**self.contentnode_db_metadata)
metadata = self.contentnode_db_metadata
metadata["extra_fields"] = {
"options": {
"threshold": {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This structure of threshold and model are new, so having those directly underneath options doesn't currently exist. What's your intent here-- to emulate the old/existing structure?

The old/existing structure should be:

        metadata["extra_fields"] = {
            "options": {
                "m": 3,
                "n": 6,
                "mastery_model": exercises.M_OF_N,
            }
        }

Since you added your consolidate_extra_fields to field_map, which is invoked during serialization of a content node, a good test would be to ensure that serializing a content node with the old mastery structure, like in a GET request, produces the new structure.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made a mistake here. The old format was at the top level of extra_fields, not extra_fields.options. So in your tests, the old data should be moved up a level, and a change to your consolidate function to match. I got hung up on the existence of threshold that you had previously, I missed that the old format wasn't inside options. My apologies!

"m": 3,
"n": 6,
"mastery_model": exercises.M_OF_N,
},
"model": completion_criteria.MASTERY,
}
}
contentnode = models.ContentNode.objects.create(**metadata)
self.client.force_authenticate(user=user)

# Update extra_fields.m
m = 5
response = self.client.post(
self.sync_url,
[generate_update_event(contentnode.id, CONTENTNODE, {
"extra_fields.options.completion_criteria.threshold.m": 4,
"extra_fields.options.completion_criteria.threshold.n": 8,
"extra_fields.options.completion_criteria.threshold.mastery_model": exercises.M_OF_N,
"extra_fields.options.completion_criteria.model": completion_criteria.MASTERY}
)],
format="json",
)

self.assertEqual(response.status_code, 200, response.content)
self.assertEqual(
models.ContentNode.objects.get(id=contentnode.id).extra_fields["options"]["completion_criteria"]["threshold"]["m"], 4
)
self.assertEqual(
models.ContentNode.objects.get(id=contentnode.id).extra_fields["options"]["completion_criteria"]["threshold"]["n"], 8
)

def test_update_extra_fields_completion_criteria_unset(self):
user = testdata.user()
metadata = self.contentnode_db_metadata
metadata["extra_fields"] = {
"m": 3,
"n": 5,
"mastery_model": exercises.M_OF_N,
}
contentnode = models.ContentNode.objects.create(**metadata)
self.client.force_authenticate(user=user)

response = self.client.post(
self.sync_url,
[generate_update_event(contentnode.id, CONTENTNODE, {"extra_fields.m": m})],
[generate_update_event(contentnode.id, CONTENTNODE, {
"extra_fields.options.completion_criteria.threshold.m": 4,
"extra_fields.options.completion_criteria.threshold.n": 6,
"extra_fields.options.completion_criteria.threshold.mastery_model": exercises.M_OF_N,
"extra_fields.options.completion_criteria.model": completion_criteria.MASTERY}
)],
format="json",
)

self.assertEqual(response.status_code, 200, response.content)

self.assertEqual(
models.ContentNode.objects.get(id=contentnode.id).extra_fields["m"], 3
)
self.assertEqual(
models.ContentNode.objects.get(id=contentnode.id).extra_fields["n"], 5
)
self.assertEqual(
models.ContentNode.objects.get(id=contentnode.id).extra_fields["mastery_model"], exercises.M_OF_N
)
self.assertEqual(
models.ContentNode.objects.get(id=contentnode.id).extra_fields["options"]["completion_criteria"]["threshold"]["m"], 4
)
self.assertEqual(
models.ContentNode.objects.get(id=contentnode.id).extra_fields["options"]["completion_criteria"]["threshold"]["n"], 6
)
self.assertEqual(
models.ContentNode.objects.get(id=contentnode.id).extra_fields["m"], m
models.ContentNode.objects.get(id=contentnode.id).extra_fields["options"]["completion_criteria"]["threshold"]["mastery_model"], exercises.M_OF_N
)
self.assertEqual(
models.ContentNode.objects.get(id=contentnode.id).extra_fields["options"]["completion_criteria"]["model"], completion_criteria.MASTERY
)

def test_update_contentnode_extra_fields(self):
user = testdata.user()
contentnode = models.ContentNode.objects.create(**self.contentnode_db_metadata)

# Update extra_fields.m
# Update m and n fields
m = 5
n = 10
self.client.force_authenticate(user=user)

response = self.client.post(
self.sync_url,
[generate_update_event(contentnode.id, CONTENTNODE, {"extra_fields.n": n})],
[generate_update_event(contentnode.id, CONTENTNODE, {
"extra_fields.options.completion_criteria.threshold.m": m,
"extra_fields.options.completion_criteria.threshold.n": n,
"extra_fields.options.completion_criteria.threshold.mastery_model": exercises.M_OF_N,
"extra_fields.options.completion_criteria.model": completion_criteria.MASTERY}
)],
format="json",
)

self.assertEqual(response.status_code, 200, response.content)
self.assertEqual(
models.ContentNode.objects.get(id=contentnode.id).extra_fields["m"], m
models.ContentNode.objects.get(id=contentnode.id).extra_fields["options"]["completion_criteria"]["threshold"]["m"], m
)
self.assertEqual(
models.ContentNode.objects.get(id=contentnode.id).extra_fields["n"], n
models.ContentNode.objects.get(id=contentnode.id).extra_fields["options"]["completion_criteria"]["threshold"]["n"], n
)

# Update extra_fields.randomize
Expand All @@ -628,10 +706,10 @@ def test_update_contentnode_extra_fields(self):
)
self.assertEqual(response.status_code, 200, response.content)
self.assertEqual(
models.ContentNode.objects.get(id=contentnode.id).extra_fields["m"], m
models.ContentNode.objects.get(id=contentnode.id).extra_fields["options"]["completion_criteria"]["threshold"]["m"], m
)
self.assertEqual(
models.ContentNode.objects.get(id=contentnode.id).extra_fields["n"], n
models.ContentNode.objects.get(id=contentnode.id).extra_fields["options"]["completion_criteria"]["threshold"]["n"], n
)
self.assertEqual(
models.ContentNode.objects.get(id=contentnode.id).extra_fields["randomize"], randomize
Expand All @@ -641,19 +719,30 @@ def test_update_contentnode_remove_from_extra_fields(self):
user = testdata.user()
metadata = self.contentnode_db_metadata
metadata["extra_fields"] = {
"m": 5,
"options": {
"threshold": {
"m": 5,
"n": None,
"mastery_model": exercises.M_OF_N,
},
"model": completion_criteria.MASTERY,
}
}
contentnode = models.ContentNode.objects.create(**metadata)
self.client.force_authenticate(user=user)
# Remove extra_fields.m
# Remove m from extra_fields
response = self.client.post(
self.sync_url,
[generate_update_event(contentnode.id, CONTENTNODE, {"extra_fields.m": None})],
[generate_update_event(contentnode.id, CONTENTNODE, {
"extra_fields.options.completion_criteria.threshold.m": None,
"extra_fields.options.completion_criteria.threshold.n": None,
"extra_fields.options.completion_criteria.threshold.mastery_model": exercises.M_OF_N,
"extra_fields.options.completion_criteria.model": completion_criteria.MASTERY}
)],
format="json",
)
self.assertEqual(response.status_code, 200, response.content)
with self.assertRaises(KeyError):
models.ContentNode.objects.get(id=contentnode.id).extra_fields["m"]
self.assertEqual(models.ContentNode.objects.get(id=contentnode.id).extra_fields["options"]["completion_criteria"]["threshold"]["m"], None)

def test_update_contentnode_add_to_extra_fields_nested(self):
user = testdata.user()
Expand Down
1 change: 1 addition & 0 deletions contentcuration/contentcuration/utils/db_tools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,7 @@ def create_exercise(title, parent, license_id, description="", user=None, empty=
"m": 3,
"n": 5,
}

exercise = ContentNode.objects.create(
title=title,
description=description,
Expand Down
36 changes: 26 additions & 10 deletions contentcuration/contentcuration/viewsets/contentnode.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
from django_cte import CTEQuerySet
from django_filters.rest_framework import CharFilter
from django_filters.rest_framework import UUIDFilter
from le_utils.constants import completion_criteria
from le_utils.constants import content_kinds
from le_utils.constants import exercises
from le_utils.constants import roles
from le_utils.constants.labels import accessibility_categories
from le_utils.constants.labels import learning_activities
Expand All @@ -35,7 +35,7 @@
from rest_framework.serializers import CharField
from rest_framework.serializers import ChoiceField
from rest_framework.serializers import DictField
from rest_framework.serializers import IntegerField
from rest_framework.serializers import Field
from rest_framework.serializers import ValidationError
from rest_framework.viewsets import ViewSet

Expand Down Expand Up @@ -254,15 +254,15 @@ def update(self, queryset, all_validated_data):
return all_objects


class ThresholdField(CharField):
class ThresholdField(Field):
bjester marked this conversation as resolved.
Show resolved Hide resolved
def to_representation(self, value):
return value

def to_internal_value(self, data):
data = super(ThresholdField, self).to_internal_value(data)
try:
print(data)
bjester marked this conversation as resolved.
Show resolved Hide resolved
data = int(data)
except ValueError:
except(ValueError, TypeError):
pass
return data

Expand All @@ -287,12 +287,7 @@ class ExtraFieldsOptionsSerializer(JSONFieldDictSerializer):


class ExtraFieldsSerializer(JSONFieldDictSerializer):
mastery_model = ChoiceField(
choices=exercises.MASTERY_MODELS, allow_null=True, required=False
)
randomize = BooleanField()
m = IntegerField(allow_null=True, required=False)
n = IntegerField(allow_null=True, required=False)
options = ExtraFieldsOptionsSerializer(required=False)


Expand Down Expand Up @@ -455,6 +450,26 @@ def get_title(item):
return item["title"] if item["parent_id"] else item["original_channel_name"]


def consolidate_extra_fields(item):
extra_fields = item.get("extra_fields")
if item["kind"] == content_kinds.EXERCISE:
m = extra_fields.pop("m", None)
n = extra_fields.pop("n", None)
mastery_model = extra_fields.pop("mastery_model", None)
if not extra_fields.get("options", {}).get("completion_criteria", {}):
rtibbles marked this conversation as resolved.
Show resolved Hide resolved
extra_fields["options"] = extra_fields.get("options", {})
extra_fields["options"]["completion_criteria"] = {
"threshold": {
"m": m,
"n": n,
"mastery_model": mastery_model,
},
"model": completion_criteria.MASTERY,
}

return extra_fields


class PrerequisitesUpdateHandler(ViewSet):
"""
Dummy viewset for handling create and delete changes for prerequisites
Expand Down Expand Up @@ -683,6 +698,7 @@ class ContentNodeViewSet(BulkUpdateMixin, ChangeEventMixin, ValuesViewset):
"accessibility_labels": partial(dict_if_none, field_name="accessibility_labels"),
"categories": partial(dict_if_none, field_name="categories"),
"learner_needs": partial(dict_if_none, field_name="learner_needs"),
"extra_fields": consolidate_extra_fields,
}

def _annotate_channel_id(self, queryset):
Expand Down