saltstack/salt

View on GitHub
salt/utils/win_network.py

Summary

Maintainability
F
4 days
Test Coverage

Function get_interface_info_wmi has a Cognitive Complexity of 71 (exceeds 5 allowed). Consider refactoring.
Open

def get_interface_info_wmi():
    '''
    Uses WMI to gather Network Interface information. Should only run on
    Windows 7/2008 R2 and lower systems. This code was pulled from the
    ``win_interfaces`` function in ``salt.utils.network`` unchanged.
Severity: Minor
Found in salt/utils/win_network.py - About 1 day 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

File win_network.py has 285 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
'''
This salt util uses WMI to gather network information on Windows 7 and .NET 4.0+
on newer systems.

Severity: Minor
Found in salt/utils/win_network.py - About 2 hrs to fix

    Cyclomatic complexity is too high in function get_interface_info_wmi. (26)
    Open

    def get_interface_info_wmi():
        '''
        Uses WMI to gather Network Interface information. Should only run on
        Windows 7/2008 R2 and lower systems. This code was pulled from the
        ``win_interfaces`` function in ``salt.utils.network`` unchanged.
    Severity: Minor
    Found in salt/utils/win_network.py by radon

    Cyclomatic Complexity

    Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

    Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

    Construct Effect on CC Reasoning
    if +1 An if statement is a single decision.
    elif +1 The elif statement adds another decision.
    else +0 The else statement does not cause a new decision. The decision is at the if.
    for +1 There is a decision at the start of the loop.
    while +1 There is a decision at the while statement.
    except +1 Each except branch adds a new conditional path of execution.
    finally +0 The finally block is unconditionally executed.
    with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
    assert +1 The assert statement internally roughly equals a conditional statement.
    Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
    Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

    Source: http://radon.readthedocs.org/en/latest/intro.html

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

    def get_interface_info():
        '''
        This function will return network interface information for the system and
        will use the best method to retrieve that information. Windows 7/2008R2 and
        below will use WMI. Newer systems will use .NET.
    Severity: Minor
    Found in salt/utils/win_network.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

    Avoid deeply nested control flow statements.
    Open

                        if '.' in ip:
                            if 'inet' not in ifaces[iface.Description]:
                                ifaces[iface.Description]['inet'] = []
                            item = {'address': ip,
                                    'label': iface.Description}
    Severity: Major
    Found in salt/utils/win_network.py - About 45 mins to fix

      Avoid deeply nested control flow statements.
      Open

                          if ':' in ip:
                              if 'inet6' not in ifaces[iface.Description]:
                                  ifaces[iface.Description]['inet6'] = []
                              item = {'address': ip}
                              if iface.DefaultIPGateway:
      Severity: Major
      Found in salt/utils/win_network.py - About 45 mins to fix

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

        def _get_ip_unicast_info(i_face):
            ip_properties = i_face.GetIPProperties()
            int_dict = {}
            if ip_properties.UnicastAddresses.Count > 0:
                names = {af_inet: 'ip_addresses',
        Severity: Minor
        Found in salt/utils/win_network.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

        def _get_ip_gateway_info(i_face):
            ip_properties = i_face.GetIPProperties()
            int_dict = {}
            if ip_properties.GatewayAddresses.Count > 0:
                names = {af_inet: 'ip_gateways',
        Severity: Major
        Found in salt/utils/win_network.py and 1 other location - About 5 hrs to fix
        salt/utils/win_network.py on lines 194..204

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

        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

        def _get_ip_multicast_info(i_face):
            ip_properties = i_face.GetIPProperties()
            int_dict = {}
            if ip_properties.MulticastAddresses.Count > 0:
                names = {af_inet: 'ip_multicast',
        Severity: Major
        Found in salt/utils/win_network.py and 1 other location - About 5 hrs to fix
        salt/utils/win_network.py on lines 168..178

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

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

                                if iface.DefaultIPGateway:
                                    broadcast = next((i for i in iface.DefaultIPGateway if ':' in i), '')
                                    if broadcast:
                                        item['broadcast'] = broadcast
        Severity: Major
        Found in salt/utils/win_network.py and 3 other locations - About 1 hr to fix
        salt/utils/win_network.py on lines 282..285
        salt/utils/win_network.py on lines 286..289
        salt/utils/win_network.py on lines 299..302

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

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

                                if iface.IPSubnet:
                                    netmask = next((i for i in iface.IPSubnet if '.' in i), '')
                                    if netmask:
                                        item['netmask'] = netmask
        Severity: Major
        Found in salt/utils/win_network.py and 3 other locations - About 1 hr to fix
        salt/utils/win_network.py on lines 282..285
        salt/utils/win_network.py on lines 295..298
        salt/utils/win_network.py on lines 299..302

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

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

                                if iface.IPSubnet:
                                    netmask = next((i for i in iface.IPSubnet if ':' in i), '')
                                    if netmask:
                                        item['netmask'] = netmask
        Severity: Major
        Found in salt/utils/win_network.py and 3 other locations - About 1 hr to fix
        salt/utils/win_network.py on lines 282..285
        salt/utils/win_network.py on lines 286..289
        salt/utils/win_network.py on lines 295..298

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

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

                                if iface.DefaultIPGateway:
                                    broadcast = next((i for i in iface.DefaultIPGateway if '.' in i), '')
                                    if broadcast:
                                        item['broadcast'] = broadcast
        Severity: Major
        Found in salt/utils/win_network.py and 3 other locations - About 1 hr to fix
        salt/utils/win_network.py on lines 286..289
        salt/utils/win_network.py on lines 295..298
        salt/utils/win_network.py on lines 299..302

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

        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