@vardot/varbase-e2e 2.0.0

package/docs/step-definitions/given-i-am-specific-page.md

@@ -0,0 +1,72 @@
+
+# Given I am on "specific" page
+
+## Step Definition Pattern
+
+```gherkin
+Given (I am |we are )*on( the)* "([^"]*)?"( page)*
+```
+
+## Description
+
+This step definition establishes the initial context for test scenarios by navigating to a designated webpage. Upon execution, it performs the necessary actions to access a specific page, including launching a browser, entering the URL, and allowing the page to fully load.
+
+## Usage Examples
+
+```gherkin
+Given I am on "contact"
+
+Given we are on "user/login"
+
+Given I am on the "/about-us" page
+
+Given we are on the "/about-us" page
+
+Given on "/about-us"
+
+Given on the "/about-us" page
+```
+
+## Key Information
+
+This step definition is part of the Varbase E2E 2.0.x documentation's Step Definitions section. It supports flexible phrasing patterns, allowing users to specify page locations using various grammatical structures. The pattern accepts optional articles ("the") and the word "page," accommodating different natural language preferences while directing the test to navigate to the specified URL or page identifier.
+
+## More examples
+
+<!-- generated: extended-examples -->
+
+### Example 1
+
+```gherkin
+Given I am on "/about"
+   Then I should see "Our mission"
+```
+
+### Example 2
+
+```gherkin
+Given I am on "/products?category=laptops"
+   Then I should see 12 ".product-card" elements
+```
+
+### Example 3
+
+```gherkin
+Given we are on the "/contact" page
+   Then "<form>" should be visible
+```
+
+### Example 4
+
+```gherkin
+Given I am on "/blog/2026/05/launch"
+   Then the page should have exactly one h1
+```
+
+### Example 5
+
+```gherkin
+Given on "/admin/users"
+   Then I should see "User list"
+```
+

package/docs/step-definitions/then-i-should-be.md

@@ -0,0 +1,56 @@
+
+# Then I should be
+
+## Overview
+
+This step definition category is designed to verify that navigation functions correctly and users arrive at the intended pages following interactions. As stated on the page: "This step is useful for ensuring that the navigation through a website is working correctly and that the user lands on the intended page after performing certain actions or interactions."
+
+## Available Step Definitions
+
+The "Then I should be" group contains four primary variations:
+
+1. **Then I should be on (the) homepage**
+2. **Then I should not be on (the) homepage**
+3. **Then I should be on "specific page"**
+4. **Then I should not be on "page path"**
+
+Each step allows testers to validate whether the current page matches expected navigation outcomes.
+
+## Purpose
+
+These assertions verify successful navigation by confirming the user's location within the website after executing actions like clicking links, submitting forms, or using browser controls. They serve as validation checkpoints in automated testing workflows.
+
+## More examples
+
+<!-- generated: extended-examples -->
+
+### Example 1
+
+```gherkin
+Then I should be on "/dashboard"
+```
+
+### Example 2
+
+```gherkin
+Then I should be on the homepage
+```
+
+### Example 3
+
+```gherkin
+And I should not be on the frontpage
+```
+
+### Example 4
+
+```gherkin
+Then we should be on "/account"
+```
+
+### Example 5
+
+```gherkin
+Then I should be on "/auth/callback"
+```
+

package/docs/step-definitions/then-i-should-see.md

