lono 5.1.1 → 5.2.0

data/lib/lono/seed.rb

@@ -1,37 +1,48 @@
-require "fileutils"
-
 module Lono
   class Seed
-    include Blueprint::Root
+    include Lono::Blueprint::Root
+    include Lono::Conventions
 
-    def initialize(blueprint, options)
+    def initialize(blueprint, options={})
       @blueprint, @options = blueprint, options
-      @args = options[:args] # hash
+      set_blueprint_root(@blueprint)
+      @template, @param = template_param_convention(options)
     end
 
-    def run
-      blueprint_root = find_blueprint_root(@blueprint)
-      unless blueprint_root
-        puts "ERROR: Did not find blueprint: #{@blueprint}".color(:red)
-        puts "Are you sure you specified the right blueprint?"
-        Blueprint::List.available
-        exit 1
-      end
+    def create
+      puts "Creating starter config files for #{@blueprint}"
+      configs_class = load_configs_class # ::Configs or Lono::Seed::Base
+      configs = configs_class.new(@blueprint, @options)
+      # The Configs class implements: variables
+      configs.run # setup the instance variables
+    end
 
+  private
+    def load_configs_class
+      blueprint_root = find_blueprint_root(@blueprint)
       configs_path = "#{blueprint_root}/seed/configs.rb"
-      unless File.exist?(configs_path)
-        puts "No #{configs_path} file found.  Nothing to configure."
-        exit
+
+      begin
+        loaded = load configs_path
+      rescue LoadError
+        loaded = false
       end
 
-      require configs_path
-      unless defined?(Configs)
-        puts "Configs class not found.\nAre you sure #{configs_path} contains a Configs class?"
-        exit 1
+      if loaded
+        if defined?(Lono::Seed::Configs)
+          configs_class = Lono::Seed::Configs # blueprint specific Configs
+        else
+          puts <<~EOL
+            Lono::Seed::Configs class not found.
+            Are you sure #{configs_path} contains a Lono::Seed::Configs class?
+          EOL
+          exit 1
+        end
+      else
+        configs_class = Lono::Seed::Base # Generic handling
       end
-      configs = Configs.new(@blueprint, @options)
-      # The Configs class implements: seed, params, and variables
-      configs.run # setup the instance variables
+
+      configs_class
     end
   end
-end
+end

data/lib/lono/template/dsl/builder/helper.rb

@@ -28,19 +28,27 @@ class Lono::Template::Dsl::Builder
       }
     end
 
+    def content(path)
+      render_file(Lono.config.content_path, path)
+    end
+
     def user_data(path)
-      path = "#{Lono.config.user_data_path}/#{path}"
+      render_file(Lono.config.user_data_path, path)
+    end
+
+    def render_file(folder, path)
+      path = "#{folder}/#{path}"
       if File.exist?(path)
         render_path(path)
       else
-        message = "WARNING: user-data path #{path} not found"
+        message = "WARNING: path #{path} not found"
         puts message.color(:yellow)
         puts "Called from:"
-        puts caller[1]
+        puts caller[2]
         message
       end
     end
-    memoize :user_data
+    memoize :render_file
 
     def render_path(path)
       RenderMePretty.result(path, context: self)

data/lib/lono/template/dsl/builder.rb

@@ -7,6 +7,7 @@ class Lono::Template::Dsl
     include Helper # built-in helpers
     include Lono::Template::Evaluate
     include Syntax
+    extend Memoist
 
     def initialize(path, blueprint, options={})
       @path, @blueprint, @options = path, blueprint, options
@@ -16,11 +17,20 @@ class Lono::Template::Dsl
 
     def build
       load_context
-      evaluate_template_path(@path)
+      evaluate_template_path(@path) # modifies @cfn
       build_template
       write_output
+      template
     end
 
+    # Useful for lono seed to get the template in memory
+    def template
+      load_context
+      evaluate_template_path(@path) # modifies @cfn
+      camelize(@cfn)
+    end
+    memoize :template
+
     def build_template
       @results = YAML.dump(camelize(@cfn))
     end

data/lib/lono/template.rb

@@ -1,8 +1,5 @@
-require "thor"
-require_relative "command"
-
 module Lono
-  class Template < Lono::Command
+  class Template < Command
     class_option :quiet, type: :boolean, desc: "silence the output"
     class_option :noop, type: :boolean, desc: "noop mode, do nothing destructive"
 

data/lib/lono/upgrade.rb

@@ -1,18 +1,18 @@
-require "thor"
+module Lono
+  class Upgrade < Command
+    desc "v3to4", "Upgrade from version 3 to 4."
+    def v3to4
+      Upgrade4.new(options).run
+    end
 
