lono 4.2.7 → 5.0.1

data/lib/lono/conventions.rb

@@ -0,0 +1,11 @@
+module Lono
+  module Conventions
+    # Think can make this a module, but need to figure out how it fits with lono cfn
+    def template_param_convention(options)
+      options = options.deep_symbolize_keys
+      template = options[:template] || @blueprint
+      param = options[:param] || template || @blueprint
+      [template, param]
+    end
+  end
+end

data/lib/lono/core.rb

@@ -3,26 +3,42 @@ require 'pathname'
 module Lono
   module Core
     extend Memoist
-    autoload :Config, 'lono/core/config'
 
     def config
       Config.new
     end
     memoize :config
 
+    @@root = nil
     def root
-      path = ENV['LONO_ROOT'] || '.'
+      path = @@root || ENV['LONO_ROOT'] || Dir.pwd
       Pathname.new(path)
     end
     memoize :root
 
+    @@blueprint_root = nil
+    def blueprint_root; @@blueprint_root ; end
+    def blueprint_root=(v) ; @@blueprint_root = v ; end
+
     def env
-      ufo_env = env_from_profile(ENV['AWS_PROFILE']) || 'development'
-      ufo_env = ENV['LONO_ENV'] if ENV['LONO_ENV'] # highest precedence
-      ufo_env
+      # 2-way binding
+      env = env_from_profile(ENV['AWS_PROFILE']) || 'development'
+      env = ENV['LONO_ENV'] if ENV['LONO_ENV'] # highest precedence
+      env
     end
     memoize :env
 
+    # Overrides AWS_PROFILE based on the Lono.env if set in configs/settings.yml
+    # 2-way binding.
+    def set_aws_profile!
+      return unless settings # Only load if within lono project and there's a settings.yml
+      data = settings[Lono.env] || {}
+      if data["aws_profile"]
+        # puts "Using AWS_PROFILE=#{data["aws_profile"]} from LONO_ENV=#{Lono.env} in configs/settings.yml"
+        ENV['AWS_PROFILE'] = data["aws_profile"]
+      end
+    end
+
     # Precedence (highest to lowest)
     #   1. LONO_SUFFIX
     #   2. .current/lono
@@ -40,15 +56,29 @@ module Lono
     end
     memoize :suffix
 
-    private
-    # Do not use the Setting class to load the profile because it can cause an
+    # Do not use the Setting#data to load the profile because it can cause an
     # infinite loop then if we decide to use Lono.env from within settings class.
+    def settings
+      setting = Setting.new(false) # check_lono_project to account for `lono new`
+      settings_path = setting.lookup_project_settings_path
+      return unless settings_path # in case outside of lono project
+
+      YAML.load_file(settings_path)
+    end
+    memoize :settings
+
+    def pro_version
+      installed = Gem::Specification.detect { |spec| spec.name == 'lono-pro' }
+      installed ? Lono::Pro::VERSION : "not installed"
+    end
+
+  private
     def env_from_profile(aws_profile)
-      data = YAML.load_file("#{Lono.root}/config/settings.yml")
-      env = data.find do |_env, setting|
-        setting ||= {}
-        profiles = setting['aws_profiles']
-        profiles && profiles.include?(aws_profile)
+      return unless settings
+      env = settings.find do |_env, settings|
+        settings ||= {}
+        profiles = settings['aws_profile']
+        profiles && profiles == aws_profile
       end
       env.first if env
     end

data/lib/lono/core/config.rb

@@ -7,14 +7,15 @@ module Lono::Core
       scripts_path: "app/scripts",
       templates_path: "app/templates",
       user_data_path: "app/user_data",
-      params_path: "config/params",
-      variables_path: "config/variables",
-      output_path: "output",
     }
     PATHS.each do |meth, path|
       define_method meth do
-        "#{Lono.root}/#{path}"
+        "#{Lono.blueprint_root}/#{path}"
       end
     end
+
+    def output_path
+      "#{Lono.root}/output"
+    end
   end
 end

data/lib/lono/default/settings.yml

@@ -7,19 +7,8 @@ base:
   # extract_scripts:
   #   to: "/opt"
   #   as: "ec2-user"
