ccs-digitalmarketplace-frameworks 3.0.2 → 3.1.0

package/README.md

@@ -85,7 +85,9 @@ Question keys
 * `dynamic_field` defines the field in the filter context that will be used to generate dynamic list questions (eg when passing
   a brief as filter context setting `dynamic_field` to `brief.niceToHaveRequirements` will generate questions for nice-to-have
   requirements) (only valid for `dynamic_list` questions)
-* `followup` is a dictionary where each key is the name of the question that will be required/shown and the value for the key is a list of question answers that should display the follow up (only valid for `boolean`, `radios` and `checkboxes` questions)
+* `followup` is a dictionary where each key is the name of the question that will be required/shown and the value for the key is a list of question answers that should display the follow up (only valid for `boolean`, `radios` and `checkboxes` questions). **Important** These questions appear on the same page as the parent question
+* `dependent_follow_up` is a dictionary where each key is the name of the question that will be required/shown and the value for the key is a list of question answers that should display the follow up (only valid for `boolean`, `radios` and `checkboxes` questions). **Important** These questions appear in a different section to the parent question and need a corresponding `depends_on_follow_up` to link the questions
+* `depends_on_follow_up` is a dictionary where each key is the name of the question this question depends on and the value is a list of values that will determine if it appears. **Important** These belong to a parent question and need a corresponding `dependent_followup` to link the questions
 
 
 Manifest files and section keys

package/frameworks/digital-outcomes-and-specialists-7/manifests/edit_service.yml

@@ -1,9 +1,3 @@
--
-  name: Research studio name
-  editable: True
-  questions:
-    - serviceName
-
 - name: Service essentials
   editable: False
   questions:
@@ -206,3 +200,14 @@
   editable: False
   questions:
     - outcomesLocations
+
+- name: User research services
+  editable: False
+  questions:
+    - whatUserResearchServices
+
+- name: User research participants essentials
+  editable: False
+  questions:
+    - userResearchParticipantsEssentialsRecruit
+    - userResearchParticipantsEssentialsManage

package/frameworks/digital-outcomes-and-specialists-7/manifests/edit_service_as_admin.yml

@@ -231,3 +231,14 @@
   editable: True
   questions:
     - outcomesLocations
+
+- name: User research services
+  editable: True
+  questions:
+    - whatUserResearchServices
+
+- name: User research participants essentials
+  editable: True
+  questions:
+    - userResearchParticipantsEssentialsRecruit
+    - userResearchParticipantsEssentialsManage

package/frameworks/digital-outcomes-and-specialists-7/manifests/edit_submission.yml

@@ -1,9 +1,3 @@
--
-  name: Research studio name
-  editable: True
-  questions:
-    - serviceName
-
 - name: Service essentials
   editable: True
   description: >
@@ -271,3 +265,14 @@
   editable: True
   questions:
     - outcomesLocations
+
+- name: User research services
+  editable: True
+  questions:
+    - whatUserResearchServices
+
+- name: User research participants essentials
+  editable: True
+  questions:
+    - userResearchParticipantsEssentialsRecruit
+    - userResearchParticipantsEssentialsManage

package/frameworks/digital-outcomes-and-specialists-7/questions/services/itOperationsRolesItServiceManagerHeadDayRate.yml

@@ -20,7 +20,7 @@ digit_limits:
 validations:
   - name: answer_required
     field: itOperationsRolesItServiceManagerHeadPriceMax
-    message: Enter the amount you will charge for a head of it service management
+    message: Enter the amount you will charge for a head of IT service management
   - name: not_money_format
     field: itOperationsRolesItServiceManagerHeadPriceMax
     message: Maximum price must be a number less than 10,000, without units, like 99.95

package/frameworks/digital-outcomes-and-specialists-7/questions/services/itOperationsRolesItServiceManagerHeadDayRateSpecialist.yml

@@ -20,7 +20,7 @@ digit_limits:
 validations:
   - name: answer_required
     field: itOperationsRolesItServiceManagerHeadPriceMax
-    message: Enter the amount you will charge for a head of it service management
+    message: Enter the amount you will charge for a head of IT service management
   - name: not_money_format
     field: itOperationsRolesItServiceManagerHeadPriceMax
     message: Maximum price must be a number less than 10,000, without units, like 99.95

