diff --git a/docs/xcui-visual-regression.md b/docs/xcui-visual-regression.md new file mode 100644 index 000000000..5f594c9f6 --- /dev/null +++ b/docs/xcui-visual-regression.md @@ -0,0 +1,218 @@ +--- +id: xcui-visual-regression +title: Getting Started With Visual Regression Testing Using XCUI On SmartUI Real Devices +sidebar_label: XCUI +description: Dive into our detailed XCUI Visual Regression support documentation for step-by-step guidance! Efficiently perform visual testing, manage applications, and ensure your mobile apps are visually perfect before launch. +keywords: + - Visual Regression + - Visual Regression Testing Guide + - Visual Regression Test Automation + - Visual Regression Automation Testing + - Running Visual Regression Tests + - Visual Regression Testing Online + - Run Visual Regression + - Visual Regression Run Specific Test + - Visual Regression Testing Environment + - How to Run Visual Regression Tests + +url: https://www.lambdatest.com/support/docs/xcui-visual-regression/ +site_name: LambdaTest +slug: xcui-visual-regression/ +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys"; +import CodeBlock from '@theme/CodeBlock'; +import NewTag from '../src/component/newTag'; + + + +XCUI (XCTest UI) is Apple's native UI testing framework used for testing iOS applications. It is part of the XCTest framework and allows developers to write UI automation tests for iOS apps. In this documentation, you will learn step-by-step how to perform regression testing and find Visual UI Regression bugs easily with the help of Smart Testing. + +## Prerequisites + +- Your LambdaTest [Username and Access key](https://accounts.lambdatest.com/security). +- Access to an **iOS** app (.ipa) and an **iOS Test** app (.ipa file). +- Go to [`LambdaTest SmartUI`](https://smartui.lambdatest.com/) and login along with your credentials. + +## Step 1: Create a SmartUI Project + +The first step is to create a project with the application in which we will combine all your **builds** run on the project. +To create a SmartUI Project, follow these steps: + +1. Go to [Projects page](https://smartui.lambdatest.com/) +2. Click on the `new project` button +3. Select the platform as Real Device for executing your `XCUI` tests. +4. Add name of the project, approvers for the changes found, tags for any filter or easy navigation. +5. Click on the **Submit**. + +## Step 2: Set up your Authentication + +Now, you need to export your environment variables LT_USERNAME and LT_ACCESS_KEY that are available in the [LambdaTest Profile page](https://accounts.lambdatest.com/details/profile). + +Run the below mentioned commands in your terminal to setup the CLI and the environment variables. + + + + +
+ + {`export LT_USERNAME=${ YOUR_LAMBDATEST_USERNAME()} \\ +export LT_ACCESS_KEY=${ YOUR_LAMBDATEST_ACCESS_KEY()}`} + +
+ + + + + +
+ + {`set LT_USERNAME=${ YOUR_LAMBDATEST_USERNAME()} \` +set LT_ACCESS_KEY=${ YOUR_LAMBDATEST_ACCESS_KEY()}`} + +
+ + + + +## Step 3: Upload your Application + +To begin testing, upload your iOS application (.ipa file) to LambdaTest's servers. You'll use our **REST API** for this process. + +- **Authentication :** You'll need your LambdaTest Username and AccessKey. Combine them in the format `Username:AccessKey`. +- **Uploading the App :** Use **cURL command** to send a request to our API. The request should include the path to your application file (**appFile**). + + + + + +
+ + {`curl -u "${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}" --location --request POST 'https://manual-api.lambdatest.com/app/uploadFramework' --form 'appFile=@""' --form 'type="xcuit-ios"'`} + +
+ + + + + +
+ +{`curl -u "${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}" --location --request POST "https://manual-api.lambdatest.com/app/uploadFramework" --form "appFile=@""" --form "type=\"xcuit-ios\""`} + +
+ + + + +:::info +- Provide the path of your ios application in the above URL in place of `` +- Response of above cURL will be a **JSON** object containing the `App URL` of the format - `lt://APP123456789123456789` and will be used in the last step. +::: + +## Step 4: Upload Your Test Suite + +Upload your XCUI test suite (.ipa) file to LambdaTest servers using our REST API. + +The following sample cURL command shows how to upload a test suite: + + + + + +
+ + {`curl -u "${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}" --location --request POST 'https://manual-api.lambdatest.com/app/uploadFramework' --form 'appFile=@""' --form 'type="xcuit-ios"'`} + +
+ + + + + +
+ +{`curl -u "${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}" --location --request POST "https://manual-api.lambdatest.com/app/uploadFramework" --form "appFile=@""" --form "type=\"xcuit-ios\""`} + +
+ + + + +:::info +- Provide the path of your ios application in the above URL in place of `` +- Response of above cURL will be a **JSON** object containing the `App URL` of the format - `lt://APP123456789123456789` and will be used in the last step. +::: + +## Step 5: Executing The Test + +- You will need **base64 encoded authentication** in order to execute your Espresso automation test suite. Enter your `username:accesskey` in **[Basic Authentication Header Generator](https://mixedanalytics.com/knowledge-base/api-connector-encode-credentials-to-base-64/)** to generate your auth token. + +Take note of the base64 encoded authentication which needs to be added in the next step. + +
+ +{`${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}`} + +
+ +- Once you have uploaded your app and test suite, you can execute your test by running the following command: + +> Enter your **BASIC_AUTH_TOKEN**, **APP_ID** (generated in the fourth step) and **TEST_SUITE_ID** (generated in the fifth step) in the below command. + +```javascript +curl --location 'https://mobile-api.lambdatest.com/framework/v1/xcui/build' \ +--header 'Authorization: Basic BASIC_AUTH_TOKEN' \ +--header 'Content-Type: application/json' \ +--data '{ + "app" : "APP_ID", //enter your app-id + "testSuite": "TEST_SUITE_ID", //enter your test-suite id + "device" : ["iPhone 13-16"], //enter your device names + "smartUI.project": "XCUI-SmartUI-Project", + "build" : "Proverbial-XCUITest", + "video" : true, + "queueTimeout": 10800, + "idleTimeout": 150, + "devicelog": true, + "network": false, + "only-testing" : ["LambdaUiKitIOSUITestsLaunchTests"], + "smartUI.cropStatusBar" : true, + "smartUI.cropNavigationBar" : true +}' +``` + +> You can check the executed builds over at [LambdaTest SmartUI](https://smartui.lambdatest.com/). + +## Smart Crop With SmartUI + +The all-new **Real Device mobile notification status bar and navigation bar crop** feature in SmartUI allows you to take your visual regression testing workflows to the next level. With Smart Crop, you can crop the status bar and navigation bar or footer from screenshots, enabling them to focus solely on the core UI elements during visual comparisons. + +By leveraging machine learning algorithms, it accurately detects and crops the status bar and navigation bar from screenshots. With precise image processing techniques, SmartUI precisely identifies the location of status bar elements. By excluding it from visual comparisons, the focus is solely on critical UI elements. + +| Original Screenshot | Cropped Screenshot | +|---------------------|--------------------| +| Profile | Profile | \ No newline at end of file diff --git a/sidebars.js b/sidebars.js index 99d881c67..bb8194d66 100644 --- a/sidebars.js +++ b/sidebars.js @@ -2847,8 +2847,10 @@ module.exports = { label: "Visually Test Your Native Apps", items: [ "appium-visual-regression", + "smartui-xcui-updates", + "espresso-visual-regression", + "xcui-visual-regression", "smartui-app-sdk", - "espresso-visual-regression" ] }, ]