ecs_deploy_cli 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3c493de7ebb99888eb436db698b8215291b733983ac8b37a16e7842c8588d0d
-  data.tar.gz: 34f5613fef2b6746196ed91b3c67d358c02bdafcf89703e1704c2b5e93ca987d
+  metadata.gz: 0be6eaeb2fd7c5c088b90f3b37983fa859d281620bbcc8c887159a22e8aaa1b8
+  data.tar.gz: 9b59b8669defa19eec6af2946c44b2ff0dff4c2a5b01497685923e09b5779f24
 SHA512:
-  metadata.gz: aa4641ecfd920aa198310ef81cd00f9f173d0fa3c98066172792e0c4d74cd09009c1c000f20ee128be9374e037c3ada0002f44e8a51a0ac7895b1a376699eb22
-  data.tar.gz: 3144d96e6f64b42faf4d47ffad4c2dfcbd4c818507978491b42586842730ae36a9c3d0cf367d00845dc347d87abc90e05ae7181264adec243d02078b19deee8d
+  metadata.gz: 103a4642983b04c15ed353be27367a317f7de14593676080ee493328756d17549a8717c647cabcef7739ce6000fc09649000f5ce20c7c6e6a0c1cc8857546c0c
+  data.tar.gz: 133202293bc169a56890081c13a8cf866ce77ac3c2c2a284a21b68f4010a00bd478d3eb9b636182ebc490bf210c4cf680dbe83205207d8847fd594b427af1733

data/lib/ecs_deploy_cli/runners/base.rb

@@ -97,6 +97,16 @@ module EcsDeployCli
         end
       end
 
+      def iam_client
+        @iam_client ||= begin
+          require 'aws-sdk-iam'
+          Aws::IAM::Client.new(
+            profile: ENV.fetch('AWS_PROFILE', 'default'),
+            region: config[:aws_region]
+          )
+        end
+      end
+
       def config
         @parser.config
       end

data/lib/ecs_deploy_cli/runners/setup.rb

@@ -3,33 +3,43 @@
 module EcsDeployCli
   module Runners
     class Setup < Base
+      REQUIRED_ECS_ROLES = {
+        'ecsInstanceRole' => 'https://docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html',
+        'ecsTaskExecutionRole' => 'https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html'
+      }.freeze
+      class SetupError < StandardError; end
+
       def run!
         services, resolved_tasks, _, cluster_options = @parser.resolve
 
+        ensure_ecs_roles_exists!
+
         setup_cluster! cluster_options
         setup_services! services, resolved_tasks: resolved_tasks
+      rescue SetupError => e
+        EcsDeployCli.logger.info e.message
       end
 
       private
 
       def setup_cluster!(cluster_options)
-        clusters = ecs_client.describe_clusters(clusters: [config[:cluster]]).to_h[:clusters]
-        if clusters.length == 1
+        if cluster_exists?
           EcsDeployCli.logger.info 'Cluster already created, skipping.'
           return
         end
 
         EcsDeployCli.logger.info "Creating cluster #{config[:cluster]}..."
 
+        create_keypair_if_required! cluster_options
         params = create_params(cluster_options)
 
         ecs_client.create_cluster(
           cluster_name: config[:cluster]
         )
+        EcsDeployCli.logger.info 'Cluster created, now running cloudformation...'
 
         stack_name = "EC2ContainerService-#{config[:cluster]}"
 
-
         cf_client.create_stack(
           stack_name: stack_name,
           template_body: File.read(File.join(__dir__, '..', 'cloudformation', 'default.yml')),
@@ -38,12 +48,13 @@ module EcsDeployCli
         )
 
         cf_client.wait_until(:stack_create_complete, { stack_name: stack_name }, delay: 30, max_attempts: 120)
-        EcsDeployCli.logger.info "Cluster #{config[:cluster]} created!"
+        EcsDeployCli.logger.info "Cluster #{config[:cluster]} created! 🎉"
       end
 
       def setup_services!(services, resolved_tasks:)
         services.each do |service_name, service_definition|
-          if ecs_client.describe_services(cluster: config[:cluster], services: [service_name]).to_h[:services].any?
+          existing_services = ecs_client.describe_services(cluster: config[:cluster], services: [service_name]).to_h[:services].filter { |s| s[:status] != 'INACTIVE' }
+          if existing_services.any?
             EcsDeployCli.logger.info "Service #{service_name} already created, skipping."
             next
           end
@@ -54,7 +65,7 @@ module EcsDeployCli
 
           ecs_client.create_service(
             cluster: config[:cluster],
-            desired_count: 1,
+            desired_count: 1, # FIXME: this should be a parameter
             load_balancers: service_definition.as_definition(task_definition)[:load_balancers],
             service_name: service_name,
             task_definition: task_name
@@ -110,6 +121,29 @@ module EcsDeployCli
         }
       end
 
