-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
✅ [#1451] -- add tests for fieldset/columns component rendering behav…
…iour Fieldsets should only be visible if not explicitly hidden AND if they have visible children.
- Loading branch information
1 parent
fda69f2
commit 1e5f84a
Showing
2 changed files
with
284 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
284 changes: 284 additions & 0 deletions
284
src/openforms/formio/rendering/tests/test_vanilla_formio_components.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,284 @@ | ||
| """ | ||
| Test the render component node implementations for the built-in Formio component types. | ||
| These can be considered integration tests for the Formio aspect, relying on the out | ||
| of the box configuration in Open Forms through the registry. | ||
| """ | ||
| from django.test import TestCase | ||
|
|
||
| from openforms.forms.tests.factories import FormFactory | ||
| from openforms.submissions.rendering import Renderer, RenderModes | ||
| from openforms.submissions.tests.factories import ( | ||
| SubmissionFactory, | ||
| SubmissionStepFactory, | ||
| ) | ||
|
|
||
| from ..nodes import ComponentNode | ||
|
|
||
|
|
||
| class FormNodeTests(TestCase): | ||
| @classmethod | ||
| def setUpTestData(cls): | ||
| super().setUpTestData() | ||
|
|
||
| form = FormFactory.create( | ||
| name="public name", | ||
| internal_name="internal name", | ||
| generate_minimal_setup=True, | ||
| formstep__form_definition__configuration={ | ||
| "components": [ | ||
| # container: visible fieldset without visible children | ||
| { | ||
| "type": "fieldset", | ||
| "label": "A container without visible children", | ||
| "hidden": False, | ||
| "components": [ | ||
| { | ||
| "type": "textfield", | ||
| "key": "input1", | ||
| "label": "Input 1", | ||
| "hidden": True, | ||
| } | ||
| ], | ||
| }, | ||
| # container: visible fieldset with visible children | ||
| { | ||
| "type": "fieldset", | ||
| "label": "A container with visible children", | ||
| "hidden": False, | ||
| "components": [ | ||
| { | ||
| "type": "textfield", | ||
| "key": "input2", | ||
| "label": "Input 2", | ||
| "hidden": True, | ||
| }, | ||
| { | ||
| "type": "textfield", | ||
| "key": "input3", | ||
| "label": "Input 3", | ||
| "hidden": False, | ||
| }, | ||
| ], | ||
| }, | ||
| # container: hidden fieldset with 'visible' children | ||
| { | ||
| "type": "fieldset", | ||
| "label": "A hidden container with visible children", | ||
| "hidden": True, | ||
| "components": [ | ||
| { | ||
| "type": "textfield", | ||
| "key": "input4", | ||
| "label": "Input 4", | ||
| "hidden": False, | ||
| } | ||
| ], | ||
| }, | ||
| # container: visible columns without visible children | ||
| { | ||
| "type": "columns", | ||
| "key": "columns1", | ||
| "label": "Columns 1", | ||
| "hidden": False, | ||
| "columns": [ | ||
| { | ||
| "size": 6, | ||
| "components": [ | ||
| { | ||
| "type": "textfield", | ||
| "key": "input5", | ||
| "label": "Input 5", | ||
| "hidden": True, | ||
| } | ||
| ], | ||
| }, | ||
| { | ||
| "size": 6, | ||
| "components": [ | ||
| { | ||
| "type": "textfield", | ||
| "key": "input6", | ||
| "label": "Input 6", | ||
| "hidden": True, | ||
| } | ||
| ], | ||
| }, | ||
| ], | ||
| }, | ||
| # container: visible columns with visible children | ||
| { | ||
| "type": "columns", | ||
| "key": "columns2", | ||
| "label": "Columns 2", | ||
| "hidden": False, | ||
| "columns": [ | ||
| { | ||
| "size": 6, | ||
| "components": [ | ||
| { | ||
| "type": "textfield", | ||
| "key": "input7", | ||
| "label": "Input 7", | ||
| "hidden": False, | ||
| } | ||
| ], | ||
| }, | ||
| { | ||
| "size": 6, | ||
| "components": [ | ||
| { | ||
| "type": "textfield", | ||
| "key": "input8", | ||
| "label": "Input 8", | ||
| "hidden": True, | ||
| } | ||
| ], | ||
| }, | ||
| ], | ||
| }, | ||
| # container: hidden columns with visible children | ||
| { | ||
| "type": "columns", | ||
| "key": "columns3", | ||
| "label": "Columns 3", | ||
| "hidden": True, | ||
| "columns": [ | ||
| { | ||
| "size": 6, | ||
| "components": [ | ||
| { | ||
| "type": "textfield", | ||
| "key": "input9", | ||
| "label": "Input 9", | ||
| "hidden": False, | ||
| } | ||
| ], | ||
| }, | ||
| { | ||
| "size": 6, | ||
| "components": [ | ||
| { | ||
| "type": "textfield", | ||
| "key": "input10", | ||
| "label": "Input 10", | ||
| "hidden": True, | ||
| } | ||
| ], | ||
| }, | ||
| ], | ||
| }, | ||
| ] | ||
| }, | ||
| ) | ||
|
|
||
| submission = SubmissionFactory.create(form=form) | ||
| step = SubmissionStepFactory.create( | ||
| submission=submission, | ||
| form_step=form.formstep_set.get(), | ||
| data={ | ||
| "input1": "aaaaa", | ||
| "input2": "bbbbb", | ||
| "input3": "ccccc", | ||
| "input4": "ddddd", | ||
| "input6": "fffff", | ||
| "input7": "ggggg", | ||
| "input8": "hhhhh", | ||
| "input9": "iiiii", | ||
| "input10": "jjjjj", | ||
| }, | ||
| ) | ||
|
|
||
| # expose test data to test methods | ||
| cls.submission = submission | ||
| cls.step = step | ||
|
|
||
| def test_fieldsets_hidden_if_all_children_hidden(self): | ||
| # we always need a renderer instance | ||
| renderer = Renderer(self.submission, mode=RenderModes.pdf, as_html=False) | ||
| # take | ||
| component = self.step.form_step.form_definition.configuration["components"][0] | ||
| assert component["type"] == "fieldset" | ||
|
|
||
| component_node = ComponentNode.build_node( | ||
| step=self.step, component=component, renderer=renderer | ||
| ) | ||
|
|
||
| self.assertFalse(component_node.is_visible) | ||
| self.assertEqual(list(component_node), []) | ||
|
|
||
| def test_fieldsets_visible_if_any_child_visible(self): | ||
| # we always need a renderer instance | ||
| renderer = Renderer(self.submission, mode=RenderModes.pdf, as_html=False) | ||
| # take | ||
| component = self.step.form_step.form_definition.configuration["components"][1] | ||
| assert component["type"] == "fieldset" | ||
|
|
||
| component_node = ComponentNode.build_node( | ||
| step=self.step, component=component, renderer=renderer | ||
| ) | ||
|
|
||
| self.assertTrue(component_node.is_visible) | ||
| nodelist = list(component_node) | ||
| self.assertEqual(len(nodelist), 2) | ||
| self.assertEqual(nodelist[0].label, "A container with visible children") | ||
| self.assertEqual(nodelist[1].label, "Input 3") | ||
|
|
||
| def test_fieldset_hidden_if_marked_as_such_and_visible_children(self): | ||
| # we always need a renderer instance | ||
| renderer = Renderer(self.submission, mode=RenderModes.pdf, as_html=False) | ||
| # take | ||
| component = self.step.form_step.form_definition.configuration["components"][2] | ||
| assert component["type"] == "fieldset" | ||
|
|
||
| component_node = ComponentNode.build_node( | ||
| step=self.step, component=component, renderer=renderer | ||
| ) | ||
|
|
||
| self.assertFalse(component_node.is_visible) | ||
| self.assertEqual(list(component_node), []) | ||
|
|
||
| def test_columns_hidden_if_all_children_hidden(self): | ||
| # we always need a renderer instance | ||
| renderer = Renderer(self.submission, mode=RenderModes.pdf, as_html=False) | ||
| # take | ||
| component = self.step.form_step.form_definition.configuration["components"][3] | ||
| assert component["type"] == "columns" | ||
|
|
||
| component_node = ComponentNode.build_node( | ||
| step=self.step, component=component, renderer=renderer | ||
| ) | ||
|
|
||
| self.assertFalse(component_node.is_visible) | ||
| self.assertEqual(list(component_node), []) | ||
|
|
||
| def test_columns_visible_if_any_child_visible(self): | ||
| # we always need a renderer instance | ||
| renderer = Renderer(self.submission, mode=RenderModes.pdf, as_html=False) | ||
| # take | ||
| component = self.step.form_step.form_definition.configuration["components"][4] | ||
| assert component["type"] == "columns" | ||
|
|
||
| component_node = ComponentNode.build_node( | ||
| step=self.step, component=component, renderer=renderer | ||
| ) | ||
|
|
||
| self.assertTrue(component_node.is_visible) | ||
| nodelist = list(component_node) | ||
| self.assertEqual(len(nodelist), 2) | ||
| self.assertEqual(nodelist[0].label, "Columns 2") | ||
| self.assertEqual(nodelist[1].label, "Input 7") | ||
|
|
||
| def test_column_hidden_if_marked_as_such_and_visible_children(self): | ||
| # we always need a renderer instance | ||
| renderer = Renderer(self.submission, mode=RenderModes.pdf, as_html=False) | ||
| # take | ||
| component = self.step.form_step.form_definition.configuration["components"][5] | ||
| assert component["type"] == "columns" | ||
|
|
||
| component_node = ComponentNode.build_node( | ||
| step=self.step, component=component, renderer=renderer | ||
| ) | ||
|
|
||
| self.assertFalse(component_node.is_visible) | ||
| self.assertEqual(list(component_node), []) |