opendev
/
elastic-recheck
Code Issues Proposed changes

Merge "Enable configuration via environment variables"

This commit is contained in:
Zuul 2020-09-18 07:14:43 +00:00 committed by Gerrit Code Review
parent e6b1354d91 3d1411f3a1
commit 262ec2c995
3 changed files with 62 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
elastic_recheck/bot.py
View File

@ -67,7 +67,7 @@ class RecheckWatchBot(irc.bot.SingleServerIRCBot):
def __init__(self, channels, config): def __init__(self, channels, config):
super(RecheckWatchBot, self).__init__( super(RecheckWatchBot, self).__init__(
[(config.ircbot_server, [(config.ircbot_server,
config.ircbot_port, int(config.ircbot_port),
config.ircbot_server_password)], config.ircbot_server_password)],
config.ircbot_nick, config.ircbot_nick,
config.ircbot_nick) config.ircbot_nick)

132
elastic_recheck/config.py
View File

@ -16,19 +16,20 @@ import os
import re import re
import configparser import configparser
DEFAULT_INDEX_FORMAT = 'logstash-%Y.%m.%d' # Can be overriden by defining environment variables with same name
DEFAULTS = {
ES_URL = 'http://logstash.openstack.org:80/elasticsearch' 'ES_URL': 'http://logstash.openstack.org:80/elasticsearch',
LS_URL = 'http://logstash.openstack.org' 'LS_URL': 'http://logstash.openstack.org',
DB_URI = 'mysql+pymysql://query:query@logstash.openstack.org/subunit2sql' 'DB_URI': 'mysql+pymysql://query:query@logstash.openstack.org/subunit2sql',
'server_password': '',
JOBS_RE = 'dsvm' 'CI_USERNAME': 'jenkins',
CI_USERNAME = 'jenkins' 'JOBS_RE': 'dsvm',
'PID_FN': '/var/run/elastic-recheck/elastic-recheck.pid',
GERRIT_QUERY_FILE = 'queries' 'INDEX_FORMAT': r'logstash-%Y.%m.%d',
GERRIT_HOST = 'review.opendev.org' 'GERRIT_QUERY_FILE': 'queries',
'GERRIT_HOST': 'review.opendev.org',
PID_FN = '/var/run/elastic-recheck/elastic-recheck.pid' 'IRC_LOG_CONFIG': None
}
# Not all teams actively used elastic recheck for categorizing their # Not all teams actively used elastic recheck for categorizing their
# work, so to keep the uncategorized page more meaningful, we exclude # work, so to keep the uncategorized page more meaningful, we exclude
@ -82,76 +83,61 @@ class Config(object):
uncat_search_size=None, uncat_search_size=None,
gerrit_query_file=None): gerrit_query_file=None):
self.es_url = es_url or ES_URL # override defaults with environment variables
self.ls_url = ls_url or LS_URL for key, val in os.environ.items():
self.db_uri = db_uri or DB_URI if key in DEFAULTS:
self.jobs_re = jobs_re or JOBS_RE DEFAULTS[key] = val
self.ci_username = ci_username or CI_USERNAME
self.es_index_format = es_index_format or DEFAULT_INDEX_FORMAT self.es_url = es_url or DEFAULTS['ES_URL']
self.pid_fn = pid_fn or PID_FN self.ls_url = ls_url or DEFAULTS['LS_URL']
self.db_uri = db_uri or DEFAULTS['DB_URI']
self.jobs_re = jobs_re or DEFAULTS['JOBS_RE']
self.ci_username = ci_username or DEFAULTS['CI_USERNAME']
self.es_index_format = es_index_format or DEFAULTS['INDEX_FORMAT']
self.pid_fn = pid_fn or DEFAULTS['PID_FN']
self.ircbot_channel_config = None self.ircbot_channel_config = None
self.irc_log_config = None self.irc_log_config = DEFAULTS['IRC_LOG_CONFIG']
self.all_fails_query = all_fails_query or ALL_FAILS_QUERY self.all_fails_query = all_fails_query or ALL_FAILS_QUERY
self.excluded_jobs_regex = excluded_jobs_regex or EXCLUDED_JOBS_REGEX self.excluded_jobs_regex = excluded_jobs_regex or EXCLUDED_JOBS_REGEX
self.included_projects_regex = \ self.included_projects_regex = \
included_projects_regex or INCLUDED_PROJECTS_REGEX included_projects_regex or INCLUDED_PROJECTS_REGEX
self.uncat_search_size = uncat_search_size or UNCAT_MAX_SEARCH_SIZE self.uncat_search_size = uncat_search_size or UNCAT_MAX_SEARCH_SIZE
self.gerrit_query_file = gerrit_query_file or GERRIT_QUERY_FILE self.gerrit_query_file = (gerrit_query_file or
DEFAULTS['GERRIT_QUERY_FILE'])
self.gerrit_user = None
self.gerrit_host = None
self.gerrit_host_key = None
if config_file or config_obj: if config_file or config_obj:
if config_obj: if config_obj:
config = config_obj config = config_obj
else: else:
config = configparser.ConfigParser( config = configparser.ConfigParser()
{'es_url': ES_URL,
'ls_url': LS_URL,
'db_uri': DB_URI,
'server_password': '',
'ci_username': CI_USERNAME,
'jobs_re': JOBS_RE,
'pidfile': PID_FN,
'index_format': DEFAULT_INDEX_FORMAT,
'query_file': GERRIT_QUERY_FILE
}
)
config.read(config_file) config.read(config_file)
cfg_map = {
if config.has_section('data_source'): 'db_uri': ('data_source', 'db_uri'),
self.es_url = config.get('data_source', 'es_url') 'es_url': ('data_source', 'es_url'),
self.ls_url = config.get('data_source', 'ls_url') 'gerrit_host': ('gerrit', 'host'),
self.db_uri = config.get('data_source', 'db_uri') 'gerrit_host_key': ('gerrit', 'key'),
self.es_index_format = config.get('data_source', 'gerrit_query_file': ('gerrit', 'query_file'),
'index_format') 'gerrit_user': ('gerrit', 'user'),
'index_format': ('data_source', 'index_format'),
if config.has_section('recheckwatch'): 'irc_log_config': ('ircbot', 'log_config'),
self.ci_username = config.get('recheckwatch', 'ci_username') 'ircbot_channel_config': ('ircbot', 'channel_config'),
self.jobs_re = config.get('recheckwatch', 'jobs_re') 'ircbot_server': ('ircbot', 'server_password'),
'ircbot_sever_password': ('ircbot', 'port'),
if config.has_section('gerrit'): 'jobs_re': ('recheckwatch', 'jobs_re'),
self.gerrit_user = config.get('gerrit', 'user') 'ls_url': ('data_source', 'ls_url'),
self.gerrit_query_file = config.get('gerrit', 'query_file') 'nick': ('ircbot', 'nick'),
# workaround for python api change: 'pass': ('ircbot', 'pass'),
# https://docs.python.org/3/library/configparser.html#fallback-values 'pid_fn': ('ircbot', 'pidfile'),
'recheckwatch': ('recheckwatch', 'ci_username'),
}
for k, v in cfg_map.items():
try: try:
self.gerrit_host = config.get('gerrit', if hasattr(self, k) and getattr(self, k) is None:
'host', setattr(self, k, config.get(v[0], v[1]))
fallback=GERRIT_HOST) except (
except TypeError: configparser.NoOptionError,
self.gerrit_host = config.get('gerrit', configparser.NoSectionError):
'host', pass
GERRIT_HOST)
self.gerrit_host_key = config.get('gerrit', 'key')
if config.has_section('ircbot'):
self.pid_fn = os.path.expanduser(config.get('ircbot',
'pidfile'))
self.ircbot_nick = config.get('ircbot', 'nick')
self.ircbot_pass = config.get('ircbot', 'pass')
self.ircbot_server = config.get('ircbot', 'server')
self.ircbot_port = config.getint('ircbot', 'port')
self.ircbot_server_password = config.get('ircbot',
'server_password')
self.ircbot_channel_config = config.get('ircbot',
'channel_config')
if config.has_option('ircbot', 'log_config'):
self.irc_log_config = config.get('ircbot', 'log_config')

