(bugfix) option to use codedeploy deployment id in release directory name

Gemfile

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem 'pry'
+  gem 'aws-sdk-codedeploy'
   gem 'guard'
   gem 'guard-minitest'
+  gem 'pry'
 end

egads.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files  = ["README.md"]
   s.rdoc_options      = ["--charset=UTF-8"]
 
+  s.add_dependency "aws-sdk-codedeploy", '~> 1.0'
   s.add_dependency "aws-sdk-s3", '~> 1.0'
   s.add_dependency "rexml", ">= 3.3.4" # required for Ruby 3+
   s.add_dependency "thor"

lib/egads.rb

@@ -1,5 +1,6 @@
 require 'fileutils'
 require 'yaml'
+require 'aws-sdk-codedeploy'
 require 'aws-sdk-s3'
 require 'thor'
 require 'benchmark'

lib/egads/command/extract.rb

@@ -4,6 +4,7 @@ class Extract < Group
 
     desc "[remote, plumbing] Downloads tarball for SHA from S3 and extracts it to the filesystem"
     class_option :force, type: :boolean, aliases: '-f', default: false, banner: "Overwrite existing files"
+    class_option :deployment_id, type: :string, default: nil, banner: 'Append suffix to release directory'
     argument :sha, type: :string, required: true, desc: 'git SHA to download and extract'
 
     attr_accessor :seed_sha, :seed_path
@@ -89,7 +90,8 @@ def do_extract(path)
 
     # Directory created upon successful extraction
     def release_dir
-      RemoteConfig.release_dir(sha)
+      suffix = options[:deployment_id] ? "_#{options[:deployment_id]}" : ''
+      dir(sha) + suffix
     end
 
     # Directory where in-progress extraction occurs

lib/egads/command/release.rb

@@ -1,10 +1,18 @@
+# rubocop:disable Style/Documentation, Style/RaiseArgs, Style/RescueModifier
+# frozen_string_literal: true
+
+require 'aws-sdk-codedeploy'
+
 module Egads
   class Release < Group
+    include Egads::LocalHelpers
     include Thor::Actions
 
-    desc "[remote] Symlinks SHA to current and restarts services. If needed, stages SHA"
-    class_option :force, type: :boolean, default: false, banner: "Overwrite existing release"
+    desc '[remote] Symlinks SHA to current and restarts services. If needed, stages SHA'
+    class_option :force, type: :boolean, default: false, banner: 'Overwrite existing release'
+    class_option :deployment_id, type: :string, default: nil, banner: 'Append suffix to release directory'
     argument :sha, type: :string, required: true, desc: 'git SHA to stage'
+
     def setup_environment
       RemoteConfig.setup_environment
     end
@@ -15,11 +23,13 @@ def stage
 
     def run_before_release_hooks
       return unless should_release?
+
       inside(dir) { run_hooks_for(:release, :before) }
     end
 
     def symlink_release
       return unless should_release?
+
       atomic_symlink(dir, release_to)
     end
 
@@ -44,8 +54,10 @@ def trim
     end
 
     protected
+
     def dir
-      RemoteConfig.release_dir(sha)
+      suffix = options[:deployment_id] ? "_#{options[:deployment_id]}" : ''
+      RemoteConfig.release_dir(sha) + suffix
     end
 
     def release_to
@@ -66,6 +78,7 @@ def should_release?
     # Use an extra temporary symlink for atomicity (equivalent to `mv -T`)
     def atomic_symlink(src, dest)
       raise ArgumentError.new("#{src} is not a directory") unless File.directory?(src)
+
       say_status :symlink, "from #{src} to #{dest}"
       tmp = "#{dest}-new-#{rand(2**32)}"
       # Make a temporary symlink
@@ -75,3 +88,5 @@ def atomic_symlink(src, dest)
     end
   end
 end
+
+# rubocop:enable Style/Documentation, Style/RaiseArgs, Style/RescueModifier

lib/egads/command/stage.rb

@@ -1,10 +1,16 @@
+# rubocop:disable Style/Documentation, Style/GuardClause
+# frozen_string_literal: true
+
+require 'aws-sdk-codedeploy'
+
 module Egads
   class Stage < Group
+    include Egads::LocalHelpers
     include Thor::Actions
 
-
-    desc "[remote] Readies SHA for release. If needed, generates URL for SHA and extracts"
-    class_option :force, type: :boolean, default: false, banner: "Overwrite existing files"
+    desc '[remote] Readies SHA for release. If needed, generates URL for SHA and extracts'
+    class_option :force, type: :boolean, default: false, banner: 'Overwrite existing files'
+    class_option :deployment_id, type: :string, default: nil, banner: 'Append suffix to release directory'
     argument :sha, type: :string, required: true, desc: 'git SHA to stage'
 
     def setup_environment
@@ -17,19 +23,21 @@ def extract
 
     def run_before_hooks
       return unless should_stage?
