saltstack/salt

View on GitHub
salt/modules/glusterfs.py

Summary

Maintainability
F
4 days
Test Coverage

File glusterfs.py has 578 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
'''
Manage a glusterfs pool
'''
from __future__ import absolute_import, unicode_literals, print_function
Severity: Major
Found in salt/modules/glusterfs.py - About 1 day to fix

    Function peer_status has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
    Open

    def peer_status():
        '''
        Return peer status information
    
        The return value is a dictionary with peer UUIDs as keys and dicts of peer
    Severity: Minor
    Found in salt/modules/glusterfs.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 get_max_op_version has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
    Open

    def get_max_op_version():
        '''
        .. versionadded:: 2019.2.0
    
        Returns the glusterfs volume's max op-version value
    Severity: Minor
    Found in salt/modules/glusterfs.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 info has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
    Open

    def info(name=None):
        '''
        .. versionadded:: 2015.8.4
    
        Return gluster volume info.
    Severity: Minor
    Found in salt/modules/glusterfs.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 create_volume has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
    Open

    def create_volume(name, bricks, stripe=False, replica=False, device_vg=False,
                      transport='tcp', start=False, force=False, arbiter=False):
        '''
        Create a glusterfs volume
    
    
    Severity: Minor
    Found in salt/modules/glusterfs.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 get_op_version has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
    Open

    def get_op_version(name):
        '''
        .. versionadded:: 2019.2.0
    
        Returns the glusterfs volume op-version
    Severity: Minor
    Found in salt/modules/glusterfs.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 status has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

    def status(name):
        '''
        Check the status of a gluster volume.
    
        name
    Severity: Minor
    Found in salt/modules/glusterfs.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

    Function add_volume_bricks has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

    def add_volume_bricks(name, bricks):
        '''
        Add brick(s) to an existing volume
    
        name
    Severity: Minor
    Found in salt/modules/glusterfs.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

    Function _gluster_xml has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

    def _gluster_xml(cmd):
        '''
        Perform a gluster --xml command and log result.
        '''
        # We will pass the command string as stdin to allow for much longer
    Severity: Minor
    Found in salt/modules/glusterfs.py - About 45 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 deeply nested control flow statements.
    Open

                        if child.tag == 'Value':
                            result = child.text
    
    
    Severity: Major
    Found in salt/modules/glusterfs.py - About 45 mins to fix

      Avoid deeply nested control flow statements.
      Open

                          if child.tag == 'Value':
                              result = child.text
      
      
      Severity: Major
      Found in salt/modules/glusterfs.py - About 45 mins to fix

        Avoid deeply nested control flow statements.
        Open

                            if hostname.text not in result[uuid]['hostnames']:
                                result[uuid]['hostnames'].append(hostname.text)
                    elif item.tag != 'uuid':
        Severity: Major
        Found in salt/modules/glusterfs.py - About 45 mins to fix

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

          def set_quota_volume(name, path, size, enable_quota=False):
              '''
              Set quota to glusterfs volume.
          
              name
          Severity: Minor
          Found in salt/modules/glusterfs.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

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

          def delete_volume(target, stop=True):
              '''
              Deletes a gluster volume
          
              target
          Severity: Minor
          Found in salt/modules/glusterfs.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

              for op_version in _iter(root, 'volGetopts'):
                  for item in op_version:
                      if item.tag == 'Value':
                          result = item.text
                      elif item.tag == 'Opt':
          Severity: Major
          Found in salt/modules/glusterfs.py and 1 other location - About 3 hrs to fix
          salt/modules/glusterfs.py on lines 778..785

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

          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

              for max_op_version in _iter(root, 'volGetopts'):
                  for item in max_op_version:
                      if item.tag == 'Value':
                          result = item.text
                      elif item.tag == 'Opt':
          Severity: Major
          Found in salt/modules/glusterfs.py and 1 other location - About 3 hrs to fix
          salt/modules/glusterfs.py on lines 744..751

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

          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