jack-eb 0.0.1

data/lib/jack/cli/help.rb

@@ -0,0 +1,107 @@
+module Jack
+  class CLI < Thor
+    class Help
+      class << self
+        def convention
+<<-EOL
+The configuration name is based on convention.  An environment with the name of stag-rails-app-s1 results in the jack/cfg/stag-rails-app.cfg.yml being used.  The convention can be overriden with the --cfg option.  
+EOL
+        end
+
+        def create
+<<-EOL
+Creates a new environment using the configuration in jack/cfg folder.  
+
+#{convention}
+
+Example:
+
+$ jack create stag-rails-app-s1
+
+$ jack create -c myconfig stag-rails-app-s1
+
+$ jack create -a myapp -c myconfig stag-rails-app-s1
+EOL
+        end
+ 
+        def upload
+<<-EOL
+Uploads the specified template configuration in jack/cfg and applies it to the environment immediately.  
+
+#{convention}
+
+Example:
+
+$ jack config upload stag-rails-app-s1
+
+$ jack config upload -a myapp -c myconfig stag-rails-app-s1
+EOL
+        end
+
+        def download
+<<-EOL
+Downloads the environment's config to jack/cfg/[CONFIG_NAME].cfg.yml
+
+#{convention}
+
+Example:
+
+$ jack config download stag-rails-app-s1
+
+$ jack config download -a myapp -c myconfig stag-rails-app-s1
+EOL
+        end
+
+
+        def diff
+<<-EOL
+Diff local jack config vs environment config.  The environment config is generated on the fly.
+
+If you have colordiff installed the diff command will use make use of it.  If you want to have your own custom diff, you can set your JACK_DIFF environment variable to it.
+
+#{convention}
+
+Example:
+
+$ jack config diff stag-rails-app-s1
+
+$ jack config diff -a myapp -c myconfig stag-rails-app-s1
+EOL
+        end
+
+        def sort
+<<-EOL
+Reformats local jack config file to a sorted yaml format.
+
+#{convention}
+
+Example:
+
+$ jack config sort stag-rails-app-s1
+
+$ jack config sort -c myconfig stag-rails-app-s1 # env name doesnt matter here
+EOL
+        end
+
+        # dumb thor bug, so this doesnt even show, leaving here in case Thor is fixed
+        def config
+<<-EOL
+Manage the environment's config.  Can use this to download the environment's config to jack/cfg folder or upload config in jack/cfg folder and apply it to the environment.
+
+Example:
+
+$ jack config download stag-rails-app-s1
+
+For more info:
+
+$ jack help config
+
+$ jack config help apply
+
+$ jack config help download
+EOL
+        end
+      end
+    end
+  end
+end

data/lib/jack/config.rb

@@ -0,0 +1,13 @@
+require 'fileutils'
+
+module Jack
+  module Config
+    autoload :Base, 'jack/config/base'
+    autoload :Diff, 'jack/config/diff'
+    autoload :Download, 'jack/config/download'
+    autoload :Sort, 'jack/config/sort'
+    autoload :Transmit, 'jack/config/transmit'
+    autoload :Upload, 'jack/config/upload'
+    autoload :YamlFormatter, 'jack/config/yaml_formatter'
+  end
+end

data/lib/jack/config/diff.rb

@@ -0,0 +1,44 @@
+module Jack
+  module Config
+    class Diff
+      attr_reader :transmit
+      def initialize(options={})
+        @options = options
+        @root = options[:root] || '.'
+        @env_name = options[:env_name]
+        @download = Jack::Config::Download.new(options)
+      end
+
+      def run
+        @download.get_current_cfg
+        do_diff(@download.current_path, @download.local_config_path)
+        cleanup_files
+      end
+
+      def do_diff(current, local)
+        UI.say "Comparing #{current} and #{local}"
+        return if @options[:noop]
+        sorter = YamlFormatter.new
+        sorter.process(current)
+        sorter.process(local)
+        # need to use system so that the diff shows up properly in the terminal
+        system(diff_command, @download.current_path, @download.local_config_path)
+        puts ""
+      end
+
+      def cleanup_files
+        return false if @options[:dirty]
+        @download.clean(silent=true)
+      end
+
+      def diff_command
+        return ENV['JACK_DIFF'] if ENV['JACK_DIFF']
+        if system("type colordiff > /dev/null 2>&1")
+          "colordiff"
+        else
+          "diff"
+        end
+      end
+    end
+  end
+end

