Skip to content

Commit

Permalink
Created a new doc for Basic Authentication (Safari) (#530)
Browse files Browse the repository at this point in the history
Created a new doc for Automating Basic Authentication in Safari, Updated MailBox, Phone Number and Test Step Settings.
  • Loading branch information
bharathk08 authored Nov 14, 2024
1 parent 8659dcb commit 8f88e9b
Show file tree
Hide file tree
Showing 5 changed files with 108 additions and 12 deletions.
3 changes: 2 additions & 1 deletion src/left-nav-title.json
Original file line number Diff line number Diff line change
Expand Up @@ -682,5 +682,6 @@
"test-cases": {"/docs/windows-lite-automation/test-cases/": "Test Cases for Windows (Lite)" },
"copado-integration": {"/docs/continuous-integration/copado-integration/": "Copado CI/CD" },
"features-and-scenarios": {"/docs/test-cases/manage/features-and-scenarios/": "Features & Scenarios" },
"key-components": {"/docs/testsigma-tunnel/key-components/": "Components & Requirements" }
"key-components": {"/docs/testsigma-tunnel/key-components/": "Components & Requirements" },
"basic-authentication-safari": {"/docs/desired-capabilities/basic-authentication-safari/": "Basic Authentication [Safari]" }
}
67 changes: 67 additions & 0 deletions src/pages/docs/desired-capabilities/basic-authentication-safari.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
title: "Automating Basic Authentication in Safari"
page_title: "Automating Basic Authentication in Safari"
metadesc: "Safari restricts automated basic authentication login by blocking credentials in the URL format. This article discusses bypassing this limitation in Testsigma."
noindex: false
order: 15.99
page_id: "Basic Authentication in Safari"
search_keyword: ""
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Prerequisites"
url: "#prerequisites"
- type: link
name: "Generate the Authorization Header"
url: "#generate-the-authorization-header"
- type: link
name: "Adding the Capability"
url: "#adding-the-capability"
---

---

Safari restricts automated Basic Authentication login by blocking credentials in the URL format, which is a challenge in automation testing. In Testsigma, you can bypass this limitation using an encoded Authorization header in the desired capabilities. This article discusses generating the necessary authorization token and configuring capabilities.

---

