ufo 5.0.7 → 6.0.0

data/lib/ufo/cli/scale.rb

@@ -0,0 +1,76 @@
+class Ufo::CLI
+  class Scale < Base
+    delegate :service, :service?, :stack_resources, to: :info
+
+    def initialize(options={})
+      super
+      @desired = options[:desired]
+      @min = options[:min]
+      @max = options[:max]
+    end
+
+    def update
+      unless service?
+        logger.error "ERROR: Unable to find the #{service}.".color(:red)
+        logger.error "Are you sure you are trying to scale the right app?"
+        exit 1
+      end
+
+      unless @desired || @min || @max
+        logger.info <<~EOL
+          No --desired --min or --max options provided
+          Not taking any actions
+        EOL
+        return
+      end
+
+      logger.info "Configuring scaling settings for #{@stack_name}"
+      set_desired_count
+      set_autoscaling
+      warning
+    end
+
+    def set_desired_count
+      return unless @desired
+      ecs.update_service(
+        service: service.service_name,
+        cluster: @cluster,
+        desired_count: @desired
+      )
+      logger.info "Configured desired count to #{@desired}"
+    end
+
+    def set_autoscaling
+      return unless @min || @max
+      scalable_target = stack_resources.find do |r|
+        r.logical_resource_id == "ScalingTarget"
+      end
+      # service/dev/app1-web-dev-EcsService-Q0XkN6VtxGWv|ecs:service:DesiredCount|ecs
+      resource_id, scalable_dimension, service_namespace = scalable_target.physical_resource_id.split('|')
+      applicationautoscaling.register_scalable_target(
+        max_capacity: @max,
+        min_capacity: @min,
+        resource_id: resource_id,
+        scalable_dimension: scalable_dimension,
+        service_namespace: service_namespace,
+      )
+      logger.info "Configured autoscaling to min: #{@min} max: #{@max}"
+    end
+
+    def warning
+      return unless Ufo.config.scale.warning
+      logger.info <<~EOL
+        Note: The settings are temporary.
+        They can be overwritten in the next `ufo ship` deploy.
+        To make the settings permanent update your ufo config.
+
+        See: https://ufoships.com/docs/config/
+
+        You can also turn off this warning with
+
+            config.scaling.warning = false
+
+      EOL
+    end
+  end
+end

data/lib/ufo/cli/ship.rb

@@ -0,0 +1,28 @@
+class Ufo::CLI
+  class Ship < Base
+    include Ufo::Concerns
+
+    def run
+      are_you_sure?
+      build_task_definition
+      deploy.run
+      ps.run
+    end
+
+    def build_task_definition
+      return if @options[:rollback]
+      build.docker
+      build.task_definition
+    end
+
+  private
+    def are_you_sure?
+      message = "Will deploy stack #{@stack_name.color(:green)}"
+      if @options[:yes]
+        logger.info message
+      else
+        sure?(message)
+      end
+    end
+  end
+end

data/lib/ufo/cli/status.rb

@@ -0,0 +1,8 @@
+class Ufo::CLI
+  class Status < Base
+    def run
+      stack = Ufo::Cfn::Stack.new(@options)
+      stack.status.wait
+    end
+  end
+end

data/lib/ufo/cli/stop.rb

@@ -0,0 +1,49 @@
+class Ufo::CLI
+  class Stop < Base
+    def run
+      service = info.service
+      return unless service # brand new deploy
+
+      @deployments = service.deployments
+      if @deployments.size >= 1
+        stop(service.service_name)
+      end
+    end
+
+    def stop(service_name)
+      tasks = service_tasks(service_name)
+      show(tasks, preview: true) unless @options[:yes]
+      sure?
+      tasks.each do |task|
+        if @options[:stop_old_tasks]
+          next if task["task_definition_arn"] == latest_deployed_arn
+        end
+        logger.debug "stop task #{task["task_arn"]}"
+        meth = "stop_task"
+        ecs.stop_task(cluster: @cluster, task: task["task_arn"], reason: "stop by ufo")
+      end
+      logger.info "Stopping tasks"
+      show(tasks, preview: false) if @options[:yes]
+    end
+
+    def show(tasks, preview: true)
+      logger.info "Will stop the following tasks:" if preview
+      ps = Ps.new(@options)
+      ps.display_tasks(tasks)
+    end
+
+    # latest deployment task definition arn
+    def latest_deployed_arn
+      latest = @deployments.sort_by do |deployment|
+        Time.parse(deployment["created_at"].to_s)
+      end.last
+      latest["task_definition"]
+    end
+
+    def service_tasks(service_name)
+      all_task_arns = ecs.list_tasks(cluster: @cluster, service_name: service_name).task_arns
+      return [] if all_task_arns.empty?
+      ecs.describe_tasks(cluster: @cluster, tasks: all_task_arns).tasks
+    end
+  end
+end

