ufo 4.3.1 → 4.4.0

data/lib/cfn/stack.yml

@@ -1,4 +1,4 @@
-Description: "Ufo ECS stack <%= @pretty_service_name %>"
+Description: "Ufo ECS stack <%= @stack_name %>"
 Parameters:
   # required
   Vpc:
@@ -63,12 +63,12 @@ Resources:
 # Happens: When changing subnets for an ELB
 # Solution: Rename the ELB to force a replacement of it
 <% random = (0...3).map { (65 + rand(26)).chr }.join.downcase %>
-      Name: <%= "#{@pretty_service_name}-#{random}" %>
+      Name: <%= "#{@stack_name}-#{random}" %>
 <% end -%>
       Type: <%= @elb_type %>
       Tags:
       - Key: Name
-        Value: <%= @pretty_service_name %>
+        Value: <%= @stack_name %>
 <% if @elb_type == "application" -%>
       # Add additional extra security groups if parameters set
       SecurityGroups: !Split
@@ -96,14 +96,14 @@ Resources:
       VpcId: !Ref Vpc
       Tags:
       - Key: Name
-        Value: <%= @pretty_service_name %>
+        Value: <%= @stack_name %>
 <% if ENV['UFO_FORCE_TARGET_GROUP'] -%>
 # When adding and removing EIPs
 # Error: TargetGroup cannot be associated with more than one load balancer
 # Solution: https://forums.aws.amazon.com/thread.jspa?threadID=254544
       Name: !Join
       - '-'
-      - - <%= @pretty_service_name %>
+      - - <%= @stack_name %>
         - !Select [ 2, !Split [ '-', !GetAtt Elb.LoadBalancerName]]
 <% end -%>
       Protocol: <%= @default_target_group_protocol %>
@@ -168,7 +168,7 @@ Resources:
         CidrIp: 0.0.0.0/0
       Tags:
       - Key: Name
-        Value: <%= @pretty_service_name %>-elb
+        Value: <%= @stack_name %>-elb
 <%= custom_properties(:ElbSecurityGroup) %>
 <% end -%>
 
@@ -185,7 +185,7 @@ Resources:
       - !Ref EcsDesiredCount
       TaskDefinition: !Ref EcsTaskDefinition
 <% if pretty_name? -%>
-      ServiceName: <%= @pretty_service_name %>
+      ServiceName: <%= @stack_name %>
 <% end -%>
 <% if @container[:fargate] -%>
       LaunchType: FARGATE
@@ -243,7 +243,7 @@ Resources:
         Description: outbound traffic
       Tags:
       - Key: Name
-        Value: <%= @pretty_service_name %>
+        Value: <%= @stack_name %>
 <%= custom_properties(:EcsSecurityGroup) %>
 
 <% if @elb_type == "application" -%>

data/lib/template/.ufo/settings.yml.tt

@@ -12,17 +12,14 @@ base:
   # There are some cavaets with this. Updating properties on resources that require
   # replacment might not work. For example, adding and removing a load balancer.
   # In these cases, you must delete the entire ecs service and recreate it.
+  stack_naming: append_env
 
 development:
   # cluster: development
-  # When you have AWS_PROFILE set to one of these values, ufo will switch to the desired
-  # environment. This prevents you from switching AWS_PROFILE, forgetting to
-  # also switch UFO_ENV, and accidentally deploying to production vs development.
-  # aws_profiles:
-  #   - dev_profile1
-  #   - dev_profile2
+  # The aws_profile tightly binds UFO_ENV to AWS_PROFILE and vice-versa.
+  # aws_profile: dev_profile
 
 production:
   # cluster: production
-  # aws_profiles:
-  #   - prod_profile
+  # The aws_profile tightly binds UFO_ENV to AWS_PROFILE and vice-versa.
+  # aws_profile: prod_profile

data/lib/ufo.rb

@@ -46,3 +46,5 @@ module Ufo
 
   extend Core
 end
+
+Ufo.set_aws_profile!

data/lib/ufo/apps/service.rb

@@ -29,12 +29,12 @@ class Ufo::Apps
     end
 
     def name
-      pretty_service_name = @service["service_name"]
-      pretty_name = cfn_map[pretty_service_name]
+      actual_service_name = @service["service_name"]
+      pretty_name = cfn_map[actual_service_name]
       if pretty_name
-        "#{pretty_service_name} (#{pretty_name})"
+        "#{actual_service_name} (#{pretty_name})"
       else
-        pretty_service_name
+        actual_service_name
       end
     end
 

data/lib/ufo/base.rb

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

data/lib/ufo/cancel.rb