> ## **Prerequisites**
>
> Before you begin, ensure you are familiar with the concepts of [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/), [Ad-hoc Runs](https://testsigma.com/docs/runs/adhoc-runs/), and [Desired Capabilities](https://testsigma.com/docs/desired-capabilities/overview/) in Testsigma.
---

## **Generate the Authorization Header**

1. Navigate to [Basic Auth Header Generator](https://www.debugbear.com/basic-auth-header-generator).

2. Enter your **username** and **password** to generate the **Authorization Header**.

![Auth Header](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Header_Generator.png)

---

## **Adding the Capability**

1. On the **Test Case Details** page, click **Run**.
![Run](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Run_Now_BA.png)

2. In the **Ad-Hoc Run** overlay,

- Select available **macOS**, **Version**, **Browser**, and **Resolution**.
![Machine, Ver, Browser & Resol](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Machine_OS_BA.png)

- Enter **testsigma.customHeaders** in the **Key** field, select **String** as **Data type**, and set the **Value** as per the generated **Authorization Header**.
![Desired Capabilities](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Desired_Capabilities_BA.png)

> **Value Format:** ```{ "Authorization": "Basic <token>" }```
3. Click **Run Now** to execute the test case.
![Execute Test](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Execute_Test_BA.png)

4. After execution completes, refer to the screenshot captured at the test step level.
![Screenshot of Execution](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Screenshot_Run_BA.png)

---
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ contextual_links:
- type: link
name: "Use Test Step Settings"
url: "#use-test-step-settings"
- type: link
name: "Configuring Global Timeouts (New)"
url: "#configuring-global-timeouts-new"
- type: link
name: "Update Step Settings"
url: "#update-step-settings"
Expand Down Expand Up @@ -60,6 +63,23 @@ Here’s a quick GIF demonstrating how to access & update the test step settings

---

## **Configuring Global Timeouts (New)**

The following table outlines how the **Global Step Timeout** settings & **Test Step Timeout** interact based on different configurations.

| Scenario | Test Step Timeout | Global Step Timeout | Toggle | Outcome |
|----------|-----------------------------------------|----------------------|--------|---------------------------------------------------------------------------------------------|
| **Case 1** | 30 seconds (default) | 30 seconds (default)| OFF | Global timeout (30 seconds) applies universally, as it matches the default step timeout. |
| **Case 2** | 30 seconds (default) | 60 seconds | OFF | Global timeout (60 seconds) applies, as it overrides the default step timeout (30 seconds). |
| **Case 3** | Some steps customized, some unchanged | Updated value | OFF | Customized steps use their specific timeouts and steps without custom timeouts use the global timeout. |
| **Case 4** | Some steps customized, some unchanged | Any value | ON | Global timeout applies to all steps, overriding step-specific timeouts. |


Refer to the screenshot below to enable the **Global Step Timeout** toggle in the **Additional Settings** section of the **Adhoc Run** overlay.

![Global Timeouts](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Global_Settings.png)

---
## **Update Step Settings**

To update several test steps, click the **checkboxes** next to the **test steps** you want to update and then click on **Update Settings** in the menu bar to open a popup window where you can make changes to the settings. ![Update Step Settings](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/update_testsettings.gif)
Expand Down
13 changes: 8 additions & 5 deletions src/pages/docs/test-data/types/mailbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,14 @@ Testsigma provides a digital inbox called Mail Box to verify OTP accuracy, check

---

## **Prerequisites**

Before using Mailbox Test Data, ensure that you understand specific concepts such as creating a [Test Case](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#creating-a-test-case), managing [Test Steps](https://testsigma.com/docs/test-cases/step-types/natural-language/), and effectively using them with [Test Data Types](https://testsigma.com/docs/test-data/types/overview/) and [Data Generators](https://testsigma.com/docs/test-data/types/data-generator/). Additionally, familiarise yourself with [Regular expressions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions) if necessary.
> ## **Prerequisites**
>
> Before using Mailbox Test Data, ensure that you understand specific concepts such as creating a [Test Case](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#creating-a-test-case), managing [Test Steps](https://testsigma.com/docs/test-cases/step-types/natural-language/), and effectively using them with [Test Data Types](https://testsigma.com/docs/test-data/types/overview/) and [Data Generators](https://testsigma.com/docs/test-data/types/data-generator/). Additionally, familiarise yourself with [Regular expressions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions) if necessary.
[[info | NOTE:]]
| You can enable Mail Box for your account by contacting **[email protected]** or using the **instant chat** option.
| - You can enable Mail Box for your account by contacting **[email protected]** or using the **instant chat** option.
| - You can now access the Mail Box & Phone Numbers outside of test executions. This allows you to retrieve messages, OTPs, and authentication codes when you enable the toggle.
| - For test executions, the toggle does not affect the execution. The test will continue to run regardless of whether the toggle is enabled or not.

---

Expand Down Expand Up @@ -83,7 +85,8 @@ Here is a quick GIF demonstrating the above workflow:
![Fetch OTP from Mail Box](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/fetchotp_mailbox.gif)

[[info | NOTE:]]
| You must perform both [Add Mail Box in Test Step](https://testsigma.com/docs/test-data/types/mailbox/#add-mailbox-in-test-step) and [Fetch OTP from Mail Box](https://testsigma.com/docs/test-data/types/mailbox/#fetch-otp-from-mailbox) for Two-Factor Authentication.
| - You must perform both [Add Mail Box in Test Step](https://testsigma.com/docs/test-data/types/mailbox/#add-mailbox-in-test-step) and [Fetch OTP from Mail Box](https://testsigma.com/docs/test-data/types/mailbox/#fetch-otp-from-mailbox) for Two-Factor Authentication.


---

Expand Down
17 changes: 11 additions & 6 deletions src/pages/docs/test-data/types/phone-number.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,15 @@ The phone number data type is used to automate two-factor authentication (2FA) a

---

## **Prerequisites**
- You should be familiar with regular expressions. Refer to the [regex guide](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions).
> ## **Prerequisites**
>
> - You should be familiar with regular expressions. Refer to the [regex guide](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions).
[[info | NOTE:]]
| - You can enable Phone Number for your account by contacting **[email protected]** or using the **instant chat** option.
| - You can now access the Phone Numbers outside of test executions. This allows you to retrieve messages, OTPs, and authentication codes when you enable the toggle.
| - For test executions, the toggle does not affect the execution. The test will continue to run regardless of whether the toggle is enabled or not.

- Contact **[email protected]** to get a phone number.

---

Expand Down Expand Up @@ -75,9 +80,9 @@ Providing phone numbers for OTP and login purposes is restricted in certain coun

---

## **Prerequisites**

- You should have Testsigma SMS Forwarder application.
> ## **Prerequisites**
>
> - You should have Testsigma SMS Forwarder application.

---
Expand Down

0 comments on commit 8f88e9b

Please sign in to comment.