@@ -0,0 +1,62 @@
+
+# Then I should see
+
+## Overview
+
+This step definition enables verification that specific elements or messages display correctly on a webpage or application, confirming expected content visibility for both users and automated tests.
+
+## Available Step Definitions
+
+The following step variations are available:
+
+- Then I should see "text in the page"
+- Then I should not see "text in the page"
+- Then I should see text matching "text pattern"
+- Then I should not see text matching "text pattern"
+- Then I should see text matching "text pattern" in the "element" element
+- Then I should not see text matching "text pattern" in the "element" element
+- Then I should see (a/an) "field" element
+- Then I should not see (a/an) "field" element
+- Then I should see "value" in the "text" element
+- Then I should not see "value" in the "text" element
+- Then I should see "value" in the "text" element by attr
+- Then I should not see "value" in the "text" element by attr
+
+## Purpose
+
+"This step is useful for verifying that certain elements or messages are displayed correctly on a webpage or application, ensuring that the expected content is visible to the user or the automated tests."
+
+## More examples
+
+<!-- generated: extended-examples -->
+
+### Example 1
+
+```gherkin
+Then I should see "Welcome"
+```
+
+### Example 2
+
+```gherkin
+Then I should not see "Access denied"
+```
+
+### Example 3
+
+```gherkin
+And I should see "Order Confirmed"
+```
+
+### Example 4
+
+```gherkin
+Then we should see "Sign in"
+```
+
+### Example 5
+
+```gherkin
+Then I should see "Total: $99.00"
+```
+

package/docs/step-definitions/then-item-checkbox.md

@@ -0,0 +1,54 @@
+
+# Then the "item" checkbox
+
+## Overview
+
+This step definition validates whether a checkbox associated with a specified item is in a checked or unchecked state. It serves to confirm expected checkbox behavior during automated testing.
+
+## Related Step Definitions
+
+The following variations of this step are available:
+
+- **Then the "item" checkbox is checked** – Asserts the checkbox is currently checked
+- **Then the "item" checkbox is not checked** – Asserts the checkbox is currently unchecked
+- **Then the "item" checkbox should be checked** – Validates the checkbox should be in a checked state
+- **Then the "item" checkbox should not be checked** – Validates the checkbox should be in an unchecked state
+
+## Purpose
+
+This step definition "typically indicates that the associated option or feature is in a checked or unchecked state. It is used to validate the expected behavior."
+
+## More examples
+
+<!-- generated: extended-examples -->
+
+### Example 1
+
+```gherkin
+Then the "#privacy-policy" checkbox should be checked
+```
+
+### Example 2
+
+```gherkin
+Then the "#newsletter" checkbox should not be checked
+```
+
+### Example 3
+
+```gherkin
+And the "#agree" checkbox is checked
+```
+
+### Example 4
+
+```gherkin
+Then the checkbox "#subscribe" should be checked
+```
+
+### Example 5
+
+```gherkin
+Then the checkbox ".terms" is not checked
+```
+

package/docs/step-definitions/then-item-link-should-contain-url.md

@@ -0,0 +1,84 @@
+
+# Then the "item" link should contain "url"
+
+## Basic Definition
+
+This step ensures that the `href` attribute of a link element includes a URL or part of a URL, identified by its link text.
+
+**Gherkin Pattern:**
+```
+Then (the )*"([^"]*)?" link should contain "([^"]*)?"
+```
+
+**Example:**
+```
+Then the "Login" link should contain "/log-in"
+```
+
+## By Attribute Variant
+
+This variation checks a link's href using an attribute selector approach.
+
+**Gherkin Pattern:**
+```
+Then (the )*"([^"]*)?" link should contain "([^"]*)?" by( its)*( "([^"]*)?")* (attribute|attr)
+```
+
+**Example 1:**
+```
+Then the "#aboutUsid" link should contain "about" by attr
+```
+
+**Example 2:**
+```
+Then the ".contactUs" link should contain "/contact-" by attr
+```
+
+## By Specific Attribute Variant
+
+Checks link content against a particular attribute type.
+
+**Gherkin Pattern:**
+```
+Then the "item" link should contain "url" by its "class" attribute
+```
+
+**Example:**
+```
+Then the "aboutUs" link should contain "about" by its "class" attribute
+```
+
+## More examples
+
+<!-- generated: extended-examples -->
+
+### Example 1
+
+```gherkin
+Then the "Login" link should contain "/log-in"
+```
+
+### Example 2
+
+```gherkin
+And the "About Us" link should contain "/about"
+```
+
+### Example 3
+
+```gherkin
+Then "Home" link should contain "/"
+```
+
+### Example 4
+
+```gherkin
+Then the "main-nav" link should contain "about" by its "class" attribute
+```
+
+### Example 5
+
+```gherkin
+Then the "#contact" link should contain "/contact-us" by attr
+```
+

