ufo 3.4.3 → 3.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4331af9c4aba2f153ac4009465fdd904d50037036f8e22d9dc8eaf7bcc15207a
-  data.tar.gz: 740a3c2bdcba00f1e225f3ccf42382aa487699f477c39f81ac48a100b2fe945e
+  metadata.gz: 53201d5487d8074486f75afc6e14e3078240714b721e84f32405c41a8fe64b16
+  data.tar.gz: 546cfdd56445e30f6c2791970fa9ad04921075895ba1bee7601f7570d2b06873
 SHA512:
-  metadata.gz: 05dd46b7d5927bbc87112edcac6243ea58e97ba4adf7c0e1e1c7ca567bf141abbcc5d834d13b9f3552e5491ee5b2403ad4d8da62fc418c10977595e633a7f512
-  data.tar.gz: 4fda387373a698325af11d1ba3b50d1aab61c901d7044248144f945436ae45c3361a96a16953f6d49e1f6c572abb05272caf90ae5711c17be856facb9b5d61b4
+  metadata.gz: 030546c273054b55929bf1d0f22ff4602a122985dd90757ee45dabc1cf2dbaca605236231c9fd195172121b49364d38efd44a730be65e00379341b718ddda24d
+  data.tar.gz: 4a072047fa10c03bafae95f8f8eb9e3d73197c924615fbe77058906e9480b7e60cc1d492ed645c9eb132e78a2812491f0cfbc822d744c5b29ba32dec6acf512f

data/CHANGELOG.md

@@ -3,6 +3,12 @@
 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.
 
+## [3.4.4]
+- Merge pull request #34 from tongueroo/show-aws-cli-commands
+- Show equivalent cli commands when possible
+- Automatically auth ECR when Dockerfiles has ECR image in FROM instruction
+- Fix upgrade task and provide user with warning message for 3.4.x version.
+
 ## [3.4.3]
 - remove debugging puts
 

data/README.md

@@ -56,3 +56,7 @@ Congratulations, you have successfully used ufo to deploy to an ECS service.
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at [https://github.com/tongueroo/ufo/issues](https://github.com/tongueroo/ufo/issues).
+
+### QA Checklist
+
+[QA Checklist](https://github.com/tongueroo/ufo/wiki/QA-Checklist) is a good list of things to check.

data/lib/template/.ufo/templates/fargate.json.erb

@@ -12,7 +12,7 @@
       <% if @container_port %>
       "portMappings": [
         {
-          "containerPort": "<%= @container_port %>",
+          "containerPort": <%= @container_port %>,
           "protocol": "tcp"
         }
       ],

data/lib/template/.ufo/templates/main.json.erb

@@ -14,7 +14,7 @@
       <% if @container_port %>
       "portMappings": [
         {
-          "containerPort": "<%= @container_port %>",
+          "containerPort": <%= @container_port %>,
           "protocol": "tcp"
         }
       ],

data/lib/ufo/docker/builder.rb

@@ -23,6 +23,8 @@ class Ufo::Docker
       start_time = Time.now
       store_full_image_name
 
+      update_auth_token
+
       command = "docker build -t #{full_image_name} -f #{@dockerfile} ."
       say "Building docker image with:".green
       say "  #{command}".green
@@ -38,6 +40,32 @@ class Ufo::Docker
       say "Docker image #{full_image_name} built.  " + "Took #{pretty_time(took)}.".green
     end
 
+    # Parse Dockerfile for FROM instruction. If the starting image is from an ECR
+    # repository, it's likely an private image so we authorize ECR for pulling.
+    def update_auth_token
+      ecr_image_names = ecr_image_names("#{Ufo.root}/#{@dockerfile}")
+      return if ecr_image_names.empty?
+
+      ecr_image_names.each do |ecr_image_name|
+        auth = Ufo::Ecr::Auth.new(ecr_image_name)
+        # wont update auth token unless the image being pushed in the ECR image format
+        auth.update
+      end
+    end
+
+    def ecr_image_names(path)
+      from_image_names(path).select { |i| i =~ /\.amazonaws\.com/ }
+    end
+
+    def from_image_names(path)
+      lines = IO.readlines(path)
+      froms = lines.select { |l| l =~ /^FROM/ }
+      froms.map do |l|
+        md = l.match(/^FROM (.*)/)
+        md[1]
+      end.compact
+    end
+
     def pusher
       @pusher ||= Pusher.new(full_image_name, @options)
     end
@@ -54,7 +82,9 @@ class Ufo::Docker
       settings["image"]
     end
 
-    # full_image - includes the tag
+    # full_image - Includes the tag. Examples:
+    #   123456789.dkr.ecr.us-west-2.amazonaws.com/myapp:ufo-2018-04-20T09-29-08-b7d51df
+    #   tongueroo/hi:ufo-2018-04-20T09-29-08-b7d51df
     def full_image_name
       return generate_name if @options[:generate]
       return "tongueroo/hi:ufo-12345678" if ENV['TEST']

data/lib/ufo/docker/pusher.rb

@@ -8,6 +8,8 @@ class Ufo::Docker
     attr_reader :last_image_name
     def initialize(image, options)
       @options = options
+      # full_image_name ultimately uses @options, so @last_image_name assignment
+      # line must be defined after setting @options.
       @last_image_name = image || full_image_name
     end
 
@@ -38,7 +40,7 @@ class Ufo::Docker
     def update_auth_token
       auth = Ufo::Ecr::Auth.new(last_image_name)
       # wont update auth token unless the image being pushed in the ECR image format
-      auth.update if auth.ecr_image?
+      auth.update
     end
 
     # full_image - does not include the tag

data/lib/ufo/ecr/auth.rb

@@ -23,6 +23,9 @@ module Ufo
     end
 
     def update
+      # wont update auth token unless the image being pushed in the ECR image format
+      return unless ecr_image?
+
       auth_token = fetch_auth_token
       if File.exist?(docker_config)
         data = JSON.load(IO.read(docker_config))

data/lib/ufo/param.rb

@@ -15,10 +15,27 @@ module Ufo
     end
 
     def data
+      upgrade_message!
+
       vars = Ufo::TemplateScope.new(helper).assign_instance_variables
       result = RenderMePretty.result(@params_path, vars)
       YAML.load(result)
     end
     memoize :data
+
+    # Ufo version 3.3 to 3.4 added a concept of a .ufo/params.yml file to support
+    # fargate: https://github.com/tongueroo/ufo/pull/31
+    #
+    # Warn user and tell them to run the `ufo upgrade3_3_to_3_4` command to upgrade.
+    def upgrade_message!
+      return if File.exist?(@params_path)
+
+      puts "ERROR: Your project is missing the .ufo/params.yml.".colorize(:red)
+      puts "This was added in ufo version 3.4 for Fargate support: https://github.com/tongueroo/ufo/pull/31"
+      puts "You can find more info about the params file here: http://ufoships.com/docs/params/"
+      puts "To upgrade run:"
+      puts "  ufo upgrade3_3_to_3_4"
+      exit 1
+    end
   end
 end

data/lib/ufo/ship.rb

@@ -125,25 +125,6 @@ module Ufo
       [deployed_service.service_name, took]
     end
 
-    def wait_for_all_deployments(deployed_services)
-      start_time = Time.now
-      threads = deployed_services.map do |deployed_service|
-        Thread.new do
-          # http://stackoverflow.com/questions/1383390/how-can-i-return-a-value-from-a-thread-in-ruby
-          Thread.current[:output] = wait_for_deployment(deployed_service, quiet=true)
-        end
-      end
-      threads.each { |t| t.join }
-      total_took = Time.now - start_time
-      puts ""
-      puts "Shipments for all #{deployed_service.size} services took a total of #{pretty_time(total_took).green}."
-      puts "Each deployment took:"
-      threads.each do |t|
-        service_name, took = t[:output]
-        puts "  #{service_name}: #{pretty_time(took)}"
-      end
-    end
-
     # used for polling
     # must pass in a service and cannot use @service for the case of multi_services mode
     def find_updated_service(service)
@@ -214,15 +195,35 @@ module Ufo
         unless target_group.nil? || target_group.empty?
           add_load_balancer!(container, options, target_group)
         end
+
         puts "Creating ECS service with params:"
         display_params(options)
+        show_aws_cli_command(:create, options)
         response = ecs.create_service(options)
         service = response.service # must set service here since this might never be called if @wait_for_deployment is false
       end
+
       puts message unless @options[:mute]
       service
     end
 
+    def show_aws_cli_command(action, params)
+      puts "Equivalent aws cli command:"
+      # Use .ufo/data instead of .ufo/output because output files all get looped
+      # through as part of `ufo tasks register`
+      rel_path = ".ufo/data/#{action}-params.json"
+      output_path = "#{Ufo.root}/#{rel_path}"
+      FileUtils.rm_f(output_path)
+
+      # Thanks: https://www.mnishiguchi.com/2017/11/29/rails-hash-camelize-and-underscore-keys/
+      params = params.deep_transform_keys { |key| key.to_s.camelize(:lower) }
+      json = JSON.pretty_generate(params)
+      IO.write(output_path, json)
+
+      file_path = "file://#{rel_path}"
+      puts "  aws ecs #{action}-service --cli-input-json #{file_path}".colorize(:green)
+    end
+
     # $ aws ecs update-service --generate-cli-skeleton
     # {
     #     "cluster": "",
@@ -248,9 +249,14 @@ module Ufo
         params = params.merge(default_params[:update_service] || {})
         puts "Updating ECS service with params:"
         display_params(params)
-        response = ecs.update_service(params)
-        service = response.service # must set service here since this might never be called if @wait_for_deployment is false
+        show_aws_cli_command(:update, params)
+
+        unless @options[:noop]
+          response = ecs.update_service(params)
+          service = response.service # must set service here since this might never be called if @wait_for_deployment is false
+        end
       end
+
       puts message unless @options[:mute]
       service
     end
@@ -366,6 +372,7 @@ module Ufo
           # TODO: Aad Waiter logic, sometimes the cluster does not exist by the time
           # we create the service
         end
+
         puts message unless @options[:mute]
       end
     end

data/lib/ufo/tasks/register.rb

@@ -24,13 +24,20 @@ module Ufo
     def register
       data = JSON.parse(IO.read(@template_definition_path))
       data = rubyize_format(data)
+
       message = "#{data[:family]} task definition registered."
       if @options[:noop]
         message = "NOOP: #{message}"
       else
         register_task_definition(data)
       end
-      puts message unless @options[:mute]
+
+      unless @options[:mute]
+        puts "Equivalent aws cli command:"
+        file_path = "file://#{@template_definition_path.sub(/^\.\//,'')}"
+        puts "  aws ecs register-task-definition --cli-input-json #{file_path}".colorize(:green)
+        puts message
+      end
     end
 
     def register_task_definition(data)

data/lib/ufo/upgrade/params.yml

@@ -1,4 +1,4 @@
-<%%
+<%
   # replace with actual values:
   @subnets = ["subnet-111","subnet-222"]
   @security_groups = ["sg-111"]

data/lib/ufo/version.rb

@@ -1,3 +1,3 @@
 module Ufo
-  VERSION = "3.4.3"
+  VERSION = "3.4.4"
 end

data/spec/fixtures/dockerfiles/dockerhub/Dockerfile

@@ -0,0 +1 @@
+FROM ruby:2.5.0

data/spec/fixtures/dockerfiles/ecr/Dockerfile

@@ -0,0 +1 @@
+FROM 123456789.dkr.ecr.us-west-2.amazonaws.com/myapp:ufo-2018-04-20T09-29-08-b7d51df

data/spec/lib/builder_spec.rb

@@ -0,0 +1,23 @@
+describe Ufo::Docker::Builder do
+  before(:all) do
+    create_ufo_project
+  end
+
+  let(:builder) { Ufo::Docker::Builder.new }
+
+  context "dockerfile uses ecr image for FROM instruction" do
+    it "updates the auth token before building the image" do
+      # builder.from_ecr_image?("spec/fixtures/dockerfiles/dockerhub/Dockerfile")
+      names = builder.ecr_image_names("spec/fixtures/dockerfiles/ecr/Dockerfile")
+      expect(names).not_to be_empty
+    end
+  end
+
+  context "dockerfile uses dockerhub image for FROM instruction" do
+    it "does not update the auth token before building the image" do
+      # builder.from_ecr_image?("spec/fixtures/dockerfiles/dockerhub/Dockerfile")
+      names = builder.ecr_image_names("spec/fixtures/dockerfiles/dockerhub/Dockerfile")
+      expect(names).to be_empty
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ufo
 version: !ruby/object:Gem::Version
-  version: 3.4.3
+  version: 3.4.4
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-18 00:00:00.000000000 Z
+date: 2018-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudwatchlogs
@@ -393,7 +393,6 @@ files:
 - lib/ufo/core.rb
 - lib/ufo/default/settings.yml
 - lib/ufo/default/templates/main.json.erb
-- lib/ufo/deploy.rb
 - lib/ufo/destroy.rb
 - lib/ufo/docker.rb
 - lib/ufo/docker/builder.rb
@@ -448,9 +447,12 @@ files:
 - lib/ufo/upgrade33_to_34.rb
 - lib/ufo/util.rb
 - lib/ufo/version.rb
+- spec/fixtures/dockerfiles/dockerhub/Dockerfile
+- spec/fixtures/dockerfiles/ecr/Dockerfile
 - spec/fixtures/home_existing/.aws/config
 - spec/fixtures/home_existing/.docker/config.json
 - spec/fixtures/settings.yml
+- spec/lib/builder_spec.rb
 - spec/lib/cli_spec.rb
 - spec/lib/completion_spec.rb
 - spec/lib/core_spec.rb
@@ -487,9 +489,12 @@ signing_key:
 specification_version: 4
 summary: Build Docker Containers and Ship Them to AWS ECS
 test_files:
+- spec/fixtures/dockerfiles/dockerhub/Dockerfile
+- spec/fixtures/dockerfiles/ecr/Dockerfile
 - spec/fixtures/home_existing/.aws/config
 - spec/fixtures/home_existing/.docker/config.json
 - spec/fixtures/settings.yml
+- spec/lib/builder_spec.rb
 - spec/lib/cli_spec.rb
 - spec/lib/completion_spec.rb
 - spec/lib/core_spec.rb