saltstack/salt

View on GitHub
salt/states/win_smtp_server.py

Summary

Maintainability
D
1 day
Test Coverage

File win_smtp_server.py has 254 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
'''
Module for managing IIS SMTP server configuration on Windows servers.

'''
Severity: Minor
Found in salt/states/win_smtp_server.py - About 2 hrs to fix

    Function server_setting has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
    Open

    def server_setting(name, settings=None, server=_DEFAULT_SERVER):
        '''
        Ensure the value is set for the specified setting.
    
        .. note::
    Severity: Minor
    Found in salt/states/win_smtp_server.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 relay_ip_list has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

    def relay_ip_list(name, addresses=None, server=_DEFAULT_SERVER):
        '''
        Manage IP list for SMTP relay connections.
    
        Due to the unusual way that Windows stores the relay IPs, it is advisable to retrieve
    Severity: Minor
    Found in salt/states/win_smtp_server.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 6 locations. Consider refactoring.
    Open

        if ret_settings['failures']:
            ret['comment'] = 'Some settings failed to change.'
            ret['changes'] = ret_settings
            ret['result'] = False
        else:
    Severity: Major
    Found in salt/states/win_smtp_server.py and 5 other locations - About 4 hrs to fix
    salt/states/win_iis.py on lines 564..571
    salt/states/win_iis.py on lines 862..869
    salt/states/win_iis.py on lines 997..1004
    salt/states/win_snmp.py on lines 84..91
    salt/states/win_snmp.py on lines 207..214

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

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

        if not ret_settings['changes']:
            ret['comment'] = 'Settings already contain the provided values.'
            ret['result'] = True
            return ret
        elif __opts__['test']:
    Severity: Major
    Found in salt/states/win_smtp_server.py and 5 other locations - About 3 hrs to fix
    salt/states/win_iis.py on lines 544..551
    salt/states/win_iis.py on lines 843..850
    salt/states/win_iis.py on lines 973..980
    salt/states/win_snmp.py on lines 66..73
    salt/states/win_snmp.py on lines 177..184

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

    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 six.text_type(settings[key]) != six.text_type(current_settings[key]):
                ret_settings['changes'][key] = {'old': current_settings[key],
                                                'new': settings[key]}
    Severity: Major
    Found in salt/states/win_smtp_server.py and 1 other location - About 2 hrs to fix
    salt/states/win_snmp.py on lines 62..65

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

    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