From 7f785589a645ef7703509cbc38f67d15398ec6a5 Mon Sep 17 00:00:00 2001
From: Sean Dague <sean.dague@samsung.com>
Date: Mon, 13 Jan 2014 14:23:00 -0500
Subject: [PATCH] refactor bot to be based on argparse

this makes the bot based on argparse, and provides a tox job that
makes running the bot in test mode a little more sane. It also
provides for a new '-n' nocomment item so you can run the bot
and not be worried that it will report to gerrit with findings.

Change-Id: If9d6a7e72dd8d9338f2dd3283cf9a761488122de
---
 elastic_recheck/bot.py | 43 +++++++++++++++++++++++++++++-------------
 tox.ini                |  4 ++++
 2 files changed, 34 insertions(+), 13 deletions(-)

diff --git a/elastic_recheck/bot.py b/elastic_recheck/bot.py
index 07302ed3..607caabc 100755
--- a/elastic_recheck/bot.py
+++ b/elastic_recheck/bot.py
@@ -37,14 +37,13 @@ openstack-qa:
      - negative
 """
 
-
+import argparse
 import ConfigParser
 import daemon
 import irc.bot
 import logging
 import logging.config
 import os
-import sys
 import threading
 import time
 import yaml
@@ -95,7 +94,8 @@ class RecheckWatchBot(irc.bot.SingleServerIRCBot):
 
 
 class RecheckWatch(threading.Thread):
-    def __init__(self, ircbot, channel_config, username, queries, host, key):
+    def __init__(self, ircbot, channel_config, username,
+                 queries, host, key, commenting=True):
         threading.Thread.__init__(self)
         self.ircbot = ircbot
         self.channel_config = channel_config
@@ -104,6 +104,7 @@ class RecheckWatch(threading.Thread):
         self.queries = queries
         self.host = host
         self.connected = False
+        self.commenting = commenting
         self.key = key
 
     def new_error(self, channel, data):
@@ -150,7 +151,8 @@ class RecheckWatch(threading.Thread):
                 else:
                     event['bug_numbers'] = bug_numbers
                     self._read(event)
-                    stream.leave_comment(project, change_id, bug_numbers)
+                    if self.commenting:
+                        stream.leave_comment(project, change_id, bug_numbers)
             except Exception:
                 self.log.exception("Uncaught exception processing event.")
 
@@ -171,7 +173,22 @@ class ChannelConfig(object):
                 self.events[event] = event_set
 
 
-def _main(config):
+def get_options():
+    parser = argparse.ArgumentParser(
+        description="IRC bot for elastic recheck bug reporting")
+    parser.add_argument('-f', '--foreground',
+                        default=False,
+                        action='store_true',
+                        help="Run in foreground")
+    parser.add_argument('-n', '--nocomment',
+                        default=False,
+                        action='store_true',
+                        help="Don't comment in gerrit. Useful in testing.")
+    parser.add_argument('conffile', nargs=1, help="Configuration file")
+    return parser.parse_args()
+
+
+def _main(args, config):
     setup_logging(config)
 
     fp = config.get('ircbot', 'channel_config')
@@ -198,31 +215,31 @@ def _main(config):
         config.get('gerrit', 'user'),
         config.get('gerrit', 'query_file'),
         config.get('gerrit', 'host', 'review.openstack.org'),
-        config.get('gerrit', 'key'))
+        config.get('gerrit', 'key'),
+        not args.nocomment
+    )
 
     recheck.start()
     bot.start()
 
 
 def main():
-    if len(sys.argv) < 2:
-        print "Usage: %s CONFIGFILE" % sys.argv[0]
-        sys.exit(1)
+    args = get_options()
 
     config = ConfigParser.ConfigParser({'server_password': None})
-    config.read(sys.argv[1])
+    config.read(args.conffile)
 
     if config.has_option('ircbot', 'pidfile'):
         pid_fn = os.path.expanduser(config.get('ircbot', 'pidfile'))
     else:
         pid_fn = '/var/run/elastic-recheck/elastic-recheck.pid'
 
-    if '-d' in sys.argv:
-        _main(config)
+    if args.foreground:
+        _main(args, config)
     else:
         pid = pid_file_module.TimeoutPIDLockFile(pid_fn, 10)
         with daemon.DaemonContext(pidfile=pid):
-            _main(config)
+            _main(args, config)
 
 
 def setup_logging(config):
diff --git a/tox.ini b/tox.ini
index 65548e47..0778378f 100644
--- a/tox.ini
+++ b/tox.ini
@@ -27,6 +27,10 @@ commands = {posargs}
 [testenv:cover]
 commands = python setup.py testr --coverage --testr-args='{posargs}'
 
+[testenv:run]
+# test to run the bot as a non voting foreground process
+commands = python elastic_recheck/bot.py -f -n elasticRecheck.conf
+
 [flake8]
 # H803 Skipped on purpose
 # E125 Skipped because it's an overreach (and anti-emacs)