ccs-digitalmarketplace-frameworks 3.0.3 → 3.2.0

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/whatTypesOfUserResearchStudio.yml

@@ -0,0 +1,24 @@
+name: What types of user research studio can you provide?
+question: What types of user research studio can you provide?
+
+depends:
+  - "on": lot
+    being:
+      - user-research-studios-and-participants
+
+type: checkboxes
+
+options:
+  - label: "Virtual studio"
+    value: "virtual-studio"
+  - label: "Physical location"
+    value: "physical-location"
+
+depends_on_follow_up:
+  whatUserResearchServices:
+    - user-research-studios
+
+validations:
+  -
+    name: answer_required
+    message: You must select the types of user research studio can you provide

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

@@ -0,0 +1,46 @@
+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
+  mrsMember:
+    - user-research-participants
+  otherTradeOrIndustryBodies:
+    - user-research-participants
+  rasAccredited:
+    - user-research-participants
+  useRasAccreditedSubcontractors:
+    - user-research-participants
+  complyWithMrsCodeOfConduct:
+    - user-research-participants
+  icoRegistered:
+    - user-research-participants
+  whatTypesOfUserResearchStudio:
+    - user-research-studios
+
+dependent_follow_up_followup:
+  otherTradeOrIndustryBodiesOther:
+    - user-research-participants
+  icoRegistrationReference:
+    - 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.3",
+  "version": "3.2.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.10.0
     # via -r requirements.txt
 ccs-digitalmarketplace-utils==68.0.0
     # via
@@ -115,7 +115,7 @@ govuk-country-register==0.5.0
     # via
     #   -r requirements.txt
     #   ccs-digitalmarketplace-utils
-hypothesis==6.112.4
+hypothesis==6.115.0
     # via -r requirements-dev.in
 idna==3.7
     # 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.10.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.10.0
     # via -r requirements.in
 ccs-digitalmarketplace-utils==68.0.0
     # via

package/schema_generator/validation.py

@@ -280,7 +280,8 @@ def load_questions(schema_type, framework_slug, lot_slug_or_agreement_version):
 
     manifest = loader.get_manifest(framework_slug, MANIFESTS[schema_type]['manifest']).filter(
         {filter_key: lot_slug_or_agreement_version},
-        dynamic=False
+        dynamic=False,
+        ignore_depends_on_follow_up=True
     )
 
     return {q['id']: q for q in sum((s.questions for s in manifest.sections), [])}
@@ -348,22 +349,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 +645,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:
@@ -666,7 +725,7 @@ def _nested_multiquestion(question):
 
 
 def _flat_multiquestion_required(question):
-    if question.get('optional'):
+    if question.get('optional') or question.get('depends_on_follow_up'):
         return []
 
     return _nested_multiquestion_required(question)
@@ -825,8 +884,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
 
 
@@ -843,10 +907,18 @@ def build_schema_properties(schema, questions):
         if isinstance(property_schema, tuple):
             property_schema, schema_addition = property_schema
             schema['properties'].update(property_schema)
-            schema = merge_schemas(schema, schema_addition)
+
+            if (
+                not schema_addition or question.get('dependent_follow_up')
+            ) and not question.get('depends_on_follow_up'):
+                schema['required'].extend(question.required_form_fields)
+
+            if schema_addition:
+                schema = merge_schemas(schema, schema_addition)
         else:
             schema['properties'].update(property_schema)
-            schema['required'].extend(question.required_form_fields)
+            if not question.get('depends_on_follow_up'):
+                schema['required'].extend(question.required_form_fields)
 
     schema['required'].sort()
 

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,24 @@
         "^[a-zA-Z0-9]+$": {"type": "array"}
       }
     },
+    "dependent_follow_up": {
+      "type": "object",
+      "patternProperties": {
+        "^[a-zA-Z0-9]+$": {"type": "array"}
+      }
+    },
+    "dependent_follow_up_followup": {
+      "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,48 @@ 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 = {}
+    questions_with_dependent_follow_up_followup = {}
+    expected_questions_with_dependent_follow_up = {}
+    expected_questions_with_dependent_follow_up_followup = {}
+
+    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")
+                if question.get("dependent_follow_up_followup"):
+                    questions_with_dependent_follow_up_followup[question.id] = \
+                        question.get("dependent_follow_up_followup")
+
+                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
+
+                    for fllowup_question_id in question.get('followup', {}).keys():
+                        if question_id not in expected_questions_with_dependent_follow_up_followup:
+                            expected_questions_with_dependent_follow_up_followup[question_id] = {}
+
+                        expected_questions_with_dependent_follow_up_followup[question_id][fllowup_question_id] = \
+                            question_values
+
+    assert questions_with_dependent_follow_up == expected_questions_with_dependent_follow_up
+    assert questions_with_dependent_follow_up_followup == expected_questions_with_dependent_follow_up_followup
+
+
 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):

