test with CliRunner

brian_polling_manager/interface_stats/cli.py

@@ -72,9 +72,9 @@ def setup_logging():
 
 def ctr2point(measurement, timestamp, counters):
     """
-
     :param measurement: the measurement where the point will be written
-    :param counters: a ERROR_POINT_SCHEMA object
+    :param counters: either a BRIAN_COUNTER_DICT_SCHEMA or
+        ERROR_COUNTER_DICT_SCHEMA object
     :return: a brian_polling_manager.influx.INFLUX_POINT object
     """
     def _is_tag(key_name):
@@ -104,9 +104,19 @@ def _validate_hostname(_unused_ctx, _unused_param, hostname):
         socket.gethostbyname(hostname)
     except socket.error:
         raise click.BadParameter(f'{hostname} is not resolveable')
+    return hostname
 
 
 def _brian_points(router_fqdn, netconf_doc, timestamp, measurement_name):
+    """
+    returns an interable of points that can be written to influxdb
+
+    :param router_fqdn: 'hostname' tag to be set in the generated points
+    :param netconf_doc: a valid loaded netconf doc
+    :param timestamp: timestamp to put in the generated points
+    :param measurement_name: measurement name to put in the generated points
+    :return:
+    """
     _ctr2point = partial(ctr2point, measurement_name, timestamp)
 
     interfaces = juniper.physical_interface_counters(netconf_doc)
@@ -119,6 +129,15 @@ def _brian_points(router_fqdn, netconf_doc, timestamp, measurement_name):
 
 
 def _error_points(router_fqdn, netconf_doc, timestamp, measurement_name):
+    """
+    returns an interable of points that can be written to influxdb
+
+    :param router_fqdn: 'hostname' tag to be set in the generated points
+    :param netconf_doc: a valid loaded netconf doc
+    :param timestamp: timestamp to put in the generated points
+    :param measurement_name: measurement name to put in the generated points
+    :return:
+    """
     _ctr2point = partial(ctr2point, measurement_name, timestamp)
 
     interfaces = juniper.physical_interface_counters(netconf_doc)
@@ -132,8 +151,10 @@ def _error_points(router_fqdn, netconf_doc, timestamp, measurement_name):
 
 def _main(router_fqdn: str, app_config_params: dict):
     """
-    callable entry point, without click
-    ... tmp, for testing
+    callable entry point, without click - for testing
+
+    loads the netconf 'show interfaces' info for the router fqdn,
+    then uses this to generate brian and error points and writes them to influxdb
 
     note: the optional inventory param is only used to validate the hostname
 
@@ -152,6 +173,7 @@ def _main(router_fqdn: str, app_config_params: dict):
     netconf_doc = juniper.get_interface_info_ncrpc(router_fqdn)
     netconf_timestamp = datetime.now()
 
+
     influx_params = app_config_params['influx']['brian-counters']
     points = _brian_points(
         router_fqdn=router_fqdn,
@@ -178,7 +200,7 @@ def _main(router_fqdn: str, app_config_params: dict):
     '--config', 'app_config_params',
     required=True,
     type=click.File('r'),
-    help='Config filename',
+    help='config filename',
     callback=_validate_config)
 @click.option(
     '--router', 'router_fqdn',
@@ -186,8 +208,8 @@ def _main(router_fqdn: str, app_config_params: dict):
     type=click.STRING,
     help='router fqdn',
     callback=_validate_hostname)
-def main(app_config_params: dict):
-    _main(app_config_params)
+def main(router_fqdn, app_config_params: dict):
+    _main(router_fqdn, app_config_params)
 
 
 if __name__ == '__main__':

brian_polling_manager/interface_stats/config.py

@@ -71,7 +71,7 @@ def load(config_file):
     config = json.loads(config_file.read())
     jsonschema.validate(config, CONFIG_SCHEMA)
 
-    for db in config['influx']:
+    for db in config['influx'].values():
         db.setdefault('ssl', DEFAULT_INFLUX_SSL)
         db.setdefault('port', DEFAULT_INFLUX_PORT)
 

test/test_interface_stats.py

@@ -13,6 +13,7 @@ import tempfile
 import time
 from unittest.mock import patch
 
+from click.testing import CliRunner
 import jsonschema
 from lxml import etree
 import pytest
@@ -219,6 +220,14 @@ def app_config_params(free_host_port):
         }
 
 
+@pytest.fixture
+def app_config_filename(app_config_params):
+    with tempfile.NamedTemporaryFile() as f:
+        f.write(json.dumps(app_config_params).encode('utf-8'))
+        f.flush()
+        yield f.name
+
+
 @pytest.fixture
 def brian_influx_container_params(app_config_params):
 
@@ -408,7 +417,7 @@ def _use_docker_compose():
 @pytest.mark.skipif(
     not _use_docker_compose(),
     reason='docker compose not found or disabled')
-def test_e2e(app_config_params, ifc_netconf_rpc, testenv_containers):
+def test_e2e(app_config_params, app_config_filename, ifc_netconf_rpc, testenv_containers):
     """
     load all router interfaces into a tmp influx container, check that
     all potential counter fields are populated
@@ -427,7 +436,15 @@ def test_e2e(app_config_params, ifc_netconf_rpc, testenv_containers):
     with patch('brian_polling_manager.inventory.load_interfaces') as inventory:
         inventory.return_value = poller_interfaces()
         for router_fqdn in managed_routers:
-            cli._main(router_fqdn=router_fqdn, app_config_params=app_config_params)
+            # cli._main(router_fqdn=router_fqdn, app_config_params=app_config_params)
+            runner = CliRunner()
+            result = runner.invoke(
+                cli.main,
+                [
+                    '--config', app_config_filename,
+                    '--router', router_fqdn
+                ])
+            assert result.exit_code == 0, str(result)
 
     def verify_influx_content(influx_config, expected_fields):
         # for each expected field, verify that there's