Skip to content

Commit

Permalink
Merge pull request #279 from testsigmahq/doc-224
Browse files Browse the repository at this point in the history 
Updated the docs as per new UI
  • Loading branch information
@bharathk08
bharathk08 authored Sep 21, 2023
2 parents a9c5ea3 + ce549e0 commit f88169a
Show file tree
Hide file tree
Showing 6 changed files with 175 additions and 188 deletions.
44 changes: 38 additions & 6 deletions src/pages/docs/continuous-integration/bitbucket-ci.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,49 @@ warning: false
---
---

You will need to setup a Bitbucket pipeline to integrate Testsigma to Bitbucket. To know how to create a bitbucket pipeline please refer here: https://support.atlassian.com/bitbucket-cloud/docs/get-started-with-bitbucket-pipelines/
You can trigger tests automatically with Bitbucket integration with Testsigma. This article explains how to integrate Bitbucket with Testsigma for CI/CD purposes.

---

## **Prerequisites**
- Testsigma API key. For more information, see [Generate API Key](https://testsigma.com/docs/configuration/api-keys/).
- Testsigma Test Plan ID. For more information, refer to [Get Test Plan ID](https://testsigma.com/docs/continuous-integration/get-test-plan-details/).

---

## **Steps to Integrate Bitbucket with Testsigma**
1. On your project, navigate to **Repository > Pipelines**.
![Bitbucket Project](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/bbprojet.png)

2. Click on **Create your first pipeline** and select **Starter pipeline**.
![Create First Pipeline](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/plbb.png)

3. Create a job using the below YML sample.

Follow below steps to configure your bitbucket pipeline to execute Testsigma tests:
```
pipelines:
default:
- parallel:
- step:
name: 'Build and Test'
script:
- echo "Your build and test goes here..."
- echo "Calling Shell Script of testsigma"
- chmod a+x testsigma-cicd.sh
- ./testsigma-cicd.sh
```

1. Go to the page [here](https://testsigma.com/docs/continuous-integration/shell-script/) and save the script as "testsigma-cicd.sh"
[[info | **NOTE**:]]
|Refer to the Shell Script to get the sh script, which contains the command that triggers the test plan and fetches the run result. You can place the sh script in the same project, call the file inside the YML file, or obtain it from any external sources by providing the appropriate path.<br> <br>
|Any bash runner can work with the provided YML file. For instance, if you are using the docker runner, you can use the YML file as it is. However, if you have a different runner like powershell, you must modify the YML file to make it executable in the powershell runner. Additionally, ensure that powershell is version seven or above.

2. Edit your bitbucket-pipelines.yml and add this command to your script section:
testsigma-cicd.sh
4. In the shell script, provide the **Test Plan ID** and **API Key**.
![Test Plan In Shell Script](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tsssbb.png)

5. Once you have created the YML script, click on **Commit** to run the job.
![Commit](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/firstplbb.png)

With above changes, the "testsigma-cicd.sh" script will be triggered whenever the bitbucket pipeline executes. The script will wait until the test completes and checks that the result of the tests is passed.
6. 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.
![Report](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/buildbb.png)

---
98 changes: 43 additions & 55 deletions src/pages/docs/integrations/bug-reporting/youtrack.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: " Youtrack Bug Reporting Integration"
title: "Youtrack Bug Reporting Integration"
page_title: "Youtrack Bug Reporting Integration in Testsigma"
metadesc: "How to integrate Testsigma with Youtrack for real-time bug reporting during Test Runs | Push bugs directly from Testsigma to your YouTrack's project"
noindex: false
Expand All @@ -13,8 +13,8 @@ contextual_links:
name: "Prerequisites"
url: "#prerequisites"
- type: link
name: "Creating Youtrack API Key"
url: "#creating-youtrack-api-key"
name: "Steps to Create API Token in Youtrack"
url: "#steps-to-create-api-token-in-youtrack"
- type: link
name: "Integrating YouTrack with Testsigma"
url: "#integrating-youtrack-with-testsigma"
Expand All @@ -25,78 +25,66 @@ contextual_links:

---

With Testsigma YouTrack integration, you can push bugs directly from Testsigma to your YouTrack's project, capture screenshots, annotate bugs, and share them with your teammates and colleagues.

In this document, we will discuss how to establish Integration with Youtrack from your Testsigma account and how to create the first bug from Testsigma which can flow into Youtrack.
You can integrate Testsigma with YouTrack to push bugs directly to YouTrack's project. You can also capture screenshots, annotate bugs, and share them with your team. In this document, we will discuss how to integrate Youtrack with Testsigma and also how to create the first bug from Testsigma which can flow into Youtrack.

---
##**Prerequisites**

To integrate Youtrack with Testsigma, you need the following information from your Youtrack Account
* Account URL - Your organization’s Youtrack Account URL
* API Key - Check the next section **Creating Youtrack API Key** to know how to get the API Token

You should already know about [Test Plan Runs and results](https://testsigma.com/docs/runs/test-plan-executions/)
## **Prerequisites**
To integrate Youtrack with Testsigma, you need the following:
- **Account URL:** Your organization’s Youtrack Account URL
- **API Key:** API Token from Youtrack

---
##**Creating Youtrack API Key**

Follow the below steps to get the API token:

1. Log in to your YouTrack account and navigate to Profile on the top-right.

![Menu under Profile dropdown on Youtrack Dashboard page](https://docs.testsigma.com/images/youtrack/youtrack-dashboard-profile-menu.png)
## **Steps to Create API Token in Youtrack**
1. Navigate to **Youtrack Profile**.
![Youtrack Profile](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ytprofile.png)

2. Click on the link that says 'Update personal information and manage logins'
2. Go to **Account Security** and click on **New Token**.
![New Token](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ytnewtoken.png)

![Manage Logins link highlighted under General tab on Youtrack Profile page](https://docs.testsigma.com/images/youtrack/0.png)
3. On **New Permanent Token**, enter **Name**, **Scope** and click on **Create**.
![Permanent Token](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ytpermnewtoken.png)

3. Select the 'Authentication' tab
4. Click on **Copy Token**.
![Copy Tocken](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Copytkenyt.png)

![Create new token in Authentication tab under Youtrack users page](https://docs.testsigma.com/images/youtrack/youtrack-users-settings-authentication-create-token.png)

4. Click on 'New Token'.
5. Enter a Token name and click on 'Create'.
6. Your new token will be generated. Click on 'Copy Token' to copy the API Token value.
Now you’re ready to integrate Youtrack with Testsigma.

---
## **Integrating Youtrack with Testsigma**
1. Navigate to **Settings > Integrations**.
![Integrations](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ytintegrations.png)

Once the above details are obtained, navigate to the Plugins page through **Dashboard > Settings > Plugins** and select Youtrack under the Bug Reporting Tab.

Click on the Disabled Icon on **Youtrack**. Youtrack Details overlay opens up as shown below:
2. Enable toggle on **Youtrack** widget.
![Youtrack Toggle](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/yttoggle.png)

![Add Youtrack Integration form](https://docs.testsigma.com/images/youtrack/plugins-add-youtrack-integration-form.png)
3. On **Youtrack Details** prompt, enter **Organization URL** and **Access Key**.
![Youtrack Toggle](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/youtrackdetails.png)

Enter the details mentioned in Prerequisites. After entering the details, click on the Create button to add the Integration.

---
##**Creating a bug**
4. Click on **Save & Enable**.
![Save & Enable](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/saveandenableyt.png)

We can create a bug within Testsigma from the run results page for a particular Test Plan. Here’s how:

1. Navigate to the run results test case level page where you want to add a bug.
2. Click on the **Report Bug** button (bug icon on the top right corner) to open the Bug Reporting overlay.

![report bug button on the run test case page for run results ](https://docs.testsigma.com/images/youtrack/run-results-test-case-page-report-bug-button-youtrack.png)

3. Choose Youtrack and enter information about your bug.

![Sample Task reported from Testsigma Bug Reporting Integration in Test Results page](https://docs.testsigma.com/images/youtrack/plugins-report-bug-create-new-youtrack-issue.png)

[[info | NOTE:]]
|Only the bug reporting tools that have been enabled via the plugins page (add link) will be displayed here.

If you want to link to an existing issue on Youtrack, click on the **Link to Issue** button, search for an existing issue in the search field and click on Link Issue to add a link to an existing Issue on Youtrack. Otherwise, enter the bug details in the form as required.

4. Click on Create to create the Bug.

When the bug is created, some additional details regarding the Test Result such as the Test Execution Video and Step Screenshots are added automatically by Testsigma. This helps the developer who checks the issue in Youtrack to understand the issue/bug better with more context.

Once the above details are obtained, navigate to the Plugins page through **Dashboard > Settings > Plugins** and select Youtrack under the Bug Reporting Tab.

---

## **Creating a Bug**
1. Navigate to **Run Results > Test Case Result**, where you want to add a bug.
![Run Results](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tcresultyt.png)

2. Click on **Report Bug**.
![Report Bug](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/reportbugyt.png)

3. On **Report** overlay, click on the **Youtrack** icon.
![Youtrack Icon](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/yticon.png)

4. On the **Create New Issue** prompt, click on **Create Ticket**.
![Create New Issue](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/createticketyt.png)

[[info | **NOTE**:]]
| If you want to link to an existing issue on **Youtrack**, click on the **Link to Issue** button, search for an existing issue in the search field and click on **Link Issue** to add a link to an existing Issue.
|![Link to New Issue](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/linktoisssue.png)

Here's a quick GIF demonstrating how to integrate Youtrack and add a bug to Youtrack from Testsigma.
![YouTrtack](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/youtrackint.gif)
---
54 changes: 28 additions & 26 deletions src/pages/docs/integrations/product-management/clickup.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,49 +20,51 @@ contextual_links:
---
---

With Testsigma and Clickup integration, you can push bugs directly from Testsigma to your Clickup project, capture screenshots, annotate bugs, and share them with your teammates and colleagues.
In this document, we will discuss how to establish Integration with Clickup from your Testsigma account and how to create the first bug from Testsigma which can flow into Clickup.
You can integrate Testsigma with Clickup to push bugs directly to Clickup’s project. You can also capture screenshots, annotate bugs, and share them with your team. In this document, we will discuss how to integrate Clickup with Testsigma and also how to create the first bug from Testsigma which can flow into Clickup.

## **Prerequisites**

To integrate Clickup with Testsigma, you need the following information from your Clickup Account (Check how to get the API key here: https://docs.clickup.com/en/articles/1367130-getting-started-with-the-clickup-api)
---

- Personal API Key
## **Prerequisites**
To integrate Clickup with Testsigma, you need the following:
- **API Key:** API Token from Clickup.

You should also be familiar with [Test Plan Runs](https://testsigma.com/docs/runs/test-plan-executions/).
[[info | **NOTE**:]]
|*For more information on how to create API token in Clickup, refer to Clickup [personal API key](https://help.clickup.com/hc/en-us/articles/6303426241687-Getting-Started-with-the-ClickUp-API).*

---

## **Integrating Clickup with Testsigma**
## **Steps to Integrate Clickup with Testsigma**
1. Navigate to **Settings > Integrations**.
![Integrations](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ytintegrations.png)

1. Once the above details are obtained, navigate to the Plugins page through Dashboard > Settings > Plugins and select Clickup under the Bug Reporting Tab.
2. Click on the Disabled Icon on Clickup. Clickup Details overlay opens up, as shown below:
2. Enable toggle on **Clickup** widget.
![Enable Toggle](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/toggleclickup.png)

![the clickup overlay to integrate with Testsigma](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/integrations/product-management/clickup/clickup-overlay-to-integrate.png)
3. On the **ClickUp details** prompt, enter the **Personal Token** and click on **Save & Enable**.
![Save & Enable](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/cusaveenable.png)

3. Enter the details as mentioned in Prerequisites. After entering the details, click on the Create button to add the Integration.

---

## **Creating a bug**
1. Navigate to **Run Results > Test Case Result**, where you want to add a bug.
![Run Results](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tcresultyt.png)

We can create a bug within Testsigma from the run results page for a particular Test Plan with the following steps:
1. Navigate to the run results test case level page where you want to add a bug.
2. Click on the Report Bug button(bug icon on the top right corner) to open the Bug Reporting overlay.

![report but on a test case execution result page](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/integrations/product-management/clickup/run-test-case-report-bug-clickup.png)

3. Choose Clickuup and enter the detailed information of your bug.

[[info | NOTE:]]
|Only the bug reporting tools that have been enabled via the plugins page (add link) will be displayed here.

If you want to link to an existing issue on Clickup, click on the Link to Issue button, search for an existing issue in the search field and click on Link Issue to add a link to an existing Issue on Clickup. Otherwise, enter the bug details in the form as required.
2. Click on **Report Bug**.
![Report Bug](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/reportbugyt.png)

4. Click on Create to create the Bug.
3. On **Report** overlay, click on the **Clickup** icon.
![Report Overlay](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/clickupreport.png)

When the bug is created, some additional details regarding the Test Result such as the Test Execution Video and Step Screenshots are added to the Issue on Clickup automatically by Testsigma. This helps the developer who checks the issue in Clickup to understand the issue/bug better with more context.
4. On the **Create New Issue** prompt, click on **Create Ticket**.
![Create Ticket](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/cucreateticket.png)

[[info | **NOTE**:]]
| If you want to link to an existing issue on Clickup, click on the **Link to Issue** button, search for an existing issue in the search field and click on **Link Issue** to add a link to an existing Issue.
|![Link to Isse](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/culinktoissue.png)


Here's a quick GIF demonstrating how to integrate Clickup and add a bug to Clickup from Testsigma.
![Clickup Integration](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/clickupgif.gif)

---
Loading

0 comments on commit f88169a

Please sign in to comment.