From 3c694252a32cf1a4323cd37741fb872b9f6d4add Mon Sep 17 00:00:00 2001
From: Vitali Kepin <vkepin@gmail.com>
Date: Mon, 2 Jan 2023 13:55:10 +0100
Subject: [PATCH] Update syntax for "When I go to the relative URL
 '$relativeURL'" step

---
 .../partials/plugin-web-app-steps.adoc        | 44 +++++++++++++++++++
 .../org/vividus/steps/ui/web/PageSteps.java   | 23 ++++++++--
 .../resources/steps/defaults/composite.steps  |  4 ++
 .../story/integration/PageStepsTests.story    | 10 +++++
 4 files changed, 77 insertions(+), 4 deletions(-)

diff --git a/docs/modules/plugins/partials/plugin-web-app-steps.adoc b/docs/modules/plugins/partials/plugin-web-app-steps.adoc
index 2eed18ef49..e2042936c6 100644
--- a/docs/modules/plugins/partials/plugin-web-app-steps.adoc
+++ b/docs/modules/plugins/partials/plugin-web-app-steps.adoc
@@ -2,6 +2,50 @@
 :popup-alert: https://www.w3schools.com/js/js_popup.asp
 :close-spec: https://w3c.github.io/webdriver/webdriver-spec.html#close-window[close]
 
+=== Steps opening pages
+
+==== Open page with relative URL
+
+Navigates the browser to the specific path in the current host defined in the _relative URL_ step variable.
+
+A relative URL can point to a file within a web site (like `about.html` or `/products`).
+If the parameter starts with '/' char, navigation will be performed from the root of the host, see examples below.
+
+.Examples
+|===
+|Current page |Relative URL parameter|Opened page
+
+|https://mysite.com
+|about.html
+|https://mysite.com/about.html
+
+|https://mysite.com
+|/products/new
+|https://mysite.com/products/new
+
+|https://mysite.com/path/foo
+|stats
+|https://mysite.com/path/stats
+
+|https://mysite.com/path/foo
+|/documents
+|https://mysite.com/documents
+|===
+
+[source,gherkin]
+----
+When I go to relative URL `$relativeURL`
+----
+
+* `relativeURL` - A string value of the relative URL
+
+. Open main application page and then navigate to '/products/new' page on the application host
+[source,gherkin]
+----
+Given I am on main application page
+When I go to relative URL `/products/new`
+----
+
 === Clicking steps
 
 ==== Click on element
diff --git a/vividus-plugin-web-app/src/main/java/org/vividus/steps/ui/web/PageSteps.java b/vividus-plugin-web-app/src/main/java/org/vividus/steps/ui/web/PageSteps.java
index 8ab912d48b..aa726a9d47 100644
--- a/vividus-plugin-web-app/src/main/java/org/vividus/steps/ui/web/PageSteps.java
+++ b/vividus-plugin-web-app/src/main/java/org/vividus/steps/ui/web/PageSteps.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2022 the original author or authors.
+ * Copyright 2019-2023 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -236,9 +236,24 @@ public void isPageScrolledToAnElement(Locator locator)
     }
 
     /**
-     * Goes to the relative URL
+     * Navigates the browser to the specific path in the current host
+     * defined in the <i>relative URL</i> step variable
      * <br>
-     * A <b>relative URL</b> - points to a file within a web site (like <i>'about.html'</i> or <i>'/products'</i>)<br>
+     * A <b>relative URL</b> - points to a file within a web site
+     * (like <i>'about.html'</i> or <i>'/products'</i>)<br>
+     * <p>
+     * <table border="1">
+     * <caption>Examples:</caption>
+     * <tr>
+     * <td>Current page</td><td>Relative URL parameter</td><td>Opened page</td>
+     * </tr>
+     * <tr>
+     * <td>https://mysite.com/path/foo</td><td>stats</td><td>https://mysite.com/path/stats</td>
+     * </tr>
+     * <tr>
+     * <td>https://mysite.com/path/foo</td><td>/documents</td><td>https://mysite.com/documents</td>
+     * </tr>
+     * </table>
      * <p>
      * Actions performed at this step:
      * <ul>
@@ -248,7 +263,7 @@ public void isPageScrolledToAnElement(Locator locator)
      * <p>
      * @param relativeURL A string value of the relative URL
      */
-    @When("I go to the relative URL '$relativeURL'")
+    @When("I go to relative URL `$relativeURL`")
     public void iGoTo(String relativeURL)
     {
         setContextSteps.switchingToDefault();
diff --git a/vividus-plugin-web-app/src/main/resources/steps/defaults/composite.steps b/vividus-plugin-web-app/src/main/resources/steps/defaults/composite.steps
index 21510b9795..8546055fbb 100644
--- a/vividus-plugin-web-app/src/main/resources/steps/defaults/composite.steps
+++ b/vividus-plugin-web-app/src/main/resources/steps/defaults/composite.steps
@@ -284,3 +284,7 @@ When I wait until element located by `<locator>` contains text `<text>'
 Composite: Then element located '$locator' disappears in '$timeout'
 !-- WARNING: The step "Then element located '$locator' disappears in '$timeout'" is deprecated and will be removed in VIVIDUS 0.6.0
 Then element located by `<locator>` disappears in `<timeout>`
+
+Composite: When I go to the relative URL '$relativeURL'
+!-- WARNING: The step "When I go to the relative URL '$relativeURL'" is deprecated and will be removed in VIVIDUS 0.7.0
+When I go to relative URL `<relativeURL>`
diff --git a/vividus-tests/src/main/resources/story/integration/PageStepsTests.story b/vividus-tests/src/main/resources/story/integration/PageStepsTests.story
index bb64287633..120d237985 100644
--- a/vividus-tests/src/main/resources/story/integration/PageStepsTests.story
+++ b/vividus-tests/src/main/resources/story/integration/PageStepsTests.story
@@ -29,3 +29,13 @@ Examples:
 |DNS_LOOKUP_TIME      |
 |DOM_CONTENT_LOAD_TIME|
 |PAGE_LOAD_TIME       |
+
+Scenario: Verify step: When I go to relative URL `$relativeURL`
+Given I am on a page with the URL '${vividus-test-site-url}'
+When I go to relative URL `/elementState.html`
+Then number of elements found by `id(element-to-hide)` is equal to `1`
+
+Scenario: Verify deprecated step: When I go to the relative URL '$relativeURL'
+Given I am on a page with the URL '${vividus-test-site-url}'
+When I go to the relative URL '/elementState.html'
+Then number of elements found by `id(element-to-hide)` is equal to `1`