@@ -3,12 +3,12 @@ module Ufo
     def run
       stack = find_stack(@stack_name)
       unless stack
-        puts "No #{@pretty_service_name} service to cancel."
+        puts "No #{@service} service to cancel."
         puts "No #{@stack_name} stack to cancel. Exiting"
         exit
       end
 
-      puts "Canceling updates to #{@pretty_service_name}."
+      puts "Canceling updates to #{@stack_name}."
       if stack.stack_status == "CREATE_IN_PROGRESS"
         cloudformation.delete_stack(stack_name: @stack_name)
         puts "Canceling stack creation."

data/lib/ufo/core.rb

@@ -21,7 +21,8 @@ module Ufo
     end
 
     def env
-      ufo_env = env_from_profile(ENV['AWS_PROFILE']) || 'development'
+      # 2-way binding
+      ufo_env = env_from_profile || 'development'
       ufo_env = ENV['UFO_ENV'] if ENV['UFO_ENV'] # highest precedence
       ufo_env
     end
@@ -35,8 +36,17 @@ module Ufo
     end
     memoize :env_extra
 
-    def pretty_service_name(service)
-      [service, Ufo.env_extra].reject {|x| x==''}.compact.join('-')
+    # Overrides AWS_PROFILE based on the Ufo.env if set in configs/settings.yml
+    # 2-way binding.
+    def set_aws_profile!
+      return if ENV['TEST']
+      return unless File.exist?("#{Ufo.root}/.ufo/settings.yml") # for rake docs
+      return unless settings # Only load if within Ufo project and there's a settings.yml
+      data = settings[Ufo.env] || {}
+      if data["aws_profile"]
+        puts "Using AWS_PROFILE=#{data["aws_profile"]} from UFO_ENV=#{Ufo.env} in config/settings.yml"
+        ENV['AWS_PROFILE'] = data["aws_profile"]
+      end
     end
 
     def settings
@@ -58,17 +68,9 @@ module Ufo
       end
     end
 
-    private
-    # Do not use the Setting class to load the profile because it can cause an
-    # infinite loop then if we decide to use Ufo.env from within settings class.
-    def env_from_profile(aws_profile)
-      data = YAML.load_file("#{Ufo.root}/.ufo/settings.yml")
-      env = data.find do |_env, setting|
-        setting ||= {}
-        profiles = setting['aws_profiles']
-        profiles && profiles.include?(aws_profile)
-      end
-      env.first if env
+  private
+    def env_from_profile
+      Ufo::Setting.new.ufo_env
     end
   end
 end

data/lib/ufo/destroy.rb

@@ -13,7 +13,7 @@ module Ufo
       end
 
       if stack.stack_status =~ /_IN_PROGRESS$/
-        puts "Cannot destroy service #{@pretty_service_name.color(:green)}"
+        puts "Cannot destroy service #{@service.color(:green)}"
         puts "Cannot delete stack #{@stack_name.color(:green)} in this state: #{stack.stack_status.color(:green)}"
         puts "If the stack is taking a long time, you can cancel the current operation with:"
         puts "  ufo cancel #{@service}"
@@ -32,7 +32,7 @@ module Ufo
 
     def are_you_sure?
       return true if @options[:sure]
-      puts "You are about to destroy #{@pretty_service_name.color(:green)} service on the #{@cluster.color(:green)} cluster."
+      puts "You are about to destroy #{@service.color(:green)} service on the #{@cluster.color(:green)} cluster."
       print "Are you sure you want to do this? (y/n) "
       answer = $stdin.gets.strip
       answer =~ /^y/

data/lib/ufo/ps.rb

@@ -31,7 +31,7 @@ module Ufo
 
     def summary
       return unless @options[:summary]
-      puts "=> Service: #{@pretty_service_name}"
+      puts "=> Service: #{@service}"
       puts "   Service name: #{service.service_name}"
       puts "   Status: #{service.status}"
       puts "   Running count: #{service.running_count}"

data/lib/ufo/scale.rb

@@ -9,7 +9,7 @@ module Ufo
 
     def update
       unless service_exists?
-        puts "Unable to find the #{@pretty_service_name.color(:green)} service on the #{@cluster.color(:green)} cluster."
+        puts "Unable to find the #{@service.color(:green)} service on the #{@cluster.color(:green)} cluster."
         puts "Are you sure you are trying to scale the right service on the right cluster?"
         exit
       end
@@ -18,7 +18,7 @@ module Ufo
         cluster: @cluster,
         desired_count: @count
       )
