_gw_logging_cfg() - Code Metrics - Inspection of "Add testcases for CLI and logging (#21)" - useblocks/groundwork - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 691bd8...662939 )

by Marco

created 2018-03-12 12:01 UTC

_gw_logging_cfg() B

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
c	1
b	0
f	0
dl	0
loc	39
rs	8.8571

import os
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
import sys


def _gw_logging_cfg(log_file):
    return {
        'version': 1,
        'disable_existing_loggers': False,
        'formatters': {
            'standard': {
                'format': "%(asctime)s - %(levelname)-5s - %(message)s"
            },
            'debug': {
                'format': "%(asctime)s - %(levelname)-5s - %(name)-40s - %(message)-80s - %(module)s:%("

                          "funcName)s(%(lineno)s)"
            },
        },
        'handlers': {
            'console_stdout': {
                'formatter': 'standard',
                'class': 'logging.StreamHandler',
                'stream': sys.stdout,
                'level': 'INFO'
            },
            'file': {
                "class": "logging.handlers.RotatingFileHandler",
                "formatter": "debug",
                "filename": log_file,
                "maxBytes": 1024000,
                "backupCount": 3,
                'level': 'INFO'
            },
        },
        'loggers': {
            '': {
                'handlers': ['console_stdout'],
                'level': 'INFO',
                'propagate': False
            },
            'groundwork': {
                'handlers': ['console_stdout', 'file'],
                'level': 'INFO',
                'propagate': False
            },
        }
    }


def test_logging_file(basicApp, tmpdir):

    """
    The test case sets up a Groundwork application with logging to file with log level ``INFO``.
    The application is then called to log a debug and an info message.

    The generated logfile is then parsed and asserted, that only the info message can be found,
    the debug message cannot.
    """
    log_file = os.path.join(str(tmpdir), "test.log")
    app = basicApp
    # set up logging in the config, with log level INFO
    app.config.set('GROUNDWORK_LOGGING', _gw_logging_cfg(log_file))
    app._configure_logging(app.config.get("GROUNDWORK_LOGGING"))
class MyParent:
    def __init__(self):
        self._x = 1;
        self.y = 2;

class MyChild(MyParent):
    def some_method(self):
        return self._x    # Ok, since accessed from a child class

class AnotherClass:
    def some_method(self, instance_of_my_child):
        return instance_of_my_child._x   # Would be flagged as AnotherClass is not
                                         # a child class of MyParent

    debug_message = "This is a test debug message."
    info_message = "This is a test info message."
    app.log.debug(debug_message)
    app.log.info(info_message)

    # verify the contents of the log file
    with open(log_file) as lf:

        log = lf.read()
    # at log level INFO, the DEBUG message should not be there
    assert log.find(debug_message) == -1
    # the INFO message should be there
    assert log.find(info_message) > 0


def test_logging_console(basicApp, tmpdir, capsys):

    """
    The test case sets up a Groundwork application with logging to stdout with log level ``INFO``.
    The application is then called to log a debug and an info message.

    The captured stdout is then parsed and asserted, that only the info message can be found,
    the debug message cannot.
    """
    log_file = os.path.join(str(tmpdir), "test.log")
    app = basicApp
    # set up logging in the config, with log level INFO
    app.config.set('GROUNDWORK_LOGGING', _gw_logging_cfg(log_file))
    app._configure_logging(app.config.get("GROUNDWORK_LOGGING"))
class MyParent:
    def __init__(self):
        self._x = 1;
        self.y = 2;

class MyChild(MyParent):
    def some_method(self):
        return self._x    # Ok, since accessed from a child class

class AnotherClass:
    def some_method(self, instance_of_my_child):
        return instance_of_my_child._x   # Would be flagged as AnotherClass is not
                                         # a child class of MyParent

    debug_message = "This is a test debug message."
    info_message = "This is a test info message."
    app.log.debug(debug_message)
    app.log.info(info_message)

    out, err = capsys.readouterr()

    # at log level INFO, the DEBUG message should not be there
    assert out.find(debug_message) == -1
    # the INFO message should be there
    assert out.find(info_message) > 0


1		import os
		0 ignored issues – show Coding Style introduced 2018-03-08 10:36 UTC by Report Bug Copy Issue Report This module should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
