saltstack/salt

View on GitHub
salt/states/netsnmp.py

Summary

Maintainability
D
1 day
Test Coverage

Function _check_config has a Cognitive Complexity of 30 (exceeds 5 allowed). Consider refactoring.
Open

def _check_config(config):

    '''
    Checks the desired config and clears interesting details.
    '''
Severity: Minor
Found in salt/states/netsnmp.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

File netsnmp.py has 282 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
'''
Network SNMP
============

Severity: Minor
Found in salt/states/netsnmp.py - About 2 hrs to fix

    Function managed has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

    def managed(name, config=None, defaults=None):
    
        '''
        Configures the SNMP on the device as specified in the SLS file.
    
    
    Severity: Minor
    Found in salt/states/netsnmp.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 _configure has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

    def _configure(changes):
    
        '''
        Calls the configuration template to apply the configuration changes on the device.
        '''
    Severity: Minor
    Found in salt/states/netsnmp.py - About 45 mins to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Avoid deeply nested control flow statements.
    Open

                        if _valid_str(_comm_name):
                            _community_tmp[_comm_name] = _clear_community_details(_comm_details)
        elif _valid_dict(_community):
    Severity: Major
    Found in salt/states/netsnmp.py - About 45 mins to fix

      Avoid too many return statements within this function.
      Open

          return ret
      Severity: Major
      Found in salt/states/netsnmp.py - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

            return True, ''
        Severity: Major
        Found in salt/states/netsnmp.py - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                  return ret
          Severity: Major
          Found in salt/states/netsnmp.py - About 30 mins to fix

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

            def _compute_diff(existing, expected):
            
                '''
                Computes the differences between the existing and the expected SNMP config.
                '''
            Severity: Minor
            Found in salt/states/netsnmp.py - About 25 mins to fix

            Cognitive Complexity

            Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

            A method's cognitive complexity is based on a few simple rules:

            • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
            • Code is considered more complex for each "break in the linear flow of the code"
            • Code is considered more complex when "flow breaking structures are nested"

            Further reading

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

                for key in ['location', 'contact', 'chassis_id']:
                    if existing.get(key) != expected.get(key):
                        _create_diff(diff,
                                     _valid_str,
                                     key,
            Severity: Minor
            Found in salt/states/netsnmp.py and 1 other location - About 55 mins to fix
            salt/states/netsnmp.py on lines 242..248

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

            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 key in ['community']:  # for the moment only onen
                    if existing.get(key) != expected.get(key):
                        _create_diff(diff,
                                     _valid_dict,
                                     key,
            Severity: Minor
            Found in salt/states/netsnmp.py and 1 other location - About 55 mins to fix
            salt/states/netsnmp.py on lines 234..240

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

            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 not _device_config.get('result'):
                    ret['comment'] = 'Cannot retrieve SNMP config from the device: {reason}'.format(
                        reason=_device_config.get('comment')
                    )
                    return ret
            Severity: Minor
            Found in salt/states/netsnmp.py and 1 other location - About 40 mins to fix
            salt/states/netusers.py on lines 349..353

            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