ecs_helper 0.0.25 → 0.0.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fcdfa5ea72481d6e07bea7f9bf9ec044ca79ece2c680233f538ed7a4e3a7683
-  data.tar.gz: de5b3ea5643b878c6c27989d8fce5a87771c3da25fef2968494fccd422e0774d
+  metadata.gz: d9360d89edeb8333e9caf152cb45a4a1d6042c3f614ab0d6d5d45e8d6bcd6e61
+  data.tar.gz: b3d2c66d829a1cf4b35e0d9dd476427287770fd14beb4e28729cc263d58ec878
 SHA512:
-  metadata.gz: 5061f5c736a06834cfd0486891b82aa5d93cd0938acb9d7c8f8e492e01269b4ee6aac18a5d73a1eeacbb5a8c0ee45c34ea31d358a1729cfc8def3771c7a77d6b
-  data.tar.gz: 4c488f4fc1b8badd9a82cee368dc1f21a7b505f047daa16ca51cf93f29e2559211d54a406ef2e05a6c3ffc39bf87d0192595129f7db871d2e0b70b00e0a925f9
+  metadata.gz: 20bc088dc9e4f3cbd8d04d83354faa39e3e319abcfe10335e0444fda5d755c32e883854f32a072c93f96129e98ba13b7d5dd53187a0b81dfc2cdcd3bc5bb8075
+  data.tar.gz: b588b0c7003c7e08afd46ce196b04cae8756c0c7b2ba3aafabbbc20c9a9e99ef319fc952d14f23a4bd9b19291714d20843149d86bb50371f689218868d5de4f3

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    ecs_helper (0.0.24)
+    ecs_helper (0.0.29)
       aws-sdk-ecr (~> 1.42, >= 1.42)
       aws-sdk-ecrpublic (~> 1.3, >= 1.3)
       aws-sdk-ecs (~> 1.80, >= 1.80)
+      aws-sdk-ssm (~> 1.0.0.rc7)
       colorize (~> 0.8, >= 0.8)
       json (~> 2.5, >= 2.5)
       terrapin (~> 0.6, >= 0.6)
@@ -17,13 +18,13 @@ GEM
     ast (2.4.2)
     awesome_print (1.9.2)
     aws-eventstream (1.2.0)
-    aws-partitions (1.496.0)
+    aws-partitions (1.503.0)
     aws-sdk-core (3.121.0)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.239.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-ecr (1.45.0)
+    aws-sdk-ecr (1.46.0)
       aws-sdk-core (~> 3, >= 3.120.0)
       aws-sigv4 (~> 1.1)
     aws-sdk-ecrpublic (1.6.0)
@@ -32,8 +33,12 @@ GEM
     aws-sdk-ecs (1.85.0)
       aws-sdk-core (~> 3, >= 3.120.0)
       aws-sigv4 (~> 1.1)
+    aws-sdk-ssm (1.0.0)
+      aws-sdk-core (~> 3)
+      aws-sigv4 (~> 1.0)
     aws-sigv4 (1.4.0)
       aws-eventstream (~> 1, >= 1.0.2)
+    bump (0.10.0)
     byebug (11.1.3)
     climate_control (0.2.0)
     coderay (1.1.3)
@@ -91,10 +96,12 @@ GEM
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
-  x86_64-linux-musl
+  x86_64-darwin-18
+  x86_64-linux
 
 DEPENDENCIES
   awesome_print
+  bump
   bundler (~> 2.2)
   ecs_helper!
   minitest
@@ -109,4 +116,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.2.22
+   2.2.27

data/Makefile

@@ -0,0 +1,30 @@
+.PHONY: test build bump-major bump-minor bump-patch help
+.DEFAULT_GOAL := test
+CURRENT_VERSION=$(shell bump current)
+NEXT_PATCH=$(shell bump show-next patch)
+NEXT_MINOR=$(shell bump show-next minor)
+NEXT_MAJOR=$(shell bump show-next major)
+GEM_VERSION=ecs_helper-${CURRENT_VERSION}.gem
+
+test: ## Run the unit tests
+	bundle exec rake --trace
+
+build: ## Build the ruby gem
+	gem build ecs_helper.gemspec
+
+push:
+	gem push ${GEM_VERSION}
+
+release:
+	bump set ${NEXT_PATCH}
+	make build
+	make push
+
+bump-major: ## Bump the major version (1.0.0 -> 2.0.0)
+	bump major
+
+bump-minor: ## Bump the minor version (0.1.0 -> 0.2.0)
+	bump minor
+
+bump-patch: ## Bump the patch version (0.0.1 -> 0.0.2)
+	bump patch

