Merge pull request #5 from fac/refactor

Complete refactor

.rubocop.yml

@@ -0,0 +1,2 @@
+Metrics/BlockLength:
+  Enabled: false

Dockerfile

@@ -5,4 +5,4 @@ COPY . /usr/src/app
 
 RUN cd /usr/src/app && bundle install
 
-ENTRYPOINT ["ruby", "/usr/src/app/app.rb"]
+ENTRYPOINT ["/usr/src/app/entrypoint.sh"]

Gemfile

@@ -1,3 +1,9 @@
 source 'https://rubygems.org' do
   gem 'aws-sdk-states'
-end
+
+  group :test do
+    gem 'nokogiri'
+    gem 'rspec'
+    gem 'rspec-mocks'
+  end
+end

Gemfile.lock

@@ -16,13 +16,34 @@ GEM
       aws-sigv4 (~> 1.1)
     aws-sigv4 (1.5.2)
       aws-eventstream (~> 1, >= 1.0.2)
+    diff-lcs (1.5.1)
     jmespath (1.6.2)
+    nokogiri (1.16.2-arm64-darwin)
+      racc (~> 1.4)
+    racc (1.7.3)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
 
 PLATFORMS
   arm64-darwin-21
+  arm64-darwin-23
 
 DEPENDENCIES
   aws-sdk-states!
+  nokogiri!
+  rspec!
+  rspec-mocks!
 
 BUNDLED WITH
    2.3.7

app.rb

@@ -1,6 +1,12 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('.', 'lib')
+
 require 'aws-sdk-states'
 require 'json'
 
+require 'deployment'
+
 STDOUT.sync = true
 
 execution_arn = ENV['EXECUTION_ARN']
@@ -12,60 +18,21 @@
 
 aws_client = Aws::States::Client.new(region: 'eu-west-1')
 
-def deployment_status(aws_client, execution_arn)
-  aws_client.describe_execution({ execution_arn: execution_arn }).status
-end
-
-def failure_reason(aws_client, execution_arn)
-  resp = aws_client.get_execution_history({
-    execution_arn: execution_arn,
-    max_results: 2,
-    reverse_order: true
-  })
-
-  event_type = resp.events[1].type
-  if event_type == "LambdaFunctionFailed"
-    error_message = JSON.parse(resp.events[1].lambda_function_failed_event_details.cause)['errorMessage']
-    if error_message.include? "Pre flight checks failed"
-      preflight_checks_output = error_message.lines[1]
-      forward_deploy_check_result =  preflight_checks_output.match(/ForwardDeployCheck=>"(.*?)"/i).captures[0]
-      if forward_deploy_check_result == "FAILED"
-        deploy_fail_reason = "Forward deploy check FAILED. No need to panic! "\
-                             "This likely means your commit has already been deployed as part of a previous deploy. "\
-                             "To confirm you can check whether your SHA is a parent commit to the currently deployed SHA. "\
-                             "You can figure out the currently deployed SHA by following this guide https://www.notion.so/freeagent/Deployment-Runbooks-29796221387e40b7abbb217d7d33c4ac?pvs=4#3bfa2ab5d3ab4c33b7a46522027f94bb"
-        return deploy_fail_reason
-      end
-    end
-    deploy_fail_reason = error_message
-  elsif event_type == "FailStateEntered"
-    error_message = JSON.parse(JSON.parse(resp.events[1].state_entered_event_details.input)['Error']['Cause'])['errorMessage']
-    if error_message.include? "ECS" and error_message.include? "IN_PROGRESS"
-      deploy_fail_reason = "Sidekiq workers failed to start or failed to stabilise."
-    else
-      deploy_fail_reason = "Failure message: #{error_message}. Please investigate further here if required https://eu-west-1.console.aws.amazon.com/states/home?region=eu-west-1#/executions/details/#{execution_arn}"
-    end
-  else
-    deploy_fail_reason = "Uncaught failure. Please investigate here https://eu-west-1.console.aws.amazon.com/states/home?region=eu-west-1#/executions/details/#{execution_arn}"
-  end
-
-  return deploy_fail_reason
-end
+deploy = Deployment::Deployment.new(aws_client, execution_arn)
 
-# One of: "RUNNING", "SUCCEEDED", "FAILED", "TIMED_OUT", "ABORTED"
-if deployment_status(aws_client, execution_arn) == 'RUNNING'
+if deploy.running?
   puts 'Deployment in progress...🔄'
   puts "Monitor at https://eu-west-1.console.aws.amazon.com/states/home?region=eu-west-1#/executions/details/#{execution_arn}"
-  sleep 15 until deployment_status(aws_client, execution_arn) != 'RUNNING'
 end
 
-deploy_status = deployment_status(aws_client, execution_arn)
-if %w[FAILED TIMED_OUT ABORTED].include?(deploy_status)
-  puts "Deployment Failure Status: #{deploy_status} ❌"
+sleep 10 while deploy.running?
+
+if deploy.succeeded?
+  puts 'Deployment Successful 🎉'
+else
+  puts "Deployment Failure Status: #{deploy.status} ❌"
   File.open(ENV['GITHUB_OUTPUT'], 'a') do |f|
