ecs-rails 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6381c88cb4b0507a1f9f667290768c0b0d060b1308108b4699e7b0d6107f048b
-  data.tar.gz: 1ca8e857d5ea22a9dae7e07388c5124f85f41a81d20b4a5e169852ce942fcba0
+  metadata.gz: 35b782be8674d1202475c5feb01d7db1f60cc44c405728e0d209b36ed73dbf36
+  data.tar.gz: 12b35c703f133f94e98a958100369fa8a55b2f6c5a00ba05fd15f7f45260606a
 SHA512:
-  metadata.gz: ab8bda757afb402c1cdb8096a24ec51a8973fb78e8be9c6f4241e936b68aff153f3d913fa5c15d7336421365972e750130bb36ce91a3da410cf6077cd47321f8
-  data.tar.gz: 87c30bb9091b7fff68cb535770d22dd4f6d8da21ee9c119eeec06e649f36a8e42f9e9a27d8c2815c67d2894904ff7b38c3c879c79465f3f34e28773c0406f251
+  metadata.gz: 14993ab00ee2a4c16050dac6e8697164b8ee107d19b0aa6258b4ae69cdc416f8bf3ebc44183b8d74002e717393ded177756ecc73d482f396a4a1c7a92da0c7b9
+  data.tar.gz: 56a7b7c237a810666872fc34b3e376cf7a87bd75b1793602b0fb3d217abc5d0ae786d1515dab745a747af7528b2ad4d03293f178c229143bc3af22365289508c

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Franck D'agostini
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,77 @@
+If you are hosting your Rails app on ECS Fargate and want to connect to the Rails console or launch a bash session, you need to use AWS cli like so :
+
+```bash
+aws ecs execute-command --region eu-west-3 --cluster CLUSTER_ARN --task TASK_ARN --container CONTAINER_NAME --command 'bundle exec rails console' --interactive
+```
+
+This gem helps to get the correct cluster arn and task id so that you don't have to get them yourself.
+
+```bash
+ecs console
+ecs bash
+```
+
+# Installation
+
+Install [AWS cli](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)
+
+Install [AWS Session Manager plugin](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html)
+
+Install gem
+
+```ruby
+gem install 'ecs-rails'
+```
+
+# Configuration
+
+## Plain Ruby
+
+Via environment variables:
+
+```
+export ENV['AWS_REGION'] = 'us-east-1'
+export ENV['AWS_ACCESS_KEY_ID'] = 'your-access-key-id'
+export ENV['AWS_SECRET_ACCESS_KEY'] = 'your-secret-access-key'
+export ENV['CONTAINER_NAME'] = 'your-container-name'
+```
+
+## Rails
+
+```ruby
+# config/initializers/ecs-rails.rb
+EcsRails.aws_region = 'us-east-1'
+EcsRails.aws_access_key_id = ENV['AWS_ACCESS_KEY_ID']
+EcsRails.aws_secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
+EcsRails.container_name = 'webapp'
+```
+
+# Usage
+
+Connect to Rails console on a running Task.
+
+```ruby
+ecs console
+
+Select a cluster:
+1) cluster-prod
+2) cluster-staging
+Choose 1-2 [1]:
+
+Select a service:
+1) app
+2) worker
+Choose 1-2 [1]:
+
+irb(main)>
+```
+
+You can specify cluster name via -c option by giving a string included in cluster arn.
+You can specify service name via -s option by giving a string included in service arn.
+
+```ruby
+# with cluster name: webapp-cluster-prod-e950a13
+# with service name: webapp-app-prod-7c7cad7
+ecs console -c prod -s app
+irb(main)>
+```

data/ecs-rails.gemspec

@@ -16,6 +16,8 @@ Gem::Specification.new do |s|
 
   s.files = `git ls-files -z`.split("\x0")
 
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+
   s.add_development_dependency 'byebug', '~> 11.1'
   s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
 

data/lib/ecs-rails/bash.rb

@@ -0,0 +1,22 @@
+module EcsRails
+  class Bash < 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
+        "bash"
+      end
+  end
+end

data/lib/ecs-rails/command_executor.rb

@@ -0,0 +1,9 @@
+module EcsRails
+  class CommandExecutor
+
+    def self.call(command_keyword, options = {})
+      CommandFactory.new(command_keyword, options).command.call
+    end
+
+  end
+end

data/lib/ecs-rails/version.rb

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

data/spec/bin/ecs_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe 'Ecs binary' do
+
+  context 'without arguments' do
+    it 'should run ecs help' do
+      output = EcsRails::CommandExecutor.call('', {})
+      expect(output).to include('You must specify a command')
+    end
+  end
+
+  context 'with console command argument' do
+    it 'calls the command factory with correct command keyword' do
+      command_factory_instance = double('command_factory_instance')
+
+      expect(EcsRails::CommandFactory).to receive(:new).with('console', {}).and_return(command_factory_instance)
+
+      command_instance = double('command_instance')
+
+      expect(command_factory_instance).to receive(:command).and_return(command_instance)
+      expect(command_instance).to receive(:call)
+
+      EcsRails::CommandExecutor.call('bash', {})
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'ecs-rails'
+require 'byebug'
+
+RSpec.configure do |config|
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ecs-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Franck D'agostini
@@ -106,18 +106,23 @@ dependencies:
         version: '0.23'
 description: Connect to your AWS ECS tasks
 email: franck.dagostini@gmail.com
-executables: []
+executables:
+- ecs
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- LICENSE
+- README.md
 - bin/ecs
 - ecs-rails.gemspec
 - lib/ecs-rails.rb
+- lib/ecs-rails/bash.rb
 - lib/ecs-rails/client.rb
 - lib/ecs-rails/cluster_selector.rb
 - lib/ecs-rails/command.rb
+- lib/ecs-rails/command_executor.rb
 - lib/ecs-rails/command_factory.rb
 - lib/ecs-rails/console.rb
 - lib/ecs-rails/ecs_rails_configuration.rb
@@ -125,6 +130,8 @@ files:
 - lib/ecs-rails/service_selector.rb
 - lib/ecs-rails/task_selector.rb
 - lib/ecs-rails/version.rb
+- spec/bin/ecs_spec.rb
+- spec/spec_helper.rb
 homepage: https://rubygems.org/gems/ecs-rails
 licenses:
 - MIT