`sendPress` Masks the press method of the ElementHandle and Locator class.
`setHTTPCredentials` Masks the HTTP credentials parameter in the newContext and newPage method of the browser class.
`setStorageState` Masks the storage state parameter in the newContext and newPage method of the browser class
`setGeolocation` Masks the Geolocation parameter in the newContext and newPage method of the browser class.|`const capability = { "LT:Options": {'lambdaMaskCommands': ["sendType", "sendFill", "sendPress", "setHTTPCredentials", "setStorageState", "setGeolocation"]}}`
| -| useSpecificBundleVersion | Boolean | If set **`true`:** LambdaTest will select the playwright server version as per the browser version you have passed in the capabilities. Check the [supported browser version list](/support/docs/playwright-test-execution-setup/#playwright-supported-browsers).
If the value set in the `browser version` capability is supported by multiple Playwright versions, LambdaTest checks your Playwright client version and sets the Playwright version accordingly.
If set **`false` :** LambdaTest will run your playwright tests with the same version as setup in your local system and the browser version will also be used the compatible one as per the [supported browser version list](/support/docs/playwright-test-execution-setup/#playwright-supported-browsers) and not your defined one. | `const capabilities = { "LT:Options": {"useSpecificBundleVersion": true,}}` | - - - +| useSpecificBundleVersion | Boolean | If set **`true`:** LambdaTest will select the playwright server version as per the browser version you have passed in the capabilities. Check the [supported browser version list](/support/docs/playwright-test-execution-setup/#playwright-supported-browsers).
If the value set in the `browser version` capability is supported by multiple Playwright versions, LambdaTest checks your Playwright client version and sets the Playwright version accordingly.
If set **`false` :** LambdaTest will run your playwright tests with the same version as setup in your local system and the browser version will also be used the compatible one as per the [supported browser version list](/support/docs/playwright-test-execution-setup/#playwright-supported-browsers) and not your defined one. | `const capability = { "LT:Options": {"useSpecificBundleVersion": true,}}` | +| lambdaSetBrowserPosition | | The `lambdaSetBrowserPosition` function is designed to arrange two browser windows on the screen, ensuring each occupies exactly half of the available screen space. This layout facilitates side-by-side browser comparisons or multitasking workflows.
OS Supported - Windows
Browsers supported : Chrome, Microsoft Edge , pw-chroium, pw-webkit & pw-firefox | `const capability = {action: 'lambdaSetBrowserPosition',}` | \ No newline at end of file diff --git a/docs/playwright-lighthouse library.md b/docs/playwright-lighthouse library.md index ebb640f53..d93164518 100644 --- a/docs/playwright-lighthouse library.md +++ b/docs/playwright-lighthouse library.md @@ -1,7 +1,7 @@ --- id: playwright-lighthouse-library -title: How to Generate Lighthouse Reports With Playwright Lighthouse Library -hide_title: true +title: Generate Lighthouse Reports With Playwright Lighthouse Library +hide_title: false sidebar_label: Playwright Lighthouse Library description: Learn how to generate multiple Lighthouse reports using Playwright Lighthouse Library. keywords: @@ -13,6 +13,11 @@ site_name: LambdaTest slug: playwright-lighthouse-library/ --- +import CodeBlock from '@theme/CodeBlock'; +import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys"; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +A Lighthouse Report is a performance, accessibility, SEO, and best practices evaluation report generated using [Google Lighthouse](https://developers.google.com/web/tools/lighthouse), an open-source, automated tool developed by Google. It is commonly used to assess and optimize the quality of web pages. +LambdaTest lets you perform Playwright automation while allowing you to generate Lighthouse reports with Playwright Lighthouse Library in a single test. -# Generating Lighthouse Reports With Playwright Lighthouse Library ---- +> Lighthouse Report is supported on **Chrome**, **MicrosoftEdge** and **Chromium** browsers. -LambdaTest lets you perform Playwright automation while allowing you to generate Lighthouse reports with Playwright Lighthouse Library in a single test. +:::tip Sample repository +The code sample for generating the Lighthouse Performance Metrics in the Playwright test can be found on **LambdaTest's GitHub Repository**. You can either download or clone the repository to quickly run your tests.
.default}){kind=icon}
View on GitHub
+:::
## Prerequisites
----
+- Ensure that you have the Playwright Lighthouse Library installed in your web project.
+ ```bash
+ npm install playwright-lighthouse
+ ```
+
+- Export the *LIGHTHOUSE_LAMBDATEST* environment variable to your project environment.
+ ```bash
+ export LIGHTHOUSE_LAMBDATEST='true'
+ ```
+
+## Write your Test Script
+:::info
+Generating lighthouse report within the test might increase the test duration. It is advisable to generate the lighthouse reports only in the required tests.
+:::
+
+You can easily add the Lighthouse Performance Metrics of the website you want to test by using the `lighthouseReport` action via the test. Following is the code snippet for generating Lighthouse report from the Playwright if you are using JavaScript:
+```js title="playwright-lighthouse-report.js"
+await page.evaluate(_ => {}, `lambdatest_action: ${JSON.stringify({
+ action: 'lighthouseReport',
+ arguments: { url: 'https://www.example.com' }
+})}`)
+```
-You can generate Lighthouse reports on LambdaTest platform while executing Playwright tests with the following steps.
+### For Authenticated Pages
+> This feature is only supported on **Windows** and **macOS** platforms.
-1. Ensure that you have the Playwright Lighthouse Library installed in your web project.
+The feature allows you to generate Lighthouse reports for authenticated web pages using Playwright. This is particularly useful for testing performance, accessibility, SEO, and other quality metrics for pages that require authentication. By leveraging authentication tokens, you can analyze restricted pages in your Playwright tests on both **Windows** and **macOS** environments.
-```bash
-npm install playwright-lighthouse
+
+
+ {`export LT_USERNAME=${ YOUR_LAMBDATEST_USERNAME()}
+export LT_ACCESS_KEY=${ YOUR_LAMBDATEST_ACCESS_KEY()}`}
+
+
+
+
+
+ {`set LT_USERNAME=${ YOUR_LAMBDATEST_USERNAME()}
+set LT_ACCESS_KEY=${ YOUR_LAMBDATEST_ACCESS_KEY()}`}
+
+
+
+.default})
+.default})
diff --git a/docs/playwright-lighthouse-performance-metrics.md b/docs/playwright-lighthouse-performance-metrics.md
deleted file mode 100644
index 8206b4944..000000000
--- a/docs/playwright-lighthouse-performance-metrics.md
+++ /dev/null
@@ -1,144 +0,0 @@
----
-id: playwright-lighthouse-performance-metrics
-title: How To View Lighthouse Performance Metrics in Playwright
-hide_title: true
-sidebar_label: Lighthouse Performance Metrics
-description: Guide to view Lighthouse Performance metrics of a website using Playwright. View the Lighthouse audits, scores, metrics, and much more.
-keywords:
- - lighthouse performance
- - lighthouse performance management
- - google lighthouse performance
- - google lighthouse performance score
- - lighthouse partners performance
- - lighthouse performance metrics
- - lighthouse performance score
- - lighthouse performance testing
- - lighthouse web performance
- - lighthouse website performance
- - google lighthouse performance audit
- - google lighthouse performance test
- - google's own lighthouse for performance accessibility and seo ratings
- - how is lighthouse performance score calculated
- - lighthouse audit for performance
- - lighthouse check performance
- - LambdaTest automation
- - playwright
- - playwright online
- - online playwright automation
- - playwright automation online
- - LambdaTest playwright automation
- - playwright tutorial
- - Playwright getting started
- - lambdatest getting started
-url: https://www.lambdatest.com/support/docs/playwright-lighthouse-performance-metrics/
-site_name: LambdaTest
-slug: playwright-lighthouse-performance-metrics/
----
-
-
-
-# View Lighthouse Performance Metrics Using Playwright
-* * *
-
-LambdaTest now integrates [**Lighthouse**](https://developers.google.com/web/tools/lighthouse) to view the performance metrics (**Lighthouse Audits**) while running Playwright tests on the LambdaTest cloud. You can now view the scores of:
-
-* **Performance**,
-* **Accessibility**,
-* **Best Practices**,
-* **SEO**
-* **Progressive Web App**
-
-metrics with the help of LambdaTest.
-
-:::tip Sample repository
-The code sample for generating the Lighthouse Performance Metrics in the Playwright test can be found on **LambdaTest's GitHub Repository**. You can either download or clone the repository to quickly run your tests. View on GitHub
-:::
-
-## Prerequisites
-
-* * *
-
-You will need a [LambdaTest account](https://accounts.lambdatest.com/login) to run your Playwright tests. Use your:
-
-* LambdaTest Username
-* LambdaTest Access Key
-
-to run your tests on LambdaTest and view the **Lighthouse Performance Metrics**. You can obtain these credentials from the [LambdaTest Automation Dashboard](https://automation.lambdatest.com/build) or through [LambdaTest Profile](https://accounts.lambdatest.com/login).
-
-## How to Include Lighthouse Performance Metrics in Playwright Automation?
-
-* * *
-
-You can easily add the Lighthouse Performance Metrics of the website you want to test by executing the `lighthouseReport` action via the test.
-As of now, LambdaTest supports **Lighthouse** on Chrome, MicrosoftEdge and Chromium browsers.
-Following is the code snippet for generating Lighthouse report from the Playwright if you are using JavaScript:
-```js
-await page.evaluate(_ => {}, `lambdatest_action: ${JSON.stringify({
- action: 'lighthouseReport',
- arguments: { url: 'https://www.example.com' }
-})}`)
-```
-
-> **Note:** Generating lighthouse report within the test might increase the test duration. It is advisable to generate the lighthouse reports only in the required tests.
-
-## How to View Lighthouse Performance Metrics on LambdaTest?
-***
-Once you have run your Playwright automation tests on LambdaTest platform, you can view the Lighthouse Performance Metrics on the website under test.
-
-Follow the below steps to view the **Lighthouse Performance Metrics** on LambdaTest platform:
-
-**1.** Go to the [Automation Dashboard](https://automation.lambdatest.com). Here you can see your recently executed Playwright automation tests. For this demo purpose, we have used a sample Playwright JS script, from this [GitHub repository](https://github.com/LambdaTest/playwright-sample/blob/main/playwright-lighthouse-report.js).
-
-**2.** Open the test where you executed the lighthouse command and click on the **Performance** tab.
-
-.default})
-
-**3.** You can see the Lighthouse Performance Metrics on your screen now, for the URL requested. For example, in the below image, the lighthouse report is generated for [https://login.live.com](https://login.live.com).
-
-.default})
-
-Similarly, you can click on any of the performance reports to view it in detail. Performance reports can also be downloaded in various formats. Not only this, but LambdaTest also helps you view the Passed Audits, individual metrics, detailed diagnosis, and improvement opportunities about that particular Lighthouse Audit.
-
-* * *
-
-That's it folks! That's all about the Lighthouse Performance Metrics with LambdaTest. You can read more about the Lighthouse Audits and Performance Metrics from [web.dev](https://web.dev/lighthouse-performance/) page. If you have any doubt or questions, feel free to contact our experts at window.openLTChatWidget()}>**24/7 chat support** or mail us at [support@lambdatest.com](mailto:support@lambdatest.com). Happy testing! :)
-
-
diff --git a/docs/sharding-xcui.md b/docs/sharding-xcui.md
index e08f97ab5..541c25715 100644
--- a/docs/sharding-xcui.md
+++ b/docs/sharding-xcui.md
@@ -258,11 +258,9 @@ You can refer to this example and screenshot below:
:::
## Filters in Sharding
-
You can filter the Classes / Tests that you'd like to execute using filters.
Here's an example of the same.
-
```java
filters:
attributes:
@@ -271,31 +269,23 @@ filters:
- type: testName
values: ["LambdaUiKitIOSUITests/testverifyAppLaunch"]
```
-
This example will run only the 2 classes & one test as mentioned from the TestSuite.
-## Additional Links
+## XCTestPlan in Sharding
+To implement the XCTestPlan in Sharding, add the `xctestplan` flag along with `app` and `testSuite` in the [framework](https://www.lambdatest.com/support/docs/hyperexecute-yaml-version0.2/#framework) flag as shown below:
----
+```yaml
+framework:
+ name: "ios/xcui"
+ args:
+ "app" : "lt://APP_ID",
+ "testSuite": "lt://TEST_SUITE_ID",
+ "xctestplan" : "lt://YOUR_XC_TEST_PLAN_ID" #only when you want to use XCTestPlan
+```
+> Refer the documentation to learn how to use [XCTestPlan feature](/support/docs/xctestplan/).
+
+## Additional Links
- [Advanced Configuration for Capabilities](https://www.lambdatest.com/support/docs/desired-capabilities-in-appium/)
- [How to test locally hosted apps](https://www.lambdatest.com/support/docs/testing-locally-hosted-pages/)
- [How to integrate LambdaTest with CI/CD](https://www.lambdatest.com/support/docs/integrations-with-ci-cd-tools/)
-
-
diff --git a/docs/xctestplan.md b/docs/xctestplan.md
index 4f508d152..2fb0e04a7 100644
--- a/docs/xctestplan.md
+++ b/docs/xctestplan.md
@@ -193,16 +193,14 @@ Take note of the base64 encoded authentication which needs to be added in the
-
-
-```bash
+```yaml
curl --location --request POST 'https://mobile-api.lambdatest.com/framework/v1/xcui/build' \
--header 'Authorization: Basic BASIC_AUTH_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
- "app" : "APP_ID",
- "testSuite": "TEST_SUITE_ID",
+ "app" : "lt://APP_ID",
+ "testSuite": "lt://TEST_SUITE_ID",
+ "xctestplan" : "lt://YOUR_XC_TEST_PLAN_ID" #only when you want to use XCTestPlan
"device" : ["iPhone 11-14"],
"video" : true,
"queueTimeout": 10800,
@@ -213,23 +211,18 @@ curl --location --request POST 'https://mobile-api.lambdatest.com/framework/v1/x
}'
```
-
-
-
-
-
-```bash
+```yaml
curl --location --request POST "https://mobile-api.lambdatest.com/framework/v1/xcui/build" \
--header "Authorization: Basic BASIC_AUTH_TOKEN" \
--header "Content-Type: application/json" \
--data-raw "{
- "app" : "APP_ID",
- "testSuite": "TEST_SUITE_ID",
+ "app" : "lt://APP_ID",
+ "testSuite": "lt://TEST_SUITE_ID",
+ "xctestplan" : "lt://YOUR_XC_TEST_PLAN_ID" #only when you want to use XCTestPlan
"device" : ["iPhone 11-14"],
"video" : true,
"queueTimeout": 10800,
@@ -239,9 +232,6 @@ curl --location --request POST "https://mobile-api.lambdatest.com/framework/v1/x
"build" : "Proverbial-XCUITest"
}"
```
-
-
-