atlassian/localstack

View on GitHub
localstack/utils/aws/aws_stack.py

Summary

Maintainability
D
1 day
Test Coverage

File aws_stack.py has 399 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import os
import boto3
import json
import base64
import logging
Severity: Minor
Found in localstack/utils/aws/aws_stack.py - About 5 hrs to fix

    Function connect_elasticsearch has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
    Open

    def connect_elasticsearch(endpoint=None, domain=None, region_name=None, env=None):
        from elasticsearch import Elasticsearch, RequestsHttpConnection
        from requests_aws4auth import AWS4Auth
    
        env = get_environment(env, region_name=region_name)
    Severity: Minor
    Found in localstack/utils/aws/aws_stack.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 kinesis_get_latest_records has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

    def kinesis_get_latest_records(stream_name, shard_id, count=10, env=None):
        kinesis = connect_to_service('kinesis', env=env)
        result = []
        response = kinesis.get_shard_iterator(StreamName=stream_name, ShardId=shard_id,
            ShardIteratorType='TRIM_HORIZON')
    Severity: Minor
    Found in localstack/utils/aws/aws_stack.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 get_environment has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

    def get_environment(env=None, region_name=None):
        """
        Return an Environment object based on the input arguments.
    
        Parameter `env` can be either of:
    Severity: Minor
    Found in localstack/utils/aws/aws_stack.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

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

    def get_apigateway_resource_for_path(api_id, path, parent=None, resources=None):
        if resources is None:
            apigateway = connect_to_service(service_name='apigateway')
            resources = apigateway.get_resources(restApiId=api_id, limit=100)
        if not isinstance(path, list):
    Severity: Minor
    Found in localstack/utils/aws/aws_stack.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

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

    def create_api_gateway(name, description=None, resources=None, stage_name=None,
            enabled_api_keys=[], env=None, usage_plan_name=None):
        client = connect_to_service('apigateway', env=env)
        if not resources:
            resources = []
    Severity: Minor
    Found in localstack/utils/aws/aws_stack.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

    Function create_api_gateway has 7 arguments (exceeds 4 allowed). Consider refactoring.
    Open

    def create_api_gateway(name, description=None, resources=None, stage_name=None,
    Severity: Major
    Found in localstack/utils/aws/aws_stack.py - About 50 mins to fix

      Function connect_to_service has 5 arguments (exceeds 4 allowed). Consider refactoring.
      Open

      def connect_to_service(service_name, client=True, env=None, region_name=None, endpoint_url=None):
      Severity: Minor
      Found in localstack/utils/aws/aws_stack.py - About 35 mins to fix

        Function create_api_gateway_integrations has 5 arguments (exceeds 4 allowed). Consider refactoring.
        Open

        def create_api_gateway_integrations(api_id, resource_id, method, integrations=[], env=None):
        Severity: Minor
        Found in localstack/utils/aws/aws_stack.py - About 35 mins to fix

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

          def get_apigateway_path_for_resource(api_id, resource_id, path_suffix='', resources=None):
              if resources is None:
                  apigateway = connect_to_service(service_name='apigateway')
                  resources = apigateway.get_resources(restApiId=api_id, limit=100)
              target_resource = list(filter(lambda res: res['id'] == resource_id, resources))[0]
          Severity: Minor
          Found in localstack/utils/aws/aws_stack.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

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

              if resources is None:
                  apigateway = connect_to_service(service_name='apigateway')
                  resources = apigateway.get_resources(restApiId=api_id, limit=100)
          Severity: Minor
          Found in localstack/utils/aws/aws_stack.py and 1 other location - About 55 mins to fix
          localstack/utils/aws/aws_stack.py on lines 327..329

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

          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 resources is None:
                  apigateway = connect_to_service(service_name='apigateway')
                  resources = apigateway.get_resources(restApiId=api_id, limit=100)
          Severity: Minor
          Found in localstack/utils/aws/aws_stack.py and 1 other location - About 55 mins to fix
          localstack/utils/aws/aws_stack.py on lines 341..343

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

          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