1. How does SQAI Suite Leverage This Integration?
Connecting to Azure Repos allows SQAI to integrate directly into your development workflow, transforming test cases into execution-ready automation code:
Context-Aware Scripting: SQAI works technology-agnostic and reads your existing (test automation) codebase, framework conventions, and folder structure within the repository to generate high-quality, maintainable automation scripts that match your team's standards.
Direct Code Delivery: Allows SQAI to push generated automation code (e.g., Playwright or Selenium scripts) directly to a uniquely created branch in your repository as a Pull Request, ready for review and execution.
Version Control & Traceability: Ensures all generated code is immediately part of your version control history, linking back to the original test case by ID.
2. Information Required from Your Azure DevOps Account
To establish a secure, plug-and-play connection, we need three specific pieces of information, all of which can be quickly extracted from a repository URL, plus a secure Personal Access Token (PAT).
The required information is extracted from a URL structure like this:
⚠️ Example:
https://dev.azure.com/{YOUR_ORGANIZATION}/_git/{MY_REPO}
Note: If the URL includes the project, it would look like: https://dev.azure.com/{YOUR_ORGANIZATION}/{YOUR_PROJECT}/_git/{MY_REPO})
Required Detail | How to Find It in the URL | Example Value |
Organization Name | The first segment after |
|
Project Name | The second segment, if present (needed to locate the specific repo). |
|
Repo Name | The name that follows |
|
Personal Access Token (PAT) | Must be generated securely (See Section 3) |
|
3. Setting up the Integration
The most crucial step is generating a Personal Access Token (PAT) with the correct scope to ensure secure access for reading code context and writing new scripts.
🔑 Permission Requirements
The user generating the PAT must have the necessary permissions to clone, read, and push code to the repository.
PAT Scope Settings
When creating the PAT in Azure DevOps, ensure you set the following scopes to grant SQAI the necessary permissions:
Category | Required Scope Setting |
Code | Full (Allows SQAI to read existing code for context and write/push new automation scripts to a unique, per test case, SQAI-created branch in order not to directly interact with your main branches.) |
Reference: For detailed steps on generating the PAT, please consult the Azure DevOps documentation: Use personal access tokens - Azure DevOps | Microsoft Learn
4. Entering Details in SQAI Suite
Once you have secured your PAT and gathered your Organization, Project, and Repo details, you can complete the setup in the SQAI Suite platform.
Step 1: Navigate to Integrations Go to your SQAI Suite settings and select the Integrations page. Find and select the Azure Repos configuration.
Step 2: Enter Details Insert the following details into the corresponding fields:
Base URL (Optional)
Only applicabl if you have a custom Azure DevOps instance URL. Leave this empty if you use the default URL (https://dev.azure.com).
Organization Name
Project Name
Repo Name
Personal Access Token (PAT)
Step 3: Save and Confirm Click "Save Configuration." If the set-up is successful, you will receive a success message and see a green indicator next to your Azure Repos integration.
5. Troubleshooting Azure Repos Integration
If SQAI reports an error or fails to connect, use this checklist to quickly identify and resolve the most common issues related to code repository access.
Problem | Cause | Solution |
Connection Failed: "Unauthorized" or "Access Denied" | A. Incorrect PAT Scope: The Personal Access Token (PAT) is missing the required Read & Write permission for the Code category. | Verify PAT Scopes: Go to User Settings > Personal access tokens and confirm the active token includes Code: Read & Write. |
Invalid Resource: Cannot Find Repo | B. Incorrect Name/Typo: The Organization Name, Project Name, or Repo Name entered contains a typo. | Double-Check URL: Verify the names are entered exactly as they appear in the Azure DevOps URL (names are often case-sensitive). |
SQAI simply does not connect | C. IP Restriction/Whitelisting: Your Azure DevOps instance could be secured by an additional organizational firewall or VPN, preventing external access. | Contact IT: If the instance is in a VPC, contact your IT team to whitelist a dedicated SQAI Suite IP address for inbound connections. (Contact the SQAI Team for a Static IP) |
PAT Expired | D. Token Expiration: PATs are set to expire after a certain period (e.g., one year). | Generate New PAT: The original user must create a new PAT with the required scopes and update the configuration in SQAI Suite. |