lono 3.5.0 → 4.0.0

data/lib/lono/project_checker.rb

@@ -1,46 +1,41 @@
-class Lono::ProjectChecker
-    # Checks to see command is running in a lono project.
-  # If not, provide a friendly message and exit.
-  def self.check
-    new.check
-  end
-
-  def check
-    config_folder_exist
-    templates_folder_exist
-    empty_folders
-  end
+# frozen_string_literal: true
+module Lono
+  # Checks to see command is running in a lono project.
+  # If not, provide a friendly message and possibly exit.
+  class ProjectChecker
+    class << self
+      def check
+        check_lono_project
+      end
 
-  def config_folder_exist
-    unless File.exist?("#{Lono.root}/config")
-      puts "The config folder does not exist in this project.  Are you sure this is a lono project?"
-      quit
-    end
-  end
+      def check_lono_project
+        paths = %w[
+          config/settings.yml
+          app/definitions
+          app/templates
+        ]
+        paths.each do |path|
+          unless File.exist?("#{Lono.root}/#{path}")
+            puts "ERROR: The #{path} does not exist in this project.  Are you sure you are in lono project?".colorize(:red)
+            quit 1
+          end
+        end
+      end
 
-  def templates_folder_exist
-    unless File.exist?("#{Lono.root}/templates")
-      puts "The templates folder does not exist in this project.  Are you sure this is a lono project?"
-      quit
-    end
-  end
-
-  def empty_folders
-    if Dir["#{Lono.root}/config/**/*.rb"].empty?
-      puts "The config folder does not contain any lono template definitions."
-      quit
-    end
-    if Dir["#{Lono.root}/templates/**/*"].empty?
-      puts "The templates folder does not contain any lono template definitions."
-      quit
-    end
-  end
+      # Dont exit for this one. It's okay. But show a warning.
+      def empty_templates
+        if Dir["#{Lono.config.templates_path}/**/*"].empty?
+          puts "INFO: The app/templates folder does not contain any lono template definitions.".colorize(:yellow)
+        end
+      end
 
-  def quit
-    if ENV['TEST'] == '1'
-      raise("Not in lono project")
-    else
-      exit 1
+      def quit(signal)
+        if ENV['TEST'] == '1'
+          signal == 0 || raise("Not in lono project")
+        else
+          exit(signal)
+        end
+      end
     end
   end
 end

data/lib/lono/script.rb

@@ -0,0 +1,19 @@
+module Lono
+  class Script < Command
+    autoload :Base, "lono/script/base"
+    autoload :Build, "lono/script/build"
+    autoload :Upload, "lono/script/upload"
+
+    desc "build", "Builds output/scripts/scripts-md5sum.tgz from app/script folder"
+    long_desc Help.text("script/build")
+    def build
+      Build.new(options).run
+    end
+
+    desc "upload", "Uploads output/scripts/scripts-md5sum.tgz to s3"
+    long_desc Help.text("script/upload")
+    def upload
+      Upload.new(options).run
+    end
+  end
+end

data/lib/lono/script/base.rb

@@ -0,0 +1,9 @@
+class Lono::Script
+  class Base
+    SCRIPTS_INFO_PATH = "#{Lono.config.output_path}/data/scripts_info.txt"
+
+    def initialize(options = {})
+      @options = options
+    end
+  end
+end

data/lib/lono/script/build.rb

