From 2a4b761d8c81f1461be7336f888e4a719de20ddf Mon Sep 17 00:00:00 2001 From: RushilK7 Date: Wed, 24 Sep 2025 19:33:38 +0530 Subject: [PATCH] katalon --- docs/smartui-katalon-plugin.md | 63 +++++++++------------------------- 1 file changed, 17 insertions(+), 46 deletions(-) diff --git a/docs/smartui-katalon-plugin.md b/docs/smartui-katalon-plugin.md index fd5f8b68..44d9edf4 100644 --- a/docs/smartui-katalon-plugin.md +++ b/docs/smartui-katalon-plugin.md @@ -60,14 +60,6 @@ With this plugin, you can: --- -## Features - -- **Visual Snapshots** — capture UI snapshots during test execution. -- **Baseline Comparison** — automatically compare snapshots against stored baselines in SmartUI. -- **Visual Regression Detection** — identify unintended UI changes with pixel-level accuracy. -- **SmartUI Dashboard** — view diffs, approve/reject changes, and track regressions over time. - ---- ## Installation @@ -79,7 +71,7 @@ With this plugin, you can: ### Option 2: Manual Installation via JAR -1. Download the latest `katalon-studio-smartui-plugin.jar` from the [official release page](https://github.com/LambdaTest/katalon-studio-smartui-plugin/releases) (if available). +1. Download the latest `katalon-studio-smartui-plugin.jar` from the [official release page](https://github.com/LambdaTest/katalon-studio-smartui-plugin/releases). 2. In Katalon Studio, go to **Project > Settings > Plugins > Import Plugin**. 3. Select the downloaded `.jar` file and click **Import**. @@ -99,42 +91,32 @@ With this plugin, you can: --- -### Step 2: Set Environment Variable - -In your Katalon project, set the `PROJECT_TOKEN` environment variable: +### Step 2: Start your Katalon Instance from terminal -#### Via Project Settings: -1. Go to **Project > Settings > Execution > Profiles**. -2. Under your active profile, add a new environment variable: +Run the following command in the terminal to start the Katalon instance. - - ```bash -export LT_USERNAME="YOUR_USERNAME" -export LT_ACCESS_KEY="YOUR ACCESS KEY" +/Applications/Katalon\ Studio\ Enterprise.app/Contents/MacOS/katalon ``` - - +--- -```bash -set LT_USERNAME="YOUR_USERNAME" -set LT_ACCESS_KEY="YOUR ACCESS KEY" -``` +### Step 3: Set Environment Variable - - +In your Katalon project, set the `PROJECT_TOKEN` environment variable: -#### Or via Script (Global Variable): -You can also set it dynamically in your test script: +#### Via Project Settings: +1. Go to **Project > Settings > Plugins > SmartUI Integration**. +2. Here you may set your project token -```groovy -System.setProperty("PROJECT_TOKEN", "123456#1234abcd-****-****-****-************") + +```bash +PROJECT_TOKEN = "project_token..." ``` --- -### Step 3: Configure SmartUI in Your Test Case +### Step 4: Configure SmartUI in Your Test Case Use the provided custom keywords to start, capture, and stop SmartUI sessions. @@ -162,7 +144,7 @@ WebUI.closeBrowser() --- -### Step 4: Advanced Configuration (Optional) +### Step 5: Advanced Configuration (Optional) You can pass additional configuration via a JSON file or inline parameters. @@ -188,8 +170,8 @@ Then use it in your test: CustomKeywords.'com.katalon.plugin.keyword.smartui.SmartKeywords.startServer'('Build v1.0', 'config.json', '') ``` -> 💡 Use `ignoreBoxes` to exclude dynamic elements (ads, timestamps) from comparison. -> 💡 Use `selectBoxes` to compare only specific regions (e.g., main content area). +> Use `ignoreBoxes` to exclude dynamic elements (ads, timestamps) from comparison. +> Use `selectBoxes` to compare only specific regions (e.g., main content area). --- @@ -221,16 +203,6 @@ CustomKeywords.'com.katalon.plugin.keyword.smartui.SmartKeywords.startServer'('B --- -## 🌐 Learn More - -For detailed API documentation and advanced features, visit: - -- [SmartUI Documentation](https://www.lambdatest.com/support/docs/smart-visual-regression-testing/) -- [Katalon Studio Docs](https://docs.katalon.com/) -- [Plugin GitHub Repository](https://github.com/LambdaTest/katalon-studio-smartui-plugin) - ---- - -``` \ No newline at end of file