ufo 2.3.0 → 3.0.0

data/lib/ufo/docker/cleaner.rb

@@ -16,15 +16,17 @@ module Ufo
       return if delete_list.empty?
       command = "docker rmi #{delete_list}"
       say "Cleaning up docker images...".green
-      say "Running: #{"docker rmi #{delete_list}"}"
+      say "=> #{"docker rmi #{delete_list}"}".green
       return if @options[:noop]
       execute(command, use_system: false) # to use_system: false silence output
     end
 
     def delete_list
+      return [] if ENV['TEST']
       return @delete_list if @delete_list
 
-      out = execute("docker images", live: true) # live to override the noop cli options
+      out = execute("docker images") # live to override the noop cli options
+
       name_regexp = Regexp.new(@docker_image_name)
       # Example tag: ufo-2016-10-19T00-36-47-211b63a
       tag_string = "#{@tag_prefix}-\\d{4}-\\d{2}-\\d{2}T\\d{2}-\\d{2}-\\d{2}-.{7}"

data/lib/ufo/docker/dockerfile.rb

@@ -3,7 +3,6 @@ module Ufo
     def initialize(full_image_name, options={})
       @full_image_name = full_image_name
       @options = options
-      @project_root = options[:project_root] || '.'
     end
 
     def update
@@ -15,7 +14,7 @@ module Ufo
     end
 
     def dockerfile_path
-      "#{@project_root}/Dockerfile"
+      "#{Ufo.root}/Dockerfile"
     end
 
     def new_dockerfile

data/lib/ufo/docker/pusher.rb

@@ -0,0 +1,53 @@
+require 'active_support/core_ext/module/delegation'
+
+class Ufo::Docker
+  class Pusher
+    include Ufo::Util
+
+    delegate :full_image_name, to: :builder
+    attr_reader :last_image_name
+    def initialize(image, options)
+      @options = options
+      @last_image_name = image || full_image_name
+    end
+
+    def push
+      update_auth_token
+      start_time = Time.now
+      message = "Pushed #{last_image_name} docker image."
+      if @options[:noop]
+        message = "NOOP #{message}"
+      else
+        command = "docker push #{last_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]
+    end
+
+    def builder
+      @builder ||= Builder.new(@options.merge(image: last_image_name))
+    end
+
+    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?
+    end
+
+    # full_image - does not include the tag
+    def image_name
+      setting.data["image"]
+    end
+
+    def setting
+      @setting ||= Ufo::Setting.new(Ufo.root)
+    end
+  end
+end

data/lib/ufo/dsl.rb

@@ -9,7 +9,6 @@ module Ufo
     def initialize(template_definitions_path, options={})
       @template_definitions_path = template_definitions_path
       @options = options
-      @project_root = options[:project_root] || '.'
       @task_definitions = []
       @outputters = []
     end
@@ -69,7 +68,7 @@ module Ufo
 
     def clean_existing_task_definitions
       # removing 1 file a a time instead of recursing removing the directory to be safe
-      Dir.glob("#{@options[:project_root]}/ufo/output/*").each do |path|
+      Dir.glob("#{Ufo.root}/.ufo/output/*").each do |path|
         FileUtils.rm_f(path)
       end
     end

data/lib/ufo/dsl/helper.rb

@@ -10,13 +10,12 @@ module Ufo
     class Helper
       def initialize(options={})
         @options = options
-        @project_root = options[:project_root] || '.'
       end
 
       ##############
       # helper variables
       def dockerfile_port
-        dockerfile_path = "#{@project_root}/Dockerfile"
+        dockerfile_path = "#{Ufo.root}/Dockerfile"
         if File.exist?(dockerfile_path)
           parse_for_dockerfile_port(dockerfile_path)
         end
@@ -50,7 +49,7 @@ module Ufo
       end
 
       def env_file(path)
-        full_path = "#{@project_root}/#{path}"
+        full_path = "#{Ufo.root}/#{path}"
         unless File.exist?(full_path)
           puts "The #{full_path} env file could not be found.  Are you sure it exists?"
           exit 1
@@ -65,7 +64,7 @@ module Ufo
       end
 
       def setting
-        @setting ||= Setting.new(@project_root)
+        @setting ||= Setting.new(Ufo.root)
       end
 
       def parse_for_dockerfile_port(dockerfile_path)

data/lib/ufo/dsl/outputter.rb

@@ -9,7 +9,7 @@ module Ufo
       end
 
       def write
-        output_path = "#{@options[:project_root]}/ufo/output"
+        output_path = "#{Ufo.root}/.ufo/output"
         FileUtils.rm_rf(output_path) if @options[:clean]
         FileUtils.mkdir(output_path) unless File.exist?(output_path)
 