@@ -0,0 +1,73 @@
+require "digest"
+require "fileutils"
+
+class Lono::Script
+  class Build < Base
+    # Only avaialble after script has been built.
+    def self.scripts_name
+      new.scripts_name
+    end
+
+    def run
+      Lono::ProjectChecker.check
+      reset
+      if Dir["#{Lono.root}/app/scripts/*"].empty?
+        puts "No detected app/scripts"
+        return
+      else
+        puts "Detected app/scripts"
+      end
+
+      puts "Tarballing app/scripts folder to scripts.tgz"
+      tarball_path = create_tarball
+      save_scripts_info(tarball_path)
+      puts "Tarball created at #{tarball_path}"
+    end
+
+    # Only avaialble after script has been built.
+    def scripts_name
+      IO.read(SCRIPTS_INFO_PATH).strip
+    end
+
+    def reset
+      FileUtils.rm_f(SCRIPTS_INFO_PATH)
+    end
+
+    def create_tarball
+      # https://apple.stackexchange.com/questions/14980/why-are-dot-underscore-files-created-and-how-can-i-avoid-them
+      sh "cd app && dot_clean ." if system("type dot_clean > /dev/null")
+
+      # 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 app && tar -c scripts | gzip -n > scripts.tgz" # temporary app/scripts.tgz file
+
+      rename_with_md5!
+    end
+
+    # 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/scripts/scripts-#{md5sum}.tgz"
+      FileUtils.mkdir_p(File.dirname(md5_path))
+      FileUtils.mv("app/scripts.tgz", md5_path)
+      md5_path
+    end
+
+    def save_scripts_info(scripts_name)
+      FileUtils.mkdir_p(File.dirname(SCRIPTS_INFO_PATH))
+      IO.write(SCRIPTS_INFO_PATH, scripts_name)
+    end
+
+    # cache this because the file will get removed
+    def md5sum
+      @md5sum ||= Digest::MD5.file("app/scripts.tgz").to_s[0..7]
+    end
+
+    def sh(command)
+      puts "=> #{command}"
+      system command
+    end
+
+  end
+end

data/lib/lono/script/upload.rb

@@ -0,0 +1,81 @@
+require "aws-sdk-s3"
+require "filesize"
+
+class Lono::Script
+  class Upload < Base
+    def run
+      Lono::ProjectChecker.check
+      return unless scripts_built?
+
+      upload(tarball_path)
+      puts "Uploaded #{File.basename(s3_dest)} to s3}"
+    end
+
+    def upload(tarball_path)
+      puts "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).colorize(:green)
+      puts "Time to upload code to s3: #{time_took}"
+    end
+
+    def filesize
+      Filesize.from(File.size(tarball_path).to_s + " B").pretty
+    end
+
+    def s3_dest
+      "s3://#{bucket_name}/#{key}"
+    end
+
+    def key
+      # Example key: cloudformation/development/scripts/scripts-md5
+      "#{dest_folder}/#{File.basename(tarball_path)}"
+    end
+
+    # Example:
+    #   s3_folder: s3://infra-bucket/cloudformation
+    #   bucket_name: infra-bucket
+    def bucket_name
+      s3_folder.sub('s3://','').split('/').first
+    end
+
+    # Removes s3://bucket-name and adds Lono.env. Example:
+    #   s3_folder: s3://infra-bucket/cloudformation
+    #   bucket_name: cloudformation/development/scripts
+    def dest_folder
+      folder = s3_folder.sub('s3://','').split('/')[1..-1].join('/')
+      "#{folder}/#{Lono.env}/scripts"
+    end
+
+    # Scripts are only built if the app/scripts folder is non empty
+    def scripts_built?
+      File.exist?(SCRIPTS_INFO_PATH) && !tarball_path.empty?
+    end
+
+    def tarball_path
+      IO.read(SCRIPTS_INFO_PATH).strip
+    end
+
+    # s3_folder example:
+    def s3_folder
+      setting = Lono::Setting.new
+      setting.s3_folder
+    end
+
+    def s3_resource
+      @s3_resource ||= Aws::S3::Resource.new
+    end
+
+    # http://stackoverflow.com/questions/4175733/convert-duration-to-hoursminutesseconds-or-similar-in-rails-3-or-ruby
+    def pretty_time(total_seconds)
+      minutes = (total_seconds / 60) % 60
+      seconds = total_seconds % 60
+      if total_seconds < 60
+        "#{seconds.to_i}s"
+      else
+        "#{minutes.to_i}m #{seconds.to_i}s"
+      end
+    end
+  end
+end

data/lib/lono/sequence.rb

@@ -0,0 +1,33 @@
+require 'fileutils'
+require 'colorize'
+require 'active_support/core_ext/string'
+require 'thor'
+require 'bundler'
+
+class Lono::Sequence < Thor::Group
+  include Thor::Actions
+
+  def self.template_name
+    ENV['TEMPLATE'] || 'skeleton'
+  end
+
+  def self.source_root
+    starter_projects = File.expand_path("../starter_projects", File.dirname(__FILE__))
+    template_folder = "#{starter_projects}/#{template_name}"
+    unless File.exist?(template_folder)
+      templates = Dir.glob("#{starter_projects}/*")
+        .select { |f| File.directory?(f) }
+        .map { |f| "  #{File.basename(f)}" }
+        .sort
+      puts "The TEMPLATE=#{ENV['TEMPLATE']} you specified does not exist.".colorize(:red)
+      puts "The available templates are:\n#{templates.join("\n")}"
+      exit
+    end
+    template_folder
+  end
+
+private
+  def git_installed?
+    system("type git > /dev/null")
+  end
+end

data/lib/lono/setting.rb

@@ -0,0 +1,83 @@
+require 'yaml'
+
+module Lono
+  class Setting
+    def initialize(check_lono_project=true)
+      @check_lono_project = check_lono_project
+    end
+
+    # data contains the settings.yml config.  The order or precedence for settings
+    # is the project lono/settings.yml and then the ~/.lono/settings.yml.
+    @@data = nil
+    def data
+      return @@data if @@data
+
+      if @check_lono_project && !File.exist?(project_settings_path)
+        puts "ERROR: No settings file at #{project_settings_path}.  Are you sure you are in a project with lono setup?".colorize(:red)
+        exit 1
+      end
+
+      # project based settings files
+      project = load_file(project_settings_path)
+
+      user_file = "#{ENV['HOME']}/.lono/settings.yml"
+      user = load_file(user_file)
+
+      default_file = File.expand_path("../default/settings.yml", __FILE__)
+      default = load_file(default_file)
+
+      all_envs = default.deep_merge(user.deep_merge(project))
+      all_envs = merge_base(all_envs)
+      @@data = all_envs[Lono.env] || all_envs["base"] || {}
+    end
+
+    # Special helper method to support multiple formats for s3_folder setting.
+    # Format 1: Simple String
+    #
+    #   development:
+    #     s3_folder: mybucket/path/to/folder
+    #
+    # Format 2: Hash
+    #
+    #   development:
+    #     s3_folder:
+    #       default: mybucket/path/to/folder
+    #       dev_profile1: mybucket/path/to/folder
+    #       dev_profile1: another-bucket/storage/path
+    #
+    def s3_folder
+      s3_folder = data['s3_folder']
+      return s3_folder if s3_folder.nil? or s3_folder.is_a?(String)
+
+      # If reach here then the s3_folder is a Hash
+      s3_folder[ENV['AWS_PROFILE']] || s3_folder["default"]
+    end
+
+  private
+    def load_file(path)
+      return Hash.new({}) unless File.exist?(path)
+
+      content = RenderMePretty.result(path)
+      data = YAML.load(content)
+      # If key is is accidentally set to nil it screws up the merge_base later.
+      # So ensure that all keys with nil value are set to {}
+      data.each do |lono_env, _setting|
+        data[lono_env] ||= {}
+      end
+      data
+    end
+
+    # automatically add base settings to the rest of the environments
+    def merge_base(all_envs)
+      base = all_envs["base"]
+      all_envs.each do |lono_env, env_settings|
+        all_envs[lono_env] = base.merge(env_settings) unless lono_env == "base"
+      end
+      all_envs
+    end
+
+    def project_settings_path
+      "#{Lono.root}/config/settings.yml"
+    end
+  end
+end

data/lib/lono/template.rb

@@ -2,21 +2,20 @@ require "thor"
 require_relative "command"
 
 class Lono::Template < Lono::Command
-  autoload :Help, 'lono/template/help'
-  autoload :Helpers, 'lono/template/helpers'
+  autoload :Context, 'lono/template/context'
+  autoload :Helper, 'lono/template/helper'
   autoload :Bashify, 'lono/template/bashify'
   autoload :DSL, 'lono/template/dsl'
   autoload :Template, 'lono/template/template'
   autoload :Upload, 'lono/template/upload'
