ufo 4.1.7 → 4.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75ec49e17bcba80691ed111954edc66403d8144536be56168665db85db974768
-  data.tar.gz: f60ee60c3dd19a8ed44dd7788811c3003dc5d73f6276d5715a4a0c32fdcbcba4
+  metadata.gz: fbed0337ef427b9207e2519ea203529f4f2db33c8b3b8a2566e53ad88da9456b
+  data.tar.gz: c4f46be9a77ab2946db88193429b0c9317fd5b9c61b909c2861514312dbc894f
 SHA512:
-  metadata.gz: 15bc1ff63ee2f7c9cf959f2ee2da0dba750a8447ffb3a40ad22703050b28160b57329b1b8ca6f716298b62dd44b457fdebf8519921bb03139e634b3de40761af
-  data.tar.gz: e52d45d8e7c5900fb8c8bcc2851781bf94300f630eb5587629c1e612d187e3eb37526d26ec46296e7a35c1870db72d405216ced9811b1ebbd716a5990951e7ad
+  metadata.gz: 9e6cd3faba4289427dfbbdd1fc65785ad563bab135a9e3816b4094ba93a4c97392e3591bd0aeeed909759ceef1fc27cfced0bacf6be33896da90ceb052418f91
+  data.tar.gz: 0452d37d8a1e785ca5f9bf0d91995d16e575d61ca0d7563f6d17ea556ae35bb03f155fde9917efb1a83c73cce1dca852702a85191f952822935c4cae644dafa1

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [4.1.8]
+- Merge pull request #59 from everplays/58-ability-to-wait-for-one-off-task-to-finish
+- Merge pull request #60 from tongueroo/wait-exit-code
+
 ## [4.1.7]
 - add scheduling-strategy option #55 from tongueroo/scheduling-strategy
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ufo (4.1.7)
+    ufo (4.1.8)
       aws-sdk-cloudformation
       aws-sdk-cloudwatchlogs
       aws-sdk-ec2
@@ -19,35 +19,35 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.1)
+    activesupport (5.2.1.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     aws-eventstream (1.0.1)
-    aws-partitions (1.111.0)
-    aws-sdk-cloudformation (1.11.0)
-      aws-sdk-core (~> 3, >= 3.26.0)
+    aws-partitions (1.121.0)
+    aws-sdk-cloudformation (1.13.0)
+      aws-sdk-core (~> 3, >= 3.39.0)
       aws-sigv4 (~> 1.0)
-    aws-sdk-cloudwatchlogs (1.10.0)
-      aws-sdk-core (~> 3, >= 3.26.0)
+    aws-sdk-cloudwatchlogs (1.12.0)
+      aws-sdk-core (~> 3, >= 3.39.0)
       aws-sigv4 (~> 1.0)
-    aws-sdk-core (3.38.0)
+    aws-sdk-core (3.42.0)
       aws-eventstream (~> 1.0)
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.0)
       jmespath (~> 1.0)
-    aws-sdk-ec2 (1.56.0)
-      aws-sdk-core (~> 3, >= 3.26.0)
+    aws-sdk-ec2 (1.62.0)
+      aws-sdk-core (~> 3, >= 3.39.0)
       aws-sigv4 (~> 1.0)
-    aws-sdk-ecr (1.8.0)
-      aws-sdk-core (~> 3, >= 3.26.0)
+    aws-sdk-ecr (1.9.0)
+      aws-sdk-core (~> 3, >= 3.39.0)
       aws-sigv4 (~> 1.0)
-    aws-sdk-ecs (1.22.0)
-      aws-sdk-core (~> 3, >= 3.26.0)
+    aws-sdk-ecs (1.26.0)
+      aws-sdk-core (~> 3, >= 3.39.0)
       aws-sigv4 (~> 1.0)
-    aws-sdk-elasticloadbalancingv2 (1.16.0)
-      aws-sdk-core (~> 3, >= 3.26.0)
+    aws-sdk-elasticloadbalancingv2 (1.18.0)
+      aws-sdk-core (~> 3, >= 3.39.0)
       aws-sigv4 (~> 1.0)
     aws-sigv4 (1.0.3)
     byebug (10.0.2)
