ufo 2.3.0 → 3.0.0

data/lib/ufo/completer.rb

@@ -1,58 +1,73 @@
-# Code Explanation.  This is mainly focused on the run method.
-#
-# There are 3 main branches of logic for completion:
-#
-#   1. top-level commands - when there are zero completed words
-#   2. params completion - when a command has some required params
-#   3. options completion - when we have finished auto-completing the top-level command and required params, the rest of the completion words will be options
-#
-# Terms:
-#
-#   params - these are params in the command itself. Example: for the method `scale(service, count)` the params would be `service, count`.
-#   options - these are cli options flags.  Examples: --noop, --verbose
-#
-# When we are done processing method params, the completion will be only options. When the detected params size is greater than the arity we are have finished auto-completing the parameters in the method declaration.  For example, say you had a method for a CLI command with the following form:
-#
-#   scale(service, count) = arity of 2
-#
-#   ufo scale service count [TAB] # there are 3 params including the "scale" command
-#
-# So the completion will be something like:
-#
-#   --noop --verbose etc
-#
-# A note about artity values:
-#
-# We are using the arity of the command method to determine if we have finish auto-completing the params completion. When the ruby method has a splat param, it's arity will be negative.  Here are some example methods and their arities.
-#
-#    ship(service) = 1
-#    scale(service, count) = 2
-#    ships(*services) = -1
-#    foo(example, *rest) = -2
-#
-# Fortunately, negative and positive arity values are processed the same way. So we take simply take the abs of the arity.
-#
-# To test:
-#
-#   ufo completion
-#   ufo completion hello
-#   ufo completion hello name
-#   ufo completion hello name --
-#   ufo completion hello name --noop
-#
-#   ufo completion
-#   ufo completion sub:goodbye
-#   ufo completion sub:goodbye name
-#
-# Note when testing, the first top-level word must be an exact match
-#
-#   ufo completion hello # works fine
-#   ufo completion he # incomplete, this will just break
-#
-# The completion assumes that the top-level word that is being passed in
-# from completor/scripts.sh will always match exactly.  This must be the
-# case.  For parameters, the word does not have to match exactly.
-#
+=begin
+Code Explanation:
+
+There are 3 types of things to auto-complete:
+
+  1. command: the command itself
+  2. parameters: command parameters.
+  3. options: command options
+
+Here's an example:
+
+  mycli hello name --from me
+
+  * command: hello
+  * parameters: name
+  * option: --from
+
+When command parameters are done processing, the remaining completion words will be options.  We can tell that the command params are completed based on the method arity.
+
+## Arity
+
+For example, say you had a method for a CLI command with the following form:
+
+  ufo scale service count --cluster development
+
+It's equivalent ruby method:
+
+  scale(service, count) = has an arity of 2
+
+So typing:
+
+  ufo scale service count [TAB] # there are 3 parameters including the "scale" command according to Thor's CLI processing.
+
+So the completion should only show options, something like this:
+
+  --noop --verbose --cluster
+
+## Splat Arguments
+
+When the ruby method has a splat argument, it's arity is negative.  Here are some example methods and their arities.
+
+   ship(service) = 1
+   scale(service, count) = 2
+   ships(*services) = -1
+   foo(example, *rest) = -2
+
+Fortunately, negative and positive arity values are processed the same way. So we take simply take the absolute value of the arity and process it the same.
+
+Here are some test cases, hit TAB after typing the command:
+
+  ufo completion
+  ufo completion hello
+  ufo completion hello name
+  ufo completion hello name --
+  ufo completion hello name --noop
+
+  ufo completion
+  ufo completion sub:goodbye
+  ufo completion sub:goodbye name
+
+## Subcommands and Thor::Group Registered Commands
+
+Sometimes the commands are not simple thor commands but are subcommands or Thor::Group commands. A good specific example is the ufo tool.
+
+  * regular command: ufo ship
+  * subcommand: ufo docker
+  * Thor::Group command: ufo init
+
+Auto-completion accounts for each of these type of commands.
+=end
 module Ufo
   class Completer
     autoload :Script, 'ufo/completer/script'
