Deprecate \Drupal\Tests\PhpunitCompatibilityTrait::setExpectedException()

Deprecated the \Drupal\Tests\PhpunitCompatibilityTrait::setExpectedException() function and replaced a total of 517 calls.

197 single parameter calls were replaced with $this->expectException and 320 calls replaced with $this->expectException and $this->expectExceptionMessage.

Drupal\Tests\jsonapi\Kernel\Context\FieldResolverTest needed an if statement to call $this->expectExceptionMessage only when the message was not empty.

Thanks!
Added the @trigger_error and @legacy test and cleaned up indentations for coding standards.

Setting back to Needs Review & Triggering bots.

Sorry, I ran code sniffer to fix the indentations and didn't realize it added the empty docs.

This should take care of the empty docs and the missing space.

@mondrake thanks so much for your direction. I'll keep those in mind going forward, this was my first contribution and you were very helpful.

1. +++ b/core/modules/migrate_drupal/migrate_drupal.install
   @@ -2,7 +2,7 @@
    /**
     * @file
   - * Contains install and update functions for Migrate Drupal
   + * Contains install and update functions for Migrate Drupal.
     */
   

   Unrelated change

2. +++ b/core/modules/migrate_drupal/tests/src/Unit/FieldDiscoveryTest.php
   @@ -178,7 +178,7 @@ public function getBundleFieldsData() {
   -            'user_field_1' => ['field_info_key' => 'user_field_1_data'],
   +          'user_field_1' => ['field_info_key' => 'user_field_1_data'],
   

   unrelated change

3. +++ b/core/tests/Drupal/Tests/Component/Datetime/DateTimePlusTest.php
   @@ -162,9 +163,11 @@ public function testTimestamp($input, array $initial, array $transform) {
       * @param array $initial
   -   *   @see testTimestamp()
   +   *
   +   * @see testTimestamp()
       * @param array $transform
   -   *   @see testTimestamp()
   +   *
   +   * @see testTimestamp()
       *
       * @dataProvider providerTestDateTimestamp
       */
   @@ -180,12 +183,15 @@ public function testDateTimestamp($input, array $initial, array $transform) {
   
   @@ -180,12 +183,15 @@ public function testDateTimestamp($input, array $initial, array $transform) {
       *
       * @param \Drupal\Component\Datetime\DateTimePlus $date
       *   DateTimePlus to test.
   +   *
       * @input mixed $input
       *   The original input passed to the test method.
       * @param array $initial
   -   *   @see testTimestamp()
   +   *
   +   * @see testTimestamp()
       * @param array $transform
   -   *   @see testTimestamp()
   +   *
   +   * @see testTimestamp()
       */
   

   unrelated change

4. +++ b/core/tests/Drupal/Tests/Component/FileCache/FileCacheFactoryTest.php
   @@ -157,7 +158,7 @@ public function configurationDataProvider() {
   -  ];
   +    ];
   

   unrelated change

5. +++ b/core/tests/Drupal/Tests/PhpunitCompatibilityTrait.php
   @@ -97,8 +97,11 @@ public function getMock($originalClassName, $methods = [], array $arguments = []
       *   The expected exception code.
   +   * @deprecated in drupal:8.8.0 and is removed from drupal:9.0.0.
   +   *   Backward compatibility for PHPUnit 4 will no longer be supported.
   

   The @deprecated needs a blank line above it as it is not a param.

   We also need an @see to the change record.

6. +++ b/core/tests/Drupal/Tests/PhpunitCompatibilityTrait.php
   @@ -97,8 +97,11 @@ public function getMock($originalClassName, $methods = [], array $arguments = []
   +    @trigger_error('\Drupal\Tests\PhpunitCompatibilityTrait:setExpectedException() is deprecated in drupal:8.8.0 and is removed from drupal:9.0.0. Backward compatibility for PHPUnit 4 will no longer be supported.', E_USER_DEPRECATED);
   

   Needs a a link to the change record.

7. +++ b/core/tests/Drupal/Tests/PhpunitCompatibilityTraitTest.php
   @@ -21,6 +21,20 @@ public function testGetMock() {
   +  public function testSetExpectedException() {
   

   <3 great to see a deprecation test.

8. Note when running coding standards if you want to only run the ones that core currently implements use composer run phpcs -- -ps or composer run phpcbf -- -ps I think that would have resulted in less out-of-scope change.

Removed unrelated changes, added a blank line above the @deprecated annotation, added an @see to the change record as well as links to the change record in the @trigger_error statement and the @expectedDeprecation annotation of the unit test.

Committed e82e0c0 and pushed to 8.8.x. Thanks!