Give useful error message

Give proper usage of command when a
command is used without args.

Fixes coala#356

Author: Vamshi99

plugins/explain.py

@@ -90,14 +90,17 @@ class Explain(BotPlugin):
         '\n- '.join(MSGS.keys())
     )
 
-    @re_botcmd(pattern=r'^explain\s+(\w+)(?:\s+to\s+@?([\w-]+))?$',
+    @re_botcmd(pattern=r'^explain(\s+(\w+)(?:\s+to\s+@?([\w-]+))?)$',
                re_cmd_name_help='explain <term>',
                flags=re.IGNORECASE)
     def explain(self, msg, match):
         """Explain various terms."""  # Ignore QuotesBear
-        return ('{}'.format('@{}: \n'.format(match.group(2))
-                            if match.group(2) else '') +
+        if match.group(1) is None:
+            return('Invalid command args. Usage: `{} '
+                   'explain <term>`.'.format(self.bot_config.BOT_PREFIX))
+        return ('{}'.format('@{}: \n'.format(match.group(3))
+                            if match.group(3) else '') +
                 self.MSGS.get(
-                    match.group(1).lower(),
+                    match.group(2).lower(),
                     self.ERROR_MSG
                 ).format(bot_prefix=self.bot_config.BOT_PREFIX))

plugins/ghetto.py

@@ -10,19 +10,22 @@ class Ghetto(BotPlugin):
     Real talk yo
     """
 
-    @re_botcmd(pattern=r'ghetto\s+(.+)',
+    @re_botcmd(pattern=r'ghetto(\s+(.+))',
                re_cmd_name_help='ghetto <sentence>',
                flags=re.IGNORECASE)
     def ghetto(self, msg, match):
         """
         Real talk yo
         """
+        if math.group(1) is None:
+            return('Invalid command args. Usage: `{} '
+                   'ghetto <sentence>`'.format(self.bot_config.BOT_PREFIX))
         rq = requests.post('http://www.gizoogle.net/textilizer.php',
-                           data={'translatetext': match.group(1)})
+                           data={'translatetext': match.group(2)})
 
         translated_text = re.search(
             r'<textarea .*;\"/>(.+)</textarea>', rq.text)
         if translated_text is not None:
-            return translated_text.group(1)
+            return translated_text.group(2)
         else:
             return 'Shiznit happens!'

plugins/labhub.py

@@ -96,14 +96,18 @@ def TEAMS(self, new):
         self._teams = new
 
     # Ignore LineLengthBear, PycodestyleBear
-    @re_botcmd(pattern=r'^(?:(?:invite)|(?:inv))\s+(?:(?:@?([\w-]+)(?:\s*(?:to)\s+(\w+))?)|(me))$',
+    @re_botcmd(pattern=r'^(?:(?:invite)|(?:inv))(\s+(?:(?:@?([\w-]+)(?:\s*(?:to)\s+(\w+))?)|(me)))$',
                re_cmd_name_help='invite [to team]')
     def invite_cmd(self, msg, match):
         """
         Invite given user to given team. By default it invites to
         "newcomers" team.
         """
-        invitee = match.group(1)
+        if match.group(1) is None:
+            return('Invalid command args. Usage: `{} (invite|inv) '
+                   '((member|member to [team])|me)`'.format(
+                        self.bot_config.BOT_PREFIX))
+        invitee = match.group(2)
         inviter = msg.frm.nick
 
         if invitee == 'me':
@@ -113,7 +117,7 @@ def invite_cmd(self, msg, match):
             self.invited_users.add(user)
             return
 
-        team = 'newcomers' if match.group(2) is None else match.group(2)
+        team = 'newcomers' if match.group(3) is None else match.group(3)
 
         self.log.info('{} invited {} to {}'.format(inviter, invitee, team))
 
@@ -146,14 +150,17 @@ def callback_message(self, msg):
                 self.TEAMS[self.GH_ORG_NAME + ' newcomers'].invite(user)
                 self.invited_users.add(user)
 
-    @re_botcmd(pattern=r'(?:new|file) issue ([\w-]+?)(?: |\n)(.+?)(?:$|\n((?:.|\n)*))',  # Ignore LineLengthBear, PyCodeStyleBear
+    @re_botcmd(pattern=r'(?:new|file) issue( ([\w-]+?)(?: |\n)(.+?)(?:$|\n((?:.|\n)*)))',  # Ignore LineLengthBear, PyCodeStyleBear
                re_cmd_name_help='new issue repo-name title\n[description]',
                flags=re.IGNORECASE)
     def create_issut_cmd(self, msg, match):
         """Create issues on GitHub and GitLab repositories."""  # Ignore QuotesBear, LineLengthBear, PyCodeStyleBear
-        repo_name = match.group(1)
-        iss_title = match.group(2)
-        iss_description = match.group(3) if match.group(3) is not None else ''
+        if match.group(1) is None:
+            return('Invalid command args. Usage: `{} (new|file) issue repo-name'
+                   ' title\n[description]`'.format(self.bot_config.BOT_PREFIX))
+        repo_name = match.group(2)
+        iss_title = match.group(3)
+        iss_description = match.group(4) if match.group(4) is not None else ''
         extra_msg = '\nOpened by @{username} at [{backend}]({msg_link})'.format(
             username=msg.frm.nick,
             backend=self.bot_config.BACKEND,
@@ -169,14 +176,17 @@ def create_issut_cmd(self, msg, match):
                     'exist. Please ensure that the repository is available '
                     'and owned by the org.')
 
-    @re_botcmd(pattern=r'^unassign\s+https://(github|gitlab)\.com/([^/]+)/([^/]+)/issues/(\d+)',  # Ignore LineLengthBear, PyCodeStyleBear
+    @re_botcmd(pattern=r'^unassign(\s+https://(github|gitlab)\.com/([^/]+)/([^/]+)/issues/(\d+))',  # Ignore LineLengthBear, PyCodeStyleBear
                re_cmd_name_help='unassign <complete-issue-URL>',
                flags=re.IGNORECASE)
     def unassign_cmd(self, msg, match):
         """Unassign from an issue."""  # Ignore QuotesBear
-        org = match.group(2)
-        repo_name = match.group(3)
-        issue_number = match.group(4)
+        if match.group(1) is None:
+            return('Invalid command args. Usage: `{} unassign '
+                   '<complete-issue-URL>`'.format(self.bot_config.BOT_PREFIX))
+        org = match.group(3)
+        repo_name = match.group(4)
+        issue_number = match.group(5)
 
         user = msg.frm.nick
 
@@ -196,13 +206,15 @@ def unassign_cmd(self, msg, match):
             else:
                 return 'You are not an assignee on the issue.'
 
-    @re_botcmd(pattern=r'mark\s+(wip|pending)\s+https://(github|gitlab)\.com/([^/]+)/([^/]+)/(pull|merge_requests)/(\d+)',  # Ignore LineLengthBear, PyCodeStyleBear
+    @re_botcmd(pattern=r'mark(\s+(wip|pending)\s+https://(github|gitlab)\.com/([^/]+)/([^/]+)/(pull|merge_requests)/(\d+))',  # Ignore LineLengthBear, PyCodeStyleBear
                re_cmd_name_help='mark (wip|pending) <complete-PR-URL>',
                flags=re.IGNORECASE)
     def mark_cmd(self, msg, match):
         """Mark a given PR/MR with status labels."""  # Ignore QuotesBear
-        state, host, org, repo_name, xr, number = match.groups()
-
+        arg, state, host, org, repo_name, xr, number = match.groups()
+        if arg is None:
+            return('Invalid command args. Usage: `{} mark (wip|pending) '
+                   '<complete-PR-URL>`'.format(self.bot_config.BOT_PREFIX))
         if host.lower() == 'github':
             assert xr.lower() == 'pull'
         elif host.lower() == 'gitlab':
@@ -244,14 +256,17 @@ def mark_cmd(self, msg, match):
                             bot_prefix=self.bot_config.BOT_PREFIX)
                         )
 
-    @re_botcmd(pattern=r'^assign\s+https://(github|gitlab)\.com/([^/]+)/([^/]+/)+issues/(\d+)',  # Ignore LineLengthBear, PyCodeStyleBear
+    @re_botcmd(pattern=r'^assign(\s+https://(github|gitlab)\.com/([^/]+)/([^/]+/)+issues/(\d+))',  # Ignore LineLengthBear, PyCodeStyleBear
                re_cmd_name_help='assign <complete-issue-URL>',
                flags=re.IGNORECASE)
     def assign_cmd(self, msg, match):
         """Assign to GitLab and GitHub issues."""  # Ignore QuotesBear
-        org = match.group(2)
-        repo_name = match.group(3)[:-1]
-        iss_number = match.group(4)
+        if match.group(1) is None:
+            return('Invalid command args. Usage: `{} assign '
+                   '<complete-issue-URL>`'.format(self.bot_config.BOT_PREFIX))
+        org = match.group(3)
+        repo_name = match.group(4)[:-1]
+        iss_number = match.group(5)
 
         user = msg.frm.nick
 
@@ -358,7 +373,10 @@ def community_state(pr_count: dict):
 
     @re_botcmd(pattern=r'pr\s+stats\s+(\d+)(?:hours|hrs)')
     def pr_stats(self, msg, match):
-        hours = match.group(1)
+        if match.group(1) is None:
+            return('Invalid command args. Usage: `{} pr stats <number-of-hours>'
+                   '(hours|hrs)`'.format(self.bot_config.BOT_PREFIX))
+        hours = match.group(2)
         pr_count = dict()
         start = time.time()
         for count, (name, repo) in enumerate(self.gh_repos.items(), 1):

plugins/lmgtfy.py

@@ -19,9 +19,12 @@ class Lmgtfy(BotPlugin):
         'help you even faster!'
     )
 
-    @re_botcmd(pattern=r'lmgtfy\s+(.+)',
+    @re_botcmd(pattern=r'lmgtfy(\s+(.+))',
                re_cmd_name_help='lmgtfy <search-string>')
     def lmgtfy(self, msg, match):
         """I'm lazy, please google for me."""  # Ignore QuotesBear
-        link = 'https://www.lmgtfy.com/?q=' + match.group(1)
+        if match.group(1) is None:
+            return('Invalid command args. Usage: `{} lmgtfy '
+                   '<search-string>`'.format(self.bot_config.BOT_PREFIX))
+        link = 'https://www.lmgtfy.com/?q=' + match.group(2)
         return self.MSG.format(link)

plugins/wolfram_alpha.py

@@ -19,6 +19,9 @@ def wa(self, msg, arg):
         """
         Query the Computational Knowledge Engine.
         """
+        if arg is None:
+            return('Invalid command args. Usage: `{} wa '
+                   '<query>`'.format(self.bot_config.BOT_PREFIX))
         ans = ''
         res = self.client.query(arg)
         try:

tests/explain_test.py

@@ -21,3 +21,4 @@ def test_explain(testbot):
                           '@meet')
     testbot.assertCommand("!please explain review",
                           "Command \"please\" / \"please explain\" not found.")
+    testbot.assertCommand("!explain", "Invalid command args.")

tests/ghetto_test.py

@@ -8,6 +8,7 @@
 @vcr.use_cassette('tests/cassettes/ghetto.yaml')
 def test_ghetto(testbot):
     testbot.assertCommand("!ghetto hi, whats up?", "hi, wassup?")
+    testbot.assertCommand("!ghetto", "Invalid command args.")
     with requests_mock.Mocker() as m:
         m.register_uri('POST', 'http://www.gizoogle.net/textilizer.php',
                        text='test text which will not match with the regex')

tests/labhub_test.py

@@ -57,6 +57,7 @@ def test_invite_cmd(self):
 
         testbot.assertCommand('!invite meet to developers',
                                    ':poop:')
+        testbot.assertCommand('!invite', 'Invalid command args.')
 
     def test_hello_world_callback(self):
         teams = {
@@ -98,6 +99,7 @@ def test_create_issue_cmd(self):
         )
 
         testbot.assertCommand('!new issue coala title', 'repository that does not exist')
+        testbot.assertCommand('!new issue', 'Invalid command args.')
 
     def test_unassign_cmd(self):
         plugins.labhub.GitHub = create_autospec(IGitt.GitHub.GitHub.GitHub)
@@ -128,6 +130,7 @@ def test_unassign_cmd(self):
 
         testbot.assertCommand('!unassign https://gitlab.com/ala/am/issues/532',
                                'Repository not owned by our org.')
+        testbot.assertCommand('!unassign', 'Invalid command args.')
 
     def test_assign_cmd(self):
         plugins.labhub.GitHub = create_autospec(IGitt.GitHub.GitHub.GitHub)
@@ -215,6 +218,8 @@ def test_assign_cmd(self):
         # unknown org
         testbot.assertCommand(cmd.format('coa', 'a', '23'),
                               'Repository not owned by our org.')
+        # command without args
+        testbot.assertCommand('!assign', 'Invalid command args.')
 
     def test_mark_cmd(self):
         labhub, testbot = plugin_testbot(plugins.labhub.LabHub, logging.ERROR)
@@ -240,6 +245,8 @@ def test_mark_cmd(self):
         mock_mr.labels = ['process/wip']
         testbot.assertCommand(cmd.format('pending', 'coala', 'a', '23'),
                               'marked pending review')
+        # command without args
+        testbot.assertCommand('!mark', 'Invalid command args.')
 
     def test_alive(self):
         labhub, testbot = plugin_testbot(plugins.labhub.LabHub, logging.ERROR)
@@ -277,6 +284,7 @@ def test_alive(self):
             testbot.assertCommand('!pr stats 3hours',
                                   '10 PRs opened in last 3 hours\n'
                                   'The community is on fire')
+            testbot.assertCommand('!pr stats', 'Invalid command args.')
 
     def test_invite_me(self):
         teams = {

tests/lmgtfy_test.py

@@ -13,3 +13,4 @@ def test_lmgtfy(testbot):
                           text.convert(
                               Lmgtfy.MSG.format("https://www.lmgtfy.com/?q=py c")
                           ))
+    testbot.assertCommand('!lmgtfy', 'Invalid command args.')

tests/wolfram_alpha_test.py

@@ -20,6 +20,7 @@ def setUp(self):
     @my_vcr.use_cassette('tests/cassettes/wa.yaml')
     def test_wa(self):
         self.testbot.assertCommand("!wa 2^6", "64")
+        self.testbot.assertCommand("!wa", "Invalid command args.")
         with self.assertLogs() as cm:
             self.testbot.assertCommand('!wa this is a sentence',
                                        'Dunno')