Skip to content

Commit

Permalink
Add API URL Override Support (#64)
Browse files Browse the repository at this point in the history
* Modernize dependencies
* Add support for api_url
* Fixed undefined appearing in output URLs
  • Loading branch information
twistedpair authored Jan 10, 2025
1 parent 7d8e415 commit 279055e
Show file tree
Hide file tree
Showing 12 changed files with 425 additions and 125 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/pr-workflow.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ jobs:
with:
application-id: D6uz-lhAGBYuTTc6Jj_w0Q-a
environment-id: I9tfo2dWd7WSigXcO91feA-e
# Intentionally trigger deprecation warning
uri: 'https://sandbox.mabl.com'
app-url: 'https://storage.googleapis.com/public-test-pages/uptime/canary.html'
browser-types: |
chrome
plan-labels: |
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/push-workflow.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ jobs:
with:
application-id: D6uz-lhAGBYuTTc6Jj_w0Q-a
environment-id: I9tfo2dWd7WSigXcO91feA-e
# Intentionally trigger deprecation warning
uri: 'https://sandbox.mabl.com'
app-url: 'https://storage.googleapis.com/public-test-pages/uptime/canary.html'
browser-types: |
chrome
plan-labels: |
Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,12 @@ jobs:
types to test e.g. `chrome, firefox, safari, internet_explorer`. If not
provided, mabl will test the browsers configured on the triggered test.
- `plan-labels` {string} (optional): comma or new line separated plan labels to test. Plans matching **any** label will be run. e.g. `smoke-test, beta-feature`. Note: additional selection criteria must also be met like application-id or environment-id, if supplied.
- `uri` {string} (optional) the base uri to test against. If provided, this will
- `uri` {string} (optional, DEPRECATED - use app_url) the base uri to run browser based tests against. If provided, this will
override the default uri associated with the environment in mabl
- `app-url` {string} (optional) the base uri to run **Web Browser tests** against. If provided, this will
override the default web browser uri associated with the environment in mabl (note, this replaces `uri`, and will supersede the value in `uri` if both are provided)
- `api-url` {string} (optional) the base uri to run **API tests** against. If provided, this will
override the default API uri associated with the environment in mabl
- `mabl-branch` {string} (optional) run tests on the mabl branch of tests with this name. Defaults to `master`.
- `http-headers` {string} (optional) Headers to add to all requests e.g. "My-Header:the-value" (comma or new line delimited).
- `rebaseline-images` {boolean} (optional) - Set `true` to reset the visual
Expand Down
21 changes: 16 additions & 5 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,19 @@ inputs:
required: false
uri:
description: ^
'Base URI to test against. If provided, this will override the default URI
associated with the environment in mabl'
'The base uri to test browser based tests against. If provided, this will
override the default uri associated with the environment in mabl'
deprecationMessage: "use 'app-url' instead"
required: false
app-url:
description: ^
'The base uri to run WEB BROWSER TESTS against. If provided, this will
override the default web browser uri associated with the environment in mabl (note, this replaces `uri`, and will override the value in `uri` if both are provided)'
required: false
api-url:
description: ^
'The base uri to run API TESTS against. If provided, this will
override the default API uri associated with the environment in mabl'
required: false
mabl-branch:
description: ^
Expand All @@ -42,19 +53,19 @@ inputs:
description: ^
'Set to true to reset the visual baseline to the current deployment'
required: false
default: false
default: 'false'
set-static-baseline:
description: ^
'Set to true to use the current deployment as an exact static
baseline. If this is set, mabl will not model dynamic areas and will use
the current deployment as a pixel-exact visual baseline.'
required: false
default: false
default: 'false'
continue-on-failure:
description: ^
'Set to true to continue the build even if there are test failures'
required: false
default: false
default: 'false'
event-time:
description: "Event time the deployment occurred. Defaults to now."
required: false
Expand Down
Loading

0 comments on commit 279055e

Please sign in to comment.