Add labels to User and Project metadata

kobo/settings/base.py

@@ -274,36 +274,48 @@
     ),
     'USER_METADATA_FIELDS': (
         json.dumps([
-            {'name': 'organization', 'required': False},
-            {'name': 'organization_website', 'required': False},
-            {'name': 'sector', 'required': False},
-            {'name': 'gender', 'required': False},
-            {'name': 'bio', 'required': False},
-            {'name': 'city', 'required': False},
-            {'name': 'country', 'required': False},
-            {'name': 'twitter', 'required': False},
-            {'name': 'linkedin', 'required': False},
-            {'name': 'instagram', 'required': False},
+            {'name': 'full_name', 'required': False,},
+            {'name': 'organization', 'required': False,},
+            {'name': 'organization_website', 'required': False,},
+            {'name': 'sector', 'required': False,},
+            {'name': 'gender', 'required': False,},
+            {'name': 'bio', 'required': False,},
+            {'name': 'city', 'required': False,},
+            {'name': 'country', 'required': False,},
+            {'name': 'twitter', 'required': False,},
+            {'name': 'linkedin', 'required': False,},
+            {'name': 'instagram', 'required': False,},
         ]),
         # The available fields are hard-coded in the front end
         'Display (and optionally require) these metadata fields for users. '
-        "Possible fields are 'organization', 'organization_website', "
+        "Possible fields are 'full_name', 'organization', 'organization_website', "
         "'sector', 'gender', 'bio', 'city', 'country', 'twitter', 'linkedin', "
-        "and 'instagram'",
+        "and 'instagram'.\n\r"
+        "To add another language, use 'some-other-language' as an example.",
         # Use custom field for schema validation
         'metadata_fields_jsonschema'
     ),
     'PROJECT_METADATA_FIELDS': (
         json.dumps([
-            {'name': 'sector', 'required': False},
-            {'name': 'country', 'required': False},
-            # {'name': 'operational_purpose', 'required': False},
-            # {'name': 'collects_pii', 'required': False},
+            {'name': 'sector', 'required': False, 'label': {
+                'default': 'Sector',
+                'some-other-language': (
+                    'This is an example and will never display because some-other-language '
+                    'is not a valid language code.'
+                ),
+            },},
+            {'name': 'country', 'required': False, 'label': {'default': 'Country'},},
+            # {'name': 'description', 'required': False, 'label': {'default': 'Description'},},
+            # {'name': 'operational_purpose', 'required': False, 'label': 
+            #     {'default': 'Operational Purpose'},
+            # },
+            # {'name': 'collects_pii', 'required': False, 'label': {'default': 'Collects PII'},},
         ]),
         # The available fields are hard-coded in the front end
         'Display (and optionally require) these metadata fields for projects. '
-        "Possible fields are 'sector', 'country', 'operational_purpose', and "
-        "'collects_pii'.",
+        "Possible fields are 'sector', 'country', 'operational_purpose', "
+        "'collects_pii', and 'description'\n\r"
+        "To add another language, use 'some-other-language' as an example.",
         # Use custom field for schema validation
         'metadata_fields_jsonschema'
     ),

kpi/fields/jsonschema_form_field.py

@@ -55,8 +55,22 @@ class MetadataFieldsListField(JsonSchemaFormField):
     Validates that the input is an array of objects with "name" and "required"
     properties, e.g.
         [
-            {"name": "important_field", "required": true},
-            {"name": "whatever_field", "required": false},
+            {
+                "name": "important_field", 
+                "required": true,
+                "label": {
+                    "default": "Important Field",
+                    "fr": "Champ important"
+                }
+            },
+            {
+                "name": "whatever_field", 
+                "required": false,
+                "label": {
+                    "default": "Whatever Field",
+                    "fr": "Champ whatever"
+                }
+            },
             …
         ]
     """
@@ -66,11 +80,20 @@ def __init__(self, *args, **kwargs):
             'uniqueItems': True,
             'items': {
                 'type': 'object',
-                'required': ['name', 'required'],
+                'required': ['name', 'required',],
                 'additionalProperties': False,
                 'properties': {
-                    'name': {'type': 'string'},
-                    'required': {'type': 'boolean'},
+                    'name': {'type': 'string',},
+                    'required': {'type': 'boolean',},
+                    'label': {
+                        'type': 'object',
+                        'uniqueItems': True,
+                        'properties': {
+                            'default': {'type': 'string',},
+                        },
+                        'required': ['default',],
+                        'additionalProperties': True,
+                    }
                 },
             },
         }

kpi/tests/api/test_api_environment.py

@@ -103,6 +103,24 @@ def test_template_context_processor(self):
         result = template.render(context)
         self.assertEqual(result, constance.config.TERMS_OF_SERVICE_URL)
 
+    def test_metadata_label_with_default_language(self):
+        """
+        Test that the label field of the user and project metadata contains a default value
+        """
+        def check_metadata_for_label(metadata):
+            for item in metadata:
+                if 'label' in item.keys():
+                    assert 'default' in item['label'].keys()
+
+        self.client.logout()
+        response = self.client.get(self.url, format='json')
+        assert response.status_code == status.HTTP_200_OK
+        user_metadata = response.data['user_metadata_fields']
+        project_metadata = response.data['project_metadata_fields']
+        check_metadata_for_label(user_metadata)
+        check_metadata_for_label(project_metadata)        
+
+
     @override_config(MFA_ENABLED=True)
     def test_mfa_value_globally_enabled(self):
         self.client.login(username='someuser', password='someuser')