Development Task

Note: this was originally a bug fix but the bug is not easily reproducible anymore. Instead this has become focused on automated testing for fields to ensure that they are stable.*

Issue #2119

Description

Specifically, this PR will work to create tests around the PROPERTY FIELD specifically as an example for field testing in general:

• Add more automated testing for the property field focusing on making sure that Chado and the Drupal field tables stay in sync. See "CRUD" tests for this.
  • Note: it doesn't check the underlying chado values.
• Add automated testing for the ChadoPropertyWidgetDefault widget (textarea) to ensure that the values are being properly massaged.
  • Expand the scenarios to check the form element defaults in the edit scenario
  • Check the right number of form elements are available for property fields with multiple properties.
  • Note: The tests don't check scenarios that we expect to have errors for

The following scenarios are focused on:

• Ensure that removing properties happens smoothly and Drupal/Chado remain in sync.
• Ensure that the Drupal delta and Chado rank values are always in sync.
• Ensure there is no swapping between property fields
• Ensure you can add properties on create and/or edit

The following helper methods have been added to help test other fields:

• tripal/tests/src/Traits/TripalEntityFieldTestTrait:
  • assertFieldValuesMatch()
  • setupTripalEntityAddForm()
  • setupTripalEntityEditForm()
  • populateTripalEntityFormState()
• tripal_chado/tests/src/Traits/ChadoFieldTestTrait:
  • assertFieldWidgetsMatch()
  • assertArrayContainsElements()
  • setupChadoEntityFieldTestEnvironment()
  • setupChadoEntityFieldSystemUnderTest()

I will work on documenting this process in the TripalDocs repo in PR tripal/tripal_doc#105

Testing?

Manual Testing

This PR does touch the property fields themselves so it would be good to manually test them through the interface.

Automated Testing

ChadoPropertyTypeCRUDTest

This test replaces the old tripal_chado/tests/src/Kernel/Plugin/ChadoField/FieldType/ChadoPropertyTypeSimpleCRUDTest.php. It is more efficient and comprehensive plus actually tests the contents of the Drupal field tables.

It tests the following scenarios which are described in tripal_chado/tests/src/Kernel/Plugin/ChadoField/FieldType/ChadoPropertyType-TestInfo.yml

• Simple project with no properties added on create or edit. There are two property fields attached so this checks that we are not forced to use the property fields ;-p
• Project with no properties added on create but then 2 properties added for each of fields project_prop1 and project_prop2 on edit. This tests multiple properties per field, multiple property fields per content type and creation of properties on edit.
• project with 2 properties for each of project_prop1 and project_prop2 on create. On edit the properties for project_prop1 are reordered but those for project_prop2 remain the same. This tests that properties can be added on create, that properties can be reordered without being changed and that reordering on one field does not affect the other field.

For each scenario

1. The entity is created with the initial user input and we check this occurs without error.
2. The entity we just created is loaded and we confirm the field values match our expectations. This checks both the values of the field in the entity and in the Drupal field table. It does not actually check chado.
3. Make changes based on user input and check that we can save without error.
4. Load the entity again and check that the changes are reflected both in the entity and in the drupal field tables.

ChadoPropertyWidgetFormTest

This widget test is brand new, never before done in Tripal ;-p

It tests the following scenarios which are described in tripal_chado/tests/src/Kernel/Plugin/ChadoField/FieldType/ChadoPropertyWidgetForm-TestInfo.yml

• Simple project with no properties added on create or edit. There are two property fields attached so this checks that we are not forced to use the property fields ;-p
• Project with no properties added on create but then 2 properties added for each of fields project_prop1 and project_prop2 on edit. This tests multiple properties per field, multiple property fields per content type and creation of properties on edit.
• project with 2 properties for each of project_prop1 and project_prop2 on create. On edit the properties for project_prop1 are reordered but those for project_prop2 remain the same. This tests that properties can be added on create, that properties can be reordered without being changed and that reordering on one field does not affect the other field.

For each scenario

• CREATE:
  • We can generate the entire TripalEntity create form without error using the field defaults. We also check the field widget form elements match our expectations here.
  • Manipulate the form state based on user input and check that form validation executes as expected (currently expects no errors).
  • If there are no errors from validate then also check that we can submit the form and save it. Then check the resulting field values match our expectations in the same way as for the CRUD test.
• EDIT:
  • We can generate the TripalEntity edit form for the specific entity we just created without error. We check the field widget form elements match our expectations including checking the default values.
  • Manipulate the form state based on user input and check that form validation executes as expected (currently expects no errors).
  • If there are no errors from validate then also check that we can submit the form and save it. Then check the resulting field values match our expectations in the same way as for the CRUD test.

Code review

NOTE: This PR also fixes coding standards in the files I touched and adds coding standards checking to the docker devcontainer.

Specific updates to non-test files are:

• tripal_chado/src/Plugin/DataType/ChadoDataType.php
  • getIterator() now needs to be \Traversable (deprecation fix)
  • onchange() method parameters have changed in Drupal core; update to match.
• tripal_chado/src/Plugin/Field/FieldWidget/ChadoPropertyWidgetDefault.php:
  • formElement() support when term_id is already set in the items
  • formElement() consistently use #value for value type elements
  • massageFormValues() don't try to remove value format from empty properties.
  • settingsForm() use DI translation $this->t() rather than procedural t().
• tripal_chado/src/TripalField/ChadoWidgetBase.php
  • Don't use t() in Exceptions as its not recommended.
  • massagePropertyFormValues() notify the developer if the field_name key is not present in the form values as it is now required.
  • massagePropertyFormValues() Only check each key of $value if it actually exists.