Passing xpath to XmlStructure::matchElement() always throws Exception

Open
#6 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
php, symfony
Domain
backend

Research direction

Read src/Util/XmlStructure.php and the SOAP module's grabTextContentFrom() path, then create a unit test reproducing an XPath such as /example. Done means the XPath no longer raises a CSS selector exception and the matching element is returned.

Written by the indexing model from the issue text.

Description

The signature allows param $cssOrXpath: https://github.com/Codeception/lib-xml/blob/main/src/Util/XmlStructure.php#L37
But when an xpath is passed, it will throw an exception.

This is broken since Codeception 5.0:

Reproduce

$xpath = '/example';
$I->grabTextContentFrom($xpath))
  • Run the test. Output:
1) ExampleCest: Call undefined operation
 Test  ExampleCest.php:example

  [Symfony\Component\CssSelector\Exception\SyntaxErrorException] Expected selector, but <delimiter "/" at 0> found.

Scenario Steps:

 4. $I->grabTextContentFrom("/example") at (..)

#1  (..)\vendor\symfony\css-selector\Exception\SyntaxErrorException.php:28
#2  (..)\vendor\symfony\css-selector\Parser\Parser.php:284
#3  (..)\vendor\symfony\css-selector\Parser\Parser.php:115
#4  (..)\vendor\symfony\css-selector\Parser\Parser.php:100
#5  (..)\vendor\symfony\css-selector\Parser\Parser.php:42
#6  (..)\vendor\symfony\css-selector\XPath\Translator.php:222
#7  (..)\vendor\symfony\css-selector\XPath\Translator.php:92
#8  (..)\vendor\symfony\css-selector\CssSelectorConverter.php:65
#9  Codeception\Module\SOAP->grabTextContentFrom

Possible fix

Re-implement the try-catch:

    public function matchElement(string $cssOrXPath): ?DOMNode
    {
        $domXpath = new DOMXpath($this->xml);
        try {
            $selector = (new CssSelectorConverter())->toXPath($cssOrXPath);
            $els = $domXpath->query($selector);
            if ($els !== false && count($els) > 0) {
                return $els->item(0);
            }
        } catch (\Symfony\Component\CssSelector\Exception\ParseException $e) {
        }
        $els = $domXpath->query($cssOrXPath);
        if ($els !== false && count($els) > 0) {
            return $els->item(0);
        }
        throw new ElementNotFound($cssOrXPath);
    }
Dominant language
PHP
Stars
17
Forks
1
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Codeception/lib-xml

All issues in Codeception/lib-xml

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.