lono 7.5.1 → 8.0.0.pre.rc2

data/lib/lono/names.rb

@@ -0,0 +1,50 @@
+module Lono
+  class Names
+    extend Memoist
+
+    attr_reader :blueprint
+    def initialize(options={})
+      @options = options
+      @blueprint = options[:blueprint]
+    end
+
+    def stack
+      expansion(Lono.config.names.stack)
+    end
+    memoize :stack
+
+    def expansion(string)
+      return string unless string.is_a?(String) # in case of nil
+
+      string = string.dup
+      vars = string.scan(/:\w+/) # => [":APP", ":BLUEPRINT", :ENV"]
+      vars.each do |var|
+        string.gsub!(var, var_value(var))
+      end
+      strip(string)
+    end
+
+    def var_value(unexpanded)
+      name = unexpanded.sub(':','').downcase
+      if respond_to?(name)
+        value = send(name).to_s
+      else
+        unexpanded
+      end
+    end
+
+    def strip(string)
+      string.sub(/^-+/,'').sub(/-+$/,'') # remove leading and trailing -
+            .gsub(%r{-+},'-') # remove double dashes are more. IE: -- => -
+            .gsub('_','-')    # underscores are not allowed in CloudFormation stack names
+    end
+
+    def app
+      Lono.app
+    end
+
+    def env
+      Lono.env
+    end
+  end
+end

data/lib/lono/plugin/meta.rb

@@ -0,0 +1,30 @@
+class Lono::Plugin
+  module Meta
+    extend ActiveSupport::Concern
+
+    included do
+      cattr_accessor :meta, default: []
+    end
+
+    class_methods do
+      def register(o={})
+        found = meta.find { |m| m[:name] == o[:name] && m[:type] == o[:type] }
+        meta << o unless found
+      end
+
+      def find(o={})
+        found = meta.find { |m| m[:name] == o[:name] && m[:type] == o[:type] }
+        Lono::Plugin.new(found) if found
+      end
+
+      def delegate_to_meta(*attrs)
+        attrs.each do |attr|
+          attr = attr.to_sym
+          define_method attr do
+            @options[attr]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lono/plugin/tester.rb

@@ -0,0 +1,13 @@
+class Lono::Plugin
+  class Tester
+    class << self
+      def register(name, options={})
+        Lono::Plugin.register(
+          name: name,
+          type: "test_framework",
+          root: options[:root],
+        )
+      end
+    end
+  end
+end

data/lib/lono/plugin.rb

@@ -0,0 +1,10 @@
+module Lono
+  class Plugin
+    include Meta
+    delegate_to_meta :name, :root
+
+    def initialize(options={})
+      @options = options
+    end
+  end
+end

data/lib/lono/s3/aws_setup.rb

@@ -1,12 +1,13 @@
-class Lono::S3
+module Lono::S3
   class AwsSetup
     include Lono::AwsServices
+    include Lono::Utils::Logging
 
     def check!
       s3.config.region
     rescue Aws::Errors::MissingRegionError => e
-      puts "ERROR: #{e.class}: #{e.message}".color(:red)
-      puts <<~EOL
+      logger.info "ERROR: #{e.class}: #{e.message}".color(:red)
+      logger.info <<~EOL
         Unable to detect the AWS_REGION to make AWS API calls. This is might be because the AWS access
         has not been set up yet. Please either your ~/.aws files.
       EOL

data/lib/lono/s3/bucket.rb

@@ -1,41 +1,23 @@
-class Lono::S3
+module Lono::S3
   class Bucket
-    STACK_NAME = ENV['LONO_STACK_NAME'] || "lono"
     include Lono::AwsServices
+    include Lono::Cfn::Concerns
+    include Lono::Utils::Logging
     extend Lono::AwsServices
     extend Memoist
 
-    class << self
-      @@name = nil
-      def name
-        return @@name if @@name # only memoize once bucket has been created
-
-        check_aws_setup!
-
-        stack = new.find_stack
-        return unless stack
-
-        resp = cfn.describe_stack_resources(stack_name: STACK_NAME)
-        bucket = resp.stack_resources.find { |r| r.logical_resource_id == "Bucket" }
-        @@name = bucket.physical_resource_id # actual bucket name
-      end
-
-      def check_aws_setup!
-        AwsSetup.new.check!
-      end
-    end
-
+    STACK_NAME = ENV['LONO_STACK_NAME'] || "lono"
     def initialize(options={})
       @options = options
     end
 
     def deploy
       stack = find_stack
