saltstack/salt

View on GitHub
salt/renderers/stateconf.py

Summary

Maintainability
F
4 days
Test Coverage

Function render has a Cognitive Complexity of 60 (exceeds 5 allowed). Consider refactoring.
Open

def render(input, saltenv='base', sls='', argline='', **kws):
    gen_start_state = False
    no_goal_state = False
    implicit_require = False

Severity: Minor
Found in salt/renderers/stateconf.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 stateconf.py has 396 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
'''
A flexible renderer that takes a templating engine and a data format

:maintainer: Jack Kuan <kjkuan@gmail.com>
Severity: Minor
Found in salt/renderers/stateconf.py - About 5 hrs to fix

    Function add_implicit_requires has a Cognitive Complexity of 36 (exceeds 5 allowed). Consider refactoring.
    Open

    def add_implicit_requires(data):
    
        def T(sid, state):  # pylint: disable=C0103
            return '{0}:{1}'.format(sid, state_name(state))
    
    
    Severity: Minor
    Found in salt/renderers/stateconf.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

    Function rename_state_ids has a Cognitive Complexity of 32 (exceeds 5 allowed). Consider refactoring.
    Open

    def rename_state_ids(data, sls, is_extend=False):
        # if the .sls file is salt://my/salt/file.sls
        # then rename all state ids defined in it that start with a dot(.) with
        # "my.salt.file::" + the_state_id_without_the_first_dot.
    
    
    Severity: Minor
    Found in salt/renderers/stateconf.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 extract_state_confs has a Cognitive Complexity of 25 (exceeds 5 allowed). Consider refactoring.
    Open

    def extract_state_confs(data, is_extend=False):
        for state_id, state_dict in six.iteritems(data):
            if state_id == 'extend' and not is_extend:
                extract_state_confs(state_dict, True)
                continue
    Severity: Minor
    Found in salt/renderers/stateconf.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

    Function rewrite_sls_includes_excludes has a Cognitive Complexity of 24 (exceeds 5 allowed). Consider refactoring.
    Open

    def rewrite_sls_includes_excludes(data, sls, saltenv):
        # if the path of the included/excluded sls starts with a leading dot(.)
        # then it's taken to be relative to the including/excluding sls.
        for sid in data:
            if sid == 'include':
    Severity: Minor
    Found in salt/renderers/stateconf.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

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

    def statelist(states_dict, sid_excludes=frozenset(['include', 'exclude'])):
        for sid, states in six.iteritems(states_dict):
            if sid.startswith('__'):
                continue
            if sid in sid_excludes:
    Severity: Minor
    Found in salt/renderers/stateconf.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 add_start_state has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

    def add_start_state(data, sls):
        start_sid = __opts__['stateconf_start_state']
        if start_sid in data:
            raise SaltRenderError(
                'Can\'t generate start state({0})! The same state id already '
    Severity: Minor
    Found in salt/renderers/stateconf.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

                        if k.startswith(prefix):
                            tmplctx[k[len(prefix):]] = tmplctx[k]
                            del tmplctx[k]
            else:
    Severity: Major
    Found in salt/renderers/stateconf.py - About 45 mins to fix

      Avoid deeply nested control flow statements.
      Open

                          if isinstance(arg, dict) and next(iter(arg)) == 'name':
                              break
                      else:
      Severity: Major
      Found in salt/renderers/stateconf.py - About 45 mins to fix

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

        def add_goal_state(data):
            goal_sid = __opts__['stateconf_goal_state']
            if goal_sid in data:
                raise SaltRenderError(
                    'Can\'t generate goal state({0})! The same state id already '
        Severity: Minor
        Found in salt/renderers/stateconf.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 nvlist has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

        def nvlist(thelist, names=None):
            '''
            Given a list of items::
        
                - whatever
        Severity: Minor
        Found in salt/renderers/stateconf.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

                for _, rstate, rsid in reqs:
                    if T(rsid, rstate) in states_before:
                        raise SaltRenderError(
                            'State({0}) can\'t require_in/watch_in/listen_in/onchanges_in/onfail_in a state({1}) '
                            'defined before it!'.format(tag, T(rsid, rstate))
        Severity: Minor
        Found in salt/renderers/stateconf.py and 1 other location - About 50 mins to fix
        salt/renderers/stateconf.py on lines 449..453

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

                for _, rstate, rsid in reqs:
                    if T(rsid, rstate) in states_after:
                        raise SaltRenderError(
                            'State({0}) can\'t require/watch/listen/onchanges/onfail a state({1}) defined '
                            'after it!'.format(tag, T(rsid, rstate))
        Severity: Minor
        Found in salt/renderers/stateconf.py and 1 other location - About 50 mins to fix
        salt/renderers/stateconf.py on lines 459..463

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

                        for _, rstate, rsid in nvlist2(eargs, REQUIRE_IN):
                            EXTENDED_REQUIRE_IN.setdefault(
                                T(esid, rstate), []).append((None, rstate, rsid))
        Severity: Minor
        Found in salt/renderers/stateconf.py and 1 other location - About 30 mins to fix
        salt/renderers/stateconf.py on lines 435..437

        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

                        for _, rstate, rsid in nvlist2(eargs, REQUIRE):
                            EXTENDED_REQUIRE.setdefault(
                                T(esid, rstate), []).append((None, rstate, rsid))
        Severity: Minor
        Found in salt/renderers/stateconf.py and 1 other location - About 30 mins to fix
        salt/renderers/stateconf.py on lines 438..440

        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