lono 5.2.8 → 5.3.0

data/lib/lono/output_template.rb

@@ -0,0 +1,35 @@
+module Lono
+  class OutputTemplate
+    def initialize(blueprint, template)
+      @blueprint, @template = blueprint, template
+    end
+
+    def data
+      template_path = "#{Lono.config.output_path}/#{@blueprint}/templates/#{@template}.yml"
+      check_template_exists(template_path)
+      YAML.load(IO.read(template_path))
+    end
+
+    # Check if the template exists and print friendly error message.  Exits if it
+    # does not exist.
+    def check_template_exists(template_path)
+      unless File.exist?(template_path)
+        puts "The template #{template_path} does not exist. Are you sure you use the right template name?  The template name does not require the extension.".color(:red)
+        exit 1
+      end
+    end
+
+    def required_parameters
+      parameters.reject { |logical_id, p| p["Default"] }
+    end
+
+    def optional_parameters
+      parameters.select { |logical_id, p| p["Default"] }
+    end
+
+    def parameters
+      data["Parameters"] || []
+    end
+
+  end
+end

data/lib/lono/param/generator.rb

@@ -13,9 +13,9 @@ class Lono::Param
     def puts_param_message(type)
       path = send("#{type}_path")
       return unless path
-      if File.exist?(path)
+      if param_file?(path)
         pretty_path = path.sub("#{Lono.root}/",'')
-        puts "Using param: #{pretty_path}".color(:yellow)
+        puts "Using param for #{type}: #{pretty_path}".color(:yellow)
       end
     end
 
@@ -26,34 +26,63 @@ class Lono::Param
     #   configs/BLUEPRINT/params/development.txt
     #
     def lookup_param_file(root: Lono.root, env: Lono.env)
-      long_form = "#{root}/configs/#{@blueprint}/params/#{env}/#{@template}/#{@param}.txt"
-      medium_form = "#{root}/configs/#{@blueprint}/params/#{env}/#{@param}.txt"
-      short_form = "#{root}/configs/#{@blueprint}/params/#{env}.txt"
+      # The docs conver direct_absolute_form and direct_relative_form as the "Direct Form"
+      unless env == "base"
+        direct_absolute_form = @param # user provided the absolute full path
+        direct_relative_form = "#{root}/#{@param}" # user provided the full path within the lono project
+        direct_env_form = "#{root}/configs/#{@blueprint}/params/#{env}/#{@param}" # direct lookup is simple
+        direct_simple_form = "#{root}/configs/#{@blueprint}/params/#{@param}" # direct lookup is simple
+      end
+      long_form = "#{root}/configs/#{@blueprint}/params/#{env}/#{@template}/#{@param}"
+      medium_form = "#{root}/configs/#{@blueprint}/params/#{env}/#{@param}"
+      short_form = "#{root}/configs/#{@blueprint}/params/#{env}"
 
       if ENV['LONO_PARAM_DEBUG']
         puts "Lono.blueprint_root #{Lono.blueprint_root}"
+        puts "direct_absolute_form #{direct_absolute_form}"
+        puts "direct_relative_form #{direct_relative_form}"
+        puts "direct_env_form #{direct_env_form}"
+        puts "direct_simple_form #{direct_simple_form}"
         puts "long_form #{long_form}"
         puts "medium_form #{medium_form}"
         puts "short_form #{short_form}"
       end
 
-      return long_form if File.exist?(long_form) # always consider this first because its so explicit
+      unless env == "base"
+        return param_file(direct_absolute_form) if param_file?(direct_absolute_form)
+        return param_file(direct_relative_form) if param_file?(direct_relative_form)
+        return param_file(direct_env_form) if param_file?(direct_env_form) # consider this first its simple and direct but is scope to env so it's more specific
+        return param_file(direct_simple_form) if param_file?(direct_simple_form) # consider this first its simple and direct but is scope to env so it's more specific
+      end
+      return param_file(long_form) if param_file?(long_form) # consider this first because its more explicit
 
       # All 3 are the same
       # Also, blueprint and template the same and explicitly specified param
       if @blueprint == @template
-        return medium_form if File.exist?(medium_form) # higher precedence between longer but short form should be encouraged
-        return short_form if File.exist?(short_form)
+        return param_file(medium_form) if param_file?(medium_form) # higher precedence between longer but short form should be encouraged
+        return param_file(short_form) if param_file?(short_form)
         return # cannot find a param file
       end
 
       # Only template and param are the same
       if @template == @param
-        return medium_form if File.exist?(medium_form) # only consider medium form
+        return param_file(medium_form) if param_file?(medium_form) # only consider medium form
         return # cannot find a param file
       end
     end
 
