Added integration documentation

ing-bank · Aug 19, 2024 · 5a05ef7 · 5a05ef7
1 parent 7ededbd
commit 5a05ef7
Show file tree

Hide file tree

Showing 33 changed files with 293 additions and 569 deletions.
diff --git a/docs/bdd.md b/docs/bdd.md
@@ -1,8 +1,3 @@
----
-icon: material/handshake
----
-
-
 # **Behavior Driven Development (BDD)** 
 -------------------------------------------
 
@@ -14,13 +9,13 @@ icon: material/handshake
 
 ## BDD Editor
 
-The framework comes with a BDD editor that lets user to **create/edit** feature files. These feature files can then be imported/converted into automation test cases. The **BDD editor** has a provision of auto suggesting the keywords that can be used while writing feature files. Perform **Ctrl+Space** anywhere in the BDD editor workspace to get the list of keywords supported by the BDD editor.
+The framework comes with a BDD editor that lets user to **create/edit** feature files. These feature files can then be imported/converted into automation test cases. The **BDD editor** has a provision of auto suggesting the keywords that can be used while writing feature files. Perform ++ctrl+space++ anywhere in the BDD editor workspace to get the list of keywords supported by the BDD editor.
 
 ---------------------------------------------- 
 
 ## Create/Edit Feature Files With BDD Editor
 
- * [x] From the INGenious IDE, navigate to **Tools** > **BDD** > **Open Feature Editor** and the editor opens in a new window
+ * [x] From the INGenious IDE, navigate to **Tools** :material-arrow-right: **BDD** :material-arrow-right: **Open Feature Editor** and the editor opens in a new window
 
  * [x] Create a new project by clicking on **New Project** option, you can also open an existing project **(This is a Mandatory step)**
 
@@ -31,18 +26,18 @@ The framework comes with a BDD editor that lets user to **create/edit** feature
  ![featurecreation](img/bdd/createfeaturefile.gif "featurecreation")
 
 
->> **Note:** Projects created from BDD editor are saved as **json** files and internally **Gherkin** language is used to create feature files.
+> **Note:** Projects created from BDD editor are saved as **json** files and internally **Gherkin** language is used to create feature files.
 
         
->> It is also possible to open an existing feature file in the BDD editor using the **down arrow** icon and edit the same and save.
+> It is also possible to open an existing feature file in the BDD editor using the **down arrow** icon and edit the same and save.
 
 ----------------------------------------------        
 
 ## Import A Feature File
 
 In order to translate the feature files into an automation scenario, follow the steps below :
 
- * [x] Navigate to **Tools** > **BDD** > **Import Feature file**
+ * [x] Navigate to **Tools** :material-arrow-right: **BDD** :material-arrow-right: **Import Feature file**
 
  * [x] Locate the feature file and click on **OK**
 
@@ -55,7 +50,7 @@ In order to translate the feature files into an automation scenario, follow the
 
  * [x] The corresponding steps can then be automated accordingly either through Recording or otherwise
 
->> **Note:** Any feature written in Gherkin language can be opened from the **Import Feature file** , even if it is not created using the **BDD editor**.
+> **Note:** Any feature written in Gherkin language can be opened from the **Import Feature file** , even if it is not created using the **BDD editor**.
 
 
 ----------------------------------------------
@@ -64,7 +59,7 @@ In order to translate the feature files into an automation scenario, follow the
 
 In order to generate BDD Style Reporting post execution, from the Run Settings, make sure **Bdd Reporting** checkbox is checked.
 
- ![checkbox](img/bdd/4.JPG "checkbox")
+ ![checkbox](img/bdd/4.png "checkbox")
 
 
 This will generate **bdd-report.json** file post execution and this json file can then be fed to Azure DevOps Yaml Task to generate BDD Style Reporting.
@@ -79,7 +74,7 @@ For this we need to use the following Yaml commands :
     outputPath: '$(System.DefaultWorkingDirectory)'
     theme: 'bootstrap'
     reportSuiteAsScenarios: true
