@vardot/varbase-e2e 2.0.0

package/docs/steps/path.md

@@ -0,0 +1,203 @@
+# URL paths steps
+
+8 steps, defined in `tests/step-definitions/path.steps.js`.
+
+Cucumber-js loads every `*.steps.js` in that directory automatically — you never `require()` a step file from a feature.
+
+| # | Step |
+| --- | --- |
+| 1 | `Then the path should be "/dashboard"` |
+| 2 | `Then the path should not be "/login"` |
+| 3 | `Then current url should have the "lang" parameter` |
+| 4 | `Then current url should have the "lang" parameter with the "en" value` |
+| 5 | `Then current url should not have the "missing" parameter` |
+| 6 | `Then current url should not have the "lang" parameter with the "fr" value` |
+| 7 | `Given the basic authentication with the username "admin" and the password "secret"` |
+| 8 | `When I go back` |
+
+---
+
+## 1. Then the path should be "/dashboard"
+
+Assert the current URL pathname equals an expected string (no query/fragment).
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+'the path should be {string}'
+```
+
+**Examples**
+
+```gherkin
+Then the path should be "/dashboard"
+Then the path should be "/about"
+And the path should be "/checkout/step-2"
+Then the path should be "/admin/users"
+Then the path should be "/"
+```
+
+## 2. Then the path should not be "/login"
+
+Assert the current URL pathname is NOT equal to an expected string.
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+'the path should not be {string}'
+```
+
+**Examples**
+
+```gherkin
+Then the path should not be "/login"
+Then the path should not be "/error"
+And the path should not be "/admin"
+Then the path should not be "/maintenance"
+Then the path should not be "/forbidden"
+```
+
+## 3. Then current url should have the "lang" parameter
+
+Assert the current URL has the named query parameter (any value).
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+'current url should have the {string} parameter'
+```
+
+**Examples**
+
+```gherkin
+Then current url should have the "lang" parameter
+Then current url should have the "page" parameter
+And current url should have the "q" parameter
+Then current url should have the "ref" parameter
+Then current url should have the "sort" parameter
+```
+
+## 4. Then current url should have the "lang" parameter with the "en" value
+
+Assert the current URL has the named query parameter with the exact value.
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+'current url should have the {string} parameter with the {string} value'
+```
+
+**Examples**
+
+```gherkin
+Then current url should have the "lang" parameter with the "en" value
+Then current url should have the "page" parameter with the "2" value
+And current url should have the "sort" parameter with the "price" value
+Then current url should have the "ref" parameter with the "newsletter" value
+Then current url should have the "q" parameter with the "laptops" value
+```
+
+## 5. Then current url should not have the "missing" parameter
+
+Assert the current URL does NOT carry the named query parameter.
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+'current url should not have the {string} parameter'
+```
+
+**Examples**
+
+```gherkin
+Then current url should not have the "missing" parameter
+Then current url should not have the "debug" parameter
+And current url should not have the "preview" parameter
+Then current url should not have the "force" parameter
+Then current url should not have the "test" parameter
+```
+
+## 6. Then current url should not have the "lang" parameter with the "fr" value
+
+Assert the current URL does NOT carry a parameter+value pair.
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+'current url should not have the {string} parameter with the {string} value'
+```
+
+**Examples**
+
+```gherkin
+Then current url should not have the "lang" parameter with the "fr" value
+Then current url should not have the "page" parameter with the "100" value
+And current url should not have the "sort" parameter with the "old" value
+Then current url should not have the "preview" parameter with the "1" value
+Then current url should not have the "debug" parameter with the "true" value
+```
+
+## 7. Given the basic authentication with the username "admin" and the password "secret"
+
+Re-open the browser context with HTTP basic-auth credentials.
+
+**Keyword**: `Given`
+
+**Pattern**
+
+```js
+'the basic authentication with the username {string} and the password {string}'
+```
+
+**Examples**
+
+```gherkin
+Given the basic authentication with the username "admin" and the password "secret"
+Given the basic authentication with the username "guest" and the password "guest"
+And the basic authentication with the username "alice" and the password "s3cret"
+Given the basic authentication with the username "ci" and the password "ci-token-123"
+Given the basic authentication with the username "tester" and the password ""
+```
+
+## 8. When I go back
+
+Navigate one step back in the browser history.
+
+Equivalent to clicking the browser back button. Throws no error if there
+is no history (returns null from `page.goBack()`).
+
+**Keyword**: `When`
+
+**Pattern**
+
+```js
+/^(I |we )*go back$/
+```
+
+**Examples**
+
+```gherkin
+When I go back
+When I follow "About"
+  And I go back
+  Then I should be on the homepage
+And I go back
+When I am on "/cart"
+  When I am on "/checkout"
+  And I go back
+  Then I should be on "/cart"
+When I go back
+  And I wait until the URL contains "/products"
+```

package/docs/steps/response.md