data/ecs_helper.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rubocop'
   s.add_development_dependency 'rubocop-minitest'
   s.add_development_dependency 'webmock'
+  s.add_development_dependency 'bump'
 
   s.add_development_dependency "bundler", "~> 2.2"
   s.add_development_dependency "rake"
@@ -36,6 +37,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'aws-sdk-ecr', '~> 1.42', '>= 1.42'
   s.add_runtime_dependency 'aws-sdk-ecrpublic', '~> 1.3', '>= 1.3'
   s.add_runtime_dependency 'aws-sdk-ecs', '~> 1.80', '>= 1.80'
+  s.add_runtime_dependency 'aws-sdk-ssm', '~> 1.0.0.rc7'
   s.add_runtime_dependency 'colorize', '~> 0.8', '>= 0.8'
   s.add_runtime_dependency 'json', '~> 2.5', '>= 2.5'
   s.add_runtime_dependency 'terrapin', '~> 0.6', '>= 0.6'

data/lib/ecs_helper/client.rb

@@ -1,11 +1,13 @@
 require 'aws-sdk-ecs'
 require 'aws-sdk-ecr'
+require 'aws-sdk-ssm'
 
 class ECSHelper::Client
-  attr_accessor :ecs, :ecr
+  attr_accessor :ecs, :ecr, :ssm
   def initialize
     @ecs = Aws::ECS::Client.new
     @ecr = Aws::ECR::Client.new
+    @ssm = Aws::SSM::Client.new
   end
 
   # ECS
@@ -54,6 +56,14 @@ class ECSHelper::Client
     ecs.describe_tasks(params).tasks
   end
 
+  def list_tasks(params = {})
+    ecs.list_tasks(params).task_arns
+  end
+
+  def execute_command(params = {})
+    ecs.execute_command(params)
+  end
+
   # ECR
   def private_repositories(params = {})
     ecr.describe_repositories(params).repositories
@@ -62,4 +72,9 @@ class ECSHelper::Client
   def describe_images(params = {})
     ecr.describe_images(params).image_details[0]
   end
+
+  # SSM
+  def get_ssm_parameters(params = {})
+    ssm.get_parameters(params).parameters
+  end
 end

data/lib/ecs_helper/command/base.rb

@@ -6,6 +6,7 @@ class ECSHelper::Command::Base
   include ECSHelper::Logging
   attr_accessor :type, :options, :helper, :client, :option_parser
 
+
   def initialize(helper)
     @client = helper.client
     @helper = helper
@@ -21,6 +22,15 @@ class ECSHelper::Command::Base
     helper.project
   end
 
+  def check_bin(bin)
+    check_cmd = Terrapin::CommandLine.new("which #{bin}")
+    result = check_cmd.run
+    "success"
+  rescue Terrapin::CommandNotFoundError, Terrapin::ExitStatusError => e
+    messages = ["#{bin} not found"]
+    raise ECSHelper::Error::BinNotFound.new(messages)
+  end
+
   def application
     helper.application
   end
@@ -28,20 +38,26 @@ class ECSHelper::Command::Base
   def validate
     required.each do |r|
       value = options[r]
-      unless value
-        puts "'#{r}' required for command '#{type}'".light_white
-        puts option_parser.help
-        exit
+      if value.nil?
+        messages = [
+          "'#{r}' required for command '#{type}'".light_white,
+          option_parser.help
+        ]
+        raise ECSHelper::Error::CommandValidationError.new(messages)
       end
     end
   end
 
-  private
-
   def required
     []
   end
 
+  def printable?
+    false
+  end
+
+  private
+
   def processEqual(value)
     value.start_with?('=') ? value[1..-1] : value
   end

