avocado-framework/avocado

View on GitHub
avocado/core/data_dir.py

Summary

Maintainability
C
1 day
Test Coverage
C
78%

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

    assert os.path.isdir(tmp_dir), msg
Severity: Info
Found in avocado/core/data_dir.py by bandit

Function get_job_results_dir has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
Open

def get_job_results_dir(job_ref, logs_dir=None):
    """
    Get the job results directory from a job reference.

    :param job_ref: job reference, which can be:
Severity: Minor
Found in avocado/core/data_dir.py - About 2 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

File data_dir.py has 266 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: Minor
Found in avocado/core/data_dir.py - About 2 hrs to fix

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

    def create_job_logs_dir(base_dir=None, unique_id=None):
        """
        Create a log directory for a job, or a stand alone execution of a test.
    
        :param base_dir: Base log directory, if `None`, use value from configuration.
    Severity: Minor
    Found in avocado/core/data_dir.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 None
    Severity: Major
    Found in avocado/core/data_dir.py - About 30 mins to fix

      Avoid too many return statements within this function.
      Open

              return os.path.dirname(match_file)
      Severity: Major
      Found in avocado/core/data_dir.py - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

            return None
        Severity: Major
        Found in avocado/core/data_dir.py - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                      return os.path.join(logs_dir, actual_dir)
          Severity: Major
          Found in avocado/core/data_dir.py - About 30 mins to fix

            There are no issues that match your filters.

            Category
            Status