-    name: 'ING'
+    name: 'Contact Us Form'
     title: 'BDD Results'
 
 ```

diff --git a/docs/browsertesting/playwrightmocking.md b/docs/browsertesting/playwrightmocking.md
@@ -45,7 +45,7 @@ In INGenious Playwright Studio, the steps will look like this :
 
  The data in the payload can be parameterized from datasheets as well.
 
- >>The built-in mocking actions can be found [here](../playwrightActions/fulfill.md)
+ >The built-in mocking actions can be found [here](../playwrightActions/fulfill.md)
 
 -------------------------------- 
 

diff --git a/docs/browsertesting/playwrightreporting.md b/docs/browsertesting/playwrightreporting.md
@@ -1,59 +1,55 @@
 # **Playwright | Report Analysis** 
 -------------------------------------------
 
-<span style="color:Green">The following are the **built-in capabilities** within the framework to perform report analysis for Playwright-Java tests, in addition to the already available reporting in INGenious</span>
+!!! info "Additional Reporting and Debugging Capabilities"
+
+    The following are the **built-in capabilities** within the framework to perform report analysis for Playwright-Java tests, in addition to the already available reporting in INGenious
 
 --------------------------------------------
 
-## Tracing
+??? example "Tracing"
 
+    ## Tracing
 
-<summary>How it works</summary>
 
-From INGenious you can generate traces for all playwright tests that are being executed. You can do this from the **Run Settings** :
+    From INGenious you can generate traces for all playwright tests that are being executed. You can do this from the **Run Settings**
 
- ![trace1](../img/reports/trace1.JPG "trace1")
+    ![trace1](../img/reports/trace.png "trace1")
 
-When you do this, the traces are saved in the `Results` location of the corresponding tests.
+    When you do this, the traces are saved in the `Results` location of the corresponding tests.
 
-Traces are a great way for debugging your tests. You can open the saved trace using the following options :
+    Traces are a great way for debugging your tests. You can open the saved trace using the following options :
 
-* On your browser on `trace.playwright.dev` [**This is not recommended in ING as your tests contain details about you ING applications**]
-* Using Playwright CLI . Make sure to add the full path to where your `trace.zip` file is located. This should include the full path to your `trace.zip` file.
+    * On your browser on `trace.playwright.dev` [**This is not recommended in ING as your tests contain details about you ING applications**]
+    * Using Playwright CLI . Make sure to add the full path to where your `trace.zip` file is located. This should include the full path to your `trace.zip` file.
 
-```shell
-mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="show-trace <full/path/to/trace.zip>"
-```
+    ```{.shell .copy}
+    mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="show-trace <full/path/to/trace.zip>"
+    ```
 
 
 
+??? example "Videos"
 
+    ## Videos
 
-## Videos
-
-
-<summary>How it works</summary>
-
-From INGenious you can generate videos for all playwright tests that are being executed. You can do this from the **Run Settings** :
-
- ![videos](../img/reports/videos.JPG "videos")
-
-When you do this, the videos are saved in the `Results` location of the corresponding tests.
-
+    From INGenious you can generate videos for all playwright tests that are being executed. You can do this from the **Run Settings**
 
+    ![videos](../img/reports/video.png "videos")
 
+    When you do this, the videos are saved in the `Results` location of the corresponding tests.
 
 
-## HAR files
 
 
-<summary>How it works</summary>
+??? example "HAR files"
+    ## HAR files
 
-From INGenious you can generate **HAR (Http Archive)** files for all playwright tests that are being executed. You can do this from the **Run Settings** :
+    From INGenious you can generate **HAR (Http Archive)** files for all playwright tests that are being executed. You can do this from the **Run Settings**
 
- ![har](../img/reports/har.JPG "har")
+    ![har](../img/reports/har.png "har")
 
-When you do this, the HAR files are saved in the `Results` location of the corresponding tests.
+    When you do this, the HAR files are saved in the `Results` location of the corresponding tests.