Add a correct and clean logging configuration

balto/_logging.py

@@ -0,0 +1,25 @@
+import logging
+
+VERBOSE_LOG_FORMAT = "[%(asctime)s] %(pathname)s:%(lineno)d: %(message)s"
+
+
+def setup_logging(verbose=False, debug=False):
+    logger = logging.getLogger("balto")
+    logger.setLevel(logging.DEBUG)
+
+    # Reset handlers
+    logger.handlers = []
+
+    # Add handler
+    console = logging.StreamHandler()
+
+    if debug is False:
+        console.setLevel(logging.INFO)
+    else:
+        console.setLevel(logging.DEBUG)
+
+    if verbose is True:
+        formatter = logging.Formatter(VERBOSE_LOG_FORMAT)
+        console.setFormatter(formatter)
+
+    logger.addHandler(console)

balto/cli.py

@@ -3,15 +3,19 @@
 from __future__ import print_function, unicode_literals
 
 import argparse
+import logging
 import os
 import shutil
 import subprocess
 import time
 import webbrowser
 from multiprocessing import Process
 
+from balto._logging import setup_logging
 from balto.server import server
 
+LOGGER = logging.getLogger(__name__)
+
 
 def main():
     parser = argparse.ArgumentParser(description=__doc__)
@@ -25,11 +29,21 @@ def main():
         action="store",
         default="curses",
     )
+    parser.add_argument(
+        "--verbose",
+        "-v",
+        help="activate the verbose mode",
+        action="store_true",
+        default=False,
+    )
+    parser.add_argument(
+        "--debug", help="activate the debug mode", action="store_true", default=False
+    )
     args = parser.parse_args()
 
+    setup_logging(args.verbose, args.debug)
+
     # Launch the server
-    balto_server_full_path = shutil.which("balto-server")
-    server_args = [balto_server_full_path, args.directory]
     port = 8889
 
     try:

balto/runners/base.py

@@ -1,6 +1,9 @@
 """ Base runner class
 """
 import json
+import logging
+
+LOGGER = logging.getLogger(__name__)
 
 
 def command_formatter(tool, tests_to_run, collect_only):
@@ -36,7 +39,7 @@ def parse_line(line):
     try:
         data = json.loads(decodedline)
     except (json.JSONDecodeError, ValueError) as e:
-        # print("Invalid line", e, repr(decodedline))
+        LOGGER.debug("Invalid line: %r", decodedline, exc_info=True)
         return
 
     return data

balto/runners/docker_runner.py

@@ -1,5 +1,6 @@
 import asyncio
 import json
+import logging
 import tarfile
 import tempfile
 from io import BytesIO
@@ -15,6 +16,8 @@
 DOCKER = DockerClient()
 AIODOCKER = Docker()
 
+LOGGER = logging.getLogger(__name__)
+
 
 def prepare_string_for_tar(name, content):
     dfinfo = tarfile.TarInfo(name)
@@ -97,6 +100,7 @@ async def _launch_container(self, docker_img, local=False):
             await self.read_line(line)
 
     def is_local_docker_host(self):
+        LOGGER.debug("Docker base url: %r", DOCKER.api.base_url)
         if DOCKER.api.base_url in ("http+docker://localunixsocket",):
             return True
 

balto/runners/subprocess_runner.py

@@ -1,9 +1,12 @@
 import asyncio
 import json
+import logging
 import shlex
 
 from balto.runners.base import BaseRunner
 
+LOGGER = logging.getLogger(__name__)
+
 
 async def _read_stream(stream, cb):
     while True:
@@ -39,6 +42,6 @@ async def launch_cmd(self, cmd):
         return_code = await process.wait()
 
         if return_code != 0:
-            print("cmd exited with return code: %r" % return_code)
+            LOGGER.warning("CMD %r exited with return code: %d", cmd, return_code)
 
         return return_code

balto/server.py

@@ -13,10 +13,13 @@
 from aiohttp.web import Application, FileResponse, HTTPNotFound, run_app
 from aiohttp_json_rpc import JsonRpc
 
+from balto._logging import setup_logging
 from balto.config import read_config
 from balto.event_emitter import EventEmitter
 from balto.store import Tests
 
+LOGGER = logging.getLogger(__name__)
+
 
 def get_static_path():
     if getattr(sys, "frozen", False):
@@ -52,14 +55,15 @@ def server(directory):
     tests = Tests(suites)
 
     async def collect_all(request):
-        print("COLLECT ALL")
+        LOGGER.info("Collect ALL")
         tasks = [
             suite.collect_all(directory, em, loop=loop) for suite in suites.values()
         ]
         await asyncio.gather(*tasks, loop=loop)
         return "ok"
 
     async def run_all(request):
+        LOGGER.info("Run ALL")
         tasks = [
             suite.launch_all(directory, em, loop=loop) for suite in suites.values()
         ]
@@ -68,7 +72,7 @@ async def run_all(request):
 
     async def run_selected(request):
         tasks = []
-        print("GOT PARAMS", request.params)
+        LOGGER.info("Run selected: %r", request.params)
         for suite_name, suite_tests in request.params.items():
             suite = suites[suite_name]
             tasks.append(suite.launch_tests(directory, em, loop, suite_tests))
@@ -80,7 +84,7 @@ async def run_selected(request):
     logging.getLogger("aiohttp-json-rpc.server").setLevel(logging.DEBUG)
 
     async def forward_notifications(message):
-        print("MESSAGE", message)
+        LOGGER.debug("Forwarding to %d clients: %r", len(rpc.clients), message)
         for client in rpc.clients:
             data = {"jsonrpc": "2.0", "id": None, "method": "test", "params": message}
             r = await client.ws.send_str(json.dumps(data))
@@ -106,8 +110,20 @@ def main():
     parser.add_argument(
         "directory", help="The directory LITR should start looking for its config file"
     )
+    parser.add_argument(
+        "--verbose",
+        "-v",
+        help="activate the verbose mode",
+        action="store_true",
+        default=False,
+    )
+    parser.add_argument(
+        "--debug", help="activate the debug mode", action="store_true", default=False
+    )
     args = parser.parse_args()
 
+    setup_logging(args.verbose, args.debug)
+
     server(args.directory)