package/docs/step-definitions/then-item-should-contain.md

@@ -0,0 +1,67 @@
+
+# Then the item should contain
+
+## Overview
+
+This documentation page describes a collection of step definitions that function as assertions or expectations. They verify whether specific elements contain particular content, text, or CSS styles.
+
+## Step Definitions
+
+### Field Content Assertions
+
+**Then the "item" field should contain "value"**
+- Verifies a field element contains specified text
+
+**Then the "item" field should not contain "value"**
+- Confirms a field element does not contain specified text
+
+### Response Content Assertions
+
+**Then the response should contain "text in the page"**
+- Checks page response includes given text
+
+**Then the response should not contain "text in the page"**
+- Confirms page response excludes given text
+
+### Element Style Assertions
+
+**Then the "item" element should contain "CSS style"**
+- Validates an element possesses specified CSS styling
+
+**Then the "item" element should not contain "CSS style"**
+- Ensures an element lacks specified CSS styling
+
+## More examples
+
+<!-- generated: extended-examples -->
+
+### Example 1
+
+```gherkin
+Then the "#username" element should contain "color: rgb(0, 0, 0)"
+```
+
+### Example 2
+
+```gherkin
+Then the "body" element should contain "font-family: Arial"
+```
+
+### Example 3
+
+```gherkin
+And the "#cta" element should contain "background-color: rgb(255, 0, 0)"
+```
+
+### Example 4
+
+```gherkin
+Then the ".error" element should not contain "display: none"
+```
+
+### Example 5
+
+```gherkin
+Then the "#header" element should contain "padding: 16px"
+```
+

package/docs/step-definitions/then-radio-button-value-should-be-selected.md

@@ -0,0 +1,68 @@
+
+# Then the radio button "value" should be selected
+
+## Gherkin Step Definition
+
+```
+Then( the)* radio button with value "([^"]*)?" should( not)* be selected
+```
+
+## Description
+
+This step validates whether a radio button matching the specified selector is selected or not selected on the page.
+
+## Examples
+
+**Example #1:**
+```
+Then the radio button "#gender-male" should be selected
+```
+
+**Example #2:**
+```
+Then the radio button ".option-1" should be selected
+```
+
+**Example #3 (Negative assertion):**
+```
+Then the radio button "#gender-female" should not be selected
+```
+
+## Purpose
+
+The step definition "verifies that the radio button is not selected" or confirms its selected state based on the assertion type used (with or without the `not` modifier).
+
+## More examples
+
+<!-- generated: extended-examples -->
+
+### Example 1
+
+```gherkin
+Then the radio button with value "male" should be selected
+```
+
+### Example 2
+
+```gherkin
+Then the radio button with value "premium" should be selected
+```
+
+### Example 3
+
+```gherkin
+And the radio button with value "monthly" should not be selected
+```
+
+### Example 4
+
+```gherkin
+Then the radio button with value "yes" should be selected
+```
+
+### Example 5
+
+```gherkin
+Then the radio button with value "annual" should not be selected
+```
+

package/docs/step-definitions/then-response-status-code-should-be-number.md