-  # If s3_folder is set then the generated templates and app/scripts will automatically
-  # be uploaded to s3.
-  # There are 2 formats for s3_folder:
-  # Format 1:
-  # s3_folder: mybucket/path/to/folder # simple string
-  # Format 2:
-  # s3_folder: # Hash options in order to support multiple AWS_PROFILEs
-  #   default: mybucket/folder
-  #   aws_profile1: mybucket/folder
-  #   aws_profile2: another-bucket/storage/folder
   # stack_name_suffix: random # tack on a 3 char random string at the end of the stack name for lono cfn create
 
-
 development:
   # When you have AWS_PROFILE set to one of these values, lono will switch to the desired
   # environment. This prevents you from switching AWS_PROFILE, forgetting to

data/lib/lono/file_uploader.rb

@@ -3,17 +3,17 @@ module Lono
     include Lono::Template::AwsService
     extend Memoist
 
-    def initialize(options={})
-      @options = options
+    def initialize(blueprint, options={})
+      @blueprint, @options = blueprint, options
       @checksums = {}
-      @prefix = "#{folder_key}/#{Lono.env}/files" # s3://s3-bucket/folder/development/files
+      @prefix = "#{folder_key}/#{Lono.env}/#{blueprint}/files" # s3://s3-bucket/folder/development/files
     end
 
     def upload_all
       puts "Uploading app/files..."
       load_checksums!
 
-      pattern = "#{Lono.root}/app/files/**/*"
+      pattern = "#{Lono.blueprint_root}/app/files/**/*"
       Dir.glob(pattern).each do |path|
         next if ::File.directory?(path)
         s3_upload(path)
@@ -50,7 +50,12 @@ module Lono
       "#{key}-#{md5}.#{ext}"
     end
 
+    # Inputs:
+    #
+    #   path: can be full path or relative path
+    #
     def s3_upload(path)