+    # Allows user to specify the .txt extension or not to.
+    # Also allows user to use other extensions like .sh if they are explicit about it.
+    def param_file?(path)
+      File.file?(path) || File.file?("#{path}.txt") || File.file?("#{path}.sh")
+    end
+
+    def param_file(path)
+      return path if File.file?(path)
+      return "#{path}.txt" if File.file?("#{path}.txt")
+      return "#{path}.sh" if File.file?("#{path}.sh")
+    end
+
     def lookup_paths
       @base_path = lookup_param_file(env: "base")
       @env_path = lookup_param_file(env: Lono.env)

data/lib/lono/seed/base.rb

@@ -133,7 +133,9 @@ class Lono::Seed
 
     def default_value(data)
       value = data["Default"]
-      if value.blank?
+      # Dont use !blank? since there can be false optional values
+      # Also dont use .empty? since value can be an Integer
+      if value.nil? || value == ''
         description_example(data["Description"])
       else
         value
@@ -148,11 +150,11 @@ class Lono::Seed
     memoize :parameters
 
     def required(parameters)
-      parameters.reject { |logical_id, p| p["Default"] }
+      parameters.select { |logical_id, p| p["Default"].nil? } # allow for false
     end
 
     def optional(parameters)
-      parameters.select { |logical_id, p| p["Default"] }
+      parameters.select { |logical_id, p| !p["Default"].nil? } # allow for false
     end
 
   private

data/lib/lono/template/context.rb

@@ -1,8 +1,10 @@
 # Encapsulates helper methods and instance variables to be rendered in the ERB templates.
 class Lono::Template
   class Context
+    extend Memoist
     include Lono::Template::Helper
     include Loader
+    include Helpers
 
     def initialize(blueprint, options={})
       @blueprint, @options = blueprint, options

data/lib/lono/template/context/helpers.rb

@@ -0,0 +1,14 @@
+class Lono::Template::Context
+  module Helpers
+    extend Memoist
+
+    def ssm(name)
+      ssm_fetcher.get(name)
+    end
+
+    def ssm_fetcher
+      SsmFetcher.new
+    end
+    memoize :ssm_fetcher
+  end
+end

data/lib/lono/template/context/ssm_fetcher.rb

@@ -0,0 +1,23 @@
+require 'aws-sdk-ssm'
+
+class Lono::Template::Context
+  class SsmFetcher
+    extend Memoist
+
+    def get(name)
+      fetch_ssm_value(name)
+    end
+
+    def fetch_ssm_value(name)
+      resp = ssm.get_parameter(name: name, with_decryption: true)
+      resp.parameter.value
+    rescue Aws::SSM::Errors::ParameterNotFound
+      'SSM-PARAM-NOT-FOUND'
+    end
+
+    def ssm
+      Aws::SSM::Client.new
+    end
+    memoize :ssm
+  end
+end

data/lib/lono/template/dsl/builder/parameter.rb

@@ -16,10 +16,10 @@ class Lono::Template::Dsl::Builder
       elsif definition.size == 2 && second.is_a?(Hash) # medium form
         logical_id, properties = first, second
         { logical_id => properties }
-      elsif (definition.size == 2 && num_or_str?(second)) || # short form
+      elsif (definition.size == 2 && valid_value?(second)) || # short form
             definition.size == 1
         logical_id = first
-        properties = num_or_str?(second) ? { default: second } : {}
+        properties = valid_value?(second) ? { default: second } : {}
         { logical_id => properties }
       else # I dont know what form
         raise "Invalid form provided. definition #{definition.inspect}"
@@ -32,8 +32,8 @@ class Lono::Template::Dsl::Builder
       attributes
     end
 
-    def num_or_str?(o)
-      o.is_a?(Float) || o.is_a?(Integer) || o.is_a?(String)
+    def valid_value?(o)
+      o.is_a?(Float) || o.is_a?(Integer) || o.is_a?(String) || o.is_a?(TrueClass) || o.is_a?(FalseClass)
     end
   end
 end

data/lib/lono/template/dsl/builder/resource.rb

@@ -17,19 +17,24 @@ class Lono::Template::Dsl::Builder
         logical_id, attributes = first, second
         attributes.delete(:properties) if attributes[:properties].nil? || attributes[:properties].empty?
         { logical_id => attributes }
-      elsif definition.size == 2 && second.is_a?(String) # short form
+      elsif definition.size == 2 && second.is_a?(String) # short form with no properties
         logical_id, type = first, second
         { logical_id => {
             type: type
         }}
-      elsif definition.size == 3 && (second.is_a?(String) || second.is_a?(NilClass))# short form
+      elsif definition.size == 3 && (second.is_a?(String) || second.is_a?(NilClass)) # short form
         logical_id, type, properties = first, second, third
