ufo 6.1.5 → 6.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5f634a56ad0e21b377ac92fb03f9b745a0f9e889e3a0b2b11f0f4b03c2a40b0
-  data.tar.gz: 3cbc84d12fd991d62f85f53792319b170fc033e77d7191fc666aa4c124b0d1f9
+  metadata.gz: e630cb6fc68958a6b7f7264e6b0ff03a2d41ae13d9a1648bd13fa601d9f9aae0
+  data.tar.gz: 2693b4ca4e3e5ffa31ff881f706de093792d93a4ff7263820308565d44685c38
 SHA512:
-  metadata.gz: fb24c7425643f9b9013f54309205c908eae46fcfbd66795d31d5067fba472280b8744b85a0d7ea9de9f684cd00ae4df6e7114c2ff051450d9d00e1ca36999945
-  data.tar.gz: 6c6cf2c3d47ff6edf45a327503b4590e9edbd38ce7cc2fc9d3b320bb4fb8d50240754fa6d6aa90e7e7e203af141de65b6140fdb98d0c4eeda031204545f558dd
+  metadata.gz: 116244ca9466e2458845904b34d99bc1fd2e7d1d8379c32066d2f90d70cfe7eb84628552a8250f7d4cca13dcdcf1cdad0ba812e602ba1df25c4f0b383131c057
+  data.tar.gz: 7e7aa81c1595f231465f1694a80dc7e4f0a8f7f7c77399e28b12b71c109a2c5ea0b9674fd0e8a9b485792253e16c4fd4a27734a121affd01bb69e163fb6e9f51

data/.cody/acceptance/bin/build.sh