@@ -92,7 +92,7 @@ GEM
     text-table (1.2.4)
     thor (0.20.3)
     thread_safe (0.3.6)
-    tilt (2.0.8)
+    tilt (2.0.9)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
 
@@ -109,4 +109,4 @@ DEPENDENCIES
   ufo!
 
 BUNDLED WITH
-   1.16.3
+   1.17.1

data/docs/_docs/fargate.md

@@ -18,11 +18,11 @@ Here's an example of creating web service with Fargate.
 
     git clone https://github.com/tongueroo/demo-ufo demo
     cd demo
-    ufo init --image tongueroo/demo-ufo --launch-type fargate --execution-role-arn arn:aws:iam::123456789012:role/ecsTaskExecutionRole
+    ufo init --image tongueroo/demo-ufo --launch-type fargate --execution-role-arn arn:aws:iam::112233445566:role/ecsTaskExecutionRole
     ufo current --service demo-web
     ufo ship
 
-Replace the `--execution-role-arn` with the ecsTaskExecutionRole associated with your account. If you do not have an ecsTaskExecutionRole yet, create one by following [Amazon ECS Task Execution IAM Role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) guide.
+**IMPORTANT**: Replace the `--execution-role-arn` with the ecsTaskExecutionRole associated with your account. If you do not have an ecsTaskExecutionRole yet, create one by following [Amazon ECS Task Execution IAM Role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) guide.
 
 You should see output similiar to this. Some output has been removed for conciseness.
 

data/docs/_reference/ufo-task.md

