librenms/librenms

View on GitHub
LibreNMS/Alert/Transport/Canopsis.php

Summary

Maintainability
C
1 day
Test Coverage

Method contactCanopsis has 45 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function contactCanopsis($obj, $opts)
    {
        // Configurations
        $host = $opts['host'];
        $port = $opts['port'];
Severity: Minor
Found in LibreNMS/Alert/Transport/Canopsis.php - About 1 hr to fix

    Method configTemplate has 41 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public static function configTemplate()
        {
            return [
                'config' => [
                    [
    Severity: Minor
    Found in LibreNMS/Alert/Transport/Canopsis.php - About 1 hr to fix

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

          public function contactCanopsis($obj, $opts)
          {
              // Configurations
              $host = $opts['host'];
              $port = $opts['port'];
      Severity: Minor
      Found in LibreNMS/Alert/Transport/Canopsis.php - 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

      The method contactCanopsis uses an else expression. Else is never necessary and you can simplify the code to work without else.
      Open

              } else {
                  $msg_rk = $msg_body['connector'] . '.' . $msg_body['connector_name'] . '.' . $msg_body['event_type'] . '.' . $msg_body['source_type'] . '.' . $msg_body['component'];
              }
      Severity: Minor
      Found in LibreNMS/Alert/Transport/Canopsis.php by phpmd

      Since: PHPMD 1.4.0

      An if expression with an else branch is never necessary. You can rewrite the conditions in a way that the else is not necessary and the code becomes simpler to read. To achieve this use early return statements. To achieve this you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

      Example:

      class Foo
        {
            public function bar($flag)
            {
                if ($flag) {
                    // one branch
                } else {
                    // another branch
                }
            }
        }

      Source: http://phpmd.org/rules/cleancode.txt

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

          public static function configTemplate()
          {
              return [
                  'config' => [
                      [
      Severity: Major
      Found in LibreNMS/Alert/Transport/Canopsis.php and 1 other location - About 5 hrs to fix
      LibreNMS/Alert/Transport/Jira.php on lines 93..136

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

      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

          public function deliverAlert($obj, $opts)
          {
              if (! empty($this->config)) {
                  $opts['host'] = $this->config['canopsis-host'];
                  $opts['port'] = $this->config['canopsis-port'];
      Severity: Major
      Found in LibreNMS/Alert/Transport/Canopsis.php and 1 other location - About 2 hrs to fix
      LibreNMS/Alert/Transport/Jira.php on lines 29..40

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

      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

      Avoid variables with short names like $ch. Configured minimum length is 3.
      Open

              $ch = $conn->channel();
      Severity: Minor
      Found in LibreNMS/Alert/Transport/Canopsis.php by phpmd

      Since: PHPMD 0.2

      Detects when a field, local, or parameter has a very short name.

      Example:

      class Something {
            private $q = 15; // VIOLATION - Field
            public static function main( array $as ) { // VIOLATION - Formal
                $r = 20 + $this->q; // VIOLATION - Local
                for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
                    $r += $this->q;
                }
            }
        }

      Source: http://phpmd.org/rules/naming.txt

      There are no issues that match your filters.

      Category
      Status