@@ -79,10 +94,10 @@ module Ufo
 
       # will only get to here if command aws found (above)
       arity = @command_class.instance_method(@current_command).arity.abs
-      if @params.size <= arity
-        puts params_completion
-      else
+      if @params.size > arity or thor_group_command?
         puts options_completion
+      else
+        puts params_completion
       end
     end
 
@@ -90,8 +105,13 @@ module Ufo
       @command_class.subcommands.include?(command)
     end
 
+    # hacky way to detect that command is a registered Thor::Group command
+    def thor_group_command?
+      command_params(raw=true) == [[:rest, :args]]
+    end
+
     def found?(command)
-      public_methods = @command_class.public_instance_methods - Object.methods
+      public_methods = @command_class.public_instance_methods(false)
       command && public_methods.include?(command.to_sym)
     end
 
@@ -103,17 +123,19 @@ module Ufo
       commands.keys
     end
 
-    def params_completion
-      method_params = @command_class.instance_method(@current_command).parameters
+    def command_params(raw=false)
+      params = @command_class.instance_method(@current_command).parameters
       # Example:
       # >> Sub.instance_method(:goodbye).parameters
       # => [[:req, :name]]
       # >>
-      method_params.map!(&:last)
+      raw ? params : params.map!(&:last)
+    end
 
+    def params_completion
       offset = @params.size - 1
-      offset_params = method_params[offset..-1]
-      method_params[offset..-1].first
+      offset_params = command_params[offset..-1]
+      command_params[offset..-1].first
     end
 
     def options_completion

data/lib/ufo/core.rb

@@ -0,0 +1,42 @@
+require 'pathname'
+require 'yaml'
+
+module Ufo
+  module Core
+    def check_task_definition!(task_definition)
+      task_definition_path = "#{Ufo.root}/.ufo/output/#{task_definition}.json"
+      unless File.exist?(task_definition_path)
+        puts "ERROR: Unable to find the task definition at #{task_definition_path}.".colorize(:red)
+        puts "Are you sure you have defined it in ufo/template_definitions.rb and it has been generated correctly in .ufo/output?".colorize(:red)
+        puts "If you are calling `ufo deploy` directly, you might want to generate the task definition first with `ufo tasks build`."
+        exit
+      end
+    end
+
+    def root
+      path = ENV['UFO_ROOT'] || '.'
+      Pathname.new(path)
+    end
+
+    @@env = nil
+    def env
+      return @@env if @@env
+      ufo_env = env_from_profile(ENV['AWS_PROFILE']) || 'development'
+      ufo_env = ENV['UFO_ENV'] if ENV['UFO_ENV'] # highest precedence
+      @@env = ufo_env
+    end
+
+    private
+    # Do not use the Setting class to load the profile because it can cause an
+    # infinite loop then if we decide to use Ufo.env from within settings class.
+    def env_from_profile(aws_profile)
+      data = YAML.load_file("#{Ufo.root}/.ufo/settings.yml")
+      env = data.find do |_env, setting|
+        setting ||= {}
+        profiles = setting['aws_profiles']
+        profiles && profiles.include?(aws_profile)
+      end
+      env.first if env
+    end
+  end
+end

data/lib/ufo/default.rb

@@ -8,19 +8,17 @@ module Ufo
   #
   # So @options must be set
   module Default
-    # The default cluster normally defaults to the UFO_ENV value.
+    # The default cluster normally defaults to the Ufo.env value.
     # But it can be overriden by ufo/settings.yml ufo_env_cluster_map
     #
     # More info: http://ufoships.com/docs/settings/
     def default_cluster
-      #
-
       map = setting.data["ufo_env_cluster_map"]
       if map
-        ecs_cluster = map[UFO_ENV] || map["default"]
+        ecs_cluster = map[Ufo.env] || map["default"]
       end
 
