ufo 5.0.6 → 6.0.1

data/lib/ufo/cli.rb

@@ -3,199 +3,124 @@ 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
+    formats = CliFormat.formats + ["auto"]
+    option :format, desc: "Output formats: #{formats.sort.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 +139,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

data/lib/ufo/config.rb

@@ -0,0 +1,190 @@
+require "singleton"
+
+module Ufo
+  class Config
+    extend Memoist
+    include DslEvaluator
+    include Singleton
+    include Ufo::Utils::Logging
+
+    include Ufo::TaskDefinition::Helpers
+
+    attr_reader :config
+    def initialize
+      @config = defaults
+    end
+
+    def defaults
+      config = ActiveSupport::OrderedOptions.new
+
+      config.app = nil # required unless UFO_APP is set
+
+      config.autoscaling = ActiveSupport::OrderedOptions.new
+      config.autoscaling.enabled = true
+      config.autoscaling.max_capacity = 5 # dont use max thats an OrderedOptions method
+      config.autoscaling.min_capacity = 1 # dont use min thats an OrderedOptions method
+      config.autoscaling.predefined_metric_type = "ECSServiceAverageCPUUtilization"
+      config.autoscaling.scale_in_cooldown = nil
+      config.autoscaling.scale_out_cooldown = nil
+      config.autoscaling.target_value = 75.0
+
+      config.cfn = ActiveSupport::OrderedOptions.new
+      config.cfn.disable_rollback = nil
+      config.cfn.notification_arns = nil
+      config.cfn.tags = nil # should be Ruby Hash
+
+      config.dns = ActiveSupport::OrderedOptions.new
+      config.dns.comment = "cname to load balancer created by ufo"
+      config.dns.domain = nil # only recommended option to set
+      config.dns.hosted_zone_id = nil
+      config.dns.hosted_zone_name = nil
+      config.dns.name = nil
+      config.dns.ttl = 60
+      config.dns.type = "CNAME"
+
+      config.docker = ActiveSupport::OrderedOptions.new
+      config.docker.clean_keep = nil
+      config.docker.ecr_keep = nil
+      config.docker.repo = nil # required IE: org/repo basename of the Docker image
+
+      config.ecs = ActiveSupport::OrderedOptions.new
+      config.ecs.cluster = ":ENV" # => dev
+      config.ecs.deployment_configuration = nil # full control
+      config.ecs.desired_count = nil # only respected when config.autoscaling.enabled = false
+      config.ecs.maximum_percent = 200 # nil
+      config.ecs.minimum_healthy_percent = 100 # nil
+      config.ecs.scheduling_strategy = "REPLICA"
+
+      config.elb = ActiveSupport::OrderedOptions.new
+      config.elb.subnet_mappings = nil # static IP addresses for network load balancer
+      config.elb.enabled = "auto" # "auto", true or false
+      config.elb.port = 80 # default listener port
+      config.elb.ssl = ActiveSupport::OrderedOptions.new
+      config.elb.ssl.certificates = nil
+      config.elb.ssl.enabled = false
+      config.elb.ssl.port = 443
+      config.elb.type = "application"
+      config.elb.default_actions = nil # full override
+      config.elb.redirect = ActiveSupport::OrderedOptions.new
+      config.elb.redirect.code = 302  # IE: 302 or 301
+      config.elb.redirect.enabled = false
+      config.elb.redirect.port = 443
+      config.elb.redirect.protocol = "HTTPS"
+
+      config.exec = ActiveSupport::OrderedOptions.new
+      config.exec.command = "/bin/bash" # aws ecs execute-command cli
+      config.exec.enabled = true        # EcsService EnableExecuteCommand
+
+      config.log = ActiveSupport::OrderedOptions.new
+      config.log.root = Ufo.log_root
+      config.logger = ufo_logger
+      config.logger.formatter = Logger::Formatter.new
+      config.logger.level = ENV['UFO_LOG_LEVEL'] || :info
+
+      config.logs = ActiveSupport::OrderedOptions.new
+      config.logs.filter_pattern = nil
+
+      config.names = ActiveSupport::OrderedOptions.new
+      config.names.stack = ":APP-:ROLE-:ENV" # => demo-web-dev
+      config.names.task_definition = ":APP-:ROLE-:ENV" # => demo-web-dev
+
+      config.ps = ActiveSupport::OrderedOptions.new
+      config.ps.format = "auto" # CliFormat.default_format
+      config.ps.hide_age = 5 # in minutes. IE: hide tasks that are older than 5 minutes
+      config.ps.summary = true
+
+      config.secrets = ActiveSupport::OrderedOptions.new
+      config.secrets.pattern = ActiveSupport::OrderedOptions.new
+      config.secrets.pattern.secretsmanager = ":APP-:ENV-:SECRET_NAME" # => demo-dev-DB_PASS
+      config.secrets.pattern.ssm = ":APP/:ENV/:SECRET_NAME" # => demo/dev/DB_PASS
+      config.secrets.provider = "ssm" # default provider for conventional expansion IE: ssm or secretsmanager
+
+      config.scale = ActiveSupport::OrderedOptions.new
+      config.scale.warning = true
+
+      config.ship = ActiveSupport::OrderedOptions.new
+      config.ship.docker = ActiveSupport::OrderedOptions.new
+      config.ship.docker.quiet = true # only affects ufo ship docker commands output
+
+      config.state = ActiveSupport::OrderedOptions.new
+      config.state.reminder = true
+
+      # When not set, the default vpc is used
+      config.vpc = ActiveSupport::OrderedOptions.new
+      config.vpc.id = nil
+      config.vpc.security_groups = ActiveSupport::OrderedOptions.new
+      config.vpc.security_groups.ecs = nil
+      config.vpc.security_groups.elb = nil
+      config.vpc.security_groups.managed = true
+      config.vpc.subnets = ActiveSupport::OrderedOptions.new
+      config.vpc.subnets.ecs = nil
+      config.vpc.subnets.elb = nil
+
+      config
+    end
+
+    def ufo_logger
+      Logger.new(ENV['UFO_LOG_PATH'] || $stderr)
+    end
+    memoize :ufo_logger
+
+    def configure
+      yield(@config)
+    end
+
+    # load_project_config gets called so early many things like logger is not available.
+    # Take care not to rely on things that rely on the the config or else will create
+    # and infinite loop.
+    def load_project_config
+      root = layer_levels(".ufo/config")
+      env  = layer_levels(".ufo/config/env")
+      role = layer_levels(".ufo/config/#{Ufo.role}")
+      layers = root + env + role
+      # Dont use Ufo.app or that'll cause infinite loop since it loads Ufo.config
+      if ENV['UFO_APP']
+        root = layer_levels(".ufo/config/#{Ufo.app}")
+        env  = layer_levels(".ufo/config/#{Ufo.app}/env")
+        role = layer_levels(".ufo/config/#{Ufo.app}/#{Ufo.role}")
+        layers += root + env + role
+      end
+      # load_project_config gets called so early that logger is not yet configured. use puts
+      puts "Config layers:" if ENV['UFO_SHOW_ALL_LAYERS']
+      layers.each do |layer|
+        path = "#{Ufo.root}/#{layer}"
+        puts "    #{layer}" if ENV['UFO_SHOW_ALL_LAYERS']
+        evaluate_file(path)
+      end
+    end
+
+    # Works similiar to Layering::Layer. Consider combining the logic and usin Layering::Layer
+    #
+    # Examples:
+    #
+    #     prefix: .ufo/config/#{Ufo.app}/env
+    #
+    # Returns
+    #
+    #     .ufo/config/#{Ufo.app}/env.rb
+    #     .ufo/config/#{Ufo.app}/env/base.rb
+    #     .ufo/config/#{Ufo.app}/env/#{Ufo.env}.rb
+    #
+    def layer_levels(prefix=nil)
+      levels = ["", "base", Ufo.env]
+      paths = levels.map do |i|
+        # base layer has prefix of '', reject with blank so it doesnt produce '//'
+        [prefix, i].join('/')
+      end
+      add_ext!(paths)
+    end
+
+      def add_ext!(paths)
+      ext = "rb"
+      paths.map! do |path|
+        path = path.sub(/\/$/,'') if path.ends_with?('/')
+        "#{path}.rb"
+      end
+      paths
+    end
+
+end
+end