lono 5.3.4 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae375abbd7489be7dc9cd29b79b006ab1e35f10814ee119a14a0b099f27d42a7
-  data.tar.gz: 077c285ab9b7a282dca83e857bef4cb3930fb76859aa6cb2f9763c3444f33ee0
+  metadata.gz: 277fec8b235735156d549bc309cebad6c7277eaf102ef4ac7d242d0af610c54a
+  data.tar.gz: 80239ae154cbd2de9ad4730fbcdccbc2b746654db65935f84ed1293a776c76be
 SHA512:
-  metadata.gz: 82a5a341de1ef8bfd76e0af97dad1f11d8c45cdf0fcabec29b53594efc9867b5e591f8bbc5a2c97528159619ab1b40e21e5d280be2e0ab44db6822ba2ef0c740
-  data.tar.gz: 68b0d96d00f7ccb6d11892ca6563f96b818d137a2e3f607fc43f814221425640c64ed5783be2d46d9a825a688f98533f4baa784b7c0fd8c7ae3d810a4d7e1524
+  metadata.gz: 937af6ff08ea6e36ad6cb785f50665f3e50d9c45b90fcaa2dd4e09771824791cd7ea7cb9b1816dfaff6bd7a188824a9d4d30fbac93ccdafc508f79b17d9c2b8e
+  data.tar.gz: 16b40f4b8ddae0d6de37992ab7f8f673622d6a3097bec434db90cec0951386be2f96ddb6bd41d22758a5b3fef44d3bc8ee84672fe4623f97db53bef9e82302e0

data/.cody/demo.rb

@@ -2,25 +2,25 @@
 aws_template_format_version "2010-09-09"
 description "Demo stack"
 
-parameter(:instance_type, "t3.micro")
+parameter("InstanceType", "t3.micro")
 
-mapping(:ami_map,
-  "ap-northeast-1": { ami: "ami-0f9ae750e8274075b" },
-  "ap-northeast-2": { ami: "ami-047f7b46bd6dd5d84" },
-  "ap-south-1":     { ami: "ami-0889b8a448de4fc44" },
-  "ap-southeast-1": { ami: "ami-0b419c3a4b01d1859" },
-  "ap-southeast-2": { ami: "ami-04481c741a0311bbb" },
-  "ca-central-1":   { ami: "ami-03338e1f67dae0168" },
-  "eu-central-1":   { ami: "ami-09def150731bdbcc2" },
-  "eu-north-1":     { ami: "ami-d16fe6af" },
-  "eu-west-1":      { ami: "ami-07683a44e80cd32c5" },
-  "eu-west-2":      { ami: "ami-09ead922c1dad67e4" },
-  "eu-west-3":      { ami: "ami-0451ae4fd8dd178f7" },
-  "sa-east-1":      { ami: "ami-0669a96e355eac82f" },
-  "us-east-1":      { ami: "ami-0de53d8956e8dcf80" },
-  "us-east-2":      { ami: "ami-02bcbb802e03574ba" },
-  "us-west-1":      { ami: "ami-0019ef04ac50be30f" },
-  "us-west-2":      { ami: "ami-061392db613a6357b" }
+mapping("AmiMap",
+  "ap-northeast-1": { Ami: "ami-0f9ae750e8274075b" },
+  "ap-northeast-2": { Ami: "ami-047f7b46bd6dd5d84" },
+  "ap-south-1":     { Ami: "ami-0889b8a448de4fc44" },
+  "ap-southeast-1": { Ami: "ami-0b419c3a4b01d1859" },
+  "ap-southeast-2": { Ami: "ami-04481c741a0311bbb" },
+  "ca-central-1":   { Ami: "ami-03338e1f67dae0168" },
+  "eu-central-1":   { Ami: "ami-09def150731bdbcc2" },
+  "eu-north-1":     { Ami: "ami-d16fe6af" },
+  "eu-west-1":      { Ami: "ami-07683a44e80cd32c5" },
+  "eu-west-2":      { Ami: "ami-09ead922c1dad67e4" },
+  "eu-west-3":      { Ami: "ami-0451ae4fd8dd178f7" },
+  "sa-east-1":      { Ami: "ami-0669a96e355eac82f" },
+  "us-east-1":      { Ami: "ami-0de53d8956e8dcf80" },
+  "us-east-2":      { Ami: "ami-02bcbb802e03574ba" },
+  "us-west-1":      { Ami: "ami-0019ef04ac50be30f" },
+  "us-west-2":      { Ami: "ami-061392db613a6357b" }
 )
 
 # Comment out instance to save costs
@@ -30,9 +30,9 @@ mapping(:ami_map,
 #   security_group_ids: [get_att("security_group.group_id")],
 #   user_data: base64(user_data("bootstrap.sh"))
 # )
-resource(:security_group, "AWS::EC2::SecurityGroup",
-  group_description: "demo security group",
+resource("SecurityGroup", "AWS::EC2::SecurityGroup",
+  GroupDescription: "demo security group",
 )
 
 # output(:instance)
-output(:security_group, get_att("security_group.group_id"))
+output("SecurityGroup", get_att("SecurityGroup.GroupId"))

data/CHANGELOG.md

@@ -3,6 +3,20 @@
 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.0.0]
+- #13 DSL improvements: auto camelize off by default
+- `auto_camelize: off` as new default for blueprints.
+- Old blueprints will continue to auto_camelize unless the `.meta/config.yml` is updated to `auto_camelize: off`
+- Upgrade vendor/cfn_status
+- Update docs to encourage CamelCase for attributes and properties
+- Add and encourage shorthand bang intrinsic methods: `if!`, `not!`, `and!`, `or!`
+- Fix iam permission error for `lono cfn preview` command
+- Update cli help
+- Improve `lono summary` output
+- Introduced experimental helpers: `conditional_parameter` and `optional_ref`. Note that their interfaces may change
+- Treat common attributes `DependsOn` and `Condition` at the property level specially and move them to the attribute level automatically. Allows for cleaner resource definitions.
+- update blueprint starter skeleton
+
 ## [5.3.4]
 - fix param preview for noecho values that are set
 

data/lib/lono.rb

@@ -14,7 +14,7 @@ require 'cfn_camelizer'
 gem_root = File.dirname(__dir__)
 $:.unshift("#{gem_root}/lib")
 $:.unshift("#{gem_root}/vendor/cfn-status/lib")
-require "cfn/status"
+require "cfn_status"
 
 require "lono/autoloader"
 Lono::Autoloader.setup

data/lib/lono/blueprint/meta.rb

@@ -0,0 +1,38 @@
+require "yaml"
+
+class Lono::Blueprint
+  class Meta
+    extend Memoist
+
+    def initialize(blueprint)
+      @blueprint = blueprint
+    end
+
+    def data
+      blueprint_location = Find.find(@blueprint)
+      meta_config = "#{blueprint_location}/.meta/config.yml"
+      YAML.load_file(meta_config)
+    end
+    memoize :data
+
+    %w[blueprint_name template_type].each do |meth|
+      define_method meth do
+        data[meth]
+      end
+    end
+
+    def auto_camelize?(target_section)
+      auto_camelize = data['auto_camelize']
+      # auto_camelize.nil? for backward compatibility
+      return true if auto_camelize.nil? || auto_camelize == true
+
+      if auto_camelize == "except_resource"
+        return target_section != "resource"
+      end
+
+      if auto_camelize.is_a?(Array)
+        auto_camelize.include?(target_section)
+      end
+    end
+  end
+end

data/lib/lono/cfn/base.rb

@@ -38,16 +38,8 @@ class Lono::Cfn
       begin
         save_stack(params) # defined in the sub class
       rescue Aws::CloudFormation::Errors::InsufficientCapabilitiesException => e
-        capabilities = e.message.match(/\[(.*)\]/)[1]
-        confirm = prompt_for_iam(capabilities)
-        if confirm =~ /^y/
-          @options.merge!(capabilities: [capabilities])
-          puts "Re-running: #{command_with_iam(capabilities).color(:green)}"
-          retry
-        else
-          puts "Exited"
-          exit
-        end
+        yes = rerun_with_iam?(e)
+        retry if yes
       rescue Aws::CloudFormation::Errors::ValidationError => e
         if e.message.include?("No updates") # No updates are to be performed.
           puts "WARN: #{e.message}".color(:yellow)
@@ -102,14 +94,29 @@ class Lono::Cfn
     end
 
     def status
-      @status ||= Cfn::Status.new(@stack_name)
+      @status ||= Status.new(@stack_name)
+    end
+
+    def rerun_with_iam?(e)
+      # e.message is "Requires capabilities : [CAPABILITY_IAM]"
+      # grab CAPABILITY_IAM with regexp
+      capabilities = e.message.match(/\[(.*)\]/)[1]
+      confirm = prompt_for_iam(capabilities)
+      if confirm =~ /^y/
+        @options.merge!(capabilities: [capabilities])
+        puts "Re-running: #{command_with_iam(capabilities).color(:green)}"
+        true
+      else
+        puts "Exited"
+        exit 1
+      end
     end
 
     def prompt_for_iam(capabilities)
       puts "This stack will create IAM resources.  Please approve to run the command again with #{capabilities} capabilities."
       puts "  #{command_with_iam(capabilities)}"
 
-      puts "Please confirm (y/n)"
+      puts "Please confirm (y/N)"
       $stdin.gets
     end
 

data/lib/lono/cfn/delete.rb

@@ -9,7 +9,7 @@ class Lono::Cfn
     end
 
     def run
-      message = "Deleted #{@stack_name} stack."
+      message = "Deleting #{@stack_name} stack."
       if @options[:noop]
         puts "NOOP #{message}"
       else
@@ -20,6 +20,7 @@ class Lono::Cfn
           puts message
         else
           puts "#{@stack_name.inspect} stack does not exist".color(:red)
+          return
         end
       end
 

data/lib/lono/cfn/preview/changeset.rb

@@ -30,13 +30,26 @@ module Lono::Cfn::Preview
         change_set_name: change_set_name,
         stack_name: @stack_name,
         parameters: params,
-        capabilities: capabilities, # ["CAPABILITY_IAM", "CAPABILITY_NAMED_IAM"],
       }
       params[:tags] = tags unless tags.empty?
       set_template_body!(params)
       show_parameters(params, "cfn.create_change_set")
       begin
+        # Tricky for preview need to set capabilities so that it gets updated. For Base#run save_stack within the begin block already.
+        params[:capabilities] = capabilities # ["CAPABILITY_IAM", "CAPABILITY_NAMED_IAM"]
         cfn.create_change_set(params)
+      rescue Aws::CloudFormation::Errors::InsufficientCapabilitiesException => e
+        # If coming from cfn_preview_command automatically add iam capabilities
+        cfn_preview_command = ARGV.join(" ").include?("cfn preview")
+        if cfn_preview_command
+          # e.message is "Requires capabilities : [CAPABILITY_IAM]"
+          # grab CAPABILITY_IAM with regexp
+          capabilities = e.message.match(/\[(.*)\]/)[1]
+          @options.merge!(capabilities: [capabilities])
+          retry
+        end
+        yes = rerun_with_iam?(e)
+        retry if yes
       rescue Aws::CloudFormation::Errors::ValidationError => e
         handle_error(e)
       end

data/lib/lono/cfn/rollback.rb

@@ -19,7 +19,7 @@ class Lono::Cfn
     end
 
     def status
-      Cfn::Status.new(@stack_name)
+      Lono::Cfn::Status.new(@stack_name)
     end
     memoize :status
   end

data/lib/lono/cfn/status.rb

@@ -1,5 +1,5 @@
 class Lono::Cfn
-  class Status < ::Cfn::Status
+  class Status < CfnStatus
     include Util
 
     def initialize(stack_name, options={})

data/lib/lono/help/blueprint.md

@@ -1,46 +1,57 @@
 ## Examples
 
-    lono blueprint new ec2 # skeleton blueprint with barebones structure
+    lono blueprint new demo # skeleton blueprint with barebones structure
 
 ## Example Output
 
-    $ lono blueprint new ec2
-    => Creating new blueprint called ec2.
-          create  ec2
-          create  ec2/ec2.gemspec
-          create  ec2/.gitignore
-          create  ec2/Gemfile
-          create  ec2/README.md
-          create  ec2/app/definitions/base.rb
-          create  ec2/seed/configs.rb
-          create  ec2/app/templates
-    => Initialize git repo
-             run  git init from "."
-    Initialized empty Git repository in /home/ec2-user/environment/infra/blueprints/ec2/.git/
+    $ lono blueprint new demo
+    => Creating new blueprint called demo.
+          create  blueprints/demo
+          create  blueprints/demo/demo.gemspec
+          create  blueprints/demo/.gitignore
+          create  blueprints/demo/.meta/config.yml
+          create  blueprints/demo/CHANGELOG.md
+          create  blueprints/demo/Gemfile
+          create  blueprints/demo/README.md
+          create  blueprints/demo/Rakefile
+          create  blueprints/demo/seed/configs.rb
+           exist  blueprints/demo
+          create  blueprints/demo/app/templates/demo.rb
+          create  blueprints/demo/app/user_data/bootstrap.sh
+           exist  blueprints/demo/app/templates
+           exist
+          create  configs/demo/params/development.txt
+          create  configs/demo/params/production.txt
+          create  configs/demo/variables/development.rb
+          create  configs/demo/variables/production.rb
     => Installing dependencies with: bundle install
+    Fetching gem metadata from https://rubygems.org/..........
+    ...
+    Bundle complete! 4 Gemfile dependencies, 9 gems now installed.
+    Use `bundle info [gemname]` to see where a bundled gem is installed.
     ================================================================
     Congrats  You have successfully created a lono blueprint.
 
     Cd into your blueprint and check things out.
 
-      cd ec2
+        cd demo
 
     More info: https://lono.cloud/docs/core/blueprints
 
-      Here's the structure your blueprint:
+    Here is the structure of your blueprint:
 
     .
     ├── app
-    │   ├── definitions
-    │   │   └── base.rb
-    │   └── templates
-    ├── ec2.gemspec
+    │   ├── templates
+    │   │   └── demo.rb
+    │   └── user_data
+    │       └── bootstrap.sh
+    ├── CHANGELOG.md
+    ├── demo.gemspec
     ├── Gemfile
     ├── Gemfile.lock
+    ├── Rakefile
     ├── README.md
-    └── setup
+    └── seed
         └── configs.rb
-
-    4 directories, 6 files
-
     $

data/lib/lono/help/param.md

@@ -1,3 +1,6 @@
 ## Examples
 
-    lono param generate
+    $ lono param generate ecs-asg
+    Generating parameter files for blueprint ecs-asg:
+      output/ecs-asg/params/development.json
+    $

data/lib/lono/help/seed.md

@@ -2,15 +2,22 @@
 
     $ lono seed ecs-asg
     Creating starter config files for ecs-asg
-    Starter params created:    configs/ecs-asg/params/development.txt
+          create  configs/ecs-asg/params/development.txt
     $ cat configs/ecs-asg/params/development.txt
     # Required parameters:
-    VpcId=vpc-111
-    Subnets=subnet-111,subnet-222,subnet-333
-    EcsCluster=development
+    VpcId=vpc-111 # Find at vpc CloudFormation Outputs
+    Subnets=subnet-111,subnet-222,subnet-333 # Find at vpc CloudFormation Outputs
     # Optional parameters:
     # InstanceType=m5.large
     # KeyName=...
     # SshLocation=...
-    # TagName=ecs-asg
-    $
+    # EcsCluster=development
+    # TagName=ecs-asg-development
+    # ExistingIamInstanceProfile=...
+    # ExistingSecurityGroups=...
+    # EbsVolumeSize=50
+    # MinSize=1
+    # MaxSize=4
+    # MinInstancesInService=2
+    # MaxBatchSize=1
+    $

data/lib/lono/help/summary.md

@@ -2,14 +2,28 @@ The `lono summary` command helps you quickly understand a CloudFormation templat
 
 ## Examples
 
-    $ lono summary ec2
-    => CloudFormation Template Summary:
-    Parameters:
-    Required:
-      KeyName (AWS::EC2::KeyPair::KeyName)
-    Optional:
-      InstanceType (String) Default: t2.micro
-      SSHLocation (String) Default: 0.0.0.0/0
+    $ bundle exec lono summary ec2
+    Generating CloudFormation templates for blueprint ec2:
+      output/ec2/templates/ec2-old.yml
+      output/ec2/templates/ec2-new.yml
+    => CloudFormation Template Summary for template ec2-new:
+    Required Parameters (0):
+      There are no required parameters.
+    Optional Parameters (3):
+      InstanceType (String) Default: t3.micro
+      Subnet (String) Default:
+      Vpc (String) Default:
+    Resources:
+      1 AWS::EC2::Instance
+      1 AWS::EC2::SecurityGroup
+      2 Total
+    => CloudFormation Template Summary for template ec2-old:
+    Required Parameters (0):
+      There are no required parameters.
+    Optional Parameters (3):
+      InstanceType (String) Default: t3.micro
+      Subnet (String) Default:
+      Vpc (String) Default:
     Resources:
       1 AWS::EC2::Instance
       1 AWS::EC2::SecurityGroup

data/lib/lono/inspector/summary.rb

@@ -17,15 +17,16 @@ module Lono::Inspector
       if parameters.empty?
         puts "There are no parameters in this template."
       else
-        print_parameters("Required Parameters", required_parameters)
-        print_parameters("Optional Parameters", optional_parameters)
+        print_parameters("Required Parameters (#{required_parameters.size})", required_parameters)
+        print_parameters("Optional Parameters (#{optional_parameters.size})", optional_parameters)
       end
     end
 
     def print_parameters(label, parameters)
       puts "#{label}:"
       if parameters.empty?
-        puts "  There are no #{label.downcase} parameters"
+        text = label.downcase.include?("required") ? "required" : "optional"
+        puts "  There are no #{text} parameters."
       else
         parameters.each do |logical_id, p|
           output = "  #{logical_id} (#{p["Type"]})"

data/lib/lono/output_template.rb

@@ -20,11 +20,11 @@ module Lono
     end
 
     def required_parameters
-      parameters.reject { |logical_id, p| p["Default"].nil? }
+      parameters.select { |logical_id, p| p["Default"].nil? }
     end
 
     def optional_parameters
-      parameters.select { |logical_id, p| !p["Default"].nil? }
+      parameters.reject { |logical_id, p| p["Default"].nil? }
     end
 
     def parameters