@vardot/varbase-e2e 2.0.0

package/docs/steps/assertion.md

@@ -0,0 +1,328 @@
+# Assertions steps
+
+14 steps, defined in `tests/step-definitions/assertion.steps.js`.
+
+Cucumber-js loads every `*.steps.js` in that directory automatically — you never `require()` a step file from a feature.
+
+| # | Step |
+| --- | --- |
+| 1 | `Then I should see "Welcome"` |
+| 2 | `Then I should see text matching "^T\w+"` |
+| 3 | `Then I should see "Active" in the "John Smith" row` |
+| 4 | `Then I should see a "Username" element` |
+| 5 | `Then I should see a "uname" element by its "id" attr` |
+| 6 | `Then I should see "John Smith" in the "Username" element` |
+| 7 | `Then I should see "John Smith" in the "uname" element by its "id" attr` |
+| 8 | `Then I should see text matching "\d{4}" in the "#year" element` |
+| 9 | `Then the "body" element should contain "color:white;"` |
+| 10 | `Then I should see 3 "li" elements` |
+| 11 | `Then the "Login" link should contain "/log-in"` |
+| 12 | `Then the "#about-us-id" link should contain "about" by attr` |
+| 13 | `Then the response should contain "Welcome visitor"` |
+| 14 | `Then the response status code should be 200` |
+
+---
+
+## 1. Then I should see "Welcome"
+
+Assert that text is or is not present on the page.
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+/^(I |we )*should( not)* see "([^"]*)?"$/
+```
+
+**Examples**
+
+```gherkin
+Then I should see "Welcome"
+Then we should see "Your accounts for the group is public"
+Then I should not see "Access denied"
+Then we should not see "Edit layout"
+```
+
+## 2. Then I should see text matching "^T\w+"
+
+Assert that page contains or does not contain text matching a regex pattern.
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+/^(I |we )*should( not)* see text matching "([^"]*)?"$/
+```
+
+**Examples**
+
+```gherkin
+Then I should see text matching "^T\w+"
+Then I should not see text matching "^O\w+"
+And we should see text matching "\d{4}"
+```
+
+## 3. Then I should see "Active" in the "John Smith" row
+
+Assert text is or is not visible inside a table row identified by text.
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+/^(I |we )*should( not)* see "([^"]*)?" in( the)* "([^"]*)?" row$/
+```
+
+**Examples**
+
+```gherkin
+Then I should see "Active" in the "John Smith" row
+Then I should see "In Stock" in the "Product A" row
+Then we should see "Processing" in the "Order #12345" row
+And I should see "Admin" in the "john.smith@example.com" row
+Then I should not see "Admin" in the "Jane Doe" row
+Then I should not see "Out of Stock" in the "Product A" row
+And I should not see "Inactive" in the "john.smith@example.com" row
+```
+
+## 4. Then I should see a "Username" element
+
+Assert that an element with a given label exists (or does not) on the page.
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+/^(I |we )*should( not)* see (a|an) "([^"]*)?" element$/
+```
+
+**Examples**
+
+```gherkin
+Then I should see a "Username" element
+Then I should not see a "Username" element
+And we should see an "Email" element
+```
+
+## 5. Then I should see a "uname" element by its "id" attr
+
+Assert that an element, identified by attribute, exists (or does not) on the page.
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+/^(I |we )*should( not)* see (a|an) "([^"]*)?" element by( its)*(?: "([^"]*)?")* (attribute|attr)$/
+```
+
+**Examples**
+
+```gherkin
+Then I should see a "uname" element by its "id" attr
+Then I should see a "pwordcss" element by attr
+Then I should not see an "emailId" element by its "id" attr
+And I should not see a "countryCss" element by attr
+```
+
+## 6. Then I should see "John Smith" in the "Username" element
+
+Assert that an element (found by its label) contains or does not contain text.
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+/^(I |we )*should( not)* see "([^"]*)?" in( the)* "([^"]*)?" element$/
+```
+
+**Examples**
+
+```gherkin
+Then I should see "John Smith" in the "Username" element
+Then I should not see "Joe Smith" in the "Username" element
+And we should see "1234" in the "Password" element
+```
+
+## 7. Then I should see "John Smith" in the "uname" element by its "id" attr
+
+Assert that an element (found by its attribute) contains or does not contain text.
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+/^(I |we )*should( not)* see "([^"]*)?" in( the)* "([^"]*)?" element by( its)*(?: "([^"]*)?")* (attribute|attr)$/
+```
+
+**Examples**
+
+```gherkin
+Then I should see "John Smith" in the "uname" element by its "id" attr
+Then I should see "1234" in the "pwordcss" element by attr
+Then I should not see "John Smith" in the "uname" element by its "id" attr
+Then I should not see "1234" in the "pwordcss" element by attr
+```
+
+## 8. Then I should see text matching "\d{4}" in the "#year" element
+
+Assert that an element's text content does or does not match a regex.
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+/^(I |we )*should( not)* see text matching "([^"]*)?" in( the)* "([^"]*)?" element$/
+```
+
+**Examples**
+
+```gherkin
+Then I should see text matching "\d{4}" in the "#year" element
+Then I should see text matching "\$\d+\.\d{2}" in the "#price" element
+Then I should not see text matching "Error" in the "#status" element
+Then we should see text matching "^[A-Z][a-z]+ [A-Z][a-z]+$" in the "#full-name" element
+Then I should see text matching "(0?[1-9]|[12][0-9]|3[01])[\/\-](0?[1-9]|1[012])[\/\-]\d{4}" in the "#date" element
+```
+
+## 9. Then the "body" element should contain "color:white;"
+
+Assert that an element has or does not have a specific CSS property.
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+/^(the )*"([^"]*)?" element should( not)* contain "([^"]*)?"$/
+```
+
+**Examples**
+
+```gherkin
+Then the "body" element should contain "color:white;"
+Then the "body" element should not contain "color:white;"
+Then the "#uname" element should not contain "border:solid 5px red;"
+Then the "pword" element should not contain "font-size: 26px;"
+```
+
+## 10. Then I should see 3 "li" elements
+
+Assert the exact number of elements matching a CSS selector.
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+/^(I |we )*should see (\d+) "([^"]*)" elements?$/
+```
+
+**Examples**
+
+```gherkin
+Then I should see 3 "li" elements
+Then I should see 1 "h1" element
+Then we should see 5 ".card" elements
+Then I should see 0 ".error" elements
+And I should see 10 "table tr" elements
+Then I should see 2 "nav a" elements
+Then we should see 4 "ul li" elements
+Then I should see 1 "form" element
+And should see 6 ".product" elements
+Then I should see 8 "[data-testid='row']" elements
+```
+
+## 11. Then the "Login" link should contain "/log-in"
+
+Assert that a link (located by its visible text) contains the given URL.
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+/^(the )*"([^"]*)?" link should contain "([^"]*)?"$/
+```
+
+**Examples**
+
+```gherkin
+Then the "Login" link should contain "/log-in"
+And the "About Us" link should contain "/about"
+Then "Home" link should contain "/"
+```
+
+## 12. Then the "#about-us-id" link should contain "about" by attr
+
+Assert that a link located by its attribute contains the given URL.
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+/^(the )*"([^"]*)?" link should contain "([^"]*)?" by( its)*(?: "([^"]*)?")* (attribute|attr)$/
+```
+
+**Examples**
+
+```gherkin
+Then the "#about-us-id" link should contain "about" by attr
+And the "aboutUs" link should contain "about" by its "class" attribute
+And the ".contactUs" link should contain "/contact-" by attr
+```
+
+## 13. Then the response should contain "Welcome visitor"
+
+Assert that the rendered HTML response contains or does not contain text.
+
+Reads the entire `<html>` text — useful for checking text that lives in
+`<head>` (meta descriptions, JSON-LD), `<noscript>`, or hidden regions.
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+/^(the )*response should( not)* contain "([^"]*)?"$/
+```
+
+**Examples**
+
+```gherkin
+Then the response should contain "Welcome visitor"
+Then the response should not contain "Access denied"
+And the response should contain "<title>Home</title>"
+Then the response should contain "<html"
+When I am on "/about"
+  Then the response should contain "Our mission"
+  And the response should not contain "TODO"
+```
+
+## 14. Then the response status code should be 200
+
+Assert that the current page's response status is or is not a given code.
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+/^(the )*response status code should( not)* be (\d+)$/
+```
+
+**Examples**
+
+```gherkin
+Then the response status code should be 200
+And the response status code should not be 404
+Then the response status code should be 301
+```