-  autoload :AwsServices, 'lono/template/aws_services'
+  autoload :AwsService, 'lono/template/aws_service'
 
-  class_option :quiet, type: :boolean, aliases: "-q", desc: "silence the output"
+  class_option :quiet, type: :boolean, desc: "silence the output"
   class_option :noop, type: :boolean, desc: "noop mode, do nothing destructive"
 
   desc "generate", "Generate the CloudFormation templates"
-  Help.generate
-  option :clean, type: :boolean, aliases: "-c", desc: "remove all output files before generating"
-  option :pretty, type: :boolean, default: true, desc: "json pretty the output.  only applies with json format"
+  long_desc Lono::Help.text("template/generate")
+  option :clean, type: :boolean, desc: "remove all output files before generating"
   def generate
     DSL.new(options.clone).run
   end
@@ -26,8 +25,8 @@ class Lono::Template < Lono::Command
     Upload.new(options.clone).run
   end
 
-  desc "bashify [URL-OR-PATH]", "Convert the UserData section of an existing CloudFormation Template to a starter bash script that is compatiable with lono"
-  Help.bashify
+  desc "bashify URL-OR-PATH", "Convert the UserData section of an existing CloudFormation Template to a starter bash script that is compatiable with lono"
+  long_desc Lono::Help.text("template/bashify")
   def bashify(path)
     Bashify.new(path: path).run
   end

data/lib/lono/template/{aws_services.rb → aws_service.rb}

@@ -1,6 +1,6 @@
 require "aws-sdk-s3"
 
-module Lono::Template::AwsServices
+module Lono::Template::AwsService
   def s3
     return @s3 if @s3
 

data/lib/lono/template/context.rb

@@ -0,0 +1,73 @@
+# Encapsulates helper methods and instance variables to be rendered in the ERB
+# templates.
+class Lono::Template
+  class Context
+    include Lono::Template::Helper
+
+    def initialize(options={})
+      @options = options
+      load_variables
+      load_project_helpers
+    end
+
+    # Take a hash and makes them instance variables in the current scope.
+    # Use this in custom helper methods to make variables accessible to ERB templates.
+    def instance_variables!(variables)
+      variables.each do |key, value|
+        instance_variable_set('@' + key.to_s, value)
+      end
+    end
+
+  private
+    # Variables in base.rb are overridden by their environment specific variables
+    # file.  Example, file LONO_ENV=development:
+    #
+    #   config/variables/base.rb
+    #   config/variables/development.rb - will override any variables in base.rb
+    #
+    def load_variables
+      load_variables_file("base")
+      load_variables_file(Lono.env)
+    end
+
+    # Load custom helper methods from project
+    def load_project_helpers
+      Dir.glob("#{Lono.config.helpers_path}/**/*_helper.rb").each do |path|
+        filename = path.sub(%r{.*/},'').sub('.rb','')
+        module_name = filename.classify
+
+        # Prepend a period so require works LONO_ROOT is set to a relative path
+        # without a period.
+        #
+        # Example: LONO_ROOT=tmp/lono_project
+        first_char = path[0..0]
+        path = "./#{path}" unless %w[. /].include?(first_char)
+        require path
+        self.class.send :include, module_name.constantize
+      end
+    end
+
+    # Load the variables defined in config/variables/* to make available in the
+    # template blocks in config/templates/*.
+    #
+    # Example:
+    #
+    #   `config/variables/base.rb`:
+    #     @foo = 123
+    #
+    #   `app/definitions/base.rb`:
+    #      template "mytemplate.yml" do
+    #        source "mytemplate.yml.erb"
+    #        variables(foo: @foo)
+    #      end
+    #
+    # NOTE: Only able to make instance variables avaialble with instance_eval,
+    #   wasnt able to make local variables available.
+    def load_variables_file(name)
+      path = "#{Lono.config.variables_path}/#{name}.rb"
+      return unless File.exist?(path)
+
+      instance_eval(IO.read(path))
+    end
+  end
+end