ufo 4.4.3 → 4.5.0

data/lib/ufo/apps.rb

@@ -2,33 +2,40 @@ require 'text-table'
 
 module Ufo
   class Apps
-    autoload :CfnMap, "ufo/apps/cfn_map"
-    autoload :Service, "ufo/apps/service"
-
     extend Memoist
     include Stack::Helper
 
     def initialize(options)
       @options = options
-      @cluster = @options[:cluster] || default_cluster
+      @clusters = @options[:cluster] || @options[:clusters]
+      @clusters = [@clusters].flatten.compact
+      if @clusters.empty?
+        @clusters = Cluster.all
+      end
+    end
+
+    def list_all
+      @clusters.each do |cluster|
+        list(cluster)
+      end
     end
 
-    def list
+    def list(cluster)
       begin
-        resp = ecs.list_services(cluster: @cluster)
+        resp = ecs.list_services(cluster: cluster)
       rescue Aws::ECS::Errors::ClusterNotFoundException => e
-        puts "ECS cluster #{@cluster.color(:green)} not found."
-        exit 1
+        puts "ECS cluster #{cluster.color(:green)} not found."
+        return
       end
       arns = resp.service_arns.sort
 
-      puts "Listing ECS services in the #{@cluster.color(:green)} cluster."
+      puts "Listing ECS services in the #{cluster.color(:green)} cluster."
       if arns.empty?
-        puts "No ECS services found in the #{@cluster.color(:green)} cluster."
+        puts "No ECS services found in the #{cluster.color(:green)} cluster."
         return
       end
 
-      resp = ecs.describe_services(services: arns, cluster: @cluster)
+      resp = ecs.describe_services(services: arns, cluster: cluster)
       display_info(resp)
     end
 

data/lib/ufo/apps/cfn_map.rb

@@ -5,7 +5,7 @@ class Ufo::Apps
 
     def initialize(options = {})
       @options = options
-      @cluster = @options[:cluster] || default_cluster
+      @cluster = @options[:cluster] || default_cluster(options[:service])
       @map = {}
     end
 

data/lib/ufo/apps/cluster.rb

@@ -0,0 +1,24 @@
+class Ufo::Apps
+  class Cluster
+    def self.all
+      new.all
+    end
+
+    def all
+      Ufo.check_ufo_project!
+      clusters = if settings[:service_cluster]
+        settings[:service_cluster].values
+      elsif settings[:cluster]
+        settings[:cluster]
+      else
+        Ufo.env
+      end
+      [clusters].flatten.compact
+    end
+
+  private
+    def settings
+      @settings ||= Ufo.settings
+    end
+  end
+end

data/lib/ufo/autoloader.rb

@@ -0,0 +1,21 @@
+require "zeitwerk"
+
+module Ufo
+  class Autoloader
+    class Inflector < Zeitwerk::Inflector
+      def camelize(basename, _abspath)
+        map = { cli: "CLI", dsl: "DSL", version: "VERSION" }
+        map[basename.to_sym] || super
+      end
+    end
+
+    class << self
+      def setup
+        loader = Zeitwerk::Loader.new
+        loader.inflector = Inflector.new
+        loader.push_dir(File.dirname(__dir__)) # lib
+        loader.setup
+      end
+    end
+  end
+end

data/lib/ufo/base.rb

@@ -7,7 +7,7 @@ module Ufo
       @service = switch_current(service)
       @options = options
 
-      @cluster = @options[:cluster] || default_cluster
+      @cluster = @options[:cluster] || default_cluster(@service)
       @stack_name = adjust_stack_name(@cluster, @service)
     end
 
@@ -22,8 +22,8 @@ module Ufo
 
     def no_service_message
       <<-EOL
-No #{@service.color(:green)} found.
-No CloudFormation stack named #{@stack_name} found.
+No #{@service.color(:green)} ecs service found.
+No CloudFormation stack named #{@stack_name.color(:green)} found.
 Are sure it exists?
       EOL
     end

data/lib/ufo/cli.rb

@@ -143,8 +143,9 @@ module Ufo
 
     desc "apps", "List apps."
     long_desc Help.text(:apps)