-      puts "Scale #{@pretty_service_name.color(:green)} service in #{@cluster.color(:green)} cluster to #{@count}" unless @options[:mute]
+      puts "Scale #{@service.color(:green)} service in #{@cluster.color(:green)} cluster to #{@count}" unless @options[:mute]
     end
 
     def service_exists?

data/lib/ufo/setting.rb

@@ -27,11 +27,26 @@ module Ufo
 
       all_envs = default.deep_merge(user.deep_merge(project))
       all_envs = merge_base(all_envs)
-      data = all_envs[Ufo.env] || all_envs["base"] || {}
+      data = all_envs[ufo_env] || all_envs["base"] || {}
       data.deep_symbolize_keys
     end
     memoize :data
 
+    # Resovles infinite problem since Ufo.env can be determined from UFO_ENV or settings.yml files.
+    # When ufo is determined from settings it should not called Ufo.env since that in turn calls
+    # Settings.new.data which can then cause an infinite loop.
+    def ufo_env
+      settings = YAML.load_file("#{Ufo.root}/.ufo/settings.yml")
+      env = settings.find do |_env, section|
+        section ||= {}
+        ENV['AWS_PROFILE'] && ENV['AWS_PROFILE'] == section['aws_profile']
+      end
+
+      ufo_env = env.first if env
+      ufo_env = ENV['UFO_ENV'] if ENV['UFO_ENV'] # highest precedence
+      ufo_env || 'development'
+    end
+
   private
     def load_file(path)
       return Hash.new({}) unless File.exist?(path)

data/lib/ufo/stack/context.rb

