Merge pull request #3407 from rtibbles/internal_metadata

Add support to ricecooker endpoint for metadata labels.

Author: rtibbles

contentcuration/contentcuration/tests/views/test_views_internal.py

@@ -8,6 +8,12 @@
 from django.db import connections
 from django.urls import reverse_lazy
 from le_utils.constants import format_presets
+from le_utils.constants.labels.accessibility_categories import ACCESSIBILITYCATEGORIESLIST
+from le_utils.constants.labels.learning_activities import LEARNINGACTIVITIESLIST
+from le_utils.constants.labels.levels import LEVELSLIST
+from le_utils.constants.labels.needs import NEEDSLIST
+from le_utils.constants.labels.resource_type import RESOURCETYPELIST
+from le_utils.constants.labels.subjects import SUBJECTSLIST
 from mixer.main import mixer
 from mock import patch
 from rest_framework.test import APIClient
@@ -44,6 +50,16 @@ class SampleContentNodeDataSchema:
     copyright_holder = str
 
 
+METADATA = {
+    "grade_levels": LEVELSLIST,
+    "resource_types": RESOURCETYPELIST,
+    "learning_activities": LEARNINGACTIVITIESLIST,
+    "accessibility_labels": ACCESSIBILITYCATEGORIESLIST,
+    "categories": SUBJECTSLIST,
+    "learner_needs": NEEDSLIST,
+}
+
+
 class ApiAddNodesToTreeTestCase(StudioTestCase):
     """
     Tests for contentcuration.views.internal.api_add_nodes_to_tree function.
@@ -110,13 +126,19 @@ def setUp(self):
         invalid_copyright_holder["title"] = "invalid_copyright_holder"
         invalid_copyright_holder["copyright_holder"] = ""
 
+        valid_metadata_labels = self._make_node_data()
+        valid_metadata_labels["title"] = "valid_metadata_labels"
+        for label, values in METADATA.items():
+            valid_metadata_labels[label] = [values[0]]
+
         self.sample_data = {
             "root_id": self.root_node.id,
             "content_data": [
                 valid_node,
                 invalid_title_node,
                 invalid_license_description,
                 invalid_copyright_holder,
+                valid_metadata_labels,
             ],
         }
         self.resp = self.admin_client().post(
@@ -166,6 +188,13 @@ def test_associates_file_with_created_node(self):
         # our original file object
         assert f.file_on_disk.read() == self.fileobj.file_on_disk.read()
 
+    def test_metadata_properly_created(self):
+        node = ContentNode.objects.get(title="valid_metadata_labels")
+        for label, values in METADATA.items():
+            self.assertEqual(getattr(node, label), {
+                values[0]: True
+            })
+
     def test_invalid_nodes_are_not_complete(self):
         node_0 = ContentNode.objects.get(title=self.title)
         node_1 = ContentNode.objects.get(description="invalid_title_node")
@@ -196,6 +225,24 @@ def test_tag_greater_than_30_chars_excluded(self):
 
         self.assertEqual(response.status_code, 400, response.content)
 
+    def test_invalid_metadata_label_excluded(self):
+        invalid_metadata_labels = self._make_node_data()
+        invalid_metadata_labels["title"] = "invalid_metadata_labels"
+        invalid_metadata_labels["categories"] = ["not a label!"]
+
+        test_data = {
+            "root_id": self.root_node.id,
+            "content_data": [
+                invalid_metadata_labels,
+            ],
+        }
+
+        response = self.admin_client().post(
+            reverse_lazy("api_add_nodes_to_tree"), data=test_data, format="json"
+        )
+
+        self.assertEqual(response.status_code, 400, response.content)
+
 
 class ApiAddExerciseNodesToTreeTestCase(StudioTestCase):
     """

contentcuration/contentcuration/views/internal.py

@@ -16,6 +16,12 @@
 from django.http import JsonResponse
 from le_utils.constants import content_kinds
 from le_utils.constants import roles
+from le_utils.constants.labels.accessibility_categories import ACCESSIBILITYCATEGORIESLIST
+from le_utils.constants.labels.learning_activities import LEARNINGACTIVITIESLIST
+from le_utils.constants.labels.levels import LEVELSLIST
+from le_utils.constants.labels.needs import NEEDSLIST
+from le_utils.constants.labels.resource_type import RESOURCETYPELIST
+from le_utils.constants.labels.subjects import SUBJECTSLIST
 from past.builtins import basestring
 from raven.contrib.django.raven_compat.models import client
 from rest_framework import status
@@ -66,7 +72,7 @@
 )
 
 
-class NodeValidationError(Exception):
+class NodeValidationError(ValidationError):
     pass
 
 
@@ -598,6 +604,16 @@ def convert_data_to_nodes(user, content_data, parent_node):
         raise ObjectDoesNotExist("Error creating node: {0}".format(e))
 
 
+METADATA = {
+    "grade_levels": set(LEVELSLIST),
+    "resource_types": set(RESOURCETYPELIST),
+    "learning_activities": set(LEARNINGACTIVITIESLIST),
+    "accessibility_labels": set(ACCESSIBILITYCATEGORIESLIST),
+    "categories": set(SUBJECTSLIST),
+    "learner_needs": set(NEEDSLIST),
+}
+
+
 def create_node(node_data, parent_node, sort_order):  # noqa: C901
     """ Generate node based on node dict """
     # Make sure license is valid
@@ -632,6 +648,18 @@ def create_node(node_data, parent_node, sort_order):  # noqa: C901
         if license.copyright_holder_required:
             is_complete &= copyright_holder != ""
 
+    metadata_labels = {}
+
+    for label, valid_values in METADATA.items():
+        if label in node_data:
+            if type(node_data[label]) is not list:
+                raise NodeValidationError("{} must pass a list of values".format(label))
+            metadata_labels[label] = {}
+            for value in node_data[label]:
+                if value not in valid_values:
+                    raise NodeValidationError("{} is not a valid value for {}".format(value, label))
+                metadata_labels[label][value] = True
+
     node = ContentNode.objects.create(
         title=title,
         tree_id=parent_node.tree_id,
@@ -654,6 +682,7 @@ def create_node(node_data, parent_node, sort_order):  # noqa: C901
         freeze_authoring_data=True,
         role_visibility=node_data.get('role') or roles.LEARNER,
         complete=is_complete,
+        **metadata_labels
     )
 
     tags = []