Merge pull request #1113 from Ishavyas9/main

LambdaTest Docs updates

Author: Ishavyas9

assets/images/hyperexecute/knowledge-base/reports/karate-reports.png

@@ -14,6 +14,9 @@ site_name: LambdaTest
 slug: advanced-tunnel-features/
 ---
 
+import CodeBlock from '@theme/CodeBlock';
+import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys";
+
 <script type="application/ld+json"
       dangerouslySetInnerHTML={{ __html: JSON.stringify({
        "@context": "https://schema.org",
@@ -38,11 +41,6 @@ slug: advanced-tunnel-features/
     }}
 ></script>
 
-import CodeBlock from '@theme/CodeBlock';
-import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys";
-
----
-
 **LambdaTest Tunnel** feature allows you to test your **private server URLs** or **locally hosted web-apps** or **websites** on **3000+** real browsers through LambdaTest. However, sometimes corporate firewalls and proxy settings may have restricted you to leverage the LambdaTest Tunnel binary. Not anymore though, as we’ve come up with a new binary for LambdaTest Tunnel. LambdaTest Tunnel follows various protocols such as **Web Socket, HTTPS, SSH(Secure Shell)** etc. to help you establish a secure and unique tunnel connection between your system and LambdaTest cloud servers.
 
 You can download the **LambdaTest Tunnel binary** that will help you establish a secure connection through corporate firewalls between your computer and [LambdaTest](https://www.lambdatest.com/) cloud servers for a testing locally hosted website or web-applications. You can test plain **HTML, CSS, PHP, Python** or other similar web files saved on your local system, over combinations of operating systems, browsers, and screen resolutions that are available on LambdaTest.
@@ -55,9 +53,6 @@ You can download the **LambdaTest Tunnel binary** that will help you establish a
 | [FreeBSD](https://downloads.lambdatest.com/tunnel/v3/freebsd/64bit/LT_Freebsd.zip) |
 
 ## Executing LambdaTest Tunnel for Client Connection
-
----
-
 After you download the zip file for your operating system, extract it in a folder and open you command line there. Once you have your terminal routed to the correct directory where the LambdaTest Tunnel binary file is placed, you need to execute the below command.
 
 ```bash title="Format"
@@ -85,27 +80,15 @@ Once you execute the command, you will successfully establish a client connectio
 <img loading="lazy" src={require('../assets/images/lambda-tunnel-for-corporate-firewalls/test-using-lambda-tunnel.webp').default} alt="Advanced LambdaTest Tunnel" width="970" height="313" className="doc_img"/>
 
 ## What Makes The New LambdaTest Tunnel Binary Special?
-
----
-
 Well, other than the fact that you can now establish a connection through your corporate firewalls with the new LambdaTest Tunnel binary. Here are a couple things to top it off -
 
 ### Auto Update Functionality
-
----
-
 Earlier, for every version update in out LambdaTest Tunnel, you were compelled to download the latest binary from our platform and over write it over the outdated version in your computer. Well, now this new binary will take care of that. Every time you execute this binary, it will check for the **latest** version available and will update itself **automatically**, in case it gets outdated.
 
 ### Default Port 443
-
----
-
 Now, by default, everything will run over the **port 443** to ensure a secure web browser communication through **http protocol** over **TLS/SSL**.
 
 ### Leverage `.lt.yaml` file
-
----
-
 With this new LambdaTest Tunnel binary, you can declare your LambdaTest authentication credentials in a **YAML** file configuration and keep it in the same directory as the **LT binary file**. That way, you won’t have to pass the environment variables in the cmd every time you wish to configure the LambdaTest Tunnel. Once you specify these variables in the `.lt.yaml file`, you will just have to execute the binary file through cmd **LT.exe** and the YAML file will automatically configure a secure LambdaTest Tunnel connection by auto detecting the variables specified in the YAML file.
 
 <img loading="lazy" src={require('../assets/images/lambda-tunnel-for-corporate-firewalls/lt-yaml-file.webp').default} alt="Advanced LambdaTest Tunnel" width="978" height="239" className="doc_img"/>
@@ -122,7 +105,7 @@ TunnelName: LambdaTest
 
 Similarly, you can go ahead and pass any other variables by just specifying them in the YAML file. For example, if you wish to have verbose variable passed on for detailed logs while the binary is being configured. You will add the verbose flag in your YAML file:
 
-```
+```yaml
 User: salmank
 Key: 123456789abcdefghijklmnopqrstuv
 TunnelName: LambdaTest
@@ -134,9 +117,6 @@ Now, when you trigger the binary file through cmd. You will have your verbose lo
 <img loading="lazy" src={require('../assets/images/lambda-tunnel-for-corporate-firewalls/automatic-verbose-logs.webp').default} alt="Advanced LambdaTest Tunnel" width="1359" height="639" className="doc_img"/>
 
 ### Local Testing By MITM (Man-In-The-Middle)
-
----
-
 The **MITM(Man-in-the-middle)** mode enables you to test websites using self-signed certificates on your local system or internal network. It happens very often that you may try to test a website on the localhost which may not have valid SSL certificates before the website is made live. In such cases, you may receive the below error.
 
 <img loading="lazy" src={require('../assets/images/lambda-tunnel-for-corporate-firewalls/Local-Testing-By-MITM.webp').default} alt="Advanced LambdaTest Tunnel" width="1266" height="657" className="doc_img"/>
@@ -150,9 +130,6 @@ Here is a screenshot of the same website that was throwing an error earlier but
 <img loading="lazy" src={require('../assets/images/lambda-tunnel-for-corporate-firewalls/test-using-mitm-mode.webp').default} alt="Advanced LambdaTest Tunnel" width="1069" height="687" className="doc_img"/>
 
 ### Using The Tunnel InfoAPIs
-
----
-
 By using the tunnel **Info APIs**, you can fetch the current status of the tunnel and can use it to stop the tunnel. You can fetch the current tunnel status using the Info API on the tunnel. Suppose the **InfoAPI** is available on the host over port **8000**, then use the below command to infuse the **InfoAPI** in the tunnel.
 
 ```bash
@@ -177,10 +154,22 @@ curl -X DELETE http://127.0.0.1:8000/api/v1.0/stop
 
 <img loading="lazy" src={require('../assets/images/lambda-tunnel-for-corporate-firewalls/stop-current-tunnel.webp').default} alt="Advanced LambdaTest Tunnel" width="1365" height="223" className="doc_img"/>
 
-## AllowHost In Tunnel
+### Tunnel Logs
+The --log-level flag in the LambdaTest CLI is used to specify the desired log level for tunnel logs. This feature enables users to control the verbosity of logs generated during tunnel operations, making it easier to debug or monitor activities as needed.
 
----
+```bash
+--log-level YOUR_LOG_LEVEL
+```
+
+#### Supported Log Levels:
+- **info :** Provides informational messages about the general operation of the tunnel.
+- **warn :** Highlights potential issues that might not immediately affect functionality but require attention.
+- **debug :** Outputs detailed logs, including diagnostic information, for troubleshooting purposes.
+- **error :** Displays error messages when something goes wrong in the tunnel operation.
+- **fatal :** Shows critical issues that cause the tunnel to terminate unexpectedly.
 
+
+## AllowHost In Tunnel
 With the latest tunnel binary release we have introduced the capability to provide the domains which will be resolved from tunnel binary and the rest of the urls will be resolved from our servers. This can speed up the execution of test as the latency will be reduced by transferring data from the tunnel client. You may also use this to restrict the traffic flowing from user’s network.
 
 **Usage:**
@@ -197,9 +186,6 @@ LT  --user <username> --key <accessKey> –allowHosts google.com,apple.com,amazo
 When this flag is used only requests for provided domains will be routed via tunnel and resolved from the user's network. Requests for domains other than mentioned will be resolved from Lambdatest’s network.
 
 ## Tunnel Arguments
-
----
-
 You can find all the arguments for LambdaTest Tunnel by running the below command in your command line:
 
 ```bash

docs/advanced-tunnel-features.md

@@ -100,4 +100,7 @@ The [Error Categorization Report](/support/docs/error-categorization-report/) re
 - Downloadable data for thorough analysis and resolution.
 
 ## JUnit XML Report
-The [JUnit XML Report](/support/docs/junit-xml-report/) provides a summary of test results conducted on [Date and Time]. The tests are organized into multiple test suites, with detailed information on execution time, status, and individual test cases.
+The [JUnit XML Report](/support/docs/junit-xml-report/) provides a summary of test results conducted on [Date and Time]. The tests are organized into multiple test suites, with detailed information on execution time, status, and individual test cases.
+
+## Karate Report
+[Karate Reports](/support/docs/karate-report/) provide a comprehensive overview of your test execution results, offering detailed insights into test performance, coverage, and failures. With visually appealing and interactive HTML reports, you can quickly analyze test outcomes, debug issues, and share results across teams. These reports are seamlessly integrated into Karate's powerful testing framework, ensuring clarity and efficiency in your test automation journey.

docs/hyperexecute-job-reports.md

@@ -0,0 +1,57 @@
+---
+id: karate-report
+title: Karate Report
+hide_title: false
+sidebar_label: Karate
+description: Streamline error analysis with the Error Categorization Report. Identify patterns in test failures to enhance quality and efficiency in your testing process.
+keywords:
+  - cucumber testing reports
+  - karate report lambdatest 
+url: https://www.lambdatest.com/support/docs/karate-report/
+site_name: LambdaTest
+slug: karate-report/
+---
+<script type="application/ld+json"
+      dangerouslySetInnerHTML={{ __html: JSON.stringify({
+       "@context": "https://schema.org",
+        "@type": "BreadcrumbList",
+        "itemListElement": [{
+          "@type": "ListItem",
+          "position": 1,
+          "name": "LambdaTest",
+          "item": "https://www.lambdatest.com"
+        },{
+          "@type": "ListItem",
+          "position": 2,
+          "name": "Support",
+          "item": "https://www.lambdatest.com/support/docs/"
+        },{
+          "@type": "ListItem",
+          "position": 3,
+          "name": "Karate Report",
+          "item": "https://www.lambdatest.com/support/docs/karate-report/"
+        }]
+      })
+    }}
+></script>
+Karate framework supports generating detailed test execution reports that help visualize test results and insights. On HyperExecute, you can run your Karate tests and configure it to generate and download these reports seamlessly.
+
+> Ensure your project is configured with the **Karate framework** and all test scripts are in place.
+
+## Steps to Generate Karate Reports on HyperExecute
+
+**Step 1:** Configure all the necessary dependencies and configurations to your project.
+
+**Step 2:** Configure the report parameters in the HyperExecute YAML file.
+
+```yaml
+report: true
+partialReports:
+    location: target
+    type: html
+    frameworkName: karate
+```
+
+**Step 3:** Now execute your job by triggering the HyperExecute CLI. You can visit the HyperExecute dashboard to download the report after job completion.
+
+<img loading="lazy" src={require('../assets/images/hyperexecute/knowledge-base/reports/karate-reports.png').default} alt="Image" className="doc_img"/> 

docs/karate-report.md

@@ -39,10 +39,11 @@ slug: lambdatest-selenium-advance-capabilities/
 
 | Key | Values | Capability Description  | Default Value | Alias | Value Type | Example | Possible Errors |
 |-----|--------|-------------------------|---------------|-------|------------|---------|-----------------|
-| `video` | true, false | By default, the video is set as true. This capability helps in video recording of the complete screen while the test gets executed. You can record maximum up to 10 minutes. In case you need to turn off the video recording, you can do so by turning off the button on our Desired Capabilities Generator. <br/>If you turn the video flag off, then for Java, it may provide the below piece of code in the capabilities class.    <br/>`capabilities.setCapability("video",false);` | TRUE | |Boolean |`capabilities.setCapability(""video"",false);` |Case Sensitive <br />Unable to generate video <br/>Video is not playing in video player |
-| `visual` | true, false | Command by command screenshots will be recorded at each test step. By default the flag is set as off. <br/>**Note:** test execution time will increase if it’s set as ‘true’.  <br/>`capabilities.setCapability("visual",true)`;|FALSE |debug |Boolean |`capabilities.setCapability(""visual"",true);` |Case sensitive <br />Unable to generate screenshot   <br/>Screenshot is broken |
-| `network` |true, false | Captures a recording for network packets while the test gets executed. By default, the network flag is set as false. <br/>**Note**: test execution time will increase if it’s set as ‘true’.  <br/>`capabilities.setCapability("network",true)`; <br />     | FALSE |networkLogs |Boolean |`capabilities.setCapability(""network"",true);` |Case sensitive <br />Network logs not supported|
-| `console` | true, false | JavaScript logs will be recorded for the test. By default, it is set as false. <br/>**Note:** test execution time will increase if it’s set as ‘true’.   <br/>`capabilities.setCapability("console",true)```; | FALSE |Capture browser console errors |String |Javascript logs will be recorded for the test. By default, it is set as false. `capabilities.setCapability("console","disable");` |Case Sensitive <br/>No error found <br />Not supported on this browser |
-| `tunnel` | true, false | To test your locally hosted web application with Lambda Tunnel, which establishes an SSH(Secure Shell) connection between your system and our cloud servers. By default, the tunnel flag, will be set as false.  <br/>`capabilities.setCapability("tunnel",true);` <br/>Find more about Lambda Tunnel from our documentation to test on  [locally hosted web applications.](/docs/testing-locally-hosted-pages/)   | FALSE |local |Boolean |`capabilities.setCapability("tunnel",true);`<br/> Find more about LambdaTest Tunnel from our documentation to test on locally hosted web applications. |Case Sensitive <br/>Tunnel not running |
+| `video` | Boolean | By default, the video is set as true. This capability helps in video recording of the complete screen while the test gets executed. You can record maximum up to 10 minutes. In case you need to turn off the video recording, you can do so by turning off the button on our Desired Capabilities Generator. <br/>If you turn the video flag off, then for Java, it may provide the below piece of code in the capabilities class.    <br/>`capabilities.setCapability("video",false);` | TRUE | |Boolean |`capabilities.setCapability(""video"",false);` |Case Sensitive <br />Unable to generate video <br/>Video is not playing in video player |
+| `visual` | Boolean | Command by command screenshots will be recorded at each test step. By default the flag is set as off. <br/>**Note:** test execution time will increase if it’s set as ‘true’.  <br/>`capabilities.setCapability("visual",true)`;|FALSE |debug |Boolean |`capabilities.setCapability(""visual"",true);` |Case sensitive <br />Unable to generate screenshot   <br/>Screenshot is broken |
+| `network` |Boolean | Captures a recording for network packets while the test gets executed. By default, the network flag is set as false. <br/>**Note**: test execution time will increase if it’s set as ‘true’.  <br/>`capabilities.setCapability("network",true)`; <br />     | FALSE |networkLogs |Boolean |`capabilities.setCapability(""network"",true);` |Case sensitive <br />Network logs not supported|
+| `console` | Boolean | JavaScript logs will be recorded for the test. By default, it is set as false. <br/>**Note:** test execution time will increase if it’s set as ‘true’.   <br/>`capabilities.setCapability("console",true)```; | FALSE |Capture browser console errors |String |Javascript logs will be recorded for the test. By default, it is set as false. `capabilities.setCapability("console","disable");` |Case Sensitive <br/>No error found <br />Not supported on this browser |
+| `tunnel` | Boolean| To test your locally hosted web application with Lambda Tunnel, which establishes an SSH(Secure Shell) connection between your system and our cloud servers. By default, the tunnel flag, will be set as false.  <br/>`capabilities.setCapability("tunnel",true);` <br/>Find more about Lambda Tunnel from our documentation to test on  [locally hosted web applications.](/docs/testing-locally-hosted-pages/)   | FALSE |local |Boolean |`capabilities.setCapability("tunnel",true);`<br/> Find more about LambdaTest Tunnel from our documentation to test on locally hosted web applications. |Case Sensitive <br/>Tunnel not running |
 | `tunnelName` | Your desire tunnel name | To provide the tunnel identifier in your test suite capability when user wants to execute the test through a particular tunnel  <br/>`capabilities.setCapability("tunnelName","your desire tunnel name")`;| |localName |String |`capabilities.setCapability("tunnelName","your desire tunnel name");` |Case Sensitive   <br/>Tunnel not running   <br />Tunnel Name not exists |
-| `timezone` | Example: UTC+07:00 | Represents the custom timezone you select for executing a test. <br/>`capabilities.setCapability("timezone","UTC+07:00")`; | UTC+00:00| |String |`capabilities.setCapability("timezone","UTC+07:00");` |Case sensitive <br/> Timezone not supported by OS <br />Timezone is different |
+| `timezone` | Example: UTC+07:00 | Represents the custom timezone you select for executing a test. <br/>`capabilities.setCapability("timezone","UTC+07:00")`; | UTC+00:00| |String |`capabilities.setCapability("timezone","UTC+07:00");` |Case sensitive <br/> Timezone not supported by OS <br />Timezone is different |
+| `verboseWebDriverLogging` | Boolean | To enable detailed Selenium logs to debug issues of your application using detailed insights including command execution, communication with the browser, and responses. <br />`capabilities.setCapability("verboseWebDriverLogging", true)` | FALSE |

docs/lambdatest-selenium-advance-capabilities.md

@@ -152,9 +152,9 @@ The Upload and Download Files feature allows you to manage files directly within
 
 | File Type | Supported Formats | Maximum File Size |
 |-----------|-------------------|-------------------|
-| Image | JPG, JPEG, PNG, GIF, BMP | 15 MB |
+| Image | JPG, JPEG, PNG, GIF, BMP, DCM, STL, SIF | 15 MB |
 | Video | MP4, MOV, 3GP | 15 MB |
-| Non-media | XLS, XLSX, DOC, DOCX, PDF, CSV, TXT, PPT, Contacts | 15 MB |
+| Non-media | XLS, XLSX, DOC, DOCX, PDF, CSV, TXT, PPT, Contacts, Zip, CER, PFX | 15 MB |
 
 </TabItem>
 <TabItem value="download" label="Downloading Files" default>

docs/real-time-upload-and-download-files.md

@@ -118,6 +118,13 @@ If you are testing a server that requires IP whitelisting, then you just have to
 
 `http://ts.lambdatest.com/`<br />
 
+- 199.58.84.59
+- 23.82.88.184
+- 23.106.34.219
+- 23.106.54.77
+
+:::note
+Below are IPs that will be deprecated soon
 - 3.214.241.254
 - 52.36.84.247
 - 13.126.37.58

docs/troubleshooting-lambda-tunnel.md

@@ -780,7 +780,8 @@ module.exports = {
               "specflow-report",
               "cypress-mochaawesome-report",
               "error-categorization-report",
-              "junit-xml-report"
+              "junit-xml-report",
+              "karate-report"
             ],
           },