+      path = path.gsub("#{Lono.root}/",'') # remove Lono.root
       pretty_path = path.sub(/^\.\//, '')
       key = md5_key(path)
       s3_full_path = "s3://#{s3_bucket}/#{key}"

data/lib/lono/help.rb

@@ -1,7 +1,6 @@
 module Lono::Help
   class << self
-    # namespaced_command: cfn/create or cfn:create
-    # both work.
+    # namespaced_command: cfn/create or cfn:create both work.
     def text(namespaced_command)
       path = namespaced_command.to_s.gsub(':','/')
       path = File.expand_path("../help/#{path}.md", __FILE__)

data/lib/lono/help/blueprint.md

@@ -0,0 +1,46 @@
+## Examples
+
+    lono blueprint ec2 # skeleton blueprint with barebones structure
+
+## Example Output
+
+    $ lono blueprint 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/setup/configs.rb
+          create  ec2/app/templates
+    => Initialize git repo
+             run  git init from "."
+    Initialized empty Git repository in /home/ec2-user/environment/boltopspro/blueprints/ec2/.git/
+    => Installing dependencies with: bundle install
+    ================================================================
+    Congrats  You have successfully created a lono blueprint.
+        
+    Cd into your blueprint and check things out.
+        
+      cd ec2
+        
+    More info: https://lono.cloud/docs/core/blueprints
+        
+      Here's the structure your blueprint:
+        
+    .
+    ├── app
+    │   ├── definitions
+    │   │   └── base.rb
+    │   └── templates
+    ├── ec2.gemspec
+    ├── Gemfile
+    ├── Gemfile.lock
+    ├── README.md
+    └── setup
+        └── configs.rb
+        
+    4 directories, 6 files
+        
+    $

data/lib/lono/help/cfn.md

@@ -1,6 +1,7 @@
 ## Examples
 
-  lono cfn create my-stack
-  lono cfn preview my-stack
-  lono cfn update my-stack
-  lono cfn delete my-stack
+  lono cfn deploy demo
+  lono cfn create demo
+  lono cfn preview demo
+  lono cfn update demo
+  lono cfn delete demo

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

@@ -1,21 +1,26 @@
 ## Examples
 
-Provided that you are in a lono project and have a `my-stack` lono template definition.  To create a stack you can run:
+Provided that you are in a lono project and have a `demo` lono blueprint that contains a `demo` template.  To create a stack you can run:
 
-  lono cfn create my-stack
+    lono cfn create demo
 
-The above command will generate and use the template in `output/templates/my-stack.json` and parameters in `output/params/my-stack.txt`.  By [convention]({% link _docs/conventions.md %}), the template defaults to the name of the stack.  In turn, the params defaults to the name of the template.
+The above command will generate:
+
+* template:   output/demo/templates/demo.yml
+* parameters: output/demo/params/development.json
+
+By [convention]({% link _docs/conventions/cli.md %}), the blueprint name is the same as the stack name. In turn, template name is the same as the blueprint name. Lastly, the param name will default to the template name.
 
 Here are examples of overriding the template and params name conventions.
 
-  lono cfn create my-stack --template different1
+    lono cfn create demo --template different1
 
-The template used is `output/templates/different1.json` and the parameters used is `output/params/different1.json`.
+The template used is `app/templates/different1.rb` and the parameters used is `configs/demo/params/development/demo/different1.txt`.
 
-  lono cfn create my-stack --param different2
+    lono cfn create demo --param different2
 
-The template used is `output/templates/my-stack.json` and the parameters used is `output/params/different2.json`.
+The template used is `app/templates/demo.rb` and the parameters used is `configs/demo/params/development/demo/different2.json`.
 
-  lono cfn create my-stack --template different3 --param different4
+    lono cfn create demo --template different3 --param different4
 
-The template used is `output/templates/different3.json` and the parameters used is `output/params/different4.json`.
+The template used is `app/templates/different3.rb` and the parameters used is `configs/demo/params/different3/different4.json`.

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

@@ -0,0 +1,92 @@
+The `cfn deploy` command figures out whether or not it should perform a stack create or update. It delegates to `cfn create` or `cfn update`.  This saves you from thinking about it
+
+# Examples
+
+Provided that you are in a lono project and have a `demo` lono blueprint that contains a `demo` template.  To create a stack you can run:
+
+    lono cfn deploy demo
+
+The above command will generate:
+
+* template:   output/demo/templates/demo.yml
+* parameters: output/demo/params/development.json
+
+By [convention]({% link _docs/conventions/cli.md %}), the blueprint name is the same as the stack name. In turn, template name is the same as the blueprint name. Lastly, the param name will default to the template name.  Some examples follow to help explain.
+
+## Convention: Stack, Blueprint, Template and Parameter are All the Same
+
+Let's say you have a blueprint in `blueprints/demo` with a structure the looks something like this:
+
+    .
+    ├── blueprints
+    │   └── demo
+    │       └── app
+    │           └── templates
+    │               ├── demo.rb
+    │               └── ec2.rb
+    └── configs
+        └── demo
+            └── params
+                ├── base.txt
+                └── development.txt
+
+The command:
+
+    lono cfn deploy demo
+
+Will use:
+
+* blueprint: blueprints/demo
+* template: blueprints/demo/app/templates/demo.rb
+* param: configs/demo/params/development.txt
+
+## Stack and Blueprint Do Not Match But Everything Else Does
+
+This is a common case, where the stack name is different from the blueprint name.
+
+    lono cfn deploy my-demo --blueprint demo
+
+The stack will be called my-demo and the blueprint is `demo`.  Since by convention, templates default to the blueprint name we're pretty much set.  Lono will use:
+
+* blueprint: blueprints/demo
+* template: blueprints/demo/app/templates/demo.rb
+* param: configs/demo/params/development.txt
+
+Everything is the same as when the stack name matches the blueprint name.
+
+## Blueprint and Template Name Do Not Match, But Template and Param Name Matches
+
+    lono cfn deploy my-demo --blueprint demo --template ec2
+
+In this case we are using the ec2 template within the demo blueprint.  We'll add another param file `configs/demo/params/ec2.txt`
+
+    └── configs
+        └── demo
+            └── params
+                └── ec2.txt
+
+Lono will use these files:
+
+* blueprint: blueprints/demo
+* template: blueprints/demo/app/templates/ec2.rb
+* param: configs/demo/params/ec2.txt
+
+## Template Name and Param Name Do Not Match
+
+The form with most control is the one with all options explicitly specified.
+
+    lono cfn deploy my-demo --blueprint demo --template ec2 --param large
+
+We'll add another parameter file here: `configs/demo/params/ec2/large.txt`
+
+    └── configs
+        └── demo
+            └── params
+                └── ec2
+                    └── large.txt
+
+Lono will use these files:
+
+* blueprint: blueprints/demo
+* template: blueprints/demo/app/templates/ec2.rb
+* param: configs/demo/params/ec2/large.txt

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

@@ -15,7 +15,6 @@ Displays code diff of the generated CloudFormation template locally vs the exist
     <     Default: t2.small
     ---
     >     Default: t2.medium
-    $ subl -a ~/.lono/settings.yml
     $
 
 Here's a screenshot of the output with the colored diff:

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

@@ -2,9 +2,7 @@
 
 Let's say we make a simple change to a template, like changing the default InstanceType from `t2.small` to `t2.micro`.  Here's what happens when you run `lono cfn update`
 
-```sh
-lono cfn update ec2
-```
+    lono cfn update ec2
 
 The output should look similiar to this:
 
@@ -19,30 +17,33 @@ You are prompted with an "Are you sure?" confirmation before lono continues.
 
 By default, the update command will display a preview of the stack changes before applying the update and prompt to check if you are sure.  If you want to bypass the are you sure prompt, use the `--sure` option.
 
-```
-lono cfn update ec2 --sure
-```
+    lono cfn update ec2 --sure
 
 ## Conventions: template and param
 
 Lono follows some [coventions](http://lono.cloud/docs/conventions/) that helps keep the commands short.  We'll go through an example to explain:
 
-Provided that you are in a lono project and have a `my-stack` lono template definition.  To update a stack you can simply run:
+Provided that you are in a lono project and have a `demo` lono blueprint that contains a `demo` template.  To update a stack you can run:
 
-  lono cfn update my-stack
+    lono cfn update demo
 
-The above command will generate and use the template in `output/templates/my-stack.json` and parameters in `output/params/my-stack.txt`.  The template by convention defaults to the name of the stack.  In turn, the params by convention defaults to the name of the template.
+The above command will generate:
+
+* template:   output/demo/templates/demo.yml
+* parameters: output/demo/params/development.json
+
+By [convention]({% link _docs/conventions/cli.md %}), the blueprint name is the same as the stack name. In turn, template name is the same as the blueprint name. Lastly, the param name will default to the template name.
 
 Here are examples of overriding the template and params name conventions.
 
-  lono cfn update my-stack --template different1
+    lono cfn update demo --template different1
 
-The template used is `output/templates/different1.json` and the parameters used is `output/params/different1.json`.
+The template used is `app/templates/different1.rb` and the parameters used is `configs/demo/params/development/demo/different1.txt`.
 
-  lono cfn update my-stack --param different2
+    lono cfn update demo --param different2
 
-The template used is `output/templates/my-stack.json` and the parameters used is `output/params/different2.json`.
+The template used is `app/templates/demo.rb` and the parameters used is `configs/demo/params/development/demo/different2.json`.
 
-  lono cfn update my-stack --template different3 --param different4
+    lono cfn update demo --template different3 --param different4
 
-The template used is `output/templates/different3.json` and the parameters used is `output/params/different4.json`.
+The template used is `app/templates/different3.rb` and the parameters used is `configs/demo/params/different3/different4.json`.

data/lib/lono/help/completion.md

@@ -8,7 +8,7 @@ Prints words for TAB auto-completion.
 
   lono completion
   lono completion cfn
-  lono completion cfn create
+  lono completion cfn deploy
 
 To enable, TAB auto-completion add the following to your profile:
 
@@ -18,5 +18,5 @@ Auto-completion example usage:
 
   lono [TAB]
   lono cfn [TAB]
-  lono cfn create [TAB]
-  lono cfn create --[TAB]
+  lono cfn deploy [TAB]
+  lono cfn deploy --[TAB]