ComplianceAsCode/content

View on GitHub
tests/automatus.py

Summary

Maintainability
D
1 day
Test Coverage

File automatus.py has 433 lines of code (exceeds 400 allowed). Consider refactoring.
Open

#!/usr/bin/python3
from __future__ import print_function

import argparse
import contextlib
Severity: Minor
Found in tests/automatus.py - About 2 hrs to fix

    Cyclomatic complexity is too high in function normalize_passed_arguments. (13)
    Open

    def normalize_passed_arguments(options):
        targets = []
        for target in options.target:
            if ',' in target:
                targets.extend(target.split(","))
    Severity: Minor
    Found in tests/automatus.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 parse_args has 52 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    def parse_args():
        parser = argparse.ArgumentParser()
    
        common_parser = argparse.ArgumentParser(add_help=False)
        common_parser.set_defaults(test_env=None)
    Severity: Major
    Found in tests/automatus.py - About 2 hrs to fix

      Function normalize_passed_arguments has a Cognitive Complexity of 16 (exceeds 7 allowed). Consider refactoring.
      Open

      def normalize_passed_arguments(options):
          targets = []
          for target in options.target:
              if ',' in target:
                  targets.extend(target.split(","))
      Severity: Minor
      Found in tests/automatus.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

      Refactor this function to reduce its Cognitive Complexity from 16 to the 15 allowed.
      Open

      def normalize_passed_arguments(options):
      Severity: Critical
      Found in tests/automatus.py by sonar-python

      Cognitive Complexity is a measure of how hard the control flow of a function is to understand. Functions with high Cognitive Complexity will be difficult to maintain.

      See

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

          try:
              bench_id = xml_operations.infer_benchmark_id_from_component_ref_id(
                  options.datastream, options.xccdf_id)
              options.benchmark_id = bench_id
          except RuntimeError as exc:
      Severity: Major
      Found in tests/automatus.py and 1 other location - About 2 hrs to fix
      tests/automatus.py on lines 465..472

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

      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

          try:
              benchmark_cpes = xml_operations.benchmark_get_applicable_platforms(
                  options.datastream, options.benchmark_id
              )
              options.benchmark_cpes = benchmark_cpes
      Severity: Major
      Found in tests/automatus.py and 1 other location - About 2 hrs to fix
      tests/automatus.py on lines 429..435

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

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

          parser_rule.add_argument("--slice",
                                   dest='_slices',
                                   # real dest is postprocessed later:
                                   # 'slice_current' and 'slice_total'
                                   metavar=('X', 'Y'),
      Severity: Major
      Found in tests/automatus.py and 2 other locations - About 40 mins to fix
      tests/automatus.py on lines 244..249
      tests/automatus.py on lines 284..289

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

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

          parser_combined.add_argument("--slice",
                                       dest='_slices',
                                       # real dest is postprocessed later:
                                       # 'slice_current' and 'slice_total'
                                       metavar=('X', 'Y'),
      Severity: Major
      Found in tests/automatus.py and 2 other locations - About 40 mins to fix
      tests/automatus.py on lines 216..221
      tests/automatus.py on lines 284..289

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

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

          parser_template.add_argument("--slice",
                                       dest='_slices',
                                       # real dest is postprocessed later:
                                       # 'slice_current' and 'slice_total'
                                       metavar=('X', 'Y'),
      Severity: Major
      Found in tests/automatus.py and 2 other locations - About 40 mins to fix
      tests/automatus.py on lines 216..221
      tests/automatus.py on lines 244..249

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

      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

      Module level import not at top of file
      Open

      import ssg_test_suite.template
      Severity: Minor
      Found in tests/automatus.py by pep8

      Place imports at the top of the file.

      Always put imports at the top of the file, just after any module
      comments and docstrings, and before module globals and constants.
      
      Okay: import os
      Okay: # this is a comment\nimport os
      Okay: '''this is a module docstring'''\nimport os
      Okay: r'''this is a module docstring'''\nimport os
      Okay:
      try:\n\timport x\nexcept ImportError:\n\tpass\nelse:\n\tpass\nimport y
      Okay:
      try:\n\timport x\nexcept ImportError:\n\tpass\nfinally:\n\tpass\nimport y
      E402: a=1\nimport os
      E402: 'One string'\n"Two string"\nimport os
      E402: a=1\nfrom sys import x
      
      Okay: if x:\n    import os

      Module level import not at top of file
      Open

      import ssg_test_suite.test_env
      Severity: Minor
      Found in tests/automatus.py by pep8

      Place imports at the top of the file.

      Always put imports at the top of the file, just after any module
      comments and docstrings, and before module globals and constants.
      
      Okay: import os
      Okay: # this is a comment\nimport os
      Okay: '''this is a module docstring'''\nimport os
      Okay: r'''this is a module docstring'''\nimport os
      Okay:
      try:\n\timport x\nexcept ImportError:\n\tpass\nelse:\n\tpass\nimport y
      Okay:
      try:\n\timport x\nexcept ImportError:\n\tpass\nfinally:\n\tpass\nimport y
      E402: a=1\nimport os
      E402: 'One string'\n"Two string"\nimport os
      E402: a=1\nfrom sys import x
      
      Okay: if x:\n    import os

      Line too long (100 > 99 characters)
      Open

                          from a data stream use `ds_unselect_rules.sh` script. List of such rules already
      Severity: Minor
      Found in tests/automatus.py by pep8

      Limit all lines to a maximum of 79 characters.

      There are still many devices around that are limited to 80 character
      lines; plus, limiting windows to 80 characters makes it possible to
      have several windows side-by-side.  The default wrapping on such
      devices looks ugly.  Therefore, please limit all lines to a maximum
      of 79 characters. For flowing long blocks of text (docstrings or
      comments), limiting the length to 72 characters is recommended.
      
      Reports error E501.

      Module level import not at top of file
      Open

      from ssg_test_suite.log import LogHelper
      Severity: Minor
      Found in tests/automatus.py by pep8

      Place imports at the top of the file.

      Always put imports at the top of the file, just after any module
      comments and docstrings, and before module globals and constants.
      
      Okay: import os
      Okay: # this is a comment\nimport os
      Okay: '''this is a module docstring'''\nimport os
      Okay: r'''this is a module docstring'''\nimport os
      Okay:
      try:\n\timport x\nexcept ImportError:\n\tpass\nelse:\n\tpass\nimport y
      Okay:
      try:\n\timport x\nexcept ImportError:\n\tpass\nfinally:\n\tpass\nimport y
      E402: a=1\nimport os
      E402: 'One string'\n"Two string"\nimport os
      E402: a=1\nfrom sys import x
      
      Okay: if x:\n    import os

      Module level import not at top of file
      Open

      from ssg_test_suite import xml_operations
      Severity: Minor
      Found in tests/automatus.py by pep8

      Place imports at the top of the file.

      Always put imports at the top of the file, just after any module
      comments and docstrings, and before module globals and constants.
      
      Okay: import os
      Okay: # this is a comment\nimport os
      Okay: '''this is a module docstring'''\nimport os
      Okay: r'''this is a module docstring'''\nimport os
      Okay:
      try:\n\timport x\nexcept ImportError:\n\tpass\nelse:\n\tpass\nimport y
      Okay:
      try:\n\timport x\nexcept ImportError:\n\tpass\nfinally:\n\tpass\nimport y
      E402: a=1\nimport os
      E402: 'One string'\n"Two string"\nimport os
      E402: a=1\nfrom sys import x
      
      Okay: if x:\n    import os

      Module level import not at top of file
      Open

      import ssg_test_suite.rule
      Severity: Minor
      Found in tests/automatus.py by pep8

      Place imports at the top of the file.

      Always put imports at the top of the file, just after any module
      comments and docstrings, and before module globals and constants.
      
      Okay: import os
      Okay: # this is a comment\nimport os
      Okay: '''this is a module docstring'''\nimport os
      Okay: r'''this is a module docstring'''\nimport os
      Okay:
      try:\n\timport x\nexcept ImportError:\n\tpass\nelse:\n\tpass\nimport y
      Okay:
      try:\n\timport x\nexcept ImportError:\n\tpass\nfinally:\n\tpass\nimport y
      E402: a=1\nimport os
      E402: 'One string'\n"Two string"\nimport os
      E402: a=1\nfrom sys import x
      
      Okay: if x:\n    import os

      Module level import not at top of file
      Open

      import ssg_test_suite.profile
      Severity: Minor
      Found in tests/automatus.py by pep8

      Place imports at the top of the file.

      Always put imports at the top of the file, just after any module
      comments and docstrings, and before module globals and constants.
      
      Okay: import os
      Okay: # this is a comment\nimport os
      Okay: '''this is a module docstring'''\nimport os
      Okay: r'''this is a module docstring'''\nimport os
      Okay:
      try:\n\timport x\nexcept ImportError:\n\tpass\nelse:\n\tpass\nimport y
      Okay:
      try:\n\timport x\nexcept ImportError:\n\tpass\nfinally:\n\tpass\nimport y
      E402: a=1\nimport os
      E402: 'One string'\n"Two string"\nimport os
      E402: a=1\nfrom sys import x
      
      Okay: if x:\n    import os

      Module level import not at top of file
      Open

      from ssg.constants import DERIVATIVES_PRODUCT_MAPPING
      Severity: Minor
      Found in tests/automatus.py by pep8

      Place imports at the top of the file.

      Always put imports at the top of the file, just after any module
      comments and docstrings, and before module globals and constants.
      
      Okay: import os
      Okay: # this is a comment\nimport os
      Okay: '''this is a module docstring'''\nimport os
      Okay: r'''this is a module docstring'''\nimport os
      Okay:
      try:\n\timport x\nexcept ImportError:\n\tpass\nelse:\n\tpass\nimport y
      Okay:
      try:\n\timport x\nexcept ImportError:\n\tpass\nfinally:\n\tpass\nimport y
      E402: a=1\nimport os
      E402: 'One string'\n"Two string"\nimport os
      E402: a=1\nfrom sys import x
      
      Okay: if x:\n    import os

      Module level import not at top of file
      Open

      import ssg_test_suite.oscap
      Severity: Minor
      Found in tests/automatus.py by pep8

      Place imports at the top of the file.

      Always put imports at the top of the file, just after any module
      comments and docstrings, and before module globals and constants.
      
      Okay: import os
      Okay: # this is a comment\nimport os
      Okay: '''this is a module docstring'''\nimport os
      Okay: r'''this is a module docstring'''\nimport os
      Okay:
      try:\n\timport x\nexcept ImportError:\n\tpass\nelse:\n\tpass\nimport y
      Okay:
      try:\n\timport x\nexcept ImportError:\n\tpass\nfinally:\n\tpass\nimport y
      E402: a=1\nimport os
      E402: 'One string'\n"Two string"\nimport os
      E402: a=1\nfrom sys import x
      
      Okay: if x:\n    import os

      Module level import not at top of file
      Open

      import ssg_test_suite.combined
      Severity: Minor
      Found in tests/automatus.py by pep8

      Place imports at the top of the file.

      Always put imports at the top of the file, just after any module
      comments and docstrings, and before module globals and constants.
      
      Okay: import os
      Okay: # this is a comment\nimport os
      Okay: '''this is a module docstring'''\nimport os
      Okay: r'''this is a module docstring'''\nimport os
      Okay:
      try:\n\timport x\nexcept ImportError:\n\tpass\nelse:\n\tpass\nimport y
      Okay:
      try:\n\timport x\nexcept ImportError:\n\tpass\nfinally:\n\tpass\nimport y
      E402: a=1\nimport os
      E402: 'One string'\n"Two string"\nimport os
      E402: a=1\nfrom sys import x
      
      Okay: if x:\n    import os

      There are no issues that match your filters.

      Category
      Status