https://github.com/chetangole/robot-framework-listener-ms-teams

Send notification of your Robot test suit execution to a configured MS Teams channel in real-time.
https://github.com/chetangole/robot-framework-listener-ms-teams

automation microsoft-teams robot-framework

Last synced: about 1 month ago
JSON representation

Send notification of your Robot test suit execution to a configured MS Teams channel in real-time.

• Host: GitHub
• URL: https://github.com/chetangole/robot-framework-listener-ms-teams
• Owner: chetangole
• Created: 2021-04-11T04:00:06.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-11-09T15:04:19.000Z (about 3 years ago)
• Last Synced: 2024-09-27T10:42:07.014Z (about 2 months ago)
• Topics: automation, microsoft-teams, robot-framework
• Language: Python
• Homepage:
• Size: 198 KB
• Stars: 8
• Watchers: 2
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Robot Framework Listener for Microsoft Teams

Send notification of your Robot test suit execution to a configured Microsoft Teams channel in real time. 

## Why use this listener

While using Robot Framework for our daily test automation, I realised that checking the result of test execution isn't easy task, you need to login into the Jenkins and search for the report. There was a need to automate the way we see the results. 

## What this listener does?

- Automated report generation without logging into the Jenkins Server. All the reports will be available in a configured Microsoft Teams channel with color coding and statistics about failed and passed test cases.

- If the test automation is very huge, the Jenkins reports are usually available only after the complete execution. Using this listener you will be able to see the reports of your test suit execution as soon as each suit completes. 

### Screenshot of the Microsoft Teams Card

![Screenshot](/screenshot.png?raw=true "Screenshot of Successful Result")

## How to install this listener

### Prerequisite

- Python with required libraries as specified in [requirements.txt](/requirements.txt)

- Robot Framework with test files

- The listener [MsTeamsListener.py](/MsTeamsListener.py)

- Incoming webhook for Microsoft Teams Channel. Please see [official Microsoft Documentation to create an incoming webhook](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook)

- The listener expects certain values as environment variables. 

  - WEBHOOK_URL=\

  - BUILD_URL= \

  - BUILD_NUMBER= \

### Installation

Robot Framework has a listener interface that can be used to receive notifications about test execution. You can simply include the file as a part of your listener using below command while executing the test. You can read more about how to use listener in [official documentation of Robot Framework](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#listener-interface).

```

robot --listener path/to/MsTeamsListener.py tests.robot

```

## FAQ

* What is Robot Framework?

Robot Framework is a Python-based, extensible keyword-driven automation framework for acceptance testing, acceptance test driven development (ATDD), behavior driven development (BDD) and robotic process automation (RPA). Fead more: https://robotframework.org/

* What is Microsoft Teams?

Microsoft Teams is a proprietary business communication platform developed by Microsoft, as part of the Microsoft 365 family of products. Read More: https://www.microsoft.com/en-in/microsoft-teams/group-chat-software