saltstack/salt

View on GitHub
salt/modules/ipset.py

Summary

Maintainability
F
3 days
Test Coverage

File ipset.py has 467 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
'''
Support for ipset
'''

Severity: Minor
Found in salt/modules/ipset.py - About 7 hrs to fix

    Function add has a Cognitive Complexity of 23 (exceeds 5 allowed). Consider refactoring.
    Open

    def add(setname=None, entry=None, family='ipv4', **kwargs):
        '''
        Append an entry to the specified set.
    
        CLI Example:
    Severity: Minor
    Found in salt/modules/ipset.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 new_set has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
    Open

    def new_set(set=None, set_type=None, family='ipv4', comment=False, **kwargs):
        '''
        .. versionadded:: 2014.7.0
    
        Create new custom set
    Severity: Minor
    Found in salt/modules/ipset.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 _compare_member_parts has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
    Open

    def _compare_member_parts(member_part, entry_part):
        if member_part == entry_part:
            # this covers int, string, and equal ip and net
            return True
    
    
    Severity: Minor
    Found in salt/modules/ipset.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 _parse_member has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
    Open

    def _parse_member(settype, member, strict=False):
        subtypes = settype.split(':')[1].split(',')
    
        all_parts = member.split(' ', 1)
        parts = all_parts[0].split(',')
    Severity: Minor
    Found in salt/modules/ipset.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 check has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
    Open

    def check(set=None, entry=None, family='ipv4'):
        '''
        Check that an entry exists in the specified set.
    
        set
    Severity: Minor
    Found in salt/modules/ipset.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 too many return statements within this function.
    Open

                return 'Error: Set {0} not created with counters support'.format(setname)
    Severity: Major
    Found in salt/modules/ipset.py - About 30 mins to fix

      Avoid too many return statements within this function.
      Open

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

        Avoid too many return statements within this function.
        Open

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

          Avoid too many return statements within this function.
          Open

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

            Avoid too many return statements within this function.
            Open

                    return 'Warn: Entry {0} already exists in set {1}'.format(cmd, setname)
            Severity: Major
            Found in salt/modules/ipset.py - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                  return 'Error: {0}'.format(out)
              Severity: Major
              Found in salt/modules/ipset.py - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                            return 'Error: Set {0} not created with skbinfo support'.format(setname)
                Severity: Major
                Found in salt/modules/ipset.py - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

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

                    Avoid too many return statements within this function.
                    Open

                            return 'Success'
                    Severity: Major
                    Found in salt/modules/ipset.py - About 30 mins to fix

                      Avoid too many return statements within this function.
                      Open

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

                        Avoid too many return statements within this function.
                        Open

                                    return entry_part in member_part
                        Severity: Major
                        Found in salt/modules/ipset.py - About 30 mins to fix

                          Avoid too many return statements within this function.
                          Open

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

                            Avoid too many return statements within this function.
                            Open

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

                              Avoid too many return statements within this function.
                              Open

                                          return 'Error: Set {0} not created with comment support'.format(setname)
                              Severity: Major
                              Found in salt/modules/ipset.py - About 30 mins to fix

                                Avoid too many return statements within this function.
                                Open

                                    return 'Error: {0}'.format(out)
                                Severity: Major
                                Found in salt/modules/ipset.py - About 30 mins to fix

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

                                  def _find_set_members(set):
                                      '''
                                      Return list of members for a set
                                      '''
                                  
                                  
                                  Severity: Minor
                                  Found in salt/modules/ipset.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

                                  def version():
                                      '''
                                      Return version from ipset --version
                                  
                                      CLI Example:
                                  Severity: Major
                                  Found in salt/modules/ipset.py and 1 other location - About 1 hr to fix
                                  salt/modules/nftables.py on lines 70..83

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

                                  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