-      inside(dir){ run_hooks_for(:stage, :before) }
+
+      inside(dir) { run_hooks_for(:stage, :before) }
     end
 
     def bundle
       return unless should_stage?
 
       inside(dir) do
-        run_with_code("bundle install #{RemoteConfig.bundler_options}", stream: true) if File.readable?("Gemfile")
+        run_with_code("bundle install #{RemoteConfig.bundler_options}", stream: true) if File.readable?('Gemfile')
       end
     end
 
     def symlink_system_paths
       return unless should_stage? && shared_path
+
       symlink_directory File.join(shared_path, 'system'), File.join(dir, 'public', 'system')
       symlink_directory File.join(shared_path, 'log'), File.join(dir, 'log')
     end
@@ -49,6 +57,7 @@ def symlink_config_files
 
     def run_after_stage_hooks
       return unless should_stage?
+
       inside(dir) { run_hooks_for(:stage, :after) }
     end
 
@@ -57,8 +66,10 @@ def mark_as_staged
     end
 
     protected
+
     def dir
-      RemoteConfig.release_dir(sha)
+      suffix = options[:deployment_id] ? "_#{options[:deployment_id]}" : ''
+      RemoteConfig.release_dir(sha) + suffix
     end
 
     def stage_flag_path
@@ -74,3 +85,5 @@ def shared_path
     end
   end
 end
+
+# rubocop:enable Style/Documentation, Style/GuardClause

lib/egads/local_helpers.rb

@@ -1,3 +1,9 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/MethodLength
+
+require 'aws-sdk-codedeploy'
+
 module Egads
   # Some helper methods for all local commands
   module LocalHelpers
@@ -6,12 +12,33 @@ def sha
     end
 
     def short_sha
-      sha[0,7]
+      sha[0, 7]
     end
 
     def tarball
       @tarball ||= S3Tarball.new(sha, seed: options[:seed])
     end
 
+    def deployment_id
+      environment = ENV['EC2_ENVIRONMENT'] || ''
+      application = ENV['EC2_SERVICE'] || ''
+
+      return unless environment && application
+
+      deployment = CodeDeploy::Client.new.list_deployments(
+        application_name: application,
+        deployment_group_name: environment,
+        include_only_statuses: %w[InProgress Created Queued]
+      ).deployments.first
+
+      return nil if deployment.empty?
+
+      deployment
+    rescue Aws::CodeDeploy::Errors::ServiceError => e
+      puts "Error fetching deployment: #{e.message}"
+      nil
+    end
   end
 end
+
+# rubocop:enable Metrics/MethodLength

lib/egads/version.rb

@@ -1,3 +1,3 @@
 module Egads
-  VERSION = '5.1.2'
+  VERSION = '5.2.0'
 end

spec/egads_release_spec.rb

@@ -1,9 +1,21 @@
+# frozen_string_literal: true
+
 require_relative 'spec_helper'
 
-describe "Egads::Release" do
+describe 'Egads::Release' do
   subject { Egads::Release }
 
   it 'should run the correct tasks' do
-  _(subject.commands.keys).must_equal %w(setup_environment stage run_before_release_hooks symlink_release restart run_after_release_hooks trim)
+    _(subject.commands.keys).must_equal %w[setup_environment stage run_before_release_hooks symlink_release restart run_after_release_hooks trim]
   end
+
+  # it 'should have the correct class options' do
+  #   expected_options = {
+  #     force: { type: :boolean, default: false, banner: 'Overwrite existing release' },
+  #     deployment_id: { type: :boolean, default: false, banner: 'Include deployment ID in release directory' }
+  #   }
+
+  #   actual_options = subject.class_options.transform_values { |opt| { type: opt.type, default: opt.default, banner: opt.banner }}
+  #   _(actual_options).must_equal expected_options
+  # end
 end

spec/egads_stage_spec.rb

@@ -1,9 +1,21 @@
+# frozen_string_literal: true
+
 require_relative 'spec_helper'
 
-describe "Egads::Stage" do
+describe 'Egads::Stage' do
   subject { Egads::Stage }
 
   it 'should run the correct tasks' do
-  _(subject.commands.keys).must_equal %w(setup_environment extract run_before_hooks bundle symlink_system_paths symlink_config_files run_after_stage_hooks mark_as_staged)
+    _(subject.commands.keys).must_equal %w[setup_environment extract run_before_hooks bundle symlink_system_paths symlink_config_files run_after_stage_hooks mark_as_staged]
   end
+
+  # it 'should have the correct class options' do
+  #   expected_options = {
+  #     force: { type: :boolean, default: false, banner: 'Overwrite existing files' },
+  #     deployment_id: { type: :boolean, default: false, banner: 'Include deployment ID in release directory'}
+  #   }
+
+  #   actual_options = subject.class_options.transform_values { |opt| { type: opt.type, default: opt.default, banner: opt.banner }}
+  #   _(actual_options).must_equal expected_options
+  # end
 end