[plugin-web-app] Use `tab` instead of `window` in steps syntax #3857

vkepin · 2023-04-19T20:43:01Z

No description provided.

valfirst · 2023-04-20T07:50:33Z

vividus-plugin-web-app/src/main/java/org/vividus/steps/ui/web/SetContextSteps.java

@@ -129,6 +129,8 @@ public void switchingToFrame(Locator locator)
     * reference</i></a>
     */
    @When("I switch to a new window")
+    // @When("I switch to a new tab")


Suggested change

// @When("I switch to a new tab")

// @When("I switch to new tab")

valfirst · 2023-04-20T07:51:17Z

vividus-plugin-web-app/src/main/java/org/vividus/steps/ui/web/WindowSteps.java

@@ -164,6 +169,7 @@ public void closeCurrentWindowWithAlertsHandling()
        });
    }

+    //TODO: rename? tryToCloseCurrentTab(BiConsumer<WebDriver, String> closeExecutor)


yes, rename please

valfirst · 2023-04-20T07:51:36Z

vividus-plugin-web-app/src/main/java/org/vividus/ui/web/action/IWindowsActions.java

    String switchToWindowWithMatchingTitle(Matcher<String> matcher);

    /**
     * Switches to a previous window
     */
+    // rename? switchToPreviousTab();


yes, rename all methods

valfirst · 2023-04-20T07:51:59Z

vividus-plugin-web-app/src/main/java/org/vividus/ui/web/action/WindowsActions.java

@@ -31,6 +31,8 @@
 import org.vividus.selenium.IWebDriverProvider;
 import org.vividus.selenium.manager.IWebDriverManager;

+// update according changes in IWindowsActions + update messages in methods
+// private methods renaming?


yes, full renaming

valfirst · 2023-04-20T07:53:03Z

...dus-plugin-web-app/src/main/java/org/vividus/ui/web/listener/PerformanceMetricsListener.java

@@ -51,6 +51,7 @@ public void afterNavigateTo(String url, WebDriver driver)
        resetPerformanceMetrics();
    }

+    // Should update to tab?


I don't think that's possible, it's an implementation of Selenium interface

valfirst · 2023-04-25T10:38:15Z

vividus-plugin-web-app/src/main/java/org/vividus/steps/ui/web/SetContextSteps.java

        if (descriptiveSoftAssert.assertThat(String.format("New window '%s' is found", newWindow),
                "New window is found", newWindow, not(equalTo(currentWindow))))
        {
            resetContext();
        }
    }

