saltstack/salt

View on GitHub
salt/states/disk.py

Summary

Maintainability
C
1 day
Test Coverage

Function _check_min_max has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
Open

def _check_min_max(absolute, free, available, used, maximum, minimum, ret):
    unit = 'KB' if absolute else '%'
    if minimum is not None:
        if free:
            if available < minimum:
Severity: Minor
Found in salt/states/disk.py - About 2 hrs 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 status has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
Open

def status(name, maximum=None, minimum=None, absolute=False, free=False):
    '''
    Return the current disk usage stats for the named mount point

    name
Severity: Minor
Found in salt/states/disk.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 _validate_int has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

def _validate_int(name, value, limits=(), strip='%'):
    '''
    Validate the named integer within the supplied limits inclusive and
    strip supplied unit characters
    '''
Severity: Minor
Found in salt/states/disk.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

Avoid too many return statements within this function.
Open

    return ret
Severity: Major
Found in salt/states/disk.py - About 30 mins to fix

    Function _status_path has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

    def _status_path(directory, ret, minimum, maximum, absolute, free):
        if path.isdir(directory) is False:
            ret['result'] = False
            ret['comment'] += ('Directory {0} does not exist or is not a directory'.format(directory))
            return ret
    Severity: Minor
    Found in salt/states/disk.py - About 25 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 minimum is not None:
            if not absolute:
                minimum, comment = _validate_int('minimum', minimum, [0, 100])
            else:
                minimum, comment = _validate_int('minimum', minimum, strip='KB')
    Severity: Major
    Found in salt/states/disk.py and 1 other location - About 2 hrs to fix
    salt/states/disk.py on lines 185..190

    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 66.

    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 2 locations. Consider refactoring.
    Open

        if maximum is not None:
            if not absolute:
                maximum, comment = _validate_int('maximum', maximum, [0, 100])
            else:
                maximum, comment = _validate_int('maximum', maximum, strip='KB')
    Severity: Major
    Found in salt/states/disk.py and 1 other location - About 2 hrs to fix
    salt/states/disk.py on lines 191..196

    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 66.

    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