sensu-plugins/sensu-plugins-victorops

View on GitHub
bin/handler-victorops.rb

Summary

Maintainability
C
1 day
Test Coverage

Method dry_run has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
Open

  def dry_run(api_url, routing_key, uri, payload)
    return unless config[:dryrun]

    puts 'Dryrun: reporting settings and exiting'
    puts "  option settingsname set: #{config[:settingsname]}"
Severity: Minor
Found in bin/handler-victorops.rb - 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

Method handle has 52 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  def handle
    # validate that we have a client defined
    unless defined?(@event['client']) && !@event['client']['name'].nil?
      raise 'victorops.rb sensu client not found or has no name. If using with Sensu Go please ensure you have enabled event mapping'
    end
Severity: Major
Found in bin/handler-victorops.rb - About 2 hrs to fix

    Method dry_run has 40 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      def dry_run(api_url, routing_key, uri, payload)
        return unless config[:dryrun]
    
        puts 'Dryrun: reporting settings and exiting'
        puts "  option settingsname set: #{config[:settingsname]}"
    Severity: Minor
    Found in bin/handler-victorops.rb - About 1 hr to fix

      Method handle has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
      Open

        def handle
          # validate that we have a client defined
          unless defined?(@event['client']) && !@event['client']['name'].nil?
            raise 'victorops.rb sensu client not found or has no name. If using with Sensu Go please ensure you have enabled event mapping'
          end
      Severity: Minor
      Found in bin/handler-victorops.rb - 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

      Method set_api_url has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
      Open

        def set_api_url
          # validate that we have an api url - environment variables take precedence
          api_url = ENV['VICTOROPS_API_URL']
          api_url = config[:api_url] if api_url.nil?
          if api_url.nil?
      Severity: Minor
      Found in bin/handler-victorops.rb - 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

      Method set_routing_key has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Open

        def set_routing_key
          # validate that we have a routing key - environment variables take precedence
          routing_key = ENV['VICTOROPS_ROUTING_KEY']
          routing_key = config[:routing_key] if routing_key.nil?
          if routing_key.nil?
      Severity: Minor
      Found in bin/handler-victorops.rb - 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

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

          if routing_key.nil?
            # validate that we have a settings name in the config
            if defined?(settings[config[:settingsname]]) && !settings[config[:settingsname]].nil?
              routing_key = settings[config[:settingsname]]['routing_key']
            else
      Severity: Minor
      Found in bin/handler-victorops.rb and 1 other location - About 40 mins to fix
      bin/handler-victorops.rb on lines 52..58

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

      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

          if api_url.nil?
            # validate that we have a settings name
            if defined?(settings[config[:settingsname]]) && !settings[config[:settingsname]].nil?
              api_url = settings[config[:settingsname]]['api_url']
            else
      Severity: Minor
      Found in bin/handler-victorops.rb and 1 other location - About 40 mins to fix
      bin/handler-victorops.rb on lines 69..75

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

      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

          if settings[config[:settingsname]]
            puts "  settings api_url set: #{settings[config[:settingsname]]['api_url']}" if settings[config[:settingsname]]['api_url']
          else
            puts "  setting name: #{config[:settingsname]} does not exist"
      Severity: Minor
      Found in bin/handler-victorops.rb and 1 other location - About 25 mins to fix
      bin/handler-victorops.rb on lines 115..118

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

      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

          if settings[config[:settingsname]]
            puts "  settings routing_key set: #{settings[config[:settingsname]]['routing_key']}" if settings[config[:settingsname]]['routing_key']
          else
            puts "  setting name: #{config[:settingsname]} does not exist"
      Severity: Minor
      Found in bin/handler-victorops.rb and 1 other location - About 25 mins to fix
      bin/handler-victorops.rb on lines 98..101

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

      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