ecs_helper 0.0.28 → 0.0.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7d7e1d62103b4759b19005b1bc248f562749be0bc5f7c5b1b351d2e5a7874f8
-  data.tar.gz: 8d2d35ef50190a45ed9ea689485d43776026eef91c496a3353c200a42c50389f
+  metadata.gz: 961fe1a06c1f8f0db5b128e0e06b4c531298cf9e4361b931108501044ff94f0e
+  data.tar.gz: 5a52f1efc1f95ee616d9e6728ebe04f8d128abe61ec8221ef1655a128d550641
 SHA512:
-  metadata.gz: 4440e1cc6a9cec9f38e8ea485c86131ebdf15635464bf577b02cb6557b908f43a1769b5289b826815d9ad8282c14446677f6b478a1771ce82706beeb2ea4d04d
-  data.tar.gz: c4cf0985abb1934130d7ad7266554d4c30643de641e2f3e3bb3d7b625fe1eb0b9c5c88d70ff935f2e9663d1ddb65e8c3782069782c8b4dd8aafb06ffa6644901
+  metadata.gz: aaae93742329f95d0abdde33a6df3b2d57645ae37920a94983cef2c77b9aa414ca186735e8cbd1b50155e2c06021058d8ac4c87d42fb5dc5497c3eab351950e3
+  data.tar.gz: d67641f9d8a1d4f97b95c6c5cca89ce1ac171eeda031388520613500482aee6b7df213d6b2473a91f3a9aea72911fb34113cd8e8ed7bdae8d6102d2a97c4f6e1

data/Gemfile.lock

@@ -1,13 +1,12 @@
 PATH
   remote: .
   specs:
-    ecs_helper (0.0.28)
+    ecs_helper (0.0.32)
       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)
 
 GEM
@@ -18,19 +17,19 @@ GEM
     ast (2.4.2)
     awesome_print (1.9.2)
     aws-eventstream (1.2.0)