+      def cluster_exists?
+        clusters = ecs_client.describe_clusters(clusters: [config[:cluster]]).to_h[:clusters]
+
+        clusters.filter { |c| c[:status] != 'INACTIVE' }.length == 1
+      end
+
+      def ensure_ecs_roles_exists!
+        REQUIRED_ECS_ROLES.each do |role_name, link|
+          iam_client.get_role(role_name: role_name).to_h
+        rescue Aws::IAM::Errors::NoSuchEntity
+          raise SetupError, "IAM Role #{role_name} does not exist. Please create it: #{link}."
+        end
+      end
+
+      def create_keypair_if_required!(cluster_options)
+        ec2_client.describe_key_pairs(key_names: [cluster_options[:keypair_name]]).to_h[:key_pairs]
+      rescue Aws::EC2::Errors::InvalidKeyPairNotFound
+        EcsDeployCli.logger.info "Keypair \"#{cluster_options[:keypair_name]}\" not found, creating it..."
+        key_material = ec2_client.create_key_pair(key_name: cluster_options[:keypair_name]).to_h[:key_material]
+        File.write("#{cluster_options[:keypair_name]}.pem", key_material)
+        EcsDeployCli.logger.info "Created PEM file at #{Dir.pwd}/#{cluster_options[:keypair_name]}.pem"
+      end
+
       def format_cloudformation_params(params)
         params.map { |k, v| { parameter_key: k, parameter_value: v.to_s } }
       end

data/lib/ecs_deploy_cli/runners/update_crons.rb

@@ -8,16 +8,13 @@ module EcsDeployCli
 
         crons.each do |cron_name, cron_definition|
           task_definition = tasks[cron_definition[:task_name]]
-          raise "Undefined task #{cron_definition[:task_name].inspect} in (#{tasks.keys.inspect})" unless task_definition
+          unless task_definition
+            raise "Undefined task #{cron_definition[:task_name].inspect} in (#{tasks.keys.inspect})"
+          end
 
           updated_task = _update_task(task_definition)
 