2		import sys
3
4
5		def _gw_logging_cfg(log_file):
6		return {
7		'version': 1,
8		'disable_existing_loggers': False,
9		'formatters': {
10		'standard': {
11		'format': "%(asctime)s - %(levelname)-5s - %(message)s"
12		},
13		'debug': {
14		'format': "%(asctime)s - %(levelname)-5s - %(name)-40s - %(message)-80s - %(module)s:%("
		0 ignored issues – show Coding Style introduced 2018-03-08 10:36 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (104/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
15		"funcName)s(%(lineno)s)"
16		},
17		},
18		'handlers': {
19		'console_stdout': {
20		'formatter': 'standard',
21		'class': 'logging.StreamHandler',
22		'stream': sys.stdout,
23		'level': 'INFO'
24		},
25		'file': {
26		"class": "logging.handlers.RotatingFileHandler",
27		"formatter": "debug",
28		"filename": log_file,
29		"maxBytes": 1024000,
30		"backupCount": 3,
31		'level': 'INFO'
32		},
33		},
34		'loggers': {
35		'': {
36		'handlers': ['console_stdout'],
37		'level': 'INFO',
38		'propagate': False
39		},
40		'groundwork': {
41		'handlers': ['console_stdout', 'file'],
42		'level': 'INFO',
43		'propagate': False
44		},
45		}
46		}
47
48
49	View Code Duplication	def test_logging_file(basicApp, tmpdir):
		0 ignored issues – show Coding Style Naming introduced 2018-03-08 10:36 UTC by Report Bug Copy Issue Report The name `basicApp` does not conform to the argument naming conventions (`(([a-z][a-z0-9_]{2,30})\|(_[a-z0-9_]*))$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history... Duplication introduced 2018-03-08 10:36 UTC by Report Bug Copy Issue Report This code seems to be duplicated in your project. Loading history...
50		"""
51		The test case sets up a Groundwork application with logging to file with log level ``INFO``.
52		The application is then called to log a debug and an info message.
53
54		The generated logfile is then parsed and asserted, that only the info message can be found,
55		the debug message cannot.
56		"""
57		log_file = os.path.join(str(tmpdir), "test.log")
58		app = basicApp
59		# set up logging in the config, with log level INFO
60		app.config.set('GROUNDWORK_LOGGING', _gw_logging_cfg(log_file))
61		app._configure_logging(app.config.get("GROUNDWORK_LOGGING"))
		0 ignored issues – show Coding Style Best Practice introduced 2018-03-08 10:36 UTC by Report Bug Copy Issue Report It seems like `_configure_logging` was declared protected and should not be accessed from this context. Prefixing a member variable `_` is usually regarded as the equivalent of declaring it with protected visibility that exists in other languages. Consequentially, such a member should only be accessed from the same class or a child class: class MyParent: def __init__(self): self._x = 1; self.y = 2; class MyChild(MyParent): def some_method(self): return self._x # Ok, since accessed from a child class class AnotherClass: def some_method(self, instance_of_my_child): return instance_of_my_child._x # Would be flagged as AnotherClass is not # a child class of MyParent Loading history...
62
63		debug_message = "This is a test debug message."
64		info_message = "This is a test info message."
65		app.log.debug(debug_message)
66		app.log.info(info_message)
67
68		# verify the contents of the log file
69		with open(log_file) as lf:
		0 ignored issues – show Coding Style Naming introduced 2018-03-08 10:36 UTC by Report Bug Copy Issue Report The name `lf` does not conform to the variable naming conventions (`(([a-z][a-z0-9_]{2,30})\|(_[a-z0-9_]*))$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
70		log = lf.read()
71		# at log level INFO, the DEBUG message should not be there
72		assert log.find(debug_message) == -1
73		# the INFO message should be there
74		assert log.find(info_message) > 0
75
76
77	View Code Duplication	def test_logging_console(basicApp, tmpdir, capsys):
		0 ignored issues – show Coding Style Naming introduced 2018-03-08 10:36 UTC by Report Bug Copy Issue Report The name `basicApp` does not conform to the argument naming conventions (`(([a-z][a-z0-9_]{2,30})\|(_[a-z0-9_]*))$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history... Duplication introduced 2018-03-08 10:36 UTC by Report Bug Copy Issue Report This code seems to be duplicated in your project. Loading history...
78		"""
79		The test case sets up a Groundwork application with logging to stdout with log level ``INFO``.
80		The application is then called to log a debug and an info message.
81
82		The captured stdout is then parsed and asserted, that only the info message can be found,
83		the debug message cannot.
84		"""
85		log_file = os.path.join(str(tmpdir), "test.log")
86		app = basicApp
87		# set up logging in the config, with log level INFO
88		app.config.set('GROUNDWORK_LOGGING', _gw_logging_cfg(log_file))
89		app._configure_logging(app.config.get("GROUNDWORK_LOGGING"))
		0 ignored issues – show Coding Style Best Practice introduced 2018-03-08 10:36 UTC by Report Bug Copy Issue Report It seems like `_configure_logging` was declared protected and should not be accessed from this context. Prefixing a member variable `_` is usually regarded as the equivalent of declaring it with protected visibility that exists in other languages. Consequentially, such a member should only be accessed from the same class or a child class: class MyParent: def __init__(self): self._x = 1; self.y = 2; class MyChild(MyParent): def some_method(self): return self._x # Ok, since accessed from a child class class AnotherClass: def some_method(self, instance_of_my_child): return instance_of_my_child._x # Would be flagged as AnotherClass is not # a child class of MyParent Loading history...
90
91		debug_message = "This is a test debug message."
92		info_message = "This is a test info message."
93		app.log.debug(debug_message)
94		app.log.info(info_message)
95
96		out, err = capsys.readouterr()
		0 ignored issues – show Unused Code introduced 2018-03-08 10:36 UTC by Report Bug Copy Issue Report The variable `err` seems to be unused. Loading history...
97		# at log level INFO, the DEBUG message should not be there
98		assert out.find(debug_message) == -1
99		# the INFO message should be there
100		assert out.find(info_message) > 0
101

useblocks / groundwork

Push — master ( 691bd8...662939 )

_gw_logging_cfg() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like