Sign upLogin

howardjones/network-weathermap

View on GitHub
Star
lib/Weathermap/Tests/ConfigTest.php

Summary

Maintainability
C
1 day
Test Coverage

Method testConfigOutput has 53 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function testConfigOutput($configFileName, $referenceImageFileName)
    {
        $outputImageFileName = self::$result1Directory . DIRECTORY_SEPARATOR . $configFileName . ".png";
        $comparisonImageFileName = self::$diffsDirectory . DIRECTORY_SEPARATOR . $configFileName . ".png";
        $outputHTMLFileName = self::$result1Directory . DIRECTORY_SEPARATOR . $configFileName . ".html";
Severity: Major
Found in lib/Weathermap/Tests/ConfigTest.php - About 2 hrs to fix

    Method configlist has 53 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function configlist()
    {
        self::checkPaths();

        $summaryFileName = self::$testSuiteDirectory . DIRECTORY_SEPARATOR . "summary.html";
    Severity: Major
    Found in lib/Weathermap/Tests/ConfigTest.php - About 2 hrs to fix

      Method checkPaths has 43 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private function checkPaths()
    {
        $version = explode('.', PHP_VERSION);
        self::$phpTag = "php-" . $version[0] . "." . $version[1];
      Severity: Minor
      Found in lib/Weathermap/Tests/ConfigTest.php - About 1 hr to fix

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

            public function configlist()
    {
        self::checkPaths();

        $summaryFileName = self::$testSuiteDirectory . DIRECTORY_SEPARATOR . "summary.html";
        Severity: Minor
        Found in lib/Weathermap/Tests/ConfigTest.php - 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 checkPaths has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
        Open

            private function checkPaths()
    {
        $version = explode('.', PHP_VERSION);
        self::$phpTag = "php-" . $version[0] . "." . $version[1];
        Severity: Minor
        Found in lib/Weathermap/Tests/ConfigTest.php - 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

        Remove this commented out code.
        Open

        //require_once dirname(__FILE__) . '/TestSupport.php';
        Severity: Major
        Found in lib/Weathermap/Tests/ConfigTest.php by sonar-php

        Programmers should not comment out code as it bloats programs and reduces readability.

        Unused code should be deleted and can be retrieved from source control history if required.

        See

        • MISRA C:2004, 2.4 - Sections of code should not be "commented out".
        • MISRA C++:2008, 2-7-2 - Sections of code shall not be "commented out" using C-style comments.
        • MISRA C++:2008, 2-7-3 - Sections of code should not be "commented out" using C++ comments.
        • MISRA C:2012, Dir. 4.4 - Sections of code should not be "commented out"

        Define and throw a dedicated exception instead of using a generic one.
        Open

                    throw new \Exception("Failed to open summary file: $summaryFileName");
        Severity: Major
        Found in lib/Weathermap/Tests/ConfigTest.php by sonar-php

        If you throw a general exception type, such as ErrorException, RuntimeException, or Exception in a library or framework, it forces consumers to catch all exceptions, including unknown exceptions that they do not know how to handle.

        Instead, either throw a subtype that already exists in the Standard PHP Library, or create your own type that derives from Exception.

        Noncompliant Code Example

        throw new Exception();  // Noncompliant

        Compliant Solution

        throw new InvalidArgumentException();
// or
throw new UnexpectedValueException();

        See

        Remove this commented out code.
        Open

        //require_once dirname(__FILE__) . '/../lib/all.php';
        Severity: Major
        Found in lib/Weathermap/Tests/ConfigTest.php by sonar-php

        Programmers should not comment out code as it bloats programs and reduces readability.

        Unused code should be deleted and can be retrieved from source control history if required.

        See

        • MISRA C:2004, 2.4 - Sections of code should not be "commented out".
        • MISRA C++:2008, 2-7-2 - Sections of code shall not be "commented out" using C-style comments.
        • MISRA C++:2008, 2-7-3 - Sections of code should not be "commented out" using C++ comments.
        • MISRA C:2012, Dir. 4.4 - Sections of code should not be "commented out"

        Define a constant instead of duplicating this literal "references/" 3 times.
        Open

                        $referenceURL = "references/" . $file . ".png";
        Severity: Critical
        Found in lib/Weathermap/Tests/ConfigTest.php by sonar-php

        Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

        On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

        Noncompliant Code Example

        With the default threshold of 3:

        function run() {
  prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
  execute('action1');
  release('action1');
}

        Compliant Solution

        ACTION_1 = 'action1';

function run() {
  prepare(ACTION_1);
  execute(ACTION_1);
  release(ACTION_1);
}

        Exceptions

        To prevent generating some false-positives, literals having less than 5 characters are excluded.

        Rename "$osTag" which has the same name as the field declared at line 19.
        Open

                $osTag = self::$osTag;
        Severity: Major
        Found in lib/Weathermap/Tests/ConfigTest.php by sonar-php

        Shadowing fields with a local variable is a bad practice that reduces code readability: it makes it confusing to know whether the field or the variable is being used.

        Noncompliant Code Example

        class Foo {
  public $myField;

  public function doSomething() {
    $myField = 0;
    ...
  }
}

        See

        Remove this commented out code.
        Open

                    // chdir($previouswd);
        Severity: Major
        Found in lib/Weathermap/Tests/ConfigTest.php by sonar-php

        Programmers should not comment out code as it bloats programs and reduces readability.

        Unused code should be deleted and can be retrieved from source control history if required.

        See

        • MISRA C:2004, 2.4 - Sections of code should not be "commented out".
        • MISRA C++:2008, 2-7-2 - Sections of code shall not be "commented out" using C-style comments.
        • MISRA C++:2008, 2-7-3 - Sections of code should not be "commented out" using C++ comments.
        • MISRA C:2012, Dir. 4.4 - Sections of code should not be "commented out"

        Remove this commented out code.
        Open

        //    protected static $confdir;
        Severity: Major
        Found in lib/Weathermap/Tests/ConfigTest.php by sonar-php

        Programmers should not comment out code as it bloats programs and reduces readability.

        Unused code should be deleted and can be retrieved from source control history if required.

        See

        • MISRA C:2004, 2.4 - Sections of code should not be "commented out".
        • MISRA C++:2008, 2-7-2 - Sections of code shall not be "commented out" using C-style comments.
        • MISRA C++:2008, 2-7-3 - Sections of code should not be "commented out" using C++ comments.
        • MISRA C:2012, Dir. 4.4 - Sections of code should not be "commented out"

        Remove this commented out code.
        Open

        //        $osTag = $osCodename . "-" . self::$phpTag;
        Severity: Major
        Found in lib/Weathermap/Tests/ConfigTest.php by sonar-php

        Programmers should not comment out code as it bloats programs and reduces readability.

        Unused code should be deleted and can be retrieved from source control history if required.

        See

        • MISRA C:2004, 2.4 - Sections of code should not be "commented out".
        • MISRA C++:2008, 2-7-2 - Sections of code shall not be "commented out" using C-style comments.
        • MISRA C++:2008, 2-7-3 - Sections of code should not be "commented out" using C++ comments.
        • MISRA C:2012, Dir. 4.4 - Sections of code should not be "commented out"

        Remove this commented out code.
        Open

        //        self::$phpTag = $phpTag;
        Severity: Major
        Found in lib/Weathermap/Tests/ConfigTest.php by sonar-php

        Programmers should not comment out code as it bloats programs and reduces readability.

        Unused code should be deleted and can be retrieved from source control history if required.

        See

        • MISRA C:2004, 2.4 - Sections of code should not be "commented out".
        • MISRA C++:2008, 2-7-2 - Sections of code shall not be "commented out" using C-style comments.
        • MISRA C++:2008, 2-7-3 - Sections of code should not be "commented out" using C++ comments.
        • MISRA C:2012, Dir. 4.4 - Sections of code should not be "commented out"

        Define and throw a dedicated exception instead of using a generic one.
        Open

                    throw new \Exception("Compare path doesn't exist (or isn't executable) - do you have Imagemagick? \n");
        Severity: Major
        Found in lib/Weathermap/Tests/ConfigTest.php by sonar-php

        If you throw a general exception type, such as ErrorException, RuntimeException, or Exception in a library or framework, it forces consumers to catch all exceptions, including unknown exceptions that they do not know how to handle.

        Instead, either throw a subtype that already exists in the Standard PHP Library, or create your own type that derives from Exception.

        Noncompliant Code Example

        throw new Exception();  // Noncompliant

        Compliant Solution

        throw new InvalidArgumentException();
// or
throw new UnexpectedValueException();

        See

        There are no issues that match your filters.

        Category
        Status