package/frameworks/digital-outcomes-and-specialists-7/questions/services/itOperationsRolesItServiceManagerHeadLocations.yml

@@ -1,6 +1,6 @@
-name: Where will your head of it service management work?
+name: Where will your head of IT service management work?
 question: |
-  <p class="govuk-!-margin-bottom-2"><span class="govuk-fieldset__legend--s">Where will your head of it service management work?</span></p>
+  <p class="govuk-!-margin-bottom-2"><span class="govuk-fieldset__legend--s">Where will your head of IT service management work?</span></p>
   <p class="govuk-!-margin-bottom-0"><span class="govuk-fieldset__legend--s">Choose all the locations where the specialist can work at buyer’s sites, and whether they can work offsite.</span></p>
 hint: |
   ‘Offsite’ means the supplier will not be working at the buyer’s own sites.

package/frameworks/digital-outcomes-and-specialists-7/questions/services/itOperationsRolesItServiceManagerHeadUkDayRate.yml

@@ -20,7 +20,7 @@ digit_limits:
 validations:
   - name: answer_required
     field: itOperationsRolesItServiceManagerHeadUkPriceMax
-    message: Enter the amount you will charge for a head of it service management
+    message: Enter the amount you will charge for a head of IT service management
   - name: not_money_format
     field: itOperationsRolesItServiceManagerHeadUkPriceMax
     message: Maximum price must be a number less than 10,000, without units, like 99.95

package/frameworks/digital-outcomes-and-specialists-7/questions/services/itOperationsRolesItServiceManagerSeniorDayRate.yml

@@ -20,7 +20,7 @@ digit_limits:
 validations:
   - name: answer_required
     field: itOperationsRolesItServiceManagerSeniorPriceMax
-    message: Enter the amount you will charge for a senior it service manager
+    message: Enter the amount you will charge for a senior IT service manager
   - name: not_money_format
     field: itOperationsRolesItServiceManagerSeniorPriceMax
     message: Maximum price must be a number less than 10,000, without units, like 99.95

package/frameworks/digital-outcomes-and-specialists-7/questions/services/itOperationsRolesItServiceManagerSeniorDayRateSpecialist.yml

@@ -20,7 +20,7 @@ digit_limits:
 validations:
   - name: answer_required
     field: itOperationsRolesItServiceManagerSeniorPriceMax
-    message: Enter the amount you will charge for a senior it service manager
+    message: Enter the amount you will charge for a senior IT service manager
   - name: not_money_format
     field: itOperationsRolesItServiceManagerSeniorPriceMax
     message: Maximum price must be a number less than 10,000, without units, like 99.95

package/frameworks/digital-outcomes-and-specialists-7/questions/services/itOperationsRolesItServiceManagerSeniorLocations.yml

@@ -1,6 +1,6 @@
-name: Where will your senior it service manager work?
+name: Where will your senior IT service manager work?
 question: |
-  <p class="govuk-!-margin-bottom-2"><span class="govuk-fieldset__legend--s">Where will your senior it service manager work?</span></p>
+  <p class="govuk-!-margin-bottom-2"><span class="govuk-fieldset__legend--s">Where will your senior IT service manager work?</span></p>
   <p class="govuk-!-margin-bottom-0"><span class="govuk-fieldset__legend--s">Choose all the locations where the specialist can work at buyer’s sites, and whether they can work offsite.</span></p>
 hint: |
   ‘Offsite’ means the supplier will not be working at the buyer’s own sites.

package/frameworks/digital-outcomes-and-specialists-7/questions/services/itOperationsRolesItServiceManagerSeniorUkDayRate.yml

@@ -20,7 +20,7 @@ digit_limits:
 validations:
   - name: answer_required
     field: itOperationsRolesItServiceManagerSeniorUkPriceMax
-    message: Enter the amount you will charge for a senior it service manager
+    message: Enter the amount you will charge for a senior IT service manager
   - name: not_money_format
     field: itOperationsRolesItServiceManagerSeniorUkPriceMax
     message: Maximum price must be a number less than 10,000, without units, like 99.95

package/frameworks/digital-outcomes-and-specialists-7/questions/services/userResearchParticipantsEssentialsManage.yml

