Sign upLogin

rapid7/metasploit-framework

View on GitHub
Star
tools/modules/module_reference.rb

Summary

Maintainability
B
5 hrs
Test Coverage

Method is_url_alive has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
Open

def is_url_alive(uri, http_timeout, cache)
  if cache.key? uri.to_s
    print_debug("Cached: #{uri} -> #{cache[uri]}")
    return cache[uri.to_s]
  end
Severity: Minor
Found in tools/modules/module_reference.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 is_url_alive has 47 lines of code (exceeds 25 allowed). Consider refactoring.
Open

def is_url_alive(uri, http_timeout, cache)
  if cache.key? uri.to_s
    print_debug("Cached: #{uri} -> #{cache[uri]}")
    return cache[uri.to_s]
  end
Severity: Minor
Found in tools/modules/module_reference.rb - About 1 hr to fix

    Avoid too many return statements within this method.
    Open

        return STATUS_DOWN
    Severity: Major
    Found in tools/modules/module_reference.rb - About 30 mins to fix

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

        when '-f'
    unless filters.include?(val.downcase)
      puts "Invalid Filter Supplied: #{val}"
      puts "Please use one of these: #{filters.map { |f| f.capitalize }.join(', ')}"
      exit
      Severity: Minor
      Found in tools/modules/module_reference.rb and 1 other location - About 30 mins to fix
      tools/modules/module_missing_reference.rb on lines 52..59

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

      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

        when '-t'
    val = (val || '').upcase
    unless types.has_key?(val)
      puts "Invalid Type Supplied: #{val}"
      puts "Please use one of these: #{types.keys.inspect}"
      Severity: Minor
      Found in tools/modules/module_reference.rb and 1 other location - About 15 mins to fix
      tools/modules/module_missing_reference.rb on lines 60..67

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

      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 4 locations. Consider refactoring.
      Open

      def types
  {
    'ALL' => '',
    'CVE' => 'https://nvd.nist.gov/vuln/detail/CVE-#{in_ctx_val}',
    'CWE' => 'http://cwe.mitre.org/data/definitions/#{in_ctx_val}.html',
      Severity: Minor
      Found in tools/modules/module_reference.rb and 3 other locations - About 15 mins to fix
      lib/msf/ui/console/command_dispatcher/session.rb on lines 20..32
      modules/auxiliary/admin/scada/moxa_credentials_recovery.rb on lines 56..68
      plugins/aggregator.rb on lines 15..27

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

      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