@@ -34,6 +34,9 @@ The `--task-only` option is useful. By default, the `ufo task` command will buil
 
 ```
     [--task-only], [--no-task-only]  # Skip docker and task register steps. Only run the task.
+w, [--wait], [--no-wait]             # Wait for task to finish.
+t, [--timeout=N]                     # How long to wait for task to finish.
+                                     # Default: 600
 c, [--command=one two three]         # Override the command used for the container
     [--verbose], [--no-verbose]      
     [--mute], [--no-mute]            

data/docs/quick-start.md

@@ -2,7 +2,7 @@
 title: Quick Start
 ---
 
-In a hurry? No sweat! Here's a quick start to using ufo that takes only a few minutes. For this example, we will use a sinatra app from [tongueroo/demo-ufo](https://github.com/tongueroo/demo-ufo).  The `ufo init` command sets up the ufo directory structure in your project. The `ufo ship` command deploys your code to an AWS ECS service.  The `ufo ps` and `ufo scale` command shows you how to verify and scale additional containers.
+In a hurry? No sweat! Here's a quick start to using ufo that takes only a few minutes. For this example, we will use a Sinatra app from [tongueroo/demo-ufo](https://github.com/tongueroo/demo-ufo).  The `ufo init` command sets up the ufo directory structure in your project. The `ufo ship` command deploys your code to an AWS ECS service.  The `ufo ps` and `ufo scale` command shows you how to verify and scale additional containers.  
 
     gem install ufo
     git clone https://github.com/tongueroo/demo-ufo.git demo
@@ -13,15 +13,7 @@ In a hurry? No sweat! Here's a quick start to using ufo that takes only a few mi
     ufo ps
     ufo scale 2
 
-Note: The example pushes the Docker image to Dockerhub account. You need push access the repo. So, you will need to an account that you have access to. You can control that with the `--image` option.  Example:
-
-    ufo init --image=yourusername/yourrepo # use your own account
-
-Also, if you are using ECR instead, you can specific an ECR repo with the `--image` option.  Example:
-
-    ufo init --image 123456789012.dkr.ecr.us-west-2.amazonaws.com/myimage
-
-For more info, refer to the [ufo init](http://ufoships.com/reference/ufo-init/) reference docs.
+Note: These quick start commands assume that you have push access to the repo. Refer to the Notes "Repo Push Access" section below for more info. It also assumes that you'd like to use ECS EC2 and assume that you have an ECS cluster with some EC2 Container instances running. Refer to the Notes "ECS EC2 vs ECS Fargate" section below for more info.
 
 ## What Happened
 
@@ -67,6 +59,28 @@ Congratulations! You have successfully deployed code to AWS ECS with ufo. It was
 
 Note: This quick start requires a working Docker installation.  For Docker installation instructions refer to to the [Docker installation guide](https://docs.docker.com/engine/installation/).
 
+## Notes
+
+### Repo Push Access
+
+The quick start example pushes the Docker image to a Dockerhub repo. You need your own repo with push access. This repo could be your own Dockerhub account or ECR repo.  You can control the setting with the `--image` option.  Example:
+
+    ufo init --image=yourusername/yourrepo # use your own account
+
+Also, if you are using ECR instead, you can specify an ECR repo with the `--image` option.  Example:
+
+    ufo init --image 123456789012.dkr.ecr.us-west-2.amazonaws.com/myimage
+
+For more info, refer to the [ufo init](http://ufoships.com/reference/ufo-init/) reference docs.
+
+### ECS EC2 vs ECS Fargate
+
+Ufo does not create the EC2 servers themselves to run the ECS tasks. If you use `ufo ship` to deploy an application to ECS EC2 and have not set up the EC2 servers, then the CloudFormation update will not be able to provision the ECS tasks and eventually roll back. Essentially it cannot create the ECS tasks because there are no EC2 servers to run them.
+
+Refer to the AWS [Creating a Cluster](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create_cluster.html) docs to create an ECS cluster. Also refer to [ECS Terms Tutorial](https://blog.boltops.com/2017/09/08/aws-ecs-terms-tutorial) for an explanation of ECS terms.
+
+If you would like not to manage the EC2 server fleet, you are looking for ECS Fargate instead of ECS EC2.  ECS Fargate allows you to run ECS Tasks and AWS will manage the EC2 server fleet for you. Refer to the [Ufo Fargate]({% link _docs/fargate.md %}) docs and use those quick start like commands instead.  The pricing for Fargate is more because AWS manages the server fleet for you. Refer to [Heroku vs ECS Fargate vs EC2 On-Demand vs EC2 Spot Pricing Comparison](https://blog.boltops.com/2018/04/22/heroku-vs-ecs-fargate-vs-ec2-on-demand-vs-ec2-spot-pricing-comparison) for a pricing comparison.
+
 Learn more in the next sections.
 
 <a id="next" class="btn btn-primary" href="{% link _docs/install.md %}">Next Step</a>

data/lib/ufo/cli.rb

@@ -105,6 +105,8 @@ module Ufo
     desc "task TASK_DEFINITION", "Run a one-time task."
     long_desc Help.text(:task)
     option :task_only, type: :boolean, desc: "Skip docker and task register steps. Only run the task."
+    option :wait, type: :boolean, aliases: 'w', desc: "Wait for task to finish.", default: false
+    option :timeout, type: :numeric, aliases: 't', desc: "How long to wait for task to finish.", default: 600
     option :command, type: :array, aliases: 'c', desc: "Override the command used for the container"
     def task(task_definition)
       Docker::Builder.build(options) unless @options[:task_only]

data/lib/ufo/task.rb

@@ -26,7 +26,7 @@ module Ufo
       if @options[:command]
         task_options.merge!(overrides: overrides)
         puts "Running task with container overrides."
-        puts "Command: #{@options[:command].join(' ')}"
+        puts "Command: #{command_in_human_readable_form}"
       end
 
       unless @options[:mute]
@@ -34,6 +34,8 @@ module Ufo
         display_params(task_options)
       end
 
+      ensure_log_group_exist
+
       resp = run_task(task_options)
       exit_if_failures!(resp)
       unless @options[:mute]
@@ -44,6 +46,10 @@ module Ufo
       end
     end
 
+    def ensure_log_group_exist
+      LogGroup.new(@task_definition, @options).create
+    end
+
     # Pretty hard to produce this edge case.  Happens when:
     #   launch_type: EC2
     #   network_mode: awsvpc
@@ -66,7 +72,13 @@ module Ufo
     def run_task(options)
       puts "Equivalent aws cli command:"
       puts "  aws ecs run-task --cluster #{@cluster} --task-definition #{options[:task_definition]}".colorize(:green)
-      ecs.run_task(options)
+      run_task_result = ecs.run_task(options)
+      if @options[:wait]
+        task_arn = run_task_result.tasks[0].task_arn
+        raise SystemExit, exit_status_of_task(task_arn)
+      else
+        run_task_result
+      end
     rescue Aws::ECS::Errors::ClientException => e
       if e.message =~ /ECS was unable to assume the role/
         puts "ERROR: #{e.class} #{e.message}".colorize(:red)
@@ -172,7 +184,7 @@ module Ufo
       arns = task_definition_arns(@task_definition)
       # "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:6",
       last_definition_arn = arns.first
-      puts "last_definition_arn #{last_definition_arn}"
+      # puts "last_definition_arn #{last_definition_arn}"
       task_name = last_definition_arn.split("/").last
       resp = ecs.describe_task_definition(task_definition: task_name)
 
@@ -184,5 +196,28 @@ module Ufo
     def container_definition
       recent_task_definition.container_definitions[0].to_h
     end
+
+    def exit_status_of_task(task_arn)
+      waiter_max_attempts = @options[:timeout] / 5
+      waiter_delay = 5 # seconds long polling.
+
+      print "Waiting for task to complete."
+      ecs.wait_until(:tasks_stopped, { cluster: @cluster, tasks: [task_arn] }) do |waiter|
+        waiter.before_wait { print '.' }
+        waiter.delay = waiter_delay
+        waiter.max_attempts = waiter_max_attempts
+      end
+      puts
+      container = ecs.describe_tasks(cluster: @cluster, tasks: [task_arn]).tasks[0].containers[0]
+
+      container.exit_code.nil? ? 1 : container.exit_code
+    rescue Aws::Waiters::Errors::WaiterFailed
+      puts "It took longer than #{options[:timeout]} seconds to run #{command_in_human_readable_form} (#{task_arn})"
+      exit 1
+    end
+
+    def command_in_human_readable_form
+      @options[:command].join(' ')
+    end
   end
 end

data/lib/ufo/version.rb

@@ -1,3 +1,3 @@
 module Ufo
-  VERSION = "4.1.7"
+  VERSION = "4.1.8"
 end

data/spec/lib/task_spec.rb

@@ -1,4 +1,4 @@
-describe Ufo::Ship do
+describe Ufo::Task do
   before(:each) do
     create_ufo_project
   end
@@ -8,11 +8,6 @@ describe Ufo::Ship do
     }
   end
   let(:task_definition) { "hi-migrate-prod" }
-  let(:task) do
-    task = Ufo::Task.new(task_definition, options)
-    allow(task).to receive(:ecs).and_return(ecs_client)
-    task
-  end
 
   context "hi-migrate-prod" do
     it "should migrate the database" do
@@ -20,15 +15,39 @@ describe Ufo::Ship do
 
       expect(task.ecs).to have_received(:run_task)
     end
+
+    it "should wait for the command to finish" do
+      expect do
+        task(wait: true, timeout: 600).run
+        expect(task.ecs).to have_received(:run_task)
+      end.to raise_error(SystemExit) do |error|
+        expect(error.status).to eq(5)
+      end
+    end
   end
 
   # mocks
   def ecs_client
     ecs = double("ecs")
+    ecs_container = double("ecs_container")
     fake_response = double('fake-response').as_null_object
     allow(ecs).to receive(:run_task).and_return(fake_response)
+    allow(ecs).to receive(:wait_until).and_return(fake_response)
+    allow(ecs).to receive(:describe_tasks).and_return(OpenStruct.new({
+      tasks: [OpenStruct.new(containers: [ecs_container])]
+    }))
     allow(ecs).to receive(:list_task_definitions).and_return(fake_response)
     allow(ecs).to receive(:describe_task_definition).and_return(fake_response)
+    allow(ecs_container).to receive(:exit_code).and_return(5)
     ecs
   end
+
+  def task option_overwrites = {}
+    @task ||=
+      begin
+        result = Ufo::Task.new(task_definition, options.merge(option_overwrites))
+        allow(result).to receive(:ecs).and_return(ecs_client)
+        result
+      end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ufo
 version: !ruby/object:Gem::Version
-  version: 4.1.7
+  version: 4.1.8
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-13 00:00:00.000000000 Z
+date: 2018-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudformation