Codeception / Codeception/lib-xml

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

未关闭
#6 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
PHP
星标
17
派生
1
PR 合并指标
30 天内没有已合并 PR

描述

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:
- v4 used to catch parser exceptions, and then continues to try an xpath: https://github.com/Codeception/Codeception/blob/4.2.2/src/Codeception/Util/XmlStructure.php#L39-L46
- v5 does not: https://github.com/Codeception/lib-xml/blob/main/src/Util/XmlStructure.php#L40

## Reproduce

- Create a unit test and pass an xpath, for example through Codeceptions SOAP module `grabTextContentFrom()` (https://codeception.com/docs/modules/SOAP#grabTextContentFrom):
```
$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 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:
```php
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);
}
```

贡献指南

这个仓库没有索引到贡献指南

调研方向

阅读 src/Util/XmlStructure.php 和 SOAP 模块的 grabTextContentFrom() 路径,然后创建一个复现类似 /example 的 XPath 的单元测试。完成标准是 XPath 不再引发 CSS selector exception,并返回匹配的元素。

由索引模型根据 Issue 内容生成。

评估

技术栈
php, symfony
领域
backend
Issue 类型
缺陷
难度
2/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
描述清楚
新手友好度
45/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。