Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 3 additions & 7 deletions docs/kane-ai-web-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,20 +55,16 @@ For example:
- Visit the website "www.lambdatest.com"
- Click on the Login button.

Keep adding instructions/commands in plain English as you go; KaneAI will automatically queue them up for execution, so you don't have to wait for one test to finish before writing the next. Click on the **Finish Test** button.
Keep adding tests in plain English as you go; KaneAI will automatically queue them up for execution, so you don't have to wait for one test to finish before writing the next. Click on the **Fininsh Test** button.
> **Remember:** The more specific you are, the more accurate KaneAI's generated test cases will be.

<img loading="lazy" src={require('../assets/images/kane-ai/write-web-test.gif').default} alt="Image" width="1347" height="616" className="doc_img"/>

### Step 3: Save your Test Case
Now, save your test cases that you have generated till now.

Select your Project, and the folder in which you want to store your test cases. The **Test Name** and the **Description** will be generated automatically, and you can also edit it. Select the **Type** of your test, and the **Status**, and define the necessary tags which will help ypu to search your tests later.
Select your Project, and the folder in which you want to store your test cases. The **Test Name** and the **Description** will be generated automatically, and you can also edit it. Select the **Type** of your test, and the status, and define the necessary tags which will help ypu to search your tests later.
<img loading="lazy" src={require('../assets/images/kane-ai/save-test.png').default} alt="Image" width="1347" height="616" className="doc_img"/>

