Replace usages of AssertLegacyTrait::constructFieldXpath, that is deprecated

Adding the "Deprecated assertions" tag to add this into the kanban board https://contribkanban.com/board/Deprecatedassertions

Verified for presence of constructFieldXpath with grep -r "constructFieldXpath(" *
only core/tests/Drupal/FunctionalTests/AssertLegacyTrait.php, core/tests/Drupal/Tests/Listeners/DeprecationListenerTrait.php and core/tests/Drupal/KernelTests/AssertContentTrait.php show up.

kiran.rao@Srijans-MBP drupal % grep -r "constructFieldXpath(" *
core/tests/Drupal/FunctionalTests/AssertLegacyTrait.php:    $this->assertFieldByXPath($this->constructFieldXpath('name', $name), $value);
core/tests/Drupal/FunctionalTests/AssertLegacyTrait.php:    $this->assertNoFieldByXPath($this->constructFieldXpath('name', $name), $value);
core/tests/Drupal/FunctionalTests/AssertLegacyTrait.php:    $this->assertFieldByXPath($this->constructFieldXpath('id', $id), $value);
core/tests/Drupal/FunctionalTests/AssertLegacyTrait.php:    $this->assertFieldByXPath($this->constructFieldXpath('name', $field) . '|' . $this->constructFieldXpath('id', $field));
core/tests/Drupal/FunctionalTests/AssertLegacyTrait.php:    $this->assertNoFieldByXPath($this->constructFieldXpath('name', $field) . '|' . $this->constructFieldXpath('id', $field));
core/tests/Drupal/FunctionalTests/AssertLegacyTrait.php:    $this->assertNoFieldByXPath($this->constructFieldXpath('id', $id), $value);
core/tests/Drupal/FunctionalTests/AssertLegacyTrait.php:  protected function constructFieldXpath($attribute, $value) {
core/tests/Drupal/FunctionalTests/AssertLegacyTrait.php:    @trigger_error('AssertLegacyTrait::constructFieldXpath() is deprecated in drupal:8.5.0 and is removed from drupal:10.0.0. Use $this->getSession()->getPage()->findField() instead. See https://www.drupal.org/node/3129738', E_USER_DEPRECATED);
core/tests/Drupal/Tests/Listeners/DeprecationListenerTrait.php:      'AssertLegacyTrait::constructFieldXpath() is deprecated in drupal:8.5.0 and is removed from drupal:10.0.0. Use $this->getSession()->getPage()->findField() instead. See https://www.drupal.org/node/3129738',
core/tests/Drupal/KernelTests/AssertContentTrait.php:    return $this->assertFieldByXPath($this->constructFieldXpath('name', $name), $value, $message, $group);
core/tests/Drupal/KernelTests/AssertContentTrait.php:    return $this->assertNoFieldByXPath($this->constructFieldXpath('name', $name), $value, $message ? $message : new FormattableMarkup('Did not find field by name @name', ['@name' => $name]), $group);
core/tests/Drupal/KernelTests/AssertContentTrait.php:    return $this->assertFieldByXPath($this->constructFieldXpath('id', $id), $value, $message ? $message : new FormattableMarkup('Found field by id @id', ['@id' => $id]), $group);
core/tests/Drupal/KernelTests/AssertContentTrait.php:    return $this->assertNoFieldByXPath($this->constructFieldXpath('id', $id), $value, $message ? $message : new FormattableMarkup('Did not find field by id @id', ['@id' => $id]), $group);
core/tests/Drupal/KernelTests/AssertContentTrait.php:    return $this->assertFieldByXPath($this->constructFieldXpath('name', $field) . '|' . $this->constructFieldXpath('id', $field), NULL, $message, $group);
core/tests/Drupal/KernelTests/AssertContentTrait.php:    return $this->assertNoFieldByXPath($this->constructFieldXpath('name', $field) . '|' . $this->constructFieldXpath('id', $field), NULL, $message, $group);
core/tests/Drupal/KernelTests/AssertContentTrait.php:  protected function constructFieldXpath($attribute, $value) {

Moving to RTBC

Once we're removed all the usages we can add an @trigger_error to the method. See \Drupal\FunctionalTests\AssertLegacyTrait::getAllOptions() for an example of how to do that.

Hi @alexpott, Thanks for the review. Correct me if I am wrong, but I found @trigger_error is already there in the method in core/tests/Drupal/FunctionalTests/AssertLegacyTrait . see here.

protected function constructFieldXpath($attribute, $value) {
    @trigger_error('AssertLegacyTrait::constructFieldXpath() is deprecated in drupal:8.5.0 and is removed from drupal:10.0.0. Use $this->getSession()->getPage()->findField() instead. See https://www.drupal.org/node/3129738', E_USER_DEPRECATED);
    $xpath = '//textarea[@' . $attribute . '=:value]|//input[@' . $attribute . '=:value]|//select[@' . $attribute . '=:value]';
    return $this->buildXPathQuery($xpath, [':value' => $value]);
  }

Hi @alexpott, @trigger_error message is already there in core/tests/Drupal/FunctionalTests/AssertLegacyTrait as mentioned by @munish.kumar also. Deleting deprecation message from the core/tests/Drupal/Tests/Listeners/DeprecationListenerTrait.php file also. Kindly review a new patch.

The failures are because of usage of AssertLegacyTrait::constructFieldXpath internally by other AssertLegacyTrait methods. This should pass once Remove the usage of deprecated methods in tests lands.

@mondrake, thanks!

1. $ git grep constructFieldXpath | grep -v AssertContentTrait
   core/tests/Drupal/FunctionalTests/AssertLegacyTrait.php:  protected function constructFieldXpath($attribute, $value) {
   core/tests/Drupal/FunctionalTests/AssertLegacyTrait.php:    @trigger_error('AssertLegacyTrait::constructFieldXpath() is deprecated in drupal:8.5.0 and is removed from drupal:10.0.0. Use $this->getSession()->getPage()->findField() instead. See https://www.drupal.org/node/3129738', E_USER_DEPRECATED);
   core/tests/Drupal/Tests/Core/Assert/AssertLegacyTraitTest.php:   * @covers ::constructFieldXpath
   core/tests/Drupal/Tests/Core/Assert/AssertLegacyTraitTest.php:   * @expectedDeprecation AssertLegacyTrait::constructFieldXpath() is deprecated in drupal:8.5.0 and is removed from drupal:10.0.0. Use $this->getSession()->getPage()->findField() instead. See https://www.drupal.org/node/3129738
   core/tests/Drupal/Tests/Core/Assert/AssertLegacyTraitTest.php:    $this->assertSame('qux', $this->constructFieldXpath('foo', ['bar']));
   

   $ git grep constructFieldXpath | grep -v AssertContentTrait | grep -v AssertLegacyTrait
   [No output]
   

   All occurrences of AssertLegacyTrait::constructFieldXpath() were replaced.

2. +++ b/core/tests/Drupal/Tests/Core/Assert/AssertLegacyTraitTest.php
   @@ -224,6 +225,18 @@ public function testPass() {
   +   * @covers ::constructFieldXpath
   +   * @expectedDeprecation AssertLegacyTrait::constructFieldXpath() is deprecated in drupal:8.5.0 and is removed from drupal:10.0.0. Use $this->getSession()->getPage()->findField() instead. See https://www.drupal.org/node/3129738
   ...
   +  public function testConstructFieldXpath() {
   

   The legacy/deprecated one gets tested.

3. +++ b/core/tests/Drupal/Tests/Listeners/DeprecationListenerTrait.php
   @@ -142,7 +142,6 @@ public static function getSkippedDeprecations() {
   -      'AssertLegacyTrait::constructFieldXpath() is deprecated in drupal:8.5.0 and is removed from drupal:10.0.0. Use $this->getSession()->getPage()->findField() instead. See https://www.drupal.org/node/3129738',
   

   The deprecated message gets removed from getSkippedDeprecations()

4. +++ b/core/modules/comment/tests/src/Functional/Views/WizardTest.php
   @@ -61,17 +61,13 @@ public function testCommentWizard() {
   +    $actual_options = [];
   +    foreach ($items as $item) {
   +      $actual_options[] = $item->getValue();
   +    }
   +    $this->assertEquals($expected_options, $actual_options);
   

   Prefer using array_map

    $this->assertEquals($expected_options, array_map(function ($item) {
         return $item->getValue();
       }, $items));
   

   But it does not matter here.

5. No CS violations

In all, it's RTBC to me.

Actually, the check in #24.1 is unnecessary, if there are leftovers, the testing won't pass once the deprecation message gets removed from getSkippedDeprecations().

Committed c532b2f and pushed to 9.1.x. Thanks!