diff --git a/docs/build-options-for-visual-regression-testing.md b/docs/build-options-for-visual-regression-testing.md index 473e95d2e..3ac9e12d7 100644 --- a/docs/build-options-for-visual-regression-testing.md +++ b/docs/build-options-for-visual-regression-testing.md @@ -42,7 +42,7 @@ import TabItem from '@theme/TabItem'; "@type": "ListItem", "position": 3, "name": "Smart Visual Testing", - "item": "https://www.lambdatest.com/support/docs/smart-ui-cypress/" + "item": "https://www.lambdatest.com/support/docs/build-options-for-visual-regression-testing/" }] }) }} @@ -214,9 +214,7 @@ We are provide multiple build status options for the project owners to check the
  • - - Smart UI with Cypress - + Build Options for Visual Regression Testing
    • diff --git a/docs/kaneai-smartui-visual-testing.md b/docs/kaneai-smartui-visual-testing.md index 0458d4f22..b66a455da 100644 --- a/docs/kaneai-smartui-visual-testing.md +++ b/docs/kaneai-smartui-visual-testing.md @@ -2,7 +2,6 @@ id: kaneai-smartui-visual-testing title: Visual Test Creation with KaneAI hide_title: false -sidebar_label: Smart Visual Test Creation description: A step-by-step guide on using KaneAI to automate visual regression tests. Learn to capture screenshots, establish baselines, compare visual changes with SmartUI, and schedule automated runs. keywords: - lambdatest kaneai diff --git a/docs/playwright-visual-regression.md b/docs/playwright-visual-regression.md index ca21c5d77..96c6e89e6 100644 --- a/docs/playwright-visual-regression.md +++ b/docs/playwright-visual-regression.md @@ -46,6 +46,13 @@ set LT_USERNAME="YOUR_USERNAME" set LT_ACCESS_KEY="YOUR ACCESS KEY" ``` + + +```powershell +$env:LT_USERNAME="YOUR_USERNAME" +$env:LT_ACCESS_KEY="YOUR ACCESS KEY" +``` + The following steps will guide you in running your first Visual Regression test on LambdaTest platform - @@ -259,9 +266,7 @@ For additional information about Playwright framework please explore the documen
  • - - Getting Started with Selenium Visual Regression - + Playwright Visual Regression
    • \ No newline at end of file diff --git a/docs/selenium-visual-regression.md b/docs/selenium-visual-regression.md index fa854fc7b..1a026f85a 100644 --- a/docs/selenium-visual-regression.md +++ b/docs/selenium-visual-regression.md @@ -48,13 +48,14 @@ set LT_USERNAME="YOUR_USERNAME" set LT_ACCESS_KEY="YOUR ACCESS KEY" ``` - + -```bash -$Env:LT_USERNAME="YOUR_USERNAME" -$Env:LT_ACCESS_KEY="YOUR_ACCESS_KEY" +```powershell +$env:LT_USERNAME="YOUR_USERNAME" +$env:LT_ACCESS_KEY="YOUR ACCESS KEY" ``` + The following steps will guide you in running your first Visual Regression test on LambdaTest platform - @@ -640,7 +641,7 @@ This may take a few seconds to process the screenshot. Please ensure that you ha
  • - Getting Started with Selenium Visual Regression + Selenium Visual Regression
    • diff --git a/docs/smartui-appium-hooks.md b/docs/smartui-appium-hooks.md index 30f204aac..35a676c5a 100644 --- a/docs/smartui-appium-hooks.md +++ b/docs/smartui-appium-hooks.md @@ -73,15 +73,20 @@ Below are code examples for taking viewport screenshots using SmartUI with Appiu ```bash export LT_USERNAME="YOUR_USERNAME" -export LT_ACCESS_KEY="YOUR ACCESS KEY" ```     - + ```bash set LT_USERNAME="YOUR_USERNAME" -set LT_ACCESS_KEY="YOUR ACCESS KEY" +``` + + + + +```powershell +$env:LT_USERNAME="YOUR_USERNAME" ``` @@ -523,7 +528,7 @@ For additional information about appium framework please explore the documentati
  • - Getting Started with appium Visual Regression + SmartUI Appium Hooks
    • diff --git a/docs/smartui-appium-java-sdk.md b/docs/smartui-appium-java-sdk.md index 325d414a9..00dabe3f9 100644 --- a/docs/smartui-appium-java-sdk.md +++ b/docs/smartui-appium-java-sdk.md @@ -103,6 +103,13 @@ export PROJECT_TOKEN="123456#1234abcd-****-****-****-************" set PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` +     + + +```powershell +$env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +``` + @@ -314,7 +321,7 @@ For additional information about SmartUI APIs, please explore the documentation
  • - SmartUI App SDK + SmartUI Appium Java SDK
    • \ No newline at end of file diff --git a/docs/smartui-baseline-management.md b/docs/smartui-baseline-management.md index c46744396..a8e3605d6 100644 --- a/docs/smartui-baseline-management.md +++ b/docs/smartui-baseline-management.md @@ -104,7 +104,7 @@ npx smartui --markBaseline exec -- ```bash # 1. Set feature branch baseline npx smartui --baselineBranch "feature/new-login" exec -- - +``` ### 2. Hotfix Management diff --git a/docs/smartui-basic-auth.md b/docs/smartui-basic-auth.md index 0f2a50166..52d8ec353 100644 --- a/docs/smartui-basic-auth.md +++ b/docs/smartui-basic-auth.md @@ -36,7 +36,7 @@ import NewTag from '../src/component/newTag'; "@type": "ListItem", "position": 3, "name": "Smart Visual Testing", - "item": "https://www.lambdatest.com/support/docs/smart-ui-cypress/" + "item": "https://www.lambdatest.com/support/docs/smartui-basic-auth/" }] }) }} @@ -111,15 +111,22 @@ Then set your environment variables: ```bash export AUTH_USERNAME="your-username" -export AUTH_PASSWORD="your-password" ``` + - + ```bash set AUTH_USERNAME="your-username" -set AUTH_PASSWORD="your-password" ``` + + + + +```powershell +$env:AUTH_USERNAME="your-username" +``` + diff --git a/docs/smartui-branch-merging.md b/docs/smartui-branch-merging.md index 5926be431..a0234c86a 100644 --- a/docs/smartui-branch-merging.md +++ b/docs/smartui-branch-merging.md @@ -99,7 +99,7 @@ npx smartui merge branch --source hotfix/security-patch --target staging ```bash # 1. Ensure feature branch is approved npx smartui merge branch --source feature/new-login --target main - +``` ### 2. Hotfix Strategy diff --git a/docs/smartui-cli-build-name.md b/docs/smartui-cli-build-name.md index 6b08d6b46..767db6ca6 100644 --- a/docs/smartui-cli-build-name.md +++ b/docs/smartui-cli-build-name.md @@ -40,7 +40,7 @@ import NewTag from '../src/component/newTag'; "@type": "ListItem", "position": 3, "name": "Smart Visual Testing", - "item": "https://www.lambdatest.com/support/docs/smart-ui-cypress/" + "item": "https://www.lambdatest.com/support/docs/smartui-cli-build-name/" }] }) }} @@ -81,11 +81,12 @@ set PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` - + -```bash -$Env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +```powershell +$env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` + diff --git a/docs/smartui-cli-env-variables.md b/docs/smartui-cli-env-variables.md index 2119e50b5..eaf236eab 100644 --- a/docs/smartui-cli-env-variables.md +++ b/docs/smartui-cli-env-variables.md @@ -43,7 +43,7 @@ import NewTag from '../src/component/newTag'; "@type": "ListItem", "position": 3, "name": "Smart Visual Testing", - "item": "https://www.lambdatest.com/support/docs/smart-ui-cypress/" + "item": "https://www.lambdatest.com/support/docs/smartui-cli-env-variables/" }] }) }} @@ -65,14 +65,25 @@ export LT_USERNAME="YOUR USERNAME" export LT_ACCESS_KEY="YOUR ACCESS KEY" export PROJECT_NAME="Required Project Name" ``` + - + ```bash set LT_USERNAME="YOUR USERNAME" set LT_ACCESS_KEY="YOUR ACCESS KEY" set PROJECT_NAME="Required Project Name" ``` + + + + +```powershell +$env: LT_USERNAME="YOUR USERNAME" +$env: LT_ACCESS_KEY="YOUR ACCESS KEY" +$env: PROJECT_NAME="Required Project Name" +``` + @@ -91,12 +102,19 @@ export PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` - + ```bash set PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` + + + +```powershell +$env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +``` + @@ -114,12 +132,21 @@ Set the baseline branch for `CLI` projects: ```bash export BASELINE_BRANCH="Required branch" ``` + - + ```bash set BASELINE_BRANCH="Required branch" ``` + + + + +```powershell +$env: BASELINE_BRANCH="Required branch" +``` + @@ -133,12 +160,21 @@ Set the current branch for `CLI` projects: ```bash export CURRENT_BRANCH="Required branch" ``` + - + ```bash set CURRENT_BRANCH="Required branch" ``` + + + + +```powershell +$env: CURRENT_BRANCH="Required branch" +``` + @@ -154,14 +190,22 @@ In case you are accessing your network using corporate proxies, set the proxies ```bash export HTTP_PROXY="http://:@:/" ``` + - + ```bash set HTTP_PROXY="http://:@:/" ``` + + + +```powershell +$env: HTTP_PROXY="http://:@:/" +``` + @@ -173,12 +217,21 @@ set HTTP_PROXY="http://:@:/" ```bash export HTTPS_PROXY="https://:@:/" ``` + - + ```bash set HTTPS_PROXY="https://:@:/" ``` + + + + +```powershell +$env: HTTPS_PROXY="https://:@:/" +``` + @@ -195,12 +248,21 @@ To enable SmartUI CLI Debug mode, use the following environment variable. export LT_SDK_DEBUG=true ``` - + ```bash set LT_SDK_DEBUG=true ``` + + + +```powershell +$env: LT_SDK_DEBUG="true" +``` + + + ## 7. Ignoring captured cookies @@ -210,15 +272,23 @@ Set the following variable to true, to stop the use of cookies captured automati -```bash +```shell export SMARTUI_DO_NOT_USE_CAPTURED_COOKIES=true ``` - + -```bash +```shell set SMARTUI_DO_NOT_USE_CAPTURED_COOKIES=true ``` + + + + +```powershell +$env: SMARTUI_DO_NOT_USE_CAPTURED_COOKIES="true" +``` + @@ -235,7 +305,7 @@ set SMARTUI_DO_NOT_USE_CAPTURED_COOKIES=true
  • - Smart UI with Cypress + SmartUI Environment Variables
    • diff --git a/docs/smartui-cli-exec.md b/docs/smartui-cli-exec.md index acdf691d8..9eb6133df 100644 --- a/docs/smartui-cli-exec.md +++ b/docs/smartui-cli-exec.md @@ -133,12 +133,14 @@ set SMARTUI_SERVER_ADDRESS='http://localhost:49152' ```     - + -```bash -$Env:SMARTUI_SERVER_ADDRESS='http://localhost:49152' +```powershell +$env:SMARTUI_SERVER_ADDRESS="http://localhost:49152" ``` + + ### Step 2: Execute Your Tests diff --git a/docs/smartui-cli-figma-web.md b/docs/smartui-cli-figma-web.md index 96c346580..6ed469405 100644 --- a/docs/smartui-cli-figma-web.md +++ b/docs/smartui-cli-figma-web.md @@ -46,7 +46,7 @@ import CodeBlock from '@theme/CodeBlock'; "@type": "ListItem", "position": 3, "name": "Smart Visual Testing", - "item": "https://www.lambdatest.com/support/docs/smart-ui-cypress/" + "item": "https://www.lambdatest.com/support/docs/smartui-cli-figma-web/" }] }) }} @@ -164,12 +164,19 @@ export PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` - + ```bash set PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` + + + +```powershell +$env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +``` + @@ -183,12 +190,19 @@ export FIGMA_TOKEN="123456#1234abcd-****-****-****-************" ``` - + ```bash set FIGMA_TOKEN="123456#1234abcd-****-****-****-************" ``` + + + +```powershell +$env:FIGMA_TOKEN="123456#1234abcd-****-****-****-************" +``` + @@ -199,15 +213,20 @@ set FIGMA_TOKEN="123456#1234abcd-****-****-****-************" ```bash export LT_USERNAME="YOUR_USERNAME" -export LT_ACCESS_KEY="YOUR ACCESS KEY" ``` - + ```bash set LT_USERNAME="YOUR_USERNAME" -set LT_ACCESS_KEY="YOUR ACCESS KEY" +``` + + + + +```powershell +$env:LT_USERNAME="YOUR_USERNAME" ``` @@ -231,7 +250,7 @@ Please read the following table for more information about the configuration fil You can now execute tests for `Visual Testing for Figma objects` using the following options:. -```bash +```powershell npx smartui upload-figma-web designs.json ``` @@ -259,12 +278,19 @@ export PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` - + ```bash set PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` + + + +```powershell +$env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +``` + @@ -278,12 +304,19 @@ export FIGMA_TOKEN="123456#1234abcd-****-****-****-************" ``` - + ```bash set FIGMA_TOKEN="123456#1234abcd-****-****-****-************" ``` + + + +```powershell +$env:FIGMA_TOKEN="123456#1234abcd-****-****-****-************" +``` + @@ -319,7 +352,7 @@ You can see the Smart UI dashboard to view the results. This will help you ident
  • - Smart UI with Cypress + SmartUI Figma-Web CLI
    • diff --git a/docs/smartui-cli-figma.md b/docs/smartui-cli-figma.md index 312a5bea5..58e86d2e6 100644 --- a/docs/smartui-cli-figma.md +++ b/docs/smartui-cli-figma.md @@ -46,7 +46,7 @@ import CodeBlock from '@theme/CodeBlock'; "@type": "ListItem", "position": 3, "name": "Smart Visual Testing", - "item": "https://www.lambdatest.com/support/docs/smart-ui-cypress/" + "item": "https://www.lambdatest.com/support/docs/smartui-cli-figma/" }] }) }} @@ -141,12 +141,19 @@ export PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ```     - + ```bash set PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` + + + +```powershell +$env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +``` + @@ -160,12 +167,19 @@ export FIGMA_TOKEN="123456#1234abcd-****-****-****-************" ``` - + ```bash set FIGMA_TOKEN="123456#1234abcd-****-****-****-************" ``` + + + +```powershell +$env:FIGMA_TOKEN="123456#1234abcd-****-****-****-************" +``` + @@ -176,15 +190,20 @@ set FIGMA_TOKEN="123456#1234abcd-****-****-****-************" ```bash export LT_USERNAME="YOUR_USERNAME" -export LT_ACCESS_KEY="YOUR ACCESS KEY" ``` - + ```bash set LT_USERNAME="YOUR_USERNAME" -set LT_ACCESS_KEY="YOUR ACCESS KEY" +``` + + + + +```powershell +$env:LT_USERNAME="YOUR_USERNAME" ``` @@ -275,7 +294,7 @@ For additional information about SmartUI APIs please explore the documentation [
  • - Smart UI with Cypress + SmartUI Figma CLI
    • diff --git a/docs/smartui-cli-git-branching.md b/docs/smartui-cli-git-branching.md index d51b87fd5..b4e67f597 100644 --- a/docs/smartui-cli-git-branching.md +++ b/docs/smartui-cli-git-branching.md @@ -157,12 +157,21 @@ You can also set the Baseline branch name through your terminal by setting the f ```bash export BASELINE_BRANCH="Required baseline branch" ``` +     - + ```bash set BASELINE_BRANCH="Required baseline branch" ``` + + + + +```powershell +$env:BASELINE_BRANCH="Required baseline branch" +``` + @@ -195,7 +204,7 @@ In this workflow, if you are working on the same branch name and want to execute And, if you have created a project and set your **Baseline** branch name to `master` then executed the following commands: -```bash +```powershell // Your current branch name $ git branch * @@ -233,12 +242,21 @@ You can streamline your workflow by setting the current branch name directly thr ```bash export CURRENT_BRANCH="Required branch" ``` + - + ```bash set CURRENT_BRANCH="Required branch" ``` + + + + +```powershell +$env:CURRENT_BRANCH="Required branch" +``` + diff --git a/docs/smartui-cli-responsive-dom.md b/docs/smartui-cli-responsive-dom.md index 7b42f1166..f25d89660 100644 --- a/docs/smartui-cli-responsive-dom.md +++ b/docs/smartui-cli-responsive-dom.md @@ -114,7 +114,7 @@ Resize your viewport according to your framework and take the screenshot. For ex "@type": "ListItem", "position": 3, "name": "Smart Visual Testing", - "item": "https://www.lambdatest.com/support/docs/smart-ui-cypress/" + "item": "https://www.lambdatest.com/support/docs/smartui-cli-responsive-dom/" }] }) }} @@ -145,7 +145,7 @@ Resize your viewport according to your framework and take the screenshot. For ex
  • - Smart UI with Cypress + SmartUI Responsive DOM
    • diff --git a/docs/smartui-cli-upload.md b/docs/smartui-cli-upload.md index d6efba119..d3e5d6cbe 100644 --- a/docs/smartui-cli-upload.md +++ b/docs/smartui-cli-upload.md @@ -43,7 +43,7 @@ import NewTag from '../src/component/newTag'; "@type": "ListItem", "position": 3, "name": "Smart Visual Testing", - "item": "https://www.lambdatest.com/support/docs/smart-ui-cypress/" + "item": "https://www.lambdatest.com/support/docs/smartui-cli-upload/" }] }) }} @@ -87,12 +87,19 @@ export PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ```     - + ```bash set PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` + + + +```powershell +$env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +``` + @@ -207,7 +214,7 @@ For additional information about SmartUI APIs please explore the documentation [
  • - Smart UI with Cypress + SmartUI Upload Screenshots
    • diff --git a/docs/smartui-cli.md b/docs/smartui-cli.md index fa4ed0f92..00a3b8231 100644 --- a/docs/smartui-cli.md +++ b/docs/smartui-cli.md @@ -43,7 +43,7 @@ import NewTag from '../src/component/newTag'; "@type": "ListItem", "position": 3, "name": "Smart Visual Testing", - "item": "https://www.lambdatest.com/support/docs/smart-ui-cypress/" + "item": "https://www.lambdatest.com/support/docs/smartui-cli/" }] }) }} @@ -123,12 +123,19 @@ export PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ```     - + ```bash set PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` + + + +```powershell +$env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +``` + @@ -369,7 +376,7 @@ For additional information about SmartUI APIs please explore the documentation [
  • - Smart UI with Cypress + SmartUI CLI
    • diff --git a/docs/smartui-cypress-sdk.md b/docs/smartui-cypress-sdk.md index 27ea92929..1b8d3de7b 100644 --- a/docs/smartui-cypress-sdk.md +++ b/docs/smartui-cypress-sdk.md @@ -43,7 +43,7 @@ import NewTag from '../src/component/newTag'; "@type": "ListItem", "position": 3, "name": "Smart Visual Testing", - "item": "https://www.lambdatest.com/support/docs/smart-ui-cypress/" + "item": "https://www.lambdatest.com/support/docs/smartui-cypress-sdk/" }] }) }} @@ -130,11 +130,12 @@ set PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ```     - + -```bash -$Env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +```powershell +$env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` + @@ -429,7 +430,7 @@ For additional information about SmartUI APIs please explore the documentation [
  • - Smart UI with Cypress + SmartUI Cypress SDK
    • diff --git a/docs/smartui-k6-setup.md b/docs/smartui-k6-setup.md index 02e0c289f..e9323512a 100644 --- a/docs/smartui-k6-setup.md +++ b/docs/smartui-k6-setup.md @@ -38,18 +38,23 @@ This documentation will act as your step-by-step guide in to perform K6 test wit ```bash export LT_USERNAME="YOUR_USERNAME" -export LT_ACCESS_KEY="YOUR ACCESS KEY" ``` -     - + + ```bash set LT_USERNAME="YOUR_USERNAME" -set LT_ACCESS_KEY="YOUR ACCESS KEY" ``` + + + +```powershell +$env:LT_USERNAME="YOUR_USERNAME" +``` + The following steps will guide you in running your first Visual Regression test on LambdaTest platform - @@ -73,7 +78,7 @@ Once you have created a SmartUI Project, you can generate screenshots by running 1. Please clone the following sample Github repo (`https://github.com/LambdaTest/smartui-k6-sample`). -```bash +```powershell git clone https://github.com/LambdaTest/smartui-k6-sample.git ``` @@ -224,6 +229,8 @@ k6 run k6-smartui.js ``` + + - You can check the executed builds over at [LambdaTest SmartUI](https://smartui.lambdatest.com/). @@ -258,7 +265,7 @@ For additional information about K6 framework please explore the documentation [
  • - Getting Started with Selenium Visual Regression + SmartUI K6 Setup
    • diff --git a/docs/smartui-pdf-api-upload.md b/docs/smartui-pdf-api-upload.md new file mode 100644 index 000000000..b919b2381 --- /dev/null +++ b/docs/smartui-pdf-api-upload.md @@ -0,0 +1,117 @@ +--- +id: smartui-pdf-api-upload +title: Upload PDFs via API +sidebar_label: API Upload +description: Learn how to upload PDF files to SmartUI using the REST API for visual regression testing. +keywords: + - PDF API Upload + - SmartUI API + - Visual Regression Testing + - PDF Testing + - REST API +url: https://www.lambdatest.com/support/docs/smartui-pdf-api-upload/ +site_name: LambdaTest +slug: smartui-pdf-api-upload/ +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + +:::caution +This functionality is exclusive to our enterprise plan subscribers on SmartUI. For additional details or inquiries, please [contact us](https://www.lambdatest.com/demo). +::: + +## Prerequisites for Using Smart UI + +- Familiarity with HTTP APIs is essential. +- Visit the [`LambdaTest SmartUI`](https://smartui.lambdatest.com/) page and log in with your credentials. +- Obtain your `LT_USERNAME` and `LT_ACCESS_KEY` by clicking on the `Access Key` button, located at the top right corner of your dashboard. + +## Step 1: Establishing a SmartUI Project + +To initiate a SmartUI PDF Comparison Project, adhere to the following instructions: + +1. Navigate to the [SmartUI Projects Page](https://smartui.lambdatest.com/). +2. Tap on the `new project` button. +3. Specify your platform type as `PDF`. +4. Provide your `project` name, designate `approvers`, and add `tags` (optional). +5. Confirm your entry by clicking on **Submit**. + +Once your project is active, retrieve your `Project Token` from the application. Here's an example of a project token: + +```bash +projectToken = "123456#1234abcd-****-****-****-************" +``` + +## Uploading PDFs via API + +After setting up your SmartUI Project, you can upload your local PDF files to your project. This will automatically generate a build by capturing snapshots of every page. + +Here's how you can upload your PDFs: + +1. Retrieve your API `URL Endpoint` post activation of your enterprise plan. To schedule a demonstration, click [here](https://www.lambdatest.com/demo). + +2. Append the following parameters to your request payload via `form-body`: + +| Variable | Type | Description | Required? | +| ------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | --------- | +| projectToken | string | This token is required to upload PDF files and validate your project.
    Example: `projectToken:123456#1234abcd-****-****-****-************` | Yes | +| pathToFiles | array | Add the path to the PDFs that will be uploaded.
    Example: `pathToFiles : [ "path/to/pdf-1", "path/to/pdf-2"]` | Yes | +| buildName | string | Assign a name of your choice to the build comprising the uploaded PDFs.
    Example: `buildName : #` | No | + +:::note +Only files in `.pdf` format are compatible with this feature. +::: + +## API Request Example + +Here's a sample API request using cURL: + +```bash +curl -X POST "YOUR_API_ENDPOINT" \ + -H "Content-Type: multipart/form-data" \ + -F "projectToken=123456#1234abcd-****-****-****-************" \ + -F "pathToFiles[]=path/to/document1.pdf" \ + -F "pathToFiles[]=path/to/document2.pdf" \ + -F "buildName=Release-v2.1" +``` + +## Response Format + +The API will return a JSON response containing: + +- **Build ID**: Unique identifier for the uploaded build +- **Status**: Upload status (success/failure) +- **Pages Captured**: Number of pages processed +- **Test Results**: Visual comparison results (if available) + +## Use Cases + +- **Automated CI/CD Integration**: Seamlessly integrate PDF testing into your deployment pipeline +- **Batch Processing**: Upload multiple PDFs simultaneously for efficient testing +- **Custom Workflows**: Build custom applications that interact with SmartUI programmatically +- **Enterprise Integration**: Connect with existing enterprise systems and workflows diff --git a/docs/smartui-pdf-cli-upload.md b/docs/smartui-pdf-cli-upload.md new file mode 100644 index 000000000..1375a5500 --- /dev/null +++ b/docs/smartui-pdf-cli-upload.md @@ -0,0 +1,181 @@ +--- +id: smartui-pdf-cli-upload +title: Upload PDFs via CLI +sidebar_label: CLI Upload +description: Learn how to upload PDF files to SmartUI using the command-line interface for visual regression testing. +keywords: + - PDF CLI Upload + - SmartUI CLI + - Visual Regression Testing + - PDF Testing + - Command Line +url: https://www.lambdatest.com/support/docs/smartui-pdf-cli-upload/ +site_name: LambdaTest +slug: smartui-pdf-cli-upload/ +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys"; + + + +:::caution +This functionality is exclusive to our enterprise plan subscribers on SmartUI. For additional details or inquiries, please [contact us](https://www.lambdatest.com/demo). +::: + +## Prerequisites for Using Smart UI + +- Familiarity with command-line tools is essential. +- Visit the [`LambdaTest SmartUI`](https://smartui.lambdatest.com/) page and log in with your credentials. +- Obtain your `LT_USERNAME` and `LT_ACCESS_KEY` by clicking on the `Access Key` button, located at the top right corner of your dashboard. + +## Step 1: Establishing a SmartUI Project + +To initiate a SmartUI PDF Comparison Project, adhere to the following instructions: + +1. Navigate to the [SmartUI Projects Page](https://smartui.lambdatest.com/). +2. Tap on the `new project` button. +3. Specify your platform type as `PDF`. +4. Provide your `project` name, designate `approvers`, and add `tags` (optional). +5. Confirm your entry by clicking on **Submit**. + +Once your project is active, retrieve your `Project Token` from the application. Here's an example of a project token: + +```bash +projectToken = "123456#1234abcd-****-****-****-************" +``` + +## Step 1: Install the SmartUI CLI + +Install the CLI globally using npm: + +```bash +npm install -g @lambdatest/smartui-cli +``` + +## Step 2: Setup your credentials + + + + +```bash +export LT_USERNAME="${ YOUR_LAMBDATEST_USERNAME()}" +export LT_ACCESS_KEY="${ YOUR_LAMBDATEST_ACCESS_KEY()}" +export PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +``` + + + + +```bash +set LT_USERNAME="${ YOUR_LAMBDATEST_USERNAME()}" +set LT_ACCESS_KEY="${ YOUR_LAMBDATEST_ACCESS_KEY()}" +set PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +``` + + + + +```powershell +$env:LT_USERNAME="${ YOUR_LAMBDATEST_USERNAME()}" +$env:LT_ACCESS_KEY="${ YOUR_LAMBDATEST_ACCESS_KEY()}" +$env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +``` + + + + +cmd + +## Step 3: Upload PDFs Using CLI + +Use the `upload-pdf` command to upload one or multiple PDF files from a directory: + +```bash +smartui upload-pdf [options] +``` + +### Arguments: +- `directory_or_filename`: Path to a single PDF file or a directory containing multiple PDFs. + +### Options: +- `--fetch-results [filename]`: Fetch test results after upload. Optionally specify an output file (e.g., `results.json`). +- `--buildName `: Assign a custom name to the build. +- `--projectToken `: Specify the project token (if not set as environment variable). + +### Example Usage: + +Upload all PDFs from a folder and name the build: + +```bash +smartui upload-pdf ./pdfs/ --buildName "Release-v2.1" +``` + +Upload a single PDF file: + +```bash +smartui upload-pdf ./document.pdf --buildName "Single-PDF-Test" +``` + +Fetch results and save to a file: + +```bash +smartui upload-pdf ./spec.pdf --fetch-results results.json +``` + +Upload with custom project token: + +```bash +smartui upload-pdf ./pdfs/ --projectToken "123456#1234abcd-****-****-****-************" --buildName "Custom-Build" +``` + +## Advanced CLI Options + +### Batch Processing + +Process multiple directories: + +```bash +smartui upload-pdf ./documents/ --buildName "Batch-1" +smartui upload-pdf ./reports/ --buildName "Batch-2" +``` + +### CI/CD Integration + +Example for GitHub Actions: + +```yaml +- name: Upload PDFs to SmartUI + run: | + smartui upload-pdf ./generated-pdfs/ --buildName "${{ github.sha }}" --fetch-results test-results.json +``` + +## Use Cases + +- **CI/CD Pipelines**: Integrate PDF testing into automated deployment workflows +- **Batch Processing**: Upload multiple PDFs efficiently from command line +- **Automated Testing**: Schedule PDF uploads as part of automated test suites +- **Developer Workflows**: Quick PDF testing during development and debugging diff --git a/docs/smartui-pdf-comparison.md b/docs/smartui-pdf-comparison.md index f7c9c5dc5..83cb2a83f 100644 --- a/docs/smartui-pdf-comparison.md +++ b/docs/smartui-pdf-comparison.md @@ -1,7 +1,7 @@ --- id: smartui-pdf-comparison title: SmartUI Visual Regression Testing for PDF Files -sidebar_label: Smart PDF Comparison +sidebar_label: PDF Testing description: In this documentation, learn how to perform Visual Regression testing of PDFs using SmartUI. keywords: - Visual Regression @@ -92,287 +92,35 @@ Once your project is active, retrieve your `Project Token` from the application. projectToken = "123456#1234abcd-****-****-****-************" ``` -## Option 1: Integrating PDFs via API - -After setting up your SmartUI Project, you can upload your local PDF files to your project. This will automatically generate a build by capturing snapshots of every page. - -Here's how you can upload your PDFs: - -1. Retrieve your API `URL Endpoint` post activation of your enterprise plan. To schedule a demonstration, click [here](https://www.lambdatest.com/demo). - -2. Append the following parameters to your request payload via `form-body`: - -| Variable | Type | Description | Required? | -| ------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | --------- | -| projectToken | string | This token is required to upload PDF files and validate your project.
    Example: `projectToken:123456#1234abcd-****-****-****-************` | Yes | -| pathToFiles | array | Add the path to the PDFs that will be uploaded.
    Example: `pathToFiles : [ "path/to/pdf-1", "path/to/pdf-2"]` | Yes | -| buildName | string | Assign a name of your choice to the build comprising the uploaded PDFs.
    Example: `buildName : #` | No | +## Upload Methods + +SmartUI provides three different methods to upload PDFs for visual regression testing. Choose the method that best fits your workflow: + + :::note Only files in `.pdf` format are compatible with this feature. ::: -## Option 2: Uploading PDFs via SmartUI CLI (Alternative Method) - -For users who prefer command-line tools, SmartUI provides a CLI to easily upload PDFs and fetch test results. - -### Step 1: Install the SmartUI CLI - -Install the CLI globally using npm: - -```bash -npm install -g @lambdatest/smartui-cli -``` -### Step 2: Setup your credentials - - - - - -
    - - {`export LT_USERNAME="${ YOUR_LAMBDATEST_USERNAME()}" -export LT_ACCESS_KEY="${ YOUR_LAMBDATEST_ACCESS_KEY()}" -export PROJECT_TOKEN="123456#1234abcd-****-****-****-************"`} - -
    - -     - - - -
    - - {`set LT_USERNAME="${ YOUR_LAMBDATEST_USERNAME()}" -set LT_ACCESS_KEY="${ YOUR_LAMBDATEST_ACCESS_KEY()}" -set PROJECT_TOKEN="123456#1234abcd-****-****-****-************"`} - -
    - -     - - - -
    - - {`$Env:LT_USERNAME="${ YOUR_LAMBDATEST_USERNAME()}" -$Env:LT_ACCESS_KEY="${ YOUR_LAMBDATEST_ACCESS_KEY()}" -$Env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************"`} - - -
    - -     - -     - - -cmd - -### Step 3: Upload PDFs Using CLI - -Use the `upload-pdf` command to upload one or multiple PDF files from a directory: - -```bash -smartui upload-pdf [options] -``` - -#### Arguments: -- `directory_or_filename`: Path to a single PDF file or a directory containing multiple PDFs. - -#### Options: -- `--fetch-results [filename]`: Fetch test results after upload. Optionally specify an output file (e.g., `results.json`). -- `--buildName `: Assign a custom name to the build. - -#### Example Usage: - -Upload all PDFs from a folder and name the build: - -```bash -smartui upload-pdf ./pdfs/ --buildName "Release-v2.1" -``` - -Fetch results and save to a file: - -```bash -smartui upload-pdf ./spec.pdf --fetch-results results.json -``` - -This CLI method streamlines PDF uploads and result retrieval, making it ideal for CI/CD pipelines and automated workflows. - -## Option 3: Uploading PDFs via SmartUI Java SDK - -For developers who prefer programmatic control, SmartUI provides a Java SDK to upload PDFs and manage visual regression testing programmatically. - -### Step 1: Clone the Sample Project - -First, clone the sample project to get started: - -```bash -git clone https://github.com/LambdaTest/junit-selenium-sample.git -cd junit-selenium-sample -``` - -### Step 2: Install the SmartUI Java SDK - -Add the SmartUI Java SDK to your `pom.xml`: - -```xml - - io.github.lambdatest - lambdatest-java-sdk - 1.0.18 - -``` - -Then compile your project: - -```bash -mvn clean compile -``` - -### Step 3: Set up your credentials - - - - - -
    - - {`export LT_USERNAME="${ YOUR_LAMBDATEST_USERNAME()}" -export LT_ACCESS_KEY="${ YOUR_LAMBDATEST_ACCESS_KEY()}" -export PROJECT_TOKEN="123456#1234abcd-****-****-****-************"`} - -
    - -     - - - -
    - - {`set LT_USERNAME="${ YOUR_LAMBDATEST_USERNAME()}" -set LT_ACCESS_KEY="${ YOUR_LAMBDATEST_ACCESS_KEY()}" -set PROJECT_TOKEN="123456#1234abcd-****-****-****-************"`} - -
    - -     - - - -
    - - {`$Env:LT_USERNAME="${ YOUR_LAMBDATEST_USERNAME()}" -$Env:LT_ACCESS_KEY="${ YOUR_LAMBDATEST_ACCESS_KEY()}" -$Env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************"`} - -
    - -     - -     - -### Step 4: Upload PDFs using Java SDK - -You can upload PDFs in two modes: - - - - - -Upload pre-existing PDFs from your local machine: - -> 📁 **Sample File**: [`SmartuiPdfLocalTest.java`](https://github.com/LambdaTest/junit-selenium-sample/blob/master/src/test/java/com/smartuiPdf/SmartuiPdfLocalTest.java) - -```java -import io.github.lambdatest.SmartUIConfig; -import io.github.lambdatest.SmartUIPdf; -import io.github.lambdatest.models.FormattedResults; - -public class SmartuiPdfLocalTest { - public void uploadLocalPdf() throws Exception { - String projectToken = System.getenv("PROJECT_TOKEN"); - - SmartUIConfig config = new SmartUIConfig() - .withProjectToken(projectToken) - .withFetchResult(true); - - SmartUIPdf pdfUploader = new SmartUIPdf(config); - - // Upload PDF file - String pdfPath = "path/to/your/document.pdf"; - FormattedResults result = pdfUploader.uploadPDF(pdfPath); - - System.out.println("Upload result: " + result); - } -} -``` - - - - - -Upload PDFs downloaded during LambdaTest cloud test execution: - -> 📁 **Sample File**: [`SmartuiPdfCloudTest.java`](https://github.com/LambdaTest/junit-selenium-sample/blob/master/src/test/java/com/smartuiPdf/SmartuiPdfCloudTest.java) - -```java -import org.openqa.selenium.WebDriver; -import org.openqa.selenium.JavascriptExecutor; -import org.openqa.selenium.remote.RemoteWebDriver; -import java.io.File; -import java.io.FileOutputStream; -import java.util.Base64; - -public class SmartuiPdfCloudTest { - public void uploadCloudPdf(WebDriver driver) throws Exception { - String projectToken = System.getenv("PROJECT_TOKEN"); - - // Download PDF from cloud session - String base64Content = (String) ((JavascriptExecutor) driver) - .executeAsyncScript("lambda-file-content=LambdaTest.pdf"); - - // Convert base64 to PDF file - byte[] pdfBytes = Base64.getDecoder().decode(base64Content); - File pdfFile = new File("downloaded.pdf"); - try (FileOutputStream fos = new FileOutputStream(pdfFile)) { - fos.write(pdfBytes); - } - - // Upload to SmartUI - SmartUIConfig config = new SmartUIConfig() - .withProjectToken(projectToken) - .withFetchResult(true); - - SmartUIPdf pdfUploader = new SmartUIPdf(config); - FormattedResults result = pdfUploader.uploadPDF(pdfFile.getAbsolutePath()); - - System.out.println("Upload result: " + result); - } -} -``` - - - - - -### Step 5: Configuration Options - -| Method | Description | -|-------|-------------| -| `.withProjectToken(token)` | Required. Your SmartUI project token. | -| `.withFetchResult(true)` | Optional. Returns structured test results. | -| `.withBuildName("v2.1")` | Optional. Assign a custom build name. | - -### Step 6: Run your tests - -```bash -mvn test -``` - -The SDK method provides programmatic control over PDF uploads and is ideal for integration into existing Java-based test automation frameworks. - ## Use Cases of Smart PDF Comparison - **Software Documentation**: Track changes and ensure consistency across document versions. diff --git a/docs/smartui-pdf-java-sdk.md b/docs/smartui-pdf-java-sdk.md new file mode 100644 index 000000000..36434553d --- /dev/null +++ b/docs/smartui-pdf-java-sdk.md @@ -0,0 +1,290 @@ +--- +id: smartui-pdf-java-sdk +title: Upload PDFs via Java SDK +sidebar_label: Java SDK Upload +description: Learn how to upload PDF files to SmartUI using the Java SDK for programmatic visual regression testing. +keywords: + - PDF Java SDK + - SmartUI Java SDK + - Visual Regression Testing + - PDF Testing + - Java Development +url: https://www.lambdatest.com/support/docs/smartui-pdf-java-sdk/ +site_name: LambdaTest +slug: smartui-pdf-java-sdk/ +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys"; + + + +:::caution +This functionality is exclusive to our enterprise plan subscribers on SmartUI. For additional details or inquiries, please [contact us](https://www.lambdatest.com/demo). +::: + +## Prerequisites for Using Smart UI + +- Java 8 or higher installed on your system +- Maven or Gradle build tool +- Familiarity with Java development +- Visit the [`LambdaTest SmartUI`](https://smartui.lambdatest.com/) page and log in with your credentials. +- Obtain your `LT_USERNAME` and `LT_ACCESS_KEY` by clicking on the `Access Key` button, located at the top right corner of your dashboard. + +## Step 1: Establishing a SmartUI Project + +To initiate a SmartUI PDF Comparison Project, adhere to the following instructions: + +1. Navigate to the [SmartUI Projects Page](https://smartui.lambdatest.com/). +2. Tap on the `new project` button. +3. Specify your platform type as `PDF`. +4. Provide your `project` name, designate `approvers`, and add `tags` (optional). +5. Confirm your entry by clicking on **Submit**. + +Once your project is active, retrieve your `Project Token` from the application. Here's an example of a project token: + +```bash +projectToken = "123456#1234abcd-****-****-****-************" +``` + +## Step 1: Clone the Sample Project + +First, clone the sample project to get started: + +```bash +git clone https://github.com/LambdaTest/junit-selenium-sample.git +cd junit-selenium-sample +``` + +## Step 2: Install the SmartUI Java SDK + +Add the SmartUI Java SDK to your `pom.xml`: + +```xml + + io.github.lambdatest + lambdatest-java-sdk + 1.0.18 + +``` + +Then compile your project: + +```bash +mvn clean compile +``` + +## Step 3: Set up your credentials + + + + +```bash +export LT_USERNAME="${ YOUR_LAMBDATEST_USERNAME()}" +export LT_ACCESS_KEY="${ YOUR_LAMBDATEST_ACCESS_KEY()}" +export PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +``` + + + + +```bash +set LT_USERNAME="${ YOUR_LAMBDATEST_USERNAME()}" +set LT_ACCESS_KEY="${ YOUR_LAMBDATEST_ACCESS_KEY()}" +set PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +``` + + + + +```powershell +$env:LT_USERNAME="${ YOUR_LAMBDATEST_USERNAME()}" +$env:LT_ACCESS_KEY="${ YOUR_LAMBDATEST_ACCESS_KEY()}" +$env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +``` + + + + +## Step 4: Upload PDFs using Java SDK + +You can upload PDFs in two modes: + + + + + +Upload pre-existing PDFs from your local machine: + +> 📁 **Sample File**: [`SmartuiPdfLocalTest.java`](https://github.com/LambdaTest/junit-selenium-sample/blob/master/src/test/java/com/smartuiPdf/SmartuiPdfLocalTest.java) + +```java +import io.github.lambdatest.SmartUIConfig; +import io.github.lambdatest.SmartUIPdf; +import io.github.lambdatest.models.FormattedResults; + +public class SmartuiPdfLocalTest { + public void uploadLocalPdf() throws Exception { + String projectToken = System.getenv("PROJECT_TOKEN"); + + SmartUIConfig config = new SmartUIConfig() + .withProjectToken(projectToken) + .withFetchResult(true); + + SmartUIPdf pdfUploader = new SmartUIPdf(config); + + // Upload PDF file + String pdfPath = "path/to/your/document.pdf"; + FormattedResults result = pdfUploader.uploadPDF(pdfPath); + + System.out.println("Upload result: " + result); + } +} +``` + + + + + +Upload PDFs downloaded during LambdaTest cloud test execution: + +> 📁 **Sample File**: [`SmartuiPdfCloudTest.java`](https://github.com/LambdaTest/junit-selenium-sample/blob/master/src/test/java/com/smartuiPdf/SmartuiPdfCloudTest.java) + +```java +import org.openqa.selenium.WebDriver; +import org.openqa.selenium.JavascriptExecutor; +import org.openqa.selenium.remote.RemoteWebDriver; +import java.io.File; +import java.io.FileOutputStream; +import java.util.Base64; + +public class SmartuiPdfCloudTest { + public void uploadCloudPdf(WebDriver driver) throws Exception { + String projectToken = System.getenv("PROJECT_TOKEN"); + + // Download PDF from cloud session + String base64Content = (String) ((JavascriptExecutor) driver) + .executeAsyncScript("lambda-file-content=LambdaTest.pdf"); + + // Convert base64 to PDF file + byte[] pdfBytes = Base64.getDecoder().decode(base64Content); + File pdfFile = new File("downloaded.pdf"); + try (FileOutputStream fos = new FileOutputStream(pdfFile)) { + fos.write(pdfBytes); + } + + // Upload to SmartUI + SmartUIConfig config = new SmartUIConfig() + .withProjectToken(projectToken) + .withFetchResult(true); + + SmartUIPdf pdfUploader = new SmartUIPdf(config); + FormattedResults result = pdfUploader.uploadPDF(pdfFile.getAbsolutePath()); + + System.out.println("Upload result: " + result); + } +} +``` + + + + + +## Step 5: Configuration Options + +| Method | Description | +|-------|-------------| +| `.withProjectToken(token)` | Required. Your SmartUI project token. | +| `.withFetchResult(true)` | Optional. Returns structured test results. | +| `.withBuildName("v2.1")` | Optional. Assign a custom build name. | + +## Step 6: Run your tests + +```bash +mvn test +``` + +## Advanced Java SDK Usage + +### Batch Upload Example + +```java +public class SmartuiPdfBatchTest { + public void uploadMultiplePdfs() throws Exception { + String projectToken = System.getenv("PROJECT_TOKEN"); + + SmartUIConfig config = new SmartUIConfig() + .withProjectToken(projectToken) + .withFetchResult(true) + .withBuildName("Batch-Upload-v1.0"); + + SmartUIPdf pdfUploader = new SmartUIPdf(config); + + String[] pdfPaths = { + "documents/report1.pdf", + "documents/report2.pdf", + "documents/specification.pdf" + }; + + for (String pdfPath : pdfPaths) { + FormattedResults result = pdfUploader.uploadPDF(pdfPath); + System.out.println("Uploaded " + pdfPath + ": " + result); + } + } +} +``` + +### Error Handling + +```java +public class SmartuiPdfErrorHandling { + public void uploadWithErrorHandling() { + try { + String projectToken = System.getenv("PROJECT_TOKEN"); + + SmartUIConfig config = new SmartUIConfig() + .withProjectToken(projectToken) + .withFetchResult(true); + + SmartUIPdf pdfUploader = new SmartUIPdf(config); + FormattedResults result = pdfUploader.uploadPDF("document.pdf"); + + System.out.println("Upload successful: " + result); + + } catch (Exception e) { + System.err.println("Upload failed: " + e.getMessage()); + e.printStackTrace(); + } + } +} +``` + +## Use Cases + +- **Enterprise Applications**: Integrate PDF testing into large-scale Java applications +- **Test Automation Frameworks**: Build comprehensive test suites with PDF validation +- **CI/CD Integration**: Automate PDF testing in Java-based deployment pipelines +- **Custom Tools**: Develop specialized tools for PDF comparison and validation diff --git a/docs/smartui-playwright-java-sdk.md b/docs/smartui-playwright-java-sdk.md index 102486518..1e5ab3609 100644 --- a/docs/smartui-playwright-java-sdk.md +++ b/docs/smartui-playwright-java-sdk.md @@ -43,7 +43,7 @@ import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/co "@type": "ListItem", "position": 3, "name": "Smart Visual Testing", - "item": "https://www.lambdatest.com/support/docs/smart-ui-cypress/" + "item": "https://www.lambdatest.com/support/docs/smartui-playwright-java-sdk/" }] }) }} @@ -95,45 +95,28 @@ mvn clean compile ### Step 4: Setup your credentials - + + - - -
    - - {`export LT_USERNAME="${ YOUR_LAMBDATEST_USERNAME()}" -export LT_ACCESS_KEY="${ YOUR_LAMBDATEST_ACCESS_KEY()}" -export PROJECT_TOKEN="123456#1234abcd-****-****-****-************"`} - -
    +```bash +export LT_USERNAME="${ YOUR_LAMBDATEST_USERNAME()}" +```     + - - -
    - - {`set LT_USERNAME="${ YOUR_LAMBDATEST_USERNAME()}" -set LT_ACCESS_KEY="${ YOUR_LAMBDATEST_ACCESS_KEY()}" -set PROJECT_TOKEN="123456#1234abcd-****-****-****-************"`} - -
    +```bash +set LT_USERNAME="${ YOUR_LAMBDATEST_USERNAME()}" +```     + - - -
    - - {`$Env:LT_USERNAME="${ YOUR_LAMBDATEST_USERNAME()}" -$Env:LT_ACCESS_KEY="${ YOUR_LAMBDATEST_ACCESS_KEY()}" -$Env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************"`} - - -
    +```powershell +$env:LT_USERNAME="${ YOUR_LAMBDATEST_USERNAME()}" +```     -     diff --git a/docs/smartui-playwright-python-sdk.md b/docs/smartui-playwright-python-sdk.md index 3b0a06b64..fecd670cf 100644 --- a/docs/smartui-playwright-python-sdk.md +++ b/docs/smartui-playwright-python-sdk.md @@ -41,7 +41,7 @@ import NewTag from '../src/component/newTag'; "@type": "ListItem", "position": 3, "name": "Smart Visual Testing", - "item": "https://www.lambdatest.com/support/docs/smart-ui-cypress/" + "item": "https://www.lambdatest.com/support/docs/smartui-playwright-python-sdk/" }] }) }} @@ -120,18 +120,19 @@ export PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` - + ```bash set PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` - + -```bash -$Env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +```powershell +$env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` +     diff --git a/docs/smartui-playwright-sdk.md b/docs/smartui-playwright-sdk.md index 574ebf088..522996421 100644 --- a/docs/smartui-playwright-sdk.md +++ b/docs/smartui-playwright-sdk.md @@ -41,7 +41,7 @@ import NewTag from '../src/component/newTag'; "@type": "ListItem", "position": 3, "name": "Smart Visual Testing", - "item": "https://www.lambdatest.com/support/docs/smart-ui-cypress/" + "item": "https://www.lambdatest.com/support/docs/smartui-playwright-sdk/" }] }) }} @@ -107,11 +107,12 @@ set PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` - + -```bash -$Env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +```powershell +$env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` + diff --git a/docs/smartui-puppeteer-sdk.md b/docs/smartui-puppeteer-sdk.md index bf0739c26..3aea0e52e 100644 --- a/docs/smartui-puppeteer-sdk.md +++ b/docs/smartui-puppeteer-sdk.md @@ -43,7 +43,7 @@ import NewTag from '../src/component/newTag'; "@type": "ListItem", "position": 3, "name": "Smart Visual Testing", - "item": "https://www.lambdatest.com/support/docs/smart-ui-cypress/" + "item": "https://www.lambdatest.com/support/docs/smartui-puppeteer-sdk/" }] }) }} @@ -109,11 +109,12 @@ set PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` - + -```bash -$Env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +```powershell +$env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` + @@ -480,7 +481,7 @@ For additional information about SmartUI APIs please explore the documentation [
  • - Smart UI with Cypress + SmartUI Puppeteer SDK
    • diff --git a/docs/smartui-puppeteer-setup.md b/docs/smartui-puppeteer-setup.md index 85679e846..c63a27c2d 100644 --- a/docs/smartui-puppeteer-setup.md +++ b/docs/smartui-puppeteer-setup.md @@ -38,15 +38,20 @@ This documentation will act as your step-by-step guide in to perform Puppteer te ```bash export LT_USERNAME="YOUR_USERNAME" -export LT_ACCESS_KEY="YOUR ACCESS KEY" ```     - + ```bash set LT_USERNAME="YOUR_USERNAME" -set LT_ACCESS_KEY="YOUR ACCESS KEY" +``` + + + + +```powershell +$env:LT_USERNAME="YOUR_USERNAME" ``` diff --git a/docs/smartui-running-your-first-project.md b/docs/smartui-running-your-first-project.md index ceafc721b..9aa9de06b 100644 --- a/docs/smartui-running-your-first-project.md +++ b/docs/smartui-running-your-first-project.md @@ -102,37 +102,27 @@ mvn clean compile Setup your project token show in the **SmartUI** app after, creating your project. - -
    - -{`export LT_USERNAME="${YOUR_LAMBDATEST_USERNAME()}" -export LT_ACCESS_KEY="${YOUR_LAMBDATEST_ACCESS_KEY()}" -export PROJECT_TOKEN="123456#1234abcd-****-****-****-************"`} - -
    -     - -
    - -{`set LT_USERNAME="${YOUR_LAMBDATEST_USERNAME()}" -set LT_ACCESS_KEY="${YOUR_LAMBDATEST_ACCESS_KEY()}" -set PROJECT_TOKEN="123456#1234abcd-****-****-****-************"`} - -
    +```bash +export LT_USERNAME="${YOUR_LAMBDATEST_USERNAME()}" +``` +     + + +```bash +set LT_USERNAME="${YOUR_LAMBDATEST_USERNAME()}" +``` - -
    - -{`$Env:LT_USERNAME="${YOUR_LAMBDATEST_USERNAME()}" -$Env:LT_ACCESS_KEY="${YOUR_LAMBDATEST_ACCESS_KEY()}" -$Env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************"`} - -
     + +```powershell +$env:LT_USERNAME="${YOUR_LAMBDATEST_USERNAME()}" +``` + +     cmd diff --git a/docs/smartui-sdk-config-options.md b/docs/smartui-sdk-config-options.md index 496ba8dc0..29a7257d0 100644 --- a/docs/smartui-sdk-config-options.md +++ b/docs/smartui-sdk-config-options.md @@ -43,7 +43,7 @@ import NewTag from '../src/component/newTag'; "@type": "ListItem", "position": 3, "name": "Smart Visual Testing", - "item": "https://www.lambdatest.com/support/docs/smart-ui-cypress/" + "item": "https://www.lambdatest.com/support/docs/smartui-sdk-config-options/" }] }) }} diff --git a/docs/smartui-sdk-fetch-results.md b/docs/smartui-sdk-fetch-results.md index 21af2b326..ddfa642f1 100644 --- a/docs/smartui-sdk-fetch-results.md +++ b/docs/smartui-sdk-fetch-results.md @@ -43,7 +43,7 @@ import NewTag from '../src/component/newTag'; "@type": "ListItem", "position": 3, "name": "Smart Visual Testing", - "item": "https://www.lambdatest.com/support/docs/smart-ui-cypress/" + "item": "https://www.lambdatest.com/support/docs/smartui-sdk-fetch-results/" }] }) }} @@ -88,11 +88,12 @@ set PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ```     - + -```bash -$Env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +```powershell +$env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` + diff --git a/docs/smartui-selenium-csharp-sdk.md b/docs/smartui-selenium-csharp-sdk.md index 35c00bdb7..50a9dc67f 100644 --- a/docs/smartui-selenium-csharp-sdk.md +++ b/docs/smartui-selenium-csharp-sdk.md @@ -43,7 +43,7 @@ import NewTag from '../src/component/newTag'; "@type": "ListItem", "position": 3, "name": "Smart Visual Testing", - "item": "https://www.lambdatest.com/support/docs/smart-ui-cypress/" + "item": "https://www.lambdatest.com/support/docs/smartui-selenium-csharp-sdk/" }] }) }} @@ -127,11 +127,12 @@ set PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` - + -```bash -$Env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +```powershell +$env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` + @@ -503,7 +504,7 @@ For additional information about SmartUI APIs please explore the documentation [
  • - Smart UI with Cypress + SmartUI Selenium C# SDK
    • diff --git a/docs/smartui-selenium-java-sdk.md b/docs/smartui-selenium-java-sdk.md index a095b607e..f1acae7f1 100644 --- a/docs/smartui-selenium-java-sdk.md +++ b/docs/smartui-selenium-java-sdk.md @@ -43,7 +43,7 @@ import NewTag from '../src/component/newTag'; "@type": "ListItem", "position": 3, "name": "Smart Visual Testing", - "item": "https://www.lambdatest.com/support/docs/smart-ui-cypress/" + "item": "https://www.lambdatest.com/support/docs/smartui-selenium-java-sdk/" }] }) }} @@ -128,11 +128,12 @@ set PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ```     - + -```bash -$Env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +```powershell +$env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` + @@ -491,7 +492,7 @@ For additional information about SmartUI APIs please explore the documentation [
  • - Smart UI with Cypress + SmartUI Selenium Java SDK
    • diff --git a/docs/smartui-selenium-js-sdk.md b/docs/smartui-selenium-js-sdk.md index 13a99cdf3..d546095f1 100644 --- a/docs/smartui-selenium-js-sdk.md +++ b/docs/smartui-selenium-js-sdk.md @@ -43,7 +43,7 @@ import NewTag from '../src/component/newTag'; "@type": "ListItem", "position": 3, "name": "Smart Visual Testing", - "item": "https://www.lambdatest.com/support/docs/smart-ui-cypress/" + "item": "https://www.lambdatest.com/support/docs/smartui-selenium-js-sdk/" }] }) }} @@ -109,11 +109,12 @@ set PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ```     - + -```bash -$Env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +```powershell +$env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` + @@ -469,7 +470,7 @@ For additional information about SmartUI APIs please explore the documentation [
  • - Smart UI with Cypress + SmartUI Selenium JavaScript SDK
    • diff --git a/docs/smartui-selenium-python-sdk.md b/docs/smartui-selenium-python-sdk.md index 1b22e0615..3fb9fe6f3 100644 --- a/docs/smartui-selenium-python-sdk.md +++ b/docs/smartui-selenium-python-sdk.md @@ -43,7 +43,7 @@ import NewTag from '../src/component/newTag'; "@type": "ListItem", "position": 3, "name": "Smart Visual Testing", - "item": "https://www.lambdatest.com/support/docs/smart-ui-cypress/" + "item": "https://www.lambdatest.com/support/docs/smartui-selenium-python-sdk/" }] }) }} @@ -122,18 +122,19 @@ export PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ```     - + ```bash set PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` - + -```bash -$Env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +```powershell +$env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` + @@ -477,7 +478,7 @@ For additional information about SmartUI APIs please explore the documentation [
  • - Smart UI with Cypress + SmartUI Selenium Python SDK
    • diff --git a/docs/smartui-selenium-ruby-sdk.md b/docs/smartui-selenium-ruby-sdk.md index 18b31ae37..41935881b 100644 --- a/docs/smartui-selenium-ruby-sdk.md +++ b/docs/smartui-selenium-ruby-sdk.md @@ -43,7 +43,7 @@ import NewTag from '../src/component/newTag'; "@type": "ListItem", "position": 3, "name": "Smart Visual Testing", - "item": "https://www.lambdatest.com/support/docs/smart-ui-cypress/" + "item": "https://www.lambdatest.com/support/docs/smartui-selenium-ruby-sdk/" }] }) }} @@ -113,11 +113,12 @@ set PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ```     - + -```bash -$Env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +```powershell +$env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` + @@ -462,7 +463,7 @@ For additional information about SmartUI APIs please explore the documentation [
  • - Smart UI with Cypress + SmartUI Selenium Ruby SDK
    • diff --git a/docs/smartui-smart-git-strategy.md b/docs/smartui-smart-git-strategy.md index 2742c3c24..4412904fb 100644 --- a/docs/smartui-smart-git-strategy.md +++ b/docs/smartui-smart-git-strategy.md @@ -78,6 +78,13 @@ set SMART_GIT=true ```     + + +```powershell +$env:SMART_GIT="true" +``` + + ## How Smart Git Works diff --git a/docs/smartui-storybook-integration.md b/docs/smartui-storybook-integration.md index f0c9e47dd..129184656 100644 --- a/docs/smartui-storybook-integration.md +++ b/docs/smartui-storybook-integration.md @@ -43,7 +43,7 @@ import NewTag from '../src/component/newTag'; "@type": "ListItem", "position": 3, "name": "Smart Visual Testing", - "item": "https://www.lambdatest.com/support/docs/smart-ui-cypress/" + "item": "https://www.lambdatest.com/support/docs/smartui-storybook-integration/" }] }) }} @@ -116,12 +116,19 @@ export PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ```     - + ```bash set PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` + + + +```powershell +$env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +``` + diff --git a/docs/smartui-testcafe-sdk.md b/docs/smartui-testcafe-sdk.md index 83013f1be..07494d098 100644 --- a/docs/smartui-testcafe-sdk.md +++ b/docs/smartui-testcafe-sdk.md @@ -43,7 +43,7 @@ import NewTag from '../src/component/newTag'; "@type": "ListItem", "position": 3, "name": "Smart Visual Testing", - "item": "https://www.lambdatest.com/support/docs/smart-ui-cypress/" + "item": "https://www.lambdatest.com/support/docs/smartui-testcafe-sdk/" }] }) }} @@ -109,11 +109,12 @@ set PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` - + -```bash -$Env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +```powershell +$env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` + @@ -446,7 +447,7 @@ For additional information about SmartUI APIs please explore the documentation [
  • - Smart UI with Cypress + SmartUI TestCafe SDK
    • diff --git a/docs/smartui-wdio-sdk.md b/docs/smartui-wdio-sdk.md index 07c9296af..76ea5bc79 100644 --- a/docs/smartui-wdio-sdk.md +++ b/docs/smartui-wdio-sdk.md @@ -42,7 +42,7 @@ import NewTag from '../src/component/newTag'; "@type": "ListItem", "position": 3, "name": "Smart Visual Testing", - "item": "https://www.lambdatest.com/support/docs/smart-ui-cypress/" + "item": "https://www.lambdatest.com/support/docs/smartui-wdio-sdk/" }] }) }} @@ -112,11 +112,12 @@ set PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ```     - + -```bash -$Env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" +```powershell +$env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************" ``` + @@ -422,7 +423,7 @@ For additional information about SmartUI APIs please explore the documentation [
  • - Smart UI with Cypress + SmartUI WebDriverIO SDK
    • diff --git a/sidebars.js b/sidebars.js index c3b6b2530..ce3acbb2a 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1311,7 +1311,11 @@ module.exports = { "kaneai-custom-headers", "kaneai-totp", "kaneai-scheduled-test-runs", - "kaneai-smartui-visual-testing", + { + type: "doc", + label: "Visual Testing", + id: "kaneai-smartui-visual-testing", + }, "kaneai-database", ], }, @@ -3110,296 +3114,644 @@ module.exports = { items: [ "smartui-running-your-first-project", "smartui-guided-walkthrough", - "smartui-cli-git-branching-strategy", "smartui-cli-env-variables", ], }, - { - type: "doc", - label: "SmartUI MCP Server", - id: "smartui-mcp-server", - }, - { - type: "doc", - label: "SmartUI RCA", - id: "smartui-root-cause-analysis", - }, - { - type: "doc", - label: "Visual AI Agent", - id: "smartui-visual-ai", - }, - { - type: "doc", - label: "Visual Test Creation with KaneAI", - id: "kaneai-smartui-visual-testing", - }, - { - type: "doc", - label: "Visual Test with Katalon", - id: "smartui-katalon-plugin", - }, { type: "category", collapsed: false, - label: "Visual Testing Configurations", + label: "Testing Frameworks", items: [ { type: "category", - collapsed: false, - label: "Languages and Frameworks", + label: "SDK Integration", + collapsed: true, items: [ { type: "category", + label: "Selenium SDKs", collapsed: true, - label: "SDK", items: [ { - type: "category", - label: "Selenium", - collapsed: true, - items: [ - { - type: "doc", - label: "Java", - id: "smartui-selenium-java-sdk", - }, - { - type: "doc", - label: "Javascript", - id: "smartui-selenium-js-sdk", - }, - { - type: "doc", - label: "C#", - id: "smartui-selenium-csharp-sdk", - }, - { - type: "doc", - label: "Python", - id: "smartui-selenium-python-sdk", - }, - { - type: "doc", - label: "Ruby", - id: "smartui-selenium-ruby-sdk", - }, - ], + type: "doc", + label: "Java SDK", + id: "smartui-selenium-java-sdk", }, { - type: "category", - label: "Playwright", - collapsed: true, - // id: "smart-visual-regression-testing", - items: [ - { - type: "doc", - label: "Java", - id: "smartui-playwright-java-sdk", - }, - { - type: "doc", - label: "Javascript", - id: "smartui-playwright-sdk", - }, - { - type: "doc", - label: "Java", - id: "smartui-playwright-python-sdk", - }, - ], + type: "doc", + label: "JavaScript SDK", + id: "smartui-selenium-js-sdk", + }, + { + type: "doc", + label: "C# SDK", + id: "smartui-selenium-csharp-sdk", + }, + { + type: "doc", + label: "Python SDK", + id: "smartui-selenium-python-sdk", + }, + { + type: "doc", + label: "Ruby SDK", + id: "smartui-selenium-ruby-sdk", }, - "smartui-puppeteer-sdk", - "smartui-testcafe-sdk", - "smartui-cypress-sdk", - "smartui-appium-sdk", - "smartui-wdio-sdk", ], }, { type: "category", + label: "Playwright SDKs", collapsed: true, - label: "Lambda Hooks", items: [ - "selenium-visual-regression", - "smart-ui-cypress", - "playwright-visual-regression", - "puppeteer-visual-regression", - "smartui-k6-setup", + { + type: "doc", + label: "Java SDK", + id: "smartui-playwright-java-sdk", + }, + { + type: "doc", + label: "JavaScript SDK", + id: "smartui-playwright-sdk", + }, + { + type: "doc", + label: "Python SDK", + id: "smartui-playwright-python-sdk", + }, ], }, + { + type: "doc", + label: "Cypress SDK", + id: "smartui-cypress-sdk", + }, + { + type: "doc", + label: "Puppeteer SDK", + id: "smartui-puppeteer-sdk", + }, + { + type: "doc", + label: "TestCafe SDK", + id: "smartui-testcafe-sdk", + }, + { + type: "doc", + label: "WebdriverIO SDK", + id: "smartui-wdio-sdk", + }, + { + type: "doc", + label: "K6 Setup", + id: "smartui-k6-setup", + }, { type: "category", + label: "Mobile SDKs", collapsed: true, - label: "Visually Test Your Native Apps", items: [ - "smartui-appium-hooks", - "smartui-appium-java-sdk", - "espresso-visual-regression", - "xcui-visual-regression", + { + type: "doc", + label: "Appium SDK", + id: "smartui-appium-sdk", + }, + { + type: "doc", + label: "Appium Java SDK", + id: "smartui-appium-java-sdk", + }, ], }, ], }, { type: "category", + label: "Lambda Hooks", collapsed: true, - label: "Branching and Merging", items: [ { type: "doc", - id: "smartui-cli-git-branching-strategy", - label: "Default Git Strategy", + label: "Selenium Hooks", + id: "selenium-visual-regression", + }, + { + type: "doc", + label: "Playwright Hooks", + id: "playwright-visual-regression", }, { type: "doc", - id: "smartui-smart-git-strategy", - label: "Smart Git Strategy", + label: "Cypress Hooks", + id: "smart-ui-cypress", }, { type: "doc", - id: "smartui-branch-merging", - label: "Branch-Level Merging", + label: "Puppeteer Hooks", + id: "puppeteer-visual-regression", }, { type: "doc", - id: "smartui-build-merging", - label: "Build-Level Merging", + label: "Appium Hooks", + id: "smartui-appium-hooks", }, { type: "doc", - id: "smartui-baseline-management", - label: "Auto Baseline Management", + label: "Espresso Hooks", + id: "espresso-visual-regression", + }, + { + type: "doc", + label: "XCUI Hooks", + id: "xcui-visual-regression", }, ], }, { type: "category", + label: "Design & Component Testing", collapsed: true, - label: "Advanced CLI Configurations", items: [ - "smartui-sdk-build-name", - "smartui-sdk-fetch-results", - "smartui-cli-responsive-dom", - "smartui-sdk-config-options", - "smartui-multiple-assets-hosts", - "smartui-cli-request-headers", - "smartui-cli-basic-auth", - "smartui-sdk-tunnel", - "smartui-shadow-dom", - "smartui-cli-exec", - "smartui-sdk-capabilities", - { - type: "category", - collapsed: true, - label: "Stabilize Your Screenshots", - items: [ - "smartui-freeze-animations", - "smartui-handle-dynamic-data", - "smartui-handle-videos", - "smartui-handle-lazy-loading", - "smartui-handle-sticky-elements", - ], + type: "doc", + label: "Storybook Integration", + id: "smart-ui-storybook", + }, + { + type: "doc", + label: "Figma Web CLI", + id: "smartui-cli-figma-web", + }, + { + type: "doc", + label: "Figma App CLI", + id: "smartui-cli-figma-app", + }, + { + type: "doc", + label: "Figma CLI", + id: "smartui-cli-figma", }, ], }, - "smartui-cli", { type: "category", - collapsed: true, - label: "Test your Figma Designs", + collapsed: false, + label: "PDF Testing", + link: { + type: "doc", + id: "smartui-pdf-comparison", + }, items: [ { type: "doc", - label: "Figma-Web", - id: "smartui-cli-figma-web", + label: "PDF Upload via API", + id: "smartui-pdf-api-upload", }, { type: "doc", - label: "Figma-App", - id: "smartui-cli-figma-app", + label: "PDF Upload via SDK", + id: "smartui-pdf-java-sdk", }, { type: "doc", - label: "Figma-Figma", - id: "smartui-cli-figma", + label: "PDF Upload via CLI", + id: "smartui-pdf-cli-upload", }, ], }, + ], + }, + + { + type: "category", + collapsed: true, + label: "Core Features", + items: [ + { + type: "doc", + label: "Visual AI Agent", + id: "smartui-visual-ai", + }, + { + type: "doc", + label: "Smart RCA (Root Cause Analysis)", + id: "smartui-root-cause-analysis", + }, + { + type: "doc", + label: "Baseline Management", + id: "smartui-baseline-management", + }, + { + type: "doc", + label: "Draw on UI", + id: "smartui-draw-on-ui", + }, { type: "category", collapsed: true, - label: "Bring your Own Screenshots", + label: "Smart Comparison Options", items: [ { type: "doc", - label: "Upload through CLI", - id: "smartui-cli-upload", + label: "Smart Ignore", + id: "smartui-smartignore", }, { type: "doc", - label: "Upload through API", - id: "smartui-upload-api-v2", + label: "Layout Testing", + id: "smartui-layout-testing", }, ], }, + ], + }, + + { + type: "category", + collapsed: true, + label: "Upload & Capture", + items: [ + { + type: "doc", + label: "CLI Upload", + id: "smartui-cli-upload", + }, { - type: "category", - collapsed: true, - label: "Component Testing", - items: ["smart-ui-storybook", "smartui-git-branching-strategy"], + type: "doc", + label: "API Upload", + id: "smartui-upload-api-v2", + }, + { + type: "doc", + label: "Capture Static URLs via CLI", + id: "smartui-cli", }, - "smartui-pdf-comparison", - "smartui-draw-on-ui", ], }, + { type: "category", collapsed: true, - label: "Difference Options", - items: ["smartui-smartignore", "smartui-layout-testing"], + label: "Project Configuration", + items: [ + { + type: "doc", + label: "Project Settings", + id: "smartui-project-settings", + }, + { + type: "doc", + label: "Test Settings", + id: "test-settings-options", + }, + { + type: "doc", + label: "HTML DOM Options", + id: "html-dom-smartui-options", + }, + { + type: "doc", + label: "Build Config & Options", + id: "smart-ui-build-options", + }, + { + type: "doc", + label: "Multiple Projects per Repo", + id: "smartui-multiple-projects-per-repo", + }, + ], }, + { type: "category", collapsed: true, - label: "Integrations with SmartUI", + label: "Git & Branching", items: [ { - type: "category", - collapsed: true, - label: "Run Visual Tests on PRs", - items: ["smartui-github-app-integration"], + type: "doc", + label: "Default Branching Strategy", + id: "smartui-cli-git-branching-strategy", }, - "smartui-slack-integration", { - type: "category", - collapsed: true, - label: "Integrate with CI/CD tools", - items: [ - "smartui-with-github-actions", - "smartui-with-gitlab", - "smartui-with-bitbucket", - "smartui-with-semaphore", - "smartui-with-azure", - "smartui-with-buildkite", - "smartui-with-circle-ci", - "smartui-with-travis-ci", - ], + type: "doc", + label: "Smart Git Strategy", + id: "smartui-smart-git-strategy", + }, + { + type: "doc", + label: "Merging Branches", + id: "smartui-branch-merging", + }, + { + type: "doc", + label: "Build Merging", + id: "smartui-build-merging", }, ], }, + { type: "category", collapsed: true, - label: "Project Management", + label: "Stabilize Screenshots", items: [ - "smartui-project-settings", - "test-settings-options", - "html-dom-smartui-options", - "smart-ui-build-options", - "smartui-multiple-projects-per-repo", + { + type: "doc", + label: "Handling Dynamic Data", + id: "smartui-handle-dynamic-data", + }, + { + type: "doc", + label: "Freezing Animations", + id: "smartui-freeze-animations", + }, + { + type: "doc", + label: "Handle Videos", + id: "smartui-handle-videos", + }, + { + type: "doc", + label: "Handle Lazy Loading", + id: "smartui-handle-lazy-loading", + }, + { + type: "doc", + label: "Handle Sticky Elements", + id: "smartui-handle-sticky-elements", + }, + ], + }, + + { + type: "category", + collapsed: true, + label: "Advanced CLI", + items: [ + { + type: "doc", + label: "Exec Command", + id: "smartui-cli-exec", + }, + { + type: "doc", + label: "Groups Screenshots by Build Names", + id: "smartui-sdk-build-name", + }, + { + type: "doc", + label: "Fetch Results", + id: "smartui-sdk-fetch-results", + }, + { + type: "doc", + label: "Configuration Options", + id: "smartui-sdk-config-options", + }, + { + type: "doc", + label: "SmartUI SDK Capabilities", + id: "smartui-sdk-capabilities", + }, + { + type: "doc", + label: "Advanced Comparison Settings", + id: "smartui-cli-responsive-dom", + }, + ], + }, + + { + type: "category", + collapsed: true, + label: "Technical Configuration", + items: [ + { + type: "doc", + label: "Tunnel Configuration", + id: "smartui-sdk-tunnel", + }, + { + type: "doc", + label: "Shadow DOM", + id: "smartui-shadow-dom", + }, + { + type: "doc", + label: "Capturing Multiple Asset Hosts", + id: "smartui-multiple-assets-hosts", + }, + { + type: "doc", + label: "Custom Request Headers", + id: "smartui-cli-request-headers", + }, + { + type: "doc", + label: "Basic Authentication", + id: "smartui-cli-basic-auth", + }, + { + type: "doc", + label: "SmartUI MCP Server", + id: "smartui-mcp-server", + }, + ], + }, + + { + type: "category", + collapsed: true, + label: "Integrations", + items: [ + { + type: "category", + collapsed: true, + label: "CI/CD Tools", + items: [ + { + type: "doc", + label: "GitHub Actions", + id: "smartui-with-github-actions", + }, + { + type: "doc", + label: "GitLab", + id: "smartui-with-gitlab", + }, + { + type: "doc", + label: "Bitbucket", + id: "smartui-with-bitbucket", + }, + { + type: "doc", + label: "Semaphore", + id: "smartui-with-semaphore", + }, + { + type: "doc", + label: "Azure", + id: "smartui-with-azure", + }, + { + type: "doc", + label: "Buildkite", + id: "smartui-with-buildkite", + }, + { + type: "doc", + label: "Circle CI", + id: "smartui-with-circle-ci", + }, + { + type: "doc", + label: "Travis CI", + id: "smartui-with-travis-ci", + }, + { + type: "doc", + label: "Netlify", + id: "smartui-with-netlify", + }, + ], + }, + { + type: "category", + collapsed: true, + label: "LambdaTest Products", + items: [ + { + type: "doc", + label: "KaneAI Integration", + id: "kaneai-smartui-visual-testing", + }, + { + type: "category", + collapsed: true, + label: "HyperExecute Integration", + items: [ + { + type: "category", + collapsed: true, + label: "SmartUI Hooks", + items: [ + { + type: "doc", + label: "Selenium", + id: "hyperexecute-smart-ui-testing-using-selenium", + }, + { + type: "doc", + label: "Cypress", + id: "hyperexecute-smart-ui-testing-using-cypress", + }, + { + type: "doc", + label: "Playwright", + id: "hyperexecute-smart-ui-test-using-playwright", + }, + ], + }, + { + type: "category", + collapsed: true, + label: "SmartUI SDK", + items: [ + { + type: "category", + collapsed: true, + label: "Selenium", + items: [ + { + type: "doc", + label: "JavaScript", + id: "hyperexecute-smart-ui-sdk-selenium-javascript", + }, + { + type: "doc", + label: "C#", + id: "hyperexecute-smart-ui-sdk-selenium-csharp", + }, + ], + }, + { + type: "doc", + label: "Cypress", + id: "hyperexecute-smart-ui-sdk-using-cypress", + }, + { + type: "doc", + label: "Maestro", + id: "hyperexecute-smart-ui-sdk-maestro", + }, + { + type: "doc", + label: "Playwright", + id: "hyperexecute-smart-ui-sdk-using-playwright", + }, + { + type: "doc", + label: "Puppeteer", + id: "hyperexecute-smart-ui-sdk-using-puppeteer", + }, + ], + }, + ], + }, + { + type: "category", + collapsed: true, + label: "WebScanner Integration", + items: [ + { + type: "doc", + label: "Visual Scan", + id: "web-scanner-visual-scan", + }, + ], + }, + ], + }, + { + type: "category", + collapsed: true, + label: "Third-Party Products", + items: [ + { + type: "doc", + label: "Katalon Plugin", + id: "smartui-katalon-plugin", + }, + ], + }, + { + type: "category", + collapsed: true, + label: "Pull Request Testing", + items: [ + { + type: "doc", + label: "GitHub App", + id: "smartui-github-app-integration", + }, + ], + }, + { + type: "category", + collapsed: true, + label: "Communication", + items: [ + { + type: "doc", + label: "Slack Integration", + id: "smartui-slack-integration", + }, + ], + }, ], }, ], diff --git a/src/component/SupportedLanguages/SmartUIHooksSupportedLanguage.js b/src/component/SupportedLanguages/SmartUIHooksSupportedLanguage.js index f2fb1ac5a..de6d7b03f 100644 --- a/src/component/SupportedLanguages/SmartUIHooksSupportedLanguage.js +++ b/src/component/SupportedLanguages/SmartUIHooksSupportedLanguage.js @@ -1,86 +1,43 @@ import React from 'react' -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; export default function SmartUIHooksSupportedLanguage() { return ( <> -
    - - -
    -
    - Java - -
    -
    -     - - -
    -
    - Javascript - -
    -
    -     - - -
    -
    - JavaScript - -
    -
    -     - - -
    -
    - JavaScript - -
    -
    -     - - -
    -
    - JavaScript - -
    -
    -     - - -
    -
    - JavaScript - -
    -
    -     - - -
    -
    - JavaScript - -
    -
    -     -     +
    +
    +
    + Selenium + +
    +
    + Playwright + +
    +
    + Puppeteer + +
    +
    + K6 + +
    +
    + Cypress + +
    +
    + Appium + +
    +
    + Espresso + +
    +
    + XCUI + +
    +
    )