From ae2ad42a61be79a0f3b7d4a349524480beed0601 Mon Sep 17 00:00:00 2001 From: Sangith Ravichandran <119392848+sangithravichandran@users.noreply.github.com> Date: Wed, 17 Jul 2024 10:21:26 +0530 Subject: [PATCH 1/7] Added Address, Company, File & IdNumber Document (#449) * Added Address, Company, File & IdNumber Document * Updated contextual_links --- .../data-generators/address-function-type.md | 1101 +++++++++++++++++ .../data-generators/company-function-type.md | 529 ++++++++ .../data-generators/file-function-type.md | 277 +++++ .../data-generators/idnumber-function-type.md | 299 +++++ .../data-generators/name-function-type.md | 106 +- 5 files changed, 2286 insertions(+), 26 deletions(-) create mode 100644 src/pages/docs/test-data/data-generators/address-function-type.md create mode 100644 src/pages/docs/test-data/data-generators/company-function-type.md create mode 100644 src/pages/docs/test-data/data-generators/file-function-type.md create mode 100644 src/pages/docs/test-data/data-generators/idnumber-function-type.md diff --git a/src/pages/docs/test-data/data-generators/address-function-type.md b/src/pages/docs/test-data/data-generators/address-function-type.md new file mode 100644 index 00000000..18a01c4f --- /dev/null +++ b/src/pages/docs/test-data/data-generators/address-function-type.md @@ -0,0 +1,1101 @@ +--- +title: "Address Function Type" +pagetitle: "Generate Random Addresses for Testing and Simulation" +metadesc: "Start addresses easily with our tool. Generate random addresses including street, city, state, and postal code for testing or data simulation." +noindex: false +order: 5.34 +page_id: "address-function-type" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Selecting Address as a Function Type for Data Generator" + url: "#selecting-address-as-a-function-type-for-data-generator" +- type: link + name: "Street Name" + url: "#street-name" +- type: link + name: "Street Address Number" + url: "#street-address-number" +- type: link + name: "Street Address" + url: "#street-address" +- type: link + name: "Secondary Address" + url: "#secondary-address" +- type: link + name: "Zip Code" + url: "#zip-code" +- type: link + name: "Zip Code by State" + url: "#zip-code-by-state" +- type: link + name: "Street Suffix" + url: "#street-suffix" +- type: link + name: "Street Prefix" + url: "#street-prefix" +- type: link + name: "City Suffix" + url: "#city-suffix" +- type: link + name: "City Prefix" + url: "#city-prefix" +- type: link + name: "City" + url: "#city" +- type: link + name: "State" + url: "#state" +- type: link + name: "State Abbr" + url: "#state-abbr" +- type: link + name: "Latitude" + url: "#latitude" +- type: link + name: "Longitude" + url: "#longitude" +- type: link + name: "Timezone" + url: "#timezone" +- type: link + name: "Country" + url: "#country" +- type: link + name: "Country Code" + url: "#country-code" +- type: link + name: "Building Number" + url: "#building-number" +- type: link + name: "Full Address" + url: "#full-address" +--- + +--- + +The Address Function Type provides various functions that generate realistic and varied address components. These functions help in creating complete and detailed addresses, which are crucial for ensuring the proper handling of various address formats and elements in different applications. Each function focuses on a specific address part, allowing for the creation of comprehensive and authentic address data for diverse purposes. + +--- + +## **Prerequisites** + +Before utilising the different data generator functions, it's essential to understand basic concepts such as creating [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#create-test-case) and [Test Steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/) and [adding data generators](https://testsigma.com/docs/test-data/types/data-generator/#add-data-generators-in-test-steps) in test steps. + +--- + +## **Selecting Address as a Function Type for Data Generator** + +1. Use **NLP** to create a **new step** in the test case and include a placeholder for **test data**. +2. Click on the **test data** placeholder. From the **Test Data Types** dropdown menu, select the **! Data Generator** option. +3. On the **! Data Generators** overlay screen, select the **Type** to **Default**. This will enable you to use a collection of built-in test data generators. +4. Select **Address** from the **Function Type** dropdown list. ![select address function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/address_functiontype_dg.gif) + +[[info | NOTE:]] +| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. + +--- + +## **Street Name** + +- Allows you to generate realistic street names commonly found in residential or commercial areas. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Street Address Number** + +- Enables you to generate realistic house or building numbers for addresses. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Street Address** + +- Enables you to generate complete street addresses with or without secondary address components for comprehensive address data creation. Select True in Secondary Address to include secondary address, or select False to exclude it. + + + +
+
+ ℹ️Example: +

+ + + + + + + + + + + + + + + + + + + + + +
InputOutput
Secondary Address: True456 Oak Street, Apt. 12
Secondary Address: True789 Pine Avenue, Suite 5B
Secondary Address: False456 Oak Street
Secondary Address: False789 Pine Avenue
+
+ +--- + +## **Secondary Address** + +- Enables you to generate realistic secondary address components. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Zip Code** + +- Allows you to generate random zip codes for various addresses to ensure each address entry has a realistic postal code, aiding in location-specific data handling. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Zip Code by State** + +- Enables you to generate state-specific ZIP codes based on the provided state abbreviation. + + + +
+
+ ℹ️Example: +

+ + + + + + + + + + + + + + + + + + + + + +
Input: State AbbreviationOutput: Zip Code
CA90001
NY10001
TX73301
FL33101
+
+ +--- + +## **Street Suffix** + +- Allows you to generate street suffixes indicating the type or category of the street, adding specificity to street or names. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Street Prefix** + +- Enables you to generate a street prefix indicating the type. Providing directional or descriptive prefixes gives more context or direction to the street name. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **City Suffix** + +- Allows you to generate city suffixes indicating the type to categorize cities or towns based on their characteristics. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **City Prefix** + +- Enables you to generate a city prefix that indicates the start or characteristic of a city's name, providing city names to denote direction, location, or historical context. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **City** + +- Allows you to generates random city names and provides diverse urban area names for various applications that need city data. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **State** + +- Enables you to generates random state names. Provides state names for applications that require state-level data. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **State Abbr** + +- Allows you to generate two-letter codes representing states. It provides standardized abbreviations for efficient data handling. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Latitude** + +- Enables you to generate random latitude coordinates. It offers geographic coordinates for location-based services and mapping applications. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Longitude** + +- Allows you to generate random longitude coordinates. It provides geographic coordinates for precise location-based applications and mapping. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Timezone** + +- Enable you to generate time zone names. It provides time zone data for accurate time-related applications and scheduling. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Country** + +- Allows you to generate random country names and provides country names for applications requiring country-level data. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Country Code** + +- Enables you to generate two-letter or three-letter codes that uniquely identify countries. Provides standardized data handling and internationalization for ISO country codes. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Building Number** + +- Allows you to generate random building numbers. It provides numeric identifiers for buildings or addresses in applications that require specific location details. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Full Address** + +- Enables you to generate a complete location description including street, city, state, and postal code. + + + +
+
+ ℹ️Example: +
+ +
+ + +--- + + diff --git a/src/pages/docs/test-data/data-generators/company-function-type.md b/src/pages/docs/test-data/data-generators/company-function-type.md new file mode 100644 index 00000000..056425ae --- /dev/null +++ b/src/pages/docs/test-data/data-generators/company-function-type.md @@ -0,0 +1,529 @@ +--- +title: "Company Function Type" +pagetitle: "Generate Realistic Company with Data Generator Functions" +metadesc: "Explore how the Company function in data generators generates random names for testing and simulations, including first and last names." +noindex: false +order: 5.35 +page_id: "company-function-type" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Selecting Company as a Function Type for Data Generator" + url: "#selecting-company-as-a-function-type-for-data-generator" +- type: link + name: "Name" + url: "#name" +- type: link + name: "Suffix" + url: "#suffix" +- type: link + name: "Industry" + url: "#industry" +- type: link + name: "Profession" + url: "#profession" +- type: link + name: "Buzzword" + url: "#buzzword" +- type: link + name: "Catch Phrase" + url: "#catch-phrase" +- type: link + name: "BS" + url: "#bs" +- type: link + name: "Logo" + url: "#logo" +- type: link + name: "Join Sample of Each List" + url: "#join-sample-of-each-list" +--- + +--- + +The Company Function Type within data generators facilitates the creation of diverse and realistic company-related data for various applications. This feature suite includes functions that generate essential attributes of fictional companies, ranging from names and industry classifications to branding elements like catchphrases and logos. + +--- + +## **Prerequisites** + +Before utilising the different data generator functions, it's essential to understand basic concepts such as creating [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#create-test-case) and [Test Steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/) and [adding data generators](https://testsigma.com/docs/test-data/types/data-generator/#add-data-generators-in-test-steps) in test steps. + +--- + +## **Selecting Company as a Function Type for Data Generator** + +1. Use **NLP** to create a **new step** in the test case and include a placeholder for **test data**. +2. Click on the **test data** placeholder. From the **Test Data Types** dropdown menu, select the **! Data Generator** option. +3. On the **! Data Generators** overlay screen, select the **Type** to **Default**. This will enable you to use a collection of built-in test data generators. +4. Select **Company** from the **Function Type** dropdown list. ![select company function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/company_functiontype_dg.gif) + +[[info | NOTE:]] +| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. + +--- + +## **Name** + +- Enables you to generate a random company name to provide realistic names for fictional companies. It is useful for generating sample company names in forms, applications, and databases. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Suffix** + +- Allows you to generate a random company suffix to add common legal suffixes to company names. This is ideal for completing company names in legal documents, business forms, and official records. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Industry** + +- Enables you to generate a random industry name. This is beneficial for filtering and categorizing companies in databases, market analysis, and business simulations. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Profession** + +- Allows you to generate a random profession related to the company's industry. This is useful for creating employee profiles, job listings, and role-based testing scenarios. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Buzzword** + +- Enables you to generate a random business buzzword. This is useful for to convey a concept or idea succinctly, often associated with current trends or technology. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Catch Phrase** + +- Allows you to generate a random company catchphrase using it. It is designed to be catchy, memorable, and often used in marketing campaigns to leave a lasting impression. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **BS** + +- Enables you to generate a random business strategy (BS) phrase. It is useful for testing humor recognition, text processing algorithms, and generating playful business dialogues. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Logo** + +- Allows you to generate a random URL for a company logo. This is useful for testing image display functionality, logo uploads, and visual elements in applications and websites. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Join Sample of Each List** + +- Enables you to generate Joins samples from multiple lists into one compound word. By combining outputs from Name, Suffix, Industry, Profession, Buzzword, CatchPhrase, BS, and Logo functions, you can rapidly generate complete company profiles. + + +
+
+ ℹ️Example: +

+ + + + + + + + + + + + + + + + + + + + + + + + +
InputOutput
arg0: Tech Innovations Inc.,
arg1: Empowering Your Future
Tech Innovations Inc., Empowering Your Future
arg0: Global Healthcare Solutions, Inc.,
arg1: Transforming Healthcare Delivery
Global Healthcare Solutions, Transforming Healthcare Delivery
arg0: Quantum Dynamics Group,
arg1: Driving Financial Success
Quantum Dynamics Group, Driving Financial Success
arg0: Innovative Financial Strategies,
arg1: Leading Manufacturing Innovation
Innovative Financial Strategies, Leading Manufacturing Innovation
+
+ +--- + + diff --git a/src/pages/docs/test-data/data-generators/file-function-type.md b/src/pages/docs/test-data/data-generators/file-function-type.md new file mode 100644 index 00000000..50adb1d6 --- /dev/null +++ b/src/pages/docs/test-data/data-generators/file-function-type.md @@ -0,0 +1,277 @@ +--- +title: "File Function Type" +pagetitle: "Importing File Function Type for Dynamic File Handling" +metadesc: "Learn to utilize the File Function Type for dynamic file handling in your applications to generate random file extensions, MIME types, and file names." +noindex: false +order: 5.37 +page_id: "file-function-type" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Selecting File as a Function Type for Data Generator" + url: "#selecting-file-as-a-function-type-for-data-generator" +- type: link + name: "Extension" + url: "#extension" +- type: link + name: "MIME Type" + url: "#mime-type" +- type: link + name: "File Name with Directory Path" + url: "#file-name-with-directory-path" +- type: link + name: "Generate Filename based on Provided Arguments" + url: "#generate-filename-based-on-provided-arguments" +--- + +--- + +You can generate and manage various file-related data. This functionality is useful for handling files with specific attributes like file extensions, MIME types, and file names. Creating diverse file data for different applications can make file-handling tasks more efficient and organized. + +--- + +## **Prerequisites** + +Before utilising the different data generator functions, it's essential to understand basic concepts such as creating [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#create-test-case) and [Test Steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/) and [adding data generators](https://testsigma.com/docs/test-data/types/data-generator/#add-data-generators-in-test-steps) in test steps. + +--- + +## **Selecting File as a Function Type for Data Generator** + +1. Use **NLP** to create a **new step** in the test case and include a placeholder for **test data**. +2. Click on the **test data** placeholder. From the **Test Data Types** dropdown menu, select the **! Data Generator** option. +3. On the **! Data Generators** overlay screen, select the **Type** to **Default**. This will enable you to use a collection of built-in test data generators. +4. Select **File** from the **Function Type** dropdown list. ![select datefunctions function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/file_functiontype_dg.gif) + +[[info | NOTE:]] +| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. + +--- + +## **Extension** + +- Allows you to specify the type of file by adding a file extension. It helps in identifying the type of file. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **MIME Type** + +- Allows you to identify the format and nature of a file using MIME types. It helps applications recognize the type of file being processed. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **File Name with Directory Path** + +- Allows you to assign a specific name to a file, including the file extension. It helps in organizing and identifying files. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Generate Filename based on Provided Arguments** + +- Allows you to generate a filename based on specific provided arguments, ensuring customized file naming. + + +
+
+ ℹ️Examples: +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
InputOutput
arg0: /documents
arg1: /
arg2: annual_report
arg3: .pdf
/documents/annual_report.pdf
arg0: /spreadsheets
arg1: /
arg2: sales_data
arg3: .xlsx
/spreadsheets/sales_data.xlsx
arg0: /presentations
arg1: /
arg2: company_meeting
arg3: .pptx
/presentations/company_meeting.pptx
arg0: /data
arg1: /
arg2: customer_list
arg3: .csv
/data/customer_list.csv
+
+ + + +--- + + diff --git a/src/pages/docs/test-data/data-generators/idnumber-function-type.md b/src/pages/docs/test-data/data-generators/idnumber-function-type.md new file mode 100644 index 00000000..cbc6e2d9 --- /dev/null +++ b/src/pages/docs/test-data/data-generators/idnumber-function-type.md @@ -0,0 +1,299 @@ +--- +title: "IdNumber Function Type" +pagetitle: "Generate Valid and Invalid Identification Numbers" +metadesc: "The IdNumber function in data generators allows you to simulate US standard identification numbers, including valid SSNs, validSvSeSSn and unique formats." +noindex: false +order: 5.38 +page_id: "idnumber-function-type" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Selecting IdNumber as a Function Type for Data Generator" + url: "#selecting-idnumber-as-a-function-type-for-data-generator" +- type: link + name: "Valid" + url: "#valid" +- type: link + name: "Invalid" + url: "#invalid" +- type: link + name: "SSN Valid" + url: "#ssn-valid" +- type: link + name: "Valid SvSe SSN" + url: "#valid-svse-ssn" +- type: link + name: "Invalid SvSe SSN" + url: "#invalid-svse-ssn" +--- + +--- + +You can generate and manage various file-related data. This functionality is useful for handling files with specific attributes like file extensions, MIME types, and file names. Creating diverse file data for different applications can make file-handling tasks more efficient and organized. + +--- + +## **Prerequisites** + +Before utilising the different data generator functions, it's essential to understand basic concepts such as creating [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#create-test-case) and [Test Steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/) and [adding data generators](https://testsigma.com/docs/test-data/types/data-generator/#add-data-generators-in-test-steps) in test steps. + +--- + +## **Selecting IdNumber as a Function Type for Data Generator** + +1. Use **NLP** to create a **new step** in the test case and include a placeholder for **test data**. +2. Click on the **test data** placeholder. From the **Test Data Types** dropdown menu, select the **! Data Generator** option. +3. On the **! Data Generators** overlay screen, select the **Type** to **Default**. This will enable you to use a collection of built-in test data generators. +4. Select **IdNumber** from the **Function Type** dropdown list. ![select datefunctions function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/idnumber_functiontype_dg.gif) + +[[info | NOTE:]] +| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. + +--- + +## **Valid** + +- Enables you to generate a valid identification number that adheres to specified formats and validation rules. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Invalid** + +- Allows you to generate an invalid identification number that does not conform to standard formats or validation rules. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **SSN Valid** + +- Enables you to generate a valid SSN format that meets the criteria for a valid social security number. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Valid SvSe SSN** + +- Allows you to generate a valid Swedish SSN according to specific validation rules for Sweden. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Invalid SvSe SSN** + +- Enables you to generate an invalid Swedish SSN that does not conform to valid formats or rules. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + + diff --git a/src/pages/docs/test-data/data-generators/name-function-type.md b/src/pages/docs/test-data/data-generators/name-function-type.md index a8b06368..6cafdc84 100644 --- a/src/pages/docs/test-data/data-generators/name-function-type.md +++ b/src/pages/docs/test-data/data-generators/name-function-type.md @@ -1,10 +1,10 @@ --- -title: "Name Function Type for Data Generator" -pagetitle: "Generate Realistic Names with Data Generator Functions" -metadesc: "Explore how the Name function in data generators generates random names for testing and simulations, including first and last names." +title: "Name Function Type" +pagetitle: "Generate Random Names Easily with Data Generators" +metadesc: "Name function in Testsigma data generators allows you to create realistic random names effortlessly. Learn how to use Name and its functions in Testsigma." noindex: false order: 5.33 -page_id: "name-function-type-for-data-generator" +page_id: "name-function-type" warning: false contextual_links: - type: section @@ -40,13 +40,13 @@ contextual_links: name: "Title" url: "#title" - type: link - name: "User Name" - url: "#user-name" + name: "Username" + url: "#username" --- --- -Name function type within data generators offers a variety of functions designed to generate random names. These include first names, middle names, last names, prefixes, suffixes, titles, and usernames. The Name Function in data generators is invaluable for generating realistic names for testing scenarios, simulations, or database populations. This document outlines the various functions available within the Name function type of data generators. +The Name Function within data generators offers a variety of functions designed to generate random names. These functions include first names, middle names, last names, prefixes, suffixes, titles, and usernames. The Name Function in data generators is invaluable for generating realistic names for testing scenarios, simulations, or database populations. This document outlines the various functions available within the Name Function type of data generators. --- @@ -70,7 +70,7 @@ Before utilising the different data generator functions, it's essential to under ## **Name** -This enables you to generate a random first and last name. Use this for scenarios requiring full names, such as creating user profiles or database test data. +- Enables you to generate random first and last names. Use it to create user profiles or generate names for forms. + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
InputOutput
username length: 10johnsmith1
username length: 6sarah5
username length: 10sarahglenn
username length: 6robert
+
+ +--- + +## **Random Apha Numeric Email** + +- Enables you to generate a random alphanumeric email address with a specified username length. This is ideal for generating unique email addresses for temporary registrations or testing environments. + + + +
+
+ ℹ️ Example: +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
InputOutput
username length: 8abc12345@example.com
username length: 12xyz67890abcd@example.com
username length: 10pqrs9876@example.com
username length: 6mno345@example.com
+
+ +--- + +## **Random Apha Numeric Email with Domain** + +- Allows you to generate a random alphanumeric email address with a specified username length and domain. This is suitable for creating email addresses with specific domains for internal systems or controlled environments. + + + +
+
+ ℹ️ Example: +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
InputOutput
username length: 10,
Domain: mydomain.com
user1234ab@mydomain.com
username length: 8,
Domain: example.org
test5678@example.org
username length: 12,
Domain: mail.com
alpha890beta@mail.com
username length: 6,
Domain: customdomain.com
abc456@customdomain.com
+
+ +--- + +## **Random Email with Domain** + +- Enables you to generate a random email address with a specified username length and domain. This is useful for generating realistic email addresses for customer databases or user profiles with specified domains. + + + +
+
+ ℹ️ Example: +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
InputOutput
username length: 6,
Domain: sample.com
user12@sample.com
username length: 8,
Domain: example.com
test4567@example.com
username length: 10,
Domain: domain.org
randomuser@domain.org
username length: 7,
Domain: mail.net
abc1234@mail.net
+
+ +--- + +## **Random Email** + +- Allows you to generate a random email address with a specified username length. This is useful for general purposes, ensuring uniqueness and randomness in email addresses. + + + +
+
+ ℹ️ Example: +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
InputOutput
username length: 12randomuser@domain.com
username length: 10sampleuser@domain.com
username length: 8testuser@domain.com
username length: 6user01@domain.com
+
+ +--- + + diff --git a/src/pages/docs/test-data/data-generators/internet-function-type.md b/src/pages/docs/test-data/data-generators/internet-function-type.md new file mode 100644 index 00000000..13d1fbf7 --- /dev/null +++ b/src/pages/docs/test-data/data-generators/internet-function-type.md @@ -0,0 +1,599 @@ +--- +title: "Internet Function Type" +pagetitle: "Internet Function for Generating Domain Names and Emails" +metadesc: "Learn how the Internet Function Type generates domain names, email addresses, URLs, and images for various testing scenarios with practical examples." +noindex: false +order: 5.40 +page_id: "internet-function-type" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Selecting Internet as a Function Type for Data Generator" + url: "#selecting-internet-as-a-function-type-for-data-generator" +- type: link + name: "Domain Name" + url: "#domain-name" +- type: link + name: "Domain Word" + url: "#domain-word" +- type: link + name: "Domain Suffix" + url: "#domain-suffix" +- type: link + name: "Email Address" + url: "#email-address" +- type: link + name: "Email Address with Input Username" + url: "#email-address-with-input-username" +- type: link + name: "Safe Email Address" + url: "#safe-email-address" +- type: link + name: "Safe Email Address with Input Username" + url: "#safe-email-address-with-input-username" +- type: link + name: "URL" + url: "#url" +- type: link + name: "Image" + url: "#image" +- type: link + name: "Password" + url: "#password" +- type: link + name: "UUID" + url: "#uuid" +--- + +--- + +The Internet Function Type and Function for Data Generators offer various functionalities to generate Internet-related data. These functions facilitate the creation of domain names, email addresses, URLs, and images, allowing users to simulate real-world scenarios. + +--- + +## **Prerequisites** + +Before utilising the different data generator functions, it's essential to understand basic concepts such as creating [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#create-test-case) and [Test Steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/) and [adding data generators](https://testsigma.com/docs/test-data/types/data-generator/#add-data-generators-in-test-steps) in test steps. + +--- + +## **Selecting Internet as a Function Type for Data Generator** + +1. Use **NLP** to create a **new step** in the test case and include a placeholder for **test data**. +2. Click on the **test data** placeholder. From the **Test Data Types** dropdown menu, select the **! Data Generator** option. +3. On the **! Data Generators** overlay screen, select the **Type** to **Default**. This will enable you to use a collection of built-in test data generators. +4. Select **Internet** from the **Function Type** dropdown list. ![select internet function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/internet_functiontype_dg.gif) + +[[info | NOTE:]] +| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. + +--- + +## **Domain Name** + +- Enables you to generate random domain names using it. It is useful for testing web applications that require domain names, such as creating sample websites or testing domain-related functionalities. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Domain Word** + +- Allows you to create a random word that can be used as a domain name. It is useful for generating unique and meaningful names for websites or services. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Domain Suffix** + +- Enables you to generate random domain suffixes. This is useful for testing purposes when you need different domain suffixes, such as .com, .org, .net. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Email Address** + +- Allows you to generate random email addresses. It is useful for testing email-related functionalities in applications, such as sending confirmation emails or user notifications. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Email Address with Input Username** + +- Enables you to create an email address using a specific username, which is useful for testing the username with various email domains. + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputOutput
username: john.doejohn.doe@example.com
username: jane.smithjane.smith@mywebsite.org
username: sarah.glennsarah.glenn@business.net
username: robert.drobert.d@shoponline.co
+
+ +--- + +## **Safe Email Address** + +- Allows you to generate safe email addresses, ensuring no personal or sensitive information is used. This is useful for privacy-conscious testing where personal data should not be used. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Safe Email Address with Input Username** + +- Enables you to create a safe email address by using a specific username, ensuring that no personal or sensitive information is used. It is beneficial for generating non-sensitive email addresses for specific users in privacy-sensitive applications. + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
InputOutput
username: supportsupport@safeonline.co
username: contactcontact@safe-mail.com
username: customer.servicecustomer.service@business.net
username: adminadmin@shoponline.co
+
+ +--- + +## **Image** + +- Enables you to generate random image URLs. It is useful for testing image-loading functionalities in web applications, such as galleries or image hosting services. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Password** + +- Allows you to generate random passwords with specified parameters. It is useful for creating secure passwords for user accounts, testing login functionalities, and ensuring password strength. + + + +
+
+ ℹ️Example: +
+ +
+ + +--- + +## **UUID** + +- Enables you to generate universally unique identifiers (UUIDs) based on specified versions. This is useful for creating unique identifiers for records in databases, tracking entities, and ensuring global uniqueness. + + + +
+
+ ℹ️Example: +
+ +
+ + +--- + + diff --git a/src/pages/docs/test-data/data-generators/mailboxfunctions-function-type.md b/src/pages/docs/test-data/data-generators/mailboxfunctions-function-type.md new file mode 100644 index 00000000..64f5468f --- /dev/null +++ b/src/pages/docs/test-data/data-generators/mailboxfunctions-function-type.md @@ -0,0 +1,898 @@ +--- +title: "MailboxFunctions Function Type" +pagetitle: "Generate and Manage Email Addresses with EmailFunctions" +metadesc: "EmailFunctions function type allows you to create various email addresses with ease. Learn to generate usernames, random emails, and domain-specific emails." +noindex: false +order: 5.42 +page_id: "mailboxfunctions-function-type" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Selecting MailboxFunctions as a Function Type for Data Generator" + url: "#selecting-mailboxfunctions-as-a-function-type-for-data-generator" +- type: link + name: "Get Email OTP" + url: "#get-email-otp" +- type: link + name: "Get Link from Content" + url: "#get-link-from-content" +- type: link + name: "Subject Verification" + url: "#subject-verification" +- type: link + name: "Content Verification" + url: "#content-verification" +- type: link + name: "Get Email Content" + url: "#get-email-content" +- type: link + name: "Get Email Subject" + url: "#get-email-subject" +- type: link + name: "Get URL with Text" + url: "#get-url-with-text" +- type: link + name: "URL which contains" + url: "#url-which-contains" +- type: link + name: "URL matching Regex" + url: "#url-matching-regex" +- type: link + name: "Get Sender Email" + url: "#get-sender-email" +- type: link + name: "Get Sender Name" + url: "#get-sender-name" +--- + +--- + +Testsigma's MailBoxFunctions enables you to interact with email functionalities programmatically. This function type lets you perform various operations related to email content, subject, URLs, and verification through specified mailbox configurations. + +--- + +## **Prerequisites** + +Before utilising the different data generator functions, it's essential to understand basic concepts such as creating [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#create-test-case) and [Test Steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/) and [adding data generators](https://testsigma.com/docs/test-data/types/data-generator/#add-data-generators-in-test-steps) in test steps. Additionally, familiarize yourself with [MailBoxFunctions](https://testsigma.com/docs/test-data/types/mailbox/) for accessing and manipulating email content and metadata + +--- + +## **Selecting MailboxFunctions as a Function Type for Data Generator** + +1. Use **NLP** to create a **new step** in the test case and include a placeholder for **test data**. +2. Click on the **test data** placeholder. From the **Test Data Types** dropdown menu, select the **! Data Generator** option. +3. On the **! Data Generators** overlay screen, select the **Type** to **Default**. This will enable you to use a collection of built-in test data generators. +4. Select **MailboxFunctions** from the **Function Type** dropdown list. ![select number function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/mailboxfuntions_functiontype_dg.gif) + +[[info | NOTE:]] +| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. + +--- + +## **Get Email OTP** + +- Enables you to retrieve OTP emails that match a specified regular expression from the configured mailbox within a defined timeout. + + + +
+
+ ℹ️Examples: +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
InputOutput
Regex: \d{4},
Select MailBox,
Timeout: 60
1234
Regex: \d{6},
Select MailBox,
Timeout: 120
987654
Regex: \d{5},
Select MailBox,
Timeout: 90
54321
Regex: \d{4,6},
Select MailBox,
Timeout: 180
1234, 56789, 456789
+
+ + +--- + +## **Get Link from Content** + +- Allows you to extract URLs from email content using a provided regular expression within the specified mailbox and timeout duration. + + + +
+
+ ℹ️Examples: +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
InputOutput
Regex: \bhttps:\/\/example\.com\b,
Select MailBox,
Timeout: 60
https://example.com
Regex: \bhttp:\/\/test\.com\/\w+,
select MailBox,
Timeout: 120
http://test.com/12345
Regex: \bhttps:\/\/www\.website\.com\/\w+,
Select MailBox,
Timeout: 90
https://www.website.com/page123
Regex: \bhttps:\/\/\w+\.com\/\w+,
Select MailBox,
Timeout: 180
https://example.com/page1, https://test.com/12345, https://anotherwebsite.com/home
+
+ + +--- + +## **Subject Verification** + +- Enables you to verify if email subjects match a given regular expression within the configured mailbox and timeout period. + + + +
+
+ ℹ️Examples: +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
InputOutput
Regex: \bSubject: Order #[0-9]+\b,
Select MailBox,
Compare String: Subject: Order #12345,
Timeout: 60 seconds
true
Regex: \bSubject: OTP - [0-9]{4}\b,
Select MailBox,
Compare String: Subject: OTP - 5678,
Timeout: 120 seconds
true
Regex: \bSubject: Invitation to event\b,
Select MailBox,
Compare String: Subject: Invitation to event,
Timeout: 90 seconds
true
Regex: \bSubject: Verification Code: [0-9]{6}\b,
Select MailBox,
Compare String: Subject: Verification Code: 123456,
Timeout: 180 seconds
true
+
+ +--- + +## **Content Verification** + +- Allows you to validate if email content matches a specified regular expression within the selected mailbox and timeout duration. + + + +
+
+ ℹ️Examples for contentVerification Function: +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
InputOutput
Regex: \bOrder #[0-9]+\b,
Select MailBox,
Compare String: Order #12345,
Timeout: 60
true
Regex: \bOTP - [0-9]{4}\b,
Select MailBox,
Compare String: OTP - 5678,
Timeout: 120
true
Regex: \bInvitation to event\b,
Select MailBox,
Compare String: Invitation to event,
Timeout: 90
true
Regex: \bVerification Code: [0-9]{6}\b,
Select MailBox,
Compare String: Verification Code: 123456,
Timeout: 180
true
+
+ + +--- + +## **Get Email Content** + +- Enables you to retrieve the content of the latest email in the configured mailbox within the specified timeout. + + + +
+
+ ℹ️Examples for getEmailContent Function: +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
InputOutput
Select MailBox
Timeout: 60
Email content from MailBox
Select MailBox
Timeout: 120
Email content from MailBox
Select MailBox
Timeout: 90
Email content from MailBox
Select MailBox
Timeout: 180
Email content from MailBox
+
+ + +--- + +## **Get Email Subject** + +- Allows you to fetch the subject line of the latest email from the specified mailbox within the given timeout. + + + +
+
+ ℹ️Examples: +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
InputOutput
Select MailBox
Timeout: 60
Email subject from MailBox
Select MailBox
Timeout: 120
Email subject from MailBox
Select MailBox
Timeout: 90
Email subject from MailBox
Select MailBox
Timeout: 180
Email subject from MailBox
+
+ +--- + +## **Get Url with Text** + +- Enables you to retrieve URLs containing a specified text from emails in the configured mailbox within the timeout period. + + + +
+
+ ℹ️Examples for getUrlWithText Function: +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
InputOutput
Text: "Click here for more info",
Select MailBox,
Timeout: 60
URL linked to "Click here for more info" from MailBox
Text: "Visit our website",
Select MailBox,
Timeout: 120
URL linked to "Visit our website" from MailBox
Text: "Check out the new products",
Select MailBox,
Timeout: 90
URL linked to "Check out the new products" from MailBox
Text: "Click here or here for updates",
Select MailBox,
Timeout: 180
URLs linked to "Click here or here for updates" from MailBox
+
+ + +--- + +## **URL which contains** + +- Allows you to fetch URLs that include a provided substring from emails in the selected mailbox within the timeout. + + + +
+
+ ℹ️Examples for getUrlContains Function: +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
InputOutput
Substring: "more info",
Select MailBox,
Timeout: 60
URLs containing "more info" MailBox
Substring: "website",
Select MailBox,
Timeout: 120
URLs containing "website" from MailBox
Substring: "products",
Select MailBox,
Timeout: 90
URLs containing "products" from MailBox
Substring: "updates",
Select MailBox,
Timeout: 180
URLs containing "updates" from MailBox
+
+ + +--- + +## **URL matching regex** + +- Enables you to retrieve URLs matching a specified regular expression pattern from emails in the configured mailbox within the timeout period. + + + +
+
+ ℹ️Examples for getUrlContains Function: +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
InputOutput
Regex: \d{4},
Select MailBox,
Timeout: 60
URLs containing numbers (e.g., 1234) from MailBox within 60
Regex: \w{6},
Select MailBox,
Timeout: 120
URLs containing alphanumeric strings (e.g., abc123) from MailBox within 120
Regex: https?,
Select MailBox,
Timeout: 90
URLs starting with "http" or "https" from MailBox within 90
Regex: \.com$,
Select MailBox,
Timeout: 180
URLs ending with ".com" from MailBox within 180
+
+ +--- + +## **Get Sender Email** + +- Allows you to retrieve the email address of the sender from an email message by using it to extract the sender email address from the latest email in the inbox. + + + +
+
+ ℹ️Examples: +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
InputOutput
Select MailBoxFunctions,
Timeout: 60 seconds
sender1@example.com
Select MailBoxFunctions,
Timeout: 120 seconds
sender2@example.com
Select MailBoxFunctions,
Timeout: 90 seconds
sender3@example.com
Select MailBoxFunctions,
Timeout: 180 seconds
sender4@example.com
+
+ +--- + +## **Get Sender Name** + +- Enables you to fetch the name of the sender from an email message. Identify the name of the sender from the most recent email. + + + +
+
+ ℹ️Examples: +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
InputOutput
Select MailBoxFunctions,
Timeout: 60 seconds
John Doe
Select MailBoxFunctions,
Timeout: 120 seconds
Jane Smith
Select MailBoxFunctions,
Timeout: 90 seconds
Alice Johnson
Select MailBoxFunctions,
Timeout: 180 seconds
Bob Brown
+
+ + +--- + + + diff --git a/src/pages/docs/test-data/data-generators/number-function-type.md b/src/pages/docs/test-data/data-generators/number-function-type.md new file mode 100644 index 00000000..eb012270 --- /dev/null +++ b/src/pages/docs/test-data/data-generators/number-function-type.md @@ -0,0 +1,564 @@ +--- +title: "Number Function Type" +pagetitle: "Generate Random Numbers and Digits | Data Generator Function" +metadesc: "Explore efficient data generator functions for seamlessly creating random numbers, digits, and decimals in diverse applications and scenarios." +noindex: false +order: 5.41 +page_id: "number-function-type" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Selecting Number as a Function Type for Data Generator" + url: "#selecting-number-as-a-function-type-for-data-generator" +- type: link + name: "Random Number" + url: "#random-number" +- type: link + name: "Random Digit" + url: "#random-digit" +- type: link + name: "Random Digit Not Zero" + url: "#random-digit-not-zero" +- type: link + name: "Number of Digits" + url: "#number-of-digits" +- type: link + name: "Random Number" + url: "#random-number" +- type: link + name: "Random Double" + url: "#random-double" +- type: link + name: "Digits" + url: "#digits" +- type: link + name: "Digit" + url: "#digit" +--- + +--- + +The Number Function Type allows you to generate various types of random numbers. These functions help in creating data for different scenarios where random numerical values are required. + +--- + +## **Prerequisites** + +Before utilising the different data generator functions, it's essential to understand basic concepts such as creating [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#create-test-case) and [Test Steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/) and [adding data generators](https://testsigma.com/docs/test-data/types/data-generator/#add-data-generators-in-test-steps) in test steps. + +--- + +## **Selecting Number as a Function Type for Data Generator** + +1. Use **NLP** to create a **new step** in the test case and include a placeholder for **test data**. +2. Click on the **test data** placeholder. From the **Test Data Types** dropdown menu, select the **! Data Generator** option. +3. On the **! Data Generators** overlay screen, select the **Type** to **Default**. This will enable you to use a collection of built-in test data generators. +4. Select **Number** from the **Function Type** dropdown list. ![select number function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/number_functiontype_dg.gif) + +[[info | NOTE:]] +| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. + +--- + +## **Random Number** + +- Enables you to generate a random number between a specified range. It is useful for creating random data samples within a specific numeric range. + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
InputOutput
min: 1, max: 10073
min: 10, max: 5032
min: 100, max: 500418
min: 5, max: 2015
+
+ +--- + +## **Random Digit** + +- Allows you to generate a random digit between 0 and 9. This is helpful for scenarios where single-digit numbers are required, like generating a random OTP. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Random Digit Not Zero** + +- Enables you to generate a random digit between 1 and 9. This is useful for cases where zero is not a valid digit, such as generating unique identification codes. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Number of Digits** + +- Allows you to generate a number with a specified number of digits. This is useful for generating identification numbers or codes of a fixed length. + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
InputOutput
Digits: 5, Boolean: True39485
Digits: 4, Boolean: False-3276
Digits: 3, Boolean: True821
Digits: 6, Boolean: False-491257
+
+ +--- + +## **Random Number** + +- Enables you to generate a random number without specifying any range. It is useful for generating random numerical data without any constraints. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Random Double** + +- Allows you to generate a random decimal number within a specified range and with a specified number of decimal places. This is useful for scenarios requiring floating-point numbers, such as price or measurement data. + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
InputOutput
Max No of Decimals: 2, Min: 1.5, Max: 5.53.47
Max No of Decimals: 3, Min: 10.1, Max: 20.515.234
Max No of Decimals: 1, Min: 100.0, Max: 200.0145.7
Max No of Decimals: 4, Min: 0.1, Max: 1.00.7564
+
+ +--- + +## **Digits** + +- Enables you to generate a random number with a specified count of digits, which is useful for creating data where numbers of a specific digit length are required, like serial numbers. + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
InputOutput
Count: 3593
Count: 548291
Count: 247
Count: 6384719
+
+ +--- + +## **Digit** + +- Allows you to generate a random number with a fixed length using this feature, which is useful for generating small, single-digit random numbers. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + + From 1193eaccfe0889afb88203117a78f91ecd77de8e Mon Sep 17 00:00:00 2001 From: Bharath Krishna <118433150+bharathk08@users.noreply.github.com> Date: Thu, 18 Jul 2024 16:51:52 +0530 Subject: [PATCH 3/7] Testsigma Copilot Documents (#452) Added initial docs for Testsigma Copilot as subsections to existing page. --- .../bulk-actions.md | 14 ++--- .../step-options.md | 10 ++-- .../step-settings.md | 17 +++--- .../test-cases/create-test-steps/overview.md | 59 +++++++++++++++++++ .../docs/test-cases/manage/add-edit-delete.md | 10 ++-- .../docs/test-cases/manage/import-export.md | 5 +- .../manage/import-from-yaml-or-git.md | 6 +- .../manage/import-postman-to-testsigma.md | 6 +- .../docs/test-cases/manage/list-actions.md | 1 + 9 files changed, 95 insertions(+), 33 deletions(-) diff --git a/src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/bulk-actions.md b/src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/bulk-actions.md index 33df457f..0e5b807c 100644 --- a/src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/bulk-actions.md +++ b/src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/bulk-actions.md @@ -23,13 +23,13 @@ Using Bulk Actions in Testsigma simplifies managing multiple test steps. You can --- -## **Prerequisites** - -- You should know about [projects](https://testsigma.com/docs/projects/overview/) in Testsigma. - -- You should know how to [manage a test case](https://testsigma.com/docs/test-cases/manage/add-edit-delete/). - -- You should know how to [manage test steps](https://testsigma.com/docs/test-cases/step-types/natural-language/). +> ## **Prerequisites** +> +> - You should know about [Projects](https://testsigma.com/docs/projects/overview/) in Testsigma. +> +> - You should know how to [manage a Test Case](https://testsigma.com/docs/test-cases/manage/add-edit-delete/). +> +> - You should know how to [manage Test Steps](https://testsigma.com/docs/test-cases/step-types/natural-language/). --- diff --git a/src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/step-options.md b/src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/step-options.md index b0492c57..15f64aff 100644 --- a/src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/step-options.md +++ b/src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/step-options.md @@ -1,6 +1,6 @@ --- title: "Test Step Options" -page_title: "Test Step Options | Testsigma Documentation" +page_title: "Test Step Options" metadesc: "Explore Testsigma's Test Step Options - Configure, manage, and optimise your test steps efficiently. Enhance testing workflow with customisation and control." noindex: false order: 4.611 @@ -47,10 +47,12 @@ In Testsigma, you can customize test steps within a test case using test step op --- -## **Prerequesties** - -- You should know how to create **test steps** and [manage a test case](https://testsigma.com/docs/test-cases/manage/add-edit-delete/). +> ## **Prerequisites** +> +> - You should know how to [manage a Test Case](https://testsigma.com/docs/test-cases/manage/add-edit-delete/). +> +> - You should know how to [manage Test Steps](https://testsigma.com/docs/test-cases/step-types/natural-language/). --- diff --git a/src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/step-settings.md b/src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/step-settings.md index 4465edf5..f23cec4f 100644 --- a/src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/step-settings.md +++ b/src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/step-settings.md @@ -1,6 +1,6 @@ --- title: "Test Step Settings for Test Cases" -page_title: "Test Step Settings | Testsigma Documentation" +page_title: "Test Step Settings" metadesc: "Configure wait times, retries, visuals, and other settings for efficient test automation in Testsigma using Test Step Settings and customise test execution." noindex: false order: 4.612 @@ -26,14 +26,13 @@ Controlling the behavior of each test step can be important to enhance your test --- -## **Prerequisites** - - -- You should know about [projects](https://testsigma.com/docs/projects/overview/) in Testsigma. - -- You should know how to [manage a test case](https://testsigma.com/docs/test-cases/manage/add-edit-delete/). - -- You should know how to [manage test steps](https://testsigma.com/docs/test-cases/step-types/natural-language/). +> ## **Prerequisites** +> +> - You should know about [Projects](https://testsigma.com/docs/projects/overview/) in Testsigma. +> +> - You should know how to [manage a Test Case](https://testsigma.com/docs/test-cases/manage/add-edit-delete/). +> +> - You should know how to [manage Test Steps](https://testsigma.com/docs/test-cases/step-types/natural-language/). --- diff --git a/src/pages/docs/test-cases/create-test-steps/overview.md b/src/pages/docs/test-cases/create-test-steps/overview.md index e0e7471e..213473d2 100644 --- a/src/pages/docs/test-cases/create-test-steps/overview.md +++ b/src/pages/docs/test-cases/create-test-steps/overview.md @@ -17,6 +17,15 @@ contextual_links: - type: link name: "Creating Test Steps Using Test Recorder" url: "#creating-test-steps-using-test-recorder" +- type: link + name: "AI Test Automation with Testsigma Copilot" + url: "#ai-test-automation-with-testsigma-copilot-" +- type: link + name: "Generate Test Scenarios" + url: "#generate-test-scenarios" +- type: link + name: "Generate Test Steps with Prompts" + url: "#generate-test-steps-with-prompts" --- --- @@ -170,4 +179,54 @@ Here's a sample GIF demonstrating creating test steps using the recorder for a W ![Record Test Steps for WebApps](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/RecordStepswappsWF.gif) +--- + +--- + +## **AI Test Automation with Testsigma Copilot 🚀** + +Testsigma Copilot redefines test automation with the power of generative AI. + +- You can effortlessly create diverse test scenarios with a single click. +- Generate detailed test steps that accurately mimic real-world user behavior with the right UI elements and complex user interactions. +- Create a comprehensive test case using simple prompts. + +Boost your test automation and deliver high-quality software with Testsigma Copilot 🤖. + +--- + +## **Generate Test Scenarios** + +1. From the left-side navbar, select **Create Tests > Test Cases** and then click **Create Test Case**. + +2. On the **Test Case Details** page, enter a name for the test case and click **Record** in the top-right corner. A new window will open. + +3. In the opened window, input the URL of the web page from which you want to generate test scenarios. The **Testsigma Recorder** will activate and prepare for recording. + +4. Click **Generate Scenarios** in the Testsigma Recorder. The Testsigma Copilot will start generating test scenarios based on the current page content. + +5. Wait until the test scenarios are generated. + +6. Click on any generated test case scenario to view its corresponding test steps. + +7. Click **Save Test Steps** to import the displayed test steps into the recorder. + +8. Modify the test steps as per the desired test case behavior. Once the necessary modifications are done, click **Stop** to return to the test case details page. + +--- + +## **Generate Test Steps with Prompts** + +Follow the steps from 1-3 from the above section. + +4. Click **Write Prompt** in the Testsigma Recorder. + +5. Enter a prompt with accurate details and click **Generate**. + +6. Wait until the test steps are generated. + +7. Click **Save Test Steps** to import the displayed test steps into the recorder. + +8. Modify the test steps as per the desired test case behavior. Once the necessary modifications are done, click **Stop** to return to the test case details page. + --- \ No newline at end of file diff --git a/src/pages/docs/test-cases/manage/add-edit-delete.md b/src/pages/docs/test-cases/manage/add-edit-delete.md index 68f87d31..fd4afd6c 100644 --- a/src/pages/docs/test-cases/manage/add-edit-delete.md +++ b/src/pages/docs/test-cases/manage/add-edit-delete.md @@ -27,7 +27,6 @@ contextual_links: - type: link name: "Recover Deleted Test Case" url: "#recover-deleted-test-case" - --- --- @@ -36,9 +35,9 @@ Testsigma provides a comprehensive and user-friendly solution for efficiently cr --- -## **Prerequisites** - -- Ensure you create a [project](https://testsigma.com/docs/projects/overview/) before creating test cases in Testsigma. +> ## **Prerequisites** +> +> Ensure you create a [Project](https://testsigma.com/docs/projects/overview/) before creating Test Cases in Testsigma. --- @@ -136,4 +135,5 @@ Use the right-side navbar on the **Test Case Details** page to access Advanced O [[info | NOTE:]] | Deleting the test case permanently will result in losing all Run reports and associated configurations. ---- + +--- \ No newline at end of file diff --git a/src/pages/docs/test-cases/manage/import-export.md b/src/pages/docs/test-cases/manage/import-export.md index 0807c09b..79c9797f 100644 --- a/src/pages/docs/test-cases/manage/import-export.md +++ b/src/pages/docs/test-cases/manage/import-export.md @@ -28,8 +28,9 @@ You can easily use test case import and export to populate a new Testsigma proje --- -## **Prerequisites** -- You should know how to [manage projects](https://testsigma.com/docs/projects/overview/). +> ## **Prerequisites** +> +> - You should know how to [Manage Projects](https://testsigma.com/docs/projects/overview/). --- diff --git a/src/pages/docs/test-cases/manage/import-from-yaml-or-git.md b/src/pages/docs/test-cases/manage/import-from-yaml-or-git.md index 6eb6dc0b..3eb5fff7 100644 --- a/src/pages/docs/test-cases/manage/import-from-yaml-or-git.md +++ b/src/pages/docs/test-cases/manage/import-from-yaml-or-git.md @@ -23,9 +23,9 @@ You will understand how to import projects from Test Project using YAML/GIT and --- -## **Prerequisites** - -Before using the import from Test Project in Testsigma, ensure that you are familiar with exporting the Test Project file as a YAML/Zip of the project or a GitHub repository for your project. +> ## **Prerequisites** +> +> Before using the import from Test Project in Testsigma, ensure that you are familiar with exporting the Test Project file as a YAML/Zip of the project or a GitHub repository for your project. --- diff --git a/src/pages/docs/test-cases/manage/import-postman-to-testsigma.md b/src/pages/docs/test-cases/manage/import-postman-to-testsigma.md index 0a790645..5f8c9cc8 100644 --- a/src/pages/docs/test-cases/manage/import-postman-to-testsigma.md +++ b/src/pages/docs/test-cases/manage/import-postman-to-testsigma.md @@ -29,9 +29,9 @@ Testsigma simplifies API test case migration by seamlessly importing Collections --- -## **Prerequisites** - -Before using the import of Postman Collections and Environments in Testsigma, ensure that you are familiar with exporting Postman [Collections](https://learning.postman.com/docs/getting-started/importing-and-exporting/exporting-data/#export-collections), [Environments](https://learning.postman.com/docs/getting-started/importing-and-exporting/exporting-data/#export-environments), and [Data Dumps](https://learning.postman.com/docs/getting-started/importing-and-exporting/exporting-data/#export-data-dumps) and understand the [Mapping Format](https://testsigma.com/docs/test-cases/manage/import-postman-to-testsigma/#mapping-format-for-postman-collection-and-environment) for Importing Postman Collections. +> ## **Prerequisites** +> +> Before using the import of Postman Collections and Environments in Testsigma, ensure that you are familiar with exporting Postman [Collections](https://learning.postman.com/docs/getting-started/importing-and-exporting/exporting-data/#export-collections), [Environments](https://learning.postman.com/docs/getting-started/importing-and-exporting/exporting-data/#export-environments), and [Data Dumps](https://learning.postman.com/docs/getting-started/importing-and-exporting/exporting-data/#export-data-dumps) and understand the [Mapping Format](https://testsigma.com/docs/test-cases/manage/import-postman-to-testsigma/#mapping-format-for-postman-collection-and-environment) for Importing Postman Collections. --- diff --git a/src/pages/docs/test-cases/manage/list-actions.md b/src/pages/docs/test-cases/manage/list-actions.md index d20a5e58..d098fdcf 100644 --- a/src/pages/docs/test-cases/manage/list-actions.md +++ b/src/pages/docs/test-cases/manage/list-actions.md @@ -34,6 +34,7 @@ contextual_links: You can efficiently manage and organise your test cases in Testsigma through the Test Case List Actions. The Test Case List Actions allows you to easily search, sort, filter, and save your test cases. --- + ## **Search Test Cases** Click inside the **Search** bar in the top right corner of the **Test Case List** page and type the name of the Test Case you want to find. As you type, Testsigma will show you matching test cases. View the test case you want by clicking on it in the search results ![Search-Test-Cases](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/search_testcases.gif) From ac1be28a616091878c22bd4a1cdb994b39b2bac0 Mon Sep 17 00:00:00 2001 From: Sangith Ravichandran <119392848+sangithravichandran@users.noreply.github.com> Date: Fri, 19 Jul 2024 12:47:06 +0530 Subject: [PATCH 4/7] Added MailBoxAlias, String, Friends and Date Functions Document (#453) --- .../data-generators/address-function-type.md | 4 +- .../data-generators/company-function-type.md | 2 +- .../datefunctions-function-type.md | 800 ++++++++++++++++++ .../emailfunctions-function-type.md | 40 +- .../data-generators/friends-function-type.md | 145 ++++ .../mailboxaliasfunctions-function-type.md | 675 +++++++++++++++ .../mailboxfunctions-function-type.md | 94 +- .../stringfunctions-function-type.md | 184 ++++ .../testdatafromprofile-function-type.md | 164 ++++ 9 files changed, 2038 insertions(+), 70 deletions(-) create mode 100644 src/pages/docs/test-data/data-generators/datefunctions-function-type.md create mode 100644 src/pages/docs/test-data/data-generators/friends-function-type.md create mode 100644 src/pages/docs/test-data/data-generators/mailboxaliasfunctions-function-type.md create mode 100644 src/pages/docs/test-data/data-generators/stringfunctions-function-type.md create mode 100644 src/pages/docs/test-data/data-generators/testdatafromprofile-function-type.md diff --git a/src/pages/docs/test-data/data-generators/address-function-type.md b/src/pages/docs/test-data/data-generators/address-function-type.md index 18a01c4f..ca902b1e 100644 --- a/src/pages/docs/test-data/data-generators/address-function-type.md +++ b/src/pages/docs/test-data/data-generators/address-function-type.md @@ -79,7 +79,7 @@ contextual_links: --- -The Address Function Type provides various functions that generate realistic and varied address components. These functions help in creating complete and detailed addresses, which are crucial for ensuring the proper handling of various address formats and elements in different applications. Each function focuses on a specific address part, allowing for the creation of comprehensive and authentic address data for diverse purposes. +Address functions generate various components of address data, such as street names, city names, and postal codes. These functions help create realistic and comprehensive address information for testing and data simulation purposes. You can generate complete addresses or individual elements like building numbers and ZIP codes. --- @@ -1003,7 +1003,7 @@ Before utilising the different data generator functions, it's essential to under ## **Building Number** -- Allows you to generate random building numbers. It provides numeric identifiers for buildings or addresses in applications that require specific location details. +- Allows you to generates a random building number for address data and ensures that the generated addresses include a realistic building number. + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + +
InputsOutputs
At most: 30,
Unit: DAYS,
Format: 'dd/MM/yyyy'
15/08/2024
At most: 60,
Unit: DAYS,
Format: 'dd/MM/yyyy'
08/09/2024
At most: 90,
Unit: DAYS,
Format: 'dd/MM/yyyy'
14/10/2024
At most: 30,
Unit: DAYS,
Format: 'dd/MM/yyyy'/td> +
09/08/2024
+
+ +--- + +## **Future** + +- Enables you to generate dates up to a specified number of days in the future from today's date. +- Generate dates for future events or reminders without specifying a reference date, making it ideal. + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
At most: 30,
Unit: DAYS,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'
15/08/2024
At most: 60,
Unit: DAYS,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'
08/09/2024
At most: 90,
Unit: DAYS,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'
14/10/2024
At most: 30,
Unit: DAYS,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'
09/08/2024
+
+ +--- + +## **Current** + +- Allows you to generate today's date in the specified format. +- This is useful when timestamping, or a specific format requires today's date. + +Here's a comprehensive example using the provided code template. The examples for all DateFunctions are presented in a tabular format: + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
Format: 'dd/MM/yyyy'20/07/2024
Format: 'dd/MM/yyyy'16/07/2024
Format: 'dd/MM/yyyy'30/04/2020
Format: 'dd/MM/yyyy'12/12/2024
+
+ + +--- + +## **Between** + +- Enables you to generate dates within a specified range. +- It is helpful in scenarios where you need to generate dates for a defined period, such as scheduling appointments or analyzing trends within a specific timeframe. + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
From: '01/01/2022',
To: '31/12/2022',
Format: 'dd/MM/yyyy'
14/05/2022
From: '01/01/2022',
To: '31/12/2022',
Format: 'dd/MM/yyyy'
22/08/2022
From: '01/01/2022',
To: '31/12/2022',
Format: 'dd/MM/yyyy'
11/11/2022
From: '01/01/2022',
To: '31/12/2022',
Format: 'dd/MM/yyyy'
02/03/2022
+
+ +--- + +## **Past** + +- Allows you to generate past dates relative to the current date. +- This function helps create historical records, such as back at events or unanalyzed over a past period. + +Here's a comprehensive example using the provided code template. The examples for all DateFunctions are presented in a tabular format: + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
At most: 60,
Unit: days,
Format: 'dd/MM/yyyy'
11/05/2024
At most: 30,
Unit: days,
Format: 'dd/MM/yyyy'
16/06/2024
At most: 60,
Unit: days,
Format: 'dd/MM/yyyy'
17/05/2024
At most: 90,
Unit: days,
Format: 'dd/MM/yyyy'
17/04/2024
+
+ +--- + +## **Past** + +- Allows you to generate past dates relative to a specified reference date. +- It is ideal when you need to anchor your past dates to a specific point in time, which can be helpful for historical simulations or data analysis starting from a particular date. + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
At most: 30,
Unit: days,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'
15/08/2024
At most: 60,
Unit: days,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'
08/09/2024
At most: 90,
Unit: days,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'
14/10/2024
At most: 30,
Unit: days,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'
09/08/2024
+
+ +--- + +## **Birthday** + +- Allows you to generate random dates formatted as birthdays. +- Ideal for scenarios that require random date generation, such as populating test data or simulating user profiles with birthdates. + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
Offset: 30,
Format: 'dd/MM/yyyy'
16/07/1994
Offset: 25,
Format: 'dd/MM/yyyy'
16/07/1999
Offset: 40,
Format: 'dd/MM/yyyy'
16/07/1984
Offset: 18,
Format: 'dd/MM/yyyy'
16/07/2006
+
+ +--- + +## **Date Before Today** + +- Allows you to generate a date of a specified number of days before today. +- Generating historical dates relative to the current date is helpful for data analysis or scheduling based on past events. + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
At most: 30,
Unit: days,
Format: 'dd/MM/yyyy'
16/06/2024
At most: 60,
Unit: days,
Format: 'dd/MM/yyyy'
17/05/2024
At most: 90,
Unit: days,
Format: 'dd/MM/yyyy'
17/04/2024
At most: 45,
Unit: days,
Format: 'dd/MM/yyyy'
01/06/2024
+
+ +--- + +## **Date After Today** + +- Allows you to generate a date that is a specified number of days after today's date. +- You can use it to calculate future dates relative to the current date, such as when you schedule future tasks or events. + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
At most: 30,
Unit: days,
Format: 'dd/MM/yyyy'
15/08/2024
At most: 60,
Unit: days,
Format: 'dd/MM/yyyy'
14/09/2024
At most: 90,
Unit: days,
Format: 'dd/MM/yyyy'
14/10/2024
At most: 45,
Unit: days,
Format: 'dd/MM/yyyy'
30/08/2024
+
+ +--- + +## **Date Before Given Today** + +- Allows you to generate a date that is a specified number of days before a given reference date. +- It is helpful for scenarios where you need to calculate deadlines or events relative to a specific date in the past. + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
At most: 30,
Unit: days,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'
10/06/2024
At most: 60,
Unit: days,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'
11/05/2024
At most: 90,
Unit: days,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'
11/04/2024
At most: 45,
Unit: days,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'
26/05/2024
+
+ +--- + +## **Date After Given Today** + +- Allows you to generate a date that is a specified number of days after a given reference date. +- It helps project dates or events forward from a specific reference point, such as milestones or project deadlines. + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
At most: 30,
Unit: days,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'
09/08/2024
At most: 60,
Unit: days,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'
08/09/2024
At most: 90,
Unit: days,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'
08/10/2024
At most: 45,
Unit: days,
Reference Date: '10/07/2024',
Format: 'dd/MM/yyyy'
24/08/2024
+
+ +--- + + + diff --git a/src/pages/docs/test-data/data-generators/emailfunctions-function-type.md b/src/pages/docs/test-data/data-generators/emailfunctions-function-type.md index b601ade7..08cb0e5b 100644 --- a/src/pages/docs/test-data/data-generators/emailfunctions-function-type.md +++ b/src/pages/docs/test-data/data-generators/emailfunctions-function-type.md @@ -105,19 +105,19 @@ Before utilising the different data generator functions, it's essential to under - username length: 10 + username length: 10 johnsmith1 - username length: 6 + username length: 6 sarah5 - username length: 10 + username length: 10 sarahglenn - username length: 6 + username length: 6 robert @@ -175,19 +175,19 @@ Before utilising the different data generator functions, it's essential to under - username length: 8 + username length: 8 abc12345@example.com - username length: 12 + username length: 12 xyz67890abcd@example.com - username length: 10 + username length: 10 pqrs9876@example.com - username length: 6 + username length: 6 mno345@example.com @@ -247,19 +247,19 @@ Before utilising the different data generator functions, it's essential to under - username length: 10,
Domain: mydomain.com + username length: 10,
Domain: mydomain.com user1234ab@mydomain.com - username length: 8,
Domain: example.org + username length: 8,
Domain: example.org test5678@example.org - username length: 12,
Domain: mail.com + username length: 12,
Domain: mail.com alpha890beta@mail.com - username length: 6,
Domain: customdomain.com + username length: 6,
Domain: customdomain.com abc456@customdomain.com @@ -319,19 +319,19 @@ Before utilising the different data generator functions, it's essential to under - username length: 6,
Domain: sample.com + username length: 6,
Domain: sample.com user12@sample.com - username length: 8,
Domain: example.com + username length: 8,
Domain: example.com test4567@example.com - username length: 10,
Domain: domain.org + username length: 10,
Domain: domain.org randomuser@domain.org - username length: 7,
Domain: mail.net + username length: 7,
Domain: mail.net abc1234@mail.net @@ -391,19 +391,19 @@ Before utilising the different data generator functions, it's essential to under - username length: 12 + username length: 12 randomuser@domain.com - username length: 10 + username length: 10 sampleuser@domain.com - username length: 8 + username length: 8 testuser@domain.com - username length: 6 + username length: 6 user01@domain.com diff --git a/src/pages/docs/test-data/data-generators/friends-function-type.md b/src/pages/docs/test-data/data-generators/friends-function-type.md new file mode 100644 index 00000000..858e2804 --- /dev/null +++ b/src/pages/docs/test-data/data-generators/friends-function-type.md @@ -0,0 +1,145 @@ +--- +title: "Friends Function Type" +pagetitle: "Generate and Manage Email Addresses with EmailFunctions" +metadesc: "Friends function type allows you to create various email addresses with ease. Learn to generate usernames, random emails, and domain-specific emails." +noindex: false +order: 5.46 +page_id: "friends-function-type" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Selecting Friends as a Function Type for Data Generator" + url: "#selecting-friends-as-a-function-type-for-data-generator" +- type: link + name: "Character" + url: "#character" +- type: link + name: "Locationsr" + url: "#locations" +--- + +--- + +TestDataFromProfile functions enable users to retrieve specific test data from designated profiles, allowing for easy access and utilization of predefined datasets for testing purposes. + +--- + +## **Prerequisites** + +Before utilising the different data generator functions, it's essential to understand basic concepts such as creating [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#create-test-case) and [Test Steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/) and [adding data generators](https://testsigma.com/docs/test-data/types/data-generator/#add-data-generators-in-test-steps) in test steps. + +--- + +## **Selecting Friends as a Function Type for Data Generator** + +1. Use **NLP** to create a **new step** in the test case and include a placeholder for **test data**. +2. Click on the **test data** placeholder. From the **Test Data Types** dropdown menu, select the **! Data Generator** option. +3. On the **! Data Generators** overlay screen, select the **Type** to **Default**. This will enable you to use a collection of built-in test data generators. +4. Select **Friends** from the **Function Type** dropdown list. ![select friends function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/friends_functiontype_dg.gif) + +[[info | NOTE:]] +| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. + +--- + +## **Character** + +- Enables you to create diverse, random character names, which facilitates the testing of character-related features and ensures varied data inputs. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + +## **Locations** + +- Allows you to generate random locations, aiding in the testing of location-based functionalities and ensuring comprehensive coverage. + + + +
+
+ ℹ️Example: +
+ +
+ +--- + diff --git a/src/pages/docs/test-data/data-generators/mailboxaliasfunctions-function-type.md b/src/pages/docs/test-data/data-generators/mailboxaliasfunctions-function-type.md new file mode 100644 index 00000000..7492c617 --- /dev/null +++ b/src/pages/docs/test-data/data-generators/mailboxaliasfunctions-function-type.md @@ -0,0 +1,675 @@ +--- +title: "MailboxAliasFunctions Function Type" +pagetitle: "Generate and Manage Email Addresses with EmailFunctions" +metadesc: "MailboxAliasFunctions function type allows you to create various email addresses with ease. Learn to generate usernames, random emails, and domain-specific emails." +noindex: false +order: 5.43 +page_id: "mailboxaliasfunctions-function-type" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Selecting MailboxAliasFunctions as a Function Type for Data Generator" + url: "#selecting-mailboxaliasfunctions-as-a-function-type-for-data-generator" +- type: link + name: "Generate Mailbox Alias" + url: "#generate-mailbox-alias" +- type: link + name: "Get Email Content" + url: "#get-email-content" +- type: link + name: "Get Email Subject" + url: "#get-email-subject" +- type: link + name: "Get OTP" + url: "#get-otp" +- type: link + name: "URL with Text" + url: "#url-with-text" +- type: link + name: "URL which Contains" + url: "#url-which-contains" +- type: link + name: "URL matching Regex" + url: "#url-matching-regex" +- type: link + name: "Get Sender Email" + url: "#get-sender-email" +- type: link + name: "Get Sender Name" + url: "#get-sender-name" +--- + +--- + +MailBoxAlias Functions enable dynamic interaction with email data in testing and automation. Users can create, retrieve, and manipulate email aliases and their content during test execution. These functions enhance testing efficiency by facilitating seamless email testing and validation processes. + +--- + +## **Prerequisites** + +Before utilising the different data generator functions, it's essential to understand basic concepts such as creating [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#create-test-case) and [Test Steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/) and [adding data generators](https://testsigma.com/docs/test-data/types/data-generator/#add-data-generators-in-test-steps) in test steps. Additionally, familiarize yourself with [MailBoxFunctions](https://testsigma.com/docs/test-data/types/mailbox/) for accessing and manipulating email content and metadata. + +--- + +## **Selecting MailboxAliasFunctions as a Function Type for Data Generator** + +1. Use **NLP** to create a **new step** in the test case and include a placeholder for **test data**. +2. Click on the **test data** placeholder. From the **Test Data Types** dropdown menu, select the **! Data Generator** option. +3. On the **! Data Generators** overlay screen, select the **Type** to **Default**. This will enable you to use a collection of built-in test data generators. +4. Select **MailboxAliasFunctions** from the **Function Type** dropdown list. ![select mailboxaliasfunctions function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/mailboxaliasfuntions_functiontype_dg.gif) + +[[info | NOTE:]] +| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. + +--- + +## **Generate Mailbox Alias** + +- Allows you to create a unique email alias associated with your primary email account during a test step. +- Each alias generates a separate mailbox, enabling multiple email addresses to direct emails to the same inbox for testing and automation purposes. + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputOutput
Selected MailBoxmailboxalias123@example.com
Selected MailBoxuser1alias456@example.com
Selected MailBoxtestuseralias789@example.com
Selected MailBoxdemoalias101@example.com
+
+ + +--- + +## **Get Email Content** + +- Enables you to retrieve the subject line of an email message based on specified runtime variables using this feature. +- It captures email subjects dynamically during test execution. + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputOutput
Runtime Variable: inbox,
Timeout: 30
Hello! This is the content of your email.
Runtime Variable: promotions,
Timeout: 30
Get 50% off on your next purchase.
Runtime Variable: updates,
Timeout: 30
Your order has been shipped.
Runtime Variable: spam,
Timeout: 30
Congratulations! You've won a prize.
+
+ +--- + +## **Get Email Subject** + +- Allows you to retrieve the subject line of an email message based on specified runtime variables. +- It is used to capture email subjects dynamically during test execution. + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + + +
InputOutput
Runtime Variable: inbox,
Timeout: 30
Your Order Confirmation
Runtime Variable: promotions,
Timeout: 30
Special Offer Just for You
Runtime Variable: updates,
Timeout: 30
Account Verification Required
Runtime Variable: spam,
Timeout: 30
You've Been Selected!
+
+ +--- + +## **Get OTP** + +- Enables you to extract an OTP from an email message based on a provided regex pattern and runtime variables. +- It facilitates the automated retrieval of OTPs for testing authentication flows. + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputOutput
Regex: \d{6},
Runtime Variable: inbox,
Timeout: 30
123456
Regex: \d{4},
Runtime Variable: inbox,
Timeout: 30
7890
Regex: \d{5},
Runtime Variable: promotions,
Timeout: 30
54321
Regex: \d{6},
Runtime Variable: updates,
Timeout: 30
654321
+
+ +--- + +## **URL with Text** + +- Allows you to retrieve a URL from an email containing specified text. +- It searches for URLs embedded in email content that match the provided text criteria. + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputOutput
Text: Verify,
Runtime Variable: inbox,
Timeout: 30
https://example.com/verify
Text: Confirm,
Runtime Variable: promotions,
Timeout: 30
https://example.com/confirm
Text: Reset,
Runtime Variable: updates,
Timeout: 30
https://example.com/reset
Text: Activate,
Runtime Variable: spam,
Timeout: 30
https://example.com/activate
+
+ +--- + +## **URL which Contains** + +- Enables you to retrieve a URL from an email message containing specified substrings or parameters. +- It searches for URLs embedded in email content that include the provided substring. + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputOutput
Substring: verify,
Runtime Variable: inbox,
Timeout: 30
https://example.com/verify
Substring: confirm,
Runtime Variable: promotions,
Timeout: 30
https://example.com/confirm
Substring: reset,
Runtime Variable: updates,
Timeout: 30
https://example.com/reset
Substring: activate,
Runtime Variable: spam,
Timeout: 30
https://example.com/activate
+
+ +--- + +## **URL Matching Regex** + +- Allows you to retrieve a URL from an email message that matches a specified regex pattern. +- It enables flexible URL extraction based on custom regex patterns defined by the user. + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputOutput
Regex: r'https://\w+\.com/\w+',
Runtime Variable: inbox,
Timeout: 30
https://example.com/verify
Regex: r'https://\w+\.com/\w+',
Runtime Variable: promotions,
Timeoutv: 30
https://promo.com/deal
Regex: r'https://\w+\.com/\w+',
Runtime Variable: updates,
Timeout: 30
https://updates.com/info
Regex: r'https://\w+\.com/\w+',
Runtime Variable: spam,
Timeout: 30
https://spam.com/win
+
+ +--- + +## **Get Sender Email** + +- Enables you to retrieve the sender's email address from an email message based on specified runtime variables. +- It simplifies fetching sender information during test execution. + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputOutput
Runtime Variable: inbox,
Timeout: 30
sender@example.com
Runtime Variable: promotions,
Timeout: 30
promo@example.com
Runtime Variable: updates,
Timeout: 30
updates@example.com
Runtime Variable: spam,
Timeout: 30
spam@example.com
+
+ +--- + +## **Get Sender Name** + +- Allows you to retrieve the sender's name from an email message based on specified runtime variables. +- It facilitates fetching sender information during test execution. + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputOutput
Runtime Variable: inbox,
Timeout: 30
John Doe
Runtime Variable: promotions,
Timeout: 30
Promo Sender
Runtime Variable: updates,
Timeout: 30
Update Sender
Runtime Variable: spam,
Timeout: 30
Spam Sender
+
+ +--- + diff --git a/src/pages/docs/test-data/data-generators/mailboxfunctions-function-type.md b/src/pages/docs/test-data/data-generators/mailboxfunctions-function-type.md index 64f5468f..02929056 100644 --- a/src/pages/docs/test-data/data-generators/mailboxfunctions-function-type.md +++ b/src/pages/docs/test-data/data-generators/mailboxfunctions-function-type.md @@ -1,7 +1,7 @@ --- title: "MailboxFunctions Function Type" -pagetitle: "Generate and Manage Email Addresses with EmailFunctions" -metadesc: "EmailFunctions function type allows you to create various email addresses with ease. Learn to generate usernames, random emails, and domain-specific emails." +pagetitle: "Explore MailBoxFunctions for Efficient Email Handling" +metadesc: "Explore how MailBoxFunctions streamlines email data retrieval for improved workflow efficiency and clarity. Discover examples and detailed instructions." noindex: false order: 5.42 page_id: "mailboxfunctions-function-type" @@ -52,7 +52,7 @@ contextual_links: --- -Testsigma's MailBoxFunctions enables you to interact with email functionalities programmatically. This function type lets you perform various operations related to email content, subject, URLs, and verification through specified mailbox configurations. +MailBoxFunctions are specialized tools that facilitate efficient email management. They enable you to retrieve sender details and perform operations within email systems, seamlessly optimizing workflow and enhancing productivity. --- @@ -124,22 +124,22 @@ Before utilising the different data generator functions, it's essential to under - Regex: \d{4},
Select MailBox,
Timeout: 60 + Regex: \d{4},
Select MailBox,
Timeout: 60 1234 - Regex: \d{6},
Select MailBox,
Timeout: 120 + Regex: \d{6},
Select MailBox,
Timeout: 120 987654 - Regex: \d{5},
Select MailBox,
Timeout: 90 + Regex: \d{5},
Select MailBox,
Timeout: 90 54321 - Regex: \d{4,6},
Select MailBox,
Timeout: 180 + Regex: \d{4,6},
Select MailBox,
Timeout: 180 1234, 56789, 456789 @@ -199,22 +199,22 @@ Before utilising the different data generator functions, it's essential to under - Regex: \bhttps:\/\/example\.com\b,
Select MailBox,
Timeout: 60 + Regex: \bhttps:\/\/example\.com\b,
Select MailBox,
Timeout: 60 https://example.com - Regex: \bhttp:\/\/test\.com\/\w+,
select MailBox,
Timeout: 120 + Regex: \bhttp:\/\/test\.com\/\w+,
select MailBox,
Timeout: 120 http://test.com/12345 - Regex: \bhttps:\/\/www\.website\.com\/\w+,
Select MailBox,
Timeout: 90 + Regex: \bhttps:\/\/www\.website\.com\/\w+,
Select MailBox,
Timeout: 90 https://www.website.com/page123 - Regex: \bhttps:\/\/\w+\.com\/\w+,
Select MailBox,
Timeout: 180 + Regex: \bhttps:\/\/\w+\.com\/\w+,
Select MailBox,
Timeout: 180 https://example.com/page1, https://test.com/12345, https://anotherwebsite.com/home @@ -273,22 +273,22 @@ Before utilising the different data generator functions, it's essential to under - Regex: \bSubject: Order #[0-9]+\b,
Select MailBox,
Compare String: Subject: Order #12345,
Timeout: 60 seconds + Regex: \bSubject: Order #[0-9]+\b,
Select MailBox,
Compare String: Subject: Order #12345,
Timeout: 60 seconds true - Regex: \bSubject: OTP - [0-9]{4}\b,
Select MailBox,
Compare String: Subject: OTP - 5678,
Timeout: 120 seconds + Regex: \bSubject: OTP - [0-9]{4}\b,
Select MailBox,
Compare String: Subject: OTP - 5678,
Timeout: 120 seconds true - Regex: \bSubject: Invitation to event\b,
Select MailBox,
Compare String: Subject: Invitation to event,
Timeout: 90 seconds + Regex: \bSubject: Invitation to event\b,
Select MailBox,
Compare String: Subject: Invitation to event,
Timeout: 90 seconds true - Regex: \bSubject: Verification Code: [0-9]{6}\b,
Select MailBox,
Compare String: Subject: Verification Code: 123456,
Timeout: 180 seconds + Regex: \bSubject: Verification Code: [0-9]{6}\b,
Select MailBox,
Compare String: Subject: Verification Code: 123456,
Timeout: 180 seconds true @@ -347,22 +347,22 @@ Before utilising the different data generator functions, it's essential to under - Regex: \bOrder #[0-9]+\b,
Select MailBox,
Compare String: Order #12345,
Timeout: 60 + Regex: \bOrder #[0-9]+\b,
Select MailBox,
Compare String: Order #12345,
Timeout: 60 true - Regex: \bOTP - [0-9]{4}\b,
Select MailBox,
Compare String: OTP - 5678,
Timeout: 120 + Regex: \bOTP - [0-9]{4}\b,
Select MailBox,
Compare String: OTP - 5678,
Timeout: 120 true - Regex: \bInvitation to event\b,
Select MailBox,
Compare String: Invitation to event,
Timeout: 90 + Regex: \bInvitation to event\b,
Select MailBox,
Compare String: Invitation to event,
Timeout: 90 true - Regex: \bVerification Code: [0-9]{6}\b,
Select MailBox,
Compare String: Verification Code: 123456,
Timeout: 180 + Regex: \bVerification Code: [0-9]{6}\b,
Select MailBox,
Compare String: Verification Code: 123456,
Timeout: 180 true @@ -422,22 +422,22 @@ Before utilising the different data generator functions, it's essential to under - Select MailBox
Timeout: 60 + Select MailBox
Timeout: 60 Email content from MailBox - Select MailBox
Timeout: 120 + Select MailBox
Timeout: 120 Email content from MailBox - Select MailBox
Timeout: 90 + Select MailBox
Timeout: 90 Email content from MailBox - Select MailBox
Timeout: 180 + Select MailBox

Timeout: 180 Email content from MailBox @@ -497,22 +497,22 @@ Before utilising the different data generator functions, it's essential to under - Select MailBox
Timeout: 60 + Select MailBox
Timeout: 60 Email subject from MailBox - Select MailBox
Timeout: 120 + Select MailBox
Timeout: 120 Email subject from MailBox - Select MailBox
Timeout: 90 + Select MailBox
Timeout: 90 Email subject from MailBox - Select MailBox
Timeout: 180 + Select MailBox
Timeout: 180 Email subject from MailBox @@ -571,22 +571,22 @@ Before utilising the different data generator functions, it's essential to under - Text: "Click here for more info",
Select MailBox,
Timeout: 60 + Text: "Click here for more info",
Select MailBox,
Timeout: 60 URL linked to "Click here for more info" from MailBox - Text: "Visit our website",
Select MailBox,
Timeout: 120 + Text: "Visit our website",
Select MailBox,
Timeoutv: 120 URL linked to "Visit our website" from MailBox - Text: "Check out the new products",
Select MailBox,
Timeout: 90 + Text: "Check out the new products",
Select MailBox,
Timeout: 90 URL linked to "Check out the new products" from MailBox - Text: "Click here or here for updates",
Select MailBox,
Timeout: 180 + Text: "Click here or here for updates",
Select MailBox,
Timeout: 180 URLs linked to "Click here or here for updates" from MailBox @@ -646,22 +646,22 @@ Before utilising the different data generator functions, it's essential to under - Substring: "more info",
Select MailBox,
Timeout: 60 + Substring: "more info",
Select MailBox,
Timeout: 60 URLs containing "more info" MailBox - Substring: "website",
Select MailBox,
Timeout: 120 + Substring: "website",
Select MailBox,
Timeout: 120 URLs containing "website" from MailBox - Substring: "products",
Select MailBox,
Timeout: 90 + Substring: "products",
Select MailBox,
Timeout: 90 URLs containing "products" from MailBox - Substring: "updates",
Select MailBox,
Timeout: 180 + Substring: "updates",
Select MailBox,
Timeout: 180 URLs containing "updates" from MailBox @@ -721,22 +721,22 @@ Before utilising the different data generator functions, it's essential to under - Regex: \d{4},
Select MailBox,
Timeout: 60 + Regex: \d{4},
Select MailBox,
Timeout: 60 URLs containing numbers (e.g., 1234) from MailBox within 60 - Regex: \w{6},
Select MailBox,
Timeout: 120 + Regex: \w{6},
Select MailBox,
Timeout: 120 URLs containing alphanumeric strings (e.g., abc123) from MailBox within 120 - Regex: https?,
Select MailBox,
Timeout: 90 + Regex: https?,
Select MailBox,
Timeout: 90 URLs starting with "http" or "https" from MailBox within 90 - Regex: \.com$,
Select MailBox,
Timeout: 180 + Regex: \.com$,
Select MailBox,
Timeout: 180 URLs ending with ".com" from MailBox within 180 @@ -795,22 +795,22 @@ Before utilising the different data generator functions, it's essential to under - Select MailBoxFunctions,
Timeout: 60 seconds + Select MailBoxFunctions,
Timeout: 60 seconds sender1@example.com - Select MailBoxFunctions,
Timeout: 120 seconds + Select MailBoxFunctions,
Timeout: 120 seconds sender2@example.com - Select MailBoxFunctions,
Timeout: 90 seconds + Select MailBoxFunctions,
Timeout: 90 seconds sender3@example.com - Select MailBoxFunctions,
Timeout: 180 seconds + Select MailBoxFunctions,
Timeout: 180 seconds sender4@example.com @@ -869,22 +869,22 @@ Before utilising the different data generator functions, it's essential to under - Select MailBoxFunctions,
Timeout: 60 seconds + Select MailBoxFunctions,
Timeout: 60 seconds John Doe - Select MailBoxFunctions,
Timeout: 120 seconds + Select MailBoxFunctions,
Timeout: 120 seconds Jane Smith - Select MailBoxFunctions,
Timeout: 90 seconds + Select MailBoxFunctions,
Timeout: 90 seconds Alice Johnson - Select MailBoxFunctions,
Timeout: 180 seconds + Select MailBoxFunctions,
Timeout: 180 seconds Bob Brown diff --git a/src/pages/docs/test-data/data-generators/stringfunctions-function-type.md b/src/pages/docs/test-data/data-generators/stringfunctions-function-type.md new file mode 100644 index 00000000..bdced8b7 --- /dev/null +++ b/src/pages/docs/test-data/data-generators/stringfunctions-function-type.md @@ -0,0 +1,184 @@ +--- +title: "StringFunctions Function Type" +pagetitle: "Transform Text Easily with StringFunctions" +metadesc: "StringFunctions in Testsigma enable dynamic string manipulation, including concatenation and variable substitution, which is ideal for flexible data generation." +noindex: false +order: 5.44 +page_id: "stringfunctions-function-type" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Selecting StringFunctions as a Function Type for Data Generator" + url: "#selecting-stringfunctions-as-a-function-type-for-data-generator" +- type: link + name: "Concat" + url: "#concat" +- type: link + name: "Param Substituter" + url: "#param-substituter" +--- + +--- + +StringFunctions allow you to manipulate and transform text strings effortlessly. These functions enable you to combine strings and perform dynamic substitutions of placeholders with actual values, supporting various testing and data generation needs. + +--- + +## **Prerequisites** + +Before utilising the different data generator functions, it's essential to understand basic concepts such as creating [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#create-test-case) and [Test Steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/) and [adding data generators](https://testsigma.com/docs/test-data/types/data-generator/#add-data-generators-in-test-steps) in test steps. Additionally, familiarize yourself with [Parameters](https://testsigma.com/docs/test-data/types/parameter/), [Runtime](https://testsigma.com/docs/test-data/types/runtime/) and [Environments](https://testsigma.com/docs/test-data/types/environment/). + +--- + +## **Selecting StringFunctions as a Function Type for Data Generator** + +1. Use **NLP** to create a **new step** in the test case and include a placeholder for **test data**. +2. Click on the **test data** placeholder. From the **Test Data Types** dropdown menu, select the **! Data Generator** option. +3. On the **! Data Generators** overlay screen, select the **Type** to **Default**. This will enable you to use a collection of built-in test data generators. +4. Select **StringFunctions** from the **Function Type** dropdown list. ![select stringfunctions function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/stringfunctions_functiontype_dg.gif) + +[[info | NOTE:]] +| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. + +--- + +## **Concat** + +- Enables you to concatenate multiple strings or data fields into a single string output, allowing you to combine strings to form composite data inputs. + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
Test Data 1: Hello,
Test Data 2: World
HelloWorld
Test Data 1: @ User1User123
Test Data 1: $ DataDataGeneration
Test Data 1: * Travelhttps://simply-travel.testsigma.com/
+
+ +--- + +## **Param Substituter** + +- Allows you to replace placeholders in the input string with their respective values. +- It supports Parameters, Runtime Variables, and Environment Variables, enabling dynamic substitution of variables into predefined strings for flexible data generation. + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
String: I am @|name|. Born on *|dob| at $|place|I am John. Born on 01/01/1990 at New York
String: Welcome, @|username|! Today is *|date|."Welcome, User123! Today is 2024-07-18."
String: Order ID: #|orderId|, Status: *|status|"Order ID: #5678, Status: Shipped
String: Hello @|firstName|, your appointment is on *|appointmentDate|Hello Alice, your appointment is on 2024-07-25
+
+ + +--- + + diff --git a/src/pages/docs/test-data/data-generators/testdatafromprofile-function-type.md b/src/pages/docs/test-data/data-generators/testdatafromprofile-function-type.md new file mode 100644 index 00000000..54f0dd87 --- /dev/null +++ b/src/pages/docs/test-data/data-generators/testdatafromprofile-function-type.md @@ -0,0 +1,164 @@ +--- +title: "TestDataFromProfile Function Type" +pagetitle: "Generate and Manage Email Addresses with EmailFunctions" +metadesc: "TestDataFromProfile function type allows you to create various email addresses with ease. Learn to generate usernames, random emails, and domain-specific emails." +noindex: false +order: 5.45 +page_id: "testdatafromprofile-function-type" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Selecting TestDataFromProfile as a Function Type for Data Generator" + url: "#selecting-testdatafromprofile-as-a-function-type-for-data-generator" +- type: link + name: "Get Test Data by SetName" + url: "#get-test-data-by-setname" +- type: link + name: "Get Test Data by RowNumber" + url: "#get-test-data-by-rownumber" +--- + +--- + +TestDataFromProfile functions enable users to retrieve specific test data from designated profiles, allowing for easy access and utilization of predefined datasets for testing purposes. + +--- + +## **Prerequisites** + +Before utilising the different data generator functions, it's essential to understand basic concepts such as creating [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#create-test-case) and [Test Steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/) and [adding data generators](https://testsigma.com/docs/test-data/types/data-generator/#add-data-generators-in-test-steps) in test steps. Additionally, familiarize yourself with [Test Data Profile](https://testsigma.com/docs/test-data/create-data-profiles/). + +--- + +## **Selecting TestDataFromProfile as a Function Type for Data Generator** + +1. Use **NLP** to create a **new step** in the test case and include a placeholder for **test data**. +2. Click on the **test data** placeholder. From the **Test Data Types** dropdown menu, select the **! Data Generator** option. +3. On the **! Data Generators** overlay screen, select the **Type** to **Default**. This will enable you to use a collection of built-in test data generators. +4. Select **TestDataFromProfile** from the **Function Type** dropdown list. ![select testdatafromprofile function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/testdatafromprofile_functiontype_dg.gif) + +[[info | NOTE:]] +| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. + +--- + +## **Get Test Data by SetName** + +- Enables you to fetch test data by specifying the test data profile, dataset, parameter, and dataset index and returning corresponding data from the selected profile and dataset. + + + +
+
+ ℹ️Example: +
+ + + + + + + + + + + + + + + + + + + + + +
InputOutput
Profile: Customer Data Profile,
Dataset: Active Customers,
Parameter: Customer ID,
Data Set: 1
12345
Profile: Order Data Profile,
Dataset: Pending Orders,
Parameter: Order ID,
Data Set: 2
67890
Profile: Employee Data Profile,
Dataset: Current Employees,
Parameter: "Employee ID",
Data Set: 3
54321
Profile: Product Data Profile,
Dataset: Available Products,
Parameter: Product Code,
Data Set: 4
P001
+
+ +--- + +## **Get Test Data by RowNumber** + +- Allows you to retrieve test data by specifying the row number within the profile and returning data from that row. + + + +
+
+ ℹ️Example: +
+
    +
  • Input: None (This function does not require any specific input)
  • +
  • Output:
  • +
      +
    • Neha Grant
    • +
    • Vern Sanford
    • +
    • Michael Johnson
    • +
    • Sarah Davis
    • +
    +
+
+ +--- + From 14e85d218c72a402e3db831c2cd17c73cf005835 Mon Sep 17 00:00:00 2001 From: Bharath Krishna <118433150+bharathk08@users.noreply.github.com> Date: Fri, 19 Jul 2024 19:02:58 +0530 Subject: [PATCH 5/7] Added doc for Mock API Support (#454) --- src/left-nav-title.json | 3 +- .../create-steps-restapi/add-body-data.md | 1 + .../create-steps-restapi/mock-apis.md | 62 +++++++++++++++++++ .../restful-api-overview.md | 11 +++- .../create-steps-restapi/stored-objects.md | 3 + .../test-plans/supported-test-lab-types.md | 25 +++++--- 6 files changed, 91 insertions(+), 14 deletions(-) create mode 100644 src/pages/docs/test-cases/create-steps-restapi/mock-apis.md diff --git a/src/left-nav-title.json b/src/left-nav-title.json index 742f5de1..eaa63334 100644 --- a/src/left-nav-title.json +++ b/src/left-nav-title.json @@ -681,5 +681,6 @@ "record-elements": {"/docs/elements/mobile-web-application/record-elements/": "Record Multiple Elements" }, "add-test-cases-for-mobile-web-app": {"/docs/test-cases/manage/add-test-cases-for-mobile-web-app/": "Test Cases (Mobile Web App)" }, "most-common-issues": { "/docs/troubleshooting/salesforce-testing/most-common-issues/": "Most Common Issues" }, - "developer-mode-for-ios": {"/docs/troubleshooting/mobile-apps/developer-mode-for-ios/": "Developer Mode (iOS 16 & Above)" } + "developer-mode-for-ios": {"/docs/troubleshooting/mobile-apps/developer-mode-for-ios/": "Developer Mode (iOS 16 & Above)" }, + "mock-apis": {"/docs/test-cases/create-steps-restapi/mock-apis/": "Mock API Support" } } \ No newline at end of file diff --git a/src/pages/docs/test-cases/create-steps-restapi/add-body-data.md b/src/pages/docs/test-cases/create-steps-restapi/add-body-data.md index ddb847e3..aedbe8c6 100644 --- a/src/pages/docs/test-cases/create-steps-restapi/add-body-data.md +++ b/src/pages/docs/test-cases/create-steps-restapi/add-body-data.md @@ -31,6 +31,7 @@ contextual_links: --- --- + Adding body data in RESTful API testing is the process of sending additional data to the server in the body of the request. You will need to send body data with requests whenever you need to add or update structured data. For example, if you're sending a request to add a new customer to a database, you might include the customer details in **JSON**. Typically, you will use body data with **PUT**, **POST**, and **PATCH** requests. [[info | NOTE:]] diff --git a/src/pages/docs/test-cases/create-steps-restapi/mock-apis.md b/src/pages/docs/test-cases/create-steps-restapi/mock-apis.md new file mode 100644 index 00000000..9b63e7da --- /dev/null +++ b/src/pages/docs/test-cases/create-steps-restapi/mock-apis.md @@ -0,0 +1,62 @@ +--- +title: "Mock API Support in Testsigma" +page_title: "Mock API Support in Testsigma" +metadesc: "Learn how to handle mock APIs and experiment with the different types of test data | Testsigma allows you give inputs while mocking an API in Testsigma" +noindex: false +order: 4.993 +page_id: "Mock APIs" +search_keyword: "" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Adding Various Inputs for Mock APIs" + url: "#adding-various-inputs-for-mock-apis" +--- + +--- + +The goal of mocking an API is to ensure that users can experiment with the data before authoring the API step. With Testsigma, users can select default and custom values associated with each key for various variables, such as parameters, runtime, environment, random data generator, phone number, and mailbox, and verify responses. + +This article discusses providing test data inputs while mocking an API in Testsigma. + +--- + +> ## **Prerequisites** +> +> - You should know how to [create a Test Case](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#creating-a-test-case). +> +> - You should know how to [add Rest API in the test steps](https://testsigma.com/docs/test-cases/step-types/rest-api/#add-restful-api-in-test-steps). + +--- + +## **Adding Various Inputs for Mock APIs** + +1. From the left-side navbar, select **Create Tests > Test Cases** and then click **Create Test Case**. + +2. On the **Test Case Details** page, click the option next to the test step and select **Rest API**. + +3. Click on the test step to open the **Rest API** window. + +4. Enter the **Title**, choose the **Method**, and enter the **Endpoint**. + +5. Select the data you want to parametrize and click **Insert Test Data**. + +6. Choose the test data type you want to add (e.g., **@Parameter**). + +7. Click **Add Request Values**. The **Request values** overlay will open. + +8. In the **Request Values** overlay, click **URL**, add the value to the parameter in the **URL**, and click **Apply**. + +9. Click **Send** and verify the response received from the API. + + +Here’s a quick GIF demonstrating an example of adding an input for mocking API. + +![Mock APIs](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/MockAPI.gif) + +--- \ No newline at end of file diff --git a/src/pages/docs/test-cases/create-steps-restapi/restful-api-overview.md b/src/pages/docs/test-cases/create-steps-restapi/restful-api-overview.md index 8fde317d..e4791ac4 100644 --- a/src/pages/docs/test-cases/create-steps-restapi/restful-api-overview.md +++ b/src/pages/docs/test-cases/create-steps-restapi/restful-api-overview.md @@ -10,6 +10,9 @@ warning: false contextual_links: - type: section name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" - type: link name: "Resources" url: "#resources" @@ -21,9 +24,11 @@ Testsigma supports Restful APIs Testing. RESTful APIs allow you to access resour --- -### **Prerequisites** - -You'll need to know how to [create a test case](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#creating-a-test-case) and [add RESTful API in the test steps](https://testsigma.com/docs/test-cases/step-types/rest-api/#add-restful-api-in-test-steps). +> ## **Prerequisites** +> +> - You should know how to [create a Test Case](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#creating-a-test-case). +> +> - You should know how to [add Rest API in the test steps](https://testsigma.com/docs/test-cases/step-types/rest-api/#add-restful-api-in-test-steps). --- diff --git a/src/pages/docs/test-cases/create-steps-restapi/stored-objects.md b/src/pages/docs/test-cases/create-steps-restapi/stored-objects.md index 1cfcc7a4..3e6ba59a 100644 --- a/src/pages/docs/test-cases/create-steps-restapi/stored-objects.md +++ b/src/pages/docs/test-cases/create-steps-restapi/stored-objects.md @@ -16,8 +16,11 @@ contextual_links: --- --- + Stored objects have **GLOBAL** scope, which can be used for cross-test case verification. Objects can be saved using the Rest API. Stored objects in RESTful API testing refer to the data that is stored in the database and is used to test the API. This data can include user accounts, product information, and other data that is used to test the API. The stored objects are used to ensure that the API is functioning correctly and that the data is being returned correctly. You can **download** objects from **save response** and **stored objects** tab. +--- + ## **Store Objects from Save response** 1. **Send** an API request, and at the bottom of the screen, the **response body** will appear for the request you sent. diff --git a/src/pages/docs/test-management/test-plans/supported-test-lab-types.md b/src/pages/docs/test-management/test-plans/supported-test-lab-types.md index 9115554a..7b649a16 100644 --- a/src/pages/docs/test-management/test-plans/supported-test-lab-types.md +++ b/src/pages/docs/test-management/test-plans/supported-test-lab-types.md @@ -28,29 +28,31 @@ Testsigma platform allows you to execute your tests using different Test Let’s learn more about these grids. -1. [Testsigma Labs](https://www.testsigma.com/) +1. Testsigma Labs -This option allows you to run tests on Testsigma′s own cloud infrastructure. Testsigma Labs hosts a set of devices which can be used to run the tests with maximum security and compatibility. This is the recommended option as the systems are pre-configured with optimal settings for the test environments and the devices are used for only one purpose, i.e for running tests. + This option allows you to run tests on Testsigma′s own cloud infrastructure. Testsigma Labs hosts a set of devices which can be used to run the tests with maximum security and compatibility. This is the recommended option as the systems are pre-configured with optimal settings for the test environments and the devices are used for only one purpose, i.e for running tests. Use this option only if the application that you need to test is accessible over the Internet and not blocked by the firewall of a company network. 2. Local Devices -It enables you to use your own local machines for setting up the test environment and running the tests on them. This is the most preferred option if your application is hosted locally on company premises and is not accessible over the internet and this is mostly the case when an application is under active development. + It enables you to use your own local machines for setting up the test environment and running the tests on them. This is the most preferred option if your application is hosted locally on company premises and is not accessible over the internet and this is mostly the case when an application is under active development. -Note: You need to install a helper agent application on your local machine to use this option. This agent configures the connection between Testsigma servers and your machine to perform the Test Plan on your local machine. +[[info | **NOTE**:]] +| You need to install a helper agent application on your local machine to use this option. This agent configures the connection between Testsigma servers and your machine to perform the Test Plan on your local machine. -Learn [how to Create a Test Plan to Run Tests on Local Machines](https://testsigma.com/tutorials/test-plans/using-local-devices/). +Learn [how to create a Test Plan to run tests on mocal machines](https://testsigma.com/tutorials/test-plans/using-local-devices/). 3. [BrowserStack](https://www.browserstack.com/#) -Testsigma also allows us to use cloud devices on the BrowserStack Model to run your tests. You just need to integrate your BrowserStack account with your Testsigma Account by entering the login credentials. Also, while creating a test plan, provide the required device details on the test plan configurations page. + Testsigma also allows us to use cloud devices on the BrowserStack Model to run your tests. You just need to integrate your BrowserStack account with your Testsigma Account by entering the login credentials. Also, while creating a test plan, provide the required device details on the test plan configurations page. + Learn how to [Configure BrowserStack](https://testsigma.com/docs/integrations/test-labs/browserstack/). Use this option only if the application that you need to test is accessible over the Internet and not blocked by the firewall of a company network. 4. [Sauce Labs](https://saucelabs.com/) -Similar to BrowserStack, it is possible to use Sauce Labs for your test execution by integrating it with Testsigma Account. You just need to integrate your Sauce Labs account with your Testsigma Account by entering the login credentials. Also, while creating a test plan, provide the required device details on the test plan configurations page. + Similar to BrowserStack, it is possible to use Sauce Labs for your test execution by integrating it with Testsigma Account. You just need to integrate your Sauce Labs account with your Testsigma Account by entering the login credentials. Also, while creating a test plan, provide the required device details on the test plan configurations page. Learn how to [Configure Sauce Labs](https://testsigma.com/docs/integrations/test-labs/sauce-labs/) @@ -58,20 +60,23 @@ Use this option only if the application that you need to test is accessible over 5. [Kobiton Test Lab](https://kobiton.com/) -Testsigma also allows us to use cloud devices on Kobiton Test Lab to run your tests. You just need to integrate your Kobiton Test Lab account with your Testsigma Account by entering the login credentials. Also, while creating a test plan, provide the required device details on the test plan configurations page. + Testsigma also allows us to use cloud devices on Kobiton Test Lab to run your tests. You just need to integrate your Kobiton Test Lab account with your Testsigma Account by entering the login credentials. Also, while creating a test plan, provide the required device details on the test plan configurations page. Use this option only if the application that you need to test is accessible over the Internet and not blocked by the firewall of a company network. 6. [LambdaTest](https://www.lambdatest.com/) -Testsigma also allows us to use cloud devices on LambdaTest to run your tests. You just need to integrate your LambdaTest account with your Testsigma Account by entering the login credentials. Also, while creating a test plan, provide the required device details on the test plan configurations page. + Testsigma also allows us to use cloud devices on LambdaTest to run your tests. You just need to integrate your LambdaTest account with your Testsigma Account by entering the login credentials. Also, while creating a test plan, provide the required device details on the test plan configurations page. Use this option only if the application that you need to test is accessible over the Internet and not blocked by the firewall of a company network. 5. Private Grid -Similar to Local Devices, a Private grid allows you to configure a set of Machines for local Execution. Please contact the Testsigma Support team for more details as this involves Advanced Steps. + Similar to Local Devices, a Private grid allows you to configure a set of Machines for local Execution. Please contact the Testsigma Support team for more details as this involves Advanced Steps. + + For more info, see [Testsigma Private Grid](https://testsigma.com/docs/runs/executing-tests-in-private-grid/) +--- \ No newline at end of file From 866ccbd3048ccc2033734e85c1a4cbdd424b81f2 Mon Sep 17 00:00:00 2001 From: Sangith Ravichandran <119392848+sangithravichandran@users.noreply.github.com> Date: Mon, 22 Jul 2024 10:06:07 +0530 Subject: [PATCH 6/7] Updated all Data Generator Document (#455) --- .../data-generators/address-function-type.md | 2 +- .../change-data-type-function-type.md | 114 ++++++++++++++ .../data-generators/company-function-type.md | 2 +- .../datefunctions-function-type.md | 2 +- .../domainfunctions-function-type.md | 115 ++++++++++++++ .../emailfunctions-function-type.md | 4 +- .../data-generators/file-function-type.md | 4 +- .../data-generators/friends-function-type.md | 4 +- .../data-generators/idnumber-function-type.md | 4 +- .../data-generators/internet-function-type.md | 4 +- .../mailboxaliasfunctions-function-type.md | 2 +- .../mailboxfunctions-function-type.md | 4 +- .../data-generators/name-function-type.md | 2 +- .../namefunctions-function-type.md | 95 +++++++++++ .../data-generators/number-function-type.md | 44 +++--- .../numberfunctions-function-type.md | 122 +++++++++++++++ .../data-generators/phone-function-type.md | 148 ++++++++++++++++++ .../phonenumberfunctions-function-type.md | 136 ++++++++++++++++ .../random-string-function-type.md | 120 ++++++++++++++ .../random-text-function-type.md | 120 ++++++++++++++ .../stringfunctions-function-type.md | 4 +- .../testdatafromprofile-function-type.md | 4 +- src/pages/docs/test-data/types/environment.md | 19 ++- 23 files changed, 1031 insertions(+), 44 deletions(-) create mode 100644 src/pages/docs/test-data/data-generators/change-data-type-function-type.md create mode 100644 src/pages/docs/test-data/data-generators/domainfunctions-function-type.md create mode 100644 src/pages/docs/test-data/data-generators/namefunctions-function-type.md create mode 100644 src/pages/docs/test-data/data-generators/numberfunctions-function-type.md create mode 100644 src/pages/docs/test-data/data-generators/phone-function-type.md create mode 100644 src/pages/docs/test-data/data-generators/phonenumberfunctions-function-type.md create mode 100644 src/pages/docs/test-data/data-generators/random-string-function-type.md create mode 100644 src/pages/docs/test-data/data-generators/random-text-function-type.md diff --git a/src/pages/docs/test-data/data-generators/address-function-type.md b/src/pages/docs/test-data/data-generators/address-function-type.md index ca902b1e..22764f44 100644 --- a/src/pages/docs/test-data/data-generators/address-function-type.md +++ b/src/pages/docs/test-data/data-generators/address-function-type.md @@ -3,7 +3,7 @@ title: "Address Function Type" pagetitle: "Generate Random Addresses for Testing and Simulation" metadesc: "Start addresses easily with our tool. Generate random addresses including street, city, state, and postal code for testing or data simulation." noindex: false -order: 5.34 +order: 5.33 page_id: "address-function-type" warning: false contextual_links: diff --git a/src/pages/docs/test-data/data-generators/change-data-type-function-type.md b/src/pages/docs/test-data/data-generators/change-data-type-function-type.md new file mode 100644 index 00000000..d35e0142 --- /dev/null +++ b/src/pages/docs/test-data/data-generators/change-data-type-function-type.md @@ -0,0 +1,114 @@ +--- +title: "ChangeDataType Function Type" +pagetitle: "Change Data Type Function: Convert Input Values Easily" +metadesc: "Change Data Type Function allows you to convert input values to specified data types, ensuring compatibility for various operations and storage needs." +noindex: false +order: 5.34 +page_id: "changedatatype-function-type" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Selecting ChangeDataType as a Function Type for Data Generator" + url: "#selecting-changedatatype-as-a-function-type-for-data-generator" +- type: link + name: "Convert Input Data Type" + url: "#convert-input-data-type" +--- + +--- + +ChangeDataType function lets you convert data from one type to another, ensuring compatibility for different operations or storage needs. It can transform data formats, such as converting strings into numbers or booleans for calculations or logical operations. + +--- + +## **Prerequisites** + +Before utilising the different data generator functions, it's essential to understand basic concepts such as creating [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#create-test-case) and [Test Steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/) and [adding data generators](https://testsigma.com/docs/test-data/types/data-generator/#add-data-generators-in-test-steps) in test steps. + +--- + +## **Selecting ChangeDataType as a Function Type for Data Generator** + +1. Use **NLP** to create a **new step** in the test case and include a placeholder for **test data**. +2. Click on the **test data** placeholder. From the **Test Data Types** dropdown menu, select the **! Data Generator** option. +3. On the **! Data Generators** overlay screen, select the **Type** to **Default**. This will enable you to use a collection of built-in test data generators. +4. Select **ChangeDataType** from the **Function Type** dropdown list. ![select changedatatype function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/changedatatype_functiontype_dg.gif) + +[[info | NOTE:]] +| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. + +--- + +## **ConvertInputDataType** + +- Allows you to convert a given input value to a specified data type. +- It is useful when data compatibility is essential, such as when you transform strings to numerical values for calculations, convert strings to booleans for logical operations, or change numerical values to strings for display purposes. + + + +
+
+ ℹ️Examples: +
+ + + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
Input: 123,
Data Type: int
123
Input: true,
Data Type: boolean
true
Input: 65,
Data Type: char
A
Input: 3.14,
Data Type: double
3.14
+
+ +--- + diff --git a/src/pages/docs/test-data/data-generators/company-function-type.md b/src/pages/docs/test-data/data-generators/company-function-type.md index a80bce78..523ae65c 100644 --- a/src/pages/docs/test-data/data-generators/company-function-type.md +++ b/src/pages/docs/test-data/data-generators/company-function-type.md @@ -64,7 +64,7 @@ Before utilising the different data generator functions, it's essential to under 4. Select **Company** from the **Function Type** dropdown list. ![select company function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/company_functiontype_dg.gif) [[info | NOTE:]] -| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. +| This action will display a list of built-in functions associated with the Company function type, enabling you to select the appropriate function based on your requirements. --- diff --git a/src/pages/docs/test-data/data-generators/datefunctions-function-type.md b/src/pages/docs/test-data/data-generators/datefunctions-function-type.md index 9de1b47d..d8706b38 100644 --- a/src/pages/docs/test-data/data-generators/datefunctions-function-type.md +++ b/src/pages/docs/test-data/data-generators/datefunctions-function-type.md @@ -70,7 +70,7 @@ Before utilising the different data generator functions, it's essential to under 4. Select **DateFunctions** from the **Function Type** dropdown list. ![select datefunctions function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/datefuntions_functiontype_dg.gif) [[info | NOTE:]] -| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. +| This action will display a list of built-in functions associated with the DateFunctions function type, enabling you to select the appropriate function based on your requirements. --- diff --git a/src/pages/docs/test-data/data-generators/domainfunctions-function-type.md b/src/pages/docs/test-data/data-generators/domainfunctions-function-type.md new file mode 100644 index 00000000..1a3a2c3b --- /dev/null +++ b/src/pages/docs/test-data/data-generators/domainfunctions-function-type.md @@ -0,0 +1,115 @@ +--- +title: "DomainFunctions Function Type" +pagetitle: "Domain Functions: Generate Domain-Specific Email Addresses" +metadesc: "Domain Functions enable you to create email addresses with specific domains. Perfect for setting up organization-specific emails and testing needs." +noindex: false +order: 5.37 +page_id: "domainfunctions-function-type" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Selecting DomainFunctions as a Function Type for Data Generator" + url: "#selecting-domainfunctions-as-a-function-type-for-data-generator" +- type: link + name: "Email with Domain" + url: "#email-with-domain" +--- + +--- + +Domain Functions design email addresses with specific domains. They create email addresses that align with a particular organization or domain name, ensuring that the generated emails are correctly formatted for that domain. + +--- + +## **Prerequisites** + +Before utilising the different data generator functions, it's essential to understand basic concepts such as creating [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#create-test-case) and [Test Steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/) and [adding data generators](https://testsigma.com/docs/test-data/types/data-generator/#add-data-generators-in-test-steps) in test steps. + +--- + +## **Selecting DomainFunctions as a Function Type for Data Generator** + +1. Use **NLP** to create a **new step** in the test case and include a placeholder for **test data**. +2. Click on the **test data** placeholder. From the **Test Data Types** dropdown menu, select the **! Data Generator** option. +3. On the **! Data Generators** overlay screen, select the **Type** to **Default**. This will enable you to use a collection of built-in test data generators. +4. Select **DomainFunctions** from the **Function Type** dropdown list. ![select domainfunctions function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/domainfunctions_functiontype_dg.gif) + +[[info | NOTE:]] +| This action will display a list of built-in functions associated with the DomainFunctions function type, enabling you to select the appropriate function based on your requirements. + +--- + +## **Email with Domain** + +- Allows you to generate an email address with a specified domain, ensuring the email format adheres to your inputs. +- It is useful when you create realistic email addresses with domains for testing or in any scenario that requires domain-specific email addresses. + + + +
+
+ ℹ️Examples: +
+ + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
domain: example.comjohn.doe@example.com
domain: mycompany.orgjane.smith@mycompany.org
domain: school.edurobert.brown@school.edu
domain: organization.netemily.jones@organization.net
+
+ + +--- + diff --git a/src/pages/docs/test-data/data-generators/emailfunctions-function-type.md b/src/pages/docs/test-data/data-generators/emailfunctions-function-type.md index 08cb0e5b..b418d362 100644 --- a/src/pages/docs/test-data/data-generators/emailfunctions-function-type.md +++ b/src/pages/docs/test-data/data-generators/emailfunctions-function-type.md @@ -3,7 +3,7 @@ title: "EmailFunctions Function Type" pagetitle: "Generate and Manage Email Addresses with EmailFunctions" metadesc: "EmailFunctions function type allows you to create various email addresses with ease. Learn to generate usernames, random emails, and domain-specific emails." noindex: false -order: 5.39 +order: 5.38 page_id: "emailfunctions-function-type" warning: false contextual_links: @@ -52,7 +52,7 @@ Before utilising the different data generator functions, it's essential to under 4. Select **EmailFunctions** from the **Function Type** dropdown list. ![select emailfunctions function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/emailfunctions_functiontype_dg.gif) [[info | NOTE:]] -| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. +| This action will display a list of built-in functions associated with the EmailFunctions function type, enabling you to select the appropriate function based on your requirements. --- diff --git a/src/pages/docs/test-data/data-generators/file-function-type.md b/src/pages/docs/test-data/data-generators/file-function-type.md index 50adb1d6..274b612d 100644 --- a/src/pages/docs/test-data/data-generators/file-function-type.md +++ b/src/pages/docs/test-data/data-generators/file-function-type.md @@ -3,7 +3,7 @@ title: "File Function Type" pagetitle: "Importing File Function Type for Dynamic File Handling" metadesc: "Learn to utilize the File Function Type for dynamic file handling in your applications to generate random file extensions, MIME types, and file names." noindex: false -order: 5.37 +order: 5.39 page_id: "file-function-type" warning: false contextual_links: @@ -49,7 +49,7 @@ Before utilising the different data generator functions, it's essential to under 4. Select **File** from the **Function Type** dropdown list. ![select datefunctions function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/file_functiontype_dg.gif) [[info | NOTE:]] -| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. +| This action will display a list of built-in functions associated with the File function type, enabling you to select the appropriate function based on your requirements. --- diff --git a/src/pages/docs/test-data/data-generators/friends-function-type.md b/src/pages/docs/test-data/data-generators/friends-function-type.md index 858e2804..196d3e9c 100644 --- a/src/pages/docs/test-data/data-generators/friends-function-type.md +++ b/src/pages/docs/test-data/data-generators/friends-function-type.md @@ -3,7 +3,7 @@ title: "Friends Function Type" pagetitle: "Generate and Manage Email Addresses with EmailFunctions" metadesc: "Friends function type allows you to create various email addresses with ease. Learn to generate usernames, random emails, and domain-specific emails." noindex: false -order: 5.46 +order: 5.40 page_id: "friends-function-type" warning: false contextual_links: @@ -43,7 +43,7 @@ Before utilising the different data generator functions, it's essential to under 4. Select **Friends** from the **Function Type** dropdown list. ![select friends function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/friends_functiontype_dg.gif) [[info | NOTE:]] -| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. +| This action will display a list of built-in functions associated with the Friends function type, enabling you to select the appropriate function based on your requirements. --- diff --git a/src/pages/docs/test-data/data-generators/idnumber-function-type.md b/src/pages/docs/test-data/data-generators/idnumber-function-type.md index cbc6e2d9..1ca668cc 100644 --- a/src/pages/docs/test-data/data-generators/idnumber-function-type.md +++ b/src/pages/docs/test-data/data-generators/idnumber-function-type.md @@ -3,7 +3,7 @@ title: "IdNumber Function Type" pagetitle: "Generate Valid and Invalid Identification Numbers" metadesc: "The IdNumber function in data generators allows you to simulate US standard identification numbers, including valid SSNs, validSvSeSSn and unique formats." noindex: false -order: 5.38 +order: 5.41 page_id: "idnumber-function-type" warning: false contextual_links: @@ -52,7 +52,7 @@ Before utilising the different data generator functions, it's essential to under 4. Select **IdNumber** from the **Function Type** dropdown list. ![select datefunctions function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/idnumber_functiontype_dg.gif) [[info | NOTE:]] -| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. +| This action will display a list of built-in functions associated with the IdNumber function type, enabling you to select the appropriate function based on your requirements. --- diff --git a/src/pages/docs/test-data/data-generators/internet-function-type.md b/src/pages/docs/test-data/data-generators/internet-function-type.md index 13d1fbf7..2a637de9 100644 --- a/src/pages/docs/test-data/data-generators/internet-function-type.md +++ b/src/pages/docs/test-data/data-generators/internet-function-type.md @@ -3,7 +3,7 @@ title: "Internet Function Type" pagetitle: "Internet Function for Generating Domain Names and Emails" metadesc: "Learn how the Internet Function Type generates domain names, email addresses, URLs, and images for various testing scenarios with practical examples." noindex: false -order: 5.40 +order: 5.42 page_id: "internet-function-type" warning: false contextual_links: @@ -70,7 +70,7 @@ Before utilising the different data generator functions, it's essential to under 4. Select **Internet** from the **Function Type** dropdown list. ![select internet function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/internet_functiontype_dg.gif) [[info | NOTE:]] -| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. +| This action will display a list of built-in functions associated with the Internet function type, enabling you to select the appropriate function based on your requirements. --- diff --git a/src/pages/docs/test-data/data-generators/mailboxaliasfunctions-function-type.md b/src/pages/docs/test-data/data-generators/mailboxaliasfunctions-function-type.md index 7492c617..40837832 100644 --- a/src/pages/docs/test-data/data-generators/mailboxaliasfunctions-function-type.md +++ b/src/pages/docs/test-data/data-generators/mailboxaliasfunctions-function-type.md @@ -64,7 +64,7 @@ Before utilising the different data generator functions, it's essential to under 4. Select **MailboxAliasFunctions** from the **Function Type** dropdown list. ![select mailboxaliasfunctions function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/mailboxaliasfuntions_functiontype_dg.gif) [[info | NOTE:]] -| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. +| This action will display a list of built-in functions associated with the MailboxAliasFunctions function type, enabling you to select the appropriate function based on your requirements. --- diff --git a/src/pages/docs/test-data/data-generators/mailboxfunctions-function-type.md b/src/pages/docs/test-data/data-generators/mailboxfunctions-function-type.md index 02929056..7ecec991 100644 --- a/src/pages/docs/test-data/data-generators/mailboxfunctions-function-type.md +++ b/src/pages/docs/test-data/data-generators/mailboxfunctions-function-type.md @@ -3,7 +3,7 @@ title: "MailboxFunctions Function Type" pagetitle: "Explore MailBoxFunctions for Efficient Email Handling" metadesc: "Explore how MailBoxFunctions streamlines email data retrieval for improved workflow efficiency and clarity. Discover examples and detailed instructions." noindex: false -order: 5.42 +order: 5.44 page_id: "mailboxfunctions-function-type" warning: false contextual_links: @@ -70,7 +70,7 @@ Before utilising the different data generator functions, it's essential to under 4. Select **MailboxFunctions** from the **Function Type** dropdown list. ![select number function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/mailboxfuntions_functiontype_dg.gif) [[info | NOTE:]] -| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. +| This action will display a list of built-in functions associated with the MailboxFunctions function type, enabling you to select the appropriate function based on your requirements. --- diff --git a/src/pages/docs/test-data/data-generators/name-function-type.md b/src/pages/docs/test-data/data-generators/name-function-type.md index 6cafdc84..13fd718f 100644 --- a/src/pages/docs/test-data/data-generators/name-function-type.md +++ b/src/pages/docs/test-data/data-generators/name-function-type.md @@ -3,7 +3,7 @@ title: "Name Function Type" pagetitle: "Generate Random Names Easily with Data Generators" metadesc: "Name function in Testsigma data generators allows you to create realistic random names effortlessly. Learn how to use Name and its functions in Testsigma." noindex: false -order: 5.33 +order: 5.45 page_id: "name-function-type" warning: false contextual_links: diff --git a/src/pages/docs/test-data/data-generators/namefunctions-function-type.md b/src/pages/docs/test-data/data-generators/namefunctions-function-type.md new file mode 100644 index 00000000..c4a4a11a --- /dev/null +++ b/src/pages/docs/test-data/data-generators/namefunctions-function-type.md @@ -0,0 +1,95 @@ +--- +title: "NameFunctions Function Type" +pagetitle: "NameFunctions: Generate Unique Alphanumeric Usernames" +metadesc: "NameFunctions lets you generate unique, random alphanumeric usernames. It’s useful for creating distinct user identifiers and varied name data." +noindex: false +order: 5.46 +page_id: "namefunctions-function-type" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Selecting NameFunctions as a Function Type for Data Generator" + url: "#selecting-namefunctions-as-a-function-type-for-data-generator" +- type: link + name: "Username" + url: "#username" +--- + +--- + +NameFunctions Function Type in data generators helps you create usernames. It provides unique and random data, offering a wide variety of name-related information for your applications. + +--- + +## **Prerequisites** + +Before utilising the different data generator functions, it's essential to understand basic concepts such as creating [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#create-test-case) and [Test Steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/) and [adding data generators](https://testsigma.com/docs/test-data/types/data-generator/#add-data-generators-in-test-steps) in test steps. + +--- + +## **Selecting NameFunctions as a Function Type for Data Generator** + +1. Use **NLP** to create a **new step** in the test case and include a placeholder for **test data**. +2. Click on the **test data** placeholder. From the **Test Data Types** dropdown menu, select the **! Data Generator** option. +3. On the **! Data Generators** overlay screen, select the **Type** to **Default**. This will enable you to use a collection of built-in test data generators. +4. Select **NameFunctions** from the **Function Type** dropdown list. ![select namefunctions function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/namefunctions_functiontype_dg.gif) + +[[info | NOTE:]] +| This action will display a list of built-in functions associated with the NameFunctions function type, enabling you to select the appropriate function based on your requirements. + +--- + +## **Username** + +- Allows you to generate unique, random alphanumeric usernames. +- It helps create distinct user identifiers and varied name data. + + + +
+
+ ℹ️Example: +
+
    +
  • Input: None (This function does not require any specific input)
  • +
  • Output:
  • +
      +
    • JohnDoe123
    • +
    • JaneSmith_xyz
    • +
    • MichaelJohnson001
    • +
    • EmilyBrown!@#
    • +
    +
+
+ + +--- diff --git a/src/pages/docs/test-data/data-generators/number-function-type.md b/src/pages/docs/test-data/data-generators/number-function-type.md index eb012270..03ab8828 100644 --- a/src/pages/docs/test-data/data-generators/number-function-type.md +++ b/src/pages/docs/test-data/data-generators/number-function-type.md @@ -3,7 +3,7 @@ title: "Number Function Type" pagetitle: "Generate Random Numbers and Digits | Data Generator Function" metadesc: "Explore efficient data generator functions for seamlessly creating random numbers, digits, and decimals in diverse applications and scenarios." noindex: false -order: 5.41 +order: 5.47 page_id: "number-function-type" warning: false contextual_links: @@ -61,7 +61,7 @@ Before utilising the different data generator functions, it's essential to under 4. Select **Number** from the **Function Type** dropdown list. ![select number function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/number_functiontype_dg.gif) [[info | NOTE:]] -| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. +| This action will display a list of built-in functions associated with the Number function type, enabling you to select the appropriate function based on your requirements. --- @@ -114,19 +114,19 @@ Before utilising the different data generator functions, it's essential to under - min: 1, max: 100 + min: 1,
max: 100 73 - min: 10, max: 50 + min: 10,
max: 50 32 - min: 100, max: 500 + min: 100,
max: 500 418 - min: 5, max: 20 + min: 5,
max: 20 15 @@ -292,19 +292,19 @@ Before utilising the different data generator functions, it's essential to under - Digits: 5, Boolean: True + Digits: 5,
Boolean: True 39485 - Digits: 4, Boolean: False + Digits: 4,
Boolean: False -3276 - Digits: 3, Boolean: True + Digits: 3,
Boolean: True 821 - Digits: 6, Boolean: False + Digits: 6,
Boolean: False -491257 @@ -410,25 +410,25 @@ Before utilising the different data generator functions, it's essential to under - - + + - + - + - + - + @@ -480,25 +480,25 @@ Before utilising the different data generator functions, it's essential to under
InputOutputInputsOutputs
Max No of Decimals: 2, Min: 1.5, Max: 5.5Max No of Decimals: 2,
Min: 1.5,
Max: 5.5
3.47
Max No of Decimals: 3, Min: 10.1, Max: 20.5Max No of Decimals: 3,
Min: 10.1,
Max: 20.5
15.234
Max No of Decimals: 1, Min: 100.0, Max: 200.0Max No of Decimals: 1,
Min: 100.0,
Max: 200.0
145.7
Max No of Decimals: 4, Min: 0.1, Max: 1.0Max No of Decimals: 4,
Min: 0.1,
Max: 1.0
0.7564
- - + + - + - + - + - + diff --git a/src/pages/docs/test-data/data-generators/numberfunctions-function-type.md b/src/pages/docs/test-data/data-generators/numberfunctions-function-type.md new file mode 100644 index 00000000..51af0d06 --- /dev/null +++ b/src/pages/docs/test-data/data-generators/numberfunctions-function-type.md @@ -0,0 +1,122 @@ +--- +title: "NumberFunctions Function Type" +pagetitle: "NumberFunctions Type: Generate Random Numbers Easily" +metadesc: "NumberFunctions Type lets you perform various mathematical operations and generate unique, random numbers, aiding diverse data generation needs." +noindex: false +order: 5.48 +page_id: "numberfunctions-function-type" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Selecting NumberFunctions as a Function Type for Data Generator" + url: "#selecting-numberfunctions-as-a-function-type-for-data-generator" +- type: link + name: "Custom Calculation" + url: "#custom-calculations" +--- + +--- + +NumberFunctions function type allows you to perform mathematical operations on numerical data. It enables you to generate unique and random numbers through various functions, such as custom calculations, sequences, and random values. This type helps you create diverse data sets with numerical results. + +--- + +## **Prerequisites** + +Before utilising the different data generator functions, it's essential to understand basic concepts such as creating [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#create-test-case) and [Test Steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/) and [adding data generators](https://testsigma.com/docs/test-data/types/data-generator/#add-data-generators-in-test-steps) in test steps. + +--- + +## **Selecting NumberFunctions as a Function Type for Data Generator** + +1. Use **NLP** to create a **new step** in the test case and include a placeholder for **test data**. +2. Click on the **test data** placeholder. From the **Test Data Types** dropdown menu, select the **! Data Generator** option. +3. On the **! Data Generators** overlay screen, select the **Type** to **Default**. This will enable you to use a collection of built-in test data generators. +4. Select **NumberFunctions** from the **Function Type** dropdown list. ![select numberfunctions function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/numberfunctions_functiontype_dg.gif) + +[[info | NOTE:]] +| This action will display a list of built-in functions associated with the NumberFunctions function type, enabling you to select the appropriate function based on your requirements. + +--- + +## **Custom Calculation** + +- Allows you to perform mathematical operations based on a given expression. +- You can use various test data types to create dynamic calculations, such as plain text, parameters, runtime, and environment variables. + + + +
+
+ ℹ️Examples: +
+
InputOutputInputsOutputs
Count: 3Count: 3 593
Count: 5Count: 5 48291
Count: 2Count: 2 47
Count: 6Count: 6 384719
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
Test data: 12+820
Test data: @|param1| * @|param2| (eg: @|param1| = 6 and @|param2| = 4)24
Test data: $|runtimeValue|-15 (eg: runtimeValue = 40)25
Test data: 35+1550
+ + + +--- + diff --git a/src/pages/docs/test-data/data-generators/phone-function-type.md b/src/pages/docs/test-data/data-generators/phone-function-type.md new file mode 100644 index 00000000..a301b505 --- /dev/null +++ b/src/pages/docs/test-data/data-generators/phone-function-type.md @@ -0,0 +1,148 @@ +--- +title: "Phone Number Function Type" +pagetitle: "Phone Number Function: Generate Random Contact Numbers" +metadesc: "Phone Number Function generates random phone numbers for various applications. Ideal for testing contact forms, databases, and user profiles." +noindex: false +order: 5.49 +page_id: "phone-number-function-type" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Selecting Phone Number as a Function Type for Data Generator" + url: "#selecting-phone-number-as-a-function-type-for-data-generator" +- type: link + name: "Cell Phone" + url: "#cellphone" +- type: link + name: "Phone Number" + url: "#phonenumber" +--- + +--- + +Phone Number Function Type allows you to generate random, realistic phone numbers for. It includes functions that generate cell numbers and phone numbers for both landline and mobile use. This function type ensures that your applications have varied and random phone number data. + +--- + +## **Prerequisites** + +Before utilising the different data generator functions, it's essential to understand basic concepts such as creating [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#create-test-case) and [Test Steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/) and [adding data generators](https://testsigma.com/docs/test-data/types/data-generator/#add-data-generators-in-test-steps) in test steps. + +--- + +## **Selecting Phone Number as a Function Type for Data Generator** + +1. Use **NLP** to create a **new step** in the test case and include a placeholder for **test data**. +2. Click on the **test data** placeholder. From the **Test Data Types** dropdown menu, select the **! Data Generator** option. +3. On the **! Data Generators** overlay screen, select the **Type** to **Default**. This will enable you to use a collection of built-in test data generators. +4. Select **Phone Number** from the **Function Type** dropdown list. ![select phone number function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/phonenumber_functiontype_dg.gif) + +[[info | NOTE:]] +| This action will display a list of built-in functions associated with the Phone Number function type, enabling you to select the appropriate function based on your requirements. + +--- + +## **Cell Phone** + +- Enables you to generate random cell phone numbers. +- It formats the generated phone numbers to match typical cell phone number patterns, ensuring they appear realistic. + + + +
+
+ ℹ️Example: +
+
    +
  • Input: None (This function does not require any specific input)
  • +
  • Output:
  • +
      +
    • (820) 332-7751
    • +
    • +1 555-123-4567
    • +
    • +61 412 345 678
    • +
    • +1-909-047-5395
    • +
    +
+
+ + +--- + +## **Phone Number** + +- Allows you to generate random phone numbers. +- It is helpful for testing contact forms, databases, and user profiles with random phone number data. + + + +
+
+ ℹ️Example: +
+
    +
  • Input: None (This function does not require any specific input)
  • +
  • Output:
  • +
      +
    • 483.497.7780
    • +
    • +1 212-555-7890
    • +
    • 1-677-575-0974 x4290
    • +
    • 1-106-694-1031 x4038
    • +
    +
+
+ +---- + diff --git a/src/pages/docs/test-data/data-generators/phonenumberfunctions-function-type.md b/src/pages/docs/test-data/data-generators/phonenumberfunctions-function-type.md new file mode 100644 index 00000000..9ef1c39f --- /dev/null +++ b/src/pages/docs/test-data/data-generators/phonenumberfunctions-function-type.md @@ -0,0 +1,136 @@ +--- +title: "PhoneNumberFunctions Function Type" +pagetitle: "Generate and Validate OTP with PhoneNumberFunctions" +metadesc: "PhoneNumberFunctions enables you to generate OTPs for phone numbers and validate them during registration or login, ensuring secure and accurate verification." +noindex: false +order: 5.50 +page_id: "phonenumberfunctions-function-type" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Selecting PhoneNumberFunctions as a Function Type for Data Generator" + url: "#selecting-phonenumberfunctions-as-a-function-type-for-data-generator" +- type: link + name: "Get OTP" + url: "#get-otp" +--- + +--- + +Phone Number Function Type in data generators allows you to generate valid phone numbers for testing applications, forms, or databases that require phone number fields. It helps ensure that they validate user interactions that require phone numbers. + +--- + +## **Prerequisites** + +Before utilising the different data generator functions, it's essential to understand basic concepts such as creating [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#create-test-case) and [Test Steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/) and [adding data generators](https://testsigma.com/docs/test-data/types/data-generator/#add-data-generators-in-test-steps) in test steps. + +--- + +## **Selecting PhoneNumberFunctions as a Function Type for Data Generator** + +1. Use **NLP** to create a **new step** in the test case and include a placeholder for **test data**. +2. Click on the **test data** placeholder. From the **Test Data Types** dropdown menu, select the **! Data Generator** option. +3. On the **! Data Generators** overlay screen, select the **Type** to **Default**. This will enable you to use a collection of built-in test data generators. +4. Select **PhoneNumberFunctions** from the **Function Type** dropdown list. ![select phonenumberfunctions function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/phonenumberfunctions_functiontype_dg.gif) + +[[info | NOTE:]] +| This action will display a list of built-in functions associated with the PhoneNumberFunctions function type, enabling you to select the appropriate function based on your requirements. + +--- + +## **Get OTP** + +- Enables you to get an OTP for phone numbers matching a specified regular expression within a set timeout. +- It is useful when you verify phone numbers during registration or login. + + + +
+
+ ℹ️Examples: +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
InputOutput
+ Regex: \d{4},,
+ Select Phone Number,
+ Timeout: 30 +
OTP: 1234
+ Regex: \d{6},
+ Select Phone Number,
+ Timeout: 600 +
654321
+ Regex: \d{4,6},
+ Select Phone Number,
+ Timeout: 120 +
OTP: 4982, 789012
+ Regex: \d{5},
+ Select Phone Number,
+ Timeout: 45 +
OTP: 45178
+
+ +---- diff --git a/src/pages/docs/test-data/data-generators/random-string-function-type.md b/src/pages/docs/test-data/data-generators/random-string-function-type.md new file mode 100644 index 00000000..a423e73f --- /dev/null +++ b/src/pages/docs/test-data/data-generators/random-string-function-type.md @@ -0,0 +1,120 @@ +--- +title: "Random String Function Type" +pagetitle: "Random String: Generate Unique Alphanumeric Usernames" +metadesc: "Phone Number Function generates random cell or phone numbers for testing contact forms, databases, and user profiles in various applications." +noindex: false +order: 5.51 +page_id: "random-string-function-type" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Selecting Random String as a Function Type for Data Generator" + url: "#selecting-namefunctions-as-a-function-type-for-data-generator" +- type: link + name: "Random String from Given Characters with Length" + url: "#random-string-from-given-characters-with-length" +--- + +--- + +NameFunctions Function Type in data generators helps you create usernames. It provides unique and random data, offering a wide variety of name-related information for your applications. + +--- + +## **Prerequisites** + +Before utilising the different data generator functions, it's essential to understand basic concepts such as creating [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#create-test-case) and [Test Steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/) and [adding data generators](https://testsigma.com/docs/test-data/types/data-generator/#add-data-generators-in-test-steps) in test steps. + +--- + +## **Selecting NameFunctions as a Function Type for Data Generator** + +1. Use **NLP** to create a **new step** in the test case and include a placeholder for **test data**. +2. Click on the **test data** placeholder. From the **Test Data Types** dropdown menu, select the **! Data Generator** option. +3. On the **! Data Generators** overlay screen, select the **Type** to **Default**. This will enable you to use a collection of built-in test data generators. +4. Select **NameFunctions** from the **Function Type** dropdown list. ![select namefunctions function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/randomstring_functiontype_dg.gif) + +[[info | NOTE:]] +| This action will display a list of built-in functions associated with the NameFunctions function type, enabling you to select the appropriate function based on your requirements. + +--- + +## **Random String from Given Characters with Length** + +- Allows you to generate a random string of a specified length using a given set of characters. +- It helps create unique and secure identifiers, passwords, or verification codes, ensuring that all data remains random and unique. + + + +
+
+ ℹ️Examples: +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
String Length: 5,
List: ['A', 'B', 'C', 'D', 'E', '1', '2', '3']
B3C1A
String Length: 8,
List: ['X', 'Y', 'Z', '1', '2', '3', '4', '5']
X2Y5Z341
String Length: 4,
List: ['a', 'b', 'c', '1', '2', '3', '!', '@']
a2@c
Input String Length: 6,
List: ['0', '1', '2', 'A', 'B', 'C', '!', '#']
C1#A20
+
+ +--- \ No newline at end of file diff --git a/src/pages/docs/test-data/data-generators/random-text-function-type.md b/src/pages/docs/test-data/data-generators/random-text-function-type.md new file mode 100644 index 00000000..78d7b71a --- /dev/null +++ b/src/pages/docs/test-data/data-generators/random-text-function-type.md @@ -0,0 +1,120 @@ +--- +title: "RandomText Function Type" +pagetitle: "Generate Random Phone Numbers for Your Applications" +metadesc: "Phone Number Function generates random cell or phone numbers for testing contact forms, databases, and user profiles in various applications." +noindex: false +order: 5.52 +page_id: "randomtext-function-type" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Selecting RandomText as a Function Type for Data Generator" + url: "#selecting-randomtext-as-a-function-type-for-data-generator" +- type: link + name: "Random Text Phrases" + url: "#random-text-phrases" +--- + +--- + +RandomText Function Type allows you to generate random text strings of specified lengths. You can use it to create placeholder content, dummy data, or random identifiers. It offers flexibility in producing variable text data for different applications. + +--- + +## **Prerequisites** + +Before utilising the different data generator functions, it's essential to understand basic concepts such as creating [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#create-test-case) and [Test Steps](https://testsigma.com/docs/test-cases/create-test-steps/overview/) and [adding data generators](https://testsigma.com/docs/test-data/types/data-generator/#add-data-generators-in-test-steps) in test steps. + +--- + +## **Selecting RandomText as a Function Type for Data Generator** + +1. Use **NLP** to create a **new step** in the test case and include a placeholder for **test data**. +2. Click on the **test data** placeholder. From the **Test Data Types** dropdown menu, select the **! Data Generator** option. +3. On the **! Data Generators** overlay screen, select the **Type** to **Default**. This will enable you to use a collection of built-in test data generators. +4. Select **RandomText** from the **Function Type** dropdown list. ![select randomtext function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/randomtext_functiontype_dg.gif) + +[[info | NOTE:]] +| This action will display a list of built-in functions associated with the RandomText function type, enabling you to select the appropriate function based on your requirements. + +--- + +## **Random Text Phrases** + +- Allows you to generate random phrases for various applications. +- It is useful for creating placeholder content, random text, or randomized text blocks for testing or development. + + + +
+
+ ℹ️Examples: +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
InputsOutputs
Length: 8kF7rB9pD
Length: 12Lm5tQv9JxK3s
Length: 6R8zQpT
Length: 15Wz4hJ7uQk9RpLf8Vb
+
+ +--- diff --git a/src/pages/docs/test-data/data-generators/stringfunctions-function-type.md b/src/pages/docs/test-data/data-generators/stringfunctions-function-type.md index bdced8b7..0fa8e1dc 100644 --- a/src/pages/docs/test-data/data-generators/stringfunctions-function-type.md +++ b/src/pages/docs/test-data/data-generators/stringfunctions-function-type.md @@ -3,7 +3,7 @@ title: "StringFunctions Function Type" pagetitle: "Transform Text Easily with StringFunctions" metadesc: "StringFunctions in Testsigma enable dynamic string manipulation, including concatenation and variable substitution, which is ideal for flexible data generation." noindex: false -order: 5.44 +order: 5.53 page_id: "stringfunctions-function-type" warning: false contextual_links: @@ -43,7 +43,7 @@ Before utilising the different data generator functions, it's essential to under 4. Select **StringFunctions** from the **Function Type** dropdown list. ![select stringfunctions function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/stringfunctions_functiontype_dg.gif) [[info | NOTE:]] -| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. +| This action will display a list of built-in functions associated with the StringFunctions function type, enabling you to select the appropriate function based on your requirements. --- diff --git a/src/pages/docs/test-data/data-generators/testdatafromprofile-function-type.md b/src/pages/docs/test-data/data-generators/testdatafromprofile-function-type.md index 54f0dd87..fa733f43 100644 --- a/src/pages/docs/test-data/data-generators/testdatafromprofile-function-type.md +++ b/src/pages/docs/test-data/data-generators/testdatafromprofile-function-type.md @@ -3,7 +3,7 @@ title: "TestDataFromProfile Function Type" pagetitle: "Generate and Manage Email Addresses with EmailFunctions" metadesc: "TestDataFromProfile function type allows you to create various email addresses with ease. Learn to generate usernames, random emails, and domain-specific emails." noindex: false -order: 5.45 +order: 5.54 page_id: "testdatafromprofile-function-type" warning: false contextual_links: @@ -43,7 +43,7 @@ Before utilising the different data generator functions, it's essential to under 4. Select **TestDataFromProfile** from the **Function Type** dropdown list. ![select testdatafromprofile function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/testdatafromprofile_functiontype_dg.gif) [[info | NOTE:]] -| This action will display a list of built-in functions associated with the Address function type, enabling you to select the appropriate function based on your requirements. +| This action will display a list of built-in functions associated with the TestDataFromProfile function type, enabling you to select the appropriate function based on your requirements. --- diff --git a/src/pages/docs/test-data/types/environment.md b/src/pages/docs/test-data/types/environment.md index 56a61daf..34e15610 100644 --- a/src/pages/docs/test-data/types/environment.md +++ b/src/pages/docs/test-data/types/environment.md @@ -21,6 +21,12 @@ contextual_links: - type: link name: "Environment Variables" url: "#environment-variables" +- type: link + name: "Add Keys & Values to all Environments Globally" + url: "#add-keys--values-to-all-environments-globally" +- type: link + name: "Use Environment Variables to Select Test Data Values" + url: "#use-environment-variables-to-select-test-data-values" --- --- @@ -119,6 +125,17 @@ Testsigma also automates the creation of new and updated keys across all environ [[info | **NOTE**:]] | Some existing users may notice some empty values in their Environment list. This happens as we have curated your Environment list into a master list. The empty values indicate that the corresponding Environment variables were not previously part of your Environment. With the transition to a master list, these variables are added to ensure the proper usage of the Environment functionality. This change will not impact your existing test cases. +--- + +## **Use Environment Variables to Select Test Data Values** + +Environment variables can filter test data sets by name during data-driven testing. This method provides flexibility and reusability, making your test cases more adaptable to different scenarios. + +1. Create an **Environment** and add the name-value pairs that match the set names and values in your Test Data Profile. ![create environment parameter using tdp](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/create_environment_using_tdp.gif) +2. On the Test Case Details page, click the **Test Case Settings** icon in the right navigation bar. +3. Select the **Test Data Profile** from the dropdown menu to associate it with the test case. Enable the **Data-Driven** toggle. ![enable data driven to use environment parameter](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/enable_data_driven_env.gif) +4. Choose **Parameters** as the **Filter type**. Select **Equals**, **Contains**, **Starts with** or **Ends with** as the **Comparison Metric** from the dropdown menu. Choose **Parameter Set Name** from the dropdown. +5. Type *| to open the Environment overlay and choose the **Environment Parameter Name** to add the filters. ![use environment variables to select test data values](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/use_environment_choose_test_data_values.gif) +6. When you run the test case, it will execute using the specified filters. ---- \ No newline at end of file From df86330adb1a7c056a273c480973c2109c0804ae Mon Sep 17 00:00:00 2001 From: Sangith Ravichandran <119392848+sangithravichandran@users.noreply.github.com> Date: Tue, 23 Jul 2024 10:22:20 +0530 Subject: [PATCH 7/7] Updated Data Generators - 1 (#457) --- .../data-generators/address-function-type.md | 88 ++++++++--------- .../change-data-type-function-type.md | 15 ++- .../datefunctions-function-type.md | 94 +++++++++---------- .../emailfunctions-function-type.md | 16 ++-- .../mailboxaliasfunctions-function-type.md | 92 +++++++++--------- .../mailboxfunctions-function-type.md | 72 +++++++------- .../data-generators/number-function-type.md | 24 ++--- .../phonenumberfunctions-function-type.md | 16 ++-- .../random-string-function-type.md | 8 +- .../stringfunctions-function-type.md | 2 +- .../testdatafromprofile-function-type.md | 8 +- 11 files changed, 212 insertions(+), 223 deletions(-) diff --git a/src/pages/docs/test-data/data-generators/address-function-type.md b/src/pages/docs/test-data/data-generators/address-function-type.md index 22764f44..2c5cb93c 100644 --- a/src/pages/docs/test-data/data-generators/address-function-type.md +++ b/src/pages/docs/test-data/data-generators/address-function-type.md @@ -136,8 +136,8 @@ Before utilising the different data generator functions, it's essential to under ℹ️Example:
    -
  • Input: None (This function does not require any specific input)
  • -
  • Output:
  • +
  • Inputs: None (This function does not require any specific input)
  • +
  • Outputs:
    • Willow
    • Cedar
    • @@ -184,8 +184,8 @@ Before utilising the different data generator functions, it's essential to under ℹ️Example:
        -
      • Input: None (This function does not require any specific input)
      • -
      • Output:
      • +
      • Inputs: None (This function does not require any specific input)
      • +
      • Outputs:
        • 1234
        • 567
        • @@ -233,23 +233,23 @@ Before utilising the different data generator functions, it's essential to under
          - - + + - + - + - + - +
          InputOutputInputsOutputs
          Secondary Address: TrueSecondary Address: True 456 Oak Street, Apt. 12
          Secondary Address: TrueSecondary Address: True 789 Pine Avenue, Suite 5B
          Secondary Address: FalseSecondary Address: False 456 Oak Street
          Secondary Address: FalseSecondary Address: False 789 Pine Avenue
          @@ -292,8 +292,8 @@ Before utilising the different data generator functions, it's essential to under ℹ️Example:
            -
          • Input: None (This function does not require any specific input)
          • -
          • Output:
          • +
          • Inputs: None (This function does not require any specific input)
          • +
          • Outputs:
            • Apt. 12
            • Suite 5B
            • @@ -340,8 +340,8 @@ Before utilising the different data generator functions, it's essential to under ℹ️Example:
                -
              • Input: None (This function does not require any specific input)
              • -
              • Output:
              • +
              • Inputs: None (This function does not require any specific input)
              • +
              • Outputs:
                • 12345
                • 67890
                • @@ -401,8 +401,8 @@ Before utilising the different data generator functions, it's essential to under
                  - - + + @@ -460,8 +460,8 @@ Before utilising the different data generator functions, it's essential to under ℹ️Example:
                    -
                  • Input: None (This function does not require any specific input)
                  • -
                  • Output:
                  • +
                  • Inputs: None (This function does not require any specific input)
                  • +
                  • Outputs:
                    • Street
                    • Avenue
                    • @@ -508,8 +508,8 @@ Before utilising the different data generator functions, it's essential to under ℹ️Example:
                        -
                      • Input: None (This function does not require any specific input)
                      • -
                      • Output:
                      • +
                      • Inputs: None (This function does not require any specific input)
                      • +
                      • Outputs:
                        • North
                        • South
                        • @@ -556,8 +556,8 @@ Before utilising the different data generator functions, it's essential to under ℹ️Example:
                            -
                          • Input: None (This function does not require any specific input)
                          • -
                          • Output:
                          • +
                          • Inputs: None (This function does not require any specific input)
                          • +
                          • Outputs:
                            • Heights
                            • Village
                            • @@ -604,8 +604,8 @@ Before utilising the different data generator functions, it's essential to under ℹ️Example:
                                -
                              • Input: None (This function does not require any specific input)
                              • -
                              • Output:
                              • +
                              • Inputs: None (This function does not require any specific input)
                              • +
                              • Outputs:
                                • North
                                • East
                                • @@ -652,8 +652,8 @@ Before utilising the different data generator functions, it's essential to under ℹ️Example:
                                    -
                                  • Input: None (This function does not require any specific input)
                                  • -
                                  • Output:
                                  • +
                                  • Inputs: None (This function does not require any specific input)
                                  • +
                                  • Outputs:
                                    • New York
                                    • Los Angeles
                                    • @@ -700,8 +700,8 @@ Before utilising the different data generator functions, it's essential to under ℹ️Example:
                                        -
                                      • Input: None (This function does not require any specific input)
                                      • -
                                      • Output:
                                      • +
                                      • Inputs: None (This function does not require any specific input)
                                      • +
                                      • Outputs:
                                        • California
                                        • Texas
                                        • @@ -748,8 +748,8 @@ Before utilising the different data generator functions, it's essential to under ℹ️Example:
                                            -
                                          • Input: None (This function does not require any specific input)
                                          • -
                                          • Output:
                                          • +
                                          • Inputs: None (This function does not require any specific input)
                                          • +
                                          • Outputs:
                                            • CA
                                            • TX
                                            • @@ -796,8 +796,8 @@ Before utilising the different data generator functions, it's essential to under ℹ️Example:
                                                -
                                              • Input: None (This function does not require any specific input)
                                              • -
                                              • Output:
                                              • +
                                              • Inputs: None (This function does not require any specific input)
                                              • +
                                              • Outputs:
                                                • 34.0522
                                                • 40.7128
                                                • @@ -844,8 +844,8 @@ Before utilising the different data generator functions, it's essential to under ℹ️Example:
                                                    -
                                                  • Input: None (This function does not require any specific input)
                                                  • -
                                                  • Output:
                                                  • +
                                                  • Inputs: None (This function does not require any specific input)
                                                  • +
                                                  • Outputs:
                                                    • 118.2437
                                                    • 74.0060
                                                    • @@ -892,8 +892,8 @@ Before utilising the different data generator functions, it's essential to under ℹ️Example:
                                                        -
                                                      • Input: None (This function does not require any specific input)
                                                      • -
                                                      • Output:
                                                      • +
                                                      • Inputs: None (This function does not require any specific input)
                                                      • +
                                                      • Outputs:
                                                        • Asia/Baku
                                                        • Africa/Lagos
                                                        • @@ -940,8 +940,8 @@ Before utilising the different data generator functions, it's essential to under ℹ️Example:
                                                            -
                                                          • Input: None (This function does not require any specific input)
                                                          • -
                                                          • Output:
                                                          • +
                                                          • Inputs: None (This function does not require any specific input)
                                                          • +
                                                          • Outputs:
                                                            • United States
                                                            • Canada
                                                            • @@ -988,8 +988,8 @@ Before utilising the different data generator functions, it's essential to under ℹ️Example:
                                                                -
                                                              • Input: None (This function does not require any specific input)
                                                              • -
                                                              • Output:
                                                              • +
                                                              • Inputs: None (This function does not require any specific input)
                                                              • +
                                                              • Outputs:
                                                                • US
                                                                • CA
                                                                • @@ -1036,8 +1036,8 @@ Before utilising the different data generator functions, it's essential to under ℹ️Example:
                                                                    -
                                                                  • Input: None (This function does not require any specific input)
                                                                  • -
                                                                  • Output:
                                                                  • +
                                                                  • Inputs: None (This function does not require any specific input)
                                                                  • +
                                                                  • Outputs:
                                                                    • 123
                                                                    • 789
                                                                    • @@ -1084,8 +1084,8 @@ Before utilising the different data generator functions, it's essential to under ℹ️Example:
                                                                        -
                                                                      • Input: None (This function does not require any specific input)
                                                                      • -
                                                                      • Output:
                                                                      • +
                                                                      • Inputs: None (This function does not require any specific input)
                                                                      • +
                                                                      • Outputs:
                                                                        • 456 Oak Street, Los Angeles, CA 90001
                                                                        • 789 Pine Avenue, New York, NY 10001
                                                                        • diff --git a/src/pages/docs/test-data/data-generators/change-data-type-function-type.md b/src/pages/docs/test-data/data-generators/change-data-type-function-type.md index d35e0142..413164ad 100644 --- a/src/pages/docs/test-data/data-generators/change-data-type-function-type.md +++ b/src/pages/docs/test-data/data-generators/change-data-type-function-type.md @@ -22,7 +22,7 @@ contextual_links: --- -ChangeDataType function lets you convert data from one type to another, ensuring compatibility for different operations or storage needs. It can transform data formats, such as converting strings into numbers or booleans for calculations or logical operations. +Change Data Type function allows you to transform an input value into a specified data type. It can transform data for calculations, logical operations, or display purposes, ensuring seamless integration with different processes. --- @@ -44,10 +44,9 @@ Before utilising the different data generator functions, it's essential to under --- -## **ConvertInputDataType** +## **Convert Input Data Type** -- Allows you to convert a given input value to a specified data type. -- It is useful when data compatibility is essential, such as when you transform strings to numerical values for calculations, convert strings to booleans for logical operations, or change numerical values to strings for display purposes. +- Allows you to transform an input value into a specified data type.
                  Input: State AbbreviationOutput: Zip CodeInputs: State AbbreviationOutputs: Zip Code
                  CA