-class Lono::Upgrade < Lono::Command
-  desc "v3to4", "Upgrade from version 3 to 4."
-  def v3to4
-    Upgrade4.new(options).run
-  end
-
-  desc "v4to4_2", "Upgrade from version 4.0 to 4.2"
-  def v4to4_2
-    Upgrade42.start
-  end
+    desc "v4to4_2", "Upgrade from version 4.0 to 4.2"
+    def v4to4_2
+      Upgrade42.start
+    end
 
-  desc "v4to5", "Upgrade from version 4.2 to 5.0"
-  def v4to5
-    Upgrade5.start
+    desc "v4to5", "Upgrade from version 4.2 to 5.0"
+    def v4to5
+      Upgrade5.start
+    end
   end
 end

data/lib/lono/version.rb

@@ -1,3 +1,3 @@
 module Lono
-  VERSION = "5.1.1"
+  VERSION = "5.2.0"
 end

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

@@ -1,54 +1,28 @@
-# This class is used by `lono seed [blueprint]` to create starter config files.
+# This is an optional class is used by `lono seed [blueprint]` to create starter configs.
 # Example files that get created:
 #
-# Variables:
+#    configs/BLUEPRINT/params/LONO_ENV.txt
+#    configs/BLUEPRINT/variables/LONO_ENV.rb
 #
-#    configs/[blueprint]/variables/[Lono.env].rb
+# The `Lono::Seed::Configs` class should implement:
 #
-# 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
+#   setup: Hook to perform logic at the beginning. A good place to create IAM service roles.
 #   variables: Template for generated variables file. Contents of what gets created at
 #     configs/[blueprint]/variables/development.rb
 #
-class Configs < Lono::Configure::Base
+# Note: There is no need to define a params method. Lono is able to generate a params config starter file by evaluating the template defintion.
+#
+class Lono::Seed::Configs < Lono::Seed::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
+  # def setup
+  # end
 
-  # Template for variables
+  # Template for variables.
+  # Return String with the content of the config/BLUEPRINT/variables file.
   # def variables
   #   <<~EOL
   #     @variable1=starter_value1
   #     @variable2=starter_value2
   #   EOL
   # end
-
-private
-  # Example:
-  # def set_instance_variables
-  #   @instance_type = "t3.micro"
-  # end
 end

data/lono.gemspec

@@ -47,6 +47,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "cli_markdown"
   gem.add_development_dependency "guard-bundler"
   gem.add_development_dependency "guard-rspec"
+  gem.add_development_dependency "lono-pro"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec"
 end

data/vendor/cfn-status/lib/cfn/aws_service.rb

@@ -45,7 +45,7 @@ module Cfn
     end
 
     def rollback_complete?(stack)
-      stack.stack_status == 'ROLLBACK_COMPLETE'
+      stack&.stack_status == 'ROLLBACK_COMPLETE'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lono
 version: !ruby/object:Gem::Version
-  version: 5.1.1
+  version: 5.2.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-09 00:00:00.000000000 Z
+date: 2019-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -360,6 +360,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: lono-pro
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -433,8 +447,8 @@ files:
 - lib/lono/blueprint/new.rb
 - lib/lono/blueprint/root.rb
 - lib/lono/cfn.rb
-- lib/lono/cfn/aws_service.rb
 - lib/lono/cfn/base.rb
+- lib/lono/cfn/cancel.rb
 - lib/lono/cfn/create.rb
 - lib/lono/cfn/current.rb
 - lib/lono/cfn/delete.rb
@@ -454,9 +468,6 @@ files:
 - lib/lono/completer/script.rb
 - lib/lono/completer/script.sh
 - lib/lono/completion.rb
-- lib/lono/configure/aws_services.rb
-- lib/lono/configure/base.rb
-- lib/lono/configure/helpers.rb
 - lib/lono/conventions.rb
 - lib/lono/core.rb
 - lib/lono/core/config.rb
@@ -465,6 +476,7 @@ files:
 - lib/lono/help.rb
 - lib/lono/help/blueprint.md
 - lib/lono/help/cfn.md
+- lib/lono/help/cfn/cancel.md
 - lib/lono/help/cfn/create.md
 - lib/lono/help/cfn/current.md
 - lib/lono/help/cfn/delete.md
@@ -482,6 +494,7 @@ files:
 - lib/lono/help/param/generate.md
 - lib/lono/help/script/build.md
 - lib/lono/help/script/upload.md
+- lib/lono/help/seed.md
 - lib/lono/help/summary.md
 - lib/lono/help/template.md
 - lib/lono/help/template/bashify.md
@@ -506,6 +519,7 @@ files:
 - lib/lono/script/build.rb
 - lib/lono/script/upload.rb
 - lib/lono/seed.rb