+    option :clusters, type: :array, desc: "List of clusters"
     def apps
-      Apps.new(options).list
+      Apps.new(options).list_all
     end
 
     desc "resources SERVICE", "The ECS service resources."

data/lib/ufo/completer.rb

@@ -70,8 +70,6 @@ Auto-completion accounts for each of these type of commands.
 =end
 module Ufo
   class Completer
-    autoload :Script, 'ufo/completer/script'
-
     def initialize(command_class, *params)
       @params = params
       @current_command = @params[0]

data/lib/ufo/docker.rb

@@ -1,10 +1,5 @@
 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'
-
     desc "build", "Build docker image."
     long_desc Help.text("docker:build")
     option :push, type: :boolean, default: false

data/lib/ufo/docker/builder.rb

@@ -23,12 +23,12 @@ class Ufo::Docker
       start_time = Time.now
       store_full_image_name
 
-      update_auth_token
-
       command = "docker build #{build_options}-t #{full_image_name} -f #{@dockerfile} ."
       say "Building docker image with:".color(:green)
       say "  #{command}".color(:green)
+      compile_dockerfile_erb
       check_dockerfile_exists
+      update_auth_token
       command = "cd #{Ufo.root} && #{command}"
       success = execute(command, use_system: true)
       unless success
@@ -81,6 +81,10 @@ class Ufo::Docker
       @pusher ||= Pusher.new(full_image_name, @options)
     end
 
+    def compile_dockerfile_erb
+      Compiler.new("#{Ufo.root}/#{@dockerfile}").compile
+    end
+
     def check_dockerfile_exists
       unless File.exist?("#{Ufo.root}/#{@dockerfile}")
         puts "#{@dockerfile} does not exist.  Are you sure it exists?"
@@ -139,8 +143,12 @@ class Ufo::Docker
     end
 
     def update_dockerfile
-      dockerfile = Dockerfile.new(full_image_name, @options)
-      dockerfile.update
+      updater = if File.exist?("#{Ufo.root}/Dockerfile.erb") # dont use @dockerfile on purpose
+        Variables.new(full_image_name, @options)
+      else
+        Dockerfile.new(full_image_name, @options)
+      end
+      updater.update
     end
 
     def say(msg)

data/lib/ufo/docker/compiler.rb

@@ -0,0 +1,21 @@
+class Ufo::Docker
+  class Compiler
+    def initialize(dockerfile)
+      @dockerfile = dockerfile
+      @erb_file = "#{dockerfile}.erb"
+    end
+
+    def compile
+      return unless File.exist?(@erb_file)
+
+      puts "Compiled #{File.basename(@erb_file).color(:green)} to #{File.basename(@dockerfile).color(:green)}"
+      path = "#{Ufo.root}/.ufo/settings/dockerfile_variables.yml"
+      vars = YAML.load_file(path)[Ufo.env] if File.exist?(path)
+      vars ||= {}
+      result = RenderMePretty.result(@erb_file, vars)
+      comment = "# Note this file was generated from #{File.basename(@erb_file)} as a part of running ufo ship"
+      result = "#{comment}\n#{result}"
+      IO.write(@dockerfile, result)
+    end
+  end
+end

data/lib/ufo/docker/dockerfile.rb

@@ -1,8 +1,7 @@
 module Ufo
   class Docker::Dockerfile
     def initialize(full_image_name, options={})
-      @full_image_name = full_image_name
-      @options = options
+      @full_image_name, @options = full_image_name, options
     end
 
     def update

data/lib/ufo/docker/variables.rb

@@ -0,0 +1,26 @@
+class Ufo::Docker
+  class Variables
+    @@variables_path = "#{Ufo.root}/.ufo/settings/dockerfile_variables.yml"
+
+    def initialize(full_image_name, options={})
+      @full_image_name, @options = full_image_name, options
+    end
+
+    def update
+      data = current_data
+      data[Ufo.env] ||= {}
+      data[Ufo.env]["base_image"] = @full_image_name
+      pretty_path = @@variables_path.sub("#{Ufo.root}/", "")
+      IO.write(@@variables_path, YAML.dump(data))
+
+      unless @options[:mute]
+        puts "The #{pretty_path} base_image has been updated with the latest base image:".color(:green)
+        puts "  #{@full_image_name}".color(:green)
+      end
+    end
+
+    def current_data
+      File.exist?(@@variables_path) ? YAML.load_file(@@variables_path) : {}
+    end
+  end
+end

