Add form helper for tests

[eileenmcnaughton]

Overview

Add form helper for tests

Before

Some great people like @mlutfy have written unit tests for extension to test form interactions. However, they copied our old core test methodology of contorting some methods to be callable directly. We try not to do that in core now - preferring to imitate the user with url parameters & submitted parameters. However, we haven't had any of of our helpers available to extensions

After

This adds a new FormTrait which, at it's simplest allows

use \Civi\Test\FormTrait;

$this->getTestForm('CRM_Event_Form_Participant', $submittedValues, $urlParameters)
->processForm(FormWrapper::SUBMITTED);

Technical Details

This will probably evolve a bit over time but the basic set up is deliberately restrictive - the only way to interact with the actual form object is by calling functions on the form that have been declared as part of the api (with the @api annotation). However, I'm working on adding helpers to check the various form outputs - smarty variables, html, validation errors, mails but think that can be in the PR/s

Note that I've added a form specific wrapper for the one form I've been working with - it makes better discoverablity for the available functions + I'm still working through where to store useful defaults for the form - so that people can submit without having to figure out all the values they need to submit

Comments

[civibot]

🤖 Thank you for contributing to CiviCRM! ❤️ We will need to test and review this PR. 👷

Introduction for new contributors...

• If this is your first PR, an admin will greenlight automated testing with the command ok to test or add to whitelist.
• A series of tests will automatically run. You can see the results at the bottom of this page (if there are any problems, it will include a link to see what went wrong).
• A demo site will be built where anyone can try out a version of CiviCRM that includes your changes.
• If this process needs to be repeated, an admin will issue the command test this please to rerun tests and build a new demo site.
• Before this PR can be merged, it needs to be reviewed. Please keep in mind that reviewers are volunteers, and their response time can vary from a few hours to a few weeks depending on their availability and their knowledge of this particular part of CiviCRM.
• A great way to speed up this process is to "trade reviews" with someone - find an open PR that you feel able to review, and leave a comment like "I'm reviewing this now, could you please review mine?" (include a link to yours). You don't have to wait for a response to get started (and you don't have to stop at one!) the more you review, the faster this process goes for everyone 😄
• To ensure that you are credited properly in the final release notes, please add yourself to contributor-key.yml
• For more information about contributing, see CONTRIBUTING.md.

Quick links for reviewers...

• ➡️ PR Demo site (can be rebuilt with the command test this please).
• 📖 Review standards
• 🗒️ Review template (brief or verbose)

➡️ Online demo of this PR 🔗

[mlutfy]

Very cool, looking forward to using it :)