Mail Job Notification Plugin

[harvey0100]

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

[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:

1. 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.
2. 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.
3. The Readme file has some syntax errors. Therefore, you have the Build Package failures.
4. The Linux with Python 3.12.0 is not related to your PR and I have already created a fix for that in cannot import name 'packaging' from 'pkg_resources' fix #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.

[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.

[richtja]

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

[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]

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.

[harvey0100]

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

[richtja]

Hi @harvey0100, still new line missing here. 😉

[harvey0100]

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

[richtja]

After the updates it LGTM, thank you.