Sign upLogin

rapid7/metasploit-framework

View on GitHub
Star
lib/msf/core/modules/metadata/search.rb

Summary

Maintainability
F
5 days
Test Coverage

Method is_match has a Cognitive Complexity of 207 (exceeds 5 allowed). Consider refactoring.
Open

  def is_match(params, module_metadata)
    return true if params.empty?

    param_hash = params
Severity: Minor
Found in lib/msf/core/modules/metadata/search.rb - About 4 days 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_match has 124 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  def is_match(params, module_metadata)
    return true if params.empty?

    param_hash = params
Severity: Major
Found in lib/msf/core/modules/metadata/search.rb - About 4 hrs to fix

    Method parse_search_string has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
    Open

      def self.parse_search_string(search_string)
    search_string ||= ''
    search_string += ' '

    # Split search terms by space, but allow quoted strings
    Severity: Minor
    Found in lib/msf/core/modules/metadata/search.rb - About 3 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 parse_search_string has 26 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      def self.parse_search_string(search_string)
    search_string ||= ''
    search_string += ' '

    # Split search terms by space, but allow quoted strings
    Severity: Minor
    Found in lib/msf/core/modules/metadata/search.rb - About 1 hr to fix

      Method find has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

        def find(params, fields={})
    raise ArgumentError if params.any? && VALID_PARAMS.none? { |k| params.key?(k) }
    search_results = []

    get_metadata.each { |module_metadata|
      Severity: Minor
      Found in lib/msf/core/modules/metadata/search.rb - About 45 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

      Avoid too many return statements within this method.
      Open

              return false
      Severity: Major
      Found in lib/msf/core/modules/metadata/search.rb - About 30 mins to fix

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

            %w[
      action
      adapter
      aka
      arch
        Severity: Minor
        Found in lib/msf/core/modules/metadata/search.rb and 2 other locations - About 35 mins to fix
        lib/msf/base/simple/buffer.rb on lines 131..163
        lib/rex/payloads/shuffle.rb on lines 13..13

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

        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