🆕 Raise error if ecsInstanceRole does not exist

Author: ProGM

ecs-deploy-cli.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'aws-sdk-ec2', '~> 1'
   s.add_dependency 'aws-sdk-ecs', '~> 1'
   s.add_dependency 'aws-sdk-ssm', '~> 1'
+  s.add_dependency 'aws-sdk-iam', '~> 1'
   s.add_dependency 'colorize', '~> 0.8.1'
   s.add_dependency 'hashdiff', '~> 1.0'
   s.add_dependency 'thor', '~> 1.1'

lib/ecs_deploy_cli/runners/setup.rb

@@ -13,12 +13,16 @@ def run!
       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
 
+        unless ecs_instance_role_exists?
+          EcsDeployCli.logger.info 'IAM Role ecsInstanceRole does not exist. Please create it: https://docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html.'
+          return
+        end
+
         EcsDeployCli.logger.info "Creating cluster #{config[:cluster]}..."
 
         params = create_params(cluster_options)
@@ -110,6 +114,19 @@ def create_params(cluster_options)
         }
       end
 
+      def cluster_exists?
+        clusters = ecs_client.describe_clusters(clusters: [config[:cluster]]).to_h[:clusters]
+
+        clusters.length == 1
+      end
+
+      def ecs_instance_role_exists?
+        role = iam_client.get_role(role_name: 'ecsInstanceRole').to_h
+        true
+      rescue Aws::IAM::Errors::NoSuchEntity
+        false
+      end
+
       def format_cloudformation_params(params)
         params.map { |k, v| { parameter_key: k, parameter_value: v.to_s } }
       end

spec/ecs_deploy_cli/runner_spec.rb

@@ -6,11 +6,13 @@
 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,56 @@
         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
+        it 'setups the cluster correctly' 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"}'
+                                          }
+                                        })
+
+          expect(mock_iam_client).to receive(:get_role).with({ role_name: 'ecsInstanceRole' }).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(: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)
 
-        expect(mock_cf_client).to receive(:wait_until)
-        expect(mock_ecs_client).to receive(:create_service)
+          subject.setup!
+        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(: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)
+        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).with({ role_name: 'ecsInstanceRole' }) 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_any_instance_of(EcsDeployCli::Runners::Base).to receive(:ecs_client).at_least(:once).and_return(mock_ecs_client)
+
+          expect { subject.setup! }.to output(/IAM Role ecsInstanceRole does not exist./).to_stdout
+        end
 
-        subject.setup!
+        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(:ecs_client).at_least(:once).and_return(mock_ecs_client)
+
+          expect { subject.setup! }.to output(/Cluster already created, skipping./).to_stdout
+        end
       end
 
       context '#ssh' do