saltstack/salt

View on GitHub
salt/states/dvs.py

Summary

Maintainability
F
1 wk
Test Coverage

File dvs.py has 620 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
'''
Manage VMware distributed virtual switches (DVSs) and their distributed virtual
portgroups (DVportgroups).

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

    Function dvs_configured has a Cognitive Complexity of 67 (exceeds 5 allowed). Consider refactoring.
    Open

    def dvs_configured(name, dvs):
        '''
        Configures a DVS.
    
        Creates a new DVS, if it doesn't exist in the provided datacenter or
    Severity: Minor
    Found in salt/states/dvs.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

    Function portgroups_configured has a Cognitive Complexity of 34 (exceeds 5 allowed). Consider refactoring.
    Open

    def portgroups_configured(name, dvs, portgroups):
        '''
        Configures portgroups on a DVS.
    
        Creates/updates/removes portgroups in a provided DVS
    Severity: Minor
    Found in salt/states/dvs.py - About 5 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 dvs_configured. (26)
    Open

    def dvs_configured(name, dvs):
        '''
        Configures a DVS.
    
        Creates a new DVS, if it doesn't exist in the provided datacenter or
    Severity: Minor
    Found in salt/states/dvs.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 _get_changes_from_diff_dict has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
    Open

    def _get_changes_from_diff_dict(diff_dict):
        '''
        Returns a list of string message of the differences in a diff dict.
    
        Each inner message is tabulated one tab deeper
    Severity: Minor
    Found in salt/states/dvs.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 uplink_portgroup_configured has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
    Open

    def uplink_portgroup_configured(name, dvs, uplink_portgroup):
        '''
        Configures the uplink portgroup on a DVS. The state assumes there is only
        one uplink portgroup.
    
    
    Severity: Minor
    Found in salt/states/dvs.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_diff_dict has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
    Open

    def _get_diff_dict(dict1, dict2):
        '''
        Returns a dictionary with the diffs between two dictionaries
    
        It will ignore any key that doesn't exist in dict2
    Severity: Minor
    Found in salt/states/dvs.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 deeply nested control flow statements.
    Open

                            if dvs[infra_prop][idx] != \
                               current_dvs[infra_prop][idx]:
    
                                original_infra_res_pools.append(
                                    current_dvs[infra_prop][idx])
    Severity: Major
    Found in salt/states/dvs.py - About 45 mins to fix

      Avoid deeply nested control flow statements.
      Open

                              if p == 'infrastructure_traffic_resource_pools':
                                  changes_string += \
                                          '\tinfrastructure_traffic_resource_pools:\n'
                                  for idx in range(len(props_to_updated_values[p])):
                                      d = props_to_updated_values[p][idx]
      Severity: Major
      Found in salt/states/dvs.py - About 45 mins to fix

        Avoid deeply nested control flow statements.
        Open

                                if 'num_shares' not in dvs[infra_prop][idx] and \
                                   current_dvs[infra_prop][idx]['share_level'] != \
                                   'custom' and \
                                   'num_shares' in current_dvs[infra_prop][idx]:
        
        
        Severity: Major
        Found in salt/states/dvs.py - About 45 mins to fix

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

          def _get_val1_dict_from_diff_dict(diff_dict):
              '''
              Returns a dictionaries with the values stored in val1 of a diff dict.
              '''
              ret_dict = {}
          Severity: Minor
          Found in salt/states/dvs.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

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

          def _get_val2_dict_from_diff_dict(diff_dict):
              '''
              Returns a dictionaries with the values stored in val2 of a diff dict.
              '''
              ret_dict = {}
          Severity: Minor
          Found in salt/states/dvs.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

          def _get_val2_dict_from_diff_dict(diff_dict):
              '''
              Returns a dictionaries with the values stored in val2 of a diff dict.
              '''
              ret_dict = {}
          Severity: Major
          Found in salt/states/dvs.py and 1 other location - About 7 hrs to fix
          salt/states/dvs.py on lines 446..459

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

          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 _get_val1_dict_from_diff_dict(diff_dict):
              '''
              Returns a dictionaries with the values stored in val1 of a diff dict.
              '''
              ret_dict = {}
          Severity: Major
          Found in salt/states/dvs.py and 1 other location - About 7 hrs to fix
          salt/states/dvs.py on lines 430..443

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

          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

              try:
                  #TODO portroups validation
                  si = __salt__['vsphere.get_service_instance_via_proxy']()
                  current_pgs = __salt__['vsphere.list_dvportgroups'](
                      dvs=dvs, service_instance=si)
          Severity: Major
          Found in salt/states/dvs.py and 1 other location - About 5 hrs to fix
          salt/states/dvs.py on lines 654..697

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

          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

              try:
                  #TODO portroups validation
                  si = __salt__['vsphere.get_service_instance_via_proxy']()
                  current_uplink_portgroup = __salt__['vsphere.list_uplink_dvportgroup'](
                      dvs=dvs, service_instance=si)
          Severity: Major
          Found in salt/states/dvs.py and 1 other location - About 5 hrs to fix
          salt/states/dvs.py on lines 519..615

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

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

              if not comments:
                  # We have no changes
                  ret.update({'comment': ('DVS \'{0}\' in datacenter \'{1}\' is '
                                          'correctly configured. Nothing to be done.'
                                          ''.format(dvs_name, datacenter_name)),
          Severity: Major
          Found in salt/states/dvs.py and 2 other locations - About 2 hrs to fix
          salt/states/dvs.py on lines 616..626
          salt/states/dvs.py on lines 698..708

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

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

              if not changes_required:
                  # We have no changes
                  ret.update({'comment': ('All portgroups in DVS \'{0}\', datacenter '
                                          '\'{1}\' exist and are correctly configured. '
                                          'Nothing to be done.'.format(dvs, datacenter)),
          Severity: Major
          Found in salt/states/dvs.py and 2 other locations - About 2 hrs to fix
          salt/states/dvs.py on lines 395..405
          salt/states/dvs.py on lines 698..708

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

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

              if not changes_required:
                  # We have no changes
                  ret.update({'comment': ('Uplink portgroup in DVS \'{0}\', datacenter '
                                          '\'{1}\' is correctly configured. '
                                          'Nothing to be done.'.format(dvs, datacenter)),
          Severity: Major
          Found in salt/states/dvs.py and 2 other locations - About 2 hrs to fix
          salt/states/dvs.py on lines 395..405
          salt/states/dvs.py on lines 616..626

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

          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']:
                              comments.append('State {0} will create a new portgroup '
                                              '\'{1}\' in DVS \'{2}\', datacenter '
                                              '\'{3}\''.format(name, pg_name, dvs,
                                                               datacenter))
          Severity: Minor
          Found in salt/states/dvs.py and 1 other location - About 40 mins to fix
          salt/states/dvs.py on lines 558..574

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

          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 sub_changes:
                          changes_strings.append('{0}:'.format(p))
                          changes_strings.extend(['\t{0}'.format(c)
          Severity: Minor
          Found in salt/states/dvs.py and 1 other location - About 40 mins to fix
          salt/utils/dictdiffer.py on lines 241..243

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

          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']:
                                  changes_strings = \
                                          _get_changes_from_diff_dict(diff_dict)
                                  log.trace('changes_strings = %s', changes_strings)
                                  comments.append(
          Severity: Minor
          Found in salt/states/dvs.py and 1 other location - About 40 mins to fix
          salt/states/dvs.py on lines 534..545

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

          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