saltstack/salt

View on GitHub
salt/modules/runit.py

Summary

Maintainability
D
2 days
Test Coverage

File runit.py has 476 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
'''
runit service module
(http://smarden.org/runit)

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

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

    def enable(name, start=False, **kwargs):
        '''
        Start service ``name`` at boot.
        Returns ``True`` if operation is successful
    
    
    Severity: Minor
    Found in salt/modules/runit.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 _get_svc_path has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
    Open

    def _get_svc_path(name='*', status=None):
        '''
        Return a list of paths to services with ``name`` that have the specified ``status``
    
        name
    Severity: Minor
    Found in salt/modules/runit.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 get_svc_alias has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
    Open

    def get_svc_alias():
        '''
        Returns the list of service's name that are aliased and their alias path(s)
        '''
    
    
    Severity: Minor
    Found in salt/modules/runit.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 True
    Severity: Major
    Found in salt/modules/runit.py - About 30 mins to fix

      Avoid too many return statements within this function.
      Open

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

        Avoid too many return statements within this function.
        Open

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

          Avoid too many return statements within this function.
          Open

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

            Avoid too many return statements within this function.
            Open

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

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

                      if not os.path.exists(down_file):
                          try:
                              salt.utils.files.fopen(down_file, "w").close()  # pylint: disable=resource-leakage
                          except IOError:
                              log.error('Unable to create file %s', down_file)
              Severity: Major
              Found in salt/modules/runit.py and 1 other location - About 2 hrs to fix
              salt/modules/runit.py on lines 680..685

              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

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

                  if not os.path.exists(down_file):
                      try:
                          salt.utils.files.fopen(down_file, "w").close()  # pylint: disable=resource-leakage
                      except IOError:
                          log.error('Unable to create file %s', down_file)
              Severity: Major
              Found in salt/modules/runit.py and 1 other location - About 2 hrs to fix
              salt/modules/runit.py on lines 605..610

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

              def restart(name):
                  '''
                  Restart service
              
                  name
              Severity: Major
              Found in salt/modules/runit.py and 8 other locations - About 35 mins to fix
              salt/modules/runit.py on lines 117..131
              salt/modules/runit.py on lines 135..149
              salt/modules/runit.py on lines 153..167
              salt/modules/s6.py on lines 52..63
              salt/modules/s6.py on lines 66..77
              salt/modules/s6.py on lines 80..91
              salt/modules/s6.py on lines 94..105
              salt/modules/s6.py on lines 108..119

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

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

              def start(name):
                  '''
                  Start service
              
                  name
              Severity: Major
              Found in salt/modules/runit.py and 8 other locations - About 35 mins to fix
              salt/modules/runit.py on lines 135..149
              salt/modules/runit.py on lines 153..167
              salt/modules/runit.py on lines 171..185
              salt/modules/s6.py on lines 52..63
              salt/modules/s6.py on lines 66..77
              salt/modules/s6.py on lines 80..91
              salt/modules/s6.py on lines 94..105
              salt/modules/s6.py on lines 108..119

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

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

              def reload_(name):
                  '''
                  Reload service
              
                  name
              Severity: Major
              Found in salt/modules/runit.py and 8 other locations - About 35 mins to fix
              salt/modules/runit.py on lines 117..131
              salt/modules/runit.py on lines 135..149
              salt/modules/runit.py on lines 171..185
              salt/modules/s6.py on lines 52..63
              salt/modules/s6.py on lines 66..77
              salt/modules/s6.py on lines 80..91
              salt/modules/s6.py on lines 94..105
              salt/modules/s6.py on lines 108..119

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

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

              def stop(name):
                  '''
                  Stop service
              
                  name
              Severity: Major
              Found in salt/modules/runit.py and 8 other locations - About 35 mins to fix
              salt/modules/runit.py on lines 117..131
              salt/modules/runit.py on lines 153..167
              salt/modules/runit.py on lines 171..185
              salt/modules/s6.py on lines 52..63
              salt/modules/s6.py on lines 66..77
              salt/modules/s6.py on lines 80..91
              salt/modules/s6.py on lines 94..105
              salt/modules/s6.py on lines 108..119

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

              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