saltstack/salt

View on GitHub
salt/states/pcs.py

Summary

Maintainability
F
1 wk
Test Coverage

File pcs.py has 831 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
'''
Management of Pacemaker/Corosync clusters with PCS
==================================================

Severity: Major
Found in salt/states/pcs.py - About 1 day to fix

    Function _item_present has a Cognitive Complexity of 33 (exceeds 5 allowed). Consider refactoring.
    Open

    def _item_present(name, item, item_id, item_type, show='show', create='create', extra_args=None, cibname=None):
        '''
        Ensure that an item is created
    
        name
    Severity: Minor
    Found in salt/states/pcs.py - About 4 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 cluster_setup has a Cognitive Complexity of 32 (exceeds 5 allowed). Consider refactoring.
    Open

    def cluster_setup(name, nodes, pcsclustername='pcscluster', extra_args=None):
        '''
        Setup Pacemaker cluster on nodes.
        Should be run on one cluster node only
        (there may be races)
    Severity: Minor
    Found in salt/states/pcs.py - About 4 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 cluster_node_present has a Cognitive Complexity of 31 (exceeds 5 allowed). Consider refactoring.
    Open

    def cluster_node_present(name, node, extra_args=None):
        '''
        Add a node to the Pacemaker cluster via PCS
        Should be run on one cluster node only
        (there may be races)
    Severity: Minor
    Found in salt/states/pcs.py - About 4 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 auth has a Cognitive Complexity of 28 (exceeds 5 allowed). Consider refactoring.
    Open

    def auth(name, nodes, pcsuser='hacluster', pcspasswd='hacluster', extra_args=None):
        '''
        Ensure all nodes are authorized to the cluster
    
        name
    Severity: Minor
    Found in salt/states/pcs.py - About 4 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 cib_present has a Cognitive Complexity of 24 (exceeds 5 allowed). Consider refactoring.
    Open

    def cib_present(name, cibname, scope=None, extra_args=None):
        '''
        Ensure that a CIB-file with the content of the current live CIB is created
    
        Should be run on one cluster node only
    Severity: Minor
    Found in salt/states/pcs.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

    Cyclomatic complexity is too high in function cluster_node_present. (22)
    Open

    def cluster_node_present(name, node, extra_args=None):
        '''
        Add a node to the Pacemaker cluster via PCS
        Should be run on one cluster node only
        (there may be races)
    Severity: Minor
    Found in salt/states/pcs.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

    Cyclomatic complexity is too high in function cib_present. (21)
    Open

    def cib_present(name, cibname, scope=None, extra_args=None):
        '''
        Ensure that a CIB-file with the content of the current live CIB is created
    
        Should be run on one cluster node only
    Severity: Minor
    Found in salt/states/pcs.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

    Function cib_present has 31 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    def cib_present(name, cibname, scope=None, extra_args=None):
        '''
        Ensure that a CIB-file with the content of the current live CIB is created
    
        Should be run on one cluster node only
    Severity: Minor
    Found in salt/states/pcs.py - About 1 hr to fix

      Avoid deeply nested control flow statements.
      Open

                          if item_id_value in [value]:
                              item_create_required = False
      
          # constraints match on '(id:<id>)'
          elif item in ['constraint']:
      Severity: Major
      Found in salt/states/pcs.py - About 45 mins to fix

        Avoid deeply nested control flow statements.
        Open

                            if __opts__['test']:
                                ret['comment'] += 'Cluster {0} is set to set up\n'.format(pcsclustername)
        
        
        Severity: Major
        Found in salt/states/pcs.py - About 45 mins to fix

          Function cib_pushed has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
          Open

          def cib_pushed(name, cibname, scope=None, extra_args=None):
              '''
              Ensure that a CIB-file is pushed if it is changed since the creation of it with pcs.cib_present
          
              Should be run on one cluster node only
          Severity: Minor
          Found in salt/states/pcs.py - About 35 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

              if node in node_add_dict and node_add_dict[node] in ['Succeeded', 'Success']:
                  ret['comment'] += 'Added node {0}\n'.format(node)
                  ret['changes'].update({node: {'old': '', 'new': 'Added'}})
              else:
                  ret['result'] = False
          Severity: Major
          Found in salt/states/pcs.py and 1 other location - About 1 day to fix
          salt/states/pcs.py on lines 520..529

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

          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 node in nodes:
                  if node in setup_dict and setup_dict[node] in ['Succeeded', 'Success']:
                      ret['comment'] += 'Set up {0}\n'.format(node)
                      ret['changes'].update({node: {'old': '', 'new': 'Setup'}})
                  else:
          Severity: Major
          Found in salt/states/pcs.py and 1 other location - About 1 day to fix
          salt/states/pcs.py on lines 620..628

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

          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 line in authorized['stdout'].splitlines():
                  node = line.split(':')[0].strip()
                  auth_state = line.split(':')[1].strip()
                  if node in nodes:
                      authorized_dict.update({node: auth_state})
          Severity: Major
          Found in salt/states/pcs.py and 1 other location - About 3 hrs to fix
          salt/states/pcs.py on lines 426..430

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

          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 line in authorize['stdout'].splitlines():
                  node = line.split(':')[0].strip()
                  auth_state = line.split(':')[1].strip()
                  if node in nodes:
                      authorize_dict.update({node: auth_state})
          Severity: Major
          Found in salt/states/pcs.py and 1 other location - About 3 hrs to fix
          salt/states/pcs.py on lines 396..400

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

          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 __opts__['test']:
                  ret['result'] = None
                  ret['comment'] += 'Node {0} is set to be added to the cluster\n'.format(node)
                  return ret
          Severity: Minor
          Found in salt/states/pcs.py and 1 other location - About 45 mins to fix
          salt/states/pcs.py on lines 804..807

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

          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 __opts__['test']:
                  ret['result'] = None
                  ret['comment'] += 'CIB {0} is set to be pushed as the new live CIB\n'.format(cibname)
                  return ret
          Severity: Minor
          Found in salt/states/pcs.py and 1 other location - About 45 mins to fix
          salt/states/pcs.py on lines 588..591

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

          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

          def resource_present(name, resource_id, resource_type, resource_options=None, cibname=None):
              '''
              Ensure that a resource is created
          
              Should be run on one cluster node only
          Severity: Minor
          Found in salt/states/pcs.py and 1 other location - About 30 mins to fix
          salt/states/pcs.py on lines 939..976

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

          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

          def stonith_present(name, stonith_id, stonith_device_type, stonith_device_options=None, cibname=None):
              '''
              Ensure that a fencing resource is created
          
              Should be run on one cluster node only
          Severity: Minor
          Found in salt/states/pcs.py and 1 other location - About 30 mins to fix
          salt/states/pcs.py on lines 984..1016

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

          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