package/docs/steps/auth.md

@@ -0,0 +1,108 @@
+# Auth state steps
+
+3 steps, defined in `tests/step-definitions/auth.steps.js`.
+
+Cucumber-js loads every `*.steps.js` in that directory automatically — you never `require()` a step file from a feature.
+
+| # | Step |
+| --- | --- |
+| 1 | `When I save the auth state to "tests/auth/admin.json"` |
+| 2 | `Given I restore the auth state from "tests/auth/admin.json"` |
+| 3 | `Given I clear the auth state` |
+
+---
+
+## 1. When I save the auth state to "tests/auth/admin.json"
+
+Save the current browser context's cookies + localStorage to a JSON file.
+
+Run this AFTER a successful interactive login. The destination file is
+created (with parent directories) if it does not exist; existing files are
+overwritten.
+
+**Keyword**: `When`
+
+**Pattern**
+
+```js
+/^(I |we )*save the auth state to "([^"]*)"$/
+```
+
+**Examples**
+
+```gherkin
+When I save the auth state to "tests/auth/admin.json"
+Given I am on "/login"
+  When I fill in "admin@example.com" for "Email"
+  And I fill in "secret" for "Password"
+  And I press "Sign in"
+  And I wait until the URL contains "/dashboard"
+  Then I save the auth state to "tests/auth/admin.json"
+When I save the auth state to "tests/auth/editor.json"
+When we save the auth state to "tests/auth/customer.json"
+When I save the auth state to "/tmp/admin-state.json"
+```
+
+## 2. Given I restore the auth state from "tests/auth/admin.json"
+
+Restore cookies + localStorage from a previously saved JSON file.
+
+The current browser context is closed and a fresh one is opened with the
+saved state. The varbase-e2e init script (AJAX/timer/mutation tracker) is
+re-installed automatically so smart waits keep working. Subsequent steps
+proceed against the restored, authenticated session.
+
+**Keyword**: `Given`
+
+**Pattern**
+
+```js
+/^(I |we )*restore the auth state from "([^"]*)"$/
+```
+
+**Examples**
+
+```gherkin
+Given I restore the auth state from "tests/auth/admin.json"
+Given I restore the auth state from "tests/auth/editor.json"
+  And I am on "/admin/products"
+Given I restore the auth state from "tests/auth/customer.json"
+  And I am on "/account/orders"
+Given we restore the auth state from "tests/auth/admin.json"
+Given I restore the auth state from "tests/auth/admin.json"
+  And I am on "/dashboard"
+  Then "<#user-list>" should have a count of 5 within 5 seconds
+```
+
+## 3. Given I clear the auth state
+
+Clear cookies and localStorage / sessionStorage for the current context.
+
+Use to anonymize a session mid-scenario, e.g. after asserting a logged-in
+action you may want to verify the same path returns 302 / login form for
+an anonymous visitor.
+
+**Keyword**: `Given`
+
+**Pattern**
+
+```js
+/^(I |we )*clear the auth state$/
+```
+
+**Examples**
+
+```gherkin
+Given I clear the auth state
+Given I restore the auth state from "tests/auth/admin.json"
+  And I am on "/dashboard"
+  Given I clear the auth state
+  When I am on "/dashboard"
+  Then I should see "Sign in"
+Given we clear the auth state
+When I press "Logout"
+  And I clear the auth state
+Given I clear the auth state
+  When I am on the homepage
+  Then I should see "Login"
+```

