-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated Documents as per React UI - Set 6 (#317)
* Updated Documents as per React UI - Set 6 * Updated Meta Title for React Set 6 docs
- Loading branch information
1 parent
d10962d
commit 82884a1
Showing
3 changed files
with
206 additions
and
358 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,143 +1,140 @@ | ||
| --- | ||
| title: "Mailbox Test Data Types" | ||
| page_title: "Mailbox type Test Data in Testsigma" | ||
| metadesc: "Use Mailbox feature to get the first email's relevant details, such as content, OTP, and subject information. Learn how to use Mailbox feature in Testsigma" | ||
| title: "Test Data Type: Mail Box" | ||
| page_title: "Mailbox Test Data Types for Effective Testing" | ||
| metadesc: "Learn how to use Mail Box Test Data Types in Testsigma to verify OTP, validate email content and improve your testing efficiency with this guide." | ||
| noindex: false | ||
| order: 5.119 | ||
| page_id: "Mailbox type Test Data" | ||
| page_id: "mailbox-test-data-types-testsigma" | ||
| warning: false | ||
| contextual_links: | ||
| - type: section | ||
| name: "Contents" | ||
| - type: link | ||
| name: "Add Mailbox in Test Step" | ||
| url: "#add-mailbox-in-test-step" | ||
| name: "Prerequisites" | ||
| url: "#prerequisites" | ||
| - type: link | ||
| name: "Fetch OTP from Mailbox" | ||
| url: "#fetch-otp-from-mailbox" | ||
| name: "Adding Mail Box in a Test Step" | ||
| url: "#adding-mail-box-in-a-test-step" | ||
| - type: link | ||
| name: "Store Data as a Runtime Variable from Mailbox" | ||
| url: "#store-data-as-a-runtime-variable-from-mailbox" | ||
| name: "Fetching OTP from Mail Box" | ||
| url: "#fetching-otp-from-mail-box" | ||
| - type: link | ||
| name: "Create Mailbox Alias in Test Step" | ||
| url: "#create-mailbox-alias-in-test-step" | ||
| name: "Store Data as a Runtime Variable from Mail Box" | ||
| url: "#store-data-as-a-runtime-variable-from-mail-box" | ||
| - type: link | ||
| name: "Generate Mailbox Alias for Test Cases Execution" | ||
| url: "#generate-mailbox-alias-for-test-cases-execution" | ||
| name: "Create Mail Box Alias in Test Step" | ||
| url: "#create-mail-box-alias-in-test-step" | ||
| - type: link | ||
| name: "Generate Mail Box Alias for Test Cases Execution" | ||
| url: "#generate-mail-box-alias-for-test-cases-execution" | ||
|
|
||
| --- | ||
|
|
||
| --- | ||
|
|
||
| Mailbox test data can be utilized in Testsigma for various purposes | ||
|
|
||
| * Verify the accuracy of the OTP delivered via email by receiving an email and authenticating its content. | ||
| * Validation of email content in numerous languages. | ||
| * Assessment of a user's ability to read an entire promotional email within a stipulated time. | ||
|
|
||
| Here's how you can use the built-in feature in Testsigma to access the mailbox, check if the mail has been received, open the email, read it, and process it. | ||
| Testsigma provides a digital inbox called Mail Box to verify OTP accuracy, check for received emails, open and read them, process them, validate email content in various languages, and test the speed at which a user can read a promotional email during testing. This guide will help you access and manage the Mail Box. | ||
|
|
||
| [[info | NOTE:]] | ||
| | Testsigma designed the Mailbox feature to retrieve only the first email's relevant details, such as content, OTP, and subject information. | ||
| | Testsigma designed the Mail Box feature to retrieve relevant details from the first email, including content, OTP, and subject information. | ||
|
|
||
| --- | ||
|
|
||
| ### **Prerequisites** | ||
| ## **Prerequisites** | ||
|
|
||
| Provisioned mailbox - Contact [Testsigma Support](mailto:support@testsigma.com) or use the **Instant Chat** option; we will provision a mailbox for you. | ||
| 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. | ||
|
|
||
| You should also be familiar with Regular expressions. If not, refer to the [Regex guide - MDN Docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions) | ||
| [[info | NOTE:]] | ||
| | You can enable Mail Box for your account by contacting [Testsigma Support]([email protected]) or using the **Instant Chat** option. | ||
|
|
||
| --- | ||
|
|
||
| ## **Add Mailbox in Test Step** | ||
| ## **Adding Mail Box in a Test Step** | ||
|
|
||
| We will enter the Email Address provided by Testsigma using the Mailbox test data type in Test Step. Follow the steps below: | ||
| Follow these steps to include an email address provided by Testsigma using the Mailbox test data type in a Test Step: | ||
|
|
||
| 1. Create a **new step** in the **test case**, including a placeholder for **test data** in the NLP. | ||
| 2. **Replace** the **test data** placeholder by selecting **&|Mailbox|** from the test data types dropdown menu. | ||
| 3. Select the **Email** from the right-side panel. | ||
|
|
||
| Here is a quick GIF demonstrating the above workflow: | ||
|  | ||
| 1. Use **NLP** to create a **new step** in the **Test Case** and include a placeholder for **test data**. | ||
| 2. Click the **test data** placeholder to replace it, and then select the **& Mail Box** from the **Test Data Types** dropdown menu. | ||
| 3. Select the **Email** from the right-side panel.  | ||
|
|
||
| --- | ||
|
|
||
| ## **Fetch OTP from Mailbox** | ||
| ## **Fetching OTP from Mail Box** | ||
|
|
||
| We will use the Test Data Generators available in Testsigma to store the OTP/ any data from the Mailbox selected. Follow the steps below: | ||
| Follow these steps to retrieve OTP or any data from the selected Mailbox using Test Data Generators in Testsigma: | ||
|
|
||
| 1. Create a **new step** in the **test case**, including a placeholder for **test data** and an **element** in the **NLP** to enter the OTP code in the **OTP** field. | ||
| 2. **Replace** the **test data** placeholder by selecting **!|Data Generator|** from the test data types dropdown menu. | ||
| 3. Search and select the Test Data generator function **!|MailBoxFunctions :: getEmailOTP|**. | ||
| 4. **Click** the **element** placeholder and **select** an **element** from the right side of the panel. | ||
| 5. Enter the required arguments for the function and **create** the Test Step. | ||
| - **Regex**: A sequence of characters defines a search pattern. Here, for example, we are given **\d{4}**, which is a pattern that matches any sequence of four consecutive digits (0-9). | ||
| - **MailBox**: It is an email mailbox that holds incoming email messages. Select Email from the drop-down list. | ||
| - **Timeout**: Enter the time a programme or system is willing to wait for a particular operation to complete. Here, for example, we are given 30 seconds to wait. | ||
| 1. Use **NLP** to create a **new step** in the **Test Case** that adds a placeholder for **test data** and an **element** for entering the OTP code in the **OTP** field. | ||
| 2. Click the **test data** placeholder to replace it, and then select the **! Data Generator** from the **Test Data Types** dropdown menu. | ||
| 3. On the right sidebar, select **Data Generator** type as the **default**, Function type as **MailBoxFunctions**, and choose the function as **getEmailOTP** from the dropdown menu. | ||
| 4. Configure the Test Step by providing the necessary details for the function: | ||
| - **Regex**: A search pattern is created by a sequence of characters. For instance, **\d{4}** matches four consecutive digits **(0-9)**. | ||
| - **MailBox**: Select **Mail Box** from the drop-down list. It stores incoming email messages. | ||
| - **Timeout**: Set the time for how long a program or system should wait for a specific task to finish. In this example, we will wait for **30** seconds. | ||
| 5. Click **Save** to store the provided arguments in the data generator for this test step. | ||
|
|
||
| Here is a quick GIF demonstrating the above workflow: | ||
|  | ||
|  | ||
|
|
||
| [[info | NOTE:]] | ||
| | For Two Factor Authentication, you must perform [Add Mailbox in Test Step](https://testsigma.com/docs/test-data/types/mailbox/#add-mailbox-in-test-step) and [Fetch OTP from Mailbox](https://testsigma.com/docs/test-data/types/mailbox/#fetch-otp-from-mailbox). | ||
| | 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. | ||
|
|
||
| --- | ||
|
|
||
| ## **Store Data as a Runtime Variable from Mailbox** | ||
| ## **Store Data as a Runtime Variable from Mail Box** | ||
|
|
||
| We will use the Test Data Generators available in Testsigma to store the OTP/ any data from the Mailbox selected. Follow the steps below: | ||
| Follow the below steps to save the data obtained from the Mailbox as a runtime variable to use later in the test case using Test Data Generators in Testsigma. | ||
|
|
||
| 1. Create a **new step** in the **test case**, including two placeholders for **test data** in the **NLP** to store **data** in the runtime variable. | ||
| 2. **Replace** the **test-data-1** placeholder by selecting **!|Data Generator|** from the test data types dropdown menu. | ||
| 3. Search and select the Test Data generator function **!|MailBoxFunctions :: contentVerification|**. | ||
| 4. **Replace** the **test-data-2** placeholder by selecting **$|Runtime|** from the test data types dropdown menu. Select the runtime variable from the right side of the panel to store data. | ||
| 5. Enter the required arguments for the function and **create** the Test Step. | ||
| - **Regex**: A sequence of characters defines a search pattern. Here, for example, we are given **\d{4}**, which is a pattern that matches any sequence of four consecutive digits (0-9). | ||
| - **MailBox**: It is an email mailbox that holds incoming email messages. Select Email from the drop-down list. | ||
| - **Compare String**: CompareString is a function used in programming languages to compare two strings and determine if they are equal or not. | ||
| - **Timeout**: Enter the time a programme or system is willing to wait for a particular operation to complete. Here, for example, we are given 30 seconds to wait. | ||
| 1. Create a **new step** in the **Test Case** using **NLP** that adds **two** placeholders for **test data** to store data as runtime variables. | ||
| 2. Click the **test data-1** placeholder to replace it, and then select the **! Data Generator** from the **Test Data Types** dropdown menu. | ||
| 3. On the right sidebar, select **Data Generator** type as the **default**, **Function type** as **MailBoxFunction**, and choose the **Function** as **contentVerification** from the dropdown menu. | ||
| 4. Configure the Test Step by providing the necessary details for the function: | ||
| - **Regex**: A search pattern is created by a sequence of characters. For instance, **\d{4}** matches four consecutive digits **(0-9)**. | ||
| - **MailBox**: Select **Mail Box** from the drop-down list. It stores incoming email messages. | ||
| - **Compare String**: Provide the CompareString function, which compares two strings and determines if they are identical. | ||
| - **Timeout**: Set the time for how long a program or system should wait for a specific task to finish. In this example, we will wait for **30** seconds. | ||
| 5. Click **Save** to store the provided arguments in the data generator for this test step. | ||
| 6. Substitute specific **text** for the **test-data-2** placeholder and create a step to generate a runtime variable that stores the value in that **text**. | ||
|
|
||
| Here is a quick GIF demonstrating the above workflow: | ||
|  | ||
|  | ||
|
|
||
| [[info | NOTE:]] | ||
| | You can store the subject by selecting the Test Data Generator function: **!|MailBoxFunctions :: subjectVerification|**. | ||
| | You can store the subject by selecting the Test Data Generator function: **! MailBoxFunctions :: subjectVerification**. | ||
|
|
||
| --- | ||
|
|
||
| ## **Create Mailbox Alias in Test Step** | ||
| ## **Create Mail Box Alias in Test Step** | ||
|
|
||
| During a test step, you can create a mailbox alias that connects an additional email address to your primary email account. This allows you to generate multiple email addresses that all direct to the same inbox. When you execute the test, it generates a unique mailbox for each alias. | ||
|
|
||
| In the test step; you can create a mailbox alias that associates an additional email address with your primary email account. You can use it to create multiple email addresses that all lead to the same inbox. It generates a unique mailbox every time you execute it during test execution. | ||
| 1. Create a **new step** in the **Test Case** using **NLP** that adds **two** placeholders for **test data** to create a mailbox alias. | ||
| 2. Click the **test data-1** placeholder to replace it, and then select the **! Data Generator** from the **Test Data Types** dropdown menu. | ||
| 3. On the right sidebar, select Data Generator type as the default, Function type as MailBoxFunction, and choose the Function as generateMailBoxAlias from the dropdown menu. | ||
| 4. Select Linked Mail Box to create a unique mailbox every time and click **Save**. | ||
| 5. Substitute specific **text** for the **test-data-2** placeholder and click **Create Step** to save the test step. It stores the **mailbox** within the **text** as a runtime variable. | ||
|
|
||
| 1. Create a **new step** in the **test case**, including two placeholders for **test data** in the **NLP** to create a mailbox alias. | ||
| 2. **Replace** the **test-data-1** placeholder by selecting **!|Data Generator|** from the test data types dropdown menu. | ||
| 3. Search and select the Test Data generator function **!|MailBoxAliasFunctions :: generateMailBoxAlias|**. | ||
| 4. Select Linked Mailbox to create a unique mailbox every time and click **Save**. | ||
| 5. **Delete** the **test-data-2** placeholder and enter text by creating a runtime variable and storing the email. Here, for example, we are given **Email1** as a runtime variable. Alternatively, select **$|Runtime|** from the **test data types** and store the email by selecting the runtime variable from the right side of the panel. | ||
| [[info | NOTE:]] | ||
| | For example, we store the email in a runtime variable named **email1**. You can use it in the Test Case by selecting **$ Runtime** from the test data types. | ||
|
|
||
| Here is a quick GIF demonstrating the above workflow: | ||
|  | ||
|  | ||
|
|
||
| --- | ||
|
|
||
| ## **Generate Mailbox Alias for Test Cases Execution** | ||
|
|
||
| Sometimes, you may need to test email-based functionalities for multiple new accounts with limited email addresses. In such scenarios, Testsigma allows you to generate new aliases every time during the test case execution. | ||
| ## **Generate Mail Box Alias for Test Cases Execution** | ||
|
|
||
| Below are the NLP tools that you can use for the same. It would be best to use add-ons such as **Data Generators** and **Actions** with the NLP tools mentioned below to store email in the runtime variable and verify the email messages. | ||
| With Testsigma, you can generate new mailbox aliases every time during test case execution, improving efficiency and reusability by making it easy to use in many test steps or test cases. If you have only a few email addresses but need to test functions related to emails for various new accounts, Testsigma can help. | ||
|
|
||
|
|
||
| |**Data Generators**|**Actions**|**Inputs**| | ||
| |---|---|---| | ||
| |**!\|MailBoxAliasFunctions :: getEmailContent\|**|This will get the entire email's content into a variable.|<li>Runtime Variable</li><li>Timeout in seconds</li>*For Example: Runtime Variable - content, Timeout - 30*| | ||
| |**!\|MailBoxAliasFunctions :: getEmailSubject\|**|This will get the entire email's subject into a variable.|<li>Runtime Variable</li><li>Timeout in seconds</li>*For Example: Runtime Variable - subject, Timeout - 30*| | ||
| |**!\|MailBoxAliasFunctions :: getOTP\|**|This will fetch the OTP sent to the email box into a variable.|<li>Regex</li><li>Runtime Variable</li><li>Timeout in seconds</li>*For Example: Regex - \d{4,6}, Runtime Variable - otp, Timeout - 30*| | ||
| |**!\|MailBoxAliasFunctions :: urlWithText\|**|This will fetch the URL that contains some required text.|<li>Text</li><li>Runtime Variable</li><li>Timeout in seconds</li>*For Example: Text - randomtext, Runtime Variable - url, Timeout - 30*| | ||
| |**!\|MailBoxAliasFunctions :: urlWhichContains\|**|This will fetch the URL that contains some required parameters.|<li>Substring</li><li>Runtime Variable</li><li>Timeout in seconds</li>*For Example: Substring - example, Runtime Variable - random_text, Timeout - 30*| | ||
| |**!\|MailBoxAliasFunctions :: urlMatchingRegex\|**|This will fetch the URL that contains a URL matching the required regex.|<li>Regex</li><li>Runtime Variable</li><li>Timeout in seconds</li>*For Example: Regex - r'https://\w+\.com/\w+', Runtime Variable - path, Timeout - 30*| | ||
| |**! MailBoxAliasFunctions :: getEmailContent**|This will get the entire email's content into a variable.|<li>Runtime Variable</li><li>Timeout in seconds</li>*For Example: Runtime Variable - content, Timeout - 30*| | ||
| |**! MailBoxAliasFunctions :: getEmailSubject**|This will get the entire email's subject into a variable.|<li>Runtime Variable</li><li>Timeout in seconds</li>*For Example: Runtime Variable - subject, Timeout - 30*| | ||
| |**! MailBoxAliasFunctions :: getOTP**|This will fetch the OTP sent to the email box into a variable.|<li>Regex</li><li>Runtime Variable</li><li>Timeout in seconds</li>*For Example: Regex - \d{4,6}, Runtime Variable - otp, Timeout - 30*| | ||
| |**! MailBoxAliasFunctions :: urlWithText**|This will fetch the URL that contains some required text.|<li>Text</li><li>Runtime Variable</li><li>Timeout in seconds</li>*For Example: Text - randomtext, Runtime Variable - url, Timeout - 30*| | ||
| |**! MailBoxAliasFunctions :: urlWhichContains**|This will fetch the URL that contains some required parameters.|<li>Substring</li><li>Runtime Variable</li><li>Timeout in seconds</li>*For Example: Substring - example, Runtime Variable - random_text, Timeout - 30*| | ||
| |**! MailBoxAliasFunctions :: urlMatchingRegex**|This will fetch the URL that contains a URL matching the required regex.|<li>Regex</li><li>Runtime Variable</li><li>Timeout in seconds</li>*For Example: Regex - r'https://\w+\.com/\w+', Runtime Variable - path, Timeout - 30*| | ||
|
|
||
| Below is a screenshot showing a test case generating a mailbox alias and getting content from the email. | ||
|  | ||
|  | ||
|
|
||
| --- |
Oops, something went wrong.