Don't create user profile fields during test runs (PHPUNIT)

[aspark21]

#283/#286 changes introduced additional profile fields on the merged user which causes core test to fail when doing a full build test run.

Simple fix is to wrap the field creation with:
if (!PHPUNIT_TEST && !defined('BEHAT_SITE_RUNNING')) {

core.testing_generator_test/test_create_custom_profile_field_categorycore\testing_generator_test::test_create_custom_profile_field_category Failed asserting that '2' matches expected 1.  
/var/www/html/lib/testing/tests/testing_generator_test.php:512 
/var/www/html/lib/phpunit/classes/advanced_testcase.php:76

core.testing_generator_test/test_create_custom_profile_fieldcore\testing_generator_test::test_create_custom_profile_field 
Failed asserting that '2' matches expected 1.  
/var/www/html/lib/testing/tests/testing_generator_test.php:574 
/var/www/html/lib/phpunit/classes/advanced_testcase.php:76

core.oauth2_test/test_get_empty_internalfield_listcore\oauth2_test::test_get_empty_internalfield_list 
Failed asserting that two arrays are equal. 
--- Expected +++ Actual @@ @@      16 => 'alternatename'      17 => 'picture'      18 => 'username' +    19 => 'profile_field_mergeusers_date' +    20 => 'profile_field_mergeusers_logid' +    21 => 'profile_field_mergeusers_olduserid' +    22 => 'profile_field_mergeusers_newuserid'  )  
/var/www/html/lib/tests/oauth2_test.php:555 
/var/www/html/lib/phpunit/classes/advanced_testcase.php:76

profilefield_checkbox.profile_field_checkbox_test/test_show_field_contentprofilefield_checkbox\profile_field_checkbox_test::test_show_field_content 
Failed asserting that false is true.  
/var/www/html/user/profile/field/checkbox/tests/profile_field_checkbox_test.php:110 
/var/www/html/lib/phpunit/classes/advanced_testcase.php:76

profilefield_checkbox.profile_field_checkbox_test/test_is_empty with data set "Value equals 0"profilefield_checkbox\profile_field_checkbox_test::test_is_empty with data set "Value equals 0" (array(0), false) Failed asserting that true matches expected false.  /var/www/html/user/profile/field/checkbox/tests/profile_field_checkbox_test.php:86 /var/www/html/lib/phpunit/classes/advanced_testcase.php:76

profilefield_checkbox.profile_field_checkbox_test/test_is_empty with data set "Value equals 1"profilefield_checkbox\profile_field_checkbox_test::test_is_empty with data set "Value equals 1" (array(1), false) Failed asserting that true matches expected false.  /var/www/html/user/profile/field/checkbox/tests/profile_field_checkbox_test.php:86 

[jpahullo]

Hi @aspark21 ,

Thanks a lot for providing feedback.

It is a pity that this plugin breaks core tests. I am sorry.

We have PHPUNIT tests to check that profile fields are properly generated upon installation or upgrade of this plugin.

Your condition seems to me that allows generating them only when no testing at all is being executed.

With your experience, how do you think we should perform this custom profile fields?

I am thinking to something like defining a certain constant with a new file phpunit.xml.dist, with an INI constant like PHPUNIT_TOOL_MERGEUSERS, so that we could let PHPUnit tests for this plugin pass and also core ones. The idea would be something like:

    if (PHPUNIT_TOOL_MERGEUSERS || (!PHPUNIT_TEST && !defined('BEHAT_SITE_RUNNING'))) {

What do you think? I do not want to overcomplicate things.

Thanks for your time,

Jordi

[matthewhilton]

Hey @jpahullo and @aspark21

To me, it does not seem correct to disable generating these fields at all during unit testing, because there still needs to be the ability to test the merge users functionality with these fields.

This has been reported but not fixed here https://tracker.moodle.org/browse/MDL-78303 - it may be possible that this may break the component communication principles and as such won't be fixed.

The safest method then is to update the plugin to work around this issue. I'd like to suggest the ability to simply link profile fields, and then have a button to "auto setup" fields.

This way they are not there on install or during core tests, and are optional (some sites may not use this feature, and don't want the additional fields), but can be added by 1 button click.

I'll make a pr for something like the above soon