-      ecs_cluster || UFO_ENV
+      ecs_cluster || Ufo.env
     end
 
     # These default service values only are used when a service is created by `ufo`
@@ -41,7 +39,7 @@ module Ufo
     end
 
     def setting
-      @setting ||= Setting.new(@options[:project_root])
+      @setting ||= Setting.new
     end
   end
 end

data/lib/ufo/default/settings.yml

@@ -1,25 +1,27 @@
 # More info: http://ufoships.com/docs/ufo-settings/
-#
-# image:
-# clean_keep: 30
-# ecr_keep: 30
+# The base config is specially treated. It gets included the other environments automatically.
+# Yaml also directly supports merging with & and <<* syntax but doing it automatically
+# for a cleaner syntax.
+base:
+  # image:
+  # clean_keep: 30
+  # ecr_keep: 30
+  # defaults when an new ECS service is created by ufo ship
+  new_service:
+    maximum_percent: 200
+    minimum_healthy_percent: 100
+    desired_count: 1
 
-# aws_profile_ufo_env_map:
-#   default: prod
-#   # More examples:
-#   aws_profile1: prod
-#   aws_profile2: stag
-#   aws_profile3: dev
+development:
+  # cluster: dev
+  # When you have AWS_PROFILE set to one of these values, ufo will switch to the desired
+  # environment. This prevents you from switching AWS_PROFILE, forgetting to
+  # also switch UFO_ENV, and accidentally deploying to production vs development.
+  # aws_profiles:
+  #   - dev_profile1
+  #   - dev_profile2
 
-# ufo_env_cluster_map:
-#   default: prod
-#   # More examples:
-#   aws_profile1: prod
-#   aws_profile2: stag
-#   aws_profile3: dev
-
-# defaults when an new ECS service is created by ufo ship
-new_service:
-  maximum_percent: 200
-  minimum_healthy_percent: 100
-  desired_count: 1
+production:
+  # cluster: prod
+  # aws_profiles:
+  #   - prod_profile

data/lib/ufo/docker.rb

@@ -1,6 +1,7 @@
 module Ufo
   class Docker < Command
     autoload :Builder, 'ufo/docker/builder'
+    autoload :Pusher, 'ufo/docker/pusher'
     autoload :Dockerfile, 'ufo/docker/dockerfile'
     autoload :Cleaner, 'ufo/docker/cleaner'
 
@@ -10,7 +11,16 @@ module Ufo
     def build
       builder = Docker::Builder.new(options)
       builder.build
-      builder.push if options[:push]
+      push if options[:push]
+    end
+
+    desc "push IMAGE", "push the docker image"
+    long_desc Help.text("docker:push")
+    option :push, type: :boolean, default: false
+    def push(full_image_name=nil)
+      # full_image_name of nil results in defaulting to the last built image by ufo docker build
+      pusher = Docker::Pusher.new(full_image_name, options)
+      pusher.push
     end
 
     desc "base", "builds docker image from Dockerfile.base and update current Dockerfile"
@@ -28,7 +38,7 @@ module Ufo
       Ecr::Cleaner.new(builder.image_name, options.merge(tag_prefix: "base")).cleanup
     end
 
-    desc "name", "displays the full docker image with tag that will be generated"
+    desc "name", "displays the full docker image with tag that was last generated."
     option :generate, type: :boolean, default: false, desc: "Generate a name without storing it"
     long_desc Help.text("docker:name")
     def name

data/lib/ufo/docker/builder.rb

@@ -1,19 +1,20 @@
-module Ufo
-  class Docker::Builder
-    include Util
+require 'active_support/core_ext/module/delegation'
 
+class Ufo::Docker
+  class Builder
+    include Ufo::Util
+
+    delegate :push, to: :pusher
     def self.build(options)
-      builder = Docker::Builder.new(options) # outside if because it need builder.full_image_name
-      if options[:docker]
-        builder.build
-        builder.push
-      end
+      builder = Builder.new(options) # outside if because it need builder.full_image_name
+      builder.build
+      pusher = Docker::Pusher.new(nil, options)
+      pusher.push
       builder
     end
 
     def initialize(options={})
       @options = options