@@ -0,0 +1,69 @@
+
+# Then the response status code should be {number}
+
+## Description
+
+"This step definition is used after making a request to the web service under test. Once the response is received, this step definition asserts HTTP status code returned by the server matches the expected code."
+
+## Gherkin Syntax
+
+```
+Then the response status code should( not)* be (\d+)
+```
+
+## Examples
+
+### Example 1: Successful Request
+```
+Then the response status code should be 200
+```
+
+The code 200 indicates a successful request where "the server has processed the request and returned the appropriate response."
+
+### Example 2: Resource Not Found
+```
+Then the response status code should not be 404
+```
+
+The code 404 indicates "the requested resource not found on the server. Meaning a possible error or invalid URL. So that it should not be 404."
+
+## Parameters
+
+- `{number}`: The expected HTTP status code (numeric value)
+- `not` (optional): Negation modifier to assert the status code should NOT match the specified value
+
+## More examples
+
+<!-- generated: extended-examples -->
+
+### Example 1
+
+```gherkin
+Then the response status code should be 200
+```
+
+### Example 2
+
+```gherkin
+Then the response status code should be 404
+```
+
+### Example 3
+
+```gherkin
+And the response status code should be 301
+```
+
+### Example 4
+
+```gherkin
+Then the response status code should not be 500
+```
+
+### Example 5
+
+```gherkin
+When I am on "/admin"
+   Then the response status code should be 403
+```
+

package/docs/step-definitions/then-value-radio-button-selected.md

@@ -0,0 +1,62 @@
+
+# Then the "value" radio button is selected
+
+## Step Definition
+
+```
+Then (the )"([^"])?" radio button is( not)* selected
+```
+
+## Description
+
+This step verifies whether a specified radio button is selected or not using Nightwatch's built-in assertion functionality.
+
+## Examples
+
+**Example #1:** `Then the "#gender-male" radio button is selected`
+
+Confirms that the radio button with the specified selector is currently selected.
+
+**Example #2:** `Then the "#gender-female" radio button is not selected`
+
+Validates that the radio button is not in a selected state.
+
+## Parameters
+
+- **Selector** (required): The radio button identifier, typically a CSS selector or element reference in quotes
+- **Negation** (optional): The phrase "not" can be appended to assert the button is unselected
+
+## More examples
+
+<!-- generated: extended-examples -->
+
+### Example 1
+
+```gherkin
+Then the "#gender-male" radio button is selected
+```
+
+### Example 2
+
+```gherkin
+Then the "#plan-premium" radio button is selected
+```
+
+### Example 3
+
+```gherkin
+And the ".option-1" radio button is not selected
+```
+
+### Example 4
+
+```gherkin
+Then the "#yes" radio button is selected
+```
+
+### Example 5
+
+```gherkin
+Then the "#monthly" radio button is not selected
+```
+

package/docs/step-definitions/when-i-attach-file-file-name-element.md

@@ -0,0 +1,71 @@
+
+# When I attach the file "file name" to "element"
+
+## Gherkin Step Phrasing
+
+```
+When (I|we)* attach the file "([^"]*)?" to "([^"]*)?"
+```
+
+## Description
+
+This step definition enables test automation for file uploads by attaching files to file input elements. The step allows subsequent actions to be performed on the uploaded files.
+
+## Setup Requirements
+
+Test files must be organized in the `tests/assets` directory. Files should be placed there in advance with appropriate naming. During feature execution, files are referenced by name and loaded into the file input element identified by the specified selector.
+
+For proper configuration of the `tests/assets` folder path, reference the Global Settings documentation.
+
+## Usage
+
+Create a step that attaches a file to a field using its id, class, name, or label identifier.
+
+## Example
+
+```
+When I attach the file "profileIcon.jpg" to "#profileIconUpload"
+```
+
+## Parameters
+
+- **file name**: The name of the file located in `tests/assets`
+- **element**: The target field identifier (id, class, name, or label)
+
+## More examples
+
+<!-- generated: extended-examples -->
+
+### Example 1
+
+```gherkin
+When I attach the file "resume.pdf" to "#resume"
+   And I press "Upload"
+```
+
+### Example 2
+
+```gherkin
+When I attach the file "logo.svg" to "input[name=logo]"
+```
+
+### Example 3
+
+```gherkin
+When we attach file "report.csv" to "[data-testid=csv-upload]"
+```
+
+### Example 4
+
+```gherkin
+When I attach file "video.mp4" to "#video-input"
+   And I wait for AJAX to finish
+```
+
+### Example 5
+
+```gherkin
+When I attach the file "profile.jpg" to "#avatar-upload"
+   Then I should see "Avatar uploaded"
+```
+