Sign upLogin

saltstack/salt

View on GitHub
Star
salt/runners/net.py

Summary

Maintainability
F
1 wk
Test Coverage

Function interfaces has a Cognitive Complexity of 99 (exceeds 5 allowed). Consider refactoring.
Open

def interfaces(device=None,
               interface=None,
               title=None,
               pattern=None,
               ipnet=None,
Severity: Minor
Found in salt/runners/net.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 net.py has 758 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
'''
NET Finder
==========
Severity: Major
Found in salt/runners/net.py - About 1 day to fix

    Function lldp has a Cognitive Complexity of 52 (exceeds 5 allowed). Consider refactoring.
    Open

    def lldp(device=None,
         interface=None,
         title=None,
         pattern=None,
         chassis=None,
    Severity: Minor
    Found in salt/runners/net.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

    Cyclomatic complexity is too high in function interfaces. (42)
    Open

    def interfaces(device=None,
               interface=None,
               title=None,
               pattern=None,
               ipnet=None,
    Severity: Minor
    Found in salt/runners/net.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 find has a Cognitive Complexity of 31 (exceeds 5 allowed). Consider refactoring.
    Open

    def find(addr, best=True, display=_DEFAULT_DISPLAY):
    '''
    Search in all possible entities (Interfaces, MAC tables, ARP tables, LLDP neighbors),
    using the following mine functions:
    Severity: Minor
    Found in salt/runners/net.py - About 4 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

    Cyclomatic complexity is too high in function lldp. (27)
    Open

    def lldp(device=None,
         interface=None,
         title=None,
         pattern=None,
         chassis=None,
    Severity: Minor
    Found in salt/runners/net.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 findarp has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring.
    Open

    def findarp(device=None,
            interface=None,
            mac=None,
            ip=None,
            display=_DEFAULT_DISPLAY):  # pylint: disable=invalid-name
    Severity: Minor
    Found in salt/runners/net.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 findmac has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
    Open

    def findmac(device=None, mac=None, interface=None, vlan=None, display=_DEFAULT_DISPLAY):
    '''
    Search in the MAC Address tables, using the following mine functions:

    - net.mac
    Severity: Minor
    Found in salt/runners/net.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

    Cyclomatic complexity is too high in function find. (24)
    Open

    def find(addr, best=True, display=_DEFAULT_DISPLAY):
    '''
    Search in all possible entities (Interfaces, MAC tables, ARP tables, LLDP neighbors),
    using the following mine functions:
    Severity: Minor
    Found in salt/runners/net.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 _find_interfaces_ip has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
    Open

    def _find_interfaces_ip(mac):
    '''
    Helper to search the interfaces IPs using the MAC address.
    '''
    try:
    Severity: Minor
    Found in salt/runners/net.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 _find_interfaces_mac has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
    Open

    def _find_interfaces_mac(ip):  # pylint: disable=invalid-name
    '''
    Helper to get the interfaces hardware address using the IP Address.
    '''
    all_interfaces = _get_mine('net.interfaces')
    Severity: Minor
    Found in salt/runners/net.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 not((ptl in rsn.lower()) or (ptl in rsd.lower()) or
                           (ptl in rpd.lower()) or (ptl in rci.lower())):
                        # nothing matched, let's move on
                        continue
                if chassis:
    Severity: Major
    Found in salt/runners/net.py - About 45 mins to fix

      Avoid deeply nested control flow statements.
      Open

                          if display:
                        interf_entry['ips'] = '\n'.join(interf_entry['ips'])
                    if ipnet:
      Severity: Major
      Found in salt/runners/net.py - About 45 mins to fix

        Avoid deeply nested control flow statements.
        Open

                            if (napalm_helpers.convert(napalm_helpers.mac, rci) !=
                       napalm_helpers.convert(napalm_helpers.mac, chassis)):
                        continue
                rows.append({
        Severity: Major
        Found in salt/runners/net.py - About 45 mins to fix

          Avoid deeply nested control flow statements.
          Open

                              if ipnet:
                        inet_ips = [
                            six.text_type(ip) for ip in ips if _ipnet_belongs(ip)
                        ]  # filter and get only IP include ipnet
                        if inet_ips:  # if any
          Severity: Major
          Found in salt/runners/net.py - About 45 mins to fix

            Consider simplifying this complex logical expression.
            Open

                        if ((mac and arp_entry.get('mac', '').lower() == mac.lower()) or  # pylint: disable=too-many-boolean-expressions
                (interface and interface in arp_entry.get('interface', '')) or
                (ip and napalm_helpers.convert(napalm_helpers.ip, arp_entry.get('ip', '')) ==
                 napalm_helpers.convert(napalm_helpers.ip, ip))):
                rows.append({
            Severity: Major
            Found in salt/runners/net.py - About 40 mins to fix

              Consider simplifying this complex logical expression.
              Open

                          if ((mac and    # pylint: disable=too-many-boolean-expressions
                napalm_helpers.convert(napalm_helpers.mac, mac_entry.get('mac', '')) ==
                napalm_helpers.convert(napalm_helpers.mac, mac)) or
                (interface and interface in mac_entry.get('interface', '')) or
               (vlan and six.text_type(mac_entry.get('vlan', '')) == six.text_type(vlan))):
              Severity: Major
              Found in salt/runners/net.py - About 40 mins to fix

                Avoid too many return statements within this function.
                Open

                        return results
                Severity: Major
                Found in salt/runners/net.py - About 30 mins to fix

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

                          if device and interface:
            title = 'Interface {interface} on {device} has the physical address ({mac})'.format(
                interface=interface,
                device=device,
                mac=mac
                  Severity: Major
                  Found in salt/runners/net.py and 1 other location - About 1 hr to fix
                  salt/runners/net.py on lines 895..901

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

                  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 device and interface:
            title = 'IP Address {ip} is set for interface {interface}, on {device}'.format(
                interface=interface,
                device=device,
                ip=ip
                  Severity: Major
                  Found in salt/runners/net.py and 1 other location - About 1 hr to fix
                  salt/runners/net.py on lines 885..891

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

                  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