Refactoring alerts.py and alerts_test.py

[ferozsalam]

Hello!

I'd like to start working on refactoring alerts.py and alerts_test.py. Both files are several thousand lines long, with code classes that are unrelated to each other. I think - as a start - that it would be a good foundation for future work if each alerter (and its test class) had their own file.

I'm happy to do this work myself, but before I start I am looking for feedback, in particular from @jertel and @nsano-rururu, about any reasons why this shouldn't be done, or anything I will have to consider before doing the work.

If done correctly, this shouldn't be a breaking change in any way. I will also take the opportunity to make minor style/clarity improvements where it's clear that it won't affect functionality.

[nsano-rururu]

It means that it is divided for each alert like opsgenie.py and zabbix.py.
In that case, the alerts_mapping part of loaders.py also needs to be modified.

The image is that each alert class is in a separate file, and alerts.py retains the base class of alerter. So declare "from .alerts import Alerter" at the beginning of each alert file.

It's just a plan, so it's not absolutely necessary, but I think it should be decided first.

alerts.py

DateTimeEncoder
BasicMatchString
Alerter

jira.py

JiraFormattedMatchString

File split as below

email.py
jira.py
stomp.py
debug.py
command.py
sns.py
ms_teams.py
slack.py
mattermost.py
pagerduty.py
exotel.py
twilio.py
victorops.py
telegram.py
googlechat.py
gitter.py
servicenow.py
alerta.py
post.py
pagertree.py
linenotify.py
hivealerter.py
discord.py
dingtalk.py
chatwork.py
datadog.py
ses.py

---

loaders.py

add

from .email import EmailAlerter,
from .jira import JiraAlerter,
from .stomp import StompAlerter,
from .debug import DebugAlerter,
from .command import CommandAlerter,
from .sns import SnsAlerter,
from .ms_teams import MsTeamsAlerter,
from .slack import SlackAlerter,
from .mattermost import MattermostAlerter,
from .pagerduty import PagerDutyAlerter,
from .exotel import ExotelAlerter,
from .twilio import TwilioAlerter,
from .victorops import VictorOpsAlerter,
from .telegram import TelegramAlerter,
from .googlechat import GoogleChatAlerter,
from .gitter import GitterAlerter,
from .servicenow import ServiceNowAlerter,
from .alerta import AlertaAlerter,
from .post import HTTPPostAlerter,
from .pagertree import PagerTreeAlerter,
from .linenotify import LineNotifyAlerter,
from .hivealerter import HiveAlerter,
from .discord import DiscordAlerter,
from .dingtalk import DingTalkAlerter,
from .chatwork import ChatworkAlerter,
from .datadog import DatadogAlerter,
from .ses import SesAlerter

modify

before

    # Used to map names of alerts to their classes
    alerts_mapping = {
        'email': alerts.EmailAlerter,
        'jira': alerts.JiraAlerter,
        'opsgenie': OpsGenieAlerter,
        'stomp': alerts.StompAlerter,
        'debug': alerts.DebugAlerter,
        'command': alerts.CommandAlerter,
        'sns': alerts.SnsAlerter,
        'ms_teams': alerts.MsTeamsAlerter,
        'slack': alerts.SlackAlerter,
        'mattermost': alerts.MattermostAlerter,
        'pagerduty': alerts.PagerDutyAlerter,
        'exotel': alerts.ExotelAlerter,
        'twilio': alerts.TwilioAlerter,
        'victorops': alerts.VictorOpsAlerter,
        'telegram': alerts.TelegramAlerter,
        'googlechat': alerts.GoogleChatAlerter,
        'gitter': alerts.GitterAlerter,
        'servicenow': alerts.ServiceNowAlerter,
        'alerta': alerts.AlertaAlerter,
        'post': alerts.HTTPPostAlerter,
        'pagertree': alerts.PagerTreeAlerter,
        'linenotify': alerts.LineNotifyAlerter,
        'hivealerter': alerts.HiveAlerter,
        'zabbix': ZabbixAlerter,
        'discord': alerts.DiscordAlerter,
        'dingtalk': alerts.DingTalkAlerter,
        'chatwork': alerts.ChatworkAlerter,
        'datadog': alerts.DatadogAlerter,
        'ses': alerts.SesAlerter
    }

after

    # Used to map names of alerts to their classes
    alerts_mapping = {
        'email': EmailAlerter,
        'jira': JiraAlerter,
        'opsgenie': OpsGenieAlerter,
        'stomp': StompAlerter,
        'debug': DebugAlerter,
        'command': CommandAlerter,
        'sns': SnsAlerter,
        'ms_teams': MsTeamsAlerter,
        'slack': SlackAlerter,
        'mattermost': MattermostAlerter,
        'pagerduty': PagerDutyAlerter,
        'exotel': ExotelAlerter,
        'twilio': TwilioAlerter,
        'victorops': VictorOpsAlerter,
        'telegram': TelegramAlerter,
        'googlechat': GoogleChatAlerter,
        'gitter': GitterAlerter,
        'servicenow': ServiceNowAlerter,
        'alerta': AlertaAlerter,
        'post': HTTPPostAlerter,
        'pagertree': PagerTreeAlerter,
        'linenotify': LineNotifyAlerter,
        'hivealerter': HiveAlerter,
        'zabbix': ZabbixAlerter,
        'discord': DiscordAlerter,
        'dingtalk': DingTalkAlerter,
        'chatwork': ChatworkAlerter,
        'datadog': DatadogAlerter,
        'ses': SesAlerter
    }

[jertel]

I agree, and am onboard with the idea!

[nsano-rururu]

After that, I would like you to add none of the following alert tests.

• ExotelAlerter
• SesAlerter
• SnsAlerter
• StompAlerter
• TwilioAllerter
• ZabbixAlerter

[nsano-rururu]

As for the test code, alerts_test.py is a test of only the classes in alerts.py, and other alerts are separated into files as follows.

alerta_test.py
chatwork_test.py
command_test.py
datadog_test.py
debug_test.py
dingtalk_test.py
discord_test.py
email_test.py
exotel_test.py
gitter_test.py
googlechat_test.py
hivealerter_test.py
jira_test.py
linenotify_test.py
mattermost_test.py
ms_teams_test.py
opsgenie_test.py
pagerduty_test.py
pagertree_test.py
post_test.py
servicenow_test.py
ses_test.py
slack_test.py
sns_test.py
stomp_test.py
telegram_test.py
twilio_test.py
victorops_test.py
zabbix_test.py

[ferozsalam]

All the suggestions sound good - I will start looking into this.

[mrfroggg]

Good idea, some of those files are way too long!