data/lib/ufo/{tasks.rb → cli/tasks.rb}

@@ -1,5 +1,5 @@
-module Ufo
-  class Tasks < Command
+class Ufo::CLI
+  class Tasks < Ufo::Command
     desc "build", "Build task definitions."
     long_desc Help.text("tasks:build")
     option :image_override, desc: "Override image in task definition for quick testing"

data/lib/ufo/{upgrade.rb → cli/upgrade.rb}

@@ -1,5 +1,5 @@
-module Ufo
-  class Upgrade < Command
+class Ufo::CLI
+  class Upgrade < Ufo::Command
     desc "v2to3", "Upgrade from version 2 to 3."
     def v2to3
       Upgrade3.new(options).run

data/lib/ufo/cli.rb

@@ -3,199 +3,123 @@ require 'ufo/command'
 
 module Ufo
   class CLI < Command
-    class_option :verbose, type: :boolean
-    class_option :mute, type: :boolean
-    class_option :noop, type: :boolean
-    class_option :cluster, desc: "Cluster.  Overrides .ufo/settings.yml."
+    include Help
+    opts = Opts.new(self)
 
-    desc "network SUBCOMMAND", "network subcommands"
-    long_desc Help.text(:network)
-    subcommand "network", Network
+    desc "central SUBCOMMAND", "central subcommands"
+    long_desc Help.text(:central)
+    subcommand "central", Central
 
     desc "docker SUBCOMMAND", "docker subcommands"
     long_desc Help.text(:docker)
     subcommand "docker", Docker
 
-    desc "tasks SUBCOMMAND", "task definition subcommands"
-    long_desc Help.text(:tasks)
-    subcommand "tasks", Tasks
-
-    desc "upgrade SUBCOMMAND", "upgrade subcommands"
-    long_desc Help.text(:upgrade)
-    subcommand "upgrade", Upgrade
-
-    long_desc Help.text(:init)
-    Init.cli_options.each do |args|
-      option(*args)
-    end
-    register(Init, "init", "init", "Set up initial ufo files.")
-
-    # common options to deploy. ship, and ships command
-    ship_options = Proc.new do
-      # All elb options remember their 'state'
-      option :ecr_keep, type: :numeric, desc: "ECR specific cleanup of old images.  Specifies how many images to keep.  Only runs if the images are ECR images. Defaults keeps all images."
-      option :elb, desc: "Decides to create elb, not create elb or use existing target group."
-      option :elb_eip_ids, type: :array, desc: "EIP Allocation ids to use for network load balancer."
-      option :elb_type, desc: "ELB type: application or network. Keep current deployed elb type when not specified."
-      option :scheduling_strategy, desc: "Scheduling strategy to use for the service. IE: replica, daemon"
-      option :stop_old_tasks, type: :boolean, default: false, desc: "Stop old tasks as part of deployment to speed it up"
-      option :task, desc: "ECS task name, to override the task name convention."
-      option :wait, type: :boolean, desc: "Wait for deployment to complete", default: true
-      option :image_override, desc: "Override image in task definition for quick testing"
-    end
-
-    desc "deploy SERVICE", "Deploy task definition to ECS service without re-building the definition."
-    long_desc Help.text(:deploy)
-    ship_options.call
-    option :register, type: :boolean, desc: "Register task definition", default: true
-    option :build, type: :boolean, desc: "Build task definition", default: true
-    def deploy(service=:current)
-      service = service == :current ? Current.service! : service
-      task_definition = options[:task] || service # convention
-      Tasks::Builder.build(options) if options[:build]
-      Tasks::Register.register(task_definition, options) if options[:register]
-      ship = Ship.new(service, options.merge(task_definition: task_definition))
-      ship.deploy
-    end
-
-    desc "ship SERVICE", "Builds and ships container image to the ECS service."
-    long_desc Help.text(:ship)
-    ship_options.call
-    def ship(service=:current)
-      service = service == :current ? Current.service! : service
-      builder = build_docker
-
-      task_definition = options[:task] || service # convention
-      Tasks::Builder.ship(task_definition, options)
-      ship = Ship.new(service, options.merge(task_definition: task_definition))
-      ship.deploy
+    desc "new SUBCOMMAND", "new subcommands"
+    long_desc Help.text(:new)
+    subcommand "new", New
 