data/lib/jack/config/download.rb

@@ -0,0 +1,66 @@
+require 'fileutils'
+require 'yaml'
+
+module Jack
+  module Config
+    class Download < Transmit
+      include Util
+
+      attr_reader :current_path, :current_name
+
+      def initialize(options={})
+        super
+        @current_path = "#{@saved_configs}/current-#{timestamp}.cfg.yml"
+        @current_name = extract_name(@current_path)
+      end
+
+      def run
+        download
+      end
+
+      def download
+        get_current_cfg
+        copy_to_local_cfg
+        clean
+        UI.say "Config downloaded to #{@local_config_path}".colorize(:green)
+      end
+
+      def get_current_cfg
+        UI.say "Downloading config file..."
+        eb_config_save
+      end
+
+      # for specs
+      def eb_config_save
+        do_cmd("eb config save --cfg #{current_name} #{@env_name}", @options)
+      end
+
+      def copy_to_local_cfg
+        UI.say "Writing to local config file: #{@local_config_path}"
+        dirname = File.dirname("#{@root}/#{@local_config_path}")
+        FileUtils.mkdir_p(dirname) unless File.exist?(dirname)
+        do_copy_to_local_cfg
+      end
+
+      # for specs
+      def do_copy_to_local_cfg
+        return if @options[:noop]
+        local_path = "#{@root}/#{@local_config_path}"
+        FileUtils.cp(@current_path, local_path) 
+        YamlFormatter.new.process(local_path)
+      end
+
+      # remove both the local download file and remote eb config
+      def clean(silent=false)
+        return if @options[:dirty]
+        UI.say "Cleaning up eb remote config and local files" unless silent
+        eb.delete_configuration_template(
+          application_name: @app_name,
+          template_name: current_name
+        ) unless @options[:noop]
+        FileUtils.rm_f(@current_path)
+      end
+
+    end
+  end
+end

data/lib/jack/config/sort.rb

@@ -0,0 +1,19 @@
+require 'fileutils'
+
+module Jack
+  module Config
+    class Sort < Transmit # for the local_config_path method
+      include Util
+
+      def initialize(options={})
+        super
+        @options = options
+      end
+
+      def run
+        YamlFormatter.new.process("#{@root}/#{local_config_path}")
+        UI.say "Reformatted the local config to a sorted yaml format at #{local_config_path}"
+      end
+    end
+  end
+end

data/lib/jack/config/transmit.rb

@@ -0,0 +1,77 @@
+require 'fileutils'
+require 'yaml'
+
+module Jack
+  module Config
+    class Transmit
+      include Util
+
+      attr_reader :local_config_path
+      def initialize(options={})
+        @options = options
+        @root = options[:root] || '.'
+        @env_name = options[:env_name]
+        @app_name = @options[:app_name] || app_name_convention(@env_name)
+
+        @saved_configs = "#{@root}/.elasticbeanstalk/saved_configs"
+
+        local_config_name = options[:cfg] || config_name_convention(@env_name)
+        @local_config_path = "jack/cfg/#{local_config_name}.cfg.yml"
+
+        sync_eb_config_yml
+      end
+
+      def eb_config_path
+        "#{@root}/.elasticbeanstalk/config.yml"
+      end
+
+      def sync_eb_config_yml(force=false)
+        # should break out to another class but too much work right now
+        create = Create.new(@options)
+        create.ensure_eb_init
+        do_sync_eb_config_yml(force)
+      end
+
+    private
+
+      # force flag for specs
+      def do_sync_eb_config_yml(force)
+        return if @options[:noop] and !force
+        envs = describe_environments
+        env = envs[:environments].first
+        if env
+          write_eb_config_yml(env.application_name, env.solution_stack_name)
+        else
+          UI.say "#{@env_name} could not be found".colorize(:red)
+          exit 0
+        end
+      end
+
+      def write_eb_config_yml(application_name, solution_stack_name)
+        data = YAML.load_file(eb_config_path)
+        data['global']['application_name'] = application_name
+        data['global']['default_platform'] = solution_stack_name
+        dump = YAML.dump(data).gsub("!ruby/object:Hash", '')
+        dump = dump.split("\n")[1..-1].join("\n") # strip first line
+        File.write(eb_config_path, dump)
+      end
+
+      # useful for specs
+      def describe_environments
+        eb.describe_environments(environment_names: [@env_name])
+      end
+
+      def config_name_convention(env_name)
+        env_name.split('-')[0..-2].join('-')
+      end
+
+      def timestamp
+        Time.now.strftime "%Y-%m-%d_%H-%M-%S"
+      end
+
+      def extract_name(path)
+        path.split('/').last.sub('.cfg.yml','')
+      end
+    end
+  end
+end