data/lib/ufo/dsl/task_definition.rb

@@ -10,7 +10,6 @@ module Ufo
         @task_definition_name = task_definition_name
         @block = block
         @options = options
-        @project_root = @options[:project_root] || '.'
       end
 
       # delegate helper method back up to dsl
@@ -21,12 +20,24 @@ module Ufo
       def build
         load_variables
         instance_eval(&@block)
-        erb_result(source_path)
+
+        hash = assign_instance_variables
+        RenderMePretty.result(source_path, hash)
+      end
+
+      def assign_instance_variables
+        # copy over the instance variables from TaskDefinition scope to RenderMePretty's scope
+        hash = {}
+        instance_variables.each do |var|
+          key = var.to_s.sub('@','') # rid of the leading @
+          hash[key.to_sym] = instance_variable_get(var)
+        end
+        hash
       end
 
       def load_variables
         load_variables_file("base")
-        load_variables_file(UFO_ENV)
+        load_variables_file(Ufo.env)
       end
 
       # Load the variables defined in ufo/variables/* to make available in the
@@ -50,41 +61,10 @@ module Ufo
       # NOTE: Only able to make instance variables avaialble with instance_eval
       #   Wasnt able to make local variables available.
       def load_variables_file(filename)
-        path = "#{@project_root}/ufo/variables/#{filename}.rb"
+        path = "#{Ufo.root}/.ufo/variables/#{filename}.rb"
         instance_eval(IO.read(path)) if File.exist?(path)
       end
 
-      def erb_result(path)
-        template = IO.read(path)
-        begin
-          ERB.new(template, nil, "-").result(binding)
-        rescue Exception => e
-          puts e
-
-          # how to know where ERB stopped? - https://www.ruby-forum.com/topic/182051
-          # syntax errors have the (erb):xxx info in e.message
-          # undefined variables have (erb):xxx info in e.backtrac
-          error_info = e.message.split("\n").grep(/\(erb\)/)[0]
-          error_info ||= e.backtrace.grep(/\(erb\)/)[0]
-          raise unless error_info # unable to find the (erb):xxx: error line
-          line = error_info.split(':')[1].to_i
-          puts "Error evaluating ERB template on line #{line.to_s.colorize(:red)} of: #{path.sub(/^\.\//, '')}"
-
-          template_lines = template.split("\n")
-          context = 5 # lines of context
-          top, bottom = [line-context-1, 0].max, line+context-1
-          spacing = template_lines.size.to_s.size
-          template_lines[top..bottom].each_with_index do |line_content, index|
-            line_number = top+index+1
-            if line_number == line
-              printf("%#{spacing}d %s\n".colorize(:red), line_number, line_content)
-            else
-              printf("%#{spacing}d %s\n", line_number, line_content)
-            end
-          end
-          exit 1 unless ENV['TEST']
-        end
-      end
       # at this point instance_eval has been called and source has possibly been called
       def source(name)
         @source = name
@@ -101,7 +81,7 @@ module Ufo
 
       def source_path
         if @source # this means that source has been called
-          path = "#{@project_root}/ufo/templates/#{@source}.json.erb"
+          path = "#{Ufo.root}/.ufo/templates/#{@source}.json.erb"
           check_source_path(path)
         else
           # default source path
@@ -113,7 +93,7 @@ module Ufo
 
       def check_source_path(path)
         unless File.exist?(path)
-          friendly_path = path.sub("#{@project_root}/", '')
+          friendly_path = path.sub("#{Ufo.root}/", '')
           puts "ERROR: Could not find the #{friendly_path} template.  Are sure it exists?  Check where you called source in ufo/task_definitions.rb"
           exit 1
         else

data/lib/ufo/ecr/auth.rb

@@ -1,9 +1,25 @@
+=begin
+Normally, you must authorized to AWS ECR to push to their registry with:
+
+  eval $(aws ecr get-login --no-include-email)
+
+If you haven't ever ran the ecr get-login command before then you'll get this error:
+
+  no basic auth credentials
+
+If you have ran it before but the auto token has expired you'll get this message:
+
+  denied: Your Authorization Token has expired. Please run 'aws ecr get-login' to fetch a new one.
+
+This class manipulates the ~/.docker/config.json file which is an internal docker file to automatically update the auto token for you.  If that format changes, the update will need to be updated.
+=end
 module Ufo
   class Ecr::Auth
     include AwsService
 
