saltstack/salt

View on GitHub
salt/renderers/aws_kms.py

Summary

Maintainability
C
1 day
Test Coverage

Function _decrypt_object has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
Open

def _decrypt_object(obj, translate_newlines=False):
    '''
    Recursively try to decrypt any object.
    Recur on objects that are not strings.
    Decrypt strings that are valid Fernet tokens.
Severity: Minor
Found in salt/renderers/aws_kms.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

Avoid too many return statements within this function.
Open

        return obj
Severity: Major
Found in salt/renderers/aws_kms.py - About 30 mins to fix

    Avoid too many return statements within this function.
    Open

            return obj
    Severity: Major
    Found in salt/renderers/aws_kms.py - About 30 mins to fix

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

      def _session():
          '''
          Return the boto3 session to use for the KMS client.
      
          If aws_kms:profile_name is set in the salt configuration, use that profile.
      Severity: Minor
      Found in salt/renderers/aws_kms.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 isinstance(obj, six.string_types):
              try:
                  return _decrypt_ciphertext(obj,
                                             translate_newlines=translate_newlines)
              except (fernet.InvalidToken, TypeError):
      Severity: Major
      Found in salt/renderers/aws_kms.py and 1 other location - About 5 hrs to fix
      salt/renderers/gpg.py on lines 394..407

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

      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 botocore.exceptions.NoRegionError as orig_exc:
              err_msg = ('Boto3 was unable to determine the AWS '
                         'endpoint region using the {} profile.').format(profile_name or 'default')
              config_error = salt.exceptions.SaltConfigurationError(err_msg)
              six.raise_from(config_error, orig_exc)
      Severity: Major
      Found in salt/renderers/aws_kms.py and 1 other location - About 1 hr to fix
      salt/renderers/aws_kms.py on lines 142..146

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

      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 botocore.exceptions.ProfileNotFound as orig_exc:
              err_msg = 'Boto3 could not find the "{}" profile configured in Salt.'.format(
                      profile_name or 'default')
              config_error = salt.exceptions.SaltConfigurationError(err_msg)
              six.raise_from(config_error, orig_exc)
      Severity: Major
      Found in salt/renderers/aws_kms.py and 1 other location - About 1 hr to fix
      salt/renderers/aws_kms.py on lines 147..151

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

      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