ecs-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6381c88cb4b0507a1f9f667290768c0b0d060b1308108b4699e7b0d6107f048b
+  data.tar.gz: 1ca8e857d5ea22a9dae7e07388c5124f85f41a81d20b4a5e169852ce942fcba0
+SHA512:
+  metadata.gz: ab8bda757afb402c1cdb8096a24ec51a8973fb78e8be9c6f4241e936b68aff153f3d913fa5c15d7336421365972e750130bb36ce91a3da410cf6077cd47321f8
+  data.tar.gz: 87c30bb9091b7fff68cb535770d22dd4f6d8da21ee9c119eeec06e649f36a8e42f9e9a27d8c2815c67d2894904ff7b38c3c879c79465f3f34e28773c0406f251

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.env*
+.byebug_history
+Gemfile.lock
+

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'byebug'
+gem 'rspec', '~> 3.0'

data/bin/ecs

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require 'byebug'
+
+require 'optparse'
+require_relative '../lib/ecs-rails'
+
+EcsRails.aws_region = ENV['AWS_REGION']
+EcsRails.aws_access_key_id = ENV['AWS_ACCESS_KEY_ID']
+EcsRails.aws_secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
+EcsRails.container_name = ENV['CONTAINER_NAME'] || 'webapp'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: ecsconsole [options]"
+
+  opts.on("-c", "--cluster CLUSTER_STRING", "Give a substring present in your cluster name. Ex: 'ecs console -c prod' to connect to cluster webapp-cluster-prod-e950a13") do |c|
+    options[:cluster] = c
+  end
+
+  opts.on("-s", "--service SERVICE_STRING", "Give a substring present in your service name. Ex: 'ecs console -c prod -s app' to connect to service webapp-app-prod-7c7cad7") do |c|
+    options[:service] = c
+  end
+end.parse!
+
+command_keyword = ARGV[0]
+
+# byebug
+
+# command = EcsRails::CommandFactory.new(command_keyword, options).command
+# command.call
+
+EcsRails::CommandExecutor.call(command_keyword, options)

data/ecs-rails.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'lib/ecs-rails/version'
+
+Gem::Specification.new do |s|
+  s.name        = "ecs-rails"
+  s.version     = EcsRails::VERSION
+  s.summary     = "Connect to your AWS ECS tasks"
+  s.description = "Connect to your AWS ECS tasks"
+  s.authors     = ["Franck D'agostini"]
+  s.email       = "franck.dagostini@gmail.com"
+  s.homepage    = "https://rubygems.org/gems/ecs-rails"
+  s.license       = "MIT"
+  s.required_ruby_version = '>= 2.7.0'
+  s.require_paths = ['lib']
+
+  s.files = `git ls-files -z`.split("\x0")
+
+  s.add_development_dependency 'byebug', '~> 11.1'
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.add_runtime_dependency "aws-sdk-ecs", "~> 1.132", "> 1.132"
+  s.add_runtime_dependency "aws-sdk-ec2", "~> 1.425", "> 1.425"
+  s.add_runtime_dependency "tty-prompt", "~> 0.23", "> 0.23"
+end

data/lib/ecs-rails/client.rb

@@ -0,0 +1,20 @@
+module EcsRails
+  class Client
+
+    def client
+      Aws::ECS::Client.new(aws_credentials)
+    end
+
+    private
+
+      def aws_credentials
+        @aws_credentials ||= {
+          region: ENV['AWS_REGION'],
+          access_key_id: ENV['AWS_ACCESS_KEY_ID'],
+          secret_access_key: ENV['AWS_SECRET_ACCESS_KEY']
+        }
+      end
+
+  end
+end
+

data/lib/ecs-rails/cluster_selector.rb

@@ -0,0 +1,55 @@
+module EcsRails
+  class ClusterSelector
+    def initialize(client, filter = nil)
+      @client = client
+      @filter = filter
+    end
+
+    def cluster
+      clusters.find { |cluster| cluster.cluster_name == cluster_name }
+    end
+
+    def call
+      puts('Fetching clusters...')
+      clusters = client.list_clusters.cluster_arns
+
+      if clusters.empty?
+        puts('No clusters found.')
+        exit
+      end
+
+      if filter
+        filtered_clusters = clusters.select { |cluster| cluster.include?(filter) }
+
+        if filtered_clusters.empty?
+          puts("No clusters found with this keyword '#{filter}'.")
+          exit
+        end
+
+        connecting_to_cluster(filtered_clusters.first)
+        return filtered_clusters.first
+      else
+        ask_for_cluster(clusters)
+      end
+    end
+
+    private
+
+      attr_reader :client, :filter
+
+      def connecting_to_cluster(cluster_name)
+        puts('')
+        puts("Connecting to cluster '#{cluster_name}':")
+        puts('')
+        puts('=' * 50)
+      end
+
+      def ask_for_cluster(clusters)
+        prompt = TTY::Prompt.new
+        choices = clusters.map { |cluster| cluster.split('/').last }
+        choice = prompt.enum_select("Select a cluster:", choices)
+        clusters.grep(Regexp.new(choice)).first
+      end
+
+  end
+end

