From 5ed065ca28237ead4932d1a8b8127a624accca1e Mon Sep 17 00:00:00 2001 From: Bharath Krishna <118433150+bharathk08@users.noreply.github.com> Date: Fri, 4 Oct 2024 16:59:20 +0530 Subject: [PATCH] Added a new doc for Folder Structure (#518) Added a new doc for folder structure and updated Mobile Test Steps & Windows Adv Intro docs. --- src/left-nav-title.json | 3 +- .../docs/reports/runs/custom-pdf-report.md | 26 ++-- .../test-cases/create-test-steps/overview.md | 13 +- .../docs/test-cases/manage/add-edit-delete.md | 2 +- .../manage/features-and-scenarios.md | 116 ++++++++++++++++++ .../docs/windows-automation/introduction.md | 4 + 6 files changed, 150 insertions(+), 14 deletions(-) create mode 100644 src/pages/docs/test-cases/manage/features-and-scenarios.md diff --git a/src/left-nav-title.json b/src/left-nav-title.json index f25af2f0..f194d54e 100644 --- a/src/left-nav-title.json +++ b/src/left-nav-title.json @@ -680,5 +680,6 @@ "projects-and-applications": {"/docs/windows-lite-automation/projects-and-applications/": "Windows (Lite) Project & Application"}, "element-learning": {"/docs/windows-lite-automation/element-learning/": "Element Learning with Test Recorder"}, "test-cases": {"/docs/windows-lite-automation/test-cases/": "Test Cases for Windows (Lite)" }, - "copado-integration": {"/docs/continuous-integration/copado-integration/": "Copado CI/CD" } + "copado-integration": {"/docs/continuous-integration/copado-integration/": "Copado CI/CD" }, + "features-and-scenarios": {"/docs/test-cases/manage/features-and-scenarios/": "Features & Scenarios" } } \ No newline at end of file diff --git a/src/pages/docs/reports/runs/custom-pdf-report.md b/src/pages/docs/reports/runs/custom-pdf-report.md index 989ace67..52c9215d 100644 --- a/src/pages/docs/reports/runs/custom-pdf-report.md +++ b/src/pages/docs/reports/runs/custom-pdf-report.md @@ -70,19 +70,23 @@ To generate reports, you need specific IDs depending on the level of detail you Run the Custom Report Generator with the required inputs to create a PDF report. This step converts your HTML template into a PDF based on your preferences. To execute the JAR file, follow these steps: 1. Open Terminal or Command Prompt and navigate to the folder containing the JAR file. -2. Run the following command, replacing the placeholders with your actual values: - -```bash -java -jar custom_pdf_generator-0.0.1-SNAPSHOT.jar \ - --config.apiKey=YOUR-API-KEY \ - --config.plan.runId=YOUR-PLAN-RUN-ID \ - --config.template.location=/path/to/your/template.html \ - --config.pdf.directory=/path/to/save/report.pdf -``` - +2. Run the following command,
+ - **For Mac** + ```bash + java -jar custom_pdf_generator-0.0.1-SNAPSHOT.jar \ + --config.apiKey=YOUR-API-KEY \ + --config.plan.runId=YOUR-PLAN-RUN-ID \ + --config.template.location=/path/to/your/template.html \ + --config.pdf.directory=/path/to/save/report.pdf + ``` + + - **For Windows** + ```bash + java -jar custom_pdf_generator-0.0.1-SNAPSHOT.jar --config.apiKey= --config.plan.runId=97040 --config.template.location=/path/to/template.html --config.pdf.directory=/path/to/save/report.pdf + ```
-Replace the placeholders with your actual values: +Replace the placeholders with your actual values: - **YOUR-API-KEY**: Your API key for authentication with Testsigma. - **YOUR-PLAN-RUN-ID**: The run ID of your test plan. - **/path/to/your/template.html**: Path to your HTML template file. 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 5fb5f7f5..8ac6a401 100644 --- a/src/pages/docs/test-cases/create-test-steps/overview.md +++ b/src/pages/docs/test-cases/create-test-steps/overview.md @@ -175,11 +175,22 @@ Here's a sample GIF demonstrating creating test steps manually for a Web Applica
+
+

+ + ⚡ New: You can now directly interact with mobile elements, and the recorder will automatically capture the action and convert it into the corresponding NLPs. +

+
+ +[[info | **NOTE**:]] +| If direct recording doesn't work, revert to the old method and use the **TAP** button to record the element. + +
+ Here's a sample GIF demonstrating creating test steps using the recorder for a Web Application. ![Record Test Steps for WebApps](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/RecordStepswappsWF.gif) ---- --- 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 fd4afd6c..e15f0951 100644 --- a/src/pages/docs/test-cases/manage/add-edit-delete.md +++ b/src/pages/docs/test-cases/manage/add-edit-delete.md @@ -3,7 +3,7 @@ title: "Manage Test Cases" pagetitle: "Manage Test Cases" metadesc: "Effortlessly manage your test cases in Testsigma by seamlessly creating, editing, deleting, and recovering them. Streamline your test case management process, adapt to changing project needs, and ensure comprehensive test coverage." noindex: false -order: 4.10 +order: 4.11 page_id: "test-cases-testsigma" warning: false contextual_links: diff --git a/src/pages/docs/test-cases/manage/features-and-scenarios.md b/src/pages/docs/test-cases/manage/features-and-scenarios.md new file mode 100644 index 00000000..5c839972 --- /dev/null +++ b/src/pages/docs/test-cases/manage/features-and-scenarios.md @@ -0,0 +1,116 @@ +--- +title: "Organizing Test Cases in Folders (✨ New)" +pagetitle: "Organize Test Cases" +metadesc: "Effortlessly organize test cases by features & scenarios, which provides a complete view of test coverage. The folder structure also simplifies the navigation." +noindex: false +order: 4.10 +page_id: "Folder Structure for Test Cases" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Why Do We Have Folder Structure?" + url: "#why-do-we-have-folder-structure" +- type: link + name: "Understanding Folder Structure" + url: "#understanding-folder-structure" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Steps to Create Features" + url: "#steps-to-create-features" +- type: link + name: "Steps to Create Scenarios" + url: "#steps-to-create-scenarios" +--- + +--- + +With Testsigma's new folder structure, you can organize test cases by features, which provides a comprehensive view of test coverage. Each feature will have multiple scenarios, each with its respective test cases. This structure helps manage test cases based on specific scenarios and scenarios based on Features. + +--- + +## **Why Do We Have Folder Structure?** +Introducing folder structure for test cases simplifies finding and managing tests. In large test setups, organizing tests is very important as it plays a key role in quickly locating specific test cases. This will save you much time and increase productivity. This folder structure also prevents duplication of test cases, streamlining the workflow. A well-organized folder system helps teams easily find and create test cases, improving collaboration and reducing confusion. + +--- + +## **Understanding Folder Structure** + +![Folders](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/FlowofFolders.png) + +Let's say you're creating test cases for an **Online Shopping App**. + +- In this case, you can have **User Authentication**, **Product Search**, and **Shopping Cart** as **Features** under **Test Cases**. + +- Each Feature can have multiple Scenarios like the examples mentioned below: + +📁 **Test Cases (Master Folder)** + - **User Authentication** + - Login + - Logout + - **Product Search** + - Search by Keyword + - Filter Results + - **Shopping Cart** + - Add to Cart + - Remove from Cart + +- The scenarios will have multiple test cases. In this cases, for **Login & Logout** scenarios, we can have the following test cases: + 1. **Login** + - Login with valid credentials + - Login with invalid credentials & verify error message + 2. **Logout** + - Verify successful logout + - Verify session expiration after logout + +--- + +> ## **Prerequisites** +> +> Ensure you create a [Project](https://testsigma.com/docs/projects/overview/) before creating Test Cases in Testsigma. + +--- + +## **Steps to Create Features** + +1. From the left navigation bar, go to **Create Tests > Test Cases**. + +2. Click **+** and choose **Add Feature** from the dropdown menu. + +3. In the **Add Feature** dialog, enter a name for the feature and click **Add**. + +4. The new feature will appear under the **Test Cases** section. + +Here's a quick GIF demonstrating steps to create features. + +![Features](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/FeatureFlow.gif) + +--- + +## **Steps to Create Scenarios** + +1. From the left navigation bar, go to **Create Tests > Test Cases**. + +2. Click **+** and choose **Add Scenario** from the dropdown menu. + +3. In the **Select Feature** dialog, choose the target feature and click **Next**. + +4. In the dialog box that pops up, enter a name for the scenario and click **Create**. + +5. The new scenario will appear under **Test Cases > Feature**. + +6. Click **<** to minimize the **Features & Scenarios** section. + +Here's a quick GIF demonstrating steps to create scenarios. + +![Scenarios](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ScenarioFlow.gif) + +[[info | **NOTE**:]] +| - You can click **List View** and perform list actions here. For more information, see [List Actions](https://testsigma.com/docs/test-cases/manage/list-actions/). +| - This will also help you filter test cases with **Scenarios** while creating test suites. +| ![Filter While adding Test Cases](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/FilterScenarios_TestSuites.png) + +--- \ No newline at end of file diff --git a/src/pages/docs/windows-automation/introduction.md b/src/pages/docs/windows-automation/introduction.md index c2d9dc80..dc38bdda 100644 --- a/src/pages/docs/windows-automation/introduction.md +++ b/src/pages/docs/windows-automation/introduction.md @@ -52,6 +52,10 @@ You can also quickly jump to one of the following topics to learn about Windows - List of Technologies Supported in Testsigma - **Oracle** - **Java** + - **SAP GUI** + - **SAP UI5** + - **Insight** + - **Terminal Emulator** ---