Merge pull request #23 from lsankar4033/fix_logging_for_ci

Fix logging for ci

.travis.yml

@@ -0,0 +1,13 @@
+language: python
+
+python:
+  - 3.8
+
+services:
+  - docker
+
+before_install:
+  - pip install -U pip
+
+script:
+  - ./steth.py logging_test

lib/logging_tests.py

@@ -0,0 +1,37 @@
+import os
+
+from lib.runner import run_module, file_to_module, return_code_to_status
+
+LOGGING_TESTS_DIR = 'logging_tests'
+
+def all_logging_test_files():
+    tests = []
+    for root, dirs, files in os.walk(LOGGING_TESTS_DIR):
+        tests.extend([f'{root}/{f}' for f in files if f.endswith('.py')])
+
+    return tests
+
+
+def run_logging_tests(client):
+    print(client)
+
+    failures = {}
+    for file in all_logging_test_files():
+        module = file_to_module(file)
+        (return_code, logs) = run_module(module, {})
+
+        print(f'\t{module} {return_code_to_status(return_code)}')
+        if return_code != 0:
+            failures[module] = (return_code, logs)
+
+    if len(failures) > 0:
+        for module, (return_code, logs) in failures.items():
+            print('')
+            print(f'\t{module} {return_code_to_status(return_code)}')
+
+            for log in logs:
+                print(f'\t{log}')
+
+        return 1
+
+    return 0

lib/runner.py

@@ -3,6 +3,7 @@
 import subprocess
 
 import trio
+from colored import fg
 
 from lib.console import ConsoleWriter
 from lib.instance_configs import DEFAULT_ARGS
@@ -23,23 +24,23 @@ def all_test_files():
 def file_to_module(script):
     return script.replace('/', '.')[0:-3]
 
+def return_code_to_status(return_code):
+    if return_code == 0:
+        return f"{fg('green')}\u2713{fg('white')}"
 
-# TODO: add args back in
-def run_module(module, args, cw):
-    print(f'Running module: {module} with args {args}')
-    #module = importlib.import_module(module)
+    else:
+        return f"{fg('red')}\u2717{fg('white')}"
 
-    #if not hasattr(module, 'run'):
-        #cw.fail(f'module {module} does not have a run method')
-        #return
+def run_module(module_str, args):
+    module = importlib.import_module(module_str)
 
-    #return_code = trio.run(module.run, args)
-    #if return_code == 0:
-        #cw.success('SUCCESS')
+    if not hasattr(module, 'run'):
+        print(f'\t{module} does not have a run method')
+        return
 
-    #else:
-        #cw.fail('FAILED')
+    return_code, logs = trio.run(module.run, args)
 
+    return (return_code, logs)
 
 def test_matches_filter(test, test_filter):
     return test_filter is None or test == test_filter
@@ -49,4 +50,4 @@ def run_all_tests(cw=ConsoleWriter(None, None), test_filter=None):
         if test_matches_filter(test_file, test_filter):
             cw = cw._replace(test=file_to_module(test_file))
 
-            run_module(file_to_module(test_file), DEFAULT_ARGS, cw)
+            run_module(file_to_module(test_file), DEFAULT_ARGS)

logging_tests/test_fail.py

@@ -0,0 +1,2 @@
+async def run(args):
+    return (1, ['error 1', 'error 2'])

logging_tests/test_success.py

@@ -0,0 +1,2 @@
+async def run(args):
+    return (0, [])

steth.py

@@ -8,6 +8,7 @@
 from lib.console import ConsoleWriter
 from lib.fixtures import extract_fixtures, setup_fixture, teardown_fixture
 from lib.runner import run_all_tests
+from lib.logging_tests import run_logging_tests
 
 
 def run_start_fixture(args):
@@ -61,6 +62,16 @@ def run_test(args):
                 teardown_fixture(fixture)
 
 
+def run_logging_test(args):
+    failed = False
+    for client in SUPPORTED_CLIENTS:
+        return_code= run_logging_tests(client)
+        if return_code != 0:
+            failed = True
+
+    if failed:
+        exit(1)
+
 if __name__ == '__main__':
     steth = argparse.ArgumentParser(description='Stethoscope tool for running multi-client Eth2 scenarios')
     steth_sub = steth.add_subparsers()
@@ -83,5 +94,8 @@ def run_test(args):
     test.add_argument('-r', '--reuse', default=False, action='store_true', help='reuse running fixtures')
     test.set_defaults(func=run_test)
 
+    test = steth_sub.add_parser('logging_test', help='Display example logs from ./steth.py test. Useful for testing CI integration')
+    test.set_defaults(func=run_logging_test)
+
     args = steth.parse_args()
     args.func(args)