ufo 6.2.1 → 6.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19359c25a4a47a3a997d9a2ad481b2dcb7a1b134474cb8c1acb83b8b2a370815
-  data.tar.gz: e6f4b287dfa7c1a46a9aaac910718ea39e5d4b6170d937a513ecc967ef21bffd
+  metadata.gz: e630cb6fc68958a6b7f7264e6b0ff03a2d41ae13d9a1648bd13fa601d9f9aae0
+  data.tar.gz: 2693b4ca4e3e5ffa31ff881f706de093792d93a4ff7263820308565d44685c38
 SHA512:
-  metadata.gz: c718937b596ec38c56d997d6e03e6320ca2b556c595fdb0a430b883ad36c0ae96d3f9c6226d912c957b0168d8d820ea753e9ce0ee0f80e702bad3dea106ea893
-  data.tar.gz: f22ffd461ba1992baf9d6f07c9315ff4ed231386663a3fdee77a876effc36ae37120ebc4a9651cf467df104a23409bb86994c947f73c55687a55a39254208808
+  metadata.gz: 116244ca9466e2458845904b34d99bc1fd2e7d1d8379c32066d2f90d70cfe7eb84628552a8250f7d4cca13dcdcf1cdad0ba812e602ba1df25c4f0b383131c057
+  data.tar.gz: 7e7aa81c1595f231465f1694a80dc7e4f0a8f7f7c77399e28b12b71c109a2c5ea0b9674fd0e8a9b485792253e16c4fd4a27734a121affd01bb69e163fb6e9f51

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,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.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

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/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

data/lib/ufo/config.rb

@@ -85,6 +85,9 @@ module Ufo
       config.exec.command = "/bin/bash" # aws ecs execute-command cli
       config.exec.enabled = true        # EcsService EnableExecuteCommand
 
+      config.layering = ActiveSupport::OrderedOptions.new
+      config.layering.show = show_layers?
+
       config.log = ActiveSupport::OrderedOptions.new
       config.log.root = Ufo.log_root
       config.logger = ufo_logger
@@ -160,15 +163,52 @@ module Ufo
         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']
+      # load_project_config gets called so early that logger is not yet configured.
+      # Cannot use Ufo.config yet and cannot use logger which relies on Ufo.config
+      # Use puts and use show_layers? which parses for the config
+      show = show_layers?
+      puts "Config Layers" if show
       layers.each do |layer|
         path = "#{Ufo.root}/#{layer}"
-        puts "    #{layer}" if ENV['UFO_SHOW_ALL_LAYERS']
+        if ENV['UFO_LAYERS_ALL']
+          puts "    #{pretty_path(path)}"
+        elsif show
+          puts "    #{pretty_path(path)}" if File.exist?(path)
+        end
         evaluate_file(path)
       end
     end
 
