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

Add teams notification feature - Enabling push notifications to teams channel #57

Merged

Conversation

BharatKumarEY
Copy link
Contributor

@BharatKumarEY BharatKumarEY commented Nov 21, 2023

Integrating the notifications to Teams Channel

Description

I've expanded the notification capability within the spark_expectations library to include Microsoft Teams alongside the existing Slack notifications. This improvement allows users to receive updates on data quality job execution status across both Slack and Teams platforms.

Related Issue

Please link to the issue here: #56

Motivation and Context

The motivation behind this change is to broaden the reach of data quality framework execution status notifications. While Slack is a popular communication platform, some organizations prefer or exclusively use Microsoft Teams. By incorporating Teams notifications into the spark_expectation library, we enhance its usability for a wider audience, ensuring that data quality job execution status alerts are accessible across multiple collaboration tools.

How Has This Been Tested?

To ensure the reliability and functionality of the Teams notification feature, I thoroughly tested the following aspects:
Unit Tests:- Implemented unit tests to verify the correctness of the Teams notification implementation.
Integration Testing: Conducted integration tests by simulating different data quality scenarios and validating the generation and delivery of notifications to Teams.
Environment: Tested the feature in various environments like databricks, local IDEs as well as to ensure compatibility and functionality across different setups.
Message Formatting: Checked the appearance and readability of messages sent to Teams to ensure they display correctly.
Link to Unit test doccument:-
This comprehensive testing approach aimed to validate the feature's effectiveness, compatibility, and correctness before integrating it into the spark_expectations library.

Screenshots (if appropriate):

Test Results & Proofs - SE Teams Notif Feature.zip
Please refer the attachments section

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@asingamaneni
Copy link
Collaborator

@BharatKumarEY Thanks for the contribution!
Looks like the build failed because of the linting issues. Can you please run make fmt in your local and again run make cov to make sure the tests pass and push the code again.

@BharatKumarEY
Copy link
Contributor Author

@asingamaneni Linting issues got resolved, I've ran the make fmt and make cov in my local and it's success.

@BharatKumarEY
Copy link
Contributor Author

@asingamaneni I see the Deploy failed due to type error, we fixed it and ran the mypy and now it it's success and also ran the make cov
report too. PFA of the screenshots.

make cov report
mypy - error rectififed

Copy link

codecov bot commented Nov 22, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (ca1ceb5) 100.00% compared to head (f64d4c1) 100.00%.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #57   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           21        22    +1     
  Lines         1394      1441   +47     
=========================================
+ Hits          1394      1441   +47     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@asingamaneni asingamaneni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@asingamaneni asingamaneni merged commit 6d546bb into Nike-Inc:main Nov 27, 2023
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants