lono 3.1.3 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9676395a3c8e7bca5d65e687de6b5b696cf6f592
-  data.tar.gz: c07ef7778f3fa56c64c0ac1245c7ca752ccdd436
+  metadata.gz: 6960654946363019c9b4f49f0dbd174939c09949
+  data.tar.gz: 170581eadc5099100aba6146a6ed51d14c89e01a
 SHA512:
-  metadata.gz: cbcd2b38a457165cd0bb324f85320233f14aa138cbf1903c0e7e653a8875ddfbb26cdfa5465e1e70f7cca597551436c4dc2cec3191e21e97ff1ffde0afb5e954
-  data.tar.gz: 5908edf59c81935a75f72b9426c0b3175810e1e1d3527d7e05a3ec6693344db19e534e7983accb6248f2bb60de5069c8e6ff5928e140b96ccd8c5dd0914b5a9d
+  metadata.gz: 9b06de16d5ce5912eedc70f5c821f578a4a01f1a794d0ffe8369a2c8b3d0df7840962ca635b5b3f3878996cd7f15945e183a861579a71a8b05f57a511c31dc8f
+  data.tar.gz: 675ec16efffaf96b22dd69034ba7a636314a45f22d530a818c11f0ca32cbfe1c91c9d5c70346a350d8cfa1c5fa048e967fd1c8d2fcce6e40ee49da35cc5d9adf

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.
 
+## [3.2.0]
+- lono inspect depends
+- lono inspect params
+
 ## [3.1.3]
 - fix randomize stack name option
 

data/lib/lono.rb

@@ -25,6 +25,7 @@ module Lono
   autoload :Clean, 'lono/clean'
   autoload :Settings, 'lono/settings'
   autoload :Importer, 'lono/importer'
+  autoload :Inspector, 'lono/inspector'
 end
 
 Lono::Env.setup!

data/lib/lono/cli.rb

@@ -19,6 +19,7 @@ module Lono
     option :format, type: :string, default: "yaml", desc: "format for the final template"
     option :project_root, default: ".", aliases: "-r", desc: "project root"
     option :casing, default: "underscore", desc: "camelcase or underscore the template name"
+    option :name, default: nil, desc: "final name of downloaded template without extension"
     def import(source)
       Importer.new(source, options).run
     end
@@ -56,5 +57,9 @@ module Lono
     desc "param ACTION", "param subcommand tasks"
     long_desc Help.param
     subcommand "param", Lono::Param
+
+    desc "inspect ACTION", "inspect subcommand tasks"
+    long_desc Help.inspector
+    subcommand "inspect", Inspector
   end
 end

data/lib/lono/help.rb

@@ -68,5 +68,15 @@ $ lono param generate
 EOL
   end
 
+  def inspector
+<<-EOL
+Examples:
+
+$ lono inspect params my-stack
+
+$ lono inspect depends my-stack
+EOL
+  end
+
   extend self
 end

data/lib/lono/importer.rb

@@ -12,10 +12,12 @@ class Lono::Importer
   end
 
   def run
-    download_template
-    template_definition_path = add_template_definition
-    puts "Imported raw CloudFormation template and lono-fied it!"
-    puts "Template definition added to #{template_definition_path}."
+    unless options[:noop]
+      download_template
+      template_definition_path = add_template_definition
+      puts "Imported raw CloudFormation template and lono-fied it!"
+      puts "Template definition added to #{template_definition_path}."
+    end
     puts "Template downloaded to #{dest_path}."
   end
 
@@ -51,6 +53,8 @@ class Lono::Importer
   end
 
   def template_name
+    return @options[:name] if @options[:name]
+    # else infer name from the original source
     name = File.basename(@source, ".*")
     @options[:casing] == "camelcase" ? name.camelize : name.underscore.dasherize
   end

data/lib/lono/inspector.rb

@@ -0,0 +1,26 @@
+require "thor"
+
+class Lono::Inspector < Lono::Command
+  autoload :Help, 'lono/inspector/help'
+  autoload :Base, 'lono/inspector/base'
+  autoload :Params, 'lono/inspector/params'
+  autoload :Depends, 'lono/inspector/depends'
+
+  class_option :verbose, type: :boolean
+  class_option :noop, type: :boolean
+  class_option :project_root, desc: "Project folder.  Defaults to current directory", default: "."
+
+  desc "params STACK", "Prints report of CloudFormation template parameters"
+  option :type, type: :string, desc: "type can be: all, required, optional", default: "all"
+  long_desc Help.params
+  def params(name)
+    Params.new(name, options).run
+  end
+
+  desc "depends STACK", "Prints dependencies tree of CloudFormation template resources"
+  long_desc Help.depends
+  option :display, type: :string, desc: "graph or text", default: "graph"
+  def depends(name)
+    Depends.new(name, options).run
+  end
+end

