saltstack/salt

View on GitHub
salt/auth/ldap.py

Summary

Maintainability
F
5 days
Test Coverage

Function groups has a Cognitive Complexity of 65 (exceeds 5 allowed). Consider refactoring.
Open

def groups(username, **kwargs):
    '''
    Authenticate against an LDAP group

    Behavior is highly dependent on if Active Directory is in use.
Severity: Minor
Found in salt/auth/ldap.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 __expand_ldap_entries has a Cognitive Complexity of 44 (exceeds 5 allowed). Consider refactoring.
Open

def __expand_ldap_entries(entries, opts=None):
    '''

    :param entries: ldap subtree in external_auth config option
    :param opts: Opts to use when __opts__ not defined
Severity: Minor
Found in salt/auth/ldap.py - About 6 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

File ldap.py has 406 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
'''
Provide authentication using simple LDAP binds

:depends:   - ldap Python module
Severity: Minor
Found in salt/auth/ldap.py - About 5 hrs to fix

    Function _bind has a Cognitive Complexity of 26 (exceeds 5 allowed). Consider refactoring.
    Open

    def _bind(username, password, anonymous=False, opts=None):
        '''
        Authenticate via an LDAP bind
        '''
        # Get config params; create connection dictionary
    Severity: Minor
    Found in salt/auth/ldap.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 groups. (25)
    Open

    def groups(username, **kwargs):
        '''
        Authenticate against an LDAP group
    
        Behavior is highly dependent on if Active Directory is in use.
    Severity: Minor
    Found in salt/auth/ldap.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 _bind. (24)
    Open

    def _bind(username, password, anonymous=False, opts=None):
        '''
        Authenticate via an LDAP bind
        '''
        # Get config params; create connection dictionary
    Severity: Minor
    Found in salt/auth/ldap.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 __init__ has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
    Open

        def __init__(self, uri, server, port,
                     starttls, tls, no_verify,
                     binddn, bindpw,
                     anonymous, accountattributename, activedirectory=False):
            '''
    Severity: Minor
    Found in salt/auth/ldap.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 _bind_for_search has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

    def _bind_for_search(anonymous=False, opts=None):
        '''
        Bind with binddn and bindpw only for searching LDAP
        :param anonymous: Try binding anonymously
        :param opts: Pass in when __opts__ is not available
    Severity: Minor
    Found in salt/auth/ldap.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

    Avoid deeply nested control flow statements.
    Open

                        for group in salt.utils.data.decode(entry[_config('groupattribute')]):
                            group_list.append(salt.utils.stringutils.to_unicode(group).split(',')[0].split('=')[-1])
                log.debug('User %s is a member of groups: %s', username, group_list)
    Severity: Major
    Found in salt/auth/ldap.py - About 45 mins to fix

      Avoid deeply nested control flow statements.
      Open

                          if username == salt.utils.stringutils.to_unicode(user).split(',')[0].split('=')[-1]:
                              group_list.append(entry.split(',')[0].split('=')[-1])
      
      
      Severity: Major
      Found in salt/auth/ldap.py - About 45 mins to fix

        Avoid deeply nested control flow statements.
        Open

                                    if opts.get('auth.ldap.minion_stripdomains', None):
                                        for domain in opts['auth.ldap.minion_stripdomains']:
                                            if minion_id.endswith(domain):
                                                minion_id = minion_id[:-len(domain)]
                                                break
        Severity: Major
        Found in salt/auth/ldap.py - About 45 mins to fix

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

          def _config(key, mandatory=True, opts=None):
              '''
              Return a value for 'name' from master config file options or defaults.
              '''
              try:
          Severity: Minor
          Found in salt/auth/ldap.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 too many return statements within this function.
          Open

              return group_list
          Severity: Major
          Found in salt/auth/ldap.py - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                return ldap_conn
            Severity: Major
            Found in salt/auth/ldap.py - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                              return []
              Severity: Major
              Found in salt/auth/ldap.py - About 30 mins to fix

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

                def auth(username, password):
                    '''
                    Simple LDAP auth
                    '''
                    if not HAS_LDAP:
                Severity: Minor
                Found in salt/auth/ldap.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

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

                    if paramvalues['binddn']:
                        connargs['binddn'] = paramvalues['binddn']
                        if paramvalues['bindpw']:
                            params['mandatory'].append('bindpw')
                Severity: Major
                Found in salt/auth/ldap.py and 1 other location - About 2 hrs to fix
                salt/auth/ldap.py on lines 172..175

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

                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 paramvalues['binddn']:
                        connargs['binddn'] = paramvalues['binddn']
                        if paramvalues['bindpw']:
                            params['mandatory'].append('bindpw')
                Severity: Major
                Found in salt/auth/ldap.py and 1 other location - About 2 hrs to fix
                salt/auth/ldap.py on lines 228..231

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

                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 username == salt.utils.stringutils.to_unicode(user).split(',')[0].split('=')[-1]:
                Severity: Major
                Found in salt/auth/ldap.py and 1 other location - About 1 hr to fix
                salt/auth/ldap.py on lines 421..421

                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

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

                                if username == salt.utils.stringutils.to_unicode(user).split(',')[0].split('=')[-1]:
                Severity: Major
                Found in salt/auth/ldap.py and 1 other location - About 1 hr to fix
                salt/auth/ldap.py on lines 396..396

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

                        if paramvalues['binddn'] and not paramvalues['bindpw']:
                            connargs['binddn'] = paramvalues['binddn']
                Severity: Major
                Found in salt/auth/ldap.py and 3 other locations - About 40 mins to fix
                salt/auth/ldap.py on lines 236..272
                salt/modules/x509.py on lines 1656..1657
                salt/modules/x509.py on lines 1658..1659

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

                    if not paramvalues['anonymous']:
                        if paramvalues['binddn'] and paramvalues['bindpw']:
                            # search for the user's DN to be used for the actual authentication
                            _ldap = _LDAPConnection(**connargs).ldap
                            log.debug(
                Severity: Major
                Found in salt/auth/ldap.py and 3 other locations - About 40 mins to fix
                salt/auth/ldap.py on lines 269..270
                salt/modules/x509.py on lines 1656..1657
                salt/modules/x509.py on lines 1658..1659

                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