-    def initialize(repo_domain)
-      @repo_domain = repo_domain
+    def initialize(full_image_name)
+      @full_image_name = full_image_name
+      @repo_domain = "#{full_image_name.split('/').first}"
     end
 
     def update
@@ -18,6 +34,10 @@ module Ufo
       IO.write(docker_config, JSON.pretty_generate(data))
     end
 
+    def ecr_image?
+      !!(@full_image_name =~ /\.amazonaws\.com/)
+    end
+
     def fetch_auth_token
       ecr.get_authorization_token.authorization_data.first.authorization_token
     end

data/lib/ufo/ecs.rb

@@ -0,0 +1,5 @@
+module Ufo
+  module ECS
+    autoload :Service, 'ufo/ecs/service'
+  end
+end

data/lib/ufo/ecs/service.rb

@@ -0,0 +1,21 @@
+# Creating this class pass so we can have a reference to their properties in
+# memory: cluster_name and service_name.
+# This helps us avoid making additional API calls to describe and lookup the information.
+#
+# Also this class allows us to pass one object around instead of both
+# cluster_name and service_name.
+#
+# This is really only used in the Ufo::Ship class.
+module Ufo
+  module ECS
+    Service = Struct.new(:cluster_arn, :service_arn) do
+      def cluster_name
+        cluster_arn.split('/').last
+      end
+
+      def service_name
+        service_arn.split('/').last
+      end
+    end
+  end
+end

data/lib/ufo/help/completion.md

@@ -12,7 +12,7 @@ Examples:
 
 To enable, TAB auto-completion add the following to your profile:
 
-  eval $(ufo completion script)
+  eval $(ufo completion_script)
 
 Auto-completion example usage:
 

data/lib/ufo/help/completion_script.md

@@ -1,3 +1,3 @@
 To use, add the following to your ~/.bashrc or ~/.profile
 
-  eval $(ufo completion script)
+  eval $(ufo completion_script)

data/lib/ufo/help/deploy.md

@@ -0,0 +1,14 @@
+It is useful to sometimes deploy only the task definition without re-building it.  Say for example, you are debugging the task definition and just want to directly edit the `.ufo/output/hi-web.json` definition. You can accomplish this with the `ufo deploy` command.  The `ufo deploy` command will deploy the task definition in `.ufo/output` unmodified.  Example:
+
+  ufo deploy hi-web
+
+The above command does the following:
+
+1. register the `.ufo/output/hi-web.json` task definition to ECS untouched.
+2. deploys it to ECS by updating the service
+
+The `ufo deploy` command does less than the `ufo ship` command.  Typically, people use `ufo ship` over the `ufo deploy` command do everything in one step:
+
+1. build the Docker image
+2. register the ECS task definition
+3. update the ECS service

data/lib/ufo/help/docker/name.md

@@ -1,5 +1,16 @@
+This command fetches the last name that was generated when `docker build` was ran internally by `ufo docker build`.  You can use it after you have built a docker image with `ufo docker build`.
+
 Examples:
 
-  ufo docker name
+  ufo docker build # stores the docker image name in the .ufo/data folder
+  ufo docker name  # fetches image name from .ufo/data folder
+
+An example image name would look something like this: tongueroo/hi:ufo-2018-02-15T19-29-06-88071f5
+
+Note, the .ufo/data folder is an internal data folder and it's structure can change in future releases.
+
+If you want to generate a brand new name for whatever purpose, you can use the `--generate` flag.  The generate does not write to the `.ufo/data` folder.  It only generates a fresh name to stdout.  If you run it multiple times, it will generate new names.  You can notice this by seeing that the timestamp will always update. Examples:
 
-Docker image name that will be used: tongueroo/hi:ufo-2016-10-15T19-29-06-88071f5
+  ufo docker name --generate  # example: tongueroo/hi:ufo-2018-02-15T10-00-00-88071f5
+  ufo docker name --generate  # example: tongueroo/hi:ufo-2018-02-15T10-00-08-88071f5
+  ufo docker name --generate  # example: tongueroo/hi:ufo-2018-02-15T10-00-16-88071f5

data/lib/ufo/help/docker/push.md

@@ -0,0 +1,11 @@
+This command pushes a docker image up to the registry.  By default it pushes the last image that was built with `ufo docker build`.  To see what the image name is you can run `ufo docker name`. Example:
+
+  ufo docker build # to build the image
+  ufo docker name  # to see the image name
+  ufo docker push  # push up the registry
+
+You can also push up a custom image by specifying the image name as the first parameter.
+
+  ufo docker push my/image:tag
+
+The command also updates your ECR auth token in `~/.docker/config.json` in case it has expired.

