Guard debug tracing with a TRACE flag

Signed-off-by: Philippe Ombredanne <[email protected]>

Author: pombredanne

src/container_inspector/cli.py

@@ -6,24 +6,25 @@
 # See https://aboutcode.org for more information about nexB OSS projects.
 #
 
-import csv as csv_module
-import json as json_module
 import logging
 import os
-from os import path
 import sys
 import tempfile
+import csv as csv_module
+import json as json_module
+from os import path
 
 import click
 
 from container_inspector import image
 from container_inspector import dockerfile
 from container_inspector import rootfs
 
+TRACE = False
 logger = logging.getLogger(__name__)
-# un-comment these lines to enable logging
-# logging.basicConfig(level=logging.DEBUG, stream=sys.stdout)
-# logger.setLevel(logging.DEBUG)
+if TRACE:
+    logging.basicConfig(level=logging.DEBUG, stream=sys.stdout)
+    logger.setLevel(logging.DEBUG)
 
 
 @click.command()

src/container_inspector/distro.py

@@ -15,15 +15,15 @@
 
 from container_inspector import rootfs
 
+TRACE = False
 logger = logging.getLogger(__name__)
-# un-comment these lines to enable logging
-import sys
-logging.basicConfig(level=logging.DEBUG, stream=sys.stdout)
-logger.setLevel(logging.DEBUG)
 
 
-def logger_debug(*args):
-    return logger.debug(' '.join(isinstance(a, str) and a or repr(a) for a in args))
+
+if TRACE:
+    import sys
+    logging.basicConfig(level=logging.DEBUG, stream=sys.stdout)
+    logger.setLevel(logging.DEBUG)
 
 """
 Utilities to detect the "distro" of a root filesystem (be it a VM or rootfs
@@ -297,7 +297,7 @@ def from_os_release_file(cls, location):
         parsed
         """
         if not location or not os.path.exists(location):
-            logger.debug(f'from_os_release_file: {location!r} does not exists')
+            if TRACE: logger.debug(f'from_os_release_file: {location!r} does not exists')
             return
 
         data = parse_os_release(location) or {}
@@ -334,7 +334,7 @@ def from_os_release_file(cls, location):
         if data:
             new_data['extra_data'] = data
 
-        logger.debug(f'from_os_release_file: new_data: {new_data!r}')
+        if TRACE: logger.debug(f'from_os_release_file: new_data: {new_data!r}')
 
         return cls(**new_data)
 
@@ -357,10 +357,10 @@ def from_rootfs(cls, location, base_distro=None):
         manifest) and may be missing from the rootfs proper (for instance of an
         /etc/os-release is missing in the rootfs for a Linux-based image).
         """
-        logger.debug(f'from_rootfs: {location!r} base_distro: {base_distro!r}')
+        if TRACE: logger.debug(f'from_rootfs: {location!r} base_distro: {base_distro!r}')
 
         if not location or not os.path.exists(location):
-            logger.debug(f'from_rootfs: {location!r} does not exists')
+            if TRACE: logger.debug(f'from_rootfs: {location!r} does not exists')
             return
 
         finders = {
@@ -370,10 +370,10 @@ def from_rootfs(cls, location, base_distro=None):
         }
 
         for finder_os, finder in finders.items():
-            logger.debug(f'from_rootfs: trying finder_os: {finder_os!r}')
+            if TRACE: logger.debug(f'from_rootfs: trying finder_os: {finder_os!r}')
 
             found = finder(location)
-            logger.debug(f'from_rootfs: trying found: {found!r}')
+            if TRACE: logger.debug(f'from_rootfs: trying found: {found!r}')
             if found:
                 if base_distro:
                     if base_distro.os != finder_os:
@@ -383,11 +383,11 @@ def from_rootfs(cls, location, base_distro=None):
                         )
 
                     merged = base_distro.merge(found)
-                    logger.debug(f'from_rootfs: returning merged: {merged!r}')
+                    if TRACE: logger.debug(f'from_rootfs: returning merged: {merged!r}')
                     return merged
 
                 else:
-                    logger.debug(f'from_rootfs: returning found: {found!r}')
+                    if TRACE: logger.debug(f'from_rootfs: returning found: {found!r}')
                     return found
 
     @classmethod
@@ -457,7 +457,7 @@ def merge(self, other_distro):
         Return a new distro based on this Distro data updated with non-empty
         values from the ``other_distro`` Distro object.
         """
-        logger.debug(f'merge: {self!r} with: {other_distro!r}')
+        if TRACE: logger.debug(f'merge: {self!r} with: {other_distro!r}')
 
         existing = self.to_dict()
         if other_distro:
@@ -466,9 +466,9 @@ def merge(self, other_distro):
                 if v
             }
             existing.update(other_non_empty)
-            logger.debug(f'merge: updated data: {existing!r}')
+            if TRACE: logger.debug(f'merge: updated data: {existing!r}')
 
-        logger.debug(f'merge: merged data: {existing!r}')
+        if TRACE: logger.debug(f'merge: merged data: {existing!r}')
 
         return type(self)(**existing)
 

src/container_inspector/dockerfile.py

@@ -8,15 +8,17 @@
 
 import logging
 import operator
+import os
 from os import path
 
 import dockerfile_parse
-import os
 
+TRACE = False
 logger = logging.getLogger(__name__)
-# un-comment these lines to enable logging
-# logging.basicConfig(level=logging.DEBUG, stream=sys.stdout)
-# logger.setLevel(logging.DEBUG)
+if TRACE:
+    import sys
+    logging.basicConfig(level=logging.DEBUG, stream=sys.stdout)
+    logger.setLevel(logging.DEBUG)
 
 """
 Analysis helper for Docker Dockerfiles.
@@ -32,7 +34,7 @@ def get_dockerfile(location):
     if not 'Dockerfile' in fn:
         return {}
 
-    logger.debug('Found Dockerfile at: %(location)r' % locals())
+    if TRACE: logger.debug('Found Dockerfile at: %(location)r' % locals())
 
     try:
         # TODO: keep comments instead of ignoring them:
@@ -52,7 +54,7 @@ def get_dockerfile(location):
             df_data['instructions'].append(entry)
         return {location: df_data}
     except:
-        logger.debug('Error parsing Dockerfile at: %(location)r' % locals())
+        if TRACE: logger.debug('Error parsing Dockerfile at: %(location)r' % locals())
         return {}
 
 
@@ -80,7 +82,7 @@ def collect_dockerfiles(location):
     for top, dirs, files in os.walk(location):
         for f in files:
             dfiles.update(get_dockerfile(path.join(top, f)))
-    logger.debug('collect_dockerfiles: %(dfiles)r' % locals())
+    if TRACE: logger.debug('collect_dockerfiles: %(dfiles)r' % locals())
     return dfiles
 
 

src/container_inspector/image.py

@@ -21,15 +21,12 @@
 from container_inspector.utils import load_json
 from container_inspector.utils import sha256_digest
 
+TRACE = False
 logger = logging.getLogger(__name__)
-# un-comment these lines to enable logging
-import sys
-logging.basicConfig(level=logging.DEBUG, stream=sys.stdout)
-logger.setLevel(logging.DEBUG)
-
-
-def logger_debug(*args):
-    return logger.debug(' '.join(isinstance(a, str) and a or repr(a) for a in args))
+if TRACE:
+    import sys
+    logging.basicConfig(level=logging.DEBUG, stream=sys.stdout)
+    logger.setLevel(logging.DEBUG)
 
 """
 Objects to handle Docker and OCI images and Layers.
@@ -419,7 +416,7 @@ def get_images_from_tarball(
         If `verify` is True, perform extra checks on the config data and layers
         checksums.
         """
-        logger.debug(f'get_images_from_tarball: {archive_location} , extracting to: {extracted_location}')
+        if TRACE: logger.debug(f'get_images_from_tarball: {archive_location} , extracting to: {extracted_location}')
 
         Image.extract(
             archive_location=archive_location,
@@ -445,14 +442,14 @@ def get_images_from_dir(
         If `verify` is True, perform extra checks on the config data and layers
         checksums.
         """
-        logger.debug(f'get_images_from_dir: from  {extracted_location} and archive_location: {archive_location}')
+        if TRACE: logger.debug(f'get_images_from_dir: from  {extracted_location} and archive_location: {archive_location}')
 
         if not os.path.isdir(extracted_location):
             raise Exception(f'Not a directory: {extracted_location}')
 
         image_format = Image.find_format(extracted_location)
 
-        logger.debug(f'get_images_from_dir: image_format: {image_format}')
+        if TRACE: logger.debug(f'get_images_from_dir: image_format: {image_format}')
 
         if image_format == 'docker':
             return Image.get_docker_images_from_dir(
@@ -510,7 +507,7 @@ def get_docker_images_from_dir(
             ....
         ]
         """
-        logger.debug(f'get_docker_images_from_dir: {extracted_location}')
+        if TRACE: logger.debug(f'get_docker_images_from_dir: {extracted_location}')
 
         if not os.path.isdir(extracted_location):
             raise Exception(f'Not a directory: {extracted_location}')
@@ -523,19 +520,19 @@ def get_docker_images_from_dir(
 
         manifest = load_json(manifest_loc)
 
-        logger.debug(f'get_docker_images_from_dir: manifest: {manifest}')
+        if TRACE: logger.debug(f'get_docker_images_from_dir: manifest: {manifest}')
 
         images = []
         for manifest_config in manifest:
-            logger.debug(f'get_docker_images_from_dir: manifest_config: {manifest_config}')
+            if TRACE: logger.debug(f'get_docker_images_from_dir: manifest_config: {manifest_config}')
             img = Image.from_docker_manifest_config(
                 extracted_location=extracted_location,
                 archive_location=archive_location,
                 manifest_config=manifest_config,
                 verify=verify,
 
             )
-            logger.debug(f'get_docker_images_from_dir: img: {img!r}')
+            if TRACE: logger.debug(f'get_docker_images_from_dir: img: {img!r}')
 
             images.append(img)
 
@@ -612,7 +609,7 @@ def from_docker_manifest_config(
             }
          }
         """
-        logger.debug(f'from_docker_manifest_config: manifest_config: {manifest_config!r}')
+        if TRACE: logger.debug(f'from_docker_manifest_config: manifest_config: {manifest_config!r}')
 
         manifest_config = utils.lower_keys(manifest_config)
 

src/container_inspector/rootfs.py

@@ -14,11 +14,12 @@
 from commoncode.fileutils import delete
 from commoncode.paths import split
 
+TRACE = False
 logger = logging.getLogger(__name__)
-# un-comment these lines to enable logging
-import sys
-logging.basicConfig(level=logging.DEBUG, stream=sys.stdout)
-logger.setLevel(logging.DEBUG)
+if TRACE:
+    import sys
+    logging.basicConfig(level=logging.DEBUG, stream=sys.stdout)
+    logger.setLevel(logging.DEBUG)
 
 """
 Utilities to handle image and layer archives and recreate proper rootfs
@@ -64,7 +65,7 @@ def rebuild_rootfs(img, target_dir):
     deletions = []
 
     for layer_num, layer in enumerate(img.layers):
-        logger.debug(
+        if TRACE: logger.debug(
             f'Extracting layer {layer_num} - {layer.layer_id} '
             f'tarball: {layer.archive_location}'
         )
@@ -73,26 +74,26 @@ def rebuild_rootfs(img, target_dir):
         # Note that we are not preserving any special file and any file permission
         extracted_loc = tempfile.mkdtemp('container_inspector-docker')
         layer.extract(extracted_location=extracted_loc)
-        logger.debug(f'  Extracted layer to: {extracted_loc}')
+        if TRACE: logger.debug(f'  Extracted layer to: {extracted_loc}')
 
         # 2. find whiteouts in that layer.
         whiteouts = list(find_whiteouts(extracted_loc))
-        logger.debug('  Merging extracted layers and applying unionfs whiteouts')
-        logger.debug('  Whiteouts:\n' + '     \n'.join(map(repr, whiteouts)))
+        if TRACE: logger.debug('  Merging extracted layers and applying unionfs whiteouts')
+        if TRACE: logger.debug('  Whiteouts:\n' + '     \n'.join(map(repr, whiteouts)))
 
         # 3. remove whiteouts in the previous layer stack (e.g. the WIP rootfs)
         for whiteout_marker_loc, whiteable_path in whiteouts:
-            logger.debug(f'    Deleting dir or file with whiteout marker: {whiteout_marker_loc}')
+            if TRACE: logger.debug(f'    Deleting dir or file with whiteout marker: {whiteout_marker_loc}')
             whiteable_loc = os.path.join(target_dir, whiteable_path)
             delete(whiteable_loc)
             # also delete the whiteout marker file
             delete(whiteout_marker_loc)
             deletions.append(whiteable_loc)
 
         # 4. finall copy/overwrite the extracted layer over the WIP rootfs
-        logger.debug(f'  Moving extracted layer from: {extracted_loc} to: {target_dir}')
+        if TRACE: logger.debug(f'  Moving extracted layer from: {extracted_loc} to: {target_dir}')
         copytree(extracted_loc, target_dir)
-        logger.debug(f'  Moved layer to: {target_dir}')
+        if TRACE: logger.debug(f'  Moved layer to: {target_dir}')
         delete(extracted_loc)
 
     return deletions
@@ -227,27 +228,27 @@ def find_root(
 
     ``walker`` is a callable behaving like ``os.walk()`` and is used for testing.
     """
-    logger.debug(
+    if TRACE: logger.debug(
         f'find_root: location={location!r}, max_depth={max_depth!r}, '
         f'root_paths={root_paths!r}, min_paths={min_paths!r}'
     )
     depth = 0
     for top, dirs, files in walker(location):
-        logger.debug(f' find_root: top={top!r}, dirs={dirs!r}, files={files!r}')
+        if TRACE: logger.debug(f' find_root: top={top!r}, dirs={dirs!r}, files={files!r}')
         if max_depth:
             depth = compute_path_depth(location, top)
-            logger.debug(f'  find_root: top depth={depth!r}')
+            if TRACE: logger.debug(f'  find_root: top depth={depth!r}')
             if depth > max_depth:
-                logger.debug(
+                if TRACE: logger.debug(
                     f'    find_root: max_depth={max_depth!r}, '
                     f'depth={depth!r} returning None')
                 return
 
         matches = len(set(dirs + files) & root_paths)
-        logger.debug(f'  find_root: top={top!r}, matches={matches!r}')
+        if TRACE: logger.debug(f'  find_root: top={top!r}, matches={matches!r}')
 
         if matches >= min_paths:
-            logger.debug(f'    find_root: matches >= min_paths: returning {top!r}')
+            if TRACE: logger.debug(f'    find_root: matches >= min_paths: returning {top!r}')
             return top
 
-    logger.debug(f'find_root: noting found: returning None')
+    if TRACE: logger.debug(f'find_root: noting found: returning None')

src/container_inspector/utils.py

@@ -15,11 +15,12 @@
 
 from extractcode.extract import extract_file
 
+TRACE = False
 logger = logging.getLogger(__name__)
-# un-comment these lines to enable logging
-import sys
-logging.basicConfig(level=logging.DEBUG, stream=sys.stdout)
-logger.setLevel(logging.DEBUG)
+if TRACE:
+    import sys
+    logging.basicConfig(level=logging.DEBUG, stream=sys.stdout)
+    logger.setLevel(logging.DEBUG)
 
 
 def load_json(location):
@@ -106,7 +107,7 @@ def extract_tar_keeping_symlinks(location, target_dir):
     Raise exceptions on possible problematic relative paths.
     """
     import tarfile
-    logger.debug(f'extract_tar_keeping_symlinks: {location} to {target_dir}')
+    if TRACE: logger.debug(f'extract_tar_keeping_symlinks: {location} to {target_dir}')
 
     fileutils.create_dir(target_dir)
 
@@ -117,7 +118,7 @@ def extract_tar_keeping_symlinks(location, target_dir):
         for tinfo in tarball:
             if tinfo.isdev():
                 continue
-            logger.debug(f'extract_tar_keeping_symlinks: {tinfo}')
+            if TRACE: logger.debug(f'extract_tar_keeping_symlinks: {tinfo}')
             tarball.extract(
                 member=tinfo,
                 path=target_dir,