-      if rollback_complete?(stack)
-        puts "Existing '#{STACK_NAME}' stack in ROLLBACK_COMPLETE state. Deleting stack before continuing."
+      if rollback.complete?
+        logger.info "Existing '#{STACK_NAME}' stack in ROLLBACK_COMPLETE state. Deleting stack before continuing."
+        disable_termination_protection
         cfn.delete_stack(stack_name: STACK_NAME)
         status.wait
-        status.reset
         stack = nil
       end
 
@@ -56,30 +38,29 @@ class Lono::S3
 
     def show
       if bucket_name
-        puts "Lono bucket name: #{bucket_name}"
+        logger.info "Lono bucket name: #{bucket_name}"
       else
-        puts "Lono bucket does not exist yet."
+        logger.info "Lono bucket does not exist yet."
       end
     end
 
     # Launches a cloudformation to create an s3 bucket
     def create
-      puts "Creating #{STACK_NAME} stack with the s3 bucket"
+      logger.info "Creating #{STACK_NAME} stack for s3 bucket to store templates"
       cfn.create_stack(
         stack_name: STACK_NAME,
         template_body: template_body,
         enable_termination_protection: true,
       )
       success = status.wait
-      status.reset
       unless success
-        puts "ERROR: Unable to create lono stack with managed s3 bucket".color(:red)
+        logger.info "ERROR: Unable to create lono stack with managed s3 bucket".color(:red)
         exit 1
       end
     end
 
     def update
-      puts "Updating #{STACK_NAME} stack with the s3 bucket"
+      logger.info "Updating #{STACK_NAME} stack with the s3 bucket"
       cfn.update_stack(stack_name: STACK_NAME, template_body: template_body)
     rescue Aws::CloudFormation::Errors::ValidationError => e
       raise unless e.message.include?("No updates are to be performed")
@@ -88,13 +69,13 @@ class Lono::S3
     def delete
       are_you_sure?
 
-      puts "Deleting #{STACK_NAME} stack with the s3 bucket"
-      disable_termination_protect
+      logger.info "Deleting #{STACK_NAME} stack with the s3 bucket"
+      disable_termination_protection
       empty_bucket!
       cfn.delete_stack(stack_name: STACK_NAME)
     end
 