data/lib/ecs_helper/command/exec.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require 'terrapin'
+
+class ECSHelper::Command::Exec < ECSHelper::Command::Base
+  def cmd_option_parser
+    options = { command: 'bash -c' }
+    parser = ::OptionParser.new do |opts|
+      opts.banner = 'Usage: ecs_helper exec [options]. require session-manager-plugin and aws cli v2'
+      opts.on('-p VALUE', '--project VALUE',
+              "Set project name, if not specified will look at ENV['PROJECT'], will be used to detect cluster") do |p|
+        options[:project] = processEqual(p)
+      end
+      opts.on('-a VALUE', '--application VALUE',
+              "Set application name, if not specified will look at ENV['APPLICATION'], will be used to detect service and task definition") do |a|
+        options[:application] = processEqual(a)
+      end
+      opts.on('-c', '--container VALUE', 'Cache image before build, default false') { |c| options[:container] = c }
+      opts.on('--command VALUE', 'Command to execute') { |c| options[:command] = c }
+    end
+    [parser, options]
+  end
+
+  def required
+    [:container]
+  end
+
+  def check_session_manager_plugin
+    check_bin('session-manager-plugin')
+  end
+
+  def check_aws_cli_version
+    check_cmd = Terrapin::CommandLine.new("aws --version")
+    result = check_cmd.run
+    version = parse_version(result)
+    if version === "1"
+      messages = [
+        "Exec command requires aws cli v2".light_white,
+        cmd_option_parser[0].help
+      ]
+      raise ECSHelper::Error::CommandValidationError.new(messages)
+    end
+  end
+
+  def check_aws_cli
+    check_bin('aws')
+    check_aws_cli_version
+    "success"
+  end
+
+
+  def check_aws_cli_version
+    check_cmd = Terrapin::CommandLine.new("aws --version")
+    result = check_cmd.run
+    version = parse_version(result)
+    if version === "1"
+      messages = [
+        "Exec command requires aws cli v2".light_white,
+        cmd_option_parser[0].help
+      ]
+      raise ECSHelper::Error::CommandValidationError.new(messages)
+    end
+  end
+
+  def run
+    log("Command", type)
+    log("Cluster", cluster_arn)
+    log("Service", service_arn)
+    log("Task", task_arn)
+    log("Options", options)
+    log("Check session-manager-plugin ", check_session_manager_plugin)
+    log("Check aws cli version", check_aws_cli)
+    exec
+  end
+
+  def exec
+    exec_cmd = Terrapin::CommandLine.new("aws ecs execute-command --cluster #{cluster_arn} --task #{task_arn}  --container=#{helper.options[:container]} --command=#{helper.options[:command]}  --interactive")
+    # --region us-east-1
+    exec_cmd.run
+  end
+
+  private
+
+  def parse_version(string)
+    string.split('/')[1][0]
+  end
+
+  def cluster_arn
+    helper.current_cluster
+  end
+
+  def service_arn
+    helper.current_service
+  end
+
+  def task_arn
+    @task_arn ||= helper.client.list_tasks({cluster: cluster_arn, service_name: service_arn, desired_status: "RUNNING"})[0]
+  end
+end

data/lib/ecs_helper/command/export_env_secrets.rb

@@ -0,0 +1,51 @@
+require 'terrapin'
+
+class ECSHelper::Command::ExportEnvSecrets < ECSHelper::Command::Base
+  attr_accessor :params
+
+  def cmd_option_parser
+    options = {
+      env_vars: []
+    }
+    parser = ::OptionParser.new do |opts|
+      opts.banner = "Usage: ecs_helper export_env_secrets"
+      opts.on('-n', '--name=VARIABLE', '') { |o| options[:env_vars] << o }
+    end
+    [parser, options]
+  end
+
+  def required
+    []
+  end
+
+  def printable?
+    true
+  end
+
+  def run
+    return log("No ENV secrets to export. Please pass ENV variables names using -n") if options[:env_vars].empty?
+    export_values
+  end
+
+  private
+
+  def to_aws_ssm_name(name)
+    "/#{helper.project}-#{helper.application}-#{helper.environment}/#{name}"
+  end
+
+  def export_values
+    params_name = options[:env_vars].map {|var_name| to_aws_ssm_name(var_name)}
+    aws_ssm_params = client.get_ssm_parameters(names: params_name, with_decryption: true)
+
+    variables = (['export'] + aws_ssm_params.map do |aws_ssm_param|
+      next if aws_ssm_param.empty?
+      value = aws_ssm_param.value
+      name = aws_ssm_param.name.split('/').last
+
+      "#{name}=#{value}"
+    rescue Aws::SSM::Errors::ParameterNotFound
+      next
+    end).join(' ')
+    variables
+  end
+end