@@ -0,0 +1,22 @@
+name: Manage incentives to user research participants
+question: Do you agree to manage any incentives to user research participants?
+
+depends:
+  - "on": lot
+    being:
+      - user-research-studios-and-participants
+
+depends_on_follow_up:
+  whatUserResearchServices:
+    - user-research-participants
+
+type: checkboxes
+
+options:
+  - label: "Yes"
+    value: "yes"
+
+validations:
+  -
+    name: answer_required
+    message: Select if you agree to manage any incentives to user research participants

package/frameworks/digital-outcomes-and-specialists-7/questions/services/userResearchParticipantsEssentialsRecruit.yml

@@ -0,0 +1,22 @@
+name: Recruit participants without revealing details
+question: Can you, if asked, recruit participants without revealing details of the organisation you’re recruiting for?
+
+depends:
+  - "on": lot
+    being:
+      - user-research-studios-and-participants
+
+depends_on_follow_up:
+  whatUserResearchServices:
+    - user-research-participants
+
+type: checkboxes
+
+options:
+  - label: "Yes"
+    value: "yes"
+
+validations:
+  -
+    name: answer_required
+    message: Select if you can recruit participants without revealing details of the organisation you’re recruiting for

package/frameworks/digital-outcomes-and-specialists-7/questions/services/whatUserResearchServices.yml

@@ -0,0 +1,26 @@
+name: What services can you provide?
+question: What services can you provide?
+
+depends:
+  - "on": lot
+    being:
+      - user-research-studios-and-participants
+
+type: checkboxes
+
+options:
+  - label: "User research studios"
+    value: "user-research-studios"
+  - label: "User research participants"
+    value: "user-research-participants"
+
+dependent_follow_up:
+  userResearchParticipantsEssentialsRecruit:
+    - user-research-participants
+  userResearchParticipantsEssentialsManage:
+    - user-research-participants
+
+validations:
+  -
+    name: answer_required
+    message: You must select the services you can provide

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ccs-digitalmarketplace-frameworks",
-  "version": "3.0.2",
+  "version": "3.1.0",
   "description": "Data files for Digital Marketplace’s procurement frameworks",
   "repository": "git@github.com:Crown-Commercial-Service/ccs-digitalmarketplace-frameworks",
   "author": "enquiries@digitalmarketplace.service.gov.uk"

package/requirements-dev.txt

@@ -34,7 +34,7 @@ ccs-digitalmarketplace-apiclient==25.11.0
     # via
     #   -r requirements.txt
     #   ccs-digitalmarketplace-utils
-ccs-digitalmarketplace-content-loader==11.6.0
+ccs-digitalmarketplace-content-loader==11.7.0
     # via -r requirements.txt
 ccs-digitalmarketplace-utils==68.0.0
     # via

package/requirements.in

@@ -1,5 +1,5 @@
 docopt==0.6.2
 deepmerge==2.0
 python-json-logger==2.0.7
-ccs-digitalmarketplace-content-loader==11.6.0
+ccs-digitalmarketplace-content-loader==11.7.0
 ccs-digitalmarketplace-utils==68.0.0

package/requirements.txt

@@ -18,7 +18,7 @@ cachelib==0.13.0
     # via flask-session
 ccs-digitalmarketplace-apiclient==25.11.0
     # via ccs-digitalmarketplace-utils
-ccs-digitalmarketplace-content-loader==11.6.0
+ccs-digitalmarketplace-content-loader==11.7.0
     # via -r requirements.in
 ccs-digitalmarketplace-utils==68.0.0
     # via

package/schema_generator/validation.py

@@ -348,22 +348,41 @@ def uri_property(question):
     }}
 
 
+def has_dependent_follow_up(property_func):
+    """
+    Adds the additional dependent follow up schema to the property
+    """
+    def inner_func(question):
+        schema = property_func(question)
+        schema_addition = {}
+
+        if question.get('dependent_follow_up'):
+            schema_addition = _dependent_follow_up(question)
+
+        return schema, schema_addition
+
+    return inner_func
+
+
+@has_dependent_follow_up
 def checkbox_property(question):
     """
     Convert a checkbox question into JSON Schema.
     """
