saltstack/salt

View on GitHub
salt/utils/win_pdh.py

Summary

Maintainability
D
2 days
Test Coverage

File win_pdh.py has 311 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
r'''
Salt Util for getting system information with the Performance Data Helper (pdh).
Counter information is gathered from current activity or log files.

Severity: Minor
Found in salt/utils/win_pdh.py - About 3 hrs to fix

    Function get_all_counters has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

    def get_all_counters(obj, instance_list=None):
        '''
        Get the values for all counters available to a Counter object
    
        Args:
    Severity: Minor
    Found in salt/utils/win_pdh.py - About 1 hr to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Function get_counters has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

    def get_counters(counter_list):
        '''
        Get the values for the passes list of counters
    
        Args:
    Severity: Minor
    Found in salt/utils/win_pdh.py - About 55 mins to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Function type_string has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

        def type_string(self):
            '''
            Returns the names of the flags that are set in the Type field
    
            It can be used to format the counter.
    Severity: Minor
    Found in salt/utils/win_pdh.py - About 35 mins to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Similar blocks of code found in 2 locations. Consider refactoring.
    Open

            if not self.info:
                ci = win32pdh.GetCounterInfo(self.handle, 0)
                self.info = {
                    'type': ci[0],
                    'version': ci[1],
    Severity: Major
    Found in salt/utils/win_pdh.py and 1 other location - About 1 day to fix
    salt/log/handlers/logstash_mod.py on lines 399..415

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 181.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Similar blocks of code found in 7 locations. Consider refactoring.
    Open

    def __virtual__():
        '''
        Only works on Windows systems with the PyWin32
        '''
        if not salt.utils.platform.is_windows():
    Severity: Major
    Found in salt/utils/win_pdh.py and 6 other locations - About 1 hr to fix
    salt/modules/win_lgpo.py on lines 4739..4747
    salt/modules/win_service.py on lines 93..103
    salt/modules/win_system.py on lines 50..60
    salt/modules/win_useradd.py on lines 65..75
    salt/utils/win_dacl.py on lines 157..167
    salt/utils/win_reg.py on lines 60..73

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 46.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    There are no issues that match your filters.

    Category
    Status