@@ -22,7 +22,6 @@ class Ufo::Stack
       vars = {
         cluster: @cluster,
         stack_name: @stack_name, # used in custom_properties
-        pretty_service_name: Ufo.pretty_service_name(@service),
         container: container,
         # elb options remember that their 'state'
         create_elb: create_elb?, # helps set Ecs DependsOn

data/lib/ufo/stack/helper.rb

@@ -17,7 +17,24 @@ class Ufo::Stack
     end
 
     def adjust_stack_name(cluster, service)
-      [cluster, Ufo.pretty_service_name(service)].compact.join('-')
+      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."
+        puts "Pausing for 20 seconds."
+        sleep 20
+      end
+
+      parts = if settings[:stack_naming] == "append_env"
+        [service, cluster, Ufo.env_extra]
+      else
+        # legacy, to be removed in next major version
+        [cluster, service, Ufo.env_extra]
+      end
+      parts.reject {|x| x==''}.compact.join('-') # stack_name
+    end
+
+    def cfn
+      Ufo::Setting::Profile.new(:cfn, settings[:cfn_profile]).data
     end
 
     def status

data/lib/ufo/upgrade.rb

@@ -3,14 +3,15 @@ module Ufo
     autoload :Upgrade3, "ufo/upgrade/upgrade3"
     autoload :Upgrade33to34, "ufo/upgrade/upgrade33to34"
     autoload :Upgrade4, "ufo/upgrade/upgrade4"
+    autoload :Upgrade43to44, "ufo/upgrade/upgrade43to44"
 
     desc "v2to3", "Upgrade from version 2 to 3."
     def v2to3
       Upgrade3.new(options).run
     end
 
-    desc "v3_3to3_4", "Upgrade from version 3.3 to 3.4"
-    def v3_3to3_4
+    desc "v33to34", "Upgrade from version 3.3 to 3.4"
+    def v33to34
       Upgrade33to34.new(options).run
     end
 
@@ -28,5 +29,10 @@ module Ufo
     def v3to4
       Upgrade4.start
     end
+
+    desc "v43to44", "Upgrade from version 4.3 to 4.4"
+    def v43to44
+      Upgrade43to44.new(options).run
+    end
   end
 end

data/lib/ufo/upgrade/upgrade33to34.rb

@@ -30,3 +30,4 @@ class Ufo::Upgrade
     end
   end
 end
+

data/lib/ufo/upgrade/upgrade43to44.rb

@@ -0,0 +1,25 @@
+require 'fileutils'
+require 'yaml'
+
+class Ufo::Upgrade
+  class Upgrade43to44
+    def initialize(options)
+      @options = options
+    end
+
+    def run
+      settings_path = ".ufo/settings.yml"
+      settings = YAML.load_file(settings_path)
+      if settings["base"]["stack_naming"]
+        puts "Detected stack_naming in the #{settings_path}. Already upgraded to v4.4"
+        return
+      end
+
+      puts "Upgrading to ufo v4.4..."
+      settings["base"]["stack_naming"] = "append_env"
+      text = YAML.dump(settings)
+      IO.write(settings_path, text)
+      puts "Updated .ufo/settings.yml"
+    end
+  end
+end

data/lib/ufo/version.rb

@@ -1,3 +1,3 @@
 module Ufo
-  VERSION = "4.3.1"
+  VERSION = "4.4.0"
 end

data/spec/fixtures/settings.yml

@@ -6,14 +6,12 @@ base:
   # defaults when an new ECS service is created by ufo ship
   cfn_profile: default
   network_profile: default
+  stack_naming: append_env # so spec doesnt pause for 20s
 
 development:
   cluster: dev
-  aws_profiles:
-    - dev_profile1
-    - dev_profile2
+  aws_profile: dev_profile1
 
 production:
   cluster: prod
-  aws_profiles:
-    - prod_profile
+  aws_profile: prod_profile

data/spec/lib/setting_spec.rb

@@ -10,4 +10,9 @@ describe Ufo::Setting do
     cluster = setting.data[:cluster]
     expect(cluster).to eq "dev"
   end
+
+  it "ufo_env" do
+    ufo_env = setting.ufo_env
+    expect(ufo_env).to eq "development"
+  end
 end

data/ufo.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.version       = Ufo::VERSION
   spec.authors       = ["Tung Nguyen"]
   spec.email         = ["tongueroo@gmail.com"]
-  spec.summary       = "AWS ECS Deployment Tool"
+  spec.summary       = "AWS ECS Deploy Tool"
   spec.homepage      = "http://ufoships.com"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ufo
 version: !ruby/object:Gem::Version
-  version: 4.3.1
+  version: 4.4.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-14 00:00:00.000000000 Z
+date: 2019-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudformation
@@ -284,6 +284,7 @@ files:
 - README.md
 - Rakefile
 - docs/.gitignore
+- docs/.ruby-version
 - docs/CNAME
 - docs/Gemfile
 - docs/LICENSE
@@ -325,7 +326,9 @@ files:
 - docs/_docs/ufo-env-extra.md
 - docs/_docs/ufo-env.md
 - docs/_docs/ufo-tasks-register.md
-- docs/_docs/upgrade4.md
+- docs/_docs/upgrading.md
+- docs/_docs/upgrading/upgrade4.4.md
+- docs/_docs/upgrading/upgrade4.md
 - docs/_docs/variables.md
 - docs/_docs/why-cloudformation.md
 - docs/_includes/about.html
@@ -352,6 +355,7 @@ files:
 - docs/_includes/js_disqus.html
 - docs/_includes/modals.html
 - docs/_includes/nav.html
+- docs/_includes/prev_next.md
 - docs/_includes/quotes.html
 - docs/_includes/reference.md
 - docs/_includes/repo_push_access.md
@@ -395,8 +399,9 @@ files:
 - docs/_reference/ufo-tasks.md
 - docs/_reference/ufo-upgrade-help.md
 - docs/_reference/ufo-upgrade-v2to3.md
-- docs/_reference/ufo-upgrade-v3_3to3_4.md
+- docs/_reference/ufo-upgrade-v33to34.md
 - docs/_reference/ufo-upgrade-v3to4.md
+- docs/_reference/ufo-upgrade-v43to44.md
 - docs/_reference/ufo-upgrade.md
 - docs/_reference/ufo-version.md
 - docs/articles.md
@@ -546,6 +551,7 @@ files:
 - lib/ufo/upgrade/upgrade3.rb
 - lib/ufo/upgrade/upgrade33to34.rb
 - lib/ufo/upgrade/upgrade4.rb
+- lib/ufo/upgrade/upgrade43to44.rb
 - lib/ufo/util.rb
 - lib/ufo/version.rb
 - spec/fixtures/apps/describe_services.json
@@ -563,7 +569,6 @@ files:
 - spec/lib/builder_spec.rb
 - spec/lib/cli_spec.rb
 - spec/lib/completion_spec.rb
-- spec/lib/core_spec.rb
 - spec/lib/ecr_auth_spec.rb
 - spec/lib/ecr_cleaner_spec.rb
 - spec/lib/ps_spec.rb
@@ -594,10 +599,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubyforge_project: 
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: AWS ECS Deployment Tool
+summary: AWS ECS Deploy Tool
 test_files:
 - spec/fixtures/apps/describe_services.json
 - spec/fixtures/cfn/stack-events-complete.json
@@ -614,7 +620,6 @@ test_files:
 - spec/lib/builder_spec.rb
 - spec/lib/cli_spec.rb
 - spec/lib/completion_spec.rb
-- spec/lib/core_spec.rb
 - spec/lib/ecr_auth_spec.rb
 - spec/lib/ecr_cleaner_spec.rb
 - spec/lib/ps_spec.rb