-          current_target = cwe_client.list_targets_by_rule(
-            {
-              rule: cron_name,
-              limit: 1
-            }
-          ).to_h[:targets].first
+          current_target = load_or_init_target(cron_name)
 
           cwe_client.put_rule(
             cron_definition[:rule]
@@ -36,6 +33,18 @@ module EcsDeployCli
           EcsDeployCli.logger.info "Deployed scheduled task \"#{cron_name}\"!"
         end
       end
+
+      private
+
+      def load_or_init_target(cron_name)
+        cwe_client.list_targets_by_rule({ rule: cron_name, limit: 1 }).to_h[:targets].first
+      rescue Aws::CloudWatchEvents::Errors::ResourceNotFoundException
+        {
+          id: cron_name,
+          arn: "arn:aws:ecs:#{config[:aws_region]}:#{config[:aws_profile_id]}:cluster/#{config[:cluster]}",
+          role_arn: "arn:aws:iam::#{config[:aws_profile_id]}:role/ecsEventsRole"
+        }
+      end
     end
   end
 end

data/lib/ecs_deploy_cli/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EcsDeployCli
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/spec/ecs_deploy_cli/runner_spec.rb

@@ -6,11 +6,13 @@ require 'aws-sdk-cloudwatchlogs'
 require 'aws-sdk-ec2'
 require 'aws-sdk-ssm'
 require 'aws-sdk-cloudformation'
+require 'aws-sdk-iam'
 
 describe EcsDeployCli::Runner do
   context 'defines task data' do
     let(:parser) { EcsDeployCli::DSL::Parser.load('spec/support/ECSFile') }
     subject { described_class.new(parser) }
+    let(:mock_iam_client) { Aws::IAM::Client.new(stub_responses: true) }
     let(:mock_cf_client) { Aws::CloudFormation::Client.new(stub_responses: true) }
     let(:mock_ssm_client) { Aws::SSM::Client.new(stub_responses: true) }
     let(:mock_ecs_client) { Aws::ECS::Client.new(stub_responses: true) }
@@ -90,24 +92,77 @@ describe EcsDeployCli::Runner do
         ENV['AWS_REGION'] = nil
       end
 
-      it '#setup!' do
-        mock_ssm_client.stub_responses(:get_parameter, {
-                                         parameter: {
-                                           name: '/aws/service/ecs/optimized-ami/amazon-linux-2/recommended',
-                                           type: 'String',
-                                           value: '{"schema_version":1,"image_name":"amzn2-ami-ecs-hvm-2.0.20210331-x86_64-ebs","image_id":"ami-03bbf53329af34379","os":"Amazon Linux 2","ecs_runtime_version":"Docker version 19.03.13-ce","ecs_agent_version":"1.51.0"}'
-                                         }
-                                       })
+      context '#setup!' do
+        before do
+          mock_ssm_client.stub_responses(
+            :get_parameter, {
+              parameter: {
+                name: '/aws/service/ecs/optimized-ami/amazon-linux-2/recommended',
+                type: 'String',
+                value: '{"schema_version":1,"image_name":"amzn2-ami-ecs-hvm-2.0.20210331-x86_64-ebs","image_id":"ami-03bbf53329af34379","os":"Amazon Linux 2","ecs_runtime_version":"Docker version 19.03.13-ce","ecs_agent_version":"1.51.0"}'
+              }
+            }
+          )
+        end
 
-        expect(mock_cf_client).to receive(:wait_until)
-        expect(mock_ecs_client).to receive(:create_service)
+        it 'setups the cluster correctly' do
+          expect(mock_ec2_client).to receive(:describe_key_pairs).and_return(key_pairs: [{ key_id: 'some' }])
 
-        expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:cwl_client).at_least(:once).and_return(mock_cwl_client)
-        expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:ecs_client).at_least(:once).and_return(mock_ecs_client)
-        expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:ssm_client).at_least(:once).and_return(mock_ssm_client)
-        expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:cf_client).at_least(:once).and_return(mock_cf_client)
+          expect(mock_iam_client).to receive(:get_role).at_least(:once).and_return({ role: { arn: 'some' } })
+          expect(mock_cf_client).to receive(:wait_until)
+          expect(mock_ecs_client).to receive(:create_service)
+
+          expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:ec2_client).at_least(:once).and_return(mock_ec2_client)
+          expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:iam_client).at_least(:once).and_return(mock_iam_client)
+          expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:cwl_client).at_least(:once).and_return(mock_cwl_client)
+          expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:ecs_client).at_least(:once).and_return(mock_ecs_client)
+          expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:ssm_client).at_least(:once).and_return(mock_ssm_client)
+          expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:cf_client).at_least(:once).and_return(mock_cf_client)
+
+          subject.setup!
+        end
+
+        it 'fails if the IAM role is not setup' do
+          expect(EcsDeployCli.logger).to receive(:info).at_least(:once) do |message|
+            puts message
+          end
+
+          expect(mock_iam_client).to receive(:get_role).at_least(:once) do
+            raise Aws::IAM::Errors::NoSuchEntity.new(nil, 'some')
+          end
+
+          expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:iam_client).at_least(:once).and_return(mock_iam_client)
+
+          expect { subject.setup! }.to output(/IAM Role ecsInstanceRole does not exist./).to_stdout
+        end
+
+        it 'fails if the cluster is already there' do
+          expect(mock_ecs_client).to receive(:describe_clusters).and_return(clusters: [{}])
+
+          expect(EcsDeployCli.logger).to receive(:info).at_least(:once) do |message|
+            puts message
+          end
+
+          expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:cwl_client).at_least(:once).and_return(mock_cwl_client)
+          expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:iam_client).at_least(:once).and_return(mock_iam_client)
+          expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:ecs_client).at_least(:once).and_return(mock_ecs_client)
+
+          expect { subject.setup! }.to output(/Cluster already created, skipping./).to_stdout
+        end
 
-        subject.setup!
+        it 'creates the keypair if not there' do
+          expect(mock_ec2_client).to receive(:describe_key_pairs) do
+            raise Aws::EC2::Errors::InvalidKeyPairNotFound.new(nil, 'some')
+          end
+
+          expect(mock_ec2_client).to receive(:create_key_pair) { raise 'created keypair' }
+
+          expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:ec2_client).at_least(:once).and_return(mock_ec2_client)
+          expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:iam_client).at_least(:once).and_return(mock_iam_client)
+          expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:ecs_client).at_least(:once).and_return(mock_ecs_client)
+
+          expect { subject.setup! }.to raise_error('created keypair')
+        end
       end
 
       context '#ssh' do
@@ -119,9 +174,11 @@ describe EcsDeployCli::Runner do
           expect(mock_ec2_client).to receive(:describe_instances)
             .with(instance_ids: ['i-123123'])
             .and_return(
-              double(reservations: [
-                      double(instances: [double(public_dns_name: 'test.com')])
-                    ])
+              double(
+                reservations: [
+                  double(instances: [double(public_dns_name: 'test.com')])
+                ]
+              )
             )
 
           expect(Process).to receive(:fork) do |&block|
