ufo 6.0.1 → 6.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3cfcec77698c26df14d0107993faaa4b6e74d235c269ff66b8750645db8103e
-  data.tar.gz: 9c5a5e8be3b5956ef6dabe22c4ddc792ca3edb9573d739821eb74378392e8ec2
+  metadata.gz: 55bfd2df0ae0be2b6c5794b147c767f1a2e2d798f68b6a0c6a34154133adf73b
+  data.tar.gz: 5c4ea4f15b55c194f0def295653a1b3278f4a0553fb8acc83ff1a1bc7a19a6ff
 SHA512:
-  metadata.gz: e3fb6884204bb2110ac621bb63f6644ff4f60b66b84d9ca5aeaa6023276d629e0e61c43a6bb539051eb594b0c0ca6294a7e78b5e55db2fb7c51f2983c4da6fdb
-  data.tar.gz: 80fd898e6c89cb1ba1ebd3aa2f5eadd04f00b12bf6ac234bdaf9eb9b72d0f2e07490400262263aab07bba73e53e7706a8d8bffb5e3d542ab285ec8502f2dd335
+  metadata.gz: e0d1c61ec52f1ae980eeca81eb7c7e8b90f3c1bd815ec3a700457ddc4a48de984d5c6c0db18271b6252e39c9f9e364640ce676c5b5a08b029e73016dcf5a78c4
+  data.tar.gz: c979b7f7174b98c9308d10650e467208e5c9bb30af2dc6b0b9153860ca8f0d61aee42314d3472b0ec05f6ce3b8756f9fbbaae40434fc9e5220c968a9f7f928dd

data/CHANGELOG.md