@@ -22,7 +22,7 @@ REPO=$(aws ecr describe-repositories --repository-name test/demo | jq -r '.repos
 
 # DockerHub
 # toomanyrequests: You have reached your pull rate limit. You may increase the limit by authenticating
-docker login --username $DOCKER_USER --password $DOCKER_PASS
+echo "$DOCKER_PASS" | docker login --username $DOCKER_USER --password-stdin
 TOKEN=$(curl -s --user "$DOCKER_USER:$DOCKER_PASS" "https://auth.docker.io/token?service=registry.docker.io&scope=repository:ratelimitpreview/test:pull" | jq -r .token)
 echo "Current rate limit:"
 curl -s --head -H "Authorization: Bearer $TOKEN" https://registry-1.docker.io/v2/ratelimitpreview/test/manifests/latest

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,84 @@
+---
+name: Reproducible Bug Report
+about: Is something not working as expected?
+title: ''
+labels: 'bug'
+assignees: ''
+
+---
+
+<!--
+Hi! Thanks for considering to file a bug with UFO. Please take the time to
+answer the basic questions. Please try to be as detailed as possible.
+To be sensitive to everyone's time, if not enough details are provided, the
+issue may be closed without comment. If you repeatedly fail to provide enough
+details, you may be blocked from ever submitting issues to UFO again.
+Please use your best judgment. 👍
+
+If you are unsure this is a bug in UFO, please consider asking your question at:
+https://community.boltops.com
+
+Thanks!
+-->
+
+## Checklist
+
+<!--
+Make sure that you've done all of these.  To mark a checkbox done, replace [ ] with [x]. Or after you create the issue you can click the checkbox.
+-->
+
+- [ ] Upgrade UFO: Are you using the latest version of UFO? This allows UFO to fix issues fast. There's an Upgrading Guide: https://ufoships.com/docs/upgrading/
+- [ ] Reproducibility: Are you reporting a bug others will be able to reproduce and not asking a question. If you're unsure or want to ask a question, do so on https://community.boltops.com
+- [ ] Code sample: Have you put together a code sample to reproduce the issue and make it available?  Code samples help speed up fixes dramatically. If it's an easily reproducible issue, then code samples are not needed. If you're unsure, please include a code sample.
+
+## My Environment
+
+<!-- Please fill out the table below with debugging info to help: -->
+
+| Software         | Version |
+| ---------------- | ------- |
+| Operating System |         |
+| UFO              |         |
+| Ruby             |         |
+
+---
+
+## Expected Behaviour
+
+<!--
+What is it you expected to happen? This should be a description of how the functionality you tried to use is supposed to work. Try to keep this to one-paragraph.
+-->
+
+## Current Behavior
+
+<!--
+Describe the details of the bug.  Try to keep this to one-paragraph.
+-->
+
+## Step-by-step reproduction instructions
+
+<!--
+Be sure to include any steps you took for the problem to exist. This is likely the longest part of the report.
+
+Please include any logs you think relevant here. If the logs are long (more than 50 lines) please make a gist of the logs and link to it. https://gist.github.com
+
+With long logs, you can also use the <details> tag to keep the report readable. Example:
+
+<details>
+ <summary>Summary Goes Here</summary>
+
+ ...this is hidden, collapsable content. start with a blank line to get terminal output to format right...
+</details>
+-->
+
+## Code Sample
+
+<!--
+Please provide a code repository, gist, code snippet or sample files to reproduce the issue.
+-->
+
+## Solution Suggestion
+
+<!--
+Please provide possible solutions. If you can't think of anything, feel free to omit. Please be kind and add helpful possible solutions.  For example, "Fix it!" is not a helpful solution suggestion. We are mere mortals. Please be constructive.
+-->

data/.github/ISSUE_TEMPLATE/documentation.md

@@ -0,0 +1,12 @@
+---
+name: Documentation
+about: Found a typo or something that isn't crystal clear in the docs?
+title: ''
+labels: docs
+assignees: ''
+
+---
+
+The UFO Docs are in the [ufo-docs repo](https://github.com/boltops-tools/ufo-docs). Please submit a PR there. Thanks!
+
+For documentation changes to the ufo code base itself, like code comments. Please submit a PR here. Thanks!

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,64 @@
+---
+name: New Feature Suggestion
+about: Want to add a feature to UFO?
+title: ''
+labels: feature
+assignees: ''
+
+---
+
+<!--
+Hi! Thanks for considering to file a feature request with UFO. Please take the time to answer the basic questions. Please try to be as detailed as possible.
+
+Thanks!
+-->
+
+## Summary
+
+<!--
+A one-paragraph explanation of the feature.
+-->
+
+## Motivation
+
+<!--
+Why do you want to see this feature in UFO? What use cases does it support?
+
+How the feature would be relevant to 80% or more of UFO users.
+-->
+
+## Guide-level explanation
+
+<!--
+Explain the proposal as if it was already included in the project and you were teaching it to another programmer. That generally means:
+
+- Introducing new named concepts.
+- Explaining the feature largely in terms of examples.
+- If applicable, provide sample error messages, deprecation warnings, or upgrade guidance.
+
+If this is a small feature, you may omit this section.
+-->
+
+## Reference-level explanation
+
+<!--
+This is the technical portion of the feature request. Explain the design in sufficient detail that:
+
+- Its interaction with other features is clear.
+- It is reasonably clear how the feature would be implemented.
+- Corner cases are dissected by example.
+
+If you do not know how to answer this, you can omit it. No worries!
+-->
+
+## Drawbacks
+
+<!--
+Why should we *not* do this?
+-->
+
+## Unresolved Questions
+
+<!--
+What related issues do you consider out of scope for this feature that could be addressed in the future independently of the solution that comes out of this feature?
+-->

data/.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,14 @@
+---
+name: Question
+about: Have any questions about how UFO works?
+title: ''
+labels: 'question'
+assignees: ''
+
+---
+
+The UFO issue tracker IS NOT for usage questions! Please post your question on our dedicated forum at https://community.boltops.com
+
+To be sensitive to everyone's time, we may close issues asking questions without comment. If you repeatedly post questions in the issues tracker, you may be blocked from ever submitting issues to UFO again. Please use your best judgment. 👍
+
+Posting your questions in the UFO community forum benefits others by grouping questions in a dedicated place. Here are some additional options also https://ufoships.com/support/ 😁

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,7 @@
+Please fill out one of the templates on https://github.com/boltops-tools/ufo/issues/new/choose
+
+If you want to ask a question please do so in the UFO category in the BoltOps Community forum: https://community.boltops.com
+
+To be sensitive to everyone's time, we may close issues asking questions without comment. Posting your questions in the UFO community forum is the best place. It also benefits others by making the questions easier to find. Here are some additional options also https://ufoships.com/support/ 👌
+
+Thank you!

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,50 @@
+<!--
+Thanks for creating a Pull Request! Before you submit, please make sure you've done the following:
+
+- I read the contributing document at https://ufoships.com/docs/contributing/
+-->
+
+<!--
+Make our lives easier! Choose one of the following by uncommenting it:
+-->
+
+<!-- This is a 🐞 bug fix. -->
+<!-- This is a 🙋‍♂️ feature or enhancement. -->
+<!-- This is a 🧐 documentation change. -->
+
+<!--
+Before you submit this pull request, make sure to have a look at the following checklist. To mark a checkbox done, replace [ ] with [x]. Or after you create the issue you can click the checkbox.
+
+If you don't know how to do some of these, that's fine!  Submit your pull request and we will help you out on the way.
+-->
+
+- [ ] I've added tests (if it's a bug, feature or enhancement)
+- [ ] I've adjusted the documentation (if it's a feature or enhancement)
+- [ ] The test suite passes (run `bundle exec rspec` to verify this)
+
+## Summary
+
+<!--
+Provide a description of what your pull request changes.
+-->
+
+## Context
+
+<!--
+Is this related to any GitHub issue(s) or another relevant link?
+-->
+
+## How to Test
+
+<!--
+Please provide instructions on how to test the fix. This speeds up reviewing the PR. If testing requires a demo UFO project, please provide an example repo.
+-->
+
+
+## Version Changes
+
+<!--
+Which semantic version change would you recommend?
+If you don't know, feel free to omit it.
+-->
+

