Mail Job Notification Plugin by harvey0100 · Pull Request #5943 · avocado-framework/avocado

harvey0100 · 2024-05-29T10:20:53Z

Gmail Plugin for Avocado allows results to be sent to any email. The Origin email though at this time has to come from a google account due to using App Passwords.

PIP package has also been created

Signed off by: Harvey Lynden hlynden@redhat.com

optional_plugins/mail/avocado_job_mail.py

richtja

Hi @harvey0100, thank you for your contribution. It is very welcome. I haven't looked at the code yet. But I can give you some comments which should help you to solve the CI failures:

In your git config your email is harveylynden@gmail.com and not hlynden@redhat.com therefore the signedoff-check is failing. You need to change your git config and create a new commit with the proper sign.
Some static checks are failing, please fix them base on the checks output. You can run those tests locally by setup.py test --select=static-checks, and it is recommended to run the tests before you push your changes.
The Readme file has some syntax errors. Therefore, you have the Build Package failures.
The Linux with Python 3.12.0 is not related to your PR and I have already created a fix for that in #5942

I hope that it will help you. If you have any questions, don't hesitate to ask.

clebergnu

Hi @harvey0100,

Thanks for this! Please find my initial comments inline in the changes.

optional_plugins/mail/README.rst

optional_plugins/mail/avocado_job_mail.py

optional_plugins/mail/setup.py

optional_plugins/mail/avocado_mail_result/mail_result.py

richtja

Hi @harvey0100, thank you very much for the CI fixes. I have more deeply looked at the code and I have a few proposals which IMO increase readability and maintainability of the code. Please let me know what do you think about it.

Also, can you please write a more detailed commit message. For example, you can use your PR description. Thanks.

optional_plugins/mail/MANIFEST.in

optional_plugins/mail/VERSION

optional_plugins/mail/README.rst

optional_plugins/mail/avocado_mail_result/mail_result.py

richtja · 2024-06-21T09:14:20Z

optional_plugins/mail/avocado_mail_result/mail_result.py

+    def _generate_test_summary(data, detail_level):
+        test_summary = []
+
+        def format_test_details(test):


Is there any reason for this inner method, instead of calling Mail._format_test_details(test, advanced=detail_level) directly?

optional_plugins/mail/avocado_mail_result/mail_result.py

optional_plugins/mail/avocado_result_mail/result_mail.py

+            return smtp
+        except Exception as e:  # pylint: disable=W0703
+            job_log.error(
+                f"Failed to establish SMTP connection to {server}:{port}: {e}"


clebergnu

Hi @harvey0100 ,

There are a few bits missing to have this properly packaged as an RPM:

diff --git a/python-avocado.spec b/python-avocado.spec
index 4eae27dba..5f71e4f20 100644
--- a/python-avocado.spec
+++ b/python-avocado.spec
@@ -135,6 +135,9 @@ popd
 pushd optional_plugins/result_upload
 %py3_build
 popd
+pushd optional_plugins/mail
+%py3_build
+popd
 %if ! 0%{?rhel}
 pushd optional_plugins/spawner_remote
 %py3_build
@@ -175,6 +178,9 @@ popd
 pushd optional_plugins/result_upload
 %py3_install
 popd
+pushd optional_plugins/mail
+%py3_install
+popd
 %if ! 0%{?rhel}
 pushd optional_plugins/spawner_remote
 %py3_install
@@ -239,6 +245,7 @@ PATH=%{buildroot}%{_bindir}:%{buildroot}%{_libexecdir}/avocado:$PATH \
 %exclude %{python3_sitelib}/avocado_varianter_pict*
 %exclude %{python3_sitelib}/avocado_varianter_cit*
 %exclude %{python3_sitelib}/avocado_result_upload*
+%exclude %{python3_sitelib}/avocado_result_mail*
 %exclude %{python3_sitelib}/avocado_framework_plugin_result_html*
 %exclude %{python3_sitelib}/avocado_framework_plugin_resultsdb*
 %exclude %{python3_sitelib}/avocado_framework_plugin_varianter_yaml_to_mux*
@@ -247,6 +254,7 @@ PATH=%{buildroot}%{_bindir}:%{buildroot}%{_libexecdir}/avocado:$PATH \
 %exclude %{python3_sitelib}/avocado_framework_plugin_golang*
 %exclude %{python3_sitelib}/avocado_framework_plugin_ansible*
 %exclude %{python3_sitelib}/avocado_framework_plugin_result_upload*
+%exclude %{python3_sitelib}/avocado_framework_plugin_result_mail*
 %exclude %{python3_sitelib}/avocado_framework_plugin_spawner_remote*
 %exclude %{python3_sitelib}/tests*

Please include these changes and let's see what packit gives us.

harvey0100 · 2024-07-26T10:18:45Z

Hi @harvey0100 ,

There are a few bits missing to have this properly packaged as an RPM:

diff --git a/python-avocado.spec b/python-avocado.spec
index 4eae27dba..5f71e4f20 100644
--- a/python-avocado.spec
+++ b/python-avocado.spec
@@ -135,6 +135,9 @@ popd
 pushd optional_plugins/result_upload
 %py3_build
 popd
+pushd optional_plugins/mail
+%py3_build
+popd
 %if ! 0%{?rhel}
 pushd optional_plugins/spawner_remote
 %py3_build
@@ -175,6 +178,9 @@ popd
 pushd optional_plugins/result_upload
 %py3_install
 popd
+pushd optional_plugins/mail
+%py3_install
+popd
 %if ! 0%{?rhel}
 pushd optional_plugins/spawner_remote
 %py3_install
@@ -239,6 +245,7 @@ PATH=%{buildroot}%{_bindir}:%{buildroot}%{_libexecdir}/avocado:$PATH \
 %exclude %{python3_sitelib}/avocado_varianter_pict*
 %exclude %{python3_sitelib}/avocado_varianter_cit*
 %exclude %{python3_sitelib}/avocado_result_upload*
+%exclude %{python3_sitelib}/avocado_result_mail*
 %exclude %{python3_sitelib}/avocado_framework_plugin_result_html*
 %exclude %{python3_sitelib}/avocado_framework_plugin_resultsdb*
 %exclude %{python3_sitelib}/avocado_framework_plugin_varianter_yaml_to_mux*
@@ -247,6 +254,7 @@ PATH=%{buildroot}%{_bindir}:%{buildroot}%{_libexecdir}/avocado:$PATH \
 %exclude %{python3_sitelib}/avocado_framework_plugin_golang*
 %exclude %{python3_sitelib}/avocado_framework_plugin_ansible*
 %exclude %{python3_sitelib}/avocado_framework_plugin_result_upload*
+%exclude %{python3_sitelib}/avocado_framework_plugin_result_mail*
 %exclude %{python3_sitelib}/avocado_framework_plugin_spawner_remote*
 %exclude %{python3_sitelib}/tests*

Please include these changes and let's see what packit gives us.

Hi Cleber,

Thanks for the changes, I've implemented them and looks like the build is succeding! :)

clebergnu

LGTM, thanks!

(waiving the codeclimate "failure")

richtja

Hi @harvey0100, thank you for your updates. IMO it is almost finished, I have just few style comments.

optional_plugins/mail/README.rst

optional_plugins/mail/VERSION

optional_plugins/mail/MANIFEST.in

spell.ignore

harvey0100 · 2024-08-12T10:00:05Z

All changes have been applied that have been requested, request should be ready for merging.

richtja · 2024-08-12T11:58:49Z

optional_plugins/mail/MANIFEST.in

@@ -0,0 +1 @@
+include VERSION README.rst


Hi @harvey0100, still new line missing here. 😉

I'll get there one day haha, IDE is now set to save all files with a new line :D - sorted now

Added sphinx target inside configuring.rst Created symbolic link inside of documentation Plugin name finalised Altered towards comments Signed-off-by: Harvey Lynden <hlynden@redhat.com>

richtja

After the updates it LGTM, thank you.

harvey0100 added the enhancement label May 29, 2024

harvey0100 added this to the #106 - Codename TBD milestone May 29, 2024

harvey0100 requested review from clebergnu and richtja May 29, 2024 10:20

harvey0100 self-assigned this May 29, 2024

github-advanced-security bot found potential problems May 29, 2024

View reviewed changes

optional_plugins/mail/avocado_job_mail.py Fixed Show fixed Hide fixed

richtja requested changes May 29, 2024

View reviewed changes

harvey0100 force-pushed the GmailPlugin branch 7 times, most recently from 0c0e5cc to ff8c241 Compare June 10, 2024 09:28

clebergnu requested changes Jun 10, 2024

View reviewed changes

harvey0100 force-pushed the GmailPlugin branch 3 times, most recently from a4624f6 to eb973ff Compare June 14, 2024 14:49

github-advanced-security bot found potential problems Jun 14, 2024

View reviewed changes

optional_plugins/mail/avocado_mail_result/mail_result.py Fixed Show fixed Hide fixed

harvey0100 force-pushed the GmailPlugin branch 3 times, most recently from 39830c7 to 1298f15 Compare June 17, 2024 16:04

harvey0100 changed the title ~~Gmail Job Notification Plugin~~ Mail Job Notification Plugin Jun 17, 2024

richtja requested changes Jun 21, 2024

View reviewed changes

harvey0100 force-pushed the GmailPlugin branch 2 times, most recently from 2ea1b49 to 7fcc607 Compare June 26, 2024 15:27

github-advanced-security bot found potential problems Jun 26, 2024

View reviewed changes

harvey0100 force-pushed the GmailPlugin branch 3 times, most recently from 3d073a7 to 4a7f518 Compare June 28, 2024 09:26

clebergnu modified the milestones: #106 - Taking Off, 107 - Codename TBD Jun 28, 2024

harvey0100 force-pushed the GmailPlugin branch 5 times, most recently from d37f13f to 37aaeb2 Compare July 1, 2024 09:47

harvey0100 force-pushed the GmailPlugin branch 2 times, most recently from 131b737 to 1dfb081 Compare July 22, 2024 13:05

harvey0100 mentioned this pull request Jul 25, 2024

email the report after completion of a job #4387

Closed

clebergnu requested changes Jul 25, 2024

View reviewed changes

harvey0100 force-pushed the GmailPlugin branch 5 times, most recently from 77d4734 to 8d79ddb Compare July 26, 2024 09:06

clebergnu approved these changes Jul 31, 2024

View reviewed changes

richtja self-requested a review July 31, 2024 13:06

richtja requested changes Jul 31, 2024

View reviewed changes

harvey0100 force-pushed the GmailPlugin branch 2 times, most recently from 54b7d52 to adb7684 Compare August 12, 2024 09:47

richtja reviewed Aug 12, 2024

View reviewed changes

Email Notification Plugin Created

350305a

Added sphinx target inside configuring.rst Created symbolic link inside of documentation Plugin name finalised Altered towards comments Signed-off-by: Harvey Lynden <hlynden@redhat.com>

harvey0100 force-pushed the GmailPlugin branch from adb7684 to 350305a Compare August 12, 2024 12:30

richtja approved these changes Aug 12, 2024

View reviewed changes

richtja merged commit d223935 into avocado-framework:master Aug 12, 2024

		@@ -0,0 +1 @@
		include VERSION README.rst No newline at end of file

Conversation

harvey0100 commented May 29, 2024

Uh oh!

Uh oh!

richtja left a comment

Choose a reason for hiding this comment

Uh oh!

clebergnu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

richtja left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

richtja Jun 21, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Check failure

clebergnu left a comment

Choose a reason for hiding this comment

Uh oh!

harvey0100 commented Jul 26, 2024

Uh oh!

clebergnu left a comment

Choose a reason for hiding this comment

Uh oh!

richtja left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

harvey0100 commented Aug 12, 2024

Uh oh!

richtja Aug 12, 2024

Choose a reason for hiding this comment

Uh oh!

harvey0100 Aug 12, 2024

Choose a reason for hiding this comment

Uh oh!

richtja left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants