(REF) CiviUnitTestCase - Cleanup and simplify the DB-reset mechanism

[totten]

Overview

Simplify the code which handles data-setup in CiviUnitTestCase. This removes several properties and functions which are not really used. Instead, callCiviEnvBuilder (which includes similar/better helpers -- and which is shared by Civi\Test::headless(), Civi\Test::e2e(), Api4TestBase, and most civix testing templates).

Before

Primarily, the functionality here is that setUpBeforeClass() and setUp() call _populateDB(),

There is a series of inter-related properties and functions which reference each other - but they are not used externally. These are:

class CiviUnitTestCase {
  protected $_dbconn;
  protected static $_dbName;
  public static $populateOnce;
  public function requireDBreset(): bool;
  public static function getDBName(): string;
  public function getConnection(): WhoKnowsWhat;
  protected function getDataSet(): WhoKnowsWhat;
  protected static function _populateDB(): bool;
}

After

Primarily, the functionality here is that setUpBeforeClass() and setUp() call buildEnvironment()->apply(TRUE),

All the "Before" methods are removed. Instead, there is one new, short method:

class CiviUnitTestCase ... {
  public static function buildEnvironment(): CiviEnvBuilder
}

Comments

The existing policy in CiviUnitTestCase have a very strong tendency to do DB resets. The PR preserves this policy.

Most of the commits are fairly basic: search for "XX", find "XX" is only used 0-1 times, and remove "XX".

The most interesting commit is probably 8cfba74 -- that's where it becomes apparent that the funny conditionals in _populateDB() don't serve a purpose, and that $DBResetRequired is inert (even though ~30 test-classes mention it).

This file has a huge amount of implicit test-coverage by way of ./tests/phpunit/ -- CiviUnitTestCase is extended by 450+ test-classes.

[civibot]

(Standard links)

• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[totten]

civibot, test this please

[totten]

civibot, test this please

[totten]

I've filled in the description and removed the "do not merge" flag. Tests are passing.

If you want to skim the patch, I suggest reading the "Before/After" summary - and then the individual commits. (The aggregated diff is a bit crisscrossy, but the individual ones are very bite-sized.)