@@ -156,8 +213,8 @@ describe EcsDeployCli::Runner do
             .with(instance_ids: ['i-321321'])
             .and_return(
               double(reservations: [
-                      double(instances: [double(public_dns_name: 'test.com')])
-                    ])
+                       double(instances: [double(public_dns_name: 'test.com')])
+                     ])
             )
 
           expect(Process).to receive(:fork) do |&block|
@@ -195,16 +252,32 @@ describe EcsDeployCli::Runner do
         subject.run_task!('yourproject-cron', launch_type: 'FARGATE', security_groups: [], subnets: [])
       end
 
-      it '#update_crons!' do
-        mock_ecs_client.stub_responses(:register_task_definition, { task_definition: { family: 'some', revision: 1, task_definition_arn: 'arn:task:eu-central-1:xxxx' } })
+      context '#update_crons!' do
+        it 'creates missing crons' do
+          mock_ecs_client.stub_responses(:register_task_definition, { task_definition: { family: 'some', revision: 1, task_definition_arn: 'arn:task:eu-central-1:xxxx' } })
 
-        mock_cwe_client.stub_responses(:list_targets_by_rule, { targets: [{ id: '123', arn: 'arn:123' }] })
+          expect(mock_cwe_client).to receive(:list_targets_by_rule) do
+            raise Aws::CloudWatchEvents::Errors::ResourceNotFoundException.new(nil, 'some')
+          end
 
-        expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:cwl_client).at_least(:once).and_return(mock_cwl_client)
-        expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:ecs_client).at_least(:once).and_return(mock_ecs_client)
-        expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:cwe_client).at_least(:once).and_return(mock_cwe_client)
+          expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:cwl_client).at_least(:once).and_return(mock_cwl_client)
+          expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:ecs_client).at_least(:once).and_return(mock_ecs_client)
+          expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:cwe_client).at_least(:once).and_return(mock_cwe_client)
+
+          subject.update_crons!
+        end
+
+        it 'updates existing crons' do
+          mock_ecs_client.stub_responses(:register_task_definition, { task_definition: { family: 'some', revision: 1, task_definition_arn: 'arn:task:eu-central-1:xxxx' } })
 
-        subject.update_crons!
+          mock_cwe_client.stub_responses(:list_targets_by_rule, { targets: [{ id: '123', arn: 'arn:123' }] })
+
+          expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:cwl_client).at_least(:once).and_return(mock_cwl_client)
+          expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:ecs_client).at_least(:once).and_return(mock_ecs_client)
+          expect_any_instance_of(EcsDeployCli::Runners::Base).to receive(:cwe_client).at_least(:once).and_return(mock_cwe_client)
+
+          subject.update_crons!
+        end
       end
 
       it '#update_services!' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ecs_deploy_cli
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Mònade
@@ -115,6 +115,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-iam
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -251,22 +265,22 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.8
+rubygems_version: 3.2.7
 signing_key:
 specification_version: 4
 summary: A command line interface to make ECS deployments easier
 test_files:
-- spec/ecs_deploy_cli/cli_spec.rb
-- spec/ecs_deploy_cli/dsl/cluster_spec.rb
-- spec/ecs_deploy_cli/dsl/container_spec.rb
-- spec/ecs_deploy_cli/dsl/cron_spec.rb
-- spec/ecs_deploy_cli/dsl/parser_spec.rb
-- spec/ecs_deploy_cli/dsl/service_spec.rb
-- spec/ecs_deploy_cli/dsl/task_spec.rb
-- spec/ecs_deploy_cli/runner_spec.rb
-- spec/ecs_deploy_cli/runners/base_spec.rb
 - spec/spec_helper.rb
 - spec/support/ECSFile
 - spec/support/ECSFile.minimal
-- spec/support/env_file.ext.yml
 - spec/support/env_file.yml
+- spec/support/env_file.ext.yml
+- spec/ecs_deploy_cli/runner_spec.rb
+- spec/ecs_deploy_cli/cli_spec.rb
+- spec/ecs_deploy_cli/runners/base_spec.rb
+- spec/ecs_deploy_cli/dsl/task_spec.rb
+- spec/ecs_deploy_cli/dsl/parser_spec.rb
+- spec/ecs_deploy_cli/dsl/service_spec.rb
+- spec/ecs_deploy_cli/dsl/cron_spec.rb
+- spec/ecs_deploy_cli/dsl/cluster_spec.rb
+- spec/ecs_deploy_cli/dsl/container_spec.rb