🆕 Create scheduled tasks if not already present

Author: ProGM

CHANGELOG.md

@@ -1,9 +1,10 @@
 # Changelog
 All notable changes to this project made by Monade Team are documented in this file. For info refer to [email protected]
 
-## [UNRELEASED]
+## [0.5.0] - 2021-07-16
 ### Added
 - Command `setup` now create the keypair if it's missing
+- `deploy-scheduled-tasks` now creates scheduled tasks if not already there
 
 ### Fixed
 - Command `setup` now raises error when the IAM role `ecsInstanceRole` doesn't exist in your account

README.md

@@ -237,7 +237,7 @@ runner.update_services!
 
 ## TODOs
 - Creating the ecsInstanceRole automatically
-- Create scheduled tasks if not present?
+- Create scheduled tasks on setup
 - Navigate through logs (or maybe not: https://github.com/jorgebastida/awslogs)
 - Recap cluster status
 - More configuration options

lib/ecs_deploy_cli/runners/setup.rb

@@ -36,7 +36,7 @@ def setup_cluster!(cluster_options)
         ecs_client.create_cluster(
           cluster_name: config[:cluster]
         )
-        EcsDeployCli.logger.info "Cluster created, now running cloudformation..."
+        EcsDeployCli.logger.info 'Cluster created, now running cloudformation...'
 
         stack_name = "EC2ContainerService-#{config[:cluster]}"
 
@@ -129,14 +129,14 @@ def cluster_exists?
 
       def ensure_ecs_roles_exists!
         REQUIRED_ECS_ROLES.each do |role_name, link|
-          role = iam_client.get_role(role_name: role_name).to_h
+          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)
-        keypairs = ec2_client.describe_key_pairs(key_names: [cluster_options[:keypair_name]]).to_h[:key_pairs]
+        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]

lib/ecs_deploy_cli/runners/update_crons.rb

@@ -8,16 +8,13 @@ def run!
 
         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 @@ def run!
           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

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

spec/ecs_deploy_cli/runner_spec.rb

@@ -94,13 +94,15 @@
 
       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"}'
-                                          }
-                                        })
+          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
 
         it 'setups the cluster correctly' do
@@ -130,19 +132,19 @@
           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
 
         it 'fails if the cluster is already there' do
-          expect(mock_ecs_client).to receive(:describe_clusters).and_return(clusters: [{  }])
+          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
@@ -172,9 +174,11 @@
           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|
@@ -209,8 +213,8 @@
             .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|
@@ -248,16 +252,32 @@
         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' } })
+
+          mock_cwe_client.stub_responses(:list_targets_by_rule, { targets: [{ id: '123', arn: 'arn:123' }] })
 
-        subject.update_crons!
+          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