+    def show_layers?
+      ENV['UFO_LAYERS'] || parse_for_layering_show
+    end
+    private :show_layers?
+
+    # Some limitations:
+    #
+    # * Only parsing one file: .ufo/config.rb
+    # * If user is using Ruby code that cannot be parse will fallback to default
+    #
+    # Think it's worth it so user only has to configure
+    #
+    #     config.layering.show = true
+    #
+    def parse_for_layering_show
+      lines = IO.readlines("#{Ufo.root}/.ufo/config.rb")
+      config_line = lines.find { |l| l =~ /config\.layering.show.*=/ && l !~ /^\s+#/ }
+      return false unless config_line # default is false
+      config_value = config_line.gsub(/.*=/,'').strip.gsub(/["']/,'')
+      config_value != "false" && config_value != "nil"
+    rescue Exception => e
+      if ENV['UFO_DEBUG']
+        puts "#{e.class} #{e.message}".color(:yellow)
+        puts "WARN: Unable to parse for config.layering.show".color(:yellow)
+        puts "Using default: config.layering.show = false"
+      end
+      false
+    end
+    memoize :parse_for_layering_show
+
     # Works similiar to Layering::Layer. Consider combining the logic and usin Layering::Layer
     #
     # Examples:
@@ -183,6 +223,7 @@ module Ufo
     #
     def layer_levels(prefix=nil)
       levels = ["", "base", Ufo.env]
+      levels << "#{Ufo.env}-#{Ufo.extra}" if Ufo.extra
       paths = levels.map do |i|
         # base layer has prefix of '', reject with blank so it doesnt produce '//'
         [prefix, i].join('/')

data/lib/ufo/layering/layer.rb

@@ -23,46 +23,44 @@ module Ufo::Layering
     end
 
     def paths
-      core = full_layers(".ufo/vars")
-      app = full_layers(".ufo/vars/#{Ufo.app}")
-      paths = core + app
+      # core = full_layers(".ufo/vars")
+      # app = full_layers(".ufo/vars/#{Ufo.app}")
+
+      core =     layer_levels(".ufo/vars")
+      role =     layer_levels(".ufo/vars/#{@task_definition.role}")
+      app =      layer_levels(".ufo/vars/#{Ufo.app}")
+      app_role = layer_levels(".ufo/vars/#{Ufo.app}/#{@task_definition.role}")
+
+      paths = core + role + app + app_role
       add_ext!(paths)
       paths.map! { |p| "#{Ufo.root}/#{p}" }
       show_layers(paths)
       paths
     end
 
-    def full_layering
-      # layers defined in Lono::Layering module
-      all = layers.map { |layer| layer.sub(/\/$/,'') } # strip trailing slash
-      all.inject([]) do |sum, layer|
-        sum += layer_levels(layer) unless layer.nil?
-        sum
-      end
-    end
-
-    # interface method
-    def main_layers
-      ['']
-    end
-
     # adds prefix and to each layer pair that has base and Ufo.env. IE:
     #
     #    "#{prefix}/base"
     #    "#{prefix}/#{Ufo.env}"
     #
     def layer_levels(prefix=nil)
-      levels = ["base", Ufo.env]
+      levels = ["", "base", Ufo.env]
+      levels << "#{Ufo.env}-#{Ufo.extra}" if Ufo.extra
       levels.map! do |i|
         # base layer has prefix of '', reject with blank so it doesnt produce '//'
         [prefix, i].reject(&:blank?).join('/')
       end
-      levels.unshift(prefix) # unless prefix.blank? # IE: params/us-west-2.txt
+      levels.map! { |level| level.sub(/\/$/,'') } # strip trailing slash
+      # levels.unshift(prefix) # unless prefix.blank? # IE: params/us-west-2.txt
       levels
     end
 
+    # interface method
+    def main_layers
+      ['']
+    end
+
     def add_ext!(paths)
-      ext = "rb"
       paths.map! do |path|
         path = path.sub(/\/$/,'') if path.ends_with?('/')
         "#{path}.rb"
@@ -70,26 +68,18 @@ module Ufo::Layering
       paths
     end
 
-    def full_layers(dir)
-      layers = full_layering.map do |layer|
-        "#{dir}/#{layer}"
-      end
-      role_layers = full_layering.map do |layer|
-        "#{dir}/#{@task_definition.role}/#{layer}" # Note: layer can be '' will clean up
-      end
-      layers += role_layers
-      layers.map { |l| l.gsub('//','/') } # cleanup // if layer is ''
-    end
-
-    @@shown_layers = false
+    @@shown = false
     def show_layers(paths)
-      return if @@shown_layers
-      logger.info "Vars Layers:" if ENV['UFO_SHOW_ALL_LAYERS']
+      return if @@shown
+      logger.debug "Layers:"
       paths.each do |path|
-        show_layer = File.exist?(path) && logger.level <= Logger::DEBUG
-        logger.info "    #{pretty_path(path)}" if show_layer || ENV['UFO_SHOW_ALL_LAYERS']
+        if ENV['UFO_LAYERS_ALL']
+          logger.info "    #{pretty_path(path)}"
+        elsif Ufo.config.layering.show
+          logger.info "    #{pretty_path(path)}" if File.exist?(path)
+        end
       end
-      @@shown_layers = true
+      @@shown = true
     end
   end
 end

data/lib/ufo/task_definition/erb.rb

@@ -10,14 +10,14 @@ class Ufo::TaskDefinition
     alias_method :family, :name
 
     def run
-      logger.debug "Building Task Definition"
+      logger.info "Building Task Definition"
       clean
       load_context
       data = evaluate_code
       check_empty!(data)
       data = squeeze(data)
       write(data)
-      logger.info "Task Definition built: #{output_path}"
+      logger.info "    #{output_path}"
     end
 
     def check_empty!(data)

data/lib/ufo/upgrade/upgrade4.rb

@@ -24,7 +24,6 @@ class Ufo::Upgrade
       upsert_dockerignore
       upsert_gitignore
       update_params_yaml
-      update_task_definitions
       new_files
     end
 
@@ -34,14 +33,6 @@ class Ufo::Upgrade
     end
 
   private
-    def update_task_definitions
-      text = <<-EOL
-    # HINT: shows how Ufo.extra can to create different log groups
-    # awslogs_group: ["ecs/TASK_DEFINITION_NAME", Ufo.extra].compact.join('-'),
-EOL
-      insert_into_file ".ufo/task_definitions.rb", text, :before => /    awslogs_group:/
-    end
-
     def new_files
       configure_network_settings
       template(".ufo/settings/network/default.yml")

data/lib/ufo/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ufo
 version: !ruby/object:Gem::Version
-  version: 6.2.1
+  version: 6.2.2
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-16 00:00:00.000000000 Z
+date: 2022-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-logs
@@ -459,6 +459,12 @@ files:
 - ".cody/acceptance/role.rb"
 - ".cody/shared/script/install.sh"
 - ".cody/shared/script/install/ufo.sh"
+- ".github/ISSUE_TEMPLATE.md"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/documentation.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/ISSUE_TEMPLATE/question.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"