Sign upLogin

rapid7/metasploit-framework

View on GitHub
Star
lib/msf/ui/debug.rb

Summary

Maintainability
D
1 day
Test Coverage

File debug.rb has 301 lines of code (exceeds 250 allowed). Consider refactoring.
Open

module Msf
  module Ui
    ###
    #
    # Displays Metasploit information useful for Debugging.
Severity: Minor
Found in lib/msf/ui/debug.rb - About 3 hrs to fix

    Method datastore has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
    Open

          def self.datastore(framework, driver)

        # Generate an ini with the existing config file
        ini = Rex::Parser::Ini.new(Msf::Config.config_file)
    Severity: Minor
    Found in lib/msf/ui/debug.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 database_configuration has 38 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

          def self.database_configuration(framework)
        output = "```\nSession Type: #{db_connection_info(framework)}\n```\n\n"

        if framework.db&.active
          current_workspace = framework.db.workspace
    Severity: Minor
    Found in lib/msf/ui/debug.rb - About 1 hr to fix

      Method datastore has 32 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

            def self.datastore(framework, driver)

        # Generate an ini with the existing config file
        ini = Rex::Parser::Ini.new(Msf::Config.config_file)
      Severity: Minor
      Found in lib/msf/ui/debug.rb - About 1 hr to fix

        Method build_regex_file_section has 29 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

                def build_regex_file_section(path, match_total, regex, header_name, blurb)
          unless File.file?(path)
            return build_section(
              header_name,
              blurb,
        Severity: Minor
        Found in lib/msf/ui/debug.rb - About 1 hr to fix

          Method db_connection_info has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
          Open

                  def db_connection_info(framework)
          unless framework.db.connection_established?
            return "#{framework.db.driver} selected, no connection"
          end
          Severity: Minor
          Found in lib/msf/ui/debug.rb - 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

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

                def self.database_configuration(framework)
        output = "```\nSession Type: #{db_connection_info(framework)}\n```\n\n"

        if framework.db&.active
          current_workspace = framework.db.workspace
          Severity: Minor
          Found in lib/msf/ui/debug.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

          Method build_regex_file_section has 5 arguments (exceeds 4 allowed). Consider refactoring.
          Open

                  def build_regex_file_section(path, match_total, regex, header_name, blurb)
          Severity: Minor
          Found in lib/msf/ui/debug.rb - About 35 mins to fix

            Method history has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
            Open

                  def self.history(driver)
        end_pos = Readline::HISTORY.length - 1
        start_pos = end_pos - COMMAND_HISTORY_TOTAL > driver.hist_last_saved ? end_pos - (COMMAND_HISTORY_TOTAL - 1) : driver.hist_last_saved

        commands = ''
            Severity: Minor
            Found in lib/msf/ui/debug.rb - 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

            Method build_regex_file_section has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
            Open

                    def build_regex_file_section(path, match_total, regex, header_name, blurb)
          unless File.file?(path)
            return build_section(
              header_name,
              blurb,
            Severity: Minor
            Found in lib/msf/ui/debug.rb - 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

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

                    def db_connection_info(framework)
          unless framework.db.connection_established?
            return "#{framework.db.driver} selected, no connection"
          end
            Severity: Major
            Found in lib/msf/ui/debug.rb and 1 other location - About 1 hr to fix
            lib/msf/ui/console/command_dispatcher/db.rb on lines 724..746

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

            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