data/lib/lono/inspector/base.rb

@@ -0,0 +1,33 @@
+class Lono::Inspector::Base
+  def initialize(stack_name, options)
+    @stack_name = stack_name
+    @options = options
+    @project_root = options[:project_root] || '.'
+  end
+
+  def generate_templates
+    Lono::Template::DSL.new(@options.clone).run
+  end
+
+  def run
+    generate_templates
+    perform
+  end
+
+  def data
+    return @data if @data
+    template_path = "#{@project_root}/output/#{@stack_name}.yml"
+    check_template_exists(template_path)
+    @data = 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.".colorize(:red)
+      exit 1
+    end
+  end
+
+end

data/lib/lono/inspector/depends.rb

@@ -0,0 +1,120 @@
+require "yaml"
+require "graph"
+
+class Lono::Inspector::Depends < Lono::Inspector::Base
+  def initialize(stack_name, options)
+    super
+    @nodes = [] # lookup map
+  end
+
+  def perform
+    puts "Generating dependencies tree..."
+    return if @options[:noop]
+
+    # First loop through top level nodes and build set depends_on property
+    node_list = [] # top level node list
+    resources = data["Resources"]
+    resources.each do |logical_id, resource|
+      node = Node.new(logical_id)
+      node.depends_on = normalize_depends_on(resource)
+      node.resource_type = normalize_resource_type(resource)
+      node_list << node
+    end
+
+    # Now that we have loop through all the top level resources once
+    # we can use the depends_on attribute on each node and set the
+    # children property since the identity nodes are in memory.
+    node_list.each do |node|
+      node.children = normalize_children(node_list, node)
+    end
+
+    # At this point we have a tree of nodes.
+    if @options[:display] == "text"
+      puts "CloudFormation Dependencies:"
+      node_list.each { |node| print_tree(node) }
+    else
+      print_graph(node_list)
+      puts "CloudFormation Dependencies graph generated."
+    end
+  end
+
+  # normalized DependsOn attribute to an Array of Strings
+  def normalize_depends_on(resource)
+    dependencies = resource["DependsOn"] || []
+    [dependencies].flatten
+  end
+
+  def normalize_resource_type(resource)
+    type = resource["Type"]
+    type.sub("AWS::", "") # strip out AWS to make less verbose
+  end
+
+  # It is possible with bad CloudFormation templates that the dependency is not
+  # resolved, but we wont deal with that.  Users can validate their CloudFormation
+  # template before using this tool.
+  def normalize_children(node_list, node)
+    kids = []
+    node.depends_on.each do |dependent_logical_id|
+      node = node_list.find { |n| n.name == dependent_logical_id }
+      kids << node
+    end
+    kids
+  end
+
+  def print_tree(node, depth=0)
+    spacing = "  " * depth
+    puts "#{spacing}#{node.name}"
+    node.children.each do |node|
+      print_tree(node, depth+1)
+    end
+  end
+
+  def print_graph(node_list)
+    check_graphviz_installed
+    digraph do
+      # graph_attribs << 'size="6,6"'
+      node_attribs << lightblue << filled
+
+      node_list.each do |n|
+        node(n.graph_name)
+        n.children.each do |child|
+          edge n.graph_name, child.graph_name
+        end
+      end
+
+      random = (0...8).map { (65 + rand(26)).chr }.join
+      path = "/tmp/cloudformation-depends-on-#{random}"
+      save path, "png"
+      # Check if open command exists and use it to open the image.
+      system "open #{path}.png" if system("type open > /dev/null")
+    end
+  end
+
+  # Check if Graphiz is installed and prints a user friendly message if it is not installed.
+  # Provide instructions if on macosx.
+  def check_graphviz_installed
+    installed = system("type dot > /dev/null") # dot is a command that is part of the graphviz package
+    unless installed
+      puts "It appears that the Graphviz is not installed.  Please install it to generate the graph."
+      if RUBY_PLATFORM =~ /darwin/
+        puts "You can install Graphviz with homebrew:"
+        puts "  brew install brew install graphviz"
+      end
+      exit 1
+    end
+  end
+
+  class Node
+    attr_accessor :name, :resource_type, :children, :depends_on
+    def initialize(name)
+      @name = name
+      @children = []
+      @depends_on = []
+    end
+
+    def graph_name
+      type = "(#{resource_type})" if resource_type
+      [name, type].compact.join("\n")
+    end
+  end
+end

data/lib/lono/inspector/help.rb

@@ -0,0 +1,21 @@
+class Lono::Inspector::Help
+  class << self
+    def params
+<<-EOL
+Example:
+
+$ lono inspect params my-stack
+
+EOL
+    end
+
+    def depends
+<<-EOL
+Example:
+
+$ lono inspect depends my-stack
+
+EOL
+    end
+  end
+end

