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

Re_botcmd_fullmatch: Add re_botcmd_fullmatch #403

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions plugins/re_botcmd_fullmatch.plug
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[Core]
name = re_botcmd_fullmatch
module = re_botcmd_fullmatch

[Documentation]
description = Checks whether all re_botcmd regexes are fullmatches or not and warns the admins.

[Python]
version = 3
35 changes: 35 additions & 0 deletions plugins/re_botcmd_fullmatch.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
import time
import threading

from errbot import BotPlugin, botcmd


class Re_botcmd_fullmatch(BotPlugin):
Copy link
Member

Choose a reason for hiding this comment

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

rather than a plugin, we should not use re_botcmd , and instead use a better decorator which does this check and then defers to re_botcmd

"""
Checks whether all re_botcmd regexes are fullmatches or not and warns the
admins.
"""

def activate(self):
super().activate()
# start asynchronously
threading.Thread(target=self.check_regexes).start()

def check_regexes(self):
# Allow all plugins to activate
time.sleep(60)

if hasattr(self.bot_config, 'RE_BOTCMD_FULLMATCH_IGNORES'):
ignores = self.bot_config.RE_BOTCMD_FULLMATCH_IGNORES
else:
ignores = tuple()

msg = 'Following re_botcmds have pattern that are not fullmatches: '

for name, func in dict(self._bot.re_commands).items():
pattern = func._err_command_re_pattern.pattern
if not (pattern.startswith('^') and pattern.endswith('$') and
name not in ignores):
msg += '\n- `{}` - `{}`'.format(name, pattern)

self.warn_admins(msg)