### Step 4: Execute your test
To execute your test, click on the **HyperExecute** button and you will be redirected to the [HyperExecute dashboard](https://hyperexecute.lambdatest.com/hyperexecute/jobs) where your tests will be executed.

Click on the view test button and you will be redirect to the automation dashboard from where you can check all the commands executed, logs, meta data and video of the test executed.

<img loading="lazy" src={require('../assets/images/kane-ai/execute-test.gif').default} alt="Image" width="1347" height="616" className="doc_img"/>
<img loading="lazy" src={require('../assets/images/kane-ai/execute-test.gif').default} alt="Image" width="1347" height="616" className="doc_img"/>
24 changes: 24 additions & 0 deletions docs/smartui-cli-env-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,30 @@ Welcome to the world of simplified visual testing with the SmartUI SDK.

This guide is designed to provide you with comprehensive information about the various environment variables options available within the SmartUI SDK. SmartUI retrieves additional details from the environment it is running in, like the branch name, baseline branch,proxies etc. You can modify certain aspects of SmartUI behavior by configuring these environment variables within your CI environment:

## 1. Setting the Project Name

Set the Project Name you want to add the current build run to by exporting these environment variables:

<Tabs className="docs__val" groupId="language">
<TabItem value="MacOS/Linux" label="MacOS/Linux" default>

```bash
export LT_USERNAME="YOUR USERNAME"
export LT_ACCESS_KEY="YOUR ACCESS KEY"
export PROJECT_NAME="Required Project Name"
```
</TabItem>
<TabItem value="Windows" label="Windows" default>

```bash
set LT_USERNAME="YOUR USERNAME"
set LT_ACCESS_KEY="YOUR ACCESS KEY"
set PROJECT_NAME="Required Project Name"
```
</TabItem>
</Tabs>

> If you specify a project name that doesn't already exist, a new project will be created by the user whose authentication is added in the environment.


## 1. Setting the Baseline Branch
Expand Down
106 changes: 106 additions & 0 deletions docs/smartui-with-azure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
---
id: smartui-with-azure
title: Azure Pipeline Integration with SmartUI
sidebar_label: Azure
description: SmartUI now integrates with Azure Pipeline to boost pipeline delivery. Perform automated cross browser testing with SmartUI to seamlessly providing 3000+ real browsers running through machines.
keywords:
- lambdatest integrations
- smart ui integration
- smart ui integrations with ci/cd tools
- ci/cd tools
- continuous integration,continuous delivery
- continuous integration tools
- azure ci cd
url: https://www.lambdatest.com/support/docs/smartui-with-azure/
site_name: LambdaTest
slug: smartui-with-azure/
---

<script type="application/ld+json"
dangerouslySetInnerHTML={{ __html: JSON.stringify({
"@context": "https://schema.org",
"@type": "BreadcrumbList",
"itemListElement": [{
"@type": "ListItem",
"position": 1,
"name": "LambdaTest",
"item": "https://www.lambdatest.com"
},{
"@type": "ListItem",
"position": 2,
"name": "Support",
"item": "https://www.lambdatest.com/support/docs/"
},{
"@type": "ListItem",
"position": 3,
"name": "Azure Integration",
"item": "https://www.lambdatest.com/support/docs/smartui-with-azure/"
}]
})
}}
></script>
Azure Pipelines is a cloud-based CI/CD service offered by Microsoft, part of the Azure DevOps suite. It helps automate the process of building, testing, and deploying applications to various platforms.

This guide explains how to integrate your project with the Azure CI/CD pipeline to trigger visual regression testing with LambdaTest SmartUI whenever changes are made to your repository.

## Steps to Integrate Azure Pipeline with SmartUI
To integrate Azure Pipeline with SmartUI, follow the below steps. You can use your own project to configure and test it. For demo purposes, we are using the sample repository.

:::tip Sample repo
Download or Clone the code sample from the LambdaTest GitHub repository to run the tests on the SmartUI.

<a href="https://github.com/amanchopra1905/smartui-ci-cd-integrations" target="_blank" className="github__anchor"><img loading="lazy" src={require('../assets/images/icons/github.png').default} alt="Image" className="doc_img"/> View on GitHub</a>
:::


### Step 1: Set Up Your Repository
Ensure your project is hosted in Azure Repos, GitHub, or any supported repository.

### Step 2: Create a New Pipeline:

- Navigate to Pipelines in your Azure DevOps project.
- Select New Pipeline and connect your repository.

### Step 3: Add Environment Variables

Go to Pipeline Settings > Variables. Add the following variables:
- `LT_USERNAME`: Your LambdaTest username.
- `LT_ACCESS_KEY`: Your LambdaTest access key.

### Step 4: Setup your Workflow
```yaml title="azure-pipelines.yml"
trigger:
- '*'

variables:
LT_USERNAME: $(LT_USERNAME)
LT_ACCESS_KEY: $(LT_ACCESS_KEY)

jobs:
- job: SmartUI_Tests
pool:
vmImage: 'ubuntu-latest'

steps:
- task: UseNode@2
inputs:
version: '16.x'

- script: |
echo "Installing dependencies"
npm install @lambdatest/smartui-cli
displayName: 'Install Dependencies'

- script: |
echo "Running SmartUI tests"
npx smartui --version
npx smartui config:create smartui-web.json
npx smartui --config smartui-web.json exec -- mvn --quiet test -D suite=sdk-cloud.xml
displayName: 'Execute SmartUI Tests'
```

### Step 5: Check the output

- After triggering the workflow, check your results in the [Smart UI Dashboard](https://smartui.lambdatest.com/projects)

<img loading="lazy" src={require('../assets/images/smart-visual-testing/ci-cd-integration/gitlab/3.png').default} alt="Create New Project" width="" height=""/>
26 changes: 2 additions & 24 deletions docs/smartui-with-bitbucket.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,30 +66,8 @@ Download or Clone the code sample from the LambdaTest GitHub repository to run t
- Now, write your workflow YAML file. Here is the sample file for your reference.
- Commit this yaml file in your repository and make the required changes in your code to automatically trigger the pipeline.

```yaml title="bitbucket-pipelines.yml"
image: maven:3.8.5-openjdk17 # Image with Maven and OpenJDK

pipelines:
default:
- step:
name: Install Dependencies
script:
- mvn clean install # Installs project dependencies

- step:
name: Configure SmartUI
script:
- npm install -g @lambdatest/smartui-cli # Install SmartUI CLI globally
- npx smartui config:create .smartui.json # Generate SmartUI config file

- step:
name: Run Visual Regression Tests
script:
# Set environment variables directly in the pipeline
- export LT_USERNAME=${LT_USERNAME}
- export LT_ACCESS_KEY=${LT_ACCESS_KEY}
- export PROJECT_TOKEN=${PROJECT_TOKEN}
- npx smartui --config .smartui.json exec -- mvn test -Dsuite=sdk-cloud.xml
```yaml reference title="bitbucket-pipelines.yml"
https://github.com/amanchopra1905/smartui-ci-cd-integrations/blob/bitbucket/bitbucket-pipelines.yml
```

:::tip
Expand Down
95 changes: 95 additions & 0 deletions docs/smartui-with-buildkite.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
---
id: smartui-with-buildkite
title: Buildkite Pipeline Integration with SmartUI
sidebar_label: Buildkite
description: SmartUI now integrates with Buildkite Pipeline to boost pipeline delivery. Perform automated cross browser testing with SmartUI to seamlessly providing 3000+ real browsers running through machines.
keywords:
- lambdatest integrations
- smart ui integration
- smart ui integrations with ci/cd tools
- ci/cd tools
- continuous integration,continuous delivery
- continuous integration tools
- buildkite ci cd
url: https://www.lambdatest.com/support/docs/smartui-with-buildkite/
site_name: LambdaTest
slug: smartui-with-buildkite/
---

<script type="application/ld+json"
dangerouslySetInnerHTML={{ __html: JSON.stringify({
"@context": "https://schema.org",
"@type": "BreadcrumbList",
"itemListElement": [{
"@type": "ListItem",
"position": 1,
"name": "LambdaTest",
"item": "https://www.lambdatest.com"
},{
"@type": "ListItem",
"position": 2,
"name": "Support",
"item": "https://www.lambdatest.com/support/docs/"
},{
"@type": "ListItem",
"position": 3,
"name": "Buildkite Integration",
"item": "https://www.lambdatest.com/support/docs/smartui-with-buildkite/"
}]
})
}}
></script>
Buildkite is a hybrid CI/CD platform that allows you to run builds in your own infrastructure, alongside cloud-based execution. This means you can leverage the power of your existing machines or cloud resources to run builds.

This guide explains how to integrate your project with the Buildkite CI/CD pipeline to trigger visual regression testing with LambdaTest SmartUI whenever changes are made to your repository.

## Steps to Integrate Buildkite Pipeline with SmartUI
To integrate Buildkite Pipeline with SmartUI, follow the below steps. You can use your own project to configure and test it. For demo purposes, we are using the sample repository.

:::tip Sample repo
Download or Clone the code sample from the LambdaTest GitHub repository to run the tests on the SmartUI.

<a href="https://github.com/amanchopra1905/smartui-ci-cd-integrations" target="_blank" className="github__anchor"><img loading="lazy" src={require('../assets/images/icons/github.png').default} alt="Image" className="doc_img"/> View on GitHub</a>
:::

### Step 1: Set Up Your Repository
Ensure your project is hosted in GitHub, or any supported repository.

### Step 2: Create a New Pipeline:

- Navigate to Pipelines in your Buildkite project.
- Select New Pipeline and connect your repository.

### Step 3: Add Environment Variables

Go to Pipeline Settings > Variables. Add the following variables:
- `LT_USERNAME`: Your LambdaTest username.
- `LT_ACCESS_KEY`: Your LambdaTest access key.

### Step 4: Setup your Workflow

```yaml title="pipeline.yml"
steps:
- label: "SmartUI Tests"
agents:
queue: "default"
env:
LT_USERNAME: "${LT_USERNAME}"
LT_ACCESS_KEY: "${LT_ACCESS_KEY}"
commands:
- echo "Checking out code"
- git clone <REPO_URL>
- cd <PROJECT_DIRECTORY>
- echo "Installing SmartUI CLI"
- npm install @lambdatest/smartui-cli
- echo "Running SmartUI tests"
- npx smartui --version
- npx smartui config:create smartui-web.json
- npx smartui --config smartui-web.json exec -- mvn --quiet test -D suite=sdk-cloud.xml
```

### Step 5: Check the output

- After triggering the workflow, check your results in the [Smart UI Dashboard](https://smartui.lambdatest.com/projects)

<img loading="lazy" src={require('../assets/images/smart-visual-testing/ci-cd-integration/gitlab/3.png').default} alt="Create New Project" width="" height=""/>
103 changes: 103 additions & 0 deletions docs/smartui-with-circle-ci.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
---
id: smartui-with-circle-ci
title: Circle CI Pipeline Integration with SmartUI
sidebar_label: Circle CI
description: SmartUI now integrates with Circle CI Pipeline to boost pipeline delivery. Perform automated cross browser testing with SmartUI to seamlessly providing 3000+ real browsers running through machines.
keywords:
- lambdatest integrations
- smart ui integration
- smart ui integrations with ci/cd tools
- ci/cd tools
- continuous integration,continuous delivery
- continuous integration tools
- circle-ci ci cd
url: https://www.lambdatest.com/support/docs/smartui-with-circle-ci/
site_name: LambdaTest
slug: smartui-with-circle-ci/
---

<script type="application/ld+json"
dangerouslySetInnerHTML={{ __html: JSON.stringify({
"@context": "https://schema.org",
"@type": "BreadcrumbList",
"itemListElement": [{
"@type": "ListItem",
"position": 1,
"name": "LambdaTest",
"item": "https://www.lambdatest.com"
},{
"@type": "ListItem",
"position": 2,
"name": "Support",
"item": "https://www.lambdatest.com/support/docs/"
},{
"@type": "ListItem",
"position": 3,
"name": "Circle CI Integration",
"item": "https://www.lambdatest.com/support/docs/smartui-with-circle-ci/"
}]
})
}}
></script>
CircleCI is a popular CI/CD tool known for its speed, flexibility, and seamless integration with version control systems like GitHub and Bitbucket. It is cloud-native and also offers an on-premises solution.

This guide explains how to integrate your project with the CircleCI CI/CD pipeline to trigger visual regression testing with LambdaTest SmartUI whenever changes are made to your repository.

## Steps to Integrate CircleCI Pipeline with SmartUI
To integrate CircleCI Pipeline with SmartUI, follow the below steps. You can use your own project to configure and test it. For demo purposes, we are using the sample repository.

:::tip Sample repo
Download or Clone the code sample from the LambdaTest GitHub repository to run the tests on the SmartUI.

<a href="https://github.com/amanchopra1905/smartui-ci-cd-integrations" target="_blank" className="github__anchor"><img loading="lazy" src={require('../assets/images/icons/github.png').default} alt="Image" className="doc_img"/> View on GitHub</a>
:::

### Step 1: Set Up Your Repository
Ensure your project is hosted in GitHub, or any supported repository.

### Step 2: Create a New Pipeline:

- Navigate to Pipelines in your CircleCI project.
- Select New Pipeline and connect your repository.

### Step 3: Add Environment Variables

Go to Pipeline Settings > Variables. Add the following variables:
- `LT_USERNAME`: Your LambdaTest username.
- `LT_ACCESS_KEY`: Your LambdaTest access key.

### Step 4: Setup your Workflow

```yaml title=".circleci/config.yml"
version: 2.1
jobs:
smartui_test:
docker:
- image: circleci/node:16
environment:
LT_USERNAME: $LT_USERNAME
LT_ACCESS_KEY: $LT_ACCESS_KEY
steps:
- checkout
- run:
name: Install Dependencies
command: npm install @lambdatest/smartui-cli
- run:
name: Execute SmartUI Tests
command: |
npx smartui --version
npx smartui config:create smartui-web.json
npx smartui --config smartui-web.json exec -- mvn --quiet test -D suite=sdk-cloud.xml

workflows:
version: 2
smartui_pipeline:
jobs:
- smartui_test
```

### Step 5: Check the output

- After triggering the workflow, check your results in the [Smart UI Dashboard](https://smartui.lambdatest.com/projects)

<img loading="lazy" src={require('../assets/images/smart-visual-testing/ci-cd-integration/gitlab/3.png').default} alt="Create New Project" width="" height=""/>
Loading
Loading