data/lib/lono/inspector/params.rb

@@ -0,0 +1,28 @@
+class Lono::Inspector::Params < Lono::Inspector::Base
+  def perform
+    puts "Parameters Summary:"
+    return if @options[:noop]
+
+    print_parameters("Required", required_parameters)
+    print_parameters("Optional", optional_parameters)
+  end
+
+  def print_parameters(label, parameters)
+    puts "#{label}:"
+    if parameters.empty?
+      puts "  There are no #{label.downcase} parameters"
+    else
+      parameters.each do |logical_id, p|
+        puts "  #{logical_id}"
+      end
+    end
+  end
+
+  def required_parameters
+    data["Parameters"].select { |logical_id, p| p["Default"] }
+  end
+
+  def optional_parameters
+    data["Parameters"].reject { |logical_id, p| p["Default"] }
+  end
+end

data/lib/lono/version.rb

@@ -1,3 +1,3 @@
 module Lono
-  VERSION = "3.1.3"
+  VERSION = "3.2.0"
 end

data/lib/starter_projects/json_project/.gitignore

@@ -0,0 +1 @@
+/output

data/lib/starter_projects/yaml_project/.gitignore

@@ -0,0 +1 @@
+/output

data/lono.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "hashie"
   gem.add_dependency "aws-sdk", '~> 3'
   gem.add_dependency "activesupport"
+  gem.add_dependency "graph" # lono inspect depends
   # gem.add_dependency "plissken" # dependency for vendor/lono-params
   # using the vendor fork version: https://github.com/tongueroo/plissken
   # until https://github.com/futurechimp/plissken/pull/6 gets merged

data/spec/fixtures/my_project/config/templates/base/stacks.rb

@@ -1,3 +1 @@
 # this file is just in here to get the lono-cfn spec to pass
-
-template "aws-waf-security-automations"

data/spec/lib/lono/inspect_spec.rb

@@ -0,0 +1,20 @@
+require_relative "../../spec_helper"
+
+describe Lono::Inspector do
+  before(:all) do
+    @args = "--noop --project-root spec/fixtures/my_project"
+  end
+
+  describe "lono inspect" do
+    it "depends" do
+      out = execute("bin/lono inspect depends my-stack #{@args}")
+      expect(out).to include("Generating dependencies tree")
+    end
+
+    it "params" do
+      out = execute("bin/lono inspect params my-stack #{@args}")
+      expect(out).to include("Parameters Summary")
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lono
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.2.0
 platform: ruby
 authors:
 - Tung Nguyen
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: graph
+  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: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -262,6 +276,11 @@ files:
 - lib/lono/env.rb
 - lib/lono/help.rb
 - lib/lono/importer.rb
+- lib/lono/inspector.rb
+- lib/lono/inspector/base.rb
+- lib/lono/inspector/depends.rb
+- lib/lono/inspector/help.rb
+- lib/lono/inspector/params.rb
 - lib/lono/new.rb
 - lib/lono/param.rb
 - lib/lono/param/generator.rb
@@ -277,6 +296,7 @@ files:
 - lib/lono/template/template.rb
 - lib/lono/template/upload.rb
 - lib/lono/version.rb
+- lib/starter_projects/json_project/.gitignore
 - lib/starter_projects/json_project/Gemfile
 - lib/starter_projects/json_project/Guardfile
 - lib/starter_projects/json_project/config/templates/base/blog.rb
@@ -290,6 +310,7 @@ files:
 - lib/starter_projects/json_project/templates/user_data/db2.sh
 - lib/starter_projects/json_project/templates/user_data/ruby_script.rb
 - lib/starter_projects/json_project/templates/web.json
+- lib/starter_projects/yaml_project/.gitignore
 - lib/starter_projects/yaml_project/Gemfile
 - lib/starter_projects/yaml_project/Guardfile
 - lib/starter_projects/yaml_project/config/templates/base/blog.rb
@@ -322,6 +343,7 @@ files:
 - spec/fixtures/params/overlay/params/prod/network.txt
 - spec/fixtures/raw_templates/aws-waf-security-automations.template
 - spec/lib/lono/cfn_spec.rb
+- spec/lib/lono/inspect_spec.rb
 - spec/lib/lono/new_spec.rb
 - spec/lib/lono/param/generator_spec.rb
 - spec/lib/lono/param_spec.rb
@@ -380,6 +402,7 @@ test_files:
 - spec/fixtures/params/overlay/params/prod/network.txt
 - spec/fixtures/raw_templates/aws-waf-security-automations.template
 - spec/lib/lono/cfn_spec.rb
+- spec/lib/lono/inspect_spec.rb
 - spec/lib/lono/new_spec.rb
 - spec/lib/lono/param/generator_spec.rb
 - spec/lib/lono/param_spec.rb