data/lib/ecs_helper/command/export_images.rb

@@ -14,8 +14,12 @@ class ECSHelper::Command::ExportImages < ECSHelper::Command::Base
     []
   end
 
+  def printable?
+    true
+  end
+
   def run
-    puts export_images
+    export_images
   end
 
   private

data/lib/ecs_helper/command.rb

@@ -5,7 +5,9 @@ class ECSHelper::Command
   autoload :Deploy, 'ecs_helper/command/deploy'
   autoload :ExportImages, 'ecs_helper/command/export_images'
   autoload :ECRLogin, 'ecs_helper/command/ecr_login'
+  autoload :Exec, 'ecs_helper/command/exec'
   autoload :RunCommand, 'ecs_helper/command/run_command'
+  autoload :ExportEnvSecrets, 'ecs_helper/command/export_env_secrets'
 
   CMD_MAPPING  = {
     "build_and_push" => BuildAndPush,
@@ -13,6 +15,8 @@ class ECSHelper::Command
     "export_images" => ExportImages,
     "ecr_login" => ECRLogin,
     "run_command" => RunCommand,
+    "export_env_secrets" => ExportEnvSecrets,
+    "exec" => Exec,
   }
   AVAILABLE_COMMANDS = CMD_MAPPING.keys
 
@@ -41,7 +45,9 @@ class ECSHelper::Command
 
   def run
     command.validate
-    command.run
+    result = command.run
+    puts result if command.printable?
+    result
   end
 end
 

data/lib/ecs_helper/error/bin_not_found.rb

@@ -0,0 +1,2 @@
+class ECSHelper::Error::BinNotFound < ECSHelper::Error::Base
+end

data/lib/ecs_helper/error/command_validation_error.rb

@@ -0,0 +1,2 @@
+class ECSHelper::Error::CommandValidationError < ECSHelper::Error::Base
+end

data/lib/ecs_helper/error.rb

@@ -3,4 +3,6 @@
 class ECSHelper::Error
   autoload :Base, 'ecs_helper/error/base'
   autoload :CommandNotFound, 'ecs_helper/error/command_not_found'
+  autoload :CommandValidationError, 'ecs_helper/error/command_validation_error'
+  autoload :BinNotFound, 'ecs_helper/error/bin_not_found'
 end

data/lib/ecs_helper/logging.rb

@@ -1,6 +1,6 @@
 module ECSHelper::Logging
   def console(message)
-    puts message if ENV["SKIP_LOGS"].nil?
+    puts message if ENV["SKIP_LOGS"] != 'true'
   end
 
   def log(title, message = nil, color = "light_white")

data/lib/ecs_helper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class ECSHelper
-  VERSION = '0.0.25'
+  VERSION = '0.0.29'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecs_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.25
+  version: 0.0.29
 platform: ruby
 authors:
 - Artem Petrov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-19 00:00:00.000000000 Z
+date: 2021-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -238,6 +252,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.80'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ssm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc7
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -309,6 +337,7 @@ files:
 - Dockerfile
 - Gemfile
 - Gemfile.lock
+- Makefile
 - Rakefile
 - bin/console
 - bin/ecs_helper
@@ -322,12 +351,16 @@ files:
 - lib/ecs_helper/command/build_and_push.rb
 - lib/ecs_helper/command/deploy.rb
 - lib/ecs_helper/command/ecr_login.rb
+- lib/ecs_helper/command/exec.rb
+- lib/ecs_helper/command/export_env_secrets.rb
 - lib/ecs_helper/command/export_images.rb
 - lib/ecs_helper/command/run_command.rb
 - lib/ecs_helper/common_helper.rb
 - lib/ecs_helper/error.rb
 - lib/ecs_helper/error/base.rb
+- lib/ecs_helper/error/bin_not_found.rb
 - lib/ecs_helper/error/command_not_found.rb
+- lib/ecs_helper/error/command_validation_error.rb
 - lib/ecs_helper/logging.rb
 - lib/ecs_helper/service_helper.rb
 - lib/ecs_helper/task_definition_helper.rb