data/lib/ecs-rails/command.rb

@@ -0,0 +1,48 @@
+module EcsRails
+  class Command
+
+    def initialize(cluster_name = nil, service_name = nil)
+      @cluster_name = cluster_name
+      @service_name = service_name
+    end
+
+    def call
+      raise NotImplementedError
+    end
+
+    private
+
+      attr_reader :cluster_name, :service_name
+
+      def client
+        client = EcsRails::Client.new.client
+      end
+
+      def container_name
+        EcsRails.container_name
+      end
+
+      def region
+        EcsRails.aws_region
+      end
+
+      def selected_cluster
+        @selected_cluster ||= EcsRails::ClusterSelector.new(client, cluster_name).call
+      end
+
+      def selected_service
+        puts("Selected cluster: #{selected_cluster}")
+        @selected_service ||= EcsRails::ServiceSelector.new(client, selected_cluster, service_name).call
+      end
+
+      def task_id
+        puts("Selected service: #{selected_service}")
+        @task_id ||= EcsRails::TaskSelector.new(client, selected_cluster, selected_service).call
+      end
+
+      def test_mode?
+        defined?(RSpec)
+      end
+  end
+end
+

data/lib/ecs-rails/command_factory.rb

@@ -0,0 +1,26 @@
+module EcsRails
+  class CommandFactory
+
+    def initialize(command_keyword, options = {})
+      @command_keyword = command_keyword
+      @cluster_name = options[:cluster]
+      @service_name = options[:service]
+    end
+
+    def command
+      case command_keyword
+      when 'console'
+        EcsRails::Console.new(cluster_name, service_name)
+      when 'bash'
+        EcsRails::Bash.new(cluster_name, service_name)
+      else
+        EcsRails::NullCommand.new
+      end
+    end
+
+    private
+
+      attr_reader :command_keyword, :cluster_name, :service_name
+
+  end
+end

data/lib/ecs-rails/console.rb

@@ -0,0 +1,22 @@
+module EcsRails
+  class Console < Command
+
+    def call
+      return full_command if test_mode?
+
+      puts "Executing command: #{full_command}"
+      system(full_command)
+    end
+
+    private
+
+      def full_command
+        @full_command ||= "aws ecs execute-command --region #{region} --cluster #{selected_cluster} --task #{task_id} --container #{container_name} --command \'#{command}\' --interactive" 
+      end
+
+
+      def command
+        "bundle exec rails console"
+      end
+  end
+end

data/lib/ecs-rails/ecs_rails_configuration.rb

@@ -0,0 +1,38 @@
+module EcsRails
+  class EcsRailsConfiguration
+    attr_accessor :aws_region
+    attr_accessor :aws_access_key_id
+    attr_accessor :aws_secret_access_key 
+    attr_accessor :container_name
+
+    def self.setup
+      new.tap do |config|
+        yield config if block_given?
+      end
+    end
+
+    def initialize
+      @aws_region = 'us-east-1'
+      @aws_access_key_id = nil
+      @aws_secret_access_key = nil
+      @container_name = nil
+    end
+
+    def aws_region=(region)
+      @aws_region = region
+    end
+
+    def aws_access_key_id=(access_key_id)
+      @aws_access_key_id = access_key_id
+    end
+
+    def aws_secret_access_key=(secret_access_key)
+      @aws_secret_access_key = secret_access_key
+    end
+
+    def container_name=(container_name)
+      @container_name = container_name
+    end
+
+  end
+end

data/lib/ecs-rails/null_command.rb

@@ -0,0 +1,10 @@
+module EcsRails
+  class NullCommand
+
+    def call
+      puts 'You must specify a command (console, bash, logs, …)'
+      exit 1
+    end
+
+  end
+end

data/lib/ecs-rails/service_selector.rb

@@ -0,0 +1,59 @@
+module EcsRails
+  class ServiceSelector
+
+    def initialize(client, cluster, service_filter = nil)
+      @client = client
+      @cluster = cluster
+      @service_filter = service_filter
+    end
+
+    def call
+      puts('Fetching services...')
+      services = client.list_services(cluster: cluster).service_arns
+
+      if services.empty?
+        puts('No services found in the cluster.')
+        exit
+      end
+
+      if services.size == 1
+        service = services.first
+        connecting_to_service(service)
+        return service
+      end
+
+      if service_filter
+        filtered_services = services.select { |service| service.include?(service_filter) }
+
+        if filtered_services.empty?
+          puts("No service found with this keyword '#{service_filter}'.")
+          exit
+        end
+        
+        connecting_to_service(filtered_services.first)
+        return filtered_services.first
+      else
+        ask_for_service(services)
+      end
+    end
+
+
+    private
+
+      attr_reader :client, :cluster, :service_filter
+
+      def connecting_to_service(service_name)
+        puts('')
+        puts("Connecting to service '#{service_name}':")
+        puts('')
+        puts('=' * 50)
+      end
+
+      def ask_for_service(services)
+        prompt = TTY::Prompt.new
+        choices = services.map { |service| service.split('/').last }
+        choice = prompt.enum_select("Select a service:", choices)
+        services.grep(Regexp.new(choice)).first
+      end
+  end
+end