-      cleanup(builder.image_name)
+    desc "build", "Build docker image, task definition, cloudformation template"
+    long_desc Help.text(:build)
+    opts.docker
+    def build
+      Build.new(options).build
     end
 
-    desc "rollback SERVICE VERSION", "Rolls back to older task definition."
-    long_desc Help.text(:rollback)
-    option :wait, type: :boolean, desc: "Wait for deployment to complete", default: true
-    def rollback(service=:current, version)
-      service = service == :current ? Current.service! : service
-      rollback = Rollback.new(service, options.merge(version: version))
-      rollback.deploy
-    end
-
-    desc "ships [LIST_OF_SERVICES]", "Builds and ships same container image to multiple ECS services."
-    long_desc Help.text(:ships)
-    ship_options.call
-    option :wait, type: :boolean, desc: "Wait for deployment to complete", default: false
-    def ships(*services)
-      builder = build_docker
-
-      if services.empty? && !Current.services&.empty?
-        services = Current.services
-      end
-      services.each_with_index do |service|
-        service_name, task_definition_name = service.split(':')
-        task_definition = task_definition_name || service_name # convention
-        Tasks::Builder.ship(task_definition, options)
-        ship = Ship.new(service, options.merge(task_definition: task_definition))
-        ship.deploy
-      end
-
-      cleanup(builder.image_name)
-    end
-
-    desc "task TASK_DEFINITION", "Run a one-time task."
-    long_desc Help.text(:task)
-    option :task_only, type: :boolean, desc: "Skip docker and task register steps. Only run the task."
-    option :wait, type: :boolean, aliases: 'w', desc: "Wait for task to finish.", default: false
-    option :timeout, type: :numeric, aliases: 't', desc: "How long to wait for task to finish.", default: 600
-    option :command, type: :array, aliases: 'c', desc: "Override the command used for the container"
-    def task(task_definition)
-      Docker::Builder.build(options) unless @options[:task_only]
-      Tasks::Builder.ship(task_definition, options) unless @options[:task_only]
-      Task.new(task_definition, options).run
-    end
-
-    desc "cancel SERVICE", "Cancel creation or update of the ECS service."
+    desc "cancel", "Cancel creation or update of the ECS service."
     long_desc Help.text(:cancel)
-    option :sure, type: :boolean, desc: "By pass are you sure prompt."
-    def cancel(service=:current)
-      task_definition = options[:task] || service # convention
-      Cancel.new(service, options).run
+    option :yes, aliases: :y, type: :boolean, desc: "By pass are you sure prompt."
+    def cancel
+      Cancel.new(options).run
     end
 
-    desc "current SERVICE", "Switch the current service. Saves to `.ufo/current`"
-    long_desc Help.text(:current)
-    option :rm, type: :boolean, desc: "Remove all current settings. Removes `.ufo/current`"
-    option :service, desc: "Sets service as a current setting."
-    option :services, type: :array, desc: "Sets services as a current setting. This is used for ufo ships."
-    option :env_extra, desc: "Sets UFO_ENV_EXTRA as a current setting."
-    def current
-      Current.new(options).run
+    desc "clean", "Removes `.ufo/output` folders"
+    opts.yes
+    def clean
+      Clean.new(options).run
     end
 
-    desc "destroy SERVICE", "Destroy the ECS service."
+    desc "destroy", "Destroy the ECS service."
     long_desc Help.text(:destroy)
-    option :sure, type: :boolean, desc: "By pass are you sure prompt."
+    option :yes, aliases: :y, type: :boolean, desc: "By pass are you sure prompt."
     option :wait, type: :boolean, desc: "Wait for completion", default: true
-    def destroy(service=:current)
-      task_definition = options[:task] || service # convention
-      Destroy.new(service, options).bye
+    def destroy
+      Destroy.new(options).run
     end
 
-    desc "apps", "List apps."
-    long_desc Help.text(:apps)
-    option :clusters, type: :array, desc: "List of clusters"
-    def apps
-      Apps.new(options).list_all
+    desc "exec", "Exec into container"
+    long_desc Help.text(:exec)
+    option :container, desc: "Container name to exec into. Default to role or first found"
+    option :command, aliases: :c, desc: "Command to run. Default is configured config.exec.command option"
+    def exec
+      Exec.new(options).run
     end
 
