saltstack/salt

View on GitHub
salt/utils/http.py

Summary

Maintainability
F
1 wk
Test Coverage

Function query has a Cognitive Complexity of 272 (exceeds 5 allowed). Consider refactoring.
Open

def query(url,
          method='GET',
          params=None,
          data=None,
          data_file=None,
Severity: Minor
Found in salt/utils/http.py - About 5 days 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 query. (143)
Open

@jinja_filter('http_query')
def query(url,
          method='GET',
          params=None,
          data=None,
Severity: Minor
Found in salt/utils/http.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

File http.py has 810 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
'''
Utils for making various web calls. Primarily designed for REST, SOAP, webhooks
and the like, but also useful for basic HTTP testing.

Severity: Major
Found in salt/utils/http.py - About 1 day to fix

    Function parse_cookie_header has a Cognitive Complexity of 43 (exceeds 5 allowed). Consider refactoring.
    Open

    def parse_cookie_header(header):
        '''
        Parse the "Set-cookie" header, and return a list of cookies.
    
        This function is here because Tornado's HTTPClient doesn't handle cookies.
    Severity: Minor
    Found in salt/utils/http.py - About 6 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 update_ca_bundle has a Cognitive Complexity of 23 (exceeds 5 allowed). Consider refactoring.
    Open

    def update_ca_bundle(
            target=None,
            source=None,
            opts=None,
            merge_files=None,
    Severity: Minor
    Found in salt/utils/http.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 get_ca_bundle has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
    Open

    def get_ca_bundle(opts=None):
        '''
        Return the location of the ca bundle file. See the following article:
    
            http://tinyurl.com/k7rx42a
    Severity: Minor
    Found in salt/utils/http.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

    Cyclomatic complexity is too high in function parse_cookie_header. (21)
    Open

    def parse_cookie_header(header):
        '''
        Parse the "Set-cookie" header, and return a list of cookies.
    
        This function is here because Tornado's HTTPClient doesn't handle cookies.
    Severity: Minor
    Found in salt/utils/http.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 sanitize_url has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
    Open

    def sanitize_url(url, hide_fields):
        '''
        Make sure no secret fields show up in logs
        '''
        if isinstance(hide_fields, list):
    Severity: Minor
    Found in salt/utils/http.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 query has 39 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    def query(url,
              method='GET',
              params=None,
              data=None,
              data_file=None,
    Severity: Minor
    Found in salt/utils/http.py - About 1 hr to fix

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

      def _render(template, render, renderer, template_dict, opts):
          '''
          Render a template
          '''
          if render:
      Severity: Minor
      Found in salt/utils/http.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 hasattr(ssl, 'SSLContext'):
                              # Python >= 2.7.9
                              context = ssl.SSLContext.load_cert_chain(*cert_chain)
                              handlers.append(urllib_request.HTTPSHandler(context=context))  # pylint: disable=E1123
                          else:
      Severity: Major
      Found in salt/utils/http.py - About 45 mins to fix

        Avoid deeply nested control flow statements.
        Open

                            for field in hide_fields:
                                if item == field:
                                    log_data[item] = 'XXXXXXXXXX'
                    log.trace('Request POST Data: %s', pprint.pformat(log_data))
        Severity: Major
        Found in salt/utils/http.py - About 45 mins to fix

          Avoid deeply nested control flow statements.
          Open

                              if isinstance(cert, six.string_types):
                                  if os.path.exists(cert):
                                      cert_chain = (cert)
                              elif isinstance(cert, list):
                                  if os.path.exists(cert[0]) and os.path.exists(cert[1]):
          Severity: Major
          Found in salt/utils/http.py - About 45 mins to fix

            Avoid too many return statements within this function.
            Open

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

              Avoid too many return statements within this function.
              Open

                      return certifi.where()
              Severity: Major
              Found in salt/utils/http.py - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                    return None
                Severity: Major
                Found in salt/utils/http.py - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

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

                    Avoid too many return statements within this function.
                    Open

                                return {
                    Severity: Major
                    Found in salt/utils/http.py - About 30 mins to fix

                      Avoid too many return statements within this function.
                      Open

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

                        Avoid too many return statements within this function.
                        Open

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

                          Avoid too many return statements within this function.
                          Open

                                                  return
                          Severity: Major
                          Found in salt/utils/http.py - About 30 mins to fix

                            Avoid too many return statements within this function.
                            Open

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

                              Avoid too many return statements within this function.
                              Open

                                          return {
                              Severity: Major
                              Found in salt/utils/http.py - About 30 mins to fix

                                Avoid too many return statements within this function.
                                Open

                                            return {'Error': six.text_type(exc)}
                                Severity: Major
                                Found in salt/utils/http.py - About 30 mins to fix

                                  Avoid too many return statements within this function.
                                  Open

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

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

                                    def __decompressContent(coding, pgctnt):
                                        '''
                                        Decompress returned HTTP content depending on the specified encoding.
                                        Currently supports identity/none, deflate, and gzip, which should
                                        cover 99%+ of the content on the internet.
                                    Severity: Minor
                                    Found in salt/utils/http.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

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

                                            if 'Content-Type' in result_headers:
                                                res_content_type, res_params = cgi.parse_header(result_headers['Content-Type'])
                                                if res_content_type.startswith('text/') and \
                                                        'charset' in res_params and \
                                                        not isinstance(result_text, six.text_type):
                                    Severity: Major
                                    Found in salt/utils/http.py and 1 other location - About 4 hrs to fix
                                    salt/utils/http.py on lines 589..594

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

                                    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 'Content-Type' in result_headers:
                                                res_content_type, res_params = cgi.parse_header(result_headers['Content-Type'])
                                                if res_content_type.startswith('text/') and \
                                                        'charset' in res_params and \
                                                        not isinstance(result_text, six.text_type):
                                    Severity: Major
                                    Found in salt/utils/http.py and 1 other location - About 4 hrs to fix
                                    salt/utils/http.py on lines 464..469

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

                                    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

                                    @jinja_filter('http_query')
                                    def query(url,
                                              method='GET',
                                              params=None,
                                              data=None,
                                    Severity: Major
                                    Found in salt/utils/http.py and 1 other location - About 1 hr to fix
                                    salt/modules/pip.py on lines 402..446

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

                                    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

                                    except ImportError:
                                        try:
                                            from backports.ssl_match_hostname import CertificateError
                                            from backports.ssl_match_hostname import match_hostname
                                            HAS_MATCHHOSTNAME = True
                                    Severity: Minor
                                    Found in salt/utils/http.py and 1 other location - About 35 mins to fix
                                    salt/cloud/clouds/joyent.py on lines 68..78

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

                                    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