lono 7.5.2 → 8.0.0.pre.rc3

data/lib/lono/cli/bundle.rb

@@ -0,0 +1,21 @@
+class Lono::CLI
+  class Bundle < Abstract
+    def run
+      Lono::Bundler::CLI.start(args)
+    end
+
+    # Allows bundle to be called without install. So both work:
+    #
+    #    lono bundle
+    #    lono bundle install
+    #
+    def args
+      args = @options[:args]
+      if args.empty? or args.first.include?('--')
+        args.unshift("install")
+      end
+      args = ["bundle"] + args
+      args
+    end
+  end
+end

data/lib/lono/cli/cfn/opts.rb

@@ -0,0 +1,59 @@
+class Lono::CLI::Cfn
+  class Opts < Lono::CLI::Opts
+    def create
+      base_options
+      wait_options
+    end
+
+    def update
+      base_options
+      wait_options
+    end
+
+    def deploy
+      update
+    end
+
+    def delete
+      wait_options
+    end
+
+    def cancel
+      wait_options
+    end
+
+    def preview
+      base_options
+      with_cli_scope do
+        option :keep, type: :boolean, desc: "keep the changeset instead of deleting it afterwards"
+      end
+    end
+
+    def download
+      base_options
+      with_cli_scope do
+        option :name, desc: "Name you want to save the template as. Default: existing stack name."
+        option :source, desc: "url or path to file with template"
+      end
+    end
+
+    # Lono::Cfn and Lono::Sets
+    def base_options(rollback: true)
+      with_cli_scope do
+        if rollback
+          option :rollback, type: :boolean, desc: "rollback" # default: nil means CloudFormation default which is true
+        end
+        # common to Lono::Cfn and Lono::Sets
+        option :capabilities, type: :array, desc: "iam capabilities. Ex: CAPABILITY_IAM, CAPABILITY_NAMED_IAM"
+        option :iam, type: :boolean, desc: "Shortcut for common IAM capabilities: CAPABILITY_IAM, CAPABILITY_NAMED_IAM"
+      end
+    end
+
+    def wait_options
+      with_cli_scope do
+        option :wait, type: :boolean, desc: "Wait for stack operation to complete.", default: true
+        option :yes, aliases: :y, type: :boolean, desc: "Skip are you sure prompt" # moved to base but used by commands like `lono down` also. Just keep here.
+      end
+    end
+  end
+end

data/lib/lono/cli/cfn.rb

@@ -0,0 +1,19 @@
+class Lono::CLI
+  class Cfn < Lono::Command
+    opts = Lono::CLI::Cfn::Opts.new(self)
+
+    desc "cancel BLUEPRINT", "Cancel a CloudFormation blueprint."
+    long_desc Help.text("cfn/cancel")
+    opts.cancel
+    def cancel(blueprint)
+      Lono::Cfn::Cancel.new(options.merge(blueprint: blueprint)).run
+    end
+
+    desc "download BLUEPRINT", "Download CloudFormation template from existing blueprint."
+    long_desc Help.text("cfn/download")
+    opts.download
+    def download(blueprint)
+      Lono::Cfn::Download.new(options.merge(blueprint: blueprint)).run
+    end
+  end
+end

data/lib/lono/cli/clean.rb

@@ -0,0 +1,23 @@
+require "fileutils"
+
+class Lono::CLI
+  class Clean
+    include Lono::Utils::Logging
+    include Lono::Utils::Sure
+
+    attr_reader :options
+    def initialize(options={})
+      @options = options
+      @mute = options[:mute] # used by CLI::Build at beginning to clear out the output folder
+    end
+
+    def run
+      folders = %w[output tmp]
+      @mute || sure?("Will remove folders: #{folders.join(' ')}")
+      folders.each do |folder|
+        FileUtils.rm_rf("#{Lono.root}/#{folder}")
+      end
+      logger.info "Removed folders: #{folders.join(' ')}" unless @mute
+    end
+  end
+end

data/lib/lono/cli/code.rb

