Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Revert "docs(java): Add SoftAssertions for Java (#26512)" (#26917)

Browse source 
As explained in
https://github.com/microsoft/playwright-java/issues/819#issuecomment-1709019419
we are not ready to ship this in its current form. Reverting for now.

This reverts commit 475c96d4c2.
This commit is contained in:
Yury Semikhatsky 2023-09-06 15:28:54 -07:00 committed by GitHub
parent f71df9fb50
commit 34af2b9477
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 0 additions and 115 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

115
docs/src/api/class-softassertions.md
View file

@ -1,115 +0,0 @@
# class: SoftAssertions
* since: v1.38
* langs: java
The [SoftAssertions] class provides assertion methods that can be used to make multiple assertions without failing the test immediately.
```java
...
import com.microsoft.playwright.assertions.SoftAssertions;
public class TestPage {
...
@Test
void hasUrlTextPass() {
SoftAssertions softly = SoftAssertions.create();
page.getByText("Sign in").click();
softly.assertThat(page).hasURL(Pattern.compile(".*/login"));
softly.assertAll();
}
}
```
## method: SoftAssertions.create
* since: v1.38
* langs: java
- returns: <[SoftAssertions]>
Creates a [SoftAssertions] object.
**Usage**
```java
SoftAssertions softly = SoftAssertions.create();
```
## method: SoftAssertions.expectLocator
* since: v1.38
* langs:
- alias-java: assertThat
- returns: <[LocatorAssertions]>
Creates a [LocatorAssertions] object for the given [Locator].
**Usage**
```java
SoftAssertions softly = SoftAssertions.create();
...
softly.assertThat(locator).isVisible();
```
### param: SoftAssertions.expectLocator.locator
* since: v1.38
- `locator` <[Locator]>
[Locator] object to use for assertions.
## method: SoftAssertions.expectPage
* since: v1.38
* langs:
- alias-java: assertThat
- returns: <[PageAssertions]>
Creates a [PageAssertions] object for the given [Page].
**Usage**
```java
SoftAssertions softly = SoftAssertions.create();
...
softly.assertThat(page).hasTitle("News");
```
### param: SoftAssertions.expectPage.page
* since: v1.38
- `page` <[Page]>
[Page] object to use for assertions.
## method: SoftAssertions.expectAPIResponse
* since: v1.38
* langs:
- alias-java: assertThat
- returns: <[APIResponseAssertions]>
Creates a [APIResponseAssertions] object for the given [APIResponse].
**Usage**
```java
SoftAssertions softly = SoftAssertions.create();
...
softly.assertThat(response).isOK();
```
### param: SoftAssertions.expectAPIResponse.response
* since: v1.38
- `response` <[APIResponse]>
[APIResponse] object to use for assertions.
## method: SoftAssertions.assertAll
* since: v1.38
* langs: java
Runs all the assertions have been executed for this [SoftAssertions] object. If any assertions fail, this method throws an AssertionFailedError with the details of all the failed assertions.
**Usage**
```java
SoftAssertions softly = SoftAssertions.create();
...
softly.assertAll();
```