-    return {question['id']: {
-        "type": "array",
-        "uniqueItems": True,
-        "minItems": 0 if question.get('optional') else 1,
-        "maxItems": question.get('number_of_items', len(question['options'])),
-        "items": {
-            "enum": [
-                option.get('value', option['label'])
-                for option in question['options']
-            ]
+    return {
+        question['id']: {
+            "type": "array",
+            "uniqueItems": True,
+            "minItems": 0 if question.get('optional') else 1,
+            "maxItems": question.get('number_of_items', len(question['options'])),
+            "items": {
+                "enum": [
+                    option.get('value', option['label'])
+                    for option in question['options']
+                ]
+            }
         }
-    }}
+    }
 
 
 def checkbox_tree_property(question):
@@ -625,6 +644,45 @@ def _followup(question, root):
     return {'allOf': schemas}
 
 
+def _dependent_follow_up(question):
+    schemas = []
+    question_values = [
+        option.get('value', option['label'])
+        for option in question.options
+    ]
+    for dependent_follow_up_field, values in question["dependent_follow_up"].items():
+        non_dependent_question_values = [
+            value
+            for value in question_values
+            if value not in values
+        ]
+        should_not_have_followup = {
+            "items": {"enum": non_dependent_question_values}
+        }
+        should_have_followup = {
+            "not": {"items": {"enum": non_dependent_question_values}}
+        }
+
+        schemas.append({
+            'oneOf': [
+                {
+                    "properties": {
+                        question['id']: should_not_have_followup,
+                        dependent_follow_up_field: {"type": "null"}
+                    },
+                },
+                {
+                    "properties": {
+                        question['id']: should_have_followup,
+                    },
+                    "required": [dependent_follow_up_field]
+                },
+            ]
+        })
+
+    return {'allOf': schemas}
+
+
 def _flat_multiquestion(question):
     properties = {}
     for nested_question in question.questions:
@@ -825,8 +883,13 @@ def add_assurance(value_schema, assurance_approach):
 def build_question_properties(question):
     question_data = QUESTION_TYPES[question['type']](question)
     if question.get('assuranceApproach'):
-        for key, value_schema in question_data.items():
-            question_data[key] = add_assurance(value_schema, question['assuranceApproach'])
+        if isinstance(question_data, tuple):
+            for key, value_schema in question_data[0].items():
+                question_data[0][key] = add_assurance(value_schema, question['assuranceApproach'])
+        else:
+            for key, value_schema in question_data.items():
+                question_data[key] = add_assurance(value_schema, question['assuranceApproach'])
+
     return question_data
 
 
@@ -842,8 +905,13 @@ def build_schema_properties(schema, questions):
         property_schema = build_question_properties(question)
         if isinstance(property_schema, tuple):
             property_schema, schema_addition = property_schema
-            schema['properties'].update(property_schema)
-            schema = merge_schemas(schema, schema_addition)
+
+            if schema_addition:
+                schema['properties'].update(property_schema)
+                schema = merge_schemas(schema, schema_addition)
+            else:
+                schema['properties'].update(property_schema)
+                schema['required'].extend(question.required_form_fields)
         else:
             schema['properties'].update(property_schema)
             schema['required'].extend(question.required_form_fields)

package/schemas/questions.json

@@ -48,6 +48,11 @@
       "properties": {
         "type": {"enum": ["boolean", "radios", "checkboxes"]}
       }
+    },
+    "dependent_follow_up": {
+      "properties": {
+        "type": {"enum": ["checkboxes"]}
+      }
     }
   },
   "properties": {
@@ -321,6 +326,18 @@
         "^[a-zA-Z0-9]+$": {"type": "array"}
       }
     },
+    "dependent_follow_up": {
+      "type": "object",
+      "patternProperties": {
+        "^[a-zA-Z0-9]+$": {"type": "array"}
+      }
+    },
+    "depends_on_follow_up": {
+      "type": "object",
+      "patternProperties": {
+        "^[a-zA-Z0-9]+$": {"type": "array"}
+      }
+    },
     "dynamic_field": {
       "type": "string"
     },

package/tests/test_content.py

@@ -6,6 +6,7 @@ import pytest
 
 from dmcontent import ContentLoader
 from dmcontent.utils import TemplateField
+from dmcontent.questions import Multiquestion
 
 content = ContentLoader('./')
 
@@ -130,6 +131,35 @@ def test_render_question(framework, question_id, question_set, question):
                 )
 
 