@@ -0,0 +1,22 @@
+class Lono::CLI
+  class Code < Lono::Command
+    # desc "import SOURCE", "Imports CloudFormation template and converts it to Ruby code."
+    # long_desc Help.text("code/import")
+    # option :blueprint, default: nil, desc: "final blueprint name"
+    # option :casing, default: "as-is", desc: "Controls casing of logical ids. IE: as-is, camelcase or underscore"
+    # option :summary, default: true, type: :boolean, desc: "provide template summary after import"
+    # option :template, default: nil, desc: "final template name of downloaded template without extension"
+    # option :template_name_casing, default: "dasherize", desc: "camelcase or dasherize the template name"
+    # option :type, default: "dsl", desc: "import as a DSL or ERB template"
+    # def import(source)
+    #   Importer.new(options.merge(source: source)).run
+    # end
+
+    desc "convert SOURCE", "Converts snippet of JSON or YAML CloudFormation template to Ruby code."
+    long_desc Help.text("code/convert")
+    option :casing, default: "as-is", desc: "Controls casing of logical ids. IE: as-is, camelcase or underscore"
+    def convert(source)
+      Lono::Importer::Converter.new(options.merge(source: source)).run
+    end
+  end
+end

data/lib/lono/{completion.rb → cli/completion.rb}

@@ -1,5 +1,5 @@
-module Lono
-  class Completion < Command
+class Lono::CLI
+  class Completion < Base
     desc "script", "generates script that can be eval to setup auto-completion"
     long_desc Help.text("completion:script")
     def script

data/lib/lono/{help → cli/help}/blueprint/new.md

@@ -19,10 +19,10 @@
           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
+          create  config/demo/params/development.txt
+          create  config/demo/params/production.txt
+          create  config/demo/variables/development.rb
+          create  config/demo/variables/production.rb
     => Installing dependencies with: bundle install
     Fetching gem metadata from https://rubygems.org/..........
     ...

data/lib/lono/{help/generate.md → cli/help/build.md}

@@ -2,16 +2,16 @@ Generates CloudFormation template, parameter files, and scripts in lono project
 
 ## Examples
 
-    lono generate BLUEPRINT
-    lono generate BLUEPRINT --clean
+    lono build BLUEPRINT
+    lono build BLUEPRINT --clean
     lono g BLUEPRINT --clean # shortcut
 
 ## Example Output
 
-    $ lono generate ec2
-    Generating CloudFormation templates, parameters, and scripts
-    Generating CloudFormation templates:
+    $ lono build ec2
+    Building template, parameters, and scripts
+    Building template:
       output/templates/ec2.yml
-    Generating parameter files:
+    Building parameters:
       output/params/ec2.json
     $

data/lib/lono/cli/help/cfn/download.md

@@ -0,0 +1,3 @@
+## Examples
+
+  lono cfn download demo

data/lib/lono/{help → cli/help}/cfn/preview.md

@@ -2,25 +2,26 @@
 
 We'll make a change to the default InstanceType of a CloudFromation stack.
 
-    lono cfn preview my-stack
+    lono cfn plan demo
 
 The output should look similiar to this:
 
-    Generating CloudFormation source code diff...
-    Running: colordiff /tmp/existing_cfn_template.yml output/templates/ec2.yml
+    Building CloudFormation source code diff...
+    => colordiff /tmp/existing_cfn_template.yml output/templates/ec2.yml
     14c14
     <     Default: t2.small
     ---
     >     Default: t2.micro
-    Generating CloudFormation Change Set for preview.....
-    CloudFormation preview for 'ec2' stack update. Changes:
+    Building CloudFormation Change Set for plan.....
+    CloudFormation plan for 'ec2' stack update. Changes:
     Modify AWS::EC2::Instance: EC2Instance i-07e939db65120fb75
 
-The preview includes colors:
+The plan includes colors:
 
 <img src="/img/reference/lono-cfn-preview.png" alt="Stack Update" class="doc-photo">
 
-There are two types of "diffs" in the preview.
+There are several types of "diffs" in the plan.
 
 1. Source code diff of the templates. This is generated by downloading the current CloudFormation template and comparing it with the locally generated one using `colordiff`.
