Skip to content

Commit

Permalink
Merge branch 'region-testing' into 'main'
Browse files Browse the repository at this point in the history
Add guide on geolocation testing. Update guides on running tests.

See merge request documentation/uilicious-docs-v3!39
  • Loading branch information
Tai Shi Ling committed Feb 20, 2024
2 parents 15be4ff + c2e5a15 commit 50bda31
Show file tree
Hide file tree
Showing 9 changed files with 115 additions and 43 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 5 additions & 4 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,8 @@
## How to Guides

* Running a test
* [Run a test using the Editor](how-to-guides/run-test/run-test-using-editor.md)
* [Schedule a test using Jobs](how-to-guides/run-test/schedule-a-job.md)
* [Run a test using the CLI](how-to-guides/run-test/run-test-using-cli.md)
* [Connect to Webdriver Grid](how-to-guides/run-test/connect-to-webdriver-grid.md)
* [Basic Configuration](how-to-guides/run-test/run-test-using-editor.md)
* [Geolocation Testing](how-to-guides/geolocation-testing.md)
* Scheduling tests using Jobs
* [Setting up a job](how-to-guides/Setting-up-jobs/schedule-a-job.md)
* Notifications
Expand All @@ -28,6 +26,9 @@
* [Microsoft Teams](how-to-guides/Setting-up-jobs/set-up-microsoft-teams-notifications.md)
* [Discord](how-to-guides/Setting-up-jobs/set-up-discord-notifications.md)
* [Telegram](how-to-guides/Setting-up-jobs/set-up-telegram-notifications.md)
* Command Line Interface
* [Running a test](how-to-guides/run-test/run-test-using-cli.md)
* [Connecting to Webdriver Grid](how-to-guides/run-test/connect-to-webdriver-grid.md)
* Integrations
* Github
* [Saving project to Github](how-to-guides/github/saving-projects-to-github.md)
Expand Down
106 changes: 106 additions & 0 deletions how-to-guides/geolocation-testing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
---
# Write a short description about the page. This will be displayed on google search results.
description: In this guide, we'll learn how to configure tests to run in specific regions for geolocation testing.
---

# Geolocation Testing

{% hint %}

**Note that this feature is only available to UI-licious cloud users.** It is not available for self-hosted installations.

{% endhint %}

You can configure tests to run in specific regions for geolocation testing. This is useful for testing content that are region locked based on IP addresses, or for testing timezone-sensitive features.

## Available regions

These are the regions that are currently available:

**Asia Pacific**
| Region | Timezone |
|-----------|-----------|
| Hong Kong | +8 GMT |
| Singapore | +8 GMT |
| Jakarta | +7 GMT |
| Bangalore | +5:30 GMT |

**Europe**
| Region | Timezone |
|-----------|-----------|
| Amsterdam | +1 GMT |
| Frankfurt | +1 GMT |
| London | +0 GMT |

**North America**
| Region | Timezone |
|----------------|-----------|
| Toronto | -4 GMT |
| New York | -5 GMT |
| San Francisco | -8 GMT |

{% hint %}

Note that timezones are fixed and will not be affected by daylight savings.

{% endhint %}


## Configuring test run region

{% hint %}

Note that only **Chrome** and **Firefox** browsers are supported in multiple regions.

{% endhint %}

To select a region for your test run, click on the Gear button in the Run toolbar to view the expanded Test Run Configuration menu.

Click on "**Region**" to select a region.

![](/static/img/test-configuration/configure-region__step-1.png)

**Select a region** that you want to run the test from.

![](/static/img/test-configuration/configure-region__step-2.png)

Once selected, run the test. The region that a test is ran with is indicated on a test report in the bottom left corner.

![](/static/img/test-configuration/configure-region__step-3.png)

## Setting default region

By default, tests will always be ran with the region set to "No Preference", which uses a range of IP addresses based in UK, with the timezone set to +0 GMT.

If you wish to choose a different region as the default, you may do so in two ways:
1. Set a default region
2. Set a default saved configuration with a selected region

### Setting a default region

Click the Gear button in the Run toolbar to view the expanded Test Run Configuration menu.

Then, click "**Add configuration**" or "**Manage configurations**" to open the Configurations settings dialog.

![](/static/img/test-configuration/set-default-region__step-1.png)

**Select a region** you want to use as default, then click **"Set default"**.

![](/static/img/test-configuration/set-default-region__step-2.png)

Now, whenever you open the project, the default region will be automatically selected. **Note that this default setting will be overridden if you have set a default saved configuration.**

### Setting a default region using saved configrations

Click the Gear button in the Run toolbar to view the expanded Test Run Configuration menu.

Then, click "**Add configuration**" or "**Manage configurations**" to open the Configurations settings dialog.

![](/static/img/test-configuration/set-default-region__step-1.png)

**Select a region** you want to use as default, then **save the configuration**, and **set the saved configuration as your default**.

![](/static/img/test-configuration/set-default-region__step-3.png)

Now, whenever you open the project, the default saved configuration will be loaded, applying the selected region from the saved configuration.

43 changes: 4 additions & 39 deletions how-to-guides/run-test/run-test-using-editor.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
# Write a short description about the page. This will be displayed on google search results.
description: Learn how to run a UIlicious test using the Editor on UIlicious Studio.
description: In this guide, learn how to run a test on UI-licious Studio
---

# Run a test using the Editor
# Running a test

In UIlicious Studio, you can write and run tests in the Editor tab.
In UIlicious Studio, you can write and run tests in the **Editor** view.

The Editor tab has three panes:
1. **Workspace** - Manage your files in your project here
Expand Down Expand Up @@ -43,39 +43,4 @@ Once the test starts, you will start seeing the test results while the test runs

![The Editor with a finished test report](/static/img/uilicious-studio-editor-test-report-shown.png)

You can click on the individual steps to view the screenshot for the step, or use the Up / Down Arrow Keys to move between steps.

## Advanced configuration

You can access advanced test run configurations by clicking on the "**Custom Test Run**" button in the "Run" menu.

![Access more configurations from "Custom Test Run"](/static/img/uilicious-studio-editor-custom-test-run.png)

<br>

You can configure the browser, resolution, dataset, region, and user agent to run the test with.

![Run settings](/static/img/uilicious-studio-editor-run-settings.png)

Once you are done configuring the test settings, you start the test by clicking the "**Run**" button.

## Setting default dataset

If you frequently run a test with the same dataset, you can set the default for the dataset to save time. This default will only be set for you, and the rest of your team members will not share your default settings.

Click "**Manage Datasets**" from the "Datasets" dropdown.

![Open the "Manage Datasets" dialog](/static/img/uilicious-studio-editor-manage-dataset.png)

Click on "**Set as default**" on the dataset that you want to use as your default dataset when running tests from the Editor.

![Set a default dataset to use when running tests from the editor](/static/img/uilicious-studio-editor-set-default-dataset.png)


## Setting default region

If you frequently run a test with the same region, you can set the default for the region to save time. This default will only be set for you, and the rest of your team members will not share your default settings.

Open "**Custom Test Run**" from the "Run" menu. Select a region, and click "**Set as default**" to make the selected region the default region when running tests from the Editor.

![Set a default region to use when running tests from the editor](/static/img/uilicious-studio-editor-set-default-region.png)
You can click on the individual steps to view the screenshot for the step, or use the Up / Down Arrow Keys to move between steps.

0 comments on commit 50bda31

Please sign in to comment.