@@ -0,0 +1,102 @@
+# Response headers steps
+
+4 steps, defined in `tests/step-definitions/response.steps.js`.
+
+Cucumber-js loads every `*.steps.js` in that directory automatically — you never `require()` a step file from a feature.
+
+| # | Step |
+| --- | --- |
+| 1 | `Then the response should contain the header "content-type"` |
+| 2 | `Then the response should not contain the header "x-fake-header"` |
+| 3 | `Then the response header "content-type" should contain the value "html"` |
+| 4 | `Then the response header "content-type" should not contain the value "application/json"` |
+
+---
+
+## 1. Then the response should contain the header "content-type"
+
+Assert the most recent navigation response carried a header (case-insensitive).
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+'the response should contain the header {string}'
+```
+
+**Examples**
+
+```gherkin
+Then the response should contain the header "content-type"
+Then the response should contain the header "cache-control"
+And the response should contain the header "x-frame-options"
+Then the response should contain the header "set-cookie"
+Then the response should contain the header "etag"
+```
+
+## 2. Then the response should not contain the header "x-fake-header"
+
+Assert the most recent navigation response did NOT carry a header.
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+'the response should not contain the header {string}'
+```
+
+**Examples**
+
+```gherkin
+Then the response should not contain the header "x-fake-header"
+Then the response should not contain the header "x-powered-by"
+And the response should not contain the header "server"
+Then the response should not contain the header "x-aspnet-version"
+Then the response should not contain the header "x-debug-token"
+```
+
+## 3. Then the response header "content-type" should contain the value "html"
+
+Assert a header's value contains a substring.
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+'the response header {string} should contain the value {string}'
+```
+
+**Examples**
+
+```gherkin
+Then the response header "content-type" should contain the value "html"
+Then the response header "cache-control" should contain the value "no-cache"
+And the response header "content-type" should contain the value "charset=utf-8"
+Then the response header "set-cookie" should contain the value "session="
+Then the response header "x-frame-options" should contain the value "DENY"
+```
+
+## 4. Then the response header "content-type" should not contain the value "application/json"
+
+Assert a header's value does NOT contain a substring (or the header is absent).
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+'the response header {string} should not contain the value {string}'
+```
+
+**Examples**
+
+```gherkin
+Then the response header "content-type" should not contain the value "application/json"
+Then the response header "cache-control" should not contain the value "public"
+And the response header "content-type" should not contain the value "xml"
+Then the response header "set-cookie" should not contain the value "Domain=other"
+Then the response header "x-frame-options" should not contain the value "ALLOW"
+```

package/docs/steps/responsive.md

@@ -0,0 +1,139 @@
+# Responsive viewports steps
+
+5 steps, defined in `tests/step-definitions/responsive.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 following responsive breakpoints:` |
+| 2 | `When I set the viewport to the "mobile" breakpoint` |
+| 3 | `When I set the viewport width to 1200` |
+| 4 | `When I set the viewport height to 800` |
+| 5 | `When I set the viewport to 1200 by 800` |
+
+---
+
+## 1. Given the following responsive breakpoints:
+
+Replace the breakpoint registry for the current scenario from a data table.
+
+**Keyword**: `Given`
+
+**Pattern**
+
+```js
+'the following responsive breakpoints:'
+```
+
+**Examples**
+
+```gherkin
+Given the following responsive breakpoints:
+  | mobile  | 375  | 667  |
+  | tablet  | 768  | 1024 |
+  | desktop | 1200 | 900  |
+Given the following responsive breakpoints:
+  | watch   | 280  | 280  |
+  | phablet | 414  | 896  |
+And the following responsive breakpoints:
+  | xs      | 320  | 480  |
+  | sm      | 480  | 800  |
+Given the following responsive breakpoints:
+  | hd      | 1280 | 720  |
+  | full-hd | 1920 | 1080 |
+Given the following responsive breakpoints:
+  | a11y    | 320  | 480  |
+  | print   | 794  | 1123 |
+```
+
+## 2. When I set the viewport to the "mobile" breakpoint
+
+Resize the viewport to a registered named breakpoint.
+
+Built-in names: `xs`, `sm`, `md`, `lg`, `xl`, `xxl`, `xxxl`, `mobile`,
+`tablet`, `desktop`. Project-defined names override built-ins.
+
+**Keyword**: `When`
+
+**Pattern**
+
+```js
+/^(I |we )*set the viewport to the "([^"]*)" breakpoint$/
+```
+
+**Examples**
+
+```gherkin
+When I set the viewport to the "mobile" breakpoint
+When I set the viewport to the "tablet" breakpoint
+And we set the viewport to the "desktop" breakpoint
+When I set the viewport to the "xl" breakpoint
+When I set the viewport to the "xxxl" breakpoint
+```
+
+## 3. When I set the viewport width to 1200
+
+Resize the viewport width while keeping the current height.
+
+**Keyword**: `When`
+
+**Pattern**
+
+```js
+/^(I |we )*set the viewport width to (\d+)$/
+```
+
+**Examples**
+
+```gherkin
+When I set the viewport width to 1200
+When I set the viewport width to 375
+And we set the viewport width to 1920
+When I set the viewport width to 768
+When I set the viewport width to 1024
+```
+
+## 4. When I set the viewport height to 800
+
+Resize the viewport height while keeping the current width.
+
+**Keyword**: `When`
+
+**Pattern**
+
+```js
+/^(I |we )*set the viewport height to (\d+)$/
+```
+
+**Examples**
+
+```gherkin
+When I set the viewport height to 800
+When I set the viewport height to 1024
+And we set the viewport height to 1080
+When I set the viewport height to 667
+When I set the viewport height to 900
+```
+
+## 5. When I set the viewport to 1200 by 800
+
+Resize the viewport to an explicit width-by-height pair.
+
+**Keyword**: `When`
+
+**Pattern**
+
+```js
+/^(I |we )*set the viewport to (\d+) by (\d+)$/
+```
+
+**Examples**
+
+```gherkin
+When I set the viewport to 1200 by 800
+When I set the viewport to 375 by 667
+And we set the viewport to 1920 by 1080
+When I set the viewport to 768 by 1024
+When I set the viewport to 1024 by 768
+```