-        template = { logical_id => {
+        resource = { logical_id => {
                        type: type
                     }}
-        attributes = template.values.first
+
+        attributes = resource.values.first
+
+        property_mover = PropertyMover.new(resource, logical_id, properties)
+        property_mover.move!
+
         attributes[:properties] = properties unless properties.empty?
-        template
+        resource
       else # Dont understand this form
         raise "Invalid form provided. definition #{definition.inspect}"
       end

data/lib/lono/template/dsl/builder/resource/property_mover.rb

@@ -0,0 +1,19 @@
+class Lono::Template::Dsl::Builder::Resource
+  # Moves the property to the top-level attributes *destructively*
+  class PropertyMover
+    def initialize(resource, logical_id, properties)
+      @resource, @logical_id, @properties = resource, logical_id, properties
+    end
+
+    def move!
+      %w[depends_on condition].each do |attribute_name|
+        move(attribute_name.to_sym)
+      end
+    end
+
+    def move(attribute_name)
+      attribute_value = @properties.delete(attribute_name)
+      @resource[@logical_id][attribute_name] = attribute_value if attribute_value
+    end
+  end
+end

data/lib/lono/version.rb

@@ -1,3 +1,3 @@
 module Lono
-  VERSION = "5.2.8"
+  VERSION = "5.3.0"
 end

data/lono.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "aws-sdk-ec2" # lono seed
   gem.add_dependency "aws-sdk-iam" # lono seed
   gem.add_dependency "aws-sdk-s3"
+  gem.add_dependency "aws-sdk-ssm"
   gem.add_dependency "cfn_camelizer"
   gem.add_dependency "filesize"
   gem.add_dependency "graph" # lono xgraph command dependency

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lono
 version: !ruby/object:Gem::Version
-  version: 5.2.8
+  version: 5.3.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-10 00:00:00.000000000 Z
+date: 2019-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ssm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: cfn_camelizer
   requirement: !ruby/object:Gem::Requirement
@@ -453,9 +467,12 @@ files:
 - lib/lono/cfn/current.rb
 - lib/lono/cfn/delete.rb
 - lib/lono/cfn/deploy.rb
-- lib/lono/cfn/diff.rb
 - lib/lono/cfn/download.rb
 - lib/lono/cfn/preview.rb
+- lib/lono/cfn/preview/changeset.rb
+- lib/lono/cfn/preview/codediff.rb
+- lib/lono/cfn/preview/diff_viewer.rb
+- lib/lono/cfn/preview/param.rb
 - lib/lono/cfn/rollback.rb
 - lib/lono/cfn/status.rb
 - lib/lono/cfn/suffix.rb
@@ -481,7 +498,6 @@ files:
 - lib/lono/help/cfn/current.md
 - lib/lono/help/cfn/delete.md
 - lib/lono/help/cfn/deploy.md
-- lib/lono/help/cfn/diff.md
 - lib/lono/help/cfn/download.md
 - lib/lono/help/cfn/preview.md
 - lib/lono/help/cfn/status.md
@@ -509,6 +525,7 @@ files:
 - lib/lono/md5.rb
 - lib/lono/new.rb
 - lib/lono/new/helper.rb
+- lib/lono/output_template.rb
 - lib/lono/param.rb
 - lib/lono/param/generator.rb
 - lib/lono/project_checker.rb
@@ -527,7 +544,9 @@ files:
 - lib/lono/template/base.rb
 - lib/lono/template/bashify.rb
 - lib/lono/template/context.rb
+- lib/lono/template/context/helpers.rb
 - lib/lono/template/context/loader.rb
+- lib/lono/template/context/ssm_fetcher.rb
 - lib/lono/template/dsl.rb
 - lib/lono/template/dsl/builder.rb
 - lib/lono/template/dsl/builder/base.rb
@@ -538,6 +557,7 @@ files:
 - lib/lono/template/dsl/builder/output.rb
 - lib/lono/template/dsl/builder/parameter.rb
 - lib/lono/template/dsl/builder/resource.rb
+- lib/lono/template/dsl/builder/resource/property_mover.rb
 - lib/lono/template/dsl/builder/section.rb
 - lib/lono/template/dsl/builder/syntax.rb
 - lib/lono/template/erb.rb

data/lib/lono/help/cfn/diff.md

@@ -1,24 +0,0 @@
-Displays code diff of the generated CloudFormation template locally vs the existing template on AWS. You can set a desired diff viewer by setting the `LONO_DIFF` environment variable.
-
-## Examples
-
-    $ lono cfn diff ec2
-    Using template: output/templates/ec2.yml
-    Using parameters: config/params/development/ec2.txt
-    No detected app/scripts
-    Generating CloudFormation templates:
-      output/templates/ec2.yml
-      output/params/ec2.json
-    Generating CloudFormation source code diff...
-    Running: colordiff /tmp/existing_cfn_template.yml output/templates/ec2.yml
-    19c19
-    <     Default: t2.small
-    ---
-    >     Default: t2.medium
-    $
-
-Here's a screenshot of the output with the colored diff:
-
-<img src="/img/reference/lono-cfn-diff.png" alt="Stack Update" class="doc-photo">
-
-A `lono cfn diff` is perform automatically as part of `lono cfn update`.