+- lib/lono/seed/base.rb
 - lib/lono/sequence.rb
 - lib/lono/setting.rb
 - lib/lono/template.rb
@@ -542,7 +556,6 @@ files:
 - lib/lono/version.rb
 - lib/templates/blueprint/%blueprint_name%.gemspec.tt
 - lib/templates/blueprint/.gitignore
-- lib/templates/blueprint/.lono/config.yml.tt
 - lib/templates/blueprint/.meta/config.yml.tt
 - lib/templates/blueprint/CHANGELOG.md
 - lib/templates/blueprint/Gemfile

data/lib/lono/cfn/aws_service.rb

@@ -1,53 +0,0 @@
-require "aws-sdk-cloudformation"
-
-module Lono::Cfn::AwsService
-  def cfn
-    @cfn ||= Aws::CloudFormation::Client.new
-  end
-
-  def stack_exists?(stack_name)
-    return true if testing_update?
-    return false if @options[:noop]
-
-    exist = nil
-    begin
-      # When the stack does not exist an exception is raised. Example:
-      # Aws::CloudFormation::Errors::ValidationError: Stack with id blah does not exist
-      resp = cfn.describe_stacks(stack_name: stack_name)
-      exist = true
-    rescue Aws::CloudFormation::Errors::ValidationError => e
-      if e.message =~ /does not exist/
-        exist = false
-      elsif e.message.include?("'stackName' failed to satisfy constraint")
-        # Example of e.message when describe_stack with invalid stack name
-        # "1 validation error detected: Value 'instance_and_route53' at 'stackName' failed to satisfy constraint: Member must satisfy regular expression pattern: [a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/._+]*"
-        puts "Invalid stack name: #{stack_name}"
-        puts "Full error message: #{e.message}"
-        exit 1
-      else
-        raise # re-raise exception  because unsure what other errors can happen
-      end
-    end
-    exist
-  end
-
-  def find_stack(stack_name)
-    resp = cfn.describe_stacks(stack_name: stack_name)
-    resp.stacks.first
-  rescue Aws::CloudFormation::Errors::ValidationError => e
-    # example: Stack with id demo-web does not exist
-    if e.message =~ /Stack with/ && e.message =~ /does not exist/
-      nil
-    else
-      raise
-    end
-  end
-
-  def rollback_complete?(stack)
-    stack.stack_status == 'ROLLBACK_COMPLETE'
-  end
-
-  def testing_update?
-    ENV['TEST'] && self.class.name == "LonoCfn::Update"
-  end
-end

data/lib/lono/configure/aws_services.rb

@@ -1,18 +0,0 @@
-require "aws-sdk-ec2"
-require "aws-sdk-iam"
-
-class Lono::Configure
-  module AwsServices
-    def ec2
-      @ec2 ||= Aws::EC2::Client.new
-    end
-
-    def iam
-      @iam ||= Aws::IAM::Client.new
-    end
-
-    def sts
-      @sts ||= Aws::STS::Client.new # part of aws-sdk-core
-    end
-  end
-end

data/lib/lono/configure/base.rb

@@ -1,94 +0,0 @@
-require "fileutils"
-require "memoist"
-require "yaml"
-
-# Subclasses must implement: setup, params, variables
-class Lono::Configure
-  class Base
-    include Lono::AwsServices
-    include Helpers
-    include Lono::Conventions
-    extend Memoist
-
-    def initialize(blueprint, options)
-      @blueprint, @options = blueprint, options
-
-      @template, @param = template_param_convention(options)
-      @args = options[:args] || {} # hash
-      @args.symbolize_keys!
-
-      @written_files = []
-      puts "Setting up starter values for #{@blueprint.color(:green)} blueprint"
-    end
-
-    def run
-      setup
-      write_configs
-      finish
-      final_message
-    end
-
-    # Should be implemented in subclass
-    def setup; end
-    def params; end
-    def variables; end
-
-    # Optionally implemented in subclasses
-    def params_form
-      :short # can be short, medium, or long
-    end
-
-    def finish; end
-
-  protected
-    def params_path
-      case params_form.to_sym
-      when :short
-        "configs/#{@blueprint}/params/#{Lono.env}.txt"
-      when :medium
-        "configs/#{@blueprint}/params/#{Lono.env}/#{@param}.txt"
-      else
-        "configs/#{@blueprint}/params/#{Lono.env}/#{@template}/#{@param}.txt"
-      end
-    end
-
-    def variables_path
-      "configs/#{@blueprint}/variables/#{Lono.env}.rb"
-    end
-
-    def base_params_path
-      params_path.sub("params/#{Lono.env}", "params/base")
-    end
-
-    def base_variables_path
-      variables_path.sub("variables/#{Lono.env}", "variables/base")
-    end
-
-    def write_configs
-      @params, @variables = params, variables # so it only gets called once
-      write_file(params_path, @params) if @params
-      write_file(variables_path, @variables) if @variables
-    end
-
-  private
-
-    def write_file(path, content)
-      FileUtils.mkdir_p(File.dirname(path))
-      IO.write(path, content)
-      @written_files << path
-    end
-
-    def final_message
-      config_list = @written_files.map { |i| "  * #{i}" }.join("\n")
-
-      puts <<~EOL
-        The #{@blueprint} blueprint configs are in:
-
-        #{config_list}
-
-        The starter values are specific to your AWS account. They meant to
-        be starter values. Please take a look, you may want to adjust the values.
-      EOL
-    end
-  end
-end