+    /**
+     * Switch the focus of future browser commands to the new <b>window object</b>.


let's avoid window in javadocs and docs

codecov · 2023-05-19T08:12:47Z

Codecov Report

Merging #3857 (1bb7371) into master (0e0420c) will decrease coverage by 0.03%.
The diff coverage is 98.18%.

❗ Current head 1bb7371 differs from pull request most recent head beb417b. Consider uploading reports for the commit beb417b to get more accurate results

@@             Coverage Diff              @@
##             master    #3857      +/-   ##
============================================
- Coverage     97.18%   97.15%   -0.03%     
+ Complexity     6432     6268     -164     
============================================
  Files           897      871      -26     
  Lines         18516    17990     -526     
  Branches       1216     1172      -44     
============================================
- Hits          17995    17479     -516     
+ Misses          412      404       -8     
+ Partials        109      107       -2

Impacted Files	Coverage Δ
...rg/vividus/ui/web/action/WebJavascriptActions.java	`100.00% <ø> (ø)`
...us/ui/web/listener/PerformanceMetricsListener.java	`100.00% <ø> (ø)`
...java/org/vividus/ui/web/action/WindowsActions.java	`93.93% <94.44%> (ø)`
...c/main/java/org/vividus/steps/WindowsStrategy.java	`100.00% <100.00%> (ø)`
.../main/java/org/vividus/steps/ui/web/PageSteps.java	`98.93% <100.00%> (+0.11%)`	⬆️
...java/org/vividus/steps/ui/web/SetContextSteps.java	`100.00% <100.00%> (ø)`
...ain/java/org/vividus/steps/ui/web/WindowSteps.java	`100.00% <100.00%> (ø)`
...n/java/org/vividus/ui/web/action/AlertActions.java	`90.47% <100.00%> (-1.42%)`	⬇️

... and 82 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

vkepin · 2023-05-19T16:42:10Z

docs/modules/plugins/pages/plugin-web-app.adoc

@@ -177,23 +177,29 @@ When I close browser

 === Wait for window and switch


update to tab

valfirst · 2023-04-25T10:39:55Z

vividus-plugin-web-app/src/main/java/org/vividus/steps/ui/web/SetContextSteps.java

+        if (descriptiveSoftAssert.assertThat(String.format(NEW_TAB_FOUND_FORMAT, newTab),
+                newTab, not(equalTo(currentTab))))


how does assertion message look like?

New tab '{770e3411-5e19-4831-8f36-fc76e46a2807}' is found

quite informative :)

does iit make sense to put tab title as part of this msg?

as a result of descussion -> just remove tab id from the message

valfirst · 2023-05-30T07:53:24Z

docs/modules/plugins/partials/plugin-web-app-steps.adoc

+
+This step is used to open the provided URL in a new browser tab.
+[NOTE]
+The newly opened tab will be the active tab, and any subsequent steps will be carried out in this new tab.


Suggested change

The newly opened tab will be the active tab, and any subsequent steps will be carried out in this new tab.

The newly opened tab will be the active tab, and any subsequent steps will be executed on this new tab.

valfirst · 2023-05-30T07:54:47Z

docs/modules/plugins/partials/plugin-web-app-steps.adoc

 [source,gherkin]
 ----
 When I switch to a new window
 ----
-


it makes sense to keep it

valfirst · 2023-05-30T07:57:20Z

vividus-build-system

redundant changes

valfirst · 2023-05-30T07:59:51Z

vividus-plugin-web-app/src/main/java/org/vividus/ui/web/action/WindowsActions.java

    }

-    private void closeSmallerWindows(Set<String> windows)
+    // ??? Tabs or windows


vividus-plugin-web-app/src/main/java/org/vividus/steps/ui/web/PageSteps.java

vividus-plugin-web-app/src/main/java/org/vividus/steps/ui/web/SetContextSteps.java

valfirst · 2023-06-09T08:59:24Z

docs/modules/plugins/partials/plugin-web-app-steps.adoc

@@ -696,6 +733,16 @@ Then text `Modal Frame Example` exists

 Switch the focus of future browser commands to new tab.

+This step gets the identifier of the currently active tab and then switches focus to the first available tab with a different identifier. For example, if tabs #1, #2, #3 are open and tab #2 is active, this method will switch focus to tab #3.


Suggested change

This step gets the identifier of the currently active tab and then switches focus to the first available tab with a different identifier. For example, if tabs #1, #2, #3 are open and tab #2 is active, this method will switch focus to tab #3.

This step gets the identifier of the currently active tab and then switches focus to the first available tab with a different identifier. For example, if tabs #1, #2, #3 are open and tab #2 is active, this step will switch focus to tab #3.

valfirst · 2023-06-09T11:40:38Z

docs/modules/plugins/partials/plugin-web-app-steps.adoc

+
+[source,gherkin]
+----
+When I open URL `$pageUrl` in new tab


isn't it documented below?

valfirst · 2023-06-09T11:41:38Z

vividus-plugin-web-app/src/main/java/org/vividus/steps/ui/web/SetContextSteps.java

+     * <ul>
+     * <li>Gets identifier of the currently active tab;
+     * <li>Switches focus to the first available tab with another identifier. So if currently there are 3 opened
+     * tabs #1, #2, #3 and tab #2 is active one, using this method will switch focus to the tab #3;


Suggested change

* tabs #1, #2, #3 and tab #2 is active one, using this method will switch focus to the tab #3;

* tabs #1, #2, #3 and tab #2 is active one, using this step will switch focus to the tab #3;

valfirst · 2023-06-09T11:42:28Z

vividus-plugin-web-app/src/main/java/org/vividus/steps/ui/web/SetContextSteps.java

+    {
+        String currentTab = getWebDriver().getWindowHandle();
+        String newTab = windowsActions.switchToNewTab(currentTab);
+        if (descriptiveSoftAssert.assertThat("New tab is found", newTab, not(equalTo(currentTab))))


haven't we agreed to simplify this assertion?

if I understand correctly, we decided just to simplify the assertion message - remove tab id from the message

it makes sense to replace assertThat with recordAssertion, since matcher not(equalTo(currentTab)) doesn't provide any value for users

valfirst · 2023-06-09T12:55:17Z

vividus-plugin-web-app/src/main/java/org/vividus/steps/ui/web/SetContextSteps.java

@@ -212,7 +264,7 @@ public Boolean apply(WebDriver driver)
            public String toString()
            {
                //TODO: change to comparisonRule.toString() once it will be safe
-                return String.format("switch to a window where title %s \"%s\"", comparisonRule.name(), title);
+                return String.format("switch to the tab where title %s \"%s\"", comparisonRule.name(), title);


good time to switch to comparisonRule.toString()

valfirst · 2023-06-26T10:14:56Z

vividus-plugin-web-app/src/main/java/org/vividus/steps/ui/web/SetContextSteps.java

+    {
+        String currentTab = getWebDriver().getWindowHandle();
+        String newTab = windowsActions.switchToNewTab(currentTab);
+        if (descriptiveSoftAssert.assertThat("New tab is found", newTab, not(equalTo(currentTab))))


it makes sense to replace assertThat with recordAssertion, since matcher not(equalTo(currentTab)) doesn't provide any value for users

valfirst · 2023-06-26T10:16:00Z

vividus-plugin-web-app/src/main/java/org/vividus/steps/ui/web/WindowSteps.java

-        softAssert.assertThat("Current window has been closed", driver.getWindowHandles(),
-                not(contains(currentWindow)));
+        softAssert.assertThat("Current tab has been closed", driver.getWindowHandles(),
+                not(contains(currentTab)));


see the comment above about using recordAssertion instead of assertThat

valfirst · 2023-06-26T10:17:12Z

vividus-plugin-web-app/src/main/resources/steps/defaults/composite.steps

+!-- Deprecated: 0.7.0, When I wait `%1$s` until tab with title that %2$s `%3$s` appears and switch to it
+When I wait `<duration>` until tab with title that <comparisonRule> `<title>` appears and switch to it
+
+Composite: When I close the current window
+!-- Deprecated: 0.7.0, When I close current tab
+When I close current tab
+
+Composite: When I attempt to close current window with possibility to handle alert
+!-- Deprecated: 0.7.0, When I attempt to close current tab with possibility to handle alert


it was changed to upper case: !-- DEPRECATED:

valfirst

Integration tests are failed

vkepin requested a review from a team as a code owner April 19, 2023 20:43

vkepin requested review from valfirst, ikalinin1 and uarlouski April 19, 2023 20:43

valfirst requested changes Apr 20, 2023

View reviewed changes

vkepin force-pushed the upd_webapp_tabs_steps branch from d243342 to 6c8f1c8 Compare April 24, 2023 17:03

valfirst reviewed Apr 25, 2023

View reviewed changes

vkepin force-pushed the upd_webapp_tabs_steps branch 5 times, most recently from 9e14380 to 1bb7371 Compare May 19, 2023 07:33

vkepin force-pushed the upd_webapp_tabs_steps branch from 1bb7371 to c3f7c0c Compare May 19, 2023 16:38

vkepin commented May 19, 2023

View reviewed changes

vkepin force-pushed the upd_webapp_tabs_steps branch 3 times, most recently from 438c3c9 to 3fe992f Compare May 23, 2023 07:35

vkepin changed the title ~~Init commit~~ Update syntax: 'tab' instead of 'window' May 25, 2023

valfirst force-pushed the master branch from c8134c8 to 277ace7 Compare May 25, 2023 18:29

valfirst requested changes May 30, 2023

View reviewed changes

vkepin force-pushed the upd_webapp_tabs_steps branch 4 times, most recently from 482015c to ff9a97a Compare May 30, 2023 09:29

vkepin commented Jun 5, 2023

View reviewed changes

vividus-plugin-web-app/src/main/java/org/vividus/steps/ui/web/PageSteps.java Show resolved Hide resolved

vkepin commented Jun 5, 2023

View reviewed changes

F438

vividus-plugin-web-app/src/main/java/org/vividus/steps/ui/web/SetContextSteps.java Show resolved Hide resolved

vkepin commented Jun 5, 2023

View reviewed changes

vividus-plugin-web-app/src/main/java/org/vividus/steps/ui/web/SetContextSteps.java Show resolved Hide resolved

vkepin force-pushed the upd_webapp_tabs_steps branch 2 times, most recently from da91add to 10adfc6 Compare June 5, 2023 16:50

vkepin force-pushed the upd_webapp_tabs_steps branch 2 times, most recently from 871e145 to 516bb68 Compare June 9, 2023 08:46

valfirst requested changes Jun 9, 2023

View reviewed changes

vkepin force-pushed the upd_webapp_tabs_steps branch from 516bb68 to 3b06421 Compare June 9, 2023 13:56

uarlouski approved these changes Jun 9, 2023

View reviewed changes

valfirst force-pushed the upd_webapp_tabs_steps branch from 3b06421 to 7797299 Compare June 15, 2023 10:32

valfirst requested changes Jun 26, 2023 10000

View reviewed changes

vkepin force-pushed the upd_webapp_tabs_steps branch 2 times, most recently from 7aa8bfe to e554e49 Compare June 27, 2023 09:55

valfirst approved these changes Jun 27, 2023

View reviewed changes

valfirst requested review from valfirst and uarlouski June 27, 2023 10:23

valfirst requested changes Jun 27, 2023

View reviewed changes

vkepin force-pushed the upd_webapp_tabs_steps branch 4 times, most recently from 6c0c86b to 41290cf Compare June 28, 2023 16:21

Update syntax: 'tab' instead of 'window'

beb417b

vkepin force-pushed the upd_webapp_tabs_steps branch from 41290cf to beb417b Compare June 28, 2023 16:34

valfirst approved these changes Jun 28, 2023

View reviewed changes

valfirst changed the title ~~Update syntax: 'tab' instead of 'window'~~ [plugin-web-app] Use tab instead of window in steps syntax Jun 28, 2023

uarlouski approved these changes Jun 28, 2023

View reviewed changes

valfirst merged commit 6f8ee9c into vividus-framework:master Jun 28, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[plugin-web-app] Use `tab` instead of `window` in steps syntax #3857

[plugin-web-app] Use `tab` instead of `window` in steps syntax #3857

	// @When("I switch to a new tab")
	// @When("I switch to new tab")

		@@ -177,23 +177,29 @@ When I close browser

		=== Wait for window and switch

		if (descriptiveSoftAssert.assertThat(String.format(NEW_TAB_FOUND_FORMAT, newTab),
		newTab, not(equalTo(currentTab))))

	The newly opened tab will be the active tab, and any subsequent steps will be carried out in this new tab.
	The newly opened tab will be the active tab, and any subsequent steps will be executed on this new tab.

		@@ -696,6 +733,16 @@ Then text `Modal Frame Example` exists

		Switch the focus of future browser commands to new tab.

		This step gets the identifier of the currently active tab and then switches focus to the first available tab with a different identifier. For example, if tabs #1, #2, #3 are open and tab #2 is active, this method will switch focus to tab #3.

	* tabs #1, #2, #3 and tab #2 is active one, using this method will switch focus to the tab #3;
	* tabs #1, #2, #3 and tab #2 is active one, using this step will switch focus to the tab #3;

[plugin-web-app] Use tab instead of window in steps syntax #3857

[plugin-web-app] Use tab instead of window in steps syntax #3857

Conversation

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

[plugin-web-app] Use `tab` instead of `window` in steps syntax #3857

[plugin-web-app] Use `tab` instead of `window` in steps syntax #3857