ufo 2.3.0 → 3.0.0

data/lib/ufo/log_group.rb

@@ -1,4 +1,5 @@
-# Use to automatically create the CloudWatch group
+# Use to automatically create the CloudWatch group.
+# For some reason creating ECS does do this by default.
 module Ufo
   class LogGroup
     include AwsService
@@ -10,6 +11,8 @@ module Ufo
     def create
       puts "Ensuring log group for #{@task_definition} exists"
       return if @options[:noop]
+
+      Ufo.check_task_definition!(@task_definition)
       task_def = JSON.load(IO.read(task_def_path))
       task_def["containerDefinitions"].each do |container_def|
         begin
@@ -29,7 +32,7 @@ module Ufo
     end
 
     def task_def_path
-      "./ufo/output/#{@task_definition}.json"
+      "#{Ufo.root}/.ufo/output/#{@task_definition}.json"
     end
   end
 end

data/lib/ufo/sequence.rb

@@ -0,0 +1,27 @@
+require 'fileutils'
+require 'colorize'
+require 'thor'
+
+module Ufo
+  class Sequence < Thor::Group
+    include Thor::Actions
+
+    def self.source_root
+      File.expand_path("../../template", __FILE__)
+    end
+
+  private
+    def confirm_cli_project
+      cli_project = File.exist?("#{project_name}/config/application.rb")
+      unless cli_project
+        puts "It does not look like the repo #{options[:repo]} is a cli project. Maybe double check that it is?  Exited.".colorize(:red)
+        exit 1
+      end
+    end
+
+    def copy_project
+      puts "Creating new project called #{project_name}."
+      directory ".", project_name
+    end
+  end
+end

data/lib/ufo/setting.rb

@@ -2,8 +2,7 @@ require 'yaml'
 
 module Ufo
   class Setting
-    def initialize(project_root='.', check_ufo_project=true)
-      @project_root = project_root
+    def initialize(check_ufo_project=true)
       @check_ufo_project = check_ufo_project
     end
 
@@ -14,13 +13,12 @@ module Ufo
 
       if @check_ufo_project && !File.exist?(project_settings_path)
         puts "ERROR: No settings file at #{project_settings_path}.  Are you sure you are in a project with ufo setup?"
-        puts "Please create a settings file via: ufo init"
+        puts "If you want to set up ufo for this prjoect, please create a settings file via: ufo init"
         exit 1
       end
 
-      project = File.exist?(project_settings_path) ?
-                  YAML.load_file(project_settings_path) :
-                  {}
+      # project based settings files
+      project = load_file(project_settings_path)
 
       user_file = "#{ENV['HOME']}/.ufo/settings.yml"
       user = File.exist?(user_file) ? YAML.load_file(user_file) : {}
@@ -28,12 +26,24 @@ module Ufo
       default_file = File.expand_path("../default/settings.yml", __FILE__)
       default = YAML.load_file(default_file)
 
-      @settings_yaml = default.merge(user.merge(project))
+      @settings_yaml = default.deep_merge(user.deep_merge(project))[Ufo.env]
     end
 
   private
+    def load_file(path)
+      content = RenderMePretty.result(path)
+      data = File.exist?(path) ? YAML.load(content) : {}
+      # automatically add base settings to the rest of the environments
+      data.each do |ufo_env, _setting|
+        base = data["base"] || {}
+        env = data[ufo_env] || {}
+        data[ufo_env] = base.merge(env) unless ufo_env == "base"
+      end
+      data
+    end
+
     def project_settings_path
-      "#{@project_root}/ufo/settings.yml"
+      "#{Ufo.root}/.ufo/settings.yml"
     end
   end
 end

data/lib/ufo/ship.rb

@@ -1,23 +1,6 @@
 require 'colorize'
 
 module Ufo
-  # Creating this class pass so we can have a reference we do not have describe
-  # all services and look up service_name creating more API calls.
-  #
-  # Also this class allows us to pass one object around instead of both
-  # cluster_name and service_name.
-  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
-
   class UfoError < RuntimeError; end
   class ShipmentOverridden < UfoError; end
 