package/docs/steps/rest.md

@@ -0,0 +1,140 @@
+# REST (short form) steps
+
+5 steps, defined in `tests/step-definitions/rest.steps.js`.
+
+Cucumber-js loads every `*.steps.js` in that directory automatically — you never `require()` a step file from a feature.
+
+| # | Step |
+| --- | --- |
+| 1 | `Given a REST header "Authorization" with value "Bearer abc123"` |
+| 2 | `When I send a REST "GET" request to "/api/users"` |
+| 3 | `When I send a REST "POST" request to "/api/users" with body:` |
+| 4 | `Then the REST response status code should be 200` |
+| 5 | `Then the REST response should contain "Alice"` |
+
+---
+
+## 1. Given a REST header "Authorization" with value "Bearer abc123"
+
+Add an HTTP header to subsequent REST requests.
+
+**Keyword**: `Given`
+
+**Pattern**
+
+```js
+'a REST header {string} with value {string}'
+```
+
+**Examples**
+
+```gherkin
+Given a REST header "Authorization" with value "Bearer abc123"
+Given a REST header "Accept" with value "application/json"
+And a REST header "X-Request-ID" with value "req-001"
+Given a REST header "Content-Type" with value "application/json"
+Given a REST header "X-API-Key" with value "key-xyz"
+```
+
+## 2. When I send a REST "GET" request to "/api/users"
+
+Send an HTTP request without a body.
+
+**Keyword**: `When`
+
+**Pattern**
+
+```js
+/^(I |we )*send a REST "([^"]*)" request to "([^"]*)"$/
+```
+
+**Examples**
+
+```gherkin
+When I send a REST "GET" request to "/api/users"
+When I send a REST "DELETE" request to "/api/orders/1"
+And we send a REST "GET" request to "https://example.com/api/health"
+When I send a REST "GET" request to "/api/me"
+When I send a REST "DELETE" request to "/api/cart/items/42"
+```
+
+## 3. When I send a REST "POST" request to "/api/users" with body:
+
+Send an HTTP request with a doc-string body (raw text, JSON, or form-encoded).
+
+**Keyword**: `When`
+
+**Pattern**
+
+```js
+/^(I |we )*send a REST "([^"]*)" request to "([^"]*)" with body:$/
+```
+
+**Examples**
+
+```gherkin
+When I send a REST "POST" request to "/api/users" with body:
+  """
+  {"name": "Alice"}
+  """
+When I send a REST "PUT" request to "/api/users/1" with body:
+  """
+  {"role": "admin"}
+  """
+And we send a REST "PATCH" request to "/api/orders/1" with body:
+  """
+  {"status": "shipped"}
+  """
+When I send a REST "POST" request to "/api/login" with body:
+  """
+  username=alice&password=s3cret
+  """
+When I send a REST "POST" request to "/webhooks/event" with body:
+  """
+  {"event": "ping"}
+  """
+```
+
+## 4. Then the REST response status code should be 200
+
+Assert the most recent REST response carried an expected status code.
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+'the REST response status code should be {int}'
+```
+
+**Examples**
+
+```gherkin
+Then the REST response status code should be 200
+Then the REST response status code should be 201
+And the REST response status code should be 401
+Then the REST response status code should be 404
+Then the REST response status code should be 500
+```
+
+## 5. Then the REST response should contain "Alice"
+
+Assert the most recent REST response body contains a substring.
+
+**Keyword**: `Then`
+
+**Pattern**
+
+```js
+'the REST response should contain {string}'
+```
+
+**Examples**
+
+```gherkin
+Then the REST response should contain "Alice"
+Then the REST response should contain "id"
+And the REST response should contain "shipped"
+Then the REST response should contain "ok"
+Then the REST response should contain "Welcome"
+```