@@ -3,6 +3,13 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [6.0.2] - 2022-03-06
+- [#128](https://github.com/tongueroo/ufo/pull/128) cleanup region with aws_data
+- [#129](https://github.com/tongueroo/ufo/pull/129) Scale and Ps Edge Cases
+- [#130](https://github.com/tongueroo/ufo/pull/130) compiled yaml errors: print code with line number context
+- [#131](https://github.com/tongueroo/ufo/pull/131) ufo central update symlink creation
+- [#132](https://github.com/tongueroo/ufo/pull/132) ufo ps improvements better catchall error messages reporting
+
 ## [6.0.1] - 2022-03-05
 - [#126](https://github.com/tongueroo/ufo/pull/126) ecs deployment_configuration options
 - [#127](https://github.com/tongueroo/ufo/pull/127) improve ps errors reporting

data/lib/templates/init/.ufo/resources/task_definitions/web.yml

@@ -16,6 +16,8 @@ containerDefinitions:
     protocol: tcp
 <% end -%>
   command: <%= @command.to_json %>
+  linuxParameters:
+    initProcessEnabled: true
   environment: <%= @environment.to_json if @environment %>
   secrets: <%= @secrets.to_json if @secrets %>
 <% if @awslogs_group -%>

data/lib/ufo/cfn/stack.rb

@@ -52,16 +52,7 @@ module Ufo::Cfn
 
     def perform(action)
       logger.info "#{action[0..-2].capitalize}ing stack #{@stack_name.color(:green)}"
-      # Example: cloudformation.send("update_stack", stack_options)
-
-      # o = stack_options.dup
-      # o[:template_body] = '...' if o[:template_body]
-      # puts "stack_options:"
-      # pp o
-      # puts "parameters:"
-      # pp o[:parameters]
-
-      cloudformation.send("#{action}_stack", stack_options)
+      cloudformation.send("#{action}_stack", stack_options) # Example: cloudformation.send("update_stack", stack_options)
     rescue Aws::CloudFormation::Errors::ValidationError => e
       handle_stack_error(e)
     end
@@ -117,7 +108,6 @@ module Ufo::Cfn
     memoize :rollback_task_definition
 
     def exit_with_message(stack)
-      region = `aws configure get region`.strip rescue "us-east-1"
       url = "https://console.aws.amazon.com/cloudformation/home?region=#{region}#/stacks"
       logger.info "The stack is not in an updateable state: #{stack.stack_status.color(:yellow)}."
       logger.info "Here's the CloudFormation url to check for more details #{url}"
@@ -134,7 +124,6 @@ module Ufo::Cfn
         if message.include?('UPDATE_ROLLBACK_FAILED')
           logger.info "You might be able to do a 'Continue Update Rollback' and skip some resources to get the stack back into a good state."
         end
-        region = `aws configure get region`.strip rescue 'us-east-1'
         url = "https://console.aws.amazon.com/cloudformation/home?region=#{region}"
         logger.info "Here's the CloudFormation console url: #{url}"
         exit 1
@@ -171,5 +160,11 @@ module Ufo::Cfn
         logger.info "The stack is not in a state to that is cancelable: #{stack.stack_status}"
       end
     end
+
+    delegate :region, to: :aws
+    def aws
+      AwsData.new
+    end
+    memoize :aws
   end
 end

data/lib/ufo/cli/central/update.rb

@@ -9,13 +9,13 @@ class Ufo::CLI::Central
     end
 
     def run
-      action = File.exist?(".ufo") ? "update" : "create"
-      sure?("Will #{action} the .ufo folder.") # IE: Will create the .ufo folder.
       validate!
+      action = File.exist?(".ufo") ? "update" : "create"
+      sure?("Will #{action} the .ufo symlink") # IE: Will create the .ufo symlink
       logger.info "Updating .ufo with #{repo}"
       FileUtils.mkdir_p(tmp_area)
       pull
-      sync
+      symlink
       check_gitignore
     end
 
@@ -30,18 +30,25 @@ class Ufo::CLI::Central
       end
     end
 
-    def sync
-      FileUtils.mv(".ufo", ".ufo.bak") if File.exist?(".ufo")
+    # Always update the symlink in case use changes UFO_CENTRAL_REPO
+    def symlink
       src = "#{tmp_area}/#{repo_name}"
       src += "/#{folder}" if folder
-      FileUtils.cp_r(src, ".ufo")
+
+      FileUtils.mv(".ufo", ".ufo.bak") if File.exist?(".ufo") && File.directory?(".ufo")
+
+      # FileUtils.ln_s(target, link, options)
+      # ~/.ufo/central/repo -> .ufo
+      FileUtils.ln_s(src, ".ufo", verbose: true)
       FileUtils.rm_rf(".ufo.bak")
-      logger.info "The .ufo folder has been updated"
+
+      logger.info "The .ufo symlink has been updated"
     end
 
     def validate!
       return if repo
       logger.info "ERROR: Please set the env var: UFO_CENTRAL_REPO".color(:red)
+      logger.info "The ufo central update command requires it."
       exit 1
     end
 
@@ -58,11 +65,11 @@ class Ufo::CLI::Central
     end
 
     def tmp_area
-      "/tmp/ufo/central"
+      "#{ENV['HOME']}/.ufo/central"
     end
 
     def check_gitignore
-      ok = true
+      ok = false
       if File.exist?('.gitignore')
         lines = IO.readlines('.gitignore')
         ok = lines.detect do |line|

data/lib/ufo/cli/destroy.rb

@@ -18,7 +18,7 @@ class Ufo::CLI
       end
 
       cloudformation.delete_stack(stack_name: @stack_name)
-      puts "Deleting stack with ECS resources: #{@stack_name}"
+      puts "Deleting stack #{@stack_name.color(:green)}"
 
       return unless @options[:wait]
       status.wait

data/lib/ufo/cli/ps/errors.rb

@@ -1,5 +1,7 @@
 class Ufo::CLI::Ps
   class Errors < Ufo::CLI::Ps
+    extend Memoist
+
     def initialize(options={})
       super
       @tasks = options[:tasks]
@@ -87,21 +89,35 @@ class Ufo::CLI::Ps
     # Example:
     #     (service app1-web-dev-EcsService-8FMliG8m6M2p) was unable to stop or start tasks during a deployment because of the service deployment configuration. Update the minimumHealthyPercent or maximumPercent value and try again.
     def catchall
-      message = recent_message
-      words = %w[fail unable]
-      found = words.detect { |word| message.include?(word) }
-      return unless found
+      words = %w[fail unable error]
+      recent_messages = recent_events.map(&:message)
+      message = recent_messages.find  do |message|
+        words.detect { |word| message.include?(word) }
+      end
+
+      return unless message
       logger.error "ERROR: #{message}".color(:red)
+
       logger.error <<~EOL
-        You might have to cancel the stack with:
+        You might have to #{cancel_actions[:cfn]} the stack with:
 
-            ufo cancel
+            ufo #{cancel_actions[:ufo]}
 
         And try again after fixing the issue.
       EOL
     end
 
   private
+    def cancel_actions
+      stack = find_stack(@stack_name)
+      if stack && stack.stack_status == "CREATE_COMPLETE"
+        { cfn: "delete", ufo: "destroy" }
+      else
+        { cfn: "cancel", ufo: "cancel" }
+      end
+    end
+    memoize :cancel_actions
+
     # only check a few most recent
     def recent_events
       service["events"][0..4]

data/lib/ufo/cli/ps/task.rb

@@ -1,11 +1,8 @@
 class Ufo::CLI::Ps
-  class Task
-    def self.header
-      %w[Task Name Release Started Status Notes]
-    end
-
-    def initialize(task)
-      @task = task
+  class Task < Ufo::CLI::Base
+    def initialize(options={})
+      super
+      @task = options[:task] # task response from ecs.list_tasks
     end
 
     def to_a
@@ -52,9 +49,11 @@ class Ufo::CLI::Ps
     #  stopping_at=2018-07-05 22:03:44 -0700,
     #  stopped_at=2018-07-05 22:03:45 -0700,
     def hide?
-      stopped_at = time(@task["stopped_at"])
+      return false if @options[:status] == "stopped"
+      started_at = time(@task["started_at"])
+      return false unless started_at # edge case when started_at not yet set
       time = Time.now - 60 * Ufo.config.ps.hide_age
-      status == "STOPPED" && stopped_at < time
+      status == "STOPPED" && started_at < time
     end
 
     def status
@@ -92,5 +91,11 @@ class Ufo::CLI::Ps
           start_time.strftime("%m/%d/%Y")
       end
     end
+
+    class << self
+      def header
+        %w[Task Name Release Started Status Notes]
+      end
+    end
   end
 end

data/lib/ufo/cli/ps.rb

@@ -9,7 +9,12 @@ class Ufo::CLI
 
     def run
       unless service
-        logger.info info.no_service_message
+        stack = find_stack(@stack_name)
+        if stack && stack.stack_status == "CREATE_IN_PROGRESS"
+          logger.info "Stack is still creating. Try again after it completes."
+        else
+          logger.info info.no_service_message
+        end
         return
       end
 
@@ -25,8 +30,7 @@ class Ufo::CLI
         resp["tasks"]
       end.flatten
 
-      tasks = convert_to_task_objects(all_task_arns)
-      show_tasks(tasks)
+      tasks = show_tasks(all_task_arns)
       show_errors(tasks)
     end
 
@@ -63,7 +67,14 @@ class Ufo::CLI
       resp.scalable_targets.first # scalable_target
     end
 
-    def show_tasks(tasks)
+    def convert_to_task_objects(task_arns)
+      task_arns.sort_by! { |t| t["task_arn"] }
+      task_arns.map { |t| Task.new(@options.merge(task: t)) } # will have Task objects after this point
+    end
+
+    # Note: ufo stop also uses Ps#show_tasks. Thats why convert_to_task_objects within the method
+    def show_tasks(tasks_arns)
+      tasks = convert_to_task_objects(tasks_arns)
       tasks = tasks.reject(&:hide?)
       show_notes = show_notes(tasks)
 
@@ -79,6 +90,7 @@ class Ufo::CLI
         presenter.rows << row
       end
       presenter.show
+      tasks
     end
 
     def show_errors(tasks)
@@ -129,11 +141,6 @@ class Ufo::CLI
       status == "ALL" ? valid_statuses : [status]
     end
 
-    def convert_to_task_objects(task_arns)
-      task_arns.sort_by! { |t| t["task_arn"] }
-      task_arns.map { |t| Task.new(t) } # will have Task objects after this point
-    end
-
     def task_arns
       threads, results = [], {}
       statuses.each do |status|

data/lib/ufo/cli/scale.rb

@@ -45,6 +45,11 @@ class Ufo::CLI
       scalable_target = stack_resources.find do |r|
         r.logical_resource_id == "ScalingTarget"
       end
+      register_scalable_target(scalable_target)
+      logger.info "Configured autoscaling to min: #{@min} max: #{@max}"
+    end
+
+    def register_scalable_target(scalable_target)
       # 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(
@@ -54,7 +59,9 @@ class Ufo::CLI
         scalable_dimension: scalable_dimension,
         service_namespace: service_namespace,
       )
-      logger.info "Configured autoscaling to min: #{@min} max: #{@max}"
+    rescue Aws::ApplicationAutoScaling::Errors::ValidationException => e
+      logger.error "ERROR: #{e.class} #{e.message}".color(:red)
+      exit 1
     end
 
     def warning
@@ -68,7 +75,7 @@ class Ufo::CLI
 
         You can also turn off this warning with
 
-            config.scaling.warning = false
+            config.scale.warning = false
 
       EOL
     end

data/lib/ufo/cli/stop.rb

@@ -29,7 +29,7 @@ class Ufo::CLI
     def show(tasks, preview: true)
       logger.info "Will stop the following tasks:" if preview
       ps = Ps.new(@options)
-      ps.display_tasks(tasks)
+      ps.show_tasks(tasks)
     end
 
     # latest deployment task definition arn

data/lib/ufo/info.rb

@@ -40,6 +40,7 @@ module Ufo
       service = stack_resources.find { |r| r.resource_type == "AWS::ECS::Service" }
       return unless service # stack is still creating
       arn = service.physical_resource_id
+      return unless arn # can be nil for a few seconds while stack is still creating it
       resp = ecs.describe_services(services: [arn], cluster: @cluster)
       resp.services.first
     end

data/lib/ufo/task_definition/erb/yaml.rb

@@ -4,15 +4,22 @@ class Ufo::TaskDefinition::Erb
       text = IO.read(@path)
       YAML.load(text)
     rescue Psych::SyntaxError => e
-      logger.error "ERROR: #{e.class}: #{e.message}"
+      logger.error "ERROR: #{e.class}: #{e.message}".color(:red)
       logger.error <<~EOL
         Rendered file contains invalid YAML. For debugging, files available at:
 
         source:   #{@task_definition.path}
-        rendered: #{@path}
+        compiled: #{@path}
 
       EOL
-      print_code(text)
+
+      md = e.message.match(/at line (\d+) column (\d+)/)
+      if md
+        line_number = md[1]
+        DslEvaluator.print_code(@path, line_number)
+      else
+        print_code(text) # fallback to simpler print code if cannot find line numbers
+      end
     end
   end
 end

data/lib/ufo/task_definition/erb.rb

@@ -21,6 +21,11 @@ class Ufo::TaskDefinition
     end
 
     def check_empty!(data)
+      if data.nil?
+        logger.error "ERROR: Unable to compile the YAML".color(:red) # invalid YAML will result in data == nil
+        exit 1
+      end
+
       return unless data == true || data == false || data.empty?
       logger.error "ERROR: Empty task definition results".color(:red)
       logger.error <<~EOL

data/lib/ufo/version.rb

@@ -1,3 +1,3 @@
 module Ufo
-  VERSION = "6.0.1"
+  VERSION = "6.0.2"
 end

data/ufo.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "cfn-status"
   spec.add_dependency "cli-format"
   spec.add_dependency "deep_merge"
-  spec.add_dependency "dsl_evaluator"
+  spec.add_dependency "dsl_evaluator", ">= 0.2.5" # for DslEvaluator.print_code
   spec.add_dependency "memoist"
   spec.add_dependency "plissken"
   spec.add_dependency "rainbow"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ufo
 version: !ruby/object:Gem::Version
-  version: 6.0.1
+  version: 6.0.2
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-05 00:00:00.000000000 Z
+date: 2022-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-logs
@@ -212,14 +212,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.5
 - !ruby/object:Gem::Dependency
   name: memoist
   requirement: !ruby/object:Gem::Requirement