avocado-framework/avocado

View on GitHub
avocado/core/job.py

Summary

Maintainability
D
2 days
Test Coverage
B
80%

Use of assert detected. The enclosed code will be removed when compiling to optimised byte code.
Open

        assert self.tmpdir is None, "Job.setup() already called"
Severity: Info
Found in avocado/core/job.py by bandit

Use of assert detected. The enclosed code will be removed when compiling to optimised byte code.
Open

        assert self.tmpdir is not None, "Job.setup() not called"
Severity: Info
Found in avocado/core/job.py by bandit

File job.py has 542 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
Severity: Major
Found in avocado/core/job.py - About 1 day to fix

    Job has 33 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class Job:
        """A Job is a set of operations performed on a test machine.
    
        Most of the time, we are interested in simply running tests,
        along with setup operations and event recording.
    Severity: Minor
    Found in avocado/core/job.py - About 4 hrs to fix

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

          def __start_job_logging(self):
              # Enable test logger
              fmt = ('%(asctime)s %(module)-16.16s L%(lineno)-.4d %('
                     'levelname)-5.5s| %(message)s')
              test_handler = output.add_log_handler(LOG_JOB,
      Severity: Minor
      Found in avocado/core/job.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 cleanup has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
      Open

          def cleanup(self):
              """
              Cleanup the temporary job handlers (dirs, global setting, ...)
              """
              output.del_last_configuration()
      Severity: Minor
      Found in avocado/core/job.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 run_tests has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Invalid

          def run_tests(self):
              """
              The actual test execution phase
              """
              self._log_job_debug_info()
      Severity: Minor
      Found in avocado/core/job.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

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

          def _update_latest_link(self):
              """
              Update the latest job result symbolic link [avocado-logs-dir]/latest.
              """
              def soft_abort(msg):
      Severity: Minor
      Found in avocado/core/job.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

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

          def run(self):
              """
              Runs all job phases, returning the test execution results.
      
              This method is supposed to be the simplified interface for
      Severity: Minor
      Found in avocado/core/job.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

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

          def get_failed_tests(self):
              """Gets the tests with status 'FAIL' and 'ERROR' after the Job ended.
      
              :return: List of failed tests
              """
      Severity: Minor
      Found in avocado/core/job.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

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

                      level = (int(name[1]) if name[1].isdigit()
                               else logging.getLevelName(name[1].upper()))
      Severity: Major
      Found in avocado/core/job.py and 1 other location - About 1 hr to fix
      avocado/core/output.py on lines 494..498

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

      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

          @property
          def timeout(self):
              if self._timeout is None:
                  self._timeout = self.config.get('job.run.timeout')
              return self._timeout
      Severity: Major
      Found in avocado/core/job.py and 1 other location - About 1 hr to fix
      avocado/core/suite.py on lines 226..230

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

      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 OSError:
                  msg = "Permission denied to link this job to category %s" % category
                  LOG_UI.warning(msg)
                  LOG_JOB.warning(msg)
      Severity: Minor
      Found in avocado/core/job.py and 1 other location - About 35 mins to fix
      avocado/core/job.py on lines 351..354

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

      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 NotImplementedError:
                  msg = "Unable to link this job to category %s" % category
                  LOG_UI.warning(msg)
                  LOG_JOB.warning(msg)
      Severity: Minor
      Found in avocado/core/job.py and 1 other location - About 35 mins to fix
      avocado/core/job.py on lines 355..358

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

      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