saltstack/salt

View on GitHub
salt/beacons/inotify.py

Summary

Maintainability
F
5 days
Test Coverage

Function beacon has a Cognitive Complexity of 114 (exceeds 5 allowed). Consider refactoring.
Open

def beacon(config):
    '''
    Watch the configured files

    Example Config
Severity: Minor
Found in salt/beacons/inotify.py - About 2 days 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 validate has a Cognitive Complexity of 67 (exceeds 5 allowed). Consider refactoring.
Open

def validate(config):
    '''
    Validate the beacon configuration
    '''

Severity: Minor
Found in salt/beacons/inotify.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 beacon. (32)
Open

def beacon(config):
    '''
    Watch the configured files

    Example Config
Severity: Minor
Found in salt/beacons/inotify.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

File inotify.py has 270 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
'''
Watch files and translate the changes into salt events

:depends:   - pyinotify Python module >= 0.9.5
Severity: Minor
Found in salt/beacons/inotify.py - About 2 hrs to fix

    Avoid deeply nested control flow statements.
    Open

                        if 'mask' in _config['files'][path]:
                            if not isinstance(_config['files'][path]['mask'], list):
                                return False, ('Configuration for inotify beacon '
                                               'mask must be list.')
                            for mask in _config['files'][path]['mask']:
    Severity: Major
    Found in salt/beacons/inotify.py - About 45 mins to fix

      Avoid deeply nested control flow statements.
      Open

                          if 'recurse' in _config['files'][path]:
                              if not isinstance(_config['files'][path]['recurse'], bool):
                                  return False, ('Configuration for inotify beacon '
                                                 'recurse must be boolean.')
      
      
      Severity: Major
      Found in salt/beacons/inotify.py - About 45 mins to fix

        Avoid deeply nested control flow statements.
        Open

                            if isinstance(exclude, dict):
                                excl.append(list(exclude)[0])
                            else:
                                excl.append(exclude)
                        excl = pyinotify.ExcludeFilter(excl)
        Severity: Major
        Found in salt/beacons/inotify.py - About 45 mins to fix

          Avoid deeply nested control flow statements.
          Open

                              if not any(j in ['mask',
                                               'recurse',
                                               'auto_add'] for j in _config['files'][path]):
                                  return False, ('Configuration for inotify beacon must '
                                                 'contain mask, recurse or auto_add items.')
          Severity: Major
          Found in salt/beacons/inotify.py - About 45 mins to fix

            Avoid deeply nested control flow statements.
            Open

                                if isinstance(exclude, dict):
                                    _exclude = next(iter(exclude))
                                    if exclude[_exclude].get('regex', False):
                                        try:
                                            if re.search(_exclude, event.pathname):
            Severity: Major
            Found in salt/beacons/inotify.py - About 45 mins to fix

              Avoid deeply nested control flow statements.
              Open

                                  if wm.watches[wd].auto_add != auto_add:
                                      update = True
                                  if update:
              Severity: Major
              Found in salt/beacons/inotify.py - About 45 mins to fix

                Avoid deeply nested control flow statements.
                Open

                                    if wm.watches[wd].mask != mask:
                                        update = True
                                    if wm.watches[wd].auto_add != auto_add:
                Severity: Major
                Found in salt/beacons/inotify.py - About 45 mins to fix

                  Avoid deeply nested control flow statements.
                  Open

                                      if 'auto_add' in _config['files'][path]:
                                          if not isinstance(_config['files'][path]['auto_add'], bool):
                                              return False, ('Configuration for inotify beacon '
                                                             'auto_add must be boolean.')
                  
                  
                  Severity: Major
                  Found in salt/beacons/inotify.py - About 45 mins to fix

                    Avoid deeply nested control flow statements.
                    Open

                                        if update:
                                            wm.update_watch(wd, mask=mask, rec=rec, auto_add=auto_add)
                            elif os.path.exists(path):
                    Severity: Major
                    Found in salt/beacons/inotify.py - About 45 mins to fix

                      Avoid too many return statements within this function.
                      Open

                          return True, 'Valid beacon configuration'
                      Severity: Major
                      Found in salt/beacons/inotify.py - About 30 mins to fix

                        Avoid too many return statements within this function.
                        Open

                                                    return False, ('Configuration for inotify beacon '
                        Severity: Major
                        Found in salt/beacons/inotify.py - About 30 mins to fix

                          Avoid too many return statements within this function.
                          Open

                                                      return False, ('Configuration for inotify beacon '
                          Severity: Major
                          Found in salt/beacons/inotify.py - About 30 mins to fix

                            Avoid too many return statements within this function.
                            Open

                                                            return False, ('Configuration for inotify beacon '
                            Severity: Major
                            Found in salt/beacons/inotify.py - About 30 mins to fix

                              Avoid too many return statements within this function.
                              Open

                                                      return False, ('Configuration for inotify beacon must '
                              Severity: Major
                              Found in salt/beacons/inotify.py - About 30 mins to fix

                                Avoid too many return statements within this function.
                                Open

                                                            return False, ('Configuration for inotify beacon '
                                Severity: Major
                                Found in salt/beacons/inotify.py - About 30 mins to fix

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

                                                      if 'auto_add' in _config['files'][path]:
                                                          if not isinstance(_config['files'][path]['auto_add'], bool):
                                                              return False, ('Configuration for inotify beacon '
                                  Severity: Major
                                  Found in salt/beacons/inotify.py and 1 other location - About 2 hrs to fix
                                  salt/beacons/inotify.py on lines 141..143

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

                                  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 'recurse' in _config['files'][path]:
                                                          if not isinstance(_config['files'][path]['recurse'], bool):
                                                              return False, ('Configuration for inotify beacon '
                                  Severity: Major
                                  Found in salt/beacons/inotify.py and 1 other location - About 2 hrs to fix
                                  salt/beacons/inotify.py on lines 136..138

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

                                  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