saltstack/salt

View on GitHub
salt/states/x509.py

Summary

Maintainability
F
3 days
Test Coverage

File x509.py has 599 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
'''
Manage X509 Certificates

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

    Function certificate_managed has a Cognitive Complexity of 54 (exceeds 5 allowed). Consider refactoring.
    Open

    def certificate_managed(name,
                            days_remaining=90,
                            managed_private_key=None,
                            append_certs=None,
                            **kwargs):
    Severity: Minor
    Found in salt/states/x509.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

    Cyclomatic complexity is too high in function certificate_managed. (32)
    Open

    def certificate_managed(name,
                            days_remaining=90,
                            managed_private_key=None,
                            append_certs=None,
                            **kwargs):
    Severity: Minor
    Found in salt/states/x509.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 _revoked_to_list has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
    Open

    def _revoked_to_list(revs):
        '''
        Turn the mess of OrderedDicts and Lists into a list of dicts for
        use in the CRL module.
        '''
    Severity: Minor
    Found in salt/states/x509.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 crl_managed has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
    Open

    def crl_managed(name,
                    signing_private_key,
                    signing_private_key_passphrase=None,
                    signing_cert=None,
                    revoked=None,
    Severity: Minor
    Found in salt/states/x509.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 certificate_managed has 29 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    def certificate_managed(name,
                            days_remaining=90,
                            managed_private_key=None,
                            append_certs=None,
                            **kwargs):
    Severity: Minor
    Found in salt/states/x509.py - About 1 hr to fix

      Function _check_private_key has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
      Open

      def _check_private_key(name, bits=2048, passphrase=None,
                             new=False, overwrite=False):
          current_bits = 0
          if os.path.isfile(name):
              try:
      Severity: Minor
      Found in salt/states/x509.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 isinstance(val, datetime.datetime):
                              val = val.strftime('%Y-%m-%d %H:%M:%S')
                          dict_[propname] = val
      Severity: Major
      Found in salt/states/x509.py - About 45 mins to fix

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

                if 'serial_number' not in kwargs:
                    new_comp.pop('Serial Number')
                    if 'signing_cert' not in kwargs:
                        try:
                            new_comp['X509v3 Extensions']['authorityKeyIdentifier'] = (
        Severity: Major
        Found in salt/states/x509.py and 1 other location - About 3 hrs to fix
        salt/states/x509.py on lines 505..512

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

        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 'serial_number' not in kwargs:
                        current_comp.pop('Serial Number')
                        if 'signing_cert' not in kwargs:
                            try:
                                current_comp['X509v3 Extensions']['authorityKeyIdentifier'] = (
        Severity: Major
        Found in salt/states/x509.py and 1 other location - About 3 hrs to fix
        salt/states/x509.py on lines 539..546

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

        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

                    private_key = __salt__['x509.create_private_key'](text=True, bits=private_key_args['bits'],
                                                                      passphrase=private_key_args['passphrase'],
                                                                      cipher=private_key_args['cipher'],
                                                                      verbose=private_key_args['verbose'])
        Severity: Minor
        Found in salt/states/x509.py and 1 other location - About 30 mins to fix
        salt/states/boto_dynamodb.py on lines 403..408

        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