LocatorAssertions
LocatorAssertions 类提供了断言方法,可用于在测试中对 Locator 状态进行断言。
🌐 The LocatorAssertions class provides assertion methods that can be used to make assertions about the Locator state in the tests.
// ...
import static com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat;
public class TestLocator {
// ...
@Test
void statusBecomesSubmitted() {
// ...
page.getByRole(AriaRole.BUTTON).click();
assertThat(page.locator(".status")).hasText("Submitted");
}
}
方法
🌐 Methods
containsClass
Added in: v1.52确保 Locator 指向具有指定 CSS 类的元素。断言值中的所有类(以空格分隔)都必须出现在 Element.classList 中,顺序可以任意。
🌐 Ensures the Locator points to an element with given CSS classes. All classes from the asserted value, separated by spaces, must be present in the Element.classList in any order.
用法
<div class='middle selected row' id='component'></div>
assertThat(page.locator("#component")).containsClass("middle selected row");
assertThat(page.locator("#component")).containsClass("selected");
assertThat(page.locator("#component")).containsClass("row middle");
当传递数组时,方法断言所在元素列表与预期类列表匹配。每个元素的类属性与数组中对应的类进行匹配:
🌐 When an array is passed, the method asserts that the list of elements located matches the corresponding list of expected class lists. Each element's class attribute is matched against the corresponding class in the array:
<div class='list'>
<div class='component inactive'></div>
<div class='component active'></div>
<div class='component inactive'></div>
</div>
assertThat(page.locator(".list > .component")).containsClass(new String[] {"inactive", "active", "inactive"});
参数
-
expectedString | List<String>#包含预期类名的字符串(以空格分隔),或用于断言多个元素的此类字符串列表。
-
optionsLocatorAssertions.ContainsClassOptions(optional)
返回
containsText
Added in: v1.20确保 Locator 指向包含给定文本的元素。在计算元素的文本内容时,将考虑所有嵌套元素。你也可以对该值使用正则表达式。
🌐 Ensures the Locator points to an element that contains the given text. All nested elements will be considered when computing the text content of the element. You can use regular expressions for the value as well.
用法
assertThat(page.locator(".title")).containsText("substring");
如果你传递一个数组作为期望值,则期望为:
🌐 If you pass an array as an expected value, the expectations are:
- 定位器解析为元素列表。
- 此列表的子集中的元素分别包含预期数组中的文本。
- 匹配的元素子集与预期数组具有相同的顺序。
- 预期数组中的每个文本值都与列表中的某个元素匹配。
例如,考虑以下列表:
🌐 For example, consider the following list:
<ul>
<li>Item Text 1</li>
<li>Item Text 2</li>
<li>Item Text 3</li>
</ul>
让我们看看如何使用断言:
🌐 Let's see how we can use the assertion:
// ✓ Contains the right items in the right order
assertThat(page.locator("ul > li")).containsText(new String[] {"Text 1", "Text 3"});
// ✖ Wrong order
assertThat(page.locator("ul > li")).containsText(new String[] {"Text 3", "Text 2"});
// ✖ No item contains this text
assertThat(page.locator("ul > li")).containsText(new String[] {"Some 33"});
// ✖ Locator points to the outer list element, not to the list items
assertThat(page.locator("ul")).containsText(new String[] {"Text 3"});
参数
-
expectedString | Pattern | String[] | Pattern[] Added in: v1.18#预期的子字符串或正则表达式或这些的列表。
-
optionsLocatorAssertions.ContainsTextOptions(optional)
返回
详情
当 expected 参数是字符串时,Playwright 会在匹配前对实际文本和预期字符串中的空格和换行进行规范化。当使用正则表达式时,实际文本将按原样进行匹配。
🌐 When expected parameter is a string, Playwright will normalize whitespaces and line breaks both in the actual text and in the expected string before matching. When regular expression is used, the actual text is matched as is.
hasAccessibleDescription
Added in: v1.44🌐 Ensures the Locator points to an element with a given accessible description.
用法
Locator locator = page.getByTestId("save-button");
assertThat(locator).hasAccessibleDescription("Save results to disk");
参数
-
预期可访问描述。
-
optionsLocatorAssertions.HasAccessibleDescriptionOptions(optional)-
setIgnoreCaseboolean (optional)#是否执行不区分大小写的匹配。如果指定, setIgnoreCase 选项优先于相应的正则表达式标志。
-
重试断言的时间(以毫秒为单位)。默认值为
5000。
-
返回
hasAccessibleErrorMessage
Added in: v1.50确保 Locator 指向具有指定 aria errormessage 的元素。
🌐 Ensures the Locator points to an element with a given aria errormessage.
用法
Locator locator = page.getByTestId("username-input");
assertThat(locator).hasAccessibleErrorMessage("Username is required.");
参数
-
errorMessageString | Pattern#预期可访问的错误消息。
-
optionsLocatorAssertions.HasAccessibleErrorMessageOptions(optional)-
setIgnoreCaseboolean (optional)#是否执行不区分大小写的匹配。如果指定, setIgnoreCase 选项优先于相应的正则表达式标志。
-
重试断言的时间(以毫秒为单位)。默认值为
5000。
-
返回
hasAccessibleName
Added in: v1.44🌐 Ensures the Locator points to an element with a given accessible name.
用法
Locator locator = page.getByTestId("save-button");
assertThat(locator).hasAccessibleName("Save to disk");
参数
-
预期可访问名称。
-
optionsLocatorAssertions.HasAccessibleNameOptions(optional)-
setIgnoreCaseboolean (optional)#是否执行不区分大小写的匹配。如果指定, setIgnoreCase 选项优先于相应的正则表达式标志。
-
重试断言的时间(以毫秒为单位)。默认值为
5000。
-
返回
hasAttribute
Added in: v1.20确保 Locator 指向具有指定属性的元素。
🌐 Ensures the Locator points to an element with given attribute.
用法
assertThat(page.locator("input")).hasAttribute("type", "text");
参数
-
属性名称。
-
valueString | Pattern Added in: v1.18#期望的属性值。
-
optionsLocatorAssertions.HasAttributeOptions(optional)-
setIgnoreCaseboolean (optional) Added in: v1.40#是否执行不区分大小写的匹配。如果指定, setIgnoreCase 选项优先于相应的正则表达式标志。
-
setTimeoutdouble (optional) Added in: v1.18#重试断言的时间(以毫秒为单位)。默认值为
5000。
-
返回
hasClass
Added in: v1.20确保 Locator 指向具有指定 CSS 类的元素。当提供字符串时,它必须与元素的 class 属性完全匹配。要匹配单个类,请使用 assertThat(locator).containsClass()。
🌐 Ensures the Locator points to an element with given CSS classes. When a string is provided, it must fully match the element's class attribute. To match individual classes use assertThat(locator).containsClass().
用法
<div class='middle selected row' id='component'></div>
assertThat(page.locator("#component")).hasClass("middle selected row");
assertThat(page.locator("#component")).hasClass(Pattern.compile("(^|\\s)selected(\\s|$)"));
当传入一个数组时,该方法会断言定位到的元素列表与相应的预期类值列表匹配。每个元素的类属性都会与数组中的相应字符串或正则表达式进行匹配:
🌐 When an array is passed, the method asserts that the list of elements located matches the corresponding list of expected class values. Each element's class attribute is matched against the corresponding string or regular expression in the array:
assertThat(page.locator(".list > .component")).hasClass(new String[] {"component", "component selected", "component"});
参数
-
expectedString | Pattern | String[] | Pattern[] Added in: v1.18#预期的类或 RegExp 或这些的列表。
-
optionsLocatorAssertions.HasClassOptions(optional)
返回
hasCount
Added in: v1.20确保 Locator 解析为确切数量的 DOM 节点。
🌐 Ensures the Locator resolves to an exact number of DOM nodes.
用法
assertThat(page.locator("list > .component")).hasCount(3);
参数
-
预期计数。
-
optionsLocatorAssertions.HasCountOptions(optional)
返回
hasCSS
Added in: v1.20确保 Locator 解析为具有给定计算 CSS 样式的元素。
🌐 Ensures the Locator resolves to an element with the given computed CSS style.
用法
assertThat(page.getByRole(AriaRole.BUTTON)).hasCSS("display", "flex");
参数
-
CSS 属性名称。
-
valueString | Pattern Added in: v1.18#CSS 属性值。
-
optionsLocatorAssertions.HasCSSOptions(optional)
返回
hasId
Added in: v1.20确保 Locator 指向具有指定 DOM 节点 ID 的元素。
🌐 Ensures the Locator points to an element with the given DOM Node ID.
用法
assertThat(page.getByRole(AriaRole.TEXTBOX)).hasId("lastname");
参数
返回
hasJSProperty
Added in: v1.20确保 Locator 指向具有指定 JavaScript 属性的元素。请注意,该属性可以是原始类型,也可以是普通可序列化的 JavaScript 对象。
🌐 Ensures the Locator points to an element with given JavaScript property. Note that this property can be of a primitive type as well as a plain serializable JavaScript object.
用法
assertThat(page.locator("input")).hasJSProperty("loaded", true);
参数
-
属性名称。
-
属性值
-
optionsLocatorAssertions.HasJSPropertyOptions(optional)
返回
hasRole
Added in: v1.44确保 Locator 指向具有指定 ARIA 角色 的元素。
🌐 Ensures the Locator points to an element with a given ARIA role.
请注意,角色是作为字符串匹配的,不考虑 ARIA 角色层次。例如,在具有子类角色 "switch" 的元素上断言超类角色 "checkbox" 将会失败。
🌐 Note that role is matched as a string, disregarding the ARIA role hierarchy. For example, asserting a superclass role "checkbox" on an element with a subclass role "switch" will fail.
用法
Locator locator = page.getByTestId("save-button");
assertThat(locator).hasRole(AriaRole.BUTTON);
参数
-
roleenum AriaRole { ALERT, ALERTDIALOG, APPLICATION, ARTICLE, BANNER, BLOCKQUOTE, BUTTON, CAPTION, CELL, CHECKBOX, CODE, COLUMNHEADER, COMBOBOX, COMPLEMENTARY, CONTENTINFO, DEFINITION, DELETION, DIALOG, DIRECTORY, DOCUMENT, EMPHASIS, FEED, FIGURE, FORM, GENERIC, GRID, GRIDCELL, GROUP, HEADING, IMG, INSERTION, LINK, LIST, LISTBOX, LISTITEM, LOG, MAIN, MARQUEE, MATH, METER, MENU, MENUBAR, MENUITEM, MENUITEMCHECKBOX, MENUITEMRADIO, NAVIGATION, NONE, NOTE, OPTION, PARAGRAPH, PRESENTATION, PROGRESSBAR, RADIO, RADIOGROUP, REGION, ROW, ROWGROUP, ROWHEADER, SCROLLBAR, SEARCH, SEARCHBOX, SEPARATOR, SLIDER, SPINBUTTON, STATUS, STRONG, SUBSCRIPT, SUPERSCRIPT, SWITCH, TAB, TABLE, TABLIST, TABPANEL, TERM, TEXTBOX, TIME, TIMER, TOOLBAR, TOOLTIP, TREE, TREEGRID, TREEITEM }#所需的咏叹调角色。
-
optionsLocatorAssertions.HasRoleOptions(optional)
返回
hasText
Added in: v1.20确保 Locator 指向具有给定文本的元素。在计算元素的文本内容时,会考虑所有嵌套的元素。你也可以对该值使用正则表达式。
🌐 Ensures the Locator points to an element with the given text. All nested elements will be considered when computing the text content of the element. You can use regular expressions for the value as well.
用法
assertThat(page.locator(".title")).hasText("Welcome, Test User");
assertThat(page.locator(".title")).hasText(Pattern.compile("Welcome, .*"));
如果你传递一个数组作为期望值,则期望为:
🌐 If you pass an array as an expected value, the expectations are:
- 定位器解析为元素列表。
- 元素的数量等于数组中期望值的数量。
- 列表中的元素具有按顺序一一匹配预期数组值的文本。
例如,考虑以下列表:
🌐 For example, consider the following list:
<ul>
<li>Text 1</li>
<li>Text 2</li>
<li>Text 3</li>
</ul>
让我们看看如何使用断言:
🌐 Let's see how we can use the assertion:
// ✓ Has the right items in the right order
assertThat(page.locator("ul > li")).hasText(new String[] {"Text 1", "Text 2", "Text 3"});
// ✖ Wrong order
assertThat(page.locator("ul > li")).hasText(new String[] {"Text 3", "Text 2", "Text 1"});
// ✖ Last item does not match
assertThat(page.locator("ul > li")).hasText(new String[] {"Text 1", "Text 2", "Text"});
// ✖ Locator points to the outer list element, not to the list items
assertThat(page.locator("ul")).hasText(new String[] {"Text 1", "Text 2", "Text 3"});
参数
-
expectedString | Pattern | String[] | Pattern[] Added in: v1.18#预期的字符串或正则表达式或它们的列表。
-
optionsLocatorAssertions.HasTextOptions(optional)
返回
详情
当 expected 参数是字符串时,Playwright 会在匹配前对实际文本和预期字符串中的空格和换行进行规范化。当使用正则表达式时,实际文本将按原样进行匹配。
🌐 When expected parameter is a string, Playwright will normalize whitespaces and line breaks both in the actual text and in the expected string before matching. When regular expression is used, the actual text is matched as is.
hasValue
Added in: v1.20确保 Locator 指向具有给定输入值的元素。你也可以为该值使用正则表达式。
🌐 Ensures the Locator points to an element with the given input value. You can use regular expressions for the value as well.
用法
assertThat(page.locator("input[type=number]")).hasValue(Pattern.compile("[0-9]"));
参数
返回
hasValues
Added in: v1.23确保 Locator 指向多选/组合框(即带有 multiple 属性的 select),并且选择了指定的值。
🌐 Ensures the Locator points to multi-select/combobox (i.e. a select with the multiple attribute) and the specified values are selected.
用法
例如,给定以下元素:
🌐 For example, given the following element:
<select id="favorite-colors" multiple>
<option value="R">Red</option>
<option value="G">Green</option>
<option value="B">Blue</option>
</select>
page.locator("id=favorite-colors").selectOption(new String[]{"R", "G"});
assertThat(page.locator("id=favorite-colors")).hasValues(new Pattern[] { Pattern.compile("R"), Pattern.compile("G") });
参数
-
当前选择的预期选项。
-
optionsLocatorAssertions.HasValuesOptions(optional)
返回
isAttached
Added in: v1.33确保 Locator 指向一个已 连接 到文档或 ShadowRoot 的元素。
🌐 Ensures that Locator points to an element that is connected to a Document or a ShadowRoot.
用法
assertThat(page.getByText("Hidden text")).isAttached();
参数
optionsLocatorAssertions.IsAttachedOptions(optional)
返回
isChecked
Added in: v1.20确保 Locator 指向已选中的输入项。
🌐 Ensures the Locator points to a checked input.
用法
assertThat(page.getByLabel("Subscribe to newsletter")).isChecked();
参数
optionsLocatorAssertions.IsCheckedOptions(optional)-
setCheckedboolean (optional) Added in: v1.18#提供要断言的状态。默认情况下断言要检查的输入。当 setIndeterminate 设置为 true 时,不能使用此选项。
-
setIndeterminateboolean (optional) Added in: v1.50#断言该元素处于不确定(混合)状态。仅支持复选框和单选按钮。当提供 setChecked 时,此选项不能为真。
-
setTimeoutdouble (optional) Added in: v1.18#重试断言的时间(以毫秒为单位)。默认值为
5000。
-
返回
isDisabled
Added in: v1.20确保 Locator 指向一个已禁用的元素。如果元素具有“disabled”属性或通过 'aria-disabled' 被禁用,则该元素被视为已禁用。请注意,只有像 HTML button、input、select、textarea、option、optgroup 这样的原生控件元素可以通过设置“disabled”属性来禁用。浏览器会忽略其他元素上的“disabled”属性。
🌐 Ensures the Locator points to a disabled element. Element is disabled if it has "disabled" attribute or is disabled via 'aria-disabled'. Note that only native control elements such as HTML button, input, select, textarea, option, optgroup can be disabled by setting "disabled" attribute. "disabled" attribute on other elements is ignored by the browser.
用法
assertThat(page.locator("button.submit")).isDisabled();
参数
optionsLocatorAssertions.IsDisabledOptions(optional)
返回
isEditable
Added in: v1.20确保 Locator 指向可编辑的元素。
🌐 Ensures the Locator points to an editable element.
用法
assertThat(page.getByRole(AriaRole.TEXTBOX)).isEditable();
参数
optionsLocatorAssertions.IsEditableOptions(optional)
返回
isEmpty
Added in: v1.20确保 Locator 指向一个空的可编辑元素或没有文本的 DOM 节点。
🌐 Ensures the Locator points to an empty editable element or to a DOM node that has no text.
用法
assertThat(page.locator("div.warning")).isEmpty();
参数
optionsLocatorAssertions.IsEmptyOptions(optional)
返回
isEnabled
Added in: v1.20确保 Locator 指向一个已启用的元素。
🌐 Ensures the Locator points to an enabled element.
用法
assertThat(page.locator("button.submit")).isEnabled();
参数
optionsLocatorAssertions.IsEnabledOptions(optional)
返回
isFocused
Added in: v1.20确保 Locator 指向一个已聚焦的 DOM 节点。
🌐 Ensures the Locator points to a focused DOM node.
用法
assertThat(page.getByRole(AriaRole.TEXTBOX)).isFocused();
参数
optionsLocatorAssertions.IsFocusedOptions(optional)
返回
isHidden
Added in: v1.20确保 Locator 要么无法解析到任何 DOM 节点,要么解析到一个不可见的节点。
🌐 Ensures that Locator either does not resolve to any DOM node, or resolves to a non-visible one.
用法
assertThat(page.locator(".my-element")).isHidden();
参数
optionsLocatorAssertions.IsHiddenOptions(optional)
返回
isInViewport
Added in: v1.31确保 Locator 指向根据 intersection observer API 与视口相交的元素。
🌐 Ensures the Locator points to an element that intersects viewport, according to the intersection observer API.
用法
Locator locator = page.getByRole(AriaRole.BUTTON);
// Make sure at least some part of element intersects viewport.
assertThat(locator).isInViewport();
// Make sure element is fully outside of viewport.
assertThat(locator).not().isInViewport();
// Make sure that at least half of the element intersects viewport.
assertThat(locator).isInViewport(new LocatorAssertions.IsInViewportOptions().setRatio(0.5));
参数
optionsLocatorAssertions.IsInViewportOptions(optional)
返回
isVisible
Added in: v1.20确保 Locator 指向一个已附加且可见的 DOM 节点。
🌐 Ensures that Locator points to an attached and visible DOM node.
要检查列表中至少有一个元素可见,请使用 [Locator.first()](/api/class-locator.mdx#locator-first)。
🌐 To check that at least one element from the list is visible, use Locator.first().
用法
// A specific element is visible.
assertThat(page.getByText("Welcome")).isVisible();
// At least one item in the list is visible.
assertThat(page.getByTestId("todo-item").first()).isVisible();
// At least one of the two elements is visible, possibly both.
assertThat(
page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("Sign in"))
.or(page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("Sign up")))
.first()
).isVisible();
参数
optionsLocatorAssertions.IsVisibleOptions(optional)
返回
matchesAriaSnapshot
Added in: v1.49断言目标元素与给定的辅助功能快照匹配。
🌐 Asserts that the target element matches the given accessibility snapshot.
用法
page.navigate("https://demo.playwright.dev/todomvc/");
assertThat(page.locator("body")).matchesAriaSnapshot("""
- heading "todos"
- textbox "What needs to be done?"
""");
参数
返回
属性
🌐 Properties
not()
Added in: v1.20使断言检查相反的条件。例如,这段代码测试 Locator 不包含文本 "error":
🌐 Makes the assertion check for the opposite condition. For example, this code tests that the Locator doesn't contain text "error":
assertThat(locator).not().containsText("error");
用法
assertThat(locator).not()
返回