data/CHANGELOG.md

@@ -3,6 +3,17 @@
 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.2] - 2022-03-20
+- [#155](https://github.com/tongueroo/ufo/pull/155) layering.show option ability to show layers
+- [#156](https://github.com/tongueroo/ufo/pull/156) extra layering support
+
+## [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
+
 ## [6.1.5] - 2022-03-16
 - [#151](https://github.com/tongueroo/ufo/pull/151) fix symlink when .git ext is in the repo
 

data/lib/ufo/aws_services/concerns.rb

@@ -0,0 +1,55 @@
+require "cfn_status"
+
+module Ufo::AwsServices
+  module Concerns
+    extend Memoist
+
+    def find_stack(stack_name)
+      resp = cfn.describe_stacks(stack_name: stack_name)
+      resp.stacks.first
+    rescue Aws::CloudFormation::Errors::ValidationError => e
+      # example: Stack with id demo-web does not exist
+      if e.message =~ /Stack with/ && e.message =~ /does not exist/
+        nil
+      else
+        raise
+      end
+    end
+
+    def stack_resources(stack_name)
+      resp = cfn.describe_stack_resources(stack_name: stack_name)
+      resp.stack_resources
+    rescue Aws::CloudFormation::Errors::ValidationError => e
+      e.message.include?("does not exist") ? return : raise
+    end
+
+    def task_definition_arns(family, max_items=10)
+      resp = ecs.list_task_definitions(
+        family_prefix: family,
+        sort: "DESC",
+      )
+      arns = resp.task_definition_arns
+      arns = arns.select do |arn|
+        task_definition = arn.split('/').last.split(':').first
+        task_definition == family
+      end
+      arns[0..max_items]
+    end
+
+    def status
+      CfnStatus.new(@stack_name) # NOTE: @stack_name must be set in the including Class
+    end
+    memoize :status
+
+    def find_stack_resources(stack_name)
+      resp = cfn.describe_stack_resources(stack_name: stack_name)
+      resp.stack_resources
+    rescue Aws::CloudFormation::Errors::ValidationError => e
+      if e.message.include?("does not exist")
+        nil
+      else
+        raise
+      end
+    end
+  end
+end

data/lib/ufo/aws_services.rb

@@ -6,15 +6,16 @@ require "aws-sdk-ec2"
 require "aws-sdk-ecr"
 require "aws-sdk-ecs"
 require "aws-sdk-elasticloadbalancingv2"
+require "aws-sdk-s3"
 require "aws-sdk-ssm"
 require "aws-sdk-wafv2"
 
 require "aws_mfa_secure/ext/aws" # add MFA support
-require "cfn_status"
 
 module Ufo
   module AwsServices
     extend Memoist
+    include Concerns
 
     def acm
       Aws::ACM::Client.new(aws_options)
@@ -26,10 +27,10 @@ module Ufo
     end
     memoize :applicationautoscaling
 
-    def cloudformation
+    def cfn
       Aws::CloudFormation::Client.new(aws_options)
     end
-    memoize :cloudformation
+    memoize :cfn
 
     def cloudwatchlogs
       Aws::CloudWatchLogs::Client.new(aws_options)
@@ -56,6 +57,11 @@ module Ufo
     end
     memoize :elb
 
+    def s3
+      Aws::S3::Client.new(aws_options)
+    end
+    memoize :s3
+
     # ssm is a helper method
     def ssm_client
       Aws::SSM::Client.new(aws_options)
@@ -98,42 +104,5 @@ module Ufo
       ) if ENV['UFO_DEBUG_AWS_SDK']
       options
     end
-
-    def find_stack(stack_name)
-      resp = cloudformation.describe_stacks(stack_name: stack_name)
-      resp.stacks.first
-    rescue Aws::CloudFormation::Errors::ValidationError => e
-      # example: Stack with id demo-web does not exist
-      if e.message =~ /Stack with/ && e.message =~ /does not exist/
-        nil
-      else
-        raise
-      end
-    end
-
-    def stack_resources(stack_name)
-      resp = cloudformation.describe_stack_resources(stack_name: stack_name)
-      resp.stack_resources
-    rescue Aws::CloudFormation::Errors::ValidationError => e
-      e.message.include?("does not exist") ? return : raise
-    end
-
-    def task_definition_arns(family, max_items=10)
-      resp = ecs.list_task_definitions(
-        family_prefix: family,
-        sort: "DESC",
-      )
-      arns = resp.task_definition_arns
-      arns = arns.select do |arn|
-        task_definition = arn.split('/').last.split(':').first
-        task_definition == family
-      end
-      arns[0..max_items]
-    end
-
-    def status
-      CfnStatus.new(@stack_name) # NOTE: @stack_name must be set in the including Class
-    end
-    memoize :status
   end
 end

data/lib/ufo/cfn/stack/builder.rb

@@ -9,6 +9,7 @@ class Ufo::Cfn::Stack
     end
 
     def build
+      logger.info "Building template"
       @template[:Parameters] = Parameters.build(@options)
       @template[:Conditions] = Conditions.build(@options)
       @template[:Resources] = Resources.build(@options)
@@ -23,7 +24,7 @@ class Ufo::Cfn::Stack
       text = YAML.dump(template)
       path = ".ufo/output/template.yml"
       IO.write("#{Ufo.root}/#{path}", text)
-      logger.info "Template built:        #{path}"
+      logger.info "    #{path}"
       # Only basic YAML validation. Doesnt check for everything CloudFormation checks.
       # For CloudFormation checks handled with an exception handler in Cfn::Stack#print_code(exception)
       Ufo::Yaml.validate!(path)

data/lib/ufo/cfn/stack/params.rb

@@ -1,6 +1,7 @@
 class Ufo::Cfn::Stack
   class Params < Ufo::Cfn::Stack::Builder::Base
     def build
+      logger.info "Building params"
       params = {
         Vpc: vpc.id,
         ElbSubnets: vpc.elb_subnets,
@@ -40,7 +41,7 @@ class Ufo::Cfn::Stack
       path = "#{Ufo.root}/.ufo/output/params.json"
       FileUtils.mkdir_p(File.dirname(path))
       IO.write(path, JSON.pretty_generate(params))
-      logger.info "Parameters built:      #{pretty_path(path)}"
+      logger.info "    #{pretty_path(path)}"
     end
 
     def vpc

data/lib/ufo/cfn/stack/status.rb

@@ -122,7 +122,7 @@ class Ufo::Cfn::Stack
 
     # refreshes the loaded events in memory
     def refresh_events
-      resp = cloudformation.describe_stack_events(stack_name: @stack_name)
+      resp = cfn.describe_stack_events(stack_name: @stack_name)
       @events = resp["stack_events"]
     rescue Aws::CloudFormation::Errors::ValidationError => e
       if e.message =~ /Stack .* does not exis/

data/lib/ufo/cfn/stack.rb

@@ -31,7 +31,7 @@ module Ufo::Cfn
       @stack = find_stack(@stack_name)
       if @stack && rollback_complete?(@stack)
         logger.info "Existing stack in ROLLBACK_COMPLETE state. Deleting stack before continuing."
-        cloudformation.delete_stack(stack_name: @stack_name)
+        cfn.delete_stack(stack_name: @stack_name)
         status.wait
         status.reset
         @stack = nil # at this point stack has been deleted
@@ -53,7 +53,7 @@ module Ufo::Cfn
 
     def perform(action)
       logger.info "#{action[0..-2].capitalize}ing stack #{@stack_name.color(:green)}"
-      cloudformation.send("#{action}_stack", stack_options) # Example: cloudformation.send("update_stack", stack_options)
+      cfn.send("#{action}_stack", stack_options) # Example: cfn.send("update_stack", stack_options)
     rescue Aws::CloudFormation::Errors::ValidationError => e
       handle_stack_error(e)
     end
@@ -152,10 +152,10 @@ module Ufo::Cfn
       end
 
       if stack.stack_status == "CREATE_IN_PROGRESS"
-        cloudformation.delete_stack(stack_name: @stack_name)
+        cfn.delete_stack(stack_name: @stack_name)
         logger.info "Canceling stack creation"
       elsif stack.stack_status == "UPDATE_IN_PROGRESS"
-        cloudformation.cancel_update_stack(stack_name: @stack_name)
+        cfn.cancel_update_stack(stack_name: @stack_name)
         logger.info "Canceling stack update"
       else
         logger.info "The stack is not in a state to that is cancelable: #{stack.stack_status}"

data/lib/ufo/cli/destroy.rb

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

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/command.rb

@@ -39,7 +39,7 @@ module Ufo
         # This requires Ufo.role.
         # So we set Ufo.role before triggering Ufo.config loading
         check_project!(args)
-        check_old_version_structure!(args)
+        check_version_structure!
         # Special case for `ufo central` commands.
         # Dont want to call configure_dsl_evaluator
         # and trigger loading of config => .ufo/config.rb
@@ -99,23 +99,33 @@ module Ufo
         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 non_project_command?
         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
 
-      def check_old_version_structure!(args)
-        return unless File.exist?('.ufo/settings.yml')
-        puts "ERROR: Old .ufo configurations detected".color(:red)
+      # Also, using ARGV instead of args because args is called by thor in multiple passes
+      # For `ufo central update`:
+      # * 1st pass: "central"
+      # * 2nd pass: "update"
+      def non_project_command?
+        commands = %w[-h -v --version completion completion_script help central init version]
+        commands.include?(ARGV[0])
+      end
+
+      def check_version_structure!
+        return if non_project_command?
+        return if File.exist?('.ufo/config.rb')
+        puts "ERROR: Latest ufo structure not detected".color(:red)
         puts <<~EOL
           It looks like this project .ufo files for an older ufo version.
           The old .ufo structure does not work with this version of ufo.
 
-          Current Installed UFO Version: 6.0.9
+          Current Installed UFO Version: #{Ufo::VERSION}
 
-          Please upgrade.
+          Please update the .ufo structure.
 
           See: https://ufoships.com/docs/upgrading/upgrade6/
         EOL