data/lib/ufo/dsl.rb

@@ -2,10 +2,6 @@ require 'ostruct'
 
 module Ufo
   class DSL
-    autoload :TaskDefinition, 'ufo/dsl/task_definition'
-    autoload :Outputter, 'ufo/dsl/outputter'
-    autoload :Helper, 'ufo/dsl/helper'
-
     def initialize(template_definitions_path, options={})
       @template_definitions_path = template_definitions_path
       @options = options

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

@@ -36,4 +36,14 @@ Some of the output has been excluded so we can focus on the important parts to p
 
 It is using the docker `-f Dockerfile.base` option to build the base image.  It names the image with `tongueroo/demo-ufo:base-2017-06-12T14-36-44-2af505e`.  The image tag contains useful information: the timestamp when the image was built and the exact git sha of the code.  The image gets push to a registry immediately.
 
+## Dockerfile FROM updated
+
 Notice at the very end, the *current* `Dockerfile`'s FROM statement has been updated with the newly built base Docker image automatically.  This saves you from forgetting to copying and pasting it the `Dockerfile` yourself.
+
+If you're using a [Dockerfile.erb](https://ufoships.com/docs/extras/dockerfile-erb/), then ufo will update the `.ufo/settings/dockerfile_variables.yml` file instead.  It assumes you're using a Dockerfile.erb that looks something like this:
+
+```Dockerfile
+FROM <%= @base_image %>
+# ...
+CMD ["bin/web"]
+```

data/lib/ufo/help/task.md

@@ -1,3 +1,9 @@
+The `ufo task` commands:
+
+1. Builds the docker image
+2. Registers the ECS task definition
+3. Runs the command
+
 ## Examples
 
 You can use the `--command` or `-c` option to override the Docker container command.
@@ -15,3 +21,7 @@ The `--task-only` option is useful. By default, the `ufo task` command will buil
   ufo task demo-web -c uptime # build at least once
   ufo task demo-web --task-only -c ls # skip docker for speed
   ufo task demo-web --task-only -c pwd # skip docker for speed
+
+## Params
+
+You can control and customize the params that get sent to the ECS run_task call with a `config/params.yml` file. More info here: https://ufoships.com/docs/ufo-task-params/

data/lib/ufo/network.rb

@@ -1,9 +1,5 @@
 module Ufo
   class Network < Command