-    aws-partitions (1.503.0)
-    aws-sdk-core (3.121.0)
+    aws-partitions (1.515.0)
+    aws-sdk-core (3.121.1)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.239.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-ecr (1.46.0)
+    aws-sdk-ecr (1.47.0)
       aws-sdk-core (~> 3, >= 3.120.0)
       aws-sigv4 (~> 1.1)
     aws-sdk-ecrpublic (1.6.0)
       aws-sdk-core (~> 3, >= 3.120.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-ecs (1.85.0)
+    aws-sdk-ecs (1.86.0)
       aws-sdk-core (~> 3, >= 3.120.0)
       aws-sigv4 (~> 1.1)
     aws-sdk-ssm (1.0.0)
@@ -47,7 +46,6 @@ GEM
       rexml
     hashdiff (1.0.1)
     jmespath (1.4.0)
-    json (2.5.1)
     method_source (1.0.0)
     minitest (5.14.4)
     minitest-power_assert (0.3.1)
@@ -96,6 +94,7 @@ GEM
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
+  aarch64-linux
   x86_64-darwin-18
   x86_64-linux
 

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

@@ -39,7 +39,5 @@ Gem::Specification.new do |s|
   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'
-
 end

data/lib/ecs_helper/client.rb

@@ -56,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

data/lib/ecs_helper/command/base.rb

@@ -22,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
@@ -29,10 +38,12 @@ 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

data/lib/ecs_helper/command/build_and_push.rb

@@ -24,6 +24,7 @@ class ECSHelper::Command::BuildAndPush < ECSHelper::Command::Base
       end
       opts.on('-c', '--cache', 'Cache image before build, default false') { options[:cache] = true }
       opts.on('--build-arg=VALUE', 'Pass --build-arg to the build command') { |o| options[:build_args] << o }
+      opts.on('-e', '--env-prefix', 'Add environment name as a prefix to the version tag, default false') { options[:env_prefix] = true }
     end
     [parser, options]
   end
@@ -90,7 +91,11 @@ class ECSHelper::Command::BuildAndPush < ECSHelper::Command::Base
   end
 
   def version_tag
-    "#{repository}:#{helper.version}"
+    if options[:env_prefix]
+      "#{repository}:#{helper.environment}-#{helper.version}"
+    else
+      "#{repository}:#{helper.version}"
+    end
   end
 
   def project

data/lib/ecs_helper/command/check_exec.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'terrapin'
+
+class ECSHelper::Command::CheckExec < ECSHelper::Command::Base
+  def cmd_option_parser
+    options = { command: 'bash -c' }
+    parser = ::OptionParser.new do |opts|
+      opts.banner = 'Usage: ecs_helper check_exec'
+      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
+    end
+    [parser, options]
+  end
+
+  def check_exec_bin
+    check_bin('check-ecs-exec')
+  end
+
+  def check_exec
+    exec_cmd = Terrapin::CommandLine.new("check-ecs-exec #{cluster_arn} #{task_arn}")
+    exec_cmd.run
+  end
+
+  def printable?
+    true
+  end
+
+  def run
+    log("Command", type)
+    log("Cluster", cluster_arn)
+    log("Service", service_arn)
+    log("Task", task_arn)
+    log("Options", options)
+    log("Check bin", check_exec_bin)
+    check_exec
+  end
+
+  private
+
+  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/exec.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'terrapin'
+
+class ECSHelper::Command::Exec < ECSHelper::Command::Base
+  def cmd_option_parser
+    options = { command: '/bin/bash' }
+    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] = processEqual(c) }
+      opts.on('--command VALUE', 'Command to execute') { |c| options[:command] = processEqual(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
+  end
+
+  def printable?
+    true
+  end
+
+  def run
+    check_session_manager_plugin
+    check_aws_cli
+    exec_command
+  end
+
+  def exec_command
+    "aws ecs execute-command --cluster #{cluster_arn} --task #{task_arn} --container #{helper.options[:container]} --command #{helper.options[:command]} --interactive"
+  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.rb

@@ -5,6 +5,8 @@ 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 :CheckExec, 'ecs_helper/command/check_exec'
   autoload :RunCommand, 'ecs_helper/command/run_command'
   autoload :ExportEnvSecrets, 'ecs_helper/command/export_env_secrets'
 
@@ -15,6 +17,8 @@ class ECSHelper::Command
     "ecr_login" => ECRLogin,
     "run_command" => RunCommand,
     "export_env_secrets" => ExportEnvSecrets,
+    "exec" => Exec,
+    "check_exec" => CheckExec,
   }
   AVAILABLE_COMMANDS = CMD_MAPPING.keys
 

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.28'
+  VERSION = '0.0.32'
 end

data/lib/ecs_helper.rb

@@ -6,6 +6,8 @@ class ECSHelper
   extend Forwardable
   attr_accessor :options, :client, :command, :parser, :cluster_helper, :service_helper, :common_helper
 
+
+  autoload :VERSION, 'ecs_helper/version'
   autoload :Client, 'ecs_helper/client'
   autoload :CommonHelper, 'ecs_helper/common_helper'
   autoload :ClusterHelper, 'ecs_helper/cluster_helper'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecs_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.28
+  version: 0.0.32
 platform: ruby
 authors:
 - Artem Petrov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-20 00:00:00.000000000 Z
+date: 2021-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -196,60 +196,60 @@ dependencies:
   name: aws-sdk-ecr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.42'
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.42'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.42'
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.42'
 - !ruby/object:Gem::Dependency
   name: aws-sdk-ecrpublic
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: aws-sdk-ecs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.80'
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.80'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.80'
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.80'
 - !ruby/object:Gem::Dependency
@@ -270,60 +270,40 @@ dependencies:
   name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.8'
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.5'
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.5'
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: terrapin
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.6'
 description: A simple gem which make CI CD process easier for AWS ECS service
@@ -337,6 +317,7 @@ files:
 - Dockerfile
 - Gemfile
 - Gemfile.lock
+- Makefile
 - Rakefile
 - bin/console
 - bin/ecs_helper
@@ -348,15 +329,19 @@ files:
 - lib/ecs_helper/command.rb
 - lib/ecs_helper/command/base.rb
 - lib/ecs_helper/command/build_and_push.rb
+- lib/ecs_helper/command/check_exec.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
@@ -365,7 +350,7 @@ homepage: https://github.com/artempartos/ecs_helper
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -380,8 +365,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6
+signing_key:
 specification_version: 4
 summary: ECSHelper
 test_files: []