def test_config_get_sources():
config = Config(config_file=get_fixtures_directory() + '/config.yaml')
sources = config.get_sources()
assert 'wikia/jira' in sources
assert 'wikia/elastic' in sources
assert 'wikia/tags-report' in sources
assert 'wikia/analytics' in sources
assert sources['wikia/jira'] == {
'name': 'wikia/jira',
'kind': 'common/jira',
'server': "${JIRA_URL}",
'user': "******",
'password': "******"
}
def get_config(env=None):
"""
:type env dict|None
:rtype: Config
"""
return Config(config_file=get_fixtures_directory() + '/config.yaml',
env=env)
def test_config_missing_file():
with pytest.raises(MycroftHolmesConfigError) as exc_info:
Config(config_file=get_fixtures_directory() + '/missing.yaml')
print(exc_info)
assert 'Failed to load' in str(exc_info.value)
assert 'fixtures/missing.yaml' in str(exc_info.value)
def test_config_broken_file():
with pytest.raises(MycroftHolmesConfigError) as exc_info:
Config(config_file=get_fixtures_directory() + '/broken.yaml')
print(exc_info)
assert 'Failed to parse' in str(exc_info.value)
assert 'fixtures/broken.yaml' in str(exc_info.value)
assert 'line 2, column 7' in str(exc_info.value)
def test_get_feature_id():
assert Config.get_feature_id('Foo Bar') == 'foo_bar'
assert Config.get_feature_id('Foo Bar') == 'foo_bar'
assert Config.get_feature_id('FOO Bar') == 'foo_bar'
assert Config.get_feature_id('FOO Bar12') == 'foo_bar12'
assert Config.get_feature_id('CKEditor') == 'ckeditor'
assert Config.get_feature_id('Message Wall') == 'message_wall'
assert Config.get_feature_id(' Message Wall ') == 'message_wall'
def test_config_get_metrics_for_feature_const():
config = Config(config_file=get_fixtures_directory() + '/const.yaml')
base.SOURCES_CACHE = dict()
metrics = config.get_metrics_for_feature('Foo Bar')
print(metrics)
assert len(metrics) == 2
assert metrics[0].get_spec() == {
'name': 'usage/foo',
'source': 'common/const',
'weight': 42
}
assert metrics[0].get_source_name() == 'common/const'
assert metrics[0].get_weight() == 42
assert metrics[1].get_source_name() == 'common/const'
assert metrics[1].get_weight() == 66
def test_calculate_metrics_and_score():
config = Config(config_file=get_fixtures_directory() + '/const.yaml')
metrics = get_metrics_for_feature('Foo Bar', config)
print(metrics)
assert len(metrics) == 3
assert metrics['score'] == 108
assert metrics['usage/foo'] == 1
assert metrics['usage/bar'] == 1
def get_config(env=None):
"""
:type env dict
:rtype: mycroft_holmes.config.Config
"""
# try to parse .env file to use development
load_dotenv(dotenv_path=path.join(getcwd(), '.env'), verbose=True)
config_file = environ.get('MIKE_CONFIG')
assert config_file, 'Please specify where your config YAML file is in MIKE_CONFIG env variable.'
return Config(config_file=config_file, env=env if env else environ)
def test_fetch_value():
config = Config(config_file=get_fixtures_directory() + '/config.yaml')
metric = Metric(spec={
'name': 'foo/bar',
'source': 'common/const',
}, feature_name='foo', config=config)
print(metric)
assert metric.get_source_name() == ConstSource.NAME
assert metric.fetch_value() == 1
assert metric.value == 1, 'We should not need to connect to database to get this'
def test_fetch_value_ignore_weight():
config = Config(config_file=get_fixtures_directory() + '/config.yaml')
metric = Metric(spec={
'name': 'foo/weighted-bar',
'source': 'common/const',
'weight': 1000,
}, feature_name='foo', config=config)
print(metric)
assert metric.get_weight() == 1000
assert metric.fetch_value() == 1 # value should not be affected by metric's weight
def test_config_variables_subst():
config = Config(config_file=get_fixtures_directory() + '/config.yaml')
assert config.get_raw(
)['sources'][0]['user'] == '${JIRA_USER}', 'Variable should be kept'
config = Config(config_file=get_fixtures_directory() + '/config.yaml',
env={'JIRA_USER': '******'})
assert config.get_raw(
)['sources'][0]['user'] == 'MrFoo', 'Variable should be replaced'
def test_config_get_metrics_specs_for_feature():
config = Config(config_file=get_fixtures_directory() + '/config.yaml')
assert config.get_metrics_for_feature(feature_name='foobar') == []
base.SOURCES_CACHE = dict()
metrics_specs = config.get_metrics_for_feature(
feature_name='DynamicPageList')
print(metrics_specs)
assert len(metrics_specs) == 3
assert metrics_specs[0].get_spec() == {
'query':
"component = '{component}' AND Priority = 'Severe - fix in 48h (P2)' AND status = 'Open'",
'source': 'wikia/jira',
'name': 'jira/p2-tickets',
'label': '%d P2 tickets',
'template': {
'component': 'DynamicPageList',
'tag': 'dpl'
},
'weight': 2
}
assert metrics_specs[1].get_spec() == {
'query':
"component = '{component}' AND Priority = 'Major - fix in 28 days (P3)' AND status = 'Open'",
'source': 'wikia/jira',
'name': 'jira/p3-tickets',
'label': '%d P3 tickets',
'template': {
'component': 'DynamicPageList',
'tag': 'dpl'
}
}
def test_config_get_metrics():
config = Config(config_file=get_fixtures_directory() + '/config.yaml')
metrics = config.get_metrics()
print(metrics)
assert 'jira/p2-tickets' in metrics
assert 'jira/p3-tickets' in metrics
assert metrics['jira/p2-tickets'] == {
'name': 'jira/p2-tickets',
'source': 'wikia/jira',
'query':
"component = '{component}' AND Priority = 'Severe - fix in 48h (P2)' AND status = 'Open'",
'label': '%d P2 tickets'
}
assert 'analytics/events' in metrics
assert metrics['analytics/events'] == {
'name': 'analytics/events',
'source': 'wikia/analytics',
'metric': 'ga:totalEvents',
'label': '{ga_label}: %d',
'filters': '{ga_filter}'
}
def test_minimal_config():
config = Config(config_file=get_fixtures_directory() +
'/../../example.yaml')
assert len(config.get_features()) == 3
assert len(config.get_metrics()) == 3
base.SOURCES_CACHE = dict()
metrics = config.get_metrics_for_feature('PanTadeusz')
print(metrics)
assert metrics[0].get_source_name() == 'http/xpath'
# can we handle empty entries in the config?
assert len(config.get_sources()) == 0
def main():
"""
Script entry point
"""
logger = logging.getLogger('collect_metrics')
# list available sources
logger.info('Available sources: %s', SourceBase.get_sources_names())
# read config file provided by MIKE_CONFIG
config = get_config()
# list features and metrics
logger.info('Configured metrics: %s', list(config.get_metrics().keys()))
logger.info('Features: %s', list(config.get_features().keys()))
# set up the metrics storage (and connect to master database)
storage = MetricsStorage(config=config, use_slave=False)
# print(storage.get('ckeditor', 'score')); exit(1)
# fetch metrics values for eac feature and calculate their score
for _, feature in config.get_features().items():
try:
feature_id = Config.get_feature_id(feature['name'])
feature_metrics = get_metrics_for_feature(feature['name'], config)
storage.push(feature_id, feature_metrics)
except MycroftHolmesError as ex:
logger.error('Failed to get metrics values', exc_info=True)
print('\nWe failed to generate metrics values:\n\t%s\n' % repr(ex))
sys.exit(1)
storage.commit()
logger.info('Done')
def test_config_get_features():
config = Config(config_file=get_fixtures_directory() + '/config.yaml')
features = config.get_features()
print(features)
assert len(features) > 4
assert 'DynamicPageList' in features
assert features['DynamicPageList'] == {
'name':
'DynamicPageList',
'url':
'http://docs.company.net/pages/DynamicPageList',
'repo':
'https://github.com/Wikia/app/tree/dev/extensions/DynamicPageList',
'metrics': [
{
'name': 'jira/p2-tickets',
'weight': 2
},
{
'name': 'jira/p3-tickets'
},
{
'name': 'tags-report/usage',
'weight': 0.1
},
],
'template': {
'component': 'DynamicPageList',
'tag': 'dpl'
}
}
assert 'CKEditor' in features
assert features['CKEditor'] == {
'name':
'CKEditor',
'url':
'http://docs.company.net/pages/CKEditor',
'repo':
'https://github.com/Wikia/app/tree/dev/extensions/wikia/RTE',
'metrics': [
{
'name': 'jira/p2-tickets',
'weight': 2
},
{
'name': 'jira/p3-tickets'
},
{
'name': 'editor/impressions'
},
{
'name': 'editor/publishes'
},
],
'template': {
'component': 'CK Editor (RTE)',
'ga_category': 'editor-ck',
}
}
def test_config_loads_correctly():
config = Config(config_file=get_fixtures_directory() + '/config.yaml')
assert config.get_raw()['name'] == 'The COrE Team components'
assert config.get_name() == 'The COrE Team components'