data/lib/ufo/init.rb

@@ -1,80 +1,63 @@
-require 'colorize'
-require 'erb'
-
 module Ufo
-  class Init
-    def initialize(options = {})
-      @options = options
-      @project_root = options[:project_root] || '.'
+  class Init < Sequence
+    add_runtime_options! # force, pretend, quiet, skip options
+      # https://github.com/erikhuda/thor/blob/master/lib/thor/actions.rb#L49
+
+    # Ugly, this is how I can get the options from to match with this Thor::Group
+    def self.cli_options
+      [
+        [:force, type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files."],
+        [:image, type: :string, required: true, desc: "Docker image name without the tag. Example: tongueroo/hi. Configures ufo/settings.yml"],
+        [:app, type: :string, required: true, desc: "App name. Preferably one word. Used in the generated ufo/task_definitions.rb."],
+      ]
     end
-
-    def setup
-      puts "Setting up ufo project...".blue unless @options[:quiet]
-      source_root = File.expand_path("../../starter_project", __FILE__)
-      # https://ruby-doc.org/core-2.2.0/Dir.html
-      # use the File::FNM_DOTMATCH flag or something like "{*,.*}".
-      paths = Dir.glob("#{source_root}/**/{*,.*}").
-                select {|p| File.file?(p) }
-      paths.each do |src|
-        dest = src.gsub(%r{.*starter_project/},'')
-        dest = "#{@project_root}/#{dest}"
-
-        if File.exist?(dest) and !@options[:sure]
-          puts "exists: #{dest}".yellow unless @options[:quiet]
-        else
-          dirname = File.dirname(dest)
-          FileUtils.mkdir_p(dirname) unless File.exist?(dirname)
-          if dest =~ /\.erb$/
-            FileUtils.cp(src, dest)
-          else
-            write_erb_result(src, dest)
-          end
-          puts "created: #{dest}".green unless @options[:quiet]
-        end
-      end
-      puts "Starter ufo files created.".blue
-      File.chmod(0755, "#{@project_root}/bin/deploy")
-      add_gitignore
+    cli_options.each do |args|
+      class_option *args
     end
 
-    def write_erb_result(src, dest)
-      source = IO.read(src)
-      b = ERBContext.new(@options).get_binding
-      output = ERB.new(source).result(b)
-      IO.write(dest, output)
+    # for specs
+    def set_destination_root
+      return unless ENV['DEST_ROOT']
+
+      dest = ENV['DEST_ROOT']
+      FileUtils.rm_rf(dest) && FileUtils.mkdir_p(dest)
+      self.destination_root = dest
+      FileUtils.cd(dest)
     end
 
-    def add_gitignore
-      gitignore_path = "#{@project_root}/.gitignore"
-      if File.exist?(gitignore_path)
-        ignores = IO.read(gitignore_path)
-        has_ignore = ignores.include?("ufo/output")
-        ignores << ufo_ignores unless has_ignore
-      else
-        ignores = ufo_ignores
-      end
-      IO.write(gitignore_path, ignores)
+    def init_files
+      # map variables
+      @app = options[:app]
+      @image = options[:image]
+      # copy the files
+      puts "Setting up ufo project..."
+      directory "."
     end
 
-    def ufo_ignores
-      ignores =<<-EOL
-ufo/output
-ufo/data
+    def upsert_gitignore
+      return unless File.exist?(".gitignore")
+      append_to_file ".gitignore", <<-EOL
+.ufo/output
+.ufo/data
 EOL
     end
 
-  end
-end
+    def user_message
+      puts "Starter ufo files created."
+      puts <<-EOL
+#{"="*64}
+Congrats 🎉 You have successfully set up ufo for your project. To deploy to ECS:
 
-# http://stackoverflow.com/questions/1338960/ruby-templates-how-to-pass-variables-into-inlined-erb
-class ERBContext
-  def initialize(hash)
-    hash.each_pair do |key, value|
-      instance_variable_set('@' + key.to_s, value)
-    end
-  end
+  ufo ship #{@app}-web
+
+If you need to customize the ECS task definition to configure things like memory and cpu allocation. You can do this by adjusting the files the .ufo/variables folder. These variables get applied to the .ufo/templates/main.json.erb task definition json that is passed to the ECS register task definition api.
+
+Some additional starter example roles for your apps were set up in in .ufo/task_definitions.rb.  Be sure to check it out and adjust it for your needs.
 
-  def get_binding
-    binding
+This allows you to fully customize and control your environment to fit your application's needs.
+
+More info: http://ufoships.com
+EOL
+    end
   end
 end