data/lib/jack/config/upload.rb

@@ -0,0 +1,97 @@
+require 'fileutils'
+
+module Jack
+  module Config
+    class Upload < Transmit
+      include Util
+
+      attr_reader :upload_path, :upload_name
+
+      def initialize(options={})
+        super
+        @upload_path = "#{@saved_configs}/#{@env_name}-#{timestamp}.cfg.yml"
+        @upload_name = extract_name(@upload_path)
+      end
+
+      def run
+        unless local_cfg_exist?
+          UI.say "#{local_config_path} does not exist, nothing to upload"
+          exit 0
+        end
+        compare
+        if confirm
+          upload
+          update_env 
+        end
+      end
+
+      def compare
+        Diff.new(@options).run
+      end
+
+      def upload
+        return false unless local_cfg_exist?
+        UI.say("Copying #{@local_config_path} to #{@upload_path} for the upload")
+        cp_to_save_configs
+        upload_to_eb
+        clean_up
+      end
+
+      def confirm
+        UI.say("Are you sure you want to update the environment with your the new config #{@config_path}?".colorize(:yellow))
+        UI.say(<<-EOL)
+If the difference is not what you expected, you should say no.  
+A blank newline indicates that there was no difference.  
+If you want to download the config from the environment and 
+overwrite your #{@local_config_path} instead, you can use this command:
+$ jack config download #{@env_name}
+$ jack config help download # for more info
+EOL
+        print "yes/no? [no] " unless @options[:silent]
+        answer = get_answer
+        answer =~ /^y/
+      end
+
+      def get_answer
+        return 'y' if @options[:force]
+        $stdin.gets
+      end
+
+      def update_env
+        UI.say("Updating environment #{@env_name} with template #{upload_name}")
+        eb.update_environment(
+          environment_name: @env_name,
+          template_name: upload_name
+        ) unless @options[:noop]
+      end
+
+      def local_cfg_exist?
+        File.exist?("#{@root}/#{@local_config_path}")
+      end
+
+      def cp_to_save_configs
+        ensure_folder_exist(@saved_configs)
+        FileUtils.cp("#{@root}/#{@local_config_path}", @upload_path)
+      end
+
+      def upload_to_eb
+        eb_config_put
+      end
+
+      # for specs
+      def eb_config_put
+        do_cmd("eb config put #{upload_name}", @options)
+      end
+
+      def clean_up
+        return if @options[:dirty]
+        FileUtils.rm_f(@upload_path)
+      end
+
+      def ensure_folder_exist(folder)
+        FileUtils.mkdir_p(folder) unless File.exist?(folder)
+      end
+
+    end
+  end
+end

data/lib/jack/config/yaml_formatter.rb

@@ -0,0 +1,30 @@
+require "yaml"
+
+module Jack
+  module Config
+    # Class does very specific formatting for the eb config files:
+    #
+    #   * Makes sure that the keys are sorted so we can compare them
+    #   * It also scripts out the generated DateModified and DateCreated Metadata
+    class YamlFormatter
+      def process(file)
+        data = YAML.load_file(file)
+        data = strip_metadata_dates(data)
+        dump = YAML.dump(data).gsub("!ruby/object:Hash", '')
+        dump = dump.split("\n")[1..-1].join("\n") + "\n" # strip first line
+        outfile = "#{file}.sorted"
+        File.open(outfile, 'w') { |f| f.write(dump) }
+        FileUtils.mv(outfile, file)
+      end
+
+      def strip_metadata_dates(data)
+        metadata = data['EnvironmentConfigurationMetadata']
+        if metadata
+          metadata.delete('DateModified')
+          metadata.delete('DateCreated')
+        end
+        data
+      end
+    end
+  end
+end