lono 4.2.7 → 5.0.1

data/lib/lono/template/util.rb

@@ -0,0 +1,48 @@
+class Lono::Template
+  module Util
+    def ensure_parent_dir(path)
+      dir = File.dirname(path)
+      FileUtils.mkdir_p(dir) unless File.exist?(dir)
+    end
+
+    def validate_yaml(path)
+      text = IO.read(path)
+      begin
+        YAML.load(text)
+      rescue Psych::SyntaxError => e
+        handle_yaml_syntax_error(e, path)
+      end
+    end
+
+    def handle_yaml_syntax_error(e, path)
+      io = StringIO.new
+      io.puts "Invalid yaml.  Output written to debugging: #{path}".color(:red)
+      io.puts "ERROR: #{e.message}".color(:red)
+
+      # Grab line info.  Example error:
+      #   ERROR: (<unknown>): could not find expected ':' while scanning a simple key at line 2 column 1
+      md = e.message.match(/at line (\d+) column (\d+)/)
+      line = md[1].to_i
+
+      lines = IO.read(path).split("\n")
+      context = 5 # lines of context
+      top, bottom = [line-context-1, 0].max, line+context-1
+      spacing = lines.size.to_s.size
+      lines[top..bottom].each_with_index do |line_content, index|
+        line_number = top+index+1
+        if line_number == line
+          io.printf("%#{spacing}d %s\n".color(:red), line_number, line_content)
+        else
+          io.printf("%#{spacing}d %s\n", line_number, line_content)
+        end
+      end
+
+      if ENV['TEST']
+        io.string
+      else
+        puts io.string
+        exit 1
+      end
+    end
+  end
+end

data/lib/lono/upgrade.rb

@@ -1,9 +1,6 @@
 require "thor"
 
 class Lono::Upgrade < Lono::Command
-  autoload :Upgrade4, 'lono/upgrade/upgrade4'
-  autoload :Upgrade42, 'lono/upgrade/upgrade42'
-
   desc "v3to4", "Upgrade from version 3 to 4."
   def v3to4
     Upgrade4.new(options).run
@@ -13,4 +10,9 @@ class Lono::Upgrade < Lono::Command
   def v4to4_2
     Upgrade42.start
   end
+
+  desc "v4to5", "Upgrade from version 4.2 to 5.0"
+  def v4to5
+    Upgrade5.start
+  end
 end

data/lib/lono/upgrade/upgrade5.rb

@@ -0,0 +1,55 @@
+require 'fileutils'
+require 'yaml'
+
+class Lono::Upgrade
+  class Upgrade5 < Lono::Sequence
+    def sanity_check
+      if File.exist?("blueprints")
+        puts "The blueprints folder already exist. The project already seems to have the lono v5 structure."
+        exit
+      end
+
+      unless File.exist?("config/settings.yml")
+        puts "ERROR: The config/settings.yml file does not exist. Are you sure you're within a lono project?".color(:red)
+        exit 1
+      end
+    end
+
+    def create_blueprints_folder
+      puts "Creating: blueprints folder"
+      FileUtils.mkdir_p("blueprints/main")
+    end
+
+    def move_to_main_blueprint
+      puts "Moving files to blueprints folder"
+      # Dir.entries includes hidden files
+      Dir.entries('.').each do |p|
+        next if %w[blueprints .git .. .].include?(p)
+        FileUtils.mv(p, "blueprints/main/#{p}")
+      end
+    end
+
+    def move_configs
+      puts "Setting up the new configs structure"
+      FileUtils.mkdir_p("configs/main")
+      FileUtils.mv("blueprints/main/config/params", "configs/main/params")
+      FileUtils.mv("blueprints/main/config/variables", "configs/main/variables")
+      FileUtils.mv("blueprints/main/config/settings.yml", "configs/settings.yml")
+
+      FileUtils.rmdir("blueprints/main/config") if Dir.empty?("blueprints/main/config")
+    end
+
+    def starter_files
+      puts "Creating remaining starter lono project files"
+      files = %w[
+        .gitignore
+        Gemfile
+        Guardfile
+        README.md
+      ]
+      files.each { |f | template(f) }
+
+      template("../upgrade5/blueprints/main/.meta/config.yml", "blueprints/main/.meta/config.yml")
+    end
+  end
+end

data/lib/lono/user_data.rb

@@ -3,11 +3,11 @@ module Lono
   # exposed to the lono userdata command so users can debug their generated
   # app/user_data scripts. It is useful for debugging.
   #
-  # Normally, the Lono::DSL#run method generates the CloudFormation templates
+  # Normally, the Lono::Erb#run method generates the CloudFormation templates
   # and embeds user-data script into the template.
   class UserData
-    def initialize(options)
-      @options = options
+    def initialize(blueprint, options)
+      @blueprint, @options = blueprint, options
       @name = options[:name]
       @path = "#{Lono.root}/app/user_data/#{@name}.sh"
     end
@@ -25,7 +25,7 @@ module Lono
     # Context for ERB rendering.
     # This is where we control what references get passed to the ERB rendering.
     def context
-      @context ||= Lono::Template::Context.new(@options)
+      @context ||= Lono::Template::Context.new(@blueprint, @options)
     end
   end
 end

data/lib/lono/version.rb

@@ -1,3 +1,3 @@
 module Lono
-  VERSION = "4.2.7"
+  VERSION = "5.0.1"
 end

data/lib/templates/blueprint/%blueprint_name%.gemspec.tt

@@ -0,0 +1,44 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "<%= blueprint_name %>"
+  spec.version       = "0.1.0"
+  spec.authors       = ["<%= user_info[:author] %>"]
+  spec.email         = ["<%= ENV['LONO_EMAIL'] || user_info[:email] %>"]
+
+  spec.summary       = "Write a short summary because it's required."  # TODO: Change me
+  spec.description   = "Write a longer description or delete this line."  # TODO: Change me
+  spec.homepage      = "https://github.com/user/repo"  # TODO: Change me
+  spec.license       = "<%= ENV['LONO_LICENSE'] || 'MIT' %>"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "<%= ENV['LONO_ALLOWED_PUSH_HOST'] || "TODO: Set to 'http://mygemserver.com'"%>"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+<% if ENV['LONO_SOURCE_CODE_ORG'] -%>
+    spec.metadata["source_code_uri"] = "<%= ENV['LONO_SOURCE_CODE_ORG'] %>/<%= blueprint_name %>"
+    spec.metadata["changelog_uri"] = "<%= ENV['LONO_SOURCE_CODE_ORG'] %>/<%= blueprint_name %>/blob/master/CHANGELOG.md"
+<% else -%>
+    spec.metadata["source_code_uri"] = "https://github.com/user/repo" # TODO: Change me
+    spec.metadata["changelog_uri"] = "https://github.com/user/repo/blob/master/CHANGELOG.md"  # TODO: Change me
+<% end -%>
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/templates/blueprint/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+output
+Gemfile.lock

data/lib/templates/blueprint/.lono/config.yml.tt

@@ -0,0 +1,3 @@
+---
+blueprint_name: <%= blueprint_name %>
+template_type: dsl

data/lib/templates/blueprint/.meta/config.yml.tt

@@ -0,0 +1,3 @@
+---
+blueprint_name: <%= blueprint_name %>
+template_type: dsl

data/lib/templates/blueprint/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/).
+
+## [0.1.0]
+- Initial release

data/lib/templates/blueprint/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ecs-asg.gemspec
+gemspec

data/lib/templates/blueprint/README.md

@@ -0,0 +1,37 @@
+# Blueprint Starter README
+
+## Usage
+
+1. Configure: configs/BLUEPRINT values
+2. Deploy blueprint
+
+## Configure
+
+First you want to configure the `configs/BLUEPRINT/params` and `configs/BLUEPRINT/variables` files.
+
+If the blueprint has implemented it, you can use `lono configure` to quickly configure starter values for these `config/BLUEPRINT` files.
+
+    LONO_ENV=development lono configure BLUEPRINT --args key1:value1 key2:value2
+
+To additional environments:
+
+    LONO_ENV=production  lono configure BLUEPRINT --args key1:value1 key2:value2
+
+The generated files in `config/BLUEPRINT` folder look something like this:
+
+    configs/BLUEPRINT/
+    ├── params
+    │   ├── development.txt
+    │   └── production.txt
+    └── variables
+        ├── development.rb
+        └── production.rb
+
+The PARAM depends on how the blueprint was authored.  The PARAM conventionally defaults to BLUEPRINT.
+
+## Deploy
+
+Use the [lono cfn deploy](http://lono.cloud/reference/lono-cfn-deploy/) command to deploy. Example:
+
+    LONO_ENV=development lono cfn deploy BLUEPRINT-development --blueprint BLUEPRINT --iam
+    LONO_ENV=production  lono cfn deploy BLUEPRINT-production --blueprint BLUEPRINT --iam

data/lib/templates/blueprint/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task default: :spec
+
+RSpec::Core::RakeTask.new

data/lib/templates/blueprint/setup/configs.rb

@@ -0,0 +1,54 @@
+# This class is used by `lono configure [blueprint]` to create starter config files.
+# Example files that get created:
+#
+# Variables:
+#
+#    configs/[blueprint]/variables/[Lono.env].rb
+#
+# Params:
+#
+#    configs/[blueprint]/params/[Lono.env].txt - short form
+#    configs/[blueprint]/params/[Lono.env]/[param].txt - medium form
+#    configs/[blueprint]/params/[Lono.env]/[template]/[param].txt - large form
+#
+# Subclasses of `Lono::Configure::Base` should implement:
+#
+#   setup: Hook to perform logic at the beginning. Examples:
+#     * Setting instance variables used in the params or variables template methods.
+#     * Creating pre-defined IAM roles required by the template.
+#   params: Template for generated params file. Contents of what gets created at
+#     configs/[blueprint]/params/development/[param].txt
+#   variables: Template for generated variables file. Contents of what gets created at
+#     configs/[blueprint]/variables/development.rb
+#
+class Configs < Lono::Configure::Base
+  # Setup hook
+  def setup
+    # Custom setup logic
+    # set_instance_variables
+  end
+
+  # Template for params
+  def params
+    <<~EOL
+      Parameter1=StarterValue1
+      Parameter2=StarterValue1
+      # Optional
+      # Parameter3=OptionalStarterValue1
+    EOL
+  end
+
+  # Template for variables
+  # def variables
+  #   <<~EOL
+  #     @variable1=starter_value1
+  #     @variable2=starter_value2
+  #   EOL
+  # end
+
+private
+  # Example:
+  # def set_instance_variables
+  #   @instance_type = "t3.micro"
+  # end
+end

data/lib/templates/blueprint_configs/configs/%blueprint_name%/params/base.txt

@@ -0,0 +1,2 @@
+# Starter Example
+# InstanceType=t3.micro

data/lib/templates/blueprint_configs/configs/%blueprint_name%/variables/base.rb

@@ -0,0 +1,2 @@
+# Starter Example
+# @variable = "value"

data/lib/templates/blueprint_types/dsl/app/templates/%blueprint_name%.rb

@@ -0,0 +1,37 @@
+# Simple Starter Demo Example
+aws_template_format_version "2010-09-09"
+description "Demo stack"
+
+parameter(:instance_type, "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" }
+)
+
+resource(:instance, "AWS::EC2::Instance",
+  instance_type: ref(:instance_type),
+  image_id: find_in_map(:ami_map, ref("AWS::Region"), :ami),
+  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",
+)
+
+output(:instance)
+output(:security_group, get_att("security_group.group_id"))

data/lib/templates/blueprint_types/dsl/app/user_data/bootstrap.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+echo "hello world"

data/lib/templates/blueprint_types/erb/app/definitions/base.rb.tt

@@ -0,0 +1 @@
+template "<%= blueprint_name %>"

data/lib/templates/blueprint_types/erb/app/templates/%blueprint_name%.yml

@@ -0,0 +1,8 @@
+---
+# Simple Starter Example
+Resources:
+  EC2Instance:
+    Type: AWS::EC2::Instance
+    Properties:
+      InstanceType: t3.micro
+      ImageId: ami-05b186cbeb4bd0170 # us-west-2 Amazon Linux 2 AMI (HVM), SSD Volume Type

data/lib/{starter_projects/autoscaling → templates/skeleton}/.gitignore

@@ -1,2 +1,3 @@
 .lono
+dev.mode
 output

data/lib/templates/skeleton/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+# gem "lono-pro", git: "git@github.com:boltopspro/lono-pro.git" # optional

data/lib/{starter_projects/autoscaling → templates/skeleton}/Guardfile

@@ -2,8 +2,8 @@
 # More info at https://github.com/guard/guard#readme
 
 guard "lono" do
-  watch(%r{^config/lono.rb$})
-  watch(%r{^templates/.*$})
+  watch(%r{^blueprints/.*$})
+  watch(%r{^configs/.*$})
 end
 
 # Commented out due to CF rate limiting

data/lib/templates/skeleton/README.md

@@ -0,0 +1,58 @@
+# Lono CloudFormation Starter README
+
+This folder contains the code that represents your infrastructure built with CloudFormation.
+
+## Overview
+
+The CloudFormations templates are generated by a tool called [lono](http://lono.cloud/).
+
+## Updating the Infrastructure
+
+The general steps to update the infrastructure:
+
+1. Add and edit the blueprints
+2. Generate CloudFormation templates
+3. Deploy the stack
+
+Steps 2-3 are automated with lono and performed together with:
+
+    lono cfn deploy STACK_NAME
+
+Here are some useful flags:
+
+    lono cfn deploy STACK_NAME --iam --sure
+
+More info: [lono cfn deploy](http://lono.cloud/reference/lono-cfn-deploy/)
+
+## Structure
+
+The structure of a lono project looks like this:
+
+More info: [Project Structure](http://lono.cloud/docs/structure/)
+
+## Generating Templates from Blueprints
+
+If you would like to just generate the templates and not update the CloudFormation stack you can do so with:
+
+    lono generate BLUEPRINT_NAME
+
+## Configs
+
+You may want to take a look at the configs folder to change params and variables. For example:
+
+* configs/demo/params
+* configs/demo/variables
+
+## Deploy
+
+To launch the stack:
+
+    lono cfn deploy demo
+
+## More help
+
+You can get help by adding `-h` to the end of commands.
+
+    lono cfn update -h
+
+Help is also provided in the [Lono Docs](http://lono.cloud/docs/).