-2. CloudFormation Change Set list of changes. This is generated using [AWS CloudFormation Change Set](https://medium.com/boltops/a-simple-introduction-to-cloudformation-part-4-change-sets-dry-run-mode-c14e41dfeab7) feature.
+2. Param diff.
+3. CloudFormation Change Set list of changes. This is generated using [AWS CloudFormation Change Set](https://medium.com/boltops/a-simple-introduction-to-cloudformation-part-4-change-sets-dry-run-mode-c14e41dfeab7) feature.

data/lib/lono/{help → cli/help}/cfn/status.md

@@ -12,4 +12,3 @@ Shows the status of the stack. If the stack is in progress then tail the status
     11:52:33PM UPDATE_COMPLETE AWS::CloudWatch::Alarm HighCpu
     11:52:35PM UPDATE_COMPLETE_CLEANUP_IN_PROGRESS AWS::CloudFormation::Stack ecs-asg
     11:52:36PM UPDATE_COMPLETE AWS::CloudFormation::Stack ecs-asg
-

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

@@ -0,0 +1,4 @@
+## Examples
+
+  lono up demo
+  lono down demo

data/lib/lono/{help → cli/help}/code/import.md

@@ -21,8 +21,8 @@
           create  blueprints/ec2/seed/configs.rb
           create  blueprints/ec2/app/templates
           create  blueprints/ec2/app/templates/ec2.rb
-          create  configs/ec2/params/development.txt
-          create  configs/ec2/params/production.txt
+          create  config/ec2/params/development.txt
+          create  config/ec2/params/production.txt
     ================================================================
     Congrats  You have successfully imported a lono blueprint.
 

data/lib/lono/{help → cli/help}/completion.md

@@ -8,7 +8,7 @@ Prints words for TAB auto-completion.
 
   lono completion
   lono completion cfn
-  lono completion cfn deploy
+  lono completion up
 
 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 deploy [TAB]
-  lono cfn deploy --[TAB]
+  lono up [TAB]
+  lono up --[TAB]

data/lib/lono/cli/help/down.md

@@ -0,0 +1,13 @@
+## Examples
+
+    $ lono down demo
+    Are you sure you want to delete the demo-dev stack? (y/N)
+    y
+    Deleted demo-dev stack.
+    $
+
+Lono prompts you with an "Are you sure?" message before the stack gets deleted.  If you would like to bypass the prompt, you can use the `-y` flag.
+
+    $ lono down demo -y
+    Deleted demo-dev stack.
+    $

data/lib/lono/cli/help/new/helper/blueprint.md

@@ -0,0 +1,17 @@
+## Example
+
+The default helper name is `custom`.
+
+    $ lono new helper blueprint --blueprint demo
+    => Generating custom_helper.rb
+          create  app/blueprints/demo/helpers
+          create  app/blueprints/demo/helpers/custom_helper.rb
+
+
+You can override the helper name with the first argument.
+
+    $ lono new helper blueprint vars --blueprint demo
+    => Generating vars_helper.rb
+          create  app/blueprints/demo/helpers
+          create  app/blueprints/demo/helpers/vars_helper.rb
+    $

data/lib/lono/cli/help/new/helper/project.md

@@ -0,0 +1,16 @@
+## Examples
+
+The default helper name is `custom`.
+
+    $ lono new helper project
+    => Generating custom_helper.rb
+          create  app/helpers/custom
+          create  app/helpers/custom/custom_helper.rb
+
+You can override the helper name with the first argument.
+
+    $ lono new helper project asg
+    => Generating asg_helper.rb
+          create  app/helpers/asg
+          create  app/helpers/asg/asg_helper.rb
+    $

data/lib/lono/cli/help/new/project.md

@@ -0,0 +1,34 @@
+## Example
+
+    $ lono new project infra
+    => Creating new project called infra.
+          create  infra
+          create  infra/.gitignore
+          create  infra/Gemfile
+          create  infra/README.md
+          create  infra/config/app.rb
+    => Initialize git repo
+             run  git init from "."
+    Initialized empty Git repository in /home/ec2-user/environment/infra/.git/
+    => Installing dependencies with: bundle install
+    Resolving dependencies...Fetching gem metadata from https://rubygems.org/.......
+    ............................
+    Using concurrent-ruby 1.1.9
+    ...
+    Bundle complete! 1 Gemfile dependency, 40 gems now installed.
+    Use `bundle info [gemname]` to see where a bundled gem is installed.
+    ================================================================
+    Congrats 🎉 You have successfully created a lono project.
+
+        cd infra
+
+    To generate a new blueprint:
+
+        lono new blueprint demo --examples
+
+    To deploy:
+
+        lono up demo
+
+    More info: https://lono.cloud/
+    $

data/lib/lono/cli/help/param.md

@@ -0,0 +1,6 @@
+## Examples
+
+    $ lono param generate ecs-asg
+    Building parameters
+        output/ecs-asg/params/development.json
+    $

data/lib/lono/cli/help/seed.md

@@ -0,0 +1,24 @@
+## Example
+
+    $ lono seed demo
+    Creating starter config files for ec2
+          create  config/blueprints/ec2/params/dev.txt
+          create  config/blueprints/ec2/vars/dev.rb
+
+To create the files in the top-level app folder
+
+    $ lono seed ec2 --where app
+    Creating starter config files for ec2
+          create  app/blueprints/ec2/config/params/dev.txt
+          create  app/blueprints/ec2/config/vars/dev.rb
+    $
+
+You can also set the default where option with
+
+config/app.rb
+
+```ruby
+Lono.configure do |config|
+  config.seed.where = "app"
+end
+```

data/lib/lono/cli/help/summary.md

@@ -0,0 +1,33 @@
+The `lono summary` command helps you quickly understand a CloudFormation template.
+
+## Examples
+
+    $ bundle exec lono summary ec2
+    Building template
+        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
+        2 Total
+    $
+
+Blog Post also covers this: [lono summary Tutorial Introduction](https://blog.boltops.com/2017/09/18/lono-inspect-summary-tutorial-introduction)

data/lib/lono/cli/help/template/generate.md

@@ -0,0 +1,7 @@
+## Examples
+
+  lono template generate
+  lono template generate --clean
+  lono template g --clean
+
+Builds the CloudFormation template files based on lono project and writes them to the output folder on the filesystem.

data/lib/lono/cli/help/up.md

@@ -0,0 +1,30 @@
+## Examples
+
+    $ lono up demo
+    Deploying demo-dev stack
+    Building template
+        output/demo/template.yml
+    Uploading template
+    Not modified: output/demo/template.yml to s3://lono-bucket-12di8xz5sy72z/dev/output/demo/template.yml
+    Uploaded to s3.
+    Building parameters
+        output/demo/params.json
+    Going to create stack demo-dev with blueprint demo. (y/N) y
+    Parameters passed to create_stack:
+    ---
+    disable_rollback: false
+    parameters:
+    - parameter_key: AccessControl
+      parameter_value: PublicRead
+    stack_name: demo-dev
+    template_url: https://lono-bucket-12di8xz5sy72z.s3.us-west-2.amazonaws.com/dev/output/demo/template.yml
+    Waiting for stack to complete
+    05:07:26AM CREATE_IN_PROGRESS AWS::CloudFormation::Stack demo-dev User Initiated
+    05:07:30AM CREATE_IN_PROGRESS AWS::S3::Bucket Bucket
+    05:07:31AM CREATE_IN_PROGRESS AWS::S3::Bucket Bucket Resource creation Initiated
+    05:07:52AM CREATE_COMPLETE AWS::S3::Bucket Bucket
+    05:07:53AM CREATE_COMPLETE AWS::CloudFormation::Stack demo-dev
+    Stack success status: CREATE_COMPLETE
+    Time took: 30s.
+    Create demo-dev stack.
+    $

data/lib/lono/{help → cli/help}/user_data.md

@@ -16,12 +16,12 @@ Script:
 Running `lono user_data bootstrap` produces:
 
     $ lono user_data bootstrap
-    Detected app/scripts
-    Tarballing app/scripts folder to scripts.tgz
+    Detected scripts
+    Tarballing scripts folder to scripts.tgz
     => cd app && dot_clean .
     => cd app && tar -c scripts | gzip -n > scripts.tgz
     Tarball created at output/scripts/scripts-93b8b29b.tgz
-    Generating user_data for 'bootstrap' at ./app/user_data/bootstrap.sh
+    Building user_data for 'bootstrap' at ./app/user_data/bootstrap.sh
     #!/bin/bash -exu
 
     # Generated from the lono extract_scripts helper.

data/lib/lono/cli/help.rb

@@ -0,0 +1,56 @@
+class Lono::CLI
+  module Help
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def main_commands
+        %w[
+          build
+          down
+          list
+          new
+          plan
+          seed
+          show
+          up
+        ]
+      end
+
+      def help(shell, subcommand)
+        list = printable_commands(true, subcommand)
+        list.sort! { |a, b| a[0] <=> b[0] }
+        filter = Proc.new do |command, desc|
+          main_commands.detect { |name| command =~ Regexp.new("^lono #{name}") }
+        end
+        main = list.select(&filter)
+        other = list.reject(&filter)
+
+        shell.say <<~EOL
+          Usage: lono COMMAND [args]
+          The available commands are listed below.
+          The primary workflow commands are given first, followed by
+          less common or more advanced commands.
+        EOL
+        shell.say "\nMain Commands:\n\n"
+        shell.print_table(main, :indent => 2, :truncate => true)
+        shell.say "\nOther Commands:\n\n"
+        shell.print_table(other, :indent => 2, :truncate => true)
+        shell.say <<~EOL
+
+          For more help on each command, you can use the -h option. Example:
+
+              lono up -h
+
+          CLI Reference also available at: https://lono.cloud/reference/
+        EOL
+      end
+    end
+
+    def text(namespaced_command)
+      path = namespaced_command.to_s.gsub(':','/')
+      path = File.expand_path("../help/#{path}.md", __FILE__)
+      IO.read(path) if File.exist?(path)
+    end
+    extend self
+  end
+end

data/lib/lono/cli/list.rb

@@ -0,0 +1,25 @@
+class Lono::CLI
+  class List < Base
+    attr_reader :options
+    def initialize(options={})
+      @options = options
+    end
+
+    def run
+      list_type("blueprints") if show?("blueprint")
+      list_type("configsets") if show?("configset")
+      list_type("extensions") if show?("extension")
+    end
+
+  private
+    def list_type(type)
+      Dir.glob("#{Lono.root}/{app,vendor}/#{type}/*").each do |path|
+        logger.info pretty_path(path)
+      end
+    end
+
+    def show?(type)
+      @options[:type] == type || @options[:type].nil? || @options[:type] == "all"
+    end
+  end
+end

data/lib/lono/cli/new/blueprint.rb

@@ -0,0 +1,29 @@
+class Lono::CLI::New
+  class Blueprint < Sequence
+    argument :name
+    def self.cli_options
+      [
+        [:examples, type: :boolean, desc: "Whether not to generate examples"],
+        [:force, type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files"],
+        [:project, desc: "Project name"],
+      ]
+    end
+    cli_options.each do |args|
+      class_option(*args)
+    end
+
+    def set_source
+      if @options[:examples]
+        set_template_source "examples/blueprint"
+      else
+        set_template_source "blueprint"
+      end
+    end
+
+    def create_blueprint
+      logger.info "=> Creating new blueprint called #{name}."
+      dest = [@options[:project], "app/blueprints"].compact.join('/')
+      directory ".", "#{dest}/#{name}"
+    end
+  end
+end

data/lib/lono/cli/new/concerns.rb

@@ -0,0 +1,16 @@
+class Lono::CLI::New
+  module Concerns
+    extend ActiveSupport::Concern
+
+  private
+    def class_name
+      name.underscore.camelize
+    end
+
+    # Files should be named with underscores instead of dashes even though project name can contain a dash.
+    # This is because autoloading works with underscores in the filenames only.
+    def underscore_name
+      name.underscore
+    end
+  end
+end