ufo 6.2.0 → 6.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b86133b126853170107907bce7c02f4620387d8b11c4a5e6e0f03176fda1349
-  data.tar.gz: 3c543c7b436ec7214043d5f5cf45a798af2ce054aed970fa5de991848f6a4664
+  metadata.gz: 19359c25a4a47a3a997d9a2ad481b2dcb7a1b134474cb8c1acb83b8b2a370815
+  data.tar.gz: e6f4b287dfa7c1a46a9aaac910718ea39e5d4b6170d937a513ecc967ef21bffd
 SHA512:
-  metadata.gz: f4658807edc6f36b07cf8048f9f7f9c75ed90f3a03cd481ea1b763d4332bdf887a17d9199988021fa3866d73e7d0b0f43b1d03ef031915fdf5e0d3ad00a5904c
-  data.tar.gz: d52d10df7faf76256f336abfc89a9ccd1afb999973d52e7cbf660481c17eb54ae8333c09e600de12455020c707fd1821a32beee0a893c72750337c1aecbcfaaa
+  metadata.gz: c718937b596ec38c56d997d6e03e6320ca2b556c595fdb0a430b883ad36c0ae96d3f9c6226d912c957b0168d8d820ea753e9ce0ee0f80e702bad3dea106ea893
+  data.tar.gz: f22ffd461ba1992baf9d6f07c9315ff4ed231386663a3fdee77a876effc36ae37120ebc4a9651cf467df104a23409bb86994c947f73c55687a55a39254208808

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 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.2.1] - 2022-03-16
+- [#153](https://github.com/tongueroo/ufo/pull/153) dockerfile_port also consider Dockerfile.base
+- [#154](https://github.com/tongueroo/ufo/pull/154) report wrong vpc config errors to user
+
 ## [6.2.0] - 2022-03-16
 - [#152](https://github.com/tongueroo/ufo/pull/152) ufo docker base: s3 storage support
 

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

@@ -15,6 +15,7 @@ class Ufo::CLI::Ps
       scale
       target_group
       deployment_configuration
+      wrong_vpc
       catchall
     end
 
@@ -86,6 +87,45 @@ class Ufo::CLI::Ps
       EOL
     end
 
+    # To reproduce #1
+    #
+    #   1. Deploy to with settings where ECS cluster is in custom VPC successfully
+    #   2. Deploy again. Accidentally with default VPC settings <= Reproduction
+    #
+    # This will produce a CloudFormation stack failure
+    #
+    # > All subnets must belong to the same VPC: 'vpc-11111111' (Service: AmazonElasticLoadBalancing; Status Code: 400; Error Code: InvalidConfigurationRequest; Request ID: b8c683ca-4c6d-4bf9-bf9b-3eb468fa9ea9; Proxy: null)
+    #
+    # So it's not actually an ECS failure and is caught early on. Notiing it for posterity.
+    #
+    # To reproduce #2
+    #
+    #   Deploy to default VPC. Even though ECS cluster is running on a custom VPC <= Reproduction
+    #
+    # This reproduces:
+    #
+    # > ERROR: (service demo-web-dev-EcsService-RkMBAhHBfx9A) failed to register targets in (target-group arn:aws:elasticloadbalancing:us-west-2:111111111111:targetgroup/demo-Targe-1HEN2QPS5LO9B/0c69c3eb5aa23bc9) with (error The following targets are not in the target group VPC 'vpc-11111111': 'i-11111111111111111')
+    #
+    # The first deploy suceeeds because CloudFormation doesn't check on the ECS service as much here.
+    # ECS does report the error though.
+    #
+    def wrong_vpc
+      error_event = recent_events.find do |e|
+        e.message =~ /targets are not in the target group VPC/ ||
+        e.message =~ /All subnets must belong to the same VPC/
+      end
+      return unless error_event
+
+      logger.info "ERROR: VPC Configuration error".color(:red)
+      logger.info error_event.message.color(:red)
+      logger.info <<~EOL
+        It seems like the ECS Service was deployed to an ECS Cluster running on
+        a different VPC than what's the ECS Service is configured with.
+
+        See: https://ufoships.com/docs/debug/vpc-subnets/
+      EOL
+    end
+
     # 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

data/lib/ufo/task_definition/helpers/{core.rb → docker.rb}

@@ -4,13 +4,16 @@
 # * dockerfile_port - Exposed port in the Dockerfile.  Only supports one exposed port, the first one that is encountered.
 #
 module Ufo::TaskDefinition::Helpers
-  module Core
-    extend Memoist
-
+  module Docker
     def dockerfile_port
-      dockerfile_path = "#{Ufo.root}/Dockerfile"
-      if File.exist?(dockerfile_path)
-        parse_for_dockerfile_port(dockerfile_path)
+      if File.exist?("Dockerfile")
+        port = parse_for_dockerfile_port("Dockerfile")
+        return port if port
+      end
+
+      # Also consider EXPOSE in Dockerfile.base
+      if File.exist?("Dockerfile.base")
+        parse_for_dockerfile_port("Dockerfile.base")
       end
     end
 
@@ -19,24 +22,6 @@ module Ufo::TaskDefinition::Helpers
       Ufo::Docker::Builder.new({}).docker_image
     end
 
-    def env(text)
-      Vars.new(text: text).env
-    end
-    alias_method :env_vars, :env
-    alias_method :environment, :env
-
-    def env_file(path)
-      Vars.new(file: path).env
-    end
-
-    def secrets(text)
-      Vars.new(text: text).secrets
-    end
-
-    def secrets_file(path)
-      Vars.new(file: path).secrets
-    end
-
     def parse_for_dockerfile_port(dockerfile_path)
       lines = IO.read(dockerfile_path).split("\n")
       expose_line = lines.find { |l| l =~ /^EXPOSE / }

data/lib/ufo/task_definition/helpers/{aws_helper.rb → vars/aws_helper.rb}

@@ -1,4 +1,5 @@
-module Ufo::TaskDefinition::Helpers
+module Ufo::TaskDefinition::Helpers::Vars
+  # Named AwsHelper to avoid possible conflict with Aws elsewhere
   module AwsHelper
     extend Memoist
     extend ActiveSupport::Concern

data/lib/ufo/task_definition/helpers/vars/builder.rb

@@ -0,0 +1,124 @@
+require "aws_data"
+
+module Ufo::TaskDefinition::Helpers::Vars
+  class Builder
+    extend Memoist
+    include AwsHelper
+    include Ufo::Concerns::Names
+    include Ufo::Utils::Pretty
+    include Ufo::Config::CallableOption::Concern
+
+    def initialize(options={})
+      # use either file or text. text takes higher precedence
+      @file = options[:file]
+      @text = options[:text]
+    end
+
+    def content
+      @text || read(@file)
+    end
+
+    def read(path)
+      full_path = "#{Ufo.root}/#{path}"
+      unless File.exist?(full_path)
+        puts "The #{pretty_path(full_path)} env file could not be found.  Are you sure it exists?"
+        exit 1
+      end
+      IO.read(full_path)
+    end
+
+    def env
+      lines = filtered_lines(content)
+      lines.map do |line|
+        key,*value = line.strip.split("=").map do |x|
+          remove_surrounding_quotes(x.strip)
+        end
+        value = value.join('=')
+        {
+          name: key,
+          value: value,
+        }
+      end
+    end
+
+    def secrets
+      secrets = env
+      secrets.map do |item|
+        value = item.delete(:value)
+        arn = normalize_to_arn(item[:name], value)
+        value = expansion(arn)
+        value = value.sub('parameter//','parameter/') # auto fix accidental leading slash for user
+        item[:valueFrom] = value
+      end
+      secrets
+    end
+
+    def normalize_to_arn(name, value)
+      case value
+      when /^ssm:/i
+        value.sub(/^ssm:/i, "arn:aws:ssm:#{region}:#{account}:parameter/")
+      when /^secretsmanager:/i
+        value.sub(/^secretsmanager:/i, "arn:aws:secretsmanager:#{region}:#{account}:secret:")
+      when '' # blank string will mean use convention
+        conventional_pattern(name, value)
+      else
+        value # assume full arn has been passed
+      end
+    end
+
+    # arn:aws:ssm:us-west-2:111111111111:parameter/demo/dev/DB-NAME
+    # arn:aws:ssm:us-west-2:111111111111:parameter/demo/dev/DB-NAME
+    def expansion(arn)
+      # performance improvement only run names.expansion on the name portion
+      md = arn.match(/(.*:)(parameter\/|secret:)(.*)/)
+      prefix, type, name = md[1], md[2], md[3]
+      expanded_name = names.expansion(name, dasherize: false) # dasherize: false. dont turn SECRET_NAME => SECRET-NAME
+      "#{prefix}#{type}#{expanded_name}"
+    end
+
+    # Examples with config.secrets.provider = "ssm"
+    #
+    # .secrets
+    #
+    #      DB_NAME
+    #
+    # Results
+    #
+    #      DB_NAME=:APP/:ENV/:SECRET_NAME # expansion will use => demo/dev/DB_NAME
+    #
+    def conventional_pattern(name, value)
+      secrets = Ufo.config.secrets
+      provider = secrets.provider # ssm or secretsmanager
+      namespace = provider == "ssm" ? "parameter/" : "secret:"
+
+      config_name = "secrets.pattern.#{provider}"
+      pattern = callable_option(
+        config_name: config_name, # Ufo.config.names.stack => :APP-:ROLE-:ENV => demo-web-dev
+        passed_args: [self],
+      )
+      # replace :SECRET_NAME since names expand doesnt know how to nor do we want to add logic there
+      pattern = pattern.sub(':SECRET_NAME', name)
+      "arn:aws:#{provider}:#{region}:#{account}:#{namespace}#{pattern}"
+    end
+
+    def remove_surrounding_quotes(s)
+      if s =~ /^"/ && s =~ /"$/
+        s.sub(/^["]/, '').gsub(/["]$/,'') # remove surrounding double quotes
+      elsif s =~ /^'/ && s =~ /'$/
+        s.sub(/^[']/, '').gsub(/[']$/,'') # remove surrounding single quotes
+      else
+        s
+      end
+    end
+
+    def filtered_lines(content)
+      lines = content.split("\n")
+      # remove comment at the end of the line
+      lines.map! { |l| l.sub(/\s+#.*/,'').strip }
+      # filter out commented lines
+      lines = lines.reject { |l| l =~ /(^|\s)#/i }
+      # filter out empty lines
+      lines = lines.reject { |l| l.strip.empty? }
+    end
+  end
+end

data/lib/ufo/task_definition/helpers/vars.rb

@@ -1,124 +1,21 @@
-require "aws_data"
-
 module Ufo::TaskDefinition::Helpers
-  class Vars
-    extend Memoist
-    include AwsHelper
-    include Ufo::Concerns::Names
-    include Ufo::Utils::Pretty
-    include Ufo::Config::CallableOption::Concern
-
-    def initialize(options={})
-      # use either file or text. text takes higher precedence
-      @file = options[:file]
-      @text = options[:text]
-    end
-
-    def content
-      @text || read(@file)
-    end
-
-    def read(path)
-      full_path = "#{Ufo.root}/#{path}"
-      unless File.exist?(full_path)
-        puts "The #{pretty_path(full_path)} env file could not be found.  Are you sure it exists?"
-        exit 1
-      end
-      IO.read(full_path)
-    end
-
-    def env
-      lines = filtered_lines(content)
-      lines.map do |line|
-        key,*value = line.strip.split("=").map do |x|
-          remove_surrounding_quotes(x.strip)
-        end
-        value = value.join('=')
-        {
-          name: key,
-          value: value,
-        }
-      end
+  module Vars
+    def env(text)
+      Builder.new(text: text).env
     end
+    alias_method :env_vars, :env
+    alias_method :environment, :env
 
-    def secrets
-      secrets = env
-      secrets.map do |item|
-        value = item.delete(:value)
-        arn = normalize_to_arn(item[:name], value)
-        value = expansion(arn)
-        value = value.sub('parameter//','parameter/') # auto fix accidental leading slash for user
-        item[:valueFrom] = value
-      end
-      secrets
-    end
-
-    def normalize_to_arn(name, value)
-      case value
-      when /^ssm:/i
-        value.sub(/^ssm:/i, "arn:aws:ssm:#{region}:#{account}:parameter/")
-      when /^secretsmanager:/i
-        value.sub(/^secretsmanager:/i, "arn:aws:secretsmanager:#{region}:#{account}:secret:")
-      when '' # blank string will mean use convention
-        conventional_pattern(name, value)
-      else
-        value # assume full arn has been passed
-      end
-    end
-
-    # arn:aws:ssm:us-west-2:111111111111:parameter/demo/dev/DB-NAME
-    # arn:aws:ssm:us-west-2:111111111111:parameter/demo/dev/DB-NAME
-    def expansion(arn)
-      # performance improvement only run names.expansion on the name portion
-      md = arn.match(/(.*:)(parameter\/|secret:)(.*)/)
-      prefix, type, name = md[1], md[2], md[3]
-      expanded_name = names.expansion(name, dasherize: false) # dasherize: false. dont turn SECRET_NAME => SECRET-NAME
-      "#{prefix}#{type}#{expanded_name}"
-    end
-
-    # Examples with config.secrets.provider = "ssm"
-    #
-    # .secrets
-    #
-    #      DB_NAME
-    #
-    # Results
-    #
-    #      DB_NAME=:APP/:ENV/:SECRET_NAME # expansion will use => demo/dev/DB_NAME
-    #
-    def conventional_pattern(name, value)
-      secrets = Ufo.config.secrets
-      provider = secrets.provider # ssm or secretsmanager
-      namespace = provider == "ssm" ? "parameter/" : "secret:"
-
-      config_name = "secrets.pattern.#{provider}"
-      pattern = callable_option(
-        config_name: config_name, # Ufo.config.names.stack => :APP-:ROLE-:ENV => demo-web-dev
-        passed_args: [self],
-      )
-      # replace :SECRET_NAME since names expand doesnt know how to nor do we want to add logic there
-      pattern = pattern.sub(':SECRET_NAME', name)
-      "arn:aws:#{provider}:#{region}:#{account}:#{namespace}#{pattern}"
+    def env_file(path)
+      Builder.new(file: path).env
     end
 
-    def remove_surrounding_quotes(s)
-      if s =~ /^"/ && s =~ /"$/
-        s.sub(/^["]/, '').gsub(/["]$/,'') # remove surrounding double quotes
-      elsif s =~ /^'/ && s =~ /'$/
-        s.sub(/^[']/, '').gsub(/[']$/,'') # remove surrounding single quotes
-      else
-        s
-      end
+    def secrets(text)
+      Builder.new(text: text).secrets
     end
 
-    def filtered_lines(content)
-      lines = content.split("\n")
-      # remove comment at the end of the line
-      lines.map! { |l| l.sub(/\s+#.*/,'').strip }
-      # filter out commented lines
-      lines = lines.reject { |l| l =~ /(^|\s)#/i }
-      # filter out empty lines
-      lines = lines.reject { |l| l.strip.empty? }
+    def secrets_file(path)
+      Builder.new(file: path).secrets
     end
   end
 end

data/lib/ufo/version.rb

@@ -1,3 +1,3 @@
 module Ufo
-  VERSION = "6.2.0"
+  VERSION = "6.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ufo
 version: !ruby/object:Gem::Version
-  version: 6.2.0
+  version: 6.2.1
 platform: ruby
 authors:
 - Tung Nguyen
@@ -629,14 +629,15 @@ files:
 - lib/ufo/task_definition/erb/yaml.rb
 - lib/ufo/task_definition/helpers.rb
 - lib/ufo/task_definition/helpers/acm.rb
-- lib/ufo/task_definition/helpers/aws_helper.rb
-- lib/ufo/task_definition/helpers/core.rb
+- lib/ufo/task_definition/helpers/docker.rb
 - lib/ufo/task_definition/helpers/ecr.rb
 - lib/ufo/task_definition/helpers/expansion.rb
 - lib/ufo/task_definition/helpers/ssm.rb
 - lib/ufo/task_definition/helpers/ssm/fetcher.rb
 - lib/ufo/task_definition/helpers/stack_output.rb
 - lib/ufo/task_definition/helpers/vars.rb
+- lib/ufo/task_definition/helpers/vars/aws_helper.rb
+- lib/ufo/task_definition/helpers/vars/builder.rb
 - lib/ufo/task_definition/helpers/vpc.rb
 - lib/ufo/task_definition/helpers/waf.rb
 - lib/ufo/upgrade/params.yml