+@pytest.mark.parametrize("framework, question_set, manifest", get_manifests())
+def test_dependent_follow_ups(framework, question_set, manifest):
+    content.load_manifest(framework, question_set, manifest)
+    loaded_content = content.get_manifest(framework, manifest)
+
+    questions_with_dependent_follow_up = {}
+    expected_questions_with_dependent_follow_up = {}
+
+    for section in loaded_content.sections:
+        for section_question in section.questions:
+            if isinstance(section_question, Multiquestion):
+                questions = section_question.get_questions_flat()
+            else:
+                questions = [section_question]
+
+            for question in questions:
+                if question.get("dependent_follow_up"):
+                    questions_with_dependent_follow_up[question.id] = question.get("dependent_follow_up")
+
+                for question_id, question_values in question.get("depends_on_follow_up", {}).items():
+                    if question_id not in expected_questions_with_dependent_follow_up:
+                        expected_questions_with_dependent_follow_up[question_id] = {}
+
+                    for field in question.form_fields:
+                        expected_questions_with_dependent_follow_up[question_id][field] = question_values
+
+    assert questions_with_dependent_follow_up == expected_questions_with_dependent_follow_up
+
+
 def strip_paragraph_wrapper(value):
     match = re.fullmatch(r"^(<p.*?>)(.+?)(</p>)", value)
     if match:

package/tests/test_generate_validation_schema.py

@@ -274,12 +274,14 @@ def test_checkbox_property(id, options):
         "id": id,
         "options": options
     }
-    result = checkbox_property(question)
+    result, additional_schema = checkbox_property(question)
     assert result[id]['minItems'] == 1
+    assert additional_schema == {}
 
     question['optional'] = True
-    result = checkbox_property(question)
+    result, additional_schema = checkbox_property(question)
     assert result[id]['minItems'] == 0
+    assert additional_schema == {}
 
     enum = result[id]['items']['enum']
     assert len(enum) == len(options)
@@ -289,6 +291,88 @@ def test_checkbox_property(id, options):
                for option in options if 'value' not in option)
 
 
+def test_checkbox_property_with_dependent_follow_up():
+    options = [
+        {"value": "1", "label": "One"},
+        {"label": "Two"},
+        {"value": "3", "label": "Three"}
+    ]
+
+    question = ContentQuestion({
+        "id": "q1",
+        "options": options,
+        "dependent_follow_up": {
+            "a": [
+                "1",
+                "Two"
+            ],
+            "b": [
+                "Two",
+            ],
+            "c": [
+                "1",
+                "3"
+            ]
+        }
+    })
+    result, additional_schema = checkbox_property(question)
+    assert result['q1']['minItems'] == 1
+
+    enum = result['q1']['items']['enum']
+    assert len(enum) == len(options)
+    assert all(option['value'] in enum
+               for option in options if 'value' in option)
+    assert all(option['label'] in enum
+               for option in options if 'value' not in option)
+
+    assert additional_schema == {
+        "allOf": [
+            {
+                "oneOf": [
+                    {
+                        "properties": {
+                            "q1": {"items": {"enum": ["3"]}},
+                            "a": {"type": "null"},
+                        }
+                    },
+                    {
+                        "properties": {"q1": {"not": {"items": {"enum": ["3"]}}}},
+                        "required": ["a"],
+                    },
+                ]
+            },
+            {
+                "oneOf": [
+                    {
+                        "properties": {
+                            "q1": {"items": {"enum": ["1", "3"]}},
+                            "b": {"type": "null"},
+                        }
+                    },
+                    {
+                        "properties": {"q1": {"not": {"items": {"enum": ["1", "3"]}}}},
+                        "required": ["b"],
+                    },
+                ]
+            },
+            {
+                "oneOf": [
+                    {
+                        "properties": {
+                            "q1": {"items": {"enum": ["Two"]}},
+                            "c": {"type": "null"},
+                        }
+                    },
+                    {
+                        "properties": {"q1": {"not": {"items": {"enum": ["Two"]}}}},
+                        "required": ["c"],
+                    },
+                ]
+            },
+        ]
+    }
+
+
 @settings(suppress_health_check=[HealthCheck.too_slow])
 @given(st.text(), nested_checkboxes_list(), st.integers(min_value=1))
 def test_checkbox_tree_property(id, options, number_of_items):