data/lib/lono/configure/helpers.rb

@@ -1,128 +0,0 @@
-class Lono::Configure
-  module Helpers
-    extend Memoist
-
-    def get_input(key, default:'')
-      value = get_seed(key, default: default, load_default: @options[:defaults])
-      return value if value
-
-      default_text = default.blank? ? '' : "(default: #{default})"
-      print "Please provide value for #{key}#{default_text}: "
-      value = $stdin.gets.strip
-      value.blank? ? load_default(default) : value
-    end
-
-    # Defaults to loading the default
-    def get_seed(key, default:, load_default: true)
-      seed_value = from_seed(key)
-      if seed_value
-        puts "For #{key}, using seed value #{seed_value}"
-        return seed_value
-      end
-
-      return load_default(default) if load_default
-    end
-
-    def load_default(default)
-      if default.is_a?(Symbol)
-        send(default) # IE: default_subnet
-      else
-        default # return the default as is
-      end
-    end
-
-    def default_subnet
-      subnet_ids.first
-    end
-
-    def default_vpc_id
-      vpc = find_vpc
-      vpc.vpc_id if vpc # default vpc might have been deleted
-    end
-
-    def default_key_name
-      key_name
-    end
-
-    def from_seed(key)
-      seed[key.to_s]
-    end
-
-    def seed
-      if @options[:seed] == :convention
-        convention_path = "seeds/#{@blueprint}/#{Lono.env}.yml"
-        seed_file = convention_path
-      else
-        seed_file = @options[:seed]
-      end
-
-      unless File.exist?(seed_file)
-        puts "WARN: unable to find seed file #{seed_file}".color(:yellow) if @options[:seed] != :convention
-        return {}
-      end
-      puts "Using seed file: #{seed_file}"
-      YAML.load_file(seed_file)
-    end
-    memoize :seed
-
-    def key_name
-      resp = ec2.describe_key_pairs
-      key = resp.key_pairs.first
-
-      if key
-        key.key_name
-      else
-        "Please create a keypair and configure it here"
-      end
-    end
-
-    def aws_account
-      sts.get_caller_identity.account
-    end
-
-    def subnet_ids(vpc_id: nil, regexp: nil)
-      vpc = find_vpc(vpc_id)
-      unless vpc
-        # sometimes even default VPC has been deleted
-        abort "ERROR: Cannot find subnets because cannot find vpc #{@vpc_id} Please double check that is the right vpc".color(:red)
-      end
-
-      resp = ec2.describe_subnets(filters: [{name: 'vpc-id', values: [vpc.vpc_id]}])
-      subnets = resp.subnets # first subnet
-
-      # Assume that the subnets have a Name tag with PrivateSubnet1, PrivateSubnet2, etc
-      # This is part of the BoltOps blueprint stack.
-      selected_subnets = select_subnets(subnets, regexp)
-
-      # if cannot find selected subnets, then keep all the subnets
-      subnets = selected_subnets unless selected_subnets.empty?
-      subnets.map(&:subnet_id)
-    end
-
-    def select_subnets(subnets, regexp=nil)
-      return subnets unless regexp
-
-      subnets.select do |subnet|
-        tags = subnet.tags
-        name_tag = tags.find { |t| t.key == "Name" }
-        name_tag && name_tag.value =~ regexp
-      end
-    end
-
-    # If not vpc_id is provided, it tries to find the default vpc.
-    # If the default vpc doesnt exist, nilt is returned.
-    def find_vpc(vpc_id=nil)
-      if vpc_id
-        resp = ec2.describe_vpcs(vpc_ids: [vpc_id])
-      else
-        resp = ec2.describe_vpcs(filters: [{name: "isDefault", values: ["true"]}])
-      end
-
-      vpcs = resp.vpcs
-      vpcs.first
-    rescue Aws::EC2::Errors::InvalidVpcIDNotFound
-      nil
-    end
-    memoize :find_vpc
-  end
-end

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

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