Add SMTP via the smtp-integrator charm

[javierdelapuente]

Overview

Currently, to configure SMTP in synapse-operator you need to set configuration options. The change allows retrieving SMTP configuration from the SMTP integrator charm.

Rationale

Leverage the new SMTP integrator charm. As an added benefit, SMTP configuration can be shared by several applications and secrets can be used.

Juju Events Changes

Module Changes

• New SMTP observer module
• Changes in state. Added SMTPConfiguration
• Changes in charm
• Changes in pebble, added enable_smtp
• Changes in workload to write the new configuration to Synapse configuration file

Library Changes

Library charms.smtp_integrator.v0.smtp is included to make use of the smtp-integrator charm.

Checklist

• The charm style guide was applied
• The contributing guide was applied
• The changes are compliant with ISD054 - Manging Charm Complexity
• The documentation is generated using src-docs
• The documentation for charmhub is updated.
• The PR is tagged with appropriate label (urgent, trivial, complex)

[github-actions]

license-eye has totally checked 103 files.

Valid	Invalid	Ignored	Fixed
0	46	57	0

Click to see the invalid file list

• actions.yaml
• charmcraft.yaml
• config.yaml
• generate-src-docs.sh
• metadata.yaml
• mjolnir_snap/snapcraft.yaml
• nginx_rock/rockcraft.yaml
• pyproject.toml
• src/actions/init.py
• src/actions/register_user.py
• src/actions/reset_instance.py
• src/charm.py
• src/charm_state.py
• src/charm_types.py
• src/database_client.py
• src/database_observer.py
• src/exceptions.py
• src/mjolnir.py
• src/observability.py
• src/pebble.py
• src/saml_observer.py
• src/smtp_observer.py
• src/synapse/init.py
• src/synapse/api.py
• src/synapse/workload.py
• src/user.py
• synapse_rock/attributemaps/login_ubuntu.py
• synapse_rock/rockcraft.yaml
• tests/init.py
• tests/conftest.py
• tests/integration/init.py
• tests/integration/conftest.py
• tests/integration/test_charm.py
• tests/unit/init.py
• tests/unit/conftest.py
• tests/unit/test_anonymize_user_action.py
• tests/unit/test_charm.py
• tests/unit/test_database.py
• tests/unit/test_mjolnir.py
• tests/unit/test_promote_user_admin_action.py
• tests/unit/test_register_user_action.py
• tests/unit/test_reset_instance_action.py
• tests/unit/test_smtp_observer.py
• tests/unit/test_synapse_api.py
• tests/unit/test_synapse_workload.py
• tox.ini

[github-actions]

license-eye has totally checked 103 files.

Valid	Invalid	Ignored	Fixed
0	46	57	0

Click to see the invalid file list

• actions.yaml
• charmcraft.yaml
• config.yaml
• generate-src-docs.sh
• metadata.yaml
• mjolnir_snap/snapcraft.yaml
• nginx_rock/rockcraft.yaml
• pyproject.toml
• src/actions/init.py
• src/actions/register_user.py
• src/actions/reset_instance.py
• src/charm.py
• src/charm_state.py
• src/charm_types.py
• src/database_client.py
• src/database_observer.py
• src/exceptions.py
• src/mjolnir.py
• src/observability.py
• src/pebble.py
• src/saml_observer.py
• src/smtp_observer.py
• src/synapse/init.py
• src/synapse/api.py
• src/synapse/workload.py
• src/user.py
• synapse_rock/attributemaps/login_ubuntu.py
• synapse_rock/rockcraft.yaml
• tests/init.py
• tests/conftest.py
• tests/integration/init.py
• tests/integration/conftest.py
• tests/integration/test_charm.py
• tests/unit/init.py
• tests/unit/conftest.py
• tests/unit/test_anonymize_user_action.py
• tests/unit/test_charm.py
• tests/unit/test_database.py
• tests/unit/test_mjolnir.py
• tests/unit/test_promote_user_admin_action.py
• tests/unit/test_register_user_action.py
• tests/unit/test_reset_instance_action.py
• tests/unit/test_smtp_observer.py
• tests/unit/test_synapse_api.py
• tests/unit/test_synapse_workload.py
• tox.ini

[yanksyoon]

LGTM! Minor questions to understand synapse better :D
(I think it might help if the LICENSE header changes were in a separate PR :D)

[javierdelapuente]

LGTM! Minor questions to understand synapse better :D (I think it might help if the LICENSE header changes were in a separate PR :D)

Totally right, sorry for the LICENSE changes, I updated them to pass the tests

[amandahla]

LGTM 🚀

[merkata]

LGTM! 🚀

[github-actions]

Test coverage for 5a7e105

Name                            Stmts   Miss Branch BrPart  Cover   Missing
---------------------------------------------------------------------------
src/actions/__init__.py             3      0      0      0   100%
src/actions/register_user.py       22      0      2      0   100%
src/actions/reset_instance.py      21      0      2      0   100%
src/charm.py                      220      8     50      4    96%   163-164, 225-226, 245-246, 287, 301
src/charm_state.py                 63      1     10      1    97%   127
src/charm_types.py                 21      0      2      0   100%
src/database_client.py             53      1     10      3    94%   35, 47->exit, 69->exit
src/database_observer.py           54      4      6      0    93%   70-72, 88
src/exceptions.py                   4      0      0      0   100%
src/mjolnir.py                     76      6     20      1    91%   60-64, 73
src/observability.py                9      0      0      0   100%
src/pebble.py                      96     12     16      6    84%   91-92, 94-95, 103, 105, 107, 111, 132-133, 148-149
src/saml_observer.py               45      1      8      0    98%   64
src/smtp_observer.py               70      3     14      1    95%   70-74, 96->101
src/synapse/__init__.py             3      0      0      0   100%
src/synapse/api.py                161      2     22      2    98%   207, 376
src/synapse/workload.py           261      8     42      6    95%   386->exit, 415-416, 468-469, 505-506, 522, 571->574, 618, 626->628, 628->630
src/user.py                        24      0      4      0   100%
---------------------------------------------------------------------------
TOTAL                            1206     46    208     24    95%

Static code analysis report

Run started:2024-01-08 12:15:38.679608

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 6352
  Total lines skipped (#nosec): 4
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):

[amandahla]

LGTM