@@ -30,25 +13,12 @@ module Ufo
       @service = service
       @task_definition = task_definition
       @options = options
-      @project_root = options[:project_root] || '.'
       @target_group_prompt = @options[:target_group_prompt].nil? ? true : @options[:target_group_prompt]
       @cluster = @options[:cluster] || default_cluster
       @wait_for_deployment = @options[:wait].nil? ? true : @options[:wait]
       @stop_old_tasks = @options[:stop_old_tasks].nil? ? false : @options[:stop_old_tasks]
     end
 
-    # Find all the matching services on a cluster and update them.
-    # If no service is found at all, then create a service on the very first specified cluster
-    # only.
-    #
-    # If it looks like one service is passed in then it'll automatically create the service
-    # on the first cluster.
-
-    # If it looks like a regexp is passed in then it'll only update the services
-    # This is because regpex cannot be used to determined a list of service_names.
-    #
-    # Example:
-    #   No way to map: hi-.*-prod -> hi-web-prod hi-worker-prod hi-clock-prod
     def deploy
       message = "Shipping #{@service}..."
       unless @options[:mute]
@@ -60,15 +30,18 @@ module Ufo
         end
       end
 
+      ensure_log_group_exist
       ensure_cluster_exist
-      process_single_service
+      process_deployment
 
       puts "Software shipped!" unless @options[:mute]
     end
 
-    # A single service name shouold had been passed and the service automatically
-    # gets created if it does not exist.
-    def process_single_service
+    def ensure_log_group_exist
+      LogGroup.new(@task_definition, @options).create
+    end
+
+    def process_deployment
       ecs_service = find_ecs_service
       deployed_service = if ecs_service
                            # update all existing service
@@ -272,11 +245,12 @@ module Ufo
       if @options[:noop]
         message = "NOOP #{message}"
       else
-        response = ecs.update_service(
+        params = {
           cluster: ecs_service.cluster_arn, # can use the cluster name also since it is unique
           service: ecs_service.service_arn, # can use the service name also since it is unique
           task_definition: @task_definition
-        )
+        }
+        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
       puts message unless @options[:mute]
@@ -338,14 +312,9 @@ module Ufo
     # assume only 1 container_definition
     # assume only 1 port mapping in that container_defintion
     def container_info(task_definition)
+      Ufo.check_task_definition!(task_definition)
       task_definition_path = "ufo/output/#{task_definition}.json"
