Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added a new document for Copado Integration #509

Merged
merged 1 commit into from
Sep 16, 2024
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
3 changes: 2 additions & 1 deletion src/left-nav-title.json
Original file line number Diff line number Diff line change
Expand Up @@ -693,5 +693,6 @@
"windows-automation": {"/docs/windows-automation/": "Windows Automation (Advanced)"},
"projects-and-applications": {"/docs/windows-lite-automation/projects-and-applications/": "Windows (Lite) Project & Application"},
"element-learning": {"/docs/windows-lite-automation/element-learning/": "Element Learning with Test Recorder"},
"test-cases": {"/docs/windows-lite-automation/test-cases/": "Test Cases for Windows (Lite)" }
"test-cases": {"/docs/windows-lite-automation/test-cases/": "Test Cases for Windows (Lite)" },
"copado-integration": {"/docs/continuous-integration/copado-integration/": "Copado CI/CD" }
}
75 changes: 75 additions & 0 deletions src/pages/docs/continuous-integration/copado-integration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
title: "Integrate Testsigma with Copado (Salesforce)"
metadesc: "Integrate Testsigma with Copado for effortless Salesforce test automation | Improve your testing efficiency accelerate Salesforce automation by integrating Testsigma with Copado"
noindex: false
order: 12.24
page_id: "Integrate Testsigma with Copado"
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Prerequisites"
url: "#prerequisites"
- type: link
name: "Configure Copado Release Manager App"
url: "#configure-copado-release-manager-app"
---

---

Testsigma Copado integration allows you to trigger test plan execution every time a Copado deployment is triggered. You can configure steps to trigger an event upon the completion of the test plan execution, pass the results back to Copado, and pause the deployment pipeline until the test plan execution is complete. This article discusses how to integrate Testsigma with Copado in Salesforce deployments.

---

## **Prerequisites**
> Before you proceed, ensure you the following:
> - An [API](https://testsigma.com/docs/configuration/api-keys/#steps-to-generate-api-key) Key from your Testsigma account.
> - [Test Cases](https://testsigma.com/docs/test-cases/create-test-steps/overview/) for Salesforce in Testsigma.
> - A [Test Plan](https://testsigma.com/docs/test-management/test-plans/overview/) in your Salesforce project.

---

## **Configure Copado Release Manager App**

1. Click **App Launcher** from the top navigation bar and search for **Copado Release Manager**.
![Search Copado Release Manager](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/CopadoSearch.png)

2. In the **Copado Release Manager App**, navigate to **Deployment > Steps > Add Step**.
![Navigate to Add Step](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Copado_Add_Steps.png)

3. Enter a name for the step in the **Step Name** textbox and select **URL Callout** from the **Type** dropdown menu.
![Type dropdown menu](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Details_Type_Dropdown.png)

2. On the details section, follow these steps:

<br>

* In the **Type** dropdown menu, select one of the following options:
1. **Perform callout and pause step**: This option helps you call an external system and wait for a response before deploying. It is useful when the deployment process depends on completing an external task, such as running automated tests and waiting for the results before continuing.

2. **Perform callout and continue with deployment**: This option helps you call an external system but continues with the deployment without waiting for a response. It is helpful when you have non-blocking automated tests that you want to run without delaying the deployment process.
![Options](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Options_Type.png)
Here, we are selecting the second option.
* In the Method, select **POST**.
* In the URL, enter the REST API call given in the **cURL**. For example, https://app.testsigma.com/api/v1/execution_results.
![CURL](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Curl_Copado.png)
You can also find the execution ID in the cURL response.
* Add the following headers:
1. **Authorization** and enter the **API Key**
2. **Accept** and enter **application/json**
3. **Content-Type** and enter **application/json**
* In the **Body**, paste the **JSON** payload
* Click **Save**

![Save Details](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Save_Details_Copado_API.png)


[[info | **NOTE**:]]
| - For Perform callout and pause step type, the system will generate a **Resume URL** once you enter and save the details.
| - Navigate to **Test Plans > Test Plan > Test Plan Settings**, select **Copado Test plan call back hook**, paste the Resume URL in the **Resume URL** textbox, and click **Update**.
| ![Test Plan Settings](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/TestPlan_Details_Copado.png)

Now, the Test Plan will run with the **Perform callout and pause step** option.

---
9 changes: 7 additions & 2 deletions src/pages/docs/continuous-integration/gitlab-cicd.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ contextual_links:
name: "Steps to integrate GitLab with Testsigma"
url: "#steps-to-integrate-gitLab-with-testsigma"
---
<br>


---

This article explains how to integrate GitLab with Testsigma for CI/CD purposes.

Expand Down Expand Up @@ -82,4 +84,7 @@ build-code-job:
Once the job is completed you can see the execution report as an XML report based on the path you have shared on the shell script.

9. Post completion of the job, you can see the details below:
![Post Run](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/postrun.png)
![Post Run](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/postrun.png)


---
2 changes: 1 addition & 1 deletion src/pages/docs/continuous-integration/shell-script.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ Now, let’s look at the script for the Unix shell:
TESTSIGMA_API_KEY=eyJhbGciOixxxxxxxxxxxxxxxTNpgv0w
TESTSIGMA_TEST_PLAN_ID=2090
MAX_WAIT_TIME_FOR_SCRIPT_TO_EXIT=1
JUNIT_REPORT_FILE_PATH=./junit-report-$(date +"%Y%m%d%H%M").xml
JUNIT_REPORT_FILE_PATH=./junit-report.xml
RUNTIME_DATA_INPUT="url=https://the-internet.herokuapp.com/login,test=1221"
BUILD_NO=$(date +"%Y%m%d%H%M")
#********END USER_INPUTS***********
Expand Down
Loading