-    f.puts "deployment_failed=true"
-    f.puts "deployment_failure_reason=#{failure_reason(aws_client, execution_arn)}"
+    f.puts 'deployment_failed=true'
+    f.puts "deployment_failure_reason=#{deploy.failure_reason}"
   end
-elsif deploy_status == 'SUCCEEDED'
-  puts 'Deployment Successful 🎉'
 end

entrypoint.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+cd /usr/src/app && bundle exec ruby app.rb

lib/deployment.rb

@@ -0,0 +1,3 @@
+require 'deployment/deployment'
+require 'deployment/events/fail_state_entered'
+require 'deployment/events/lambda_function_failed'

lib/deployment/deployment.rb

@@ -0,0 +1,61 @@
+module Deployment
+  class Deployment
+    def initialize(aws_client, execution_arn)
+      @aws_client = aws_client
+      @execution_arn = execution_arn
+    end
+
+    def status
+      @aws_client.describe_execution({ execution_arn: @execution_arn }).status
+    end
+
+    def running?
+      status == 'RUNNING'
+    end
+
+    def succeeded?
+      status == 'SUCCEEDED'
+    end
+
+    def aborted?
+      status == 'ABORTED'
+    end
+
+    def timed_out?
+      status == 'TIMED_OUT'
+    end
+
+    def failed?
+      status == 'FAILED'
+    end
+
+    def failure_reason
+      raise 'Deploy still runnning' if running?
+      raise 'Deploy succeeded' if succeeded?
+
+      event_type = fail_event.type
+
+      case event_type
+      when 'LambdaFunctionFailed'
+        Events::LambdaFunctionFailed.new(fail_event).error
+      when 'FailStateEntered'
+        Events::FailStateEntered.new(fail_event, @execution_arn).error
+      else
+        "Uncaught failure. Please investigate here https://eu-west-1.console.aws.amazon.com/states/home?region=eu-west-1#/executions/details/#{@execution_arn}"
+      end
+    end
+
+    private
+
+    def fail_event
+      # The penultimate event holds the failure reason
+      @aws_client.get_execution_history(
+        {
+          execution_arn: @execution_arn,
+          max_results: 2,
+          reverse_order: true
+        }
+      ).events.last
+    end
+  end
+end

lib/deployment/events/fail_state_entered.rb

@@ -0,0 +1,36 @@
+module Deployment
+  module Events
+    class FailStateEntered
+      def initialize(event, execution_arn)
+        @event = event
+        @execution_arn = execution_arn
+      end
+
+      def error
+        if sidekiq_error?
+          'Sidekiq workers failed to start or failed to stabilise.'
+        else
+          "Failure message: #{error_message}. Please investigate further here if required https://eu-west-1.console.aws.amazon.com/states/home?region=eu-west-1#/executions/details/#{@execution_arn}"
+        end
+      end
+
+      private
+
+      def error_message
+        @error_message ||= JSON.parse(JSON.parse(@event.state_entered_event_details.input)['Error']['Cause'])['errorMessage']
+      end
+
+      def in_progress?
+        error_message.include? 'IN_PROGRESS'
+      end
+
+      def ecs_error?
+        error_message.include? 'ECS'
+      end
+
+      def sidekiq_error?
+        ecs_error? && in_progress?
+      end
+    end
+  end
+end

lib/deployment/events/lambda_function_failed.rb

@@ -0,0 +1,42 @@
+module Deployment
+  module Events
+    class LambdaFunctionFailed
+      def initialize(event)
+        @event = event
+      end
+
+      def error
+        if preflight_checks_failed? && forward_deploy_check_failed?
+          'Forward deploy check FAILED. No need to panic! '\
+          'This likely means your commit has already been deployed as part of a previous deploy. '\
+          'To confirm you can check whether your SHA is a parent commit to the currently deployed SHA. '\
+          'You can figure out the currently deployed SHA by following this guide https://www.notion.so/freeagent/Deployment-Runbooks-29796221387e40b7abbb217d7d33c4ac?pvs=4#3bfa2ab5d3ab4c33b7a46522027f94bb'
+        else
+          error_message
+        end
+      end
+
+      private
+
+      def error_message
+        @error_message ||= JSON.parse(@event.lambda_function_failed_event_details.cause)['errorMessage']
+      end
+
+      def preflight_checks_output
+        error_message.lines[1]
+      end
+
+      def preflight_checks_failed?
+        error_message.include? 'Pre flight checks failed'
+      end
+
+      def forward_deploy_check_result
+        preflight_checks_output.match(/ForwardDeployCheck=>"(.*?)"/i).captures[0]
+      end
+
+      def forward_deploy_check_failed?
+        forward_deploy_check_result == 'FAILED'
+      end
+    end
+  end
+end