-    desc "resources SERVICE", "The ECS service resources."
-    long_desc Help.text(:resources)
-    def resources(service=:current)
-      Info.new(service, options).run
+    long_desc Help.text("init")
+    New::Init.options.each { |args| option(*args) }
+    register(New::Init, "init", "init", "Generate starter .ufo structure")
+
+    desc "logs", "Prints out logs"
+    long_desc Help.text(:logs)
+    option :follow, default: true, type: :boolean, desc: " Whether to continuously poll for new logs. To exit from this mode, use Control-C."
+    option :since, desc: "From what time to begin displaying logs.  By default, logs will be displayed starting from 1 minutes in the past. The value provided can be an ISO 8601 timestamp or a relative time."
+    option :format, default: "short", desc: "The format to display the logs. IE: detailed or short.  With detailed, the log stream name is also shown."
+    option :filter_pattern, desc: "The filter pattern to use. If not provided, all the events are matched"
+    def logs
+      Logs.new(options).run
     end
 
-    desc "scale SERVICE COUNT", "Scale the ECS service."
-    long_desc Help.text(:scale)
-    def scale(service=:current, count)
-      Scale.new(service, count, options).update
+    desc "releases", "Show possible 'releases' or task definitions for the service."
+    long_desc Help.text(:releases)
+    def releases
+      Releases.new(options).list
+    end
+
+    desc "rollback VERSION", "Rolls back to older task definition."
+    long_desc Help.text(:rollback)
+    option :wait, type: :boolean, desc: "Wait for deployment to complete", default: true
+    def rollback(version)
+      Rollback.new(options.merge(version: version)).deploy
     end
 
-    desc "ps SERVICE", "Show process info on ECS service."
+    desc "ps", "Show process info on ECS service."
     long_desc Help.text(:ps)
-    option :summary, type: :boolean, default: true, desc: "Display summary header info."
-    option :extra, type: :boolean, default: false, desc: "Display extra debugging columns."
     option :status, default: "all", desc: "Status filter: all, pending, stopped, running."
-    def ps(service=:current)
-      Ps.new(service, options).run
+    # not setting format default so we can use Ufo.config.ps.format and dont want to trigger a config load this early
+    option :format, desc: "Output formats: #{CliFormat.formats.join(', ')}"
+    def ps
+      Ps.new(options).run
     end
 
-    desc "releases SERVICE", "Show possible 'releases' or task definitions for the service."
-    long_desc Help.text(:releases)
-    def releases(service=:current)
-      Releases.new(service, options).list
+    desc "scale", "Scale the ECS service"
+    long_desc Help.text(:scale)
+    option :desired, type: :numeric, desc: "Desired count"
+    option :min, type: :numeric, desc: "Minimum capacity"
+    option :max, type: :numeric, desc: "Maximum capacity"
+    def scale
+      Scale.new(options).update
     end
 
-    desc "stop SERVICE", "Stop tasks from old deployments.  Can speed up deployments with network load balancer."
-    long_desc Help.text(:stop)
-    def stop(service=:current)
-      Stop.new(service, options).run
+    desc "ship", "Deploy app to ECS"
+    long_desc Help.text(:ship)
+    option :wait, type: :boolean, desc: "Wait for deployment to complete", default: true
+    option :image, aliases: :i, desc: "Override image in task definition for quick testing"
+    opts.docker
+    opts.yes
+    def ship
+      Ship.new(options).run
     end
 
-    desc "status SERVICE", "Status of ECS service.  Essentially, status of CloudFormation stack"
+    desc "status", "Status of ECS service.  Essentially, status of CloudFormation stack"
     long_desc Help.text(:status)
-    def status(service=:current)
-      Status.new(service, options).run
+    def status
+      Status.new(options).run
     end
 
-    desc "logs", "Prints out logs"
-    long_desc Help.text(:logs)
-    option :follow, default: true, type: :boolean, desc: " Whether to continuously poll for new logs. To exit from this mode, use Control-C."
-    option :since, desc: "From what time to begin displaying logs.  By default, logs will be displayed starting from 1 minutes in the past. The value provided can be an ISO 8601 timestamp or a relative time."
-    option :format, default: "detailed", desc: "The format to display the logs. IE: detailed or short.  With detailed, the log stream name is also shown."
-    option :filter_pattern, desc: "The filter pattern to use. If not provided, all the events are matched"
-    def logs(service=:current)
-      Logs.new(service, options).run
+    desc "stop", "Stop tasks"
+    long_desc Help.text(:stop)
+    opts.yes
+    def stop
+      Stop.new(options).run
     end
 
     desc "completion *PARAMS", "Prints words for auto-completion."
@@ -214,19 +138,5 @@ module Ufo
     def version
       puts VERSION
     end