-    def disable_termination_protect
+    def disable_termination_protection
       cfn.update_termination_protection(
         stack_name: STACK_NAME,
         enable_termination_protection: false,
@@ -111,7 +92,6 @@ class Lono::S3
     def status
       CfnStatus.new(STACK_NAME)
     end
-    memoize :status
 
   private
 
@@ -135,18 +115,18 @@ class Lono::S3
 
 
     def are_you_sure?
-      return true if @options[:sure]
+      return true if @options[:yes]
 
       if bucket_name.nil?
-        puts "The lono stack and s3 bucket does not exist."
+        logger.info "The lono stack and s3 bucket does not exist."
         exit
       end
 
-      puts "Are you sure you want the lono bucket #{bucket_name.color(:green)} to be emptied and deleted? (y/N)"
-      sure = $stdin.gets.strip
-      yes = sure =~ /^Y/i
-      unless yes
-        puts "Phew that was close."
+      logger.info "Are you yes you want the lono bucket #{bucket_name.color(:green)} to be emptied and deleted? (y/N)"
+      yes = $stdin.gets.strip
+      confirmed = yes =~ /^Y/i
+      unless confirmed
+        logger.info "Phew that was close."
         exit
       end
     end
@@ -167,5 +147,25 @@ class Lono::S3
                   Value: lono
       YAML
     end
+
+    def rollback
+      Rollback.new(STACK_NAME)
+    end
+
+    class << self
+      @@name = nil
+      def name
+        return @@name if @@name # only memoize once bucket has been created
+
+        AwsSetup.new.check!
+
+        stack = new.find_stack
+        return unless stack
+
+        stack_resources = find_stack_resources(STACK_NAME)
+        bucket = stack_resources.find { |r| r.logical_resource_id == "Bucket" }
+        @@name = bucket.physical_resource_id # actual bucket name
+      end
+    end
   end
 end

data/lib/lono/s3/rollback.rb

@@ -0,0 +1,8 @@
+module Lono::S3
+  class Rollback < Lono::Cfn::Deploy::Rollback
+    # override initialize
+    def initialize(stack)
+      @stack = stack
+    end
+  end
+end

data/lib/lono/s3/uploader.rb

@@ -1,7 +1,8 @@
-class Lono::S3
+module Lono::S3
   class Uploader
-    include Lono::AwsServices
     extend Memoist
+    include Lono::AwsServices
+    include Lono::Utils::Logging
 
     attr_reader :path
     def initialize(path, options={})
@@ -14,33 +15,30 @@ class Lono::S3
     #   path: can be full path or relative path
     #
     def upload
-      return if @options[:noop] || ENV['LONO_TEST'] == '1'
-
       path = @path.gsub("#{Lono.root}/",'') # remove Lono.root
       key = "#{Lono.env}/#{path}"
 
       pretty_path = path.sub(/^\.\//, '')
-      s3_full_path = "s3://#{s3_bucket}/#{key}"
+      s3_path = "s3://#{s3_bucket}/#{key}"
 
-      local_checksum = Digest::MD5.hexdigest(IO.read(path))
+      local_checksum = Digest::MD5.hexdigest(IO.read(@path))
       remote_checksum = remote_checksum(key)
       if local_checksum == remote_checksum
-        puts("Not modified: #{pretty_path} to #{s3_full_path}".color(:yellow)) unless @options[:noop]
+        logger.debug "Not modified: #{pretty_path} to #{s3_path}"
         return # do not upload unless the checksum has changed
       else
         # Example output:
         # Uploaded: app/files/docker.yml to s3://boltops-dev/s3_folder/templates/development/docker.yml
         # Uploaded: app/files/ecs/private.yml to s3://boltops-dev/s3_folder/templates/development/ecs/private.yml
-        message = "Uploading: #{pretty_path} to #{s3_full_path}".color(:green)
-        message = "NOOP: #{message}" if @options[:noop]
-        puts message
+        message = "Uploading #{pretty_path} to #{s3_path}"
+        logger.debug message
       end
 
       s3.put_object(
-        body: IO.read(path),
+        body: IO.read(@path),
         bucket: s3_bucket,
         key: key,
-      ) unless @options[:noop]
+      )
     end
 
     # https://s3.amazonaws.com/mybucket/development/output/blueprint/templates/blueprint.yml

data/lib/lono/script/base.rb

@@ -1,5 +1,5 @@
-class Lono::Script
-  class Base < Lono::AbstractBase
-    SCRIPTS_INFO_PATH = "#{Lono.config.output_path}/data/scripts_info.txt"
+module Lono::Script
+  class Base < Lono::CLI::Base
+    SCRIPTS_INFO_PATH = "#{Lono.root}/output/data/scripts_info.txt"
   end
 end

data/lib/lono/script/build.rb

@@ -1,7 +1,7 @@
 require "digest"
 require "fileutils"
 
-class Lono::Script
+module Lono::Script
   class Build < Base
     # Only avaialble after script has been built.
     def self.scripts_name
@@ -9,18 +9,17 @@ class Lono::Script
     end
 
     def run
-      Lono::ProjectChecker.check
       reset
-      if Dir["#{Lono.blueprint_root}/app/scripts/*"].empty?
+      if Dir["#{@blueprint.root}/scripts/*"].empty?
         return
       else
-        puts "Detected app/scripts for blueprint #{@blueprint}"
+        logger.info "Detected scripts"
       end
 
-      puts "Tarballing app/scripts folder to scripts.tgz"
+      logger.info "Tarballing scripts folder to scripts.tgz"
       tarball_path = create_tarball
       save_scripts_info(tarball_path)
-      puts "Tarball created at #{tarball_path}"
+      logger.info "Tarball created at #{tarball_path}"
     end
 
     # Only avaialble after script has been built.
@@ -35,12 +34,12 @@ class Lono::Script
     def create_tarball
       # https://apple.stackexchange.com/questions/14980/why-are-dot-underscore-files-created-and-how-can-i-avoid-them
       # using system to avoid displaying command
-      system "cd #{Lono.blueprint_root}/app && dot_clean ." if system("type dot_clean > /dev/null 2>&1")
+      system "cd #{@blueprint.root} && dot_clean ." if system("type dot_clean > /dev/null 2>&1")
 
       # https://serverfault.com/questions/110208/different-md5sums-for-same-tar-contents
       # Using tar czf directly results in a new m5sum each time because the gzip
       # timestamp is included.  So using:  tar -c ... | gzip -n
-      sh "cd #{Lono.blueprint_root}/app && tar -c scripts | gzip -n > scripts.tgz" # temporary app/scripts.tgz file
+      sh "cd #{@blueprint.root} && tar -c scripts | gzip -n > scripts.tgz" # temporary scripts.tgz file
 
       rename_with_md5!
     end
@@ -48,9 +47,9 @@ class Lono::Script
     # Apppend a md5 to file after it's been created and moves it to
     # output/scripts/scripts-[MD5].tgz
     def rename_with_md5!
-      md5_path = "output/#{@blueprint}/scripts/scripts-#{md5sum}.tgz"
+      md5_path = "output/#{@blueprint.name}/scripts/scripts-#{md5sum}.tgz"
       FileUtils.mkdir_p(File.dirname(md5_path))
-      FileUtils.mv("#{Lono.blueprint_root}/app/scripts.tgz", md5_path)
+      FileUtils.mv("#{@blueprint.root}/scripts.tgz", md5_path)
       md5_path
     end
 
@@ -61,11 +60,11 @@ class Lono::Script
 
     # cache this because the file will get removed
     def md5sum
-      @md5sum ||= Digest::MD5.file("#{Lono.blueprint_root}/app/scripts.tgz").to_s[0..7]
+      @md5sum ||= Digest::MD5.file("#{@blueprint.root}/scripts.tgz").to_s[0..7]
     end
 
     def sh(command)
-      puts "=> #{command}"
+      logger.info "=> #{command}"
       system command
     end
 

data/lib/lono/script/upload.rb

@@ -1,25 +1,25 @@
 require "filesize"
 
-class Lono::Script
+module Lono::Script
   class Upload < Base
     include Lono::AwsServices
-    include Lono::Utils::PrettyTime
+    include Lono::Utils::Pretty
+    include Lono::Utils::Logging
 
     def run
-      Lono::ProjectChecker.check
       return unless scripts_built?
 
       upload(tarball_path)
-      puts "Uploaded #{File.basename(s3_dest)} to s3."
+      logger.info "Uploaded #{File.basename(s3_dest)} to s3."
     end
 
     def upload(tarball_path)
-      puts "Uploading scripts.tgz (#{filesize}) to #{s3_dest}"
+      logger.info "Uploading scripts.tgz (#{filesize}) to #{s3_dest}"
       obj = s3_resource.bucket(bucket_name).object(key)
       start_time = Time.now
       obj.upload_file(tarball_path)
       time_took = pretty_time(Time.now-start_time).color(:green)
-      puts "Time took to upload code to s3: #{time_took}"
+      logger.info "Time took to upload code to s3: #{time_took}"
     end
 
     def filesize
@@ -43,7 +43,7 @@ class Lono::Script
       "#{Lono.env}/scripts"
     end
 
-    # Scripts are only built if the app/scripts folder is non empty
+    # Scripts are only built if the scripts folder is non empty
     def scripts_built?
       File.exist?(SCRIPTS_INFO_PATH) && !tarball_path.empty?
     end

data/lib/lono/{seed → seeder}/service_role.rb

@@ -1,4 +1,4 @@
-class Lono::Seed
+class Lono::Seeder
   module ServiceRole
     def create_service_linked_role(aws_service_name)
       iam.create_service_linked_role(

data/lib/lono/{seed/base.rb → seeder.rb}

@@ -3,17 +3,10 @@ require "memoist"
 require "thor"
 require "yaml"
 
-# Subclasses should implement:
-#
-#   variables - Returns String with content of varibles files.
-#   setup - Hook to do extra things like create IAM service roles.
-#   finish - Finish hook after config files have been created.
-#
-# Note there is no params method to hook. The Base class handles params well.
-#
-class Lono::Seed
-  class Base < Lono::AbstractBase
+module Lono
+  class Seeder < Lono::CLI::Base
     include Lono::AwsServices
+    include Lono::Cfn::Concerns::TemplateOutput
     include ServiceRole
 
     # What's needed for a Thor::Group or "Sequence"
@@ -28,33 +21,29 @@ class Lono::Seed
     extend Memoist
 
     def run
-      generate_template
-      setup
+      build_template
       self.destination_root = Dir.pwd # Thor::Actions require destination_root to be set
       create_params
       create_variables
-      finish
     end
 
-    def generate_template
-      Lono::Template::Generator.new(@options).run
+    def build_template
+      Lono::Builder::Template.new(@options).run
     end
 
     def create_params
-      return unless params
       create_param_file
     end
 
     def create_param_file
-      @output_template = Lono::Output::Template.new(@blueprint, @template)
-      if @output_template.parameters.empty?
-        puts "Template has no parameters."
+      if template_output.parameters.empty?
+        logger.info "Template has no parameters."
         return
       end
 
       # Generate by parameter group first
       lines, shown = [], []
-      @output_template.parameter_groups.each do |label, parameters|
+      template_output.parameter_groups.each do |label, parameters|
         lines << "# Parameter Group: #{label}"
         parameters.each do |name|
           parameter_line = parameter_line(name)
@@ -62,20 +51,20 @@ class Lono::Seed
           shown << name
         end
         lines << ""
-      end if @output_template.parameter_groups
+      end if template_output.parameter_groups
 
       # Then generate the rest
-      @output_template.parameters.each do |name, data|
+      template_output.parameters.each do |name, data|
         lines << parameter_line(name) unless shown.include?(name)
       end
 
       content = lines.join("\n")
-      dest_path = "configs/#{@blueprint}/params/#{Lono.env}.txt" # only support environment level parameters for now
+      dest_path = "#{dest_folder}/params/#{Lono.env}.txt" # only support environment level parameters for now
       create_file(dest_path, content) # Thor::Action
     end
 
     def parameter_line(name)
-      data = @output_template.parameters[name]
+      data = template_output.parameters[name]
       example = description_example(data["Description"])
       if data["Default"].nil?
         line = "#{name}=#{example} # (required)"
@@ -94,23 +83,37 @@ class Lono::Seed
       md[2]
     end
 
-    def params
-      true
+    def self.source_root
+      Lono.root
     end
 
     def create_variables
-      return unless variables
-      dest_path = "configs/#{@blueprint}/variables/#{Lono.env}.rb"
-      create_file(dest_path, variables) # Thor::Action
+      src = "#{@blueprint.root}/seed/vars"
+      dest = "#{dest_folder}/vars"
+      directory(src, dest) if File.exist?(src)
     end
 
-    def setup; end
-    def finish; end
+    # config structure:
+    #
+    #   config/blueprints/demo
+    #
+    # general structure:
+    #
+    #   app/blueprints/demo/config
+    #   vendor/blueprints/demo/config
+    #
+    def dest_folder
+      where = @options[:where] || Lono.config.seed.where
+      if where == "config"
+        "#{Lono.root}/config/blueprints/#{@blueprint.name}"
+      else # app or vendor
+        "#{Lono.root}/#{where}/blueprints/#{@blueprint.name}/config"
+      end
+    end
 
-    # Meant to be overriden by subclass
-    # Return String with contents of variables file.
-    def variables
-      false
+  private
+    def env
+      Lono.env # allows for seed/vars/%env%.rb.tt
     end
   end
 end

data/lib/lono/user_data.rb

@@ -1,11 +1,11 @@
 module Lono
   # This class is not use by lono internally. It is really only meant to be
-  # exposed to the lono userdata command so users can debug their generated
-  # app/user_data scripts. It is useful for debugging.
+  # exposed to the lono user_data command so users can debug their generated
+  # user_data scripts. It is useful for debugging.
   #
-  # Normally, the Lono::Erb#run method generates the CloudFormation templates
+  # Normally, the Lono::Erb#run method generates the CloudFormation template
   # and embeds user-data script into the template.
-  class UserData < AbstractBase
+  class UserData < Lono::CLI::Base
     def initialize(options={})
       super
       @name = options[:name]
@@ -13,19 +13,14 @@ module Lono
     end
 
     def generate
-      puts "Generating user_data for '#{@name}' at #{@path}"
+      pretty_path = pretty_path(@path)
+      logger.info "Building user_data for '#{@name}' at #{pretty_path}"
       if File.exist?(@path)
-        puts RenderMePretty.result(@path, context: context)
+        logger.info RenderMePretty.result(@path, context: template_context)
       else
-        puts "ERROR: #{@path} does not exist".color(:red)
+        logger.info "ERROR: #{pretty_path} does not exist".color(:red)
         exit 1
       end
     end
-
-    # 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)
-    end
   end
 end

data/lib/lono/utils/contexts.rb

@@ -0,0 +1,15 @@
+module Lono::Utils
+  module Contexts
+    extend Memoist
+
+    def template_context
+      Lono::Builder::Context::Template.new(@options)
+    end
+    memoize :template_context
+
+    def params_context
+      Lono::Builder::Context::Params.new(@options)
+    end
+    memoize :params_context
+  end
+end