saltstack/salt

View on GitHub
salt/states/boto_s3_bucket.py

Summary

Maintainability
F
4 days
Test Coverage

Function present has a Cognitive Complexity of 71 (exceeds 5 allowed). Consider refactoring.
Open

def present(name, Bucket,
            LocationConstraint=None,
            ACL=None,
            CORSRules=None,
            LifecycleConfiguration=None,
Severity: Minor
Found in salt/states/boto_s3_bucket.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 boto_s3_bucket.py has 551 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
'''
Manage S3 Buckets
=================

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

    Cyclomatic complexity is too high in function present. (38)
    Open

    def present(name, Bucket,
                LocationConstraint=None,
                ACL=None,
                CORSRules=None,
                LifecycleConfiguration=None,
    Severity: Minor
    Found in salt/states/boto_s3_bucket.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 _acl_to_grant has a Cognitive Complexity of 30 (exceeds 5 allowed). Consider refactoring.
    Open

    def _acl_to_grant(ACL, owner_canonical_id):
        if 'AccessControlPolicy' in ACL:
            ret = copy.deepcopy(ACL['AccessControlPolicy'])
            ret['Owner'] = _normalize_user(ret['Owner'])
            for item in ACL.get('Grants', ()):
    Severity: Minor
    Found in salt/states/boto_s3_bucket.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

    Avoid deeply nested control flow statements.
    Open

                        if not r.get('deleted'):
                            ret['result'] = False
                            ret['comment'] = 'Failed to update bucket: {0}.'.format(r['error']['message'])
                            return ret
                    else:
    Severity: Major
    Found in salt/states/boto_s3_bucket.py - About 45 mins to fix

      Avoid deeply nested control flow statements.
      Open

                          if not r.get('updated'):
                              ret['result'] = False
                              ret['comment'] = 'Failed to update bucket: {0}.'.format(r['error']['message'])
                              return ret
          if update and __opts__['test']:
      Severity: Major
      Found in salt/states/boto_s3_bucket.py - About 45 mins to fix

        Avoid too many return statements within this function.
        Open

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

          Avoid too many return statements within this function.
          Open

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

            Avoid too many return statements within this function.
            Open

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

              Avoid too many return statements within this function.
              Open

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

                Avoid too many return statements within this function.
                Open

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

                  Avoid too many return statements within this function.
                  Open

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

                    Avoid too many return statements within this function.
                    Open

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

                      Avoid too many return statements within this function.
                      Open

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

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

                        def _get_role_arn(name, region=None, key=None, keyid=None, profile=None):
                            if name.startswith('arn:aws:iam:'):
                                return name
                        
                            account_id = __salt__['boto_iam.get_account_id'](
                        Severity: Major
                        Found in salt/states/boto_s3_bucket.py and 2 other locations - About 6 hrs to fix
                        salt/modules/boto_lambda.py on lines 176..187
                        salt/modules/boto_s3_bucket.py on lines 674..685

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

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

                            if 'error' in _describe:
                                ret['result'] = False
                                ret['comment'] = 'Failed to update bucket: {0}.'.format(_describe['error']['message'])
                                ret['changes'] = {}
                                return ret
                        Severity: Major
                        Found in salt/states/boto_s3_bucket.py and 8 other locations - About 2 hrs to fix
                        salt/states/boto_cloudtrail.py on lines 193..197
                        salt/states/boto_cloudtrail.py on lines 218..222
                        salt/states/boto_cloudwatch_event.py on lines 166..170
                        salt/states/boto_cloudwatch_event.py on lines 179..183
                        salt/states/boto_cloudwatch_event.py on lines 192..196
                        salt/states/boto_cloudwatch_event.py on lines 201..205
                        salt/states/boto_cloudwatch_event.py on lines 254..258
                        salt/states/boto_cloudwatch_event.py on lines 263..267

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

                        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