-    autoload :Init, "ufo/network/init"
-    autoload :Helper, "ufo/network/helper"
-    autoload :Fetch, "ufo/network/fetch"
-
     def self.cli_options
       [
         [:force, type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files."],

data/lib/ufo/param.rb

@@ -9,7 +9,7 @@ module Ufo
     end
 
     def data
-      upgrade_message!
+      return {} unless File.exist?(@params_path)
 
       result = RenderMePretty.result(@params_path, context: template_scope)
       data = YAML.load(result) || {}
@@ -20,20 +20,5 @@ module Ufo
     def template_scope
       @template_scope ||= Ufo::TemplateScope.new(Ufo::DSL::Helper.new, nil)
     end
-
-    # 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 upgrade v3_3to3_4` command to upgrade.
-    def upgrade_message!
-      return if File.exist?(@params_path)
-
-      puts "ERROR: Your project is missing the .ufo/params.yml.".color(:red)
-      puts "This was added in ufo version 3.4"
-      puts "You can find more info about the params file here: http://ufoships.com/docs/params/"
-      puts "To upgrade run:"
-      puts "  ufo upgrade v3_3to3_4"
-      exit 1
-    end
   end
 end

data/lib/ufo/ps.rb

@@ -2,8 +2,6 @@ require 'text-table'
 
 module Ufo
   class Ps < Base
-    autoload :Task, 'ufo/ps/task'
-
     delegate :service, to: :info
 
     def run

data/lib/ufo/setting.rb

@@ -3,8 +3,6 @@ require 'yaml'
 module Ufo
   class Setting
     extend Memoist
-    autoload :Profile, "ufo/setting/profile"
-
     def initialize(check_ufo_project=true)
       @check_ufo_project = check_ufo_project
     end

data/lib/ufo/ship.rb

@@ -1,7 +1,6 @@
 module Ufo
   class UfoError < RuntimeError; end
   class ShipmentOverridden < UfoError; end
-  autoload :KillTask, 'ufo/ship/kill_task'
 
   class Ship < Base
     def initialize(service, options={})
@@ -10,13 +9,13 @@ module Ufo
     end
 
     def deploy
-      message = "Deploying #{@service}..."
+      message = "Deploying service #{@service.color(:green)} to cluster #{@cluster.color(:green)}..."
       unless @options[:mute]
         if @options[:noop]
           puts "NOOP: #{message}"
           return
         else
-          puts message.color(:green)
+          puts message
         end
       end
 

data/lib/ufo/stack.rb

@@ -23,9 +23,6 @@
 #
 module Ufo
   class Stack
-    autoload :Context, "ufo/stack/context"
-    autoload :Helper, "ufo/stack/helper"
-    autoload :Status, "ufo/stack/status"
     extend Memoist
     include Helper
 
@@ -33,7 +30,7 @@ module Ufo
       @options = options
       @task_definition = options[:task_definition]
       @service = options[:service]
-      @cluster = @options[:cluster] || default_cluster
+      @cluster = @options[:cluster] || default_cluster(@service)
       @stack_name = adjust_stack_name(@cluster, options[:service])
     end
 

data/lib/ufo/stack/context.rb

@@ -91,12 +91,12 @@ class Ufo::Stack
       create_elb == "true" # convert to boolean
     end
 
-    # if --elb is not set at all, so it's nil. Thhen it defaults to creating the
-    # load balancer if the ecs service has a container name "web".
+    # If --elb is not set at all and is nil, then it defaults to creating the load balancer if the ecs service has
+    # a container name "web".
     #
-    # --elb '' - wont crete an elb
+    # --elb '' - will not crete an elb
     # --elb 'auto' - creates an elb
-    # --elb arn:... - wont create elb and use the existing target group
+    # --elb arn:... - will not create elb and use the existing target group
     #
     def elb_options
       case @options[:elb]

data/lib/ufo/stack/helper.rb

@@ -17,14 +17,20 @@ class Ufo::Stack
     end
 
     def adjust_stack_name(cluster, service)
-      if settings[:stack_naming] != "append_env"
-        puts "WARN: In ufo v4.4 the environment name gets appends to the end of the CloudFormation stack name.  This means a new stack gets created. You must upgrade to using the new stack and delete the old stack manually.  More info: http://ufoships.com/docs/upgrading/upgrade4.4/".color(:yellow)
-        puts "To get rid of this warning you can add `stack_naming: append_env` to your `.ufo/settings.yml config. New versions of ufo init does this automatically."
+      upgraded_namings = %w[append_ufo_env append_env append_cluster]
+      unless upgraded_namings.include?(settings[:stack_naming])
+        puts "WARN: In ufo v4.6 the UFO_ENV value gets appends to the end of the CloudFormation stack name.  This means a new stack gets created. You must upgrade to using the new stack and delete the old stack manually.  More info: http://ufoships.com/docs/upgrading/upgrade4.x/".color(:yellow)
+        puts "To get rid of this warning you can add `stack_naming: append_ufo_env` to your `.ufo/settings.yml config. New versions of ufo init do this automatically."
         puts "Pausing for 20 seconds."
         sleep 20
       end
 
-      parts = if settings[:stack_naming] == "append_env"
+      parts = case settings[:stack_naming]
+      when "append_ufo_env" # ufo v4.6
+        [service, Ufo.env, Ufo.env_extra]
+      when "append_env", "append_cluster" # ufo v4.5
+        # append_env will be removed in the next major version in favor of apend_cluster.
+        # To avoid confusiong with append_ufo_env
         [service, cluster, Ufo.env_extra]
       else
         # legacy, to be removed in next major version