renoki-co/php-k8s

View on GitHub
src/Traits/Cluster/LoadsFromKubeConfig.php

Summary

Maintainability
B
5 hrs
Test Coverage

fromKubeConfigVariable accesses the super-global variable $_SERVER.
Open

    public static function fromKubeConfigVariable(string $context = null)
    {
        /** @var \RenokiCo\PhpK8s\KubernetesCluster $this */
        $cluster = new static;

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

fromKubeConfigVariable accesses the super-global variable $_SERVER.
Open

    public static function fromKubeConfigVariable(string $context = null)
    {
        /** @var \RenokiCo\PhpK8s\KubernetesCluster $this */
        $cluster = new static;

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

Method loadKubeConfigFromArray has 78 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    protected function loadKubeConfigFromArray(array $kubeconfig, string $context = null)
    {
        /** @var \RenokiCo\PhpK8s\KubernetesCluster $this */

        // Compute the context from the method, or in case it is passed as null
Severity: Major
Found in src/Traits/Cluster/LoadsFromKubeConfig.php - About 3 hrs to fix

    Function loadKubeConfigFromArray has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
    Open

        protected function loadKubeConfigFromArray(array $kubeconfig, string $context = null)
        {
            /** @var \RenokiCo\PhpK8s\KubernetesCluster $this */
    
            // Compute the context from the method, or in case it is passed as null
    Severity: Minor
    Found in src/Traits/Cluster/LoadsFromKubeConfig.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 fromKubeConfigVariable has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

        public static function fromKubeConfigVariable(string $context = null)
        {
            /** @var \RenokiCo\PhpK8s\KubernetesCluster $this */
            $cluster = new static;
    
    
    Severity: Minor
    Found in src/Traits/Cluster/LoadsFromKubeConfig.php - About 55 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

    The method loadKubeConfigFromArray() has 106 lines of code. Current threshold is set to 100. Avoid really long methods.
    Open

        protected function loadKubeConfigFromArray(array $kubeconfig, string $context = null)
        {
            /** @var \RenokiCo\PhpK8s\KubernetesCluster $this */
    
            // Compute the context from the method, or in case it is passed as null

    The method loadKubeConfigFromArray() has an NPath complexity of 49152. The configured NPath complexity threshold is 200.
    Open

        protected function loadKubeConfigFromArray(array $kubeconfig, string $context = null)
        {
            /** @var \RenokiCo\PhpK8s\KubernetesCluster $this */
    
            // Compute the context from the method, or in case it is passed as null

    NPathComplexity

    Since: 0.1

    The NPath complexity of a method is the number of acyclic execution paths through that method. A threshold of 200 is generally considered the point where measures should be taken to reduce complexity.

    Example

    class Foo {
        function bar() {
            // lots of complicated code
        }
    }

    Source https://phpmd.org/rules/codesize.html#npathcomplexity

    The method loadKubeConfigFromArray() has a Cyclomatic Complexity of 17. The configured cyclomatic complexity threshold is 10.
    Open

        protected function loadKubeConfigFromArray(array $kubeconfig, string $context = null)
        {
            /** @var \RenokiCo\PhpK8s\KubernetesCluster $this */
    
            // Compute the context from the method, or in case it is passed as null

    CyclomaticComplexity

    Since: 0.1

    Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.

    Example

    // Cyclomatic Complexity = 11
    class Foo {
    1   public function example() {
    2       if ($a == $b) {
    3           if ($a1 == $b1) {
                    fiddle();
    4           } elseif ($a2 == $b2) {
                    fiddle();
                } else {
                    fiddle();
                }
    5       } elseif ($c == $d) {
    6           while ($c == $d) {
                    fiddle();
                }
    7        } elseif ($e == $f) {
    8           for ($n = 0; $n < $h; $n++) {
                    fiddle();
                }
            } else {
                switch ($z) {
    9               case 1:
                        fiddle();
                        break;
    10              case 2:
                        fiddle();
                        break;
    11              case 3:
                        fiddle();
                        break;
                    default:
                        fiddle();
                        break;
                }
            }
        }
    }

    Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity

    Remove error control operator '@' on line 60.
    Open

        public static function fromKubeConfigVariable(string $context = null)
        {
            /** @var \RenokiCo\PhpK8s\KubernetesCluster $this */
            $cluster = new static;
    
    

    ErrorControlOperator

    Error suppression should be avoided if possible as it doesn't just suppress the error, that you are trying to stop, but will also suppress errors that you didn't predict would ever occur. Consider changing error_reporting() level and/or setting up your own error handler.

    Example

    function foo($filePath) {
        $file = @fopen($filPath); // hides exceptions
        $key = @$array[$notExistingKey]; // assigns null to $key
    }

    Source http://phpmd.org/rules/cleancode.html#errorcontroloperator

    Avoid using static access to class '\Illuminate\Support\Arr' in method 'mergeKubeconfigContents'.
    Open

                    ! Arr::isAssoc($value) &&

    StaticAccess

    Since: 1.4.0

    Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

    Example

    class Foo
    {
        public function bar()
        {
            Bar::baz();
        }
    }

    Source https://phpmd.org/rules/cleancode.html#staticaccess

    Avoid assigning values to variables in if clauses and the like (line '157', column '15').
    Open

        protected function loadKubeConfigFromArray(array $kubeconfig, string $context = null)
        {
            /** @var \RenokiCo\PhpK8s\KubernetesCluster $this */
    
            // Compute the context from the method, or in case it is passed as null

    IfStatementAssignment

    Since: 2.7.0

    Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

    Example

    class Foo
    {
        public function bar($flag)
        {
            if ($foo = 'bar') { // possible typo
                // ...
            }
            if ($baz = 0) { // always false
                // ...
            }
        }
    }

    Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

    Avoid assigning values to variables in if clauses and the like (line '151', column '15').
    Open

        protected function loadKubeConfigFromArray(array $kubeconfig, string $context = null)
        {
            /** @var \RenokiCo\PhpK8s\KubernetesCluster $this */
    
            // Compute the context from the method, or in case it is passed as null

    IfStatementAssignment

    Since: 2.7.0

    Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

    Example

    class Foo
    {
        public function bar($flag)
        {
            if ($foo = 'bar') { // possible typo
                // ...
            }
            if ($baz = 0) { // always false
                // ...
            }
        }
    }

    Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

    Avoid using static access to class '\RenokiCo\PhpK8s\Kinds\K8sResource' in method 'loadKubeConfigFromArray'.
    Open

                K8sResource::setDefaultNamespace($contextConfig['context']['namespace']);

    StaticAccess

    Since: 1.4.0

    Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

    Example

    class Foo
    {
        public function bar()
        {
            Bar::baz();
        }
    }

    Source https://phpmd.org/rules/cleancode.html#staticaccess

    Avoid using static access to class '\Illuminate\Support\Arr' in method 'mergeKubeconfigContents'.
    Open

                    ! Arr::isAssoc($kubeconfig2[$key])

    StaticAccess

    Since: 1.4.0

    Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

    Example

    class Foo
    {
        public function bar()
        {
            Bar::baz();
        }
    }

    Source https://phpmd.org/rules/cleancode.html#staticaccess

    Avoid assigning values to variables in if clauses and the like (line '60', column '43').
    Open

        public static function fromKubeConfigVariable(string $context = null)
        {
            /** @var \RenokiCo\PhpK8s\KubernetesCluster $this */
            $cluster = new static;
    
    

    IfStatementAssignment

    Since: 2.7.0

    Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

    Example

    class Foo
    {
        public function bar($flag)
        {
            if ($foo = 'bar') { // possible typo
                // ...
            }
            if ($baz = 0) { // always false
                // ...
            }
        }
    }

    Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

    Avoid using static access to class '\Illuminate\Support\Str' in method 'writeTempFileForContext'.
    Open

            $tempFilePath = $tempFolder.DIRECTORY_SEPARATOR.Str::slug("ctx-{$context}-{$userName}-{$url}")."-{$fileName}";

    StaticAccess

    Since: 1.4.0

    Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

    Example

    class Foo
    {
        public function bar()
        {
            Bar::baz();
        }
    }

    Source https://phpmd.org/rules/cleancode.html#staticaccess

    Line exceeds 120 characters; contains 123 characters
    Open

                throw new KubeConfigClusterNotFound("The cluster {$cluster} does not exist in the provided Kube Config file.");

    Line exceeds 120 characters; contains 132 characters
    Open

            if (isset($clusterConfig['cluster']['insecure-skip-tls-verify']) && $clusterConfig['cluster']['insecure-skip-tls-verify']) {

    Line exceeds 120 characters; contains 123 characters
    Open

                throw new KubeConfigContextNotFound("The context {$context} does not exist in the provided Kube Config file.");

    Expected 0 spaces after opening bracket; newline found
    Open

                if (

    There are no issues that match your filters.

    Category
    Status