-
-    no_tasks do
-      def build_docker
-        builder = Docker::Builder.new(options)
-        builder.build
-        builder.push
-        builder
-      end
-
-      def cleanup(image_name)
-        Docker::Cleaner.new(image_name, options).cleanup
-        Ecr::Cleaner.new(image_name, options).cleanup
-      end
-    end
   end
 end

data/lib/ufo/command.rb

@@ -11,12 +11,36 @@ class Thor
       end
     end
   end
+
+  module Util
+    # Hack to fix issue when -h produces extra ufo command in help.  IE:
+    #
+    # $ bundle exec ufo blueprint -h
+    # Commands:
+    #   ...
+    #   ufo ufo:blueprint:new BLUEPRINT_NAME  <= weird
+    #
+    # It looks like thor_classes_in is only used to generate the help menu.
+    #
+    def self.thor_classes_in(*)
+      []
+    end
+  end
 end
 
 module Ufo
   class Command < Thor
     class << self
+      include Ufo::Utils::Logging
+
       def dispatch(m, args, options, config)
+        # Old note: Configuring the DslEvalulator requires Ufo.root and Ufo.logger which
+        # loads Ufo.config and Ufo::Config#load_project_config
+        # This requires Ufo.role.
+        # So we set Ufo.role before triggering Ufo.config loading
+        configure_dsl_evaluator
+        check_project!(args)
+
         # Allow calling for help via:
         #   ufo command help
         #   ufo command -h
@@ -26,7 +50,6 @@ module Ufo
         # as well thor's normal way:
         #
         #   ufo help command
-        help_flags = Thor::HELP_MAPPINGS + ["help"]
         if args.length > 1 && !(args & help_flags).empty?
           args -= help_flags
           args.insert(-2, "help")
@@ -43,6 +66,38 @@ module Ufo
         super
       end
 
+      # Uses Ufo.logger and Ufo.root which loads Ufo.config.
+      # See comment where configure_dsl_evaluator is used about Ufo.role
+      def configure_dsl_evaluator
+        DslEvaluator.configure do |config|
+          config.backtrace.select_pattern = Ufo.root.to_s
+          config.logger = Ufo.logger
+          config.on_exception = :exit
+          config.root = Ufo.root
+        end
+      end
+
+      def help_flags
+        Thor::HELP_MAPPINGS + ["help"]
+      end
+      private :help_flags
+
+      def subcommand?
+        !!caller.detect { |l| l.include?('in subcommand') }
+      end
+
+      def check_project!(args)
+        command_name = args.first
+        return if subcommand?
+        return if command_name.nil?
+        return if help_flags.include?(args.last) # IE: -h help
+        return if %w[-h -v --version central init version].include?(command_name)
+        return if File.exist?("#{Ufo.root}/.ufo")
+
+        logger.error "ERROR: It doesnt look like this is a ufo project. Are you sure you are in a ufo project?".color(:red)
+        ENV['UFO_TEST'] ? raise : exit(1)
+      end
+
       # Override command_help to include the description at the top of the
       # long_description.
       def command_help(shell, command_name)

data/lib/ufo/concerns/autoscaling.rb

@@ -0,0 +1,11 @@
+module Ufo::Concerns
+  module Autoscaling
+    def autoscaling_enabled?
+      autoscaling.enabled && autoscaling.min_capacity && autoscaling.max_capacity
+    end
+
+    def autoscaling
+      Ufo.config.autoscaling
+    end
+  end
+end

data/lib/ufo/concerns/names.rb

@@ -0,0 +1,9 @@
+module Ufo::Concerns
+  module Names
+    extend Memoist
+    def names
+      Ufo::Names.new
+    end
+    memoize :names
+  end
+end

data/lib/ufo/concerns.rb

@@ -0,0 +1,26 @@
+module Ufo
+  module Concerns
+    extend Memoist
+    include Names
+
+    def build
+      Ufo::CLI::Build.new(@options)
+    end
+    memoize :build
+
+    def deploy
+      Ufo::Cfn::Deploy.new(@options)
+    end
+    memoize :deploy
+
+    def info
+      Ufo::Info.new(@options)
+    end
+    memoize :info
+
+    def ps
+      Ufo::CLI::Ps.new(@options)
+    end
+    memoize :ps
+  end
+end

data/lib/ufo/config/inits.rb

@@ -0,0 +1,13 @@
+class Ufo::Config
+  class Inits
+    class << self
+      include DslEvaluator
+
+      def run_all
+        Dir.glob("#{Ufo.root}/.ufo/config/inits/*.rb").each do |path|
+          evaluate_file(path)
+        end
+      end
+    end
+  end
+end