package/docs/steps/clock.md

@@ -0,0 +1,171 @@
+# Clock steps
+
+7 steps, defined in `tests/step-definitions/clock.steps.js`.
+
+Cucumber-js loads every `*.steps.js` in that directory automatically — you never `require()` a step file from a feature.
+
+| # | Step |
+| --- | --- |
+| 1 | `Given the system time is "2026-05-08T10:00:00Z"` |
+| 2 | `When I advance the clock by 500 ms` |
+| 3 | `When I advance the clock by 30 seconds` |
+| 4 | `When I advance the clock by 5 minutes` |
+| 5 | `When I pause the clock` |
+| 6 | `When I resume the clock` |
+| 7 | `When I set the system time to "2026-05-08T12:30:00Z"` |
+
+---
+
+## 1. Given the system time is "2026-05-08T10:00:00Z"
+
+Install a fake clock anchored at an ISO 8601 instant.
+
+**Keyword**: `Given`
+
+**Pattern**
+
+```js
+/^the system time is "([^"]*)"$/
+```
+
+**Examples**
+
+```gherkin
+Given the system time is "2026-05-08T10:00:00Z"
+Given the system time is "2026-01-01T00:00:00Z"
+Given the system time is "2026-12-31T23:59:55Z"
+Given the system time is "2026-05-08T10:00:00Z"
+Given the system time is "2026-07-04T12:00:00-04:00"
+```
+
+## 2. When I advance the clock by 500 ms
+
+Advance the fake clock forward by N milliseconds.
+
+**Keyword**: `When`
+
+**Pattern**
+
+```js
+/^(I |we )*advance the clock by (\d+) ?ms$/
+```
+
+**Examples**
+
+```gherkin
+When I advance the clock by 500 ms
+When I advance the clock by 1500 ms
+When we advance the clock by 250 ms
+And I advance the clock by 100 ms
+When I advance the clock by 60000 ms
+```
+
+## 3. When I advance the clock by 30 seconds
+
+Advance the fake clock forward by N seconds.
+
+**Keyword**: `When`
+
+**Pattern**
+
+```js
+/^(I |we )*advance the clock by (\d+) seconds?$/
+```
+
+**Examples**
+
+```gherkin
+When I advance the clock by 30 seconds
+When I advance the clock by 5 seconds
+When we advance the clock by 1 second
+And I advance the clock by 10 seconds
+When I advance the clock by 90 seconds
+```
+
+## 4. When I advance the clock by 5 minutes
+
+Advance the fake clock forward by N minutes.
+
+**Keyword**: `When`
+
+**Pattern**
+
+```js
+/^(I |we )*advance the clock by (\d+) minutes?$/
+```
+
+**Examples**
+
+```gherkin
+When I advance the clock by 5 minutes
+When I advance the clock by 1 minute
+When we advance the clock by 14 minutes
+And I advance the clock by 30 minutes
+When I advance the clock by 60 minutes
+```
+
+## 5. When I pause the clock
+
+Pause the fake clock.
+
+**Keyword**: `When`
+
+**Pattern**
+
+```js
+/^(I |we )*pause the clock$/
+```
+
+**Examples**
+
+```gherkin
+When I pause the clock
+When I pause the clock
+When we pause the clock
+And I pause the clock
+When I pause the clock
+```
+
+## 6. When I resume the clock
+
+Resume the fake clock.
+
+**Keyword**: `When`
+
+**Pattern**
+
+```js
+/^(I |we )*resume the clock$/
+```
+
+**Examples**
+
+```gherkin
+When I resume the clock
+When I resume the clock
+When we resume the clock
+And I resume the clock
+When I resume the clock
+```
+
+## 7. When I set the system time to "2026-05-08T12:30:00Z"
+
+Set the fake clock to a specific time.
+
+**Keyword**: `When`
+
+**Pattern**
+
+```js
+/^(I |we )*set the system time to "([^"]*)"$/
+```
+
+**Examples**
+
+```gherkin
+When I set the system time to "2026-05-08T12:30:00Z"
+When I set the system time to "2026-12-31T23:59:55Z"
+When we set the system time to "2026-01-01T00:00:00Z"
+And I set the system time to "2026-07-04T08:00:00-04:00"
+When I set the system time to "2027-01-01T00:00:00Z"
+```