package/assets/style.css

@@ -1,186 +0,0 @@
-body {
-  font-family: Helvetica, Arial, sans-serif;
-  font-size: 12px;
-  /* do not increase min-width as some may use split screens */
-  min-width: 800px;
-  color: #999;
-}
-
-h1 {
-  font-size: 24px;
-  color: black;
-}
-
-h2 {
-  font-size: 16px;
-  color: black;
-}
-
-p {
-  color: black;
-}
-
-a {
-  color: #999;
-}
-
-table {
-  border-collapse: collapse;
-}
-
-/******************************
- * SUMMARY INFORMATION
- ******************************/
-#environment td {
-  padding: 5px;
-  border: 1px solid #E6E6E6;
-}
-#environment tr:nth-child(odd) {
-  background-color: #f6f6f6;
-}
-
-/******************************
- * TEST RESULT COLORS
- ******************************/
-span.passed,
-.passed .col-result {
-  color: green;
-}
-
-span.skipped,
-span.xfailed,
-span.rerun,
-.skipped .col-result,
-.xfailed .col-result,
-.rerun .col-result {
-  color: orange;
-}
-
-span.error,
-span.failed,
-span.xpassed,
-.error .col-result,
-.failed .col-result,
-.xpassed .col-result {
-  color: red;
-}
-
-/******************************
- * RESULTS TABLE
- *
- * 1. Table Layout
- * 2. Extra
- * 3. Sorting items
- *
- ******************************/
-/*------------------
- * 1. Table Layout
- *------------------*/
-#results-table {
-  border: 1px solid #e6e6e6;
-  color: #999;
-  font-size: 12px;
-  width: 100%;
-}
-#results-table th,
-#results-table td {
-  padding: 5px;
-  border: 1px solid #E6E6E6;
-  text-align: left;
-}
-#results-table th {
-  font-weight: bold;
-}
-
-/*------------------
- * 2. Extra
- *------------------*/
-.log {
-  background-color: #e6e6e6;
-  border: 1px solid #e6e6e6;
-  color: black;
-  display: block;
-  font-family: "Courier New", Courier, monospace;
-  height: 230px;
-  overflow-y: scroll;
-  padding: 5px;
-  white-space: pre-wrap;
-}
-.log:only-child {
-  height: inherit;
-}
-
-div.image {
-  border: 1px solid #e6e6e6;
-  float: right;
-  height: 240px;
-  margin-left: 5px;
-  overflow: hidden;
-  width: 320px;
-}
-div.image img {
-  width: 320px;
-}
-
-div.video {
-  border: 1px solid #e6e6e6;
-  float: right;
-  height: 240px;
-  margin-left: 5px;
-  overflow: hidden;
-  width: 320px;
-}
-div.video video {
-  overflow: hidden;
-  width: 320px;
-  height: 240px;
-}
-
-.collapsed {
-  display: none;
-}
-
-.expander::after {
-  content: " (show details)";
-  color: #BBB;
-  font-style: italic;
-  cursor: pointer;
-}
-
-.collapser::after {
-  content: " (hide details)";
-  color: #BBB;
-  font-style: italic;
-  cursor: pointer;
-}
-
-/*------------------
- * 3. Sorting items
- *------------------*/
-.sortable {
-  cursor: pointer;
-}
-
-.sort-icon {
-  font-size: 0px;
-  float: left;
-  margin-right: 5px;
-  margin-top: 5px;
-  /*triangle*/
-  width: 0;
-  height: 0;
-  border-left: 8px solid transparent;
-  border-right: 8px solid transparent;
-}
-.inactive .sort-icon {
-  /*finish triangle*/
-  border-top: 8px solid #E6E6E6;
-}
-.asc.active .sort-icon {
-  /*finish triangle*/
-  border-bottom: 8px solid #999;
-}
-.desc.active .sort-icon {
-  /*finish triangle*/
-  border-top: 8px solid #999;
-}

package/assets/tests_test_generate_validation_schema.py__test_boolean_list_property_0_0.txt

@@ -1,11 +0,0 @@
-tests/test_generate_validation_schema.py::test_boolean_list_property:
-
-  - during reuse phase (0.00 seconds):
-    - Typical runtimes: < 1ms, ~ 57% in data generation
-    - 2 passing examples, 0 failing examples, 0 invalid examples
-
-  - during generate phase (0.11 seconds):
-    - Typical runtimes: < 1ms, ~ 73% in data generation
-    - 98 passing examples, 0 failing examples, 1 invalid examples
-
-  - Stopped because settings.max_examples=100