saltstack/salt

View on GitHub
salt/modules/openvswitch.py

Summary

Maintainability
F
3 days
Test Coverage

File openvswitch.py has 484 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
'''
Support for Open vSwitch - module with basic Open vSwitch commands.

Suitable for setting up Openstack Neutron.
Severity: Minor
Found in salt/modules/openvswitch.py - About 7 hrs to fix

    Function _convert_json has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
    Open

    def _convert_json(obj):
        '''
        Converts from the JSON output provided by ovs-vsctl into a usable Python
        object tree. In particular, sets and maps are converted from lists to
        actual sets or maps.
    Severity: Minor
    Found in salt/modules/openvswitch.py - About 3 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 port_create_vlan has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

    def port_create_vlan(br, port, id, internal=False):
        '''
        Isolate VM traffic using VLANs.
    
        Args:
    Severity: Minor
    Found in salt/modules/openvswitch.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

    Avoid too many return statements within this function.
    Open

            return _retcode_to_bool(result['retcode'])
    Severity: Major
    Found in salt/modules/openvswitch.py - About 30 mins to fix

      Avoid too many return statements within this function.
      Open

              return _retcode_to_bool(result['retcode'])
      Severity: Major
      Found in salt/modules/openvswitch.py - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

                    return obj
        Severity: Major
        Found in salt/modules/openvswitch.py - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                  return [_convert_json(elem) for elem in obj]
          Severity: Major
          Found in salt/modules/openvswitch.py - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                    return _retcode_to_bool(result['retcode'])
            Severity: Major
            Found in salt/modules/openvswitch.py - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                      return obj
              Severity: Major
              Found in salt/modules/openvswitch.py - About 30 mins to fix

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

                def port_create_vxlan(br, port, id, remote, dst_port=None):
                    '''
                    Virtual eXtensible Local Area Network - creates VXLAN tunnel between endpoints.
                
                    Args:
                Severity: Minor
                Found in salt/modules/openvswitch.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 4 locations. Consider refactoring.
                Open

                def interface_get_options(port):
                    '''
                    Port's interface's optional parameters.
                
                    Args:
                Severity: Major
                Found in salt/modules/openvswitch.py and 3 other locations - About 2 hrs to fix
                salt/modules/openvswitch.py on lines 360..381
                salt/modules/openvswitch.py on lines 384..405
                salt/modules/openvswitch.py on lines 432..453

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

                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

                def port_get_tag(port):
                    '''
                    Lists tags of the port.
                
                    Args:
                Severity: Major
                Found in salt/modules/openvswitch.py and 3 other locations - About 2 hrs to fix
                salt/modules/openvswitch.py on lines 360..381
                salt/modules/openvswitch.py on lines 408..429
                salt/modules/openvswitch.py on lines 432..453

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

                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

                def port_list(br):
                    '''
                    Lists all of the ports within bridge.
                
                    Args:
                Severity: Major
                Found in salt/modules/openvswitch.py and 3 other locations - About 2 hrs to fix
                salt/modules/openvswitch.py on lines 384..405
                salt/modules/openvswitch.py on lines 408..429
                salt/modules/openvswitch.py on lines 432..453

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

                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

                def interface_get_type(port):
                    '''
                    Type of port's interface.
                
                    Args:
                Severity: Major
                Found in salt/modules/openvswitch.py and 3 other locations - About 2 hrs to fix
                salt/modules/openvswitch.py on lines 360..381
                salt/modules/openvswitch.py on lines 384..405
                salt/modules/openvswitch.py on lines 408..429

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

                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