-      task_definition_full_path = "#{@project_root}/#{task_definition_path}"
-      unless File.exist?(task_definition_full_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?".colorize(:red)
-        exit
-      end
-      task_definition = JSON.load(IO.read(task_definition_full_path))
+      task_definition = JSON.load(IO.read(task_definition_path))
       container_def = task_definition["containerDefinitions"].first
       mappings = container_def["portMappings"]
       if mappings
@@ -363,11 +332,11 @@ module Ufo
     end
 
     # find all services on a cluster
-    # yields ECS::Service object
+    # yields Ufo::ECS::Service object
     def find_all_ecs_services
       ecs_services = []
       service_arns.each do |service_arn|
-        ecs_service = ECS::Service.new(cluster_arn, service_arn)
+        ecs_service = Ufo::ECS::Service.new(cluster_arn, service_arn)
         yield(ecs_service) if block_given?
         ecs_services << ecs_service
       end
@@ -375,7 +344,13 @@ module Ufo
     end
 
     def service_arns
-      ecs.list_services(cluster: @cluster).service_arns
+      services = ecs.list_services(cluster: @cluster)
+      list_service_arns = services.service_arns
+      while services.next_token != nil
+        services = ecs.list_services(cluster: @cluster, next_token: services.next_token)
+        list_service_arns += services.service_arns
+      end
+      list_service_arns
     end
 
     def cluster_arn
@@ -390,6 +365,8 @@ module Ufo
           message = "NOOP #{message}"
         else
           ecs.create_cluster(cluster_name: @cluster)
+          # TODO: Aad Waiter logic, sometimes the cluster does not exist by the time
+          # we create the service
         end
         puts message unless @options[:mute]
       end

data/lib/ufo/tasks/builder.rb

@@ -1,19 +1,16 @@
 module Ufo
   class Tasks::Builder
-    # build and registers together
-    def self.register(task_definition, options)
-      # task definition and deploy logic are coupled in the Ship class.
-      # Example: We need to know if the task defintion is a web service to see if we need to
-      # add the elb target group.  The web service information is in the Tasks::Builder
-      # and the elb target group gets set in the Ship class.
-      # So we always call these together.
+    # ship: build and registers task definitions together
+    def self.ship(task_definition, options)
+      # When handling task definitions in with the ship command and class, we always want to
+      # build and register task definitions. There is little point of running them independently
+      # This method helps us do that.
       Tasks::Builder.new(options).build
       Tasks::Register.register(task_definition, options)
     end
 
     def initialize(options={})
       @options = options
-      @project_root = options[:project_root] || '.'
     end
 
     def build
@@ -21,19 +18,19 @@ module Ufo
       check_templates_definitions_path
       dsl = DSL.new(template_definitions_path, @options.merge(quiet: false, mute: true))
       dsl.run
-      puts "Task Definitions built in ufo/output." unless @options[:mute]
+      puts "Task Definitions built in .ufo/output" unless @options[:mute]
     end
 
     def check_templates_definitions_path
       unless File.exist?(template_definitions_path)
-        pretty_path = template_definitions_path.sub("#{@project_root}/", '')
+        pretty_path = template_definitions_path.sub("#{Ufo.root}/", '')
         puts "ERROR: #{pretty_path} does not exist.  Run: `ufo init` to create a starter file" unless @options[:mute]
         exit 1
       end
     end
 
     def template_definitions_path
-      "#{@project_root}/ufo/task_definitions.rb"
+      "#{Ufo.root}/.ufo/task_definitions.rb"
     end
   end
 end

data/lib/ufo/tasks/register.rb

@@ -6,8 +6,7 @@ module Ufo
     include AwsService
 
     def self.register(task_name, options={})
-      project_root = options[:project_root] || '.'
-      Dir.glob("#{project_root}/ufo/output/*").each do |path|
+      Dir.glob("#{Ufo.root}/.ufo/output/*").each do |path|
         if task_name == :all or path.include?(task_name)
           task_register = Tasks::Register.new(path, options)
           task_register.register
@@ -20,7 +19,7 @@ module Ufo
       @options = options
     end
 
-    # aws ecs register-task-definition --cli-input-json file://ufo/output/hi-web-prod.json
+    # aws ecs register-task-definition --cli-input-json file://.ufo/output/hi-web-prod.json
     def register
       data = JSON.parse(IO.read(@template_definition_path), symbolize_names: true)
       data = data.to_snake_keys

data/lib/ufo/upgrade3.rb

@@ -0,0 +1,64 @@
+require 'fileutils'
+require 'yaml'
+
+module Ufo
+  class Upgrade3
+    def initialize(options)
+      @options = options
+    end
+
+    def run
+      if File.exist?("#{Ufo.root}/.ufo")
+        puts "It looks like you already have a .ufo folder in your project. This is the new project structure so exiting without updating anything."
+        return
+      end
+
+      if !File.exist?("#{Ufo.root}/ufo")
+        puts "Could not find a ufo folder in your project. Maybe you want to run ufo init to initialize a new ufo project instead?"
+        return
+      end
+
+      puts "Upgrading structure of your current project to the new ufo version 3 project structure"
+      upgrade_settings("ufo/settings.yml")
+      user_settings_path = "#{ENV['HOME']}/.ufo/settings.yml"
+      if File.exist?(user_settings_path)
+        upgrade_settings(user_settings_path)
+      end
+      mv("ufo", ".ufo")
+      puts "Upgrade complete."
+    end
+
+    def upgrade_settings(path)
+      data = YAML.load_file(path)
+      return if data.key?("base") # already in new format
+
+      new_structure = {}
+
+      (data["aws_profile_ufo_env_map"] || {}).each do |aws_profile, ufo_env|
+        new_structure[ufo_env] ||= {}
+        new_structure[ufo_env]["aws_profiles"] ||= []
+        new_structure[ufo_env]["aws_profiles"] << aws_profile
+      end
+      data.delete("aws_profile_ufo_env_map")
+
+      (data["ufo_env_cluster_map"] || {}).each do |ufo_env, cluster|
+        new_structure[ufo_env] ||= {}
+        new_structure[ufo_env]["cluster"] = cluster
+      end
+      data.delete("ufo_env_cluster_map")
+
+      new_structure["base"] = data
+      text = YAML.dump(new_structure)
+      IO.write(path, text)
+      puts "Upgraded settings: #{path}"
+      if path.include?(ENV['HOME'])
+        puts "NOTE: Your ~/.ufo/settings.yml file was also upgraded to the new format. If you are using ufo in other projects those will have to be upgraded also."
+      end
+    end
+
+    def mv(src, dest)
+      puts "mv #{src} #{dest}"
+      FileUtils.mv(src, dest)
+    end
+  end
+end

data/lib/ufo/util.rb

@@ -1,8 +1,6 @@
 module Ufo
   module Util
     def execute(command, local_options={})
-      command = "cd #{@project_root} && #{command}"
-      # local_options[:live] overrides the global @options[:noop]
       if @options[:noop] && !local_options[:live]
         say "NOOP: #{command}"
         result = true # always success with no noop for specs

data/lib/ufo/version.rb

@@ -1,3 +1,3 @@
 module Ufo
-  VERSION = "2.3.0"
+  VERSION = "3.0.0"
 end

data/spec/fixtures/home_existing/.docker/config.json

@@ -1,6 +1,6 @@
 {
   "auths": {
-    "https://123456789.dkr.ecr.us-east-1.amazonaws.com": {
+    "123456789.dkr.ecr.us-east-1.amazonaws.com": {
       "auth": "crazylongawsecrtoken"
     },
     "https://index.docker.io/v1/": {

data/spec/fixtures/settings.yml

@@ -0,0 +1,23 @@
+# More info: http://ufoships.com/docs/ufo-settings/
+base: &base
+  image: <%= @image %>
+  # clean_keep: 30 # cleans up docker images on your docker server.
+  # ecr_keep: 30 # cleans up images on ECR and keeps this remaining amount. Defaults to keep all.
+  # defaults when an new ECS service is created by ufo ship
+  new_service:
+    maximum_percent: 200
+    minimum_healthy_percent: 100
+    desired_count: 1
+
+development:
+  <<: *base
+  cluster: dev
+  aws_profiles:
+    - dev_profile1
+    - dev_profile2
+
+production:
+  <<: *base
+  cluster: prod
+  aws_profiles:
+    - prod_profile

data/spec/lib/cli_spec.rb

@@ -1,15 +1,7 @@
-require 'spec_helper'
-
-# to run specs with what's remembered from vcr
-#   $ rake
-#
-# to run specs with new fresh data from aws api calls
-#   $ rake clean:vcr ; time rake
 describe Ufo::CLI do
   before(:all) do
     create_starter_project_fixture
-    project_root = File.expand_path("../../fixtures/hi", __FILE__)
-    @args = "--noop --project-root=#{project_root}"
+    @args = "--noop"
   end
 
   describe "ufo" do

data/spec/lib/completion_spec.rb

@@ -0,0 +1,18 @@
+describe Ufo::CLI do
+  describe "ufo completion" do
+    commands = {
+      "ship" => "service",
+      "ship service" => "--task",
+      "docker" =>  "build",
+      "docker build" => "--push",
+      "docker clean" => "image_name",
+      "init" => "--image",
+    }
+    commands.each do |command, expected_word|
+      it "#{command}" do
+        out = execute("exe/ufo completion #{command}")
+        expect(out).to include(expected_word) # only checking for one word for simplicity
+      end
+    end
+  end
+end