aws/aws-codedeploy-agent

View on GitHub
lib/instance_agent/plugins/codedeploy/hook_executor.rb

Summary

Maintainability
C
1 day
Test Coverage

File hook_executor.rb has 275 lines of code (exceeds 250 allowed). Consider refactoring.
Open

require 'timeout'
require 'open3'
require 'json'
require 'fileutils'

Severity: Minor
Found in lib/instance_agent/plugins/codedeploy/hook_executor.rb - About 2 hrs to fix

    Method execute has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
    Open

            def execute
              return if @app_spec.nil?
              if (hooks = @app_spec.hooks[@lifecycle_event]) &&
              !hooks.empty?
                create_script_log_file_if_needed do |script_log_file|
    Severity: Minor
    Found in lib/instance_agent/plugins/codedeploy/hook_executor.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 execute_script has 36 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

            def execute_script(script, script_log_file)
              script_command = InstanceAgent::Platform.util.prepare_script_command(script, script_absolute_path(script))
              log_script("Script - " + script.location + "\n", script_log_file)
              exit_status = 1
              signal = nil
    Severity: Minor
    Found in lib/instance_agent/plugins/codedeploy/hook_executor.rb - About 1 hr to fix

      Method execute has 30 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

              def execute
                return if @app_spec.nil?
                if (hooks = @app_spec.hooks[@lifecycle_event]) &&
                !hooks.empty?
                  create_script_log_file_if_needed do |script_log_file|
      Severity: Minor
      Found in lib/instance_agent/plugins/codedeploy/hook_executor.rb - About 1 hr to fix

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

                def initialize(arguments = {})
                  #check arguments
                  raise "Lifecycle Event Required " if arguments[:lifecycle_event].nil?
                  raise "Deployment ID required " if arguments[:deployment_id].nil?
                  raise "Deployment Root Directory Required " if arguments[:deployment_root_dir].nil?
        Severity: Minor
        Found in lib/instance_agent/plugins/codedeploy/hook_executor.rb - About 1 hr to fix

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

                  def initialize(arguments = {})
                    #check arguments
                    raise "Lifecycle Event Required " if arguments[:lifecycle_event].nil?
                    raise "Deployment ID required " if arguments[:deployment_id].nil?
                    raise "Deployment Root Directory Required " if arguments[:deployment_root_dir].nil?
          Severity: Minor
          Found in lib/instance_agent/plugins/codedeploy/hook_executor.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 create_script_log_file_if_needed has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
          Open

                  def create_script_log_file_if_needed
                    script_log_file_location = File.join(@current_deployment_root_dir, ScriptLog::SCRIPT_LOG_FILE_RELATIVE_LOCATION)
                    if(!File.exists?(script_log_file_location))
                      unless File.directory?(File.dirname(script_log_file_location))
                        FileUtils.mkdir_p(File.dirname(script_log_file_location))
          Severity: Minor
          Found in lib/instance_agent/plugins/codedeploy/hook_executor.rb - About 35 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 6 locations. Consider refactoring.
          Open

                  def log(severity, message)
                    raise ArgumentError, "Unknown severity #{severity.inspect}" unless InstanceAgent::Log::SEVERITIES.include?(severity.to_s)
                    InstanceAgent::Log.send(severity.to_sym, "#{description}: #{message}")
          Severity: Minor
          Found in lib/instance_agent/plugins/codedeploy/hook_executor.rb and 5 other locations - About 15 mins to fix
          lib/instance_agent/agent/base.rb on lines 19..21
          lib/instance_agent/plugins/codedeploy/command_executor.rb on lines 612..614
          lib/instance_agent/plugins/codedeploy/install_instruction.rb on lines 195..197
          lib/instance_agent/plugins/codedeploy/installer.rb on lines 156..158
          lib/winagent.rb on lines 67..69

          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

          There are no issues that match your filters.

          Category
          Status