data/lib/ecs-rails/task_selector.rb

@@ -0,0 +1,52 @@
+module EcsRails
+  class TaskSelector
+
+    def initialize(client, cluster_name, service_name)
+      @client = client
+      @cluster_name = cluster_name
+      @service_name = service_name
+    end
+
+    def call
+      puts('Fetching tasks...')
+      service_descriptions = client.describe_services(cluster: cluster_name, services: [service_name]).services
+
+      service_descriptions.each do |service|
+        service.deployments.each do |deployment|
+          task_arns = client.list_tasks(cluster: cluster_name, service_name: service.service_name, desired_status: 'RUNNING').task_arns
+          next if task_arns.empty?
+
+          tasks = client.describe_tasks(cluster: cluster_name, tasks: task_arns).tasks
+
+          # Filter tasks by deployment's task definition
+          tasks_for_deployment = tasks.select { |task| task.task_definition_arn == deployment.task_definition }
+
+          if tasks_for_deployment.empty?
+            puts("      No tasks found for this deployment.")
+          elsif tasks_for_deployment.size == 1
+            puts("      Task: #{task_arns.first}")
+              return task_arns.first
+          else
+            tasks_for_deployment.each_with_index do |task, index|
+              puts("#{index+1}. Task: #{task.task_arn.split('/').last}, Last Status: #{task.last_status}, Desired Status: #{task.desired_status}")
+            end
+          end
+
+          selection = $stdin.gets.chomp.to_i
+          puts("Selected task: #{tasks_for_deployment[selection - 1].task_arn}")
+
+            unless selection.between?(1, task_arns.size)
+              puts('Invalid selection.')
+              exit
+            end
+
+          return task_arns[selection - 1]
+        end
+      end
+    end
+
+    private
+
+      attr_reader :client, :cluster_name, :service_name
+  end
+end

data/lib/ecs-rails/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EcsRails
+  VERSION = '0.0.1'
+end

data/lib/ecs-rails.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-ecs'
+
+# version
+require_relative 'ecs-rails/version'
+
+# configuration
+require_relative 'ecs-rails/ecs_rails_configuration'
+
+# client
+require_relative 'ecs-rails/client'
+
+# selectors
+require_relative 'ecs-rails/cluster_selector'
+require_relative 'ecs-rails/service_selector'
+require_relative 'ecs-rails/task_selector'
+
+# commands
+require_relative 'ecs-rails/command_executor'
+require_relative 'ecs-rails/command_factory'
+require_relative 'ecs-rails/command'
+require_relative 'ecs-rails/console'
+require_relative 'ecs-rails/bash'
+require_relative 'ecs-rails/null_command'
+
+
+# prompt
+require "tty-prompt"
+
+module EcsRails
+
+  @configuration = EcsRails::EcsRailsConfiguration.setup
+
+  class << self
+    extend Forwardable
+
+    def_delegators :@configuration, :aws_region, :aws_region=
+    def_delegators :@configuration, :aws_access_key_id, :aws_access_key_id=
+    def_delegators :@configuration, :aws_secret_access_key, :aws_secret_access_key=
+    def_delegators :@configuration, :container_name, :container_name=
+  end
+
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: ecs-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Franck D'agostini
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ecs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.132'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.132'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.132'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.132'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ec2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.425'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.425'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.425'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.425'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+description: Connect to your AWS ECS tasks
+email: franck.dagostini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- bin/ecs
+- ecs-rails.gemspec
+- lib/ecs-rails.rb
+- lib/ecs-rails/client.rb
+- lib/ecs-rails/cluster_selector.rb
+- lib/ecs-rails/command.rb
+- lib/ecs-rails/command_factory.rb
+- lib/ecs-rails/console.rb
+- lib/ecs-rails/ecs_rails_configuration.rb
+- lib/ecs-rails/null_command.rb
+- lib/ecs-rails/service_selector.rb
+- lib/ecs-rails/task_selector.rb
+- lib/ecs-rails/version.rb
+homepage: https://rubygems.org/gems/ecs-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.12
+signing_key:
+specification_version: 4
+summary: Connect to your AWS ECS tasks
+test_files: []