silverstripe-userforms/tests/php/Form/UserFormsRequiredFieldsTest.php

<?php

namespace SilverStripe\UserForms\Tests\Form;

use SilverStripe\CMS\Controllers\ModelAsController;
use SilverStripe\Dev\Debug;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\UserForms\Form\UserFormsRequiredFields;
use SilverStripe\UserForms\Model\UserDefinedForm;
use SilverStripe\UserForms\Form\UserForm;
use PHPUnit\Framework\Attributes\DataProvider;

class UserFormsRequiredFieldsTest extends SapphireTest
{
    protected static $fixture_file = '../UserFormsTest.yml';

    private function getValidatorFromPage($page)
    {
        $controller = ModelAsController::controller_for($page);
        $form = new UserForm($controller);
        return $form->getValidator();
    }

    public function testUsesUserFormsRequiredFieldsValidator()
    {
        $page = $this->objFromFixture(UserDefinedForm::class, 'required-custom-rules-form');
        $this->assertEquals(3, $page->Fields()->count());
        $validator = $this->getValidatorFromPage($page);
        $this->assertNotNull($validator);
        $this->assertInstanceOf(UserFormsRequiredFields::class, $validator, 'Uses UserFormsRequiredFields validator');
    }

    public static function dataProviderValidationOfConditionalRequiredFields()
    {
        return [
            'Passes when non-conditional required field has a value' => [
                [
                    'required-text-field-2'     => 'some text',
                    'radio-option-2'            => 'N',
                    'conditional-required-text' => ''
                ],
                true
            ],
            'Fails when conditional required is displayed but not completed' => [
                [
                    'required-text-field-2'     => 'some text',
                    'radio-option-2'            => 'Y',
                    'conditional-required-text' => ''
                ],
                false
            ],
            'Passes when conditional required field has a value' => [
                [
                    'required-text-field-2'     => 'some text',
                    'radio-option-2'            => 'Y',
                    'conditional-required-text' => 'some more text'
                ],
                true
            ]
        ];
    }

    /**
     * @param $data
     * @param $expected
     */
    #[DataProvider('dataProviderValidationOfConditionalRequiredFields')]
    public function testValidationOfConditionalRequiredFields($data, $expected)
    {
        $page = $this->objFromFixture(UserDefinedForm::class, 'required-custom-rules-form');
        $validator = $this->getValidatorFromPage($page);
        $this->assertNotNull($validator);

        $this->assertFalse(
            $validator->php([]),
            'Fails when non-conditional required field is empty'
        );

        $this->assertEquals($expected, $validator->php($data));
    }

    public static function dataProviderValidationOfNestedConditionalRequiredFields()
    {
        return [
            'Fails when non-conditional required field is empty' => [[], false],
            'Passes when non-conditional required field has a value' => [
                [
                    'required-text-field-3'       => 'some text',
                    'radio-option-3'              => 'N',
                    'conditional-required-text-2' => '',
                    'conditional-required-text-3' => ''
                ],
                true
            ],
            'Fails when conditional required is displayed but not completed' => [
                [
                    'required-text-field-3'       => 'some text',
                    'radio-option-3'              => 'Y',
                    'conditional-required-text-2' => '',
                    'conditional-required-text-3' => ''
                ],
                false
            ],
            'Passes when non-conditional required field has a value' => [
                [
                    'required-text-field-3'       => 'some text',
                    'radio-option-3'              => 'Y',
                    'conditional-required-text-2' => 'this text',
                    'conditional-required-text-3' => ''
                ],
                true
            ],
            'Fails when nested conditional required is displayed but not completed' => [
                [
                    'required-text-field-3'       => 'some text',
                    'radio-option-3'              => 'Y',
                    'conditional-required-text-2' => 'Show more',
                    'conditional-required-text-3' => ''
                ],
                false
            ],
            'Passes when nested conditional required field has a value' => [
                [
                    'required-text-field-3'       => 'some text',
                    'radio-option-3'              => 'Y',
                    'conditional-required-text-2' => 'Show more',
                    'conditional-required-text-3' => 'more text'
                ],
                true
            ]
        ];
    }

    /**
     * @param string $data
     * @param array $expected
     */
    #[DataProvider('dataProviderValidationOfNestedConditionalRequiredFields')]
    public function testValidationOfNestedConditionalRequiredFields($data, $expected)
    {
        $page = $this->objFromFixture(UserDefinedForm::class, 'required-nested-custom-rules-form');
        $this->assertEquals(4, $page->Fields()->count());
        $validator = $this->getValidatorFromPage($page);
        $this->assertNotNull($validator);

        $this->assertEquals($expected, $validator->php($data));
    }
}