-      @project_root = options[:project_root] || '.'
       @dockerfile = options[:dockerfile] || 'Dockerfile'
       @image_namespace = options[:image_namespace] || 'ufo'
     end
@@ -21,13 +22,12 @@ module Ufo
     def build
       start_time = Time.now
       store_full_image_name
-      update_auth_token # call after store_full_image_name
 
       command = "docker build -t #{full_image_name} -f #{@dockerfile} ."
       say "Building docker image with:".green
       say "  #{command}".green
       check_dockerfile_exists
-      command = "cd #{@project_root} && #{command}"
+      command = "cd #{Ufo.root} && #{command}"
       success = execute(command, use_system: true)
       unless success
         puts "ERROR: The docker image fail to build.  Are you sure the docker daemon is available?  Try running: docker version".colorize(:red)
@@ -38,44 +38,17 @@ module Ufo
       say "Docker image #{full_image_name} built.  " + "Took #{pretty_time(took)}.".green
     end
 
-    def push
-      update_auth_token
-      start_time = Time.now
-      message = "Pushed #{full_image_name} docker image."
-      if @options[:noop]
-        message = "NOOP #{message}"
-      else
-        command = "docker push #{full_image_name}"
-        puts "=> #{command}".colorize(:green)
-        success = execute(command, use_system: true)
-        unless success
-          puts "ERROR: The docker image fail to push.".colorize(:red)
-          exit 1
-        end
-      end
-      took = Time.now - start_time
-      message << " Took #{pretty_time(took)}.".green
-      puts message unless @options[:mute]
+    def pusher
+      @pusher ||= Pusher.new(full_image_name, @options)
     end
 
     def check_dockerfile_exists
-      unless File.exist?("#{@project_root}/#{@dockerfile}")
+      unless File.exist?("#{Ufo.root}/#{@dockerfile}")
         puts "#{@dockerfile} does not exist.  Are you sure it exists?"
         exit 1
       end
     end
 
-    def update_auth_token
-      return unless ecr_image?
-      repo_domain = "https://#{image_name.split('/').first}"
-      auth = Ecr::Auth.new(repo_domain)
-      auth.update
-    end
-
-    def ecr_image?
-      full_image_name =~ /\.amazonaws\.com/
-    end
-
     # full_image - does not include the tag
     def image_name
       setting.data["image"]
@@ -83,10 +56,7 @@ module Ufo
 
     # full_image - includes the tag
     def full_image_name
-      if @options[:generate]
-        return generate_name # name already has a newline
-      end
-
+      return generate_name if @options[:generate]
       return "tongueroo/hi:ufo-12345678" if ENV['TEST']
 
       unless File.exist?(docker_name_path)
@@ -113,7 +83,7 @@ module Ufo
 
     def docker_name_path
       # output gets entirely wiped by tasks builder so dotn use that folder
-      "#{@project_root}/ufo/data/docker_image_name_#{@image_namespace}.txt"
+      "#{Ufo.root}/.ufo/data/docker_image_name_#{@image_namespace}.txt"
     end
 
     def timestamp
@@ -123,16 +93,16 @@ module Ufo
     def git_sha
       return @git_sha if @git_sha
       # always call this and dont use the execute method because of the noop option
-      @git_sha = `cd #{@project_root} && git rev-parse --short HEAD`
+      @git_sha = `cd #{Ufo.root} && git rev-parse --short HEAD`
       @git_sha.strip!
     end
 
     def setting
-      @setting ||= Setting.new(@project_root)
+      @setting ||= Ufo::Setting.new(Ufo.root)
     end
 
     def update_dockerfile
-      dockerfile = Docker::Dockerfile.new(full_image_name, @options)
+      dockerfile = Dockerfile.new(full_image_name, @options)
       dockerfile.update
     end