Merge pull request #212 from lukpueh/fix-logging

Configure basic top-level logger

Author: lukpueh

securesystemslib/__init__.py

@@ -0,0 +1,11 @@
+import logging
+
+# Configure a basic 'securesystemslib' top-level logger with a StreamHandler
+# (print to console) and the WARNING log level (print messages of type
+# warning, error or critical). This is similar to what 'logging.basicConfig'
+# would do with the root logger. All 'securesystemslib.*' loggers default to
+# this top-level logger and thus may be configured (e.g. formatted, silenced,
+# etc.) with it. It can be accessed via logging.getLogger('securesystemslib').
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.WARNING)
+logger.addHandler(logging.StreamHandler())

securesystemslib/ecdsa_keys.py

@@ -66,7 +66,7 @@
 
 _SUPPORTED_ECDSA_SCHEMES = ['ecdsa-sha2-nistp256']
 
-logger = logging.getLogger('securesystemslib_ecdsa_keys')
+logger = logging.getLogger(__name__)
 
 
 def generate_public_and_private(scheme='ecdsa-sha2-nistp256'):

securesystemslib/exceptions.py

@@ -25,11 +25,8 @@
 from __future__ import division
 from __future__ import unicode_literals
 
-import logging
-
 import six
 
-logger = logging.getLogger('securesystemslib.exceptions')
 
 
 class Error(Exception):

securesystemslib/hash.py

@@ -30,16 +30,13 @@
 from __future__ import division
 from __future__ import unicode_literals
 
-import logging
 import hashlib
 
 import six
 
 import securesystemslib.exceptions
 import securesystemslib.formats
 
-# Import securesystemslib logger to log warning messages.
-logger = logging.getLogger('securesystemslib.hash')
 
 DEFAULT_CHUNK_SIZE = 4096
 DEFAULT_HASH_ALGORITHM = 'sha256'

securesystemslib/interface.py

@@ -48,8 +48,7 @@
 
 import six
 
-# See 'log.py' to learn how logging is handled in securesystemslib.
-logger = logging.getLogger('securesystemslib_interface')
+logger = logging.getLogger(__name__)
 
 try:
   from colorama import Fore
@@ -73,7 +72,7 @@
 
 def _prompt(message, result_type=str):
   """
-    Non-public function that prompts the user for input by logging 'message',
+    Non-public function that prompts the user for input by printing 'message',
     converting the input to 'result_type', and returning the value to the
     caller.
   """

securesystemslib/keys.py

@@ -102,7 +102,7 @@
   'rsa-pkcs1v15-sha512',
 ]
 
-logger = logging.getLogger('securesystemslib_keys')
+logger = logging.getLogger(__name__)
 
 
 def generate_rsa_key(bits=_DEFAULT_RSA_KEY_BITS, scheme='rsassa-pss-sha256'):

securesystemslib/util.py

@@ -39,7 +39,7 @@
 
 import six
 
-logger = logging.getLogger('securesystemslib_util')
+logger = logging.getLogger(__name__)
 
 
 def get_file_details(filepath, hash_algorithms=['sha256']):

tests/check_public_interfaces.py

@@ -34,7 +34,6 @@
 
 import inspect
 import json
-import logging
 import os
 import shutil
 import sys
@@ -50,9 +49,6 @@
 import securesystemslib.keys
 
 
-logger = logging.getLogger('securesystemslib_check_public_interfaces')
-
-
 
 class TestPublicInterfaces(unittest.TestCase):
 

tests/test_ecdsa_keys.py

@@ -27,14 +27,12 @@
 
 import unittest
 import os
-import logging
 
 import securesystemslib.exceptions
 import securesystemslib.formats
 import securesystemslib.ecdsa_keys
 import securesystemslib.rsa_keys
 
-logger = logging.getLogger('securesystemslib_test_ecdsa_keys')
 
 public, private = securesystemslib.ecdsa_keys.generate_public_and_private()
 FORMAT_ERROR_MSG = 'securesystemslib.exceptions.FormatError raised.  Check object\'s format.'

tests/test_ed25519_keys.py

@@ -27,13 +27,11 @@
 
 import unittest
 import os
-import logging
 
 import securesystemslib.exceptions
 import securesystemslib.formats
 import securesystemslib.ed25519_keys
 
-logger = logging.getLogger('securesystemslib.test_ed25519_keys')
 
 public, private = securesystemslib.ed25519_keys.generate_public_and_private()
 FORMAT_ERROR_MSG = 'securesystemslib.exceptions.FormatError raised.  Check object\'s format.'

tests/test_exceptions.py

@@ -30,7 +30,7 @@
 
 import securesystemslib.exceptions
 
-logger = logging.getLogger('test_exceptions')
+logger = logging.getLogger(__name__)
 
 class TestExceptions(unittest.TestCase):
   def setUp(self):

tests/test_hash.py

@@ -36,11 +36,11 @@
 
 import six
 
-logger = logging.getLogger('securesystemslib.test_hash')
+logger = logging.getLogger(__name__)
 
 
 if not 'hashlib' in securesystemslib.hash.SUPPORTED_LIBRARIES:
-  logger.warn('Not testing hashlib: could not be imported.')
+  logger.warning('Not testing hashlib: could not be imported.')
 
 
 class TestHash(unittest.TestCase):

tests/test_interface.py

@@ -28,7 +28,6 @@
 import os
 import time
 import datetime
-import logging
 import tempfile
 import json
 import shutil
@@ -49,8 +48,6 @@
 
 import six
 
-logger = logging.getLogger('securesystemslib_test_interface')
-
 
 
 class TestInterfaceFunctions(unittest.TestCase):

tests/test_keys.py

@@ -26,16 +26,12 @@
 from __future__ import unicode_literals
 
 import unittest
-import logging
-
 
 import securesystemslib.exceptions
 import securesystemslib.formats
 import securesystemslib.keys
 import securesystemslib.ecdsa_keys
 
-logger = logging.getLogger('securesystemslib_test_keys')
-
 KEYS = securesystemslib.keys
 FORMAT_ERROR_MSG = 'securesystemslib.exceptions.FormatError was raised!' + \
   '  Check object\'s format.'

tests/test_rsa_keys.py

@@ -26,15 +26,13 @@
 from __future__ import unicode_literals
 
 import unittest
-import logging
 
 import securesystemslib.exceptions
 import securesystemslib.formats
 import securesystemslib.keys
 import securesystemslib.rsa_keys
 
 from cryptography.hazmat.primitives import hashes
-logger = logging.getLogger('securesystemslib.test_rsa_keys')
 
 public_rsa, private_rsa = securesystemslib.rsa_keys.generate_rsa_public_and_private()
 FORMAT_ERROR_MSG = 'securesystemslib.exceptions.FormatError raised.  Check object\'s format.'

tests/test_schema.py

@@ -27,12 +27,10 @@
 
 import unittest
 import re
-import logging
 
 import securesystemslib.exceptions
 import securesystemslib.schema as SCHEMA
 
-logger = logging.getLogger('securesystemslib.test_schema')
 
 
 class TestSchema(unittest.TestCase):

tests/test_util.py

@@ -41,7 +41,7 @@
 
 import six
 
-logger = logging.getLogger('securesystemslib_test_util')
+logger = logging.getLogger(__name__)
 
 
 class TestUtil(unittest_toolbox.Modified_TestCase):