saltstack/salt

View on GitHub
salt/pillar/vmware_pillar.py

Summary

Maintainability
F
3 days
Test Coverage

Function ext_pillar has a Cognitive Complexity of 75 (exceeds 5 allowed). Consider refactoring.
Open

def ext_pillar(minion_id,
               pillar,  # pylint: disable=W0613
               **kwargs):
    '''
    Check vmware/vcenter for all data
Severity: Minor
Found in salt/pillar/vmware_pillar.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

File vmware_pillar.py has 454 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
'''
Pillar data from vCenter or an ESXi host

.. versionadded:: 2017.7.0
Severity: Minor
Found in salt/pillar/vmware_pillar.py - About 6 hrs to fix

    Cyclomatic complexity is too high in function ext_pillar. (28)
    Open

    def ext_pillar(minion_id,
                   pillar,  # pylint: disable=W0613
                   **kwargs):
        '''
        Check vmware/vcenter for all data
    Severity: Minor
    Found in salt/pillar/vmware_pillar.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 _crawl_attribute has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
    Open

    def _crawl_attribute(this_data, this_attr):
        '''
        helper function to crawl an attribute specified for retrieval
        '''
        if isinstance(this_data, list):
    Severity: Minor
    Found in salt/pillar/vmware_pillar.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 _recurse_config_to_dict has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
    Open

    def _recurse_config_to_dict(t_data):
        '''
        helper function to recurse through a vim object and attempt to return all child objects
        '''
        if not isinstance(t_data, type(None)):
    Severity: Minor
    Found in salt/pillar/vmware_pillar.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 ext_pillar has 29 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    def ext_pillar(minion_id,
                   pillar,  # pylint: disable=W0613
                   **kwargs):
        '''
        Check vmware/vcenter for all data
    Severity: Minor
    Found in salt/pillar/vmware_pillar.py - About 1 hr to fix

      Avoid deeply nested control flow statements.
      Open

                              if type_name in type_specific_pillar_attributes:
                                  type_specific_pillar_attribute = type_specific_pillar_attributes[type_name]
                              vmware_pillar[pillar_key] = dictupdate.update(vmware_pillar[pillar_key],
      Severity: Major
      Found in salt/pillar/vmware_pillar.py - About 45 mins to fix

        Avoid deeply nested control flow statements.
        Open

                                if hasattr(data, 'availableField'):
                                    vmware_pillar[pillar_key]['annotations'] = {}
                                    for availableField in data.availableField:
                                        for customValue in data.customValue:
                                            if availableField.key == customValue.key:
        Severity: Major
        Found in salt/pillar/vmware_pillar.py - About 45 mins to fix

          Avoid too many return statements within this function.
          Open

                  return {}
          Severity: Major
          Found in salt/pillar/vmware_pillar.py - About 30 mins to fix

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

                if 'username' not in kwargs:
                    log.error('VMWare external pillar requested but username is not specified in ext_pillar configuration.')
                    return vmware_pillar
                else:
                    username = kwargs['username']
            Severity: Major
            Found in salt/pillar/vmware_pillar.py and 2 other locations - About 50 mins to fix
            salt/pillar/vmware_pillar.py on lines 362..367
            salt/pillar/vmware_pillar.py on lines 376..381

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

            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 'password' not in kwargs:
                    log.error('VMWare external pillar requested but password is not specified in ext_pillar configuration.')
                    return vmware_pillar
                else:
                    password = kwargs['password']
            Severity: Major
            Found in salt/pillar/vmware_pillar.py and 2 other locations - About 50 mins to fix
            salt/pillar/vmware_pillar.py on lines 362..367
            salt/pillar/vmware_pillar.py on lines 369..374

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

            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 'host' not in kwargs:
                    log.error('VMWare external pillar configured but host is not specified in ext_pillar configuration.')
                    return vmware_pillar
                else:
                    host = kwargs['host']
            Severity: Major
            Found in salt/pillar/vmware_pillar.py and 2 other locations - About 50 mins to fix
            salt/pillar/vmware_pillar.py on lines 369..374
            salt/pillar/vmware_pillar.py on lines 376..381

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

            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