3
elastic_recheck/tests/unit/test_bot.py
View File

@ -30,7 +30,7 @@ def _set_fake_config(fake_config):
fake_config.add_section('ircbot') fake_config.add_section('ircbot')
fake_config.add_section('gerrit') fake_config.add_section('gerrit')
# Set fake ircbot config # Set fake ircbot config
fake_config.set('ircbot', 'pidfile', er_conf.PID_FN) fake_config.set('ircbot', 'pidfile', er_conf.DEFAULTS['PID_FN'])
fake_config.set('ircbot', 'nick', 'Fake_User') fake_config.set('ircbot', 'nick', 'Fake_User')
fake_config.set('ircbot', 'pass', '') fake_config.set('ircbot', 'pass', '')
fake_config.set('ircbot', 'server', 'irc.fake.net') fake_config.set('ircbot', 'server', 'irc.fake.net')
@ -47,6 +47,7 @@ def _set_fake_config(fake_config):
# NOTE(mtreinish) Using unittest here because testtools TestCase.assertRaises # NOTE(mtreinish) Using unittest here because testtools TestCase.assertRaises
# doesn't support using it as a context manager # doesn't support using it as a context manager
class TestBot(unittest.TestCase): class TestBot(unittest.TestCase):
def setUp(self): def setUp(self):
super(TestBot, self).setUp() super(TestBot, self).setUp()
self.fake_config = configparser.ConfigParser( self.fake_config = configparser.ConfigParser(