awx 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f45efb7c22579d93855b4b979bd61d48b19c5d6d
-  data.tar.gz: 6f56e452dc4298b9cd1bafe150691325df84e745
+  metadata.gz: a22d18dbf189673739f5963a622151a85e814a1e
+  data.tar.gz: 8b61eee5e62db727d1c105df70588e2fa0209434
 SHA512:
-  metadata.gz: eabe941e7349e2003decadcd90258029c0ed7250c9f3f91305a85094387777217b732f4c5bfecc3214b16b26f8724a1ce7ac3163c418bcdb664bf80142f76313
-  data.tar.gz: 2101dcd95ea79eb57e6c58da6f6f7b10dba7bb1233247e2b2b2f6fe421af4ad75602c02d6608da9b4d8683dedda9fbefbe4b79c98c6456f73e24935e97c0df88
+  metadata.gz: 21cc5951d290166128b6eaa29b25de3ed4206744625013c2e420996827b47a7bfdfef276a0c5e2dffdba822e2ee353e95ba1115490c895099e29af3a34ace8fa
+  data.tar.gz: c9723e5ca2518609c52228387e2886ae85a272beed50a9392acd8953b8aa0972452a861ee5f931820fabe25ca39106e4ba0f5ecd39893ba93706dd3ec1cf238c

data/lib/aws/aws_cache.rb

@@ -0,0 +1,53 @@
+module App
+
+    class CacheKey
+
+        ARRAY_AWS_REGIONS = 'aws_regions'
+
+    end
+
+    class Cache
+
+        # Stores a string representation of a Array/Hash/String in the /tmp directory using a unique key + timestamp.
+        # Key is the unique key used for retrieving it -- stored as constant in class above ^ App::CacheKey
+        # Data can be either anything. It will simply be stored as object.inspect.
+        # Expire hours is the amount of hours this Hash should be stored for.
+        # @return void
+        def self.store(key, data, expire_hours = nil)
+
+            # TODO
+
+        end
+
+        # Returns either the data or nil.
+        # Nil will be returned in 2 cases, the key doesn't exist or the data has expired.
+        # @return Object|nil
+        def self.get(key)
+
+            # TODO
+
+            nil
+
+        end
+
+        # Checks if a key exists but doesn't actually parse it.
+        # @return boolean
+        def self.exists?(key)
+
+            # TODO
+
+            false
+
+        end
+
+        # Invalidate a cache key. Does nothing if key doesn't exist.
+        # @return void
+        def self.invalidate(key)
+
+            # TODO
+
+        end
+
+    end
+
+end

data/lib/aws/aws_cli.rb

@@ -0,0 +1,166 @@
+require 'json'
+require 'uri'
+
+module App
+
+    class AWSCli
+
+        BLANK       = 'BLANK'
+        REGION_SKIP = 'E+e^P7p?KYWvc~R/' # Must provide this to skip region (so it can't easily be done accidentally)
+
+        @@valid_regions         = BLANK
+        @@ec2_instances         = {}
+        @@ec2_volumes           = {}
+        @@ec2_security_groups   = {}
+        @@s3_buckets            = {}
+        @@rds_mysql_instances   = {}
+        @@sqs_queues            = {}
+        @@cloudformation_stacks = {}
+
+        # @return void
+        def self.get_regions
+
+            # TODO - Remove the following line(s) and add actual caching...
+
+            @@valid_regions = %w(ap-south-1 eu-west-3 eu-west-2 eu-west-1 ap-northeast-2 ap-northeast-1 sa-east-1 ca-central-1 ap-southeast-1 ap-southeast-2 eu-central-1 us-east-1 us-east-2 us-west-1 us-west-2)
+            @@valid_regions = %w(us-east-1 us-east-2 us-west-1 us-west-2)
+
+            if @@valid_regions == BLANK
+                @@valid_regions = []
+                regions         = execute('ec2 describe-regions', nil)
+                regions['Regions'].each do |region|
+                    @@valid_regions << region['RegionName']
+                end
+            end
+
+            @@valid_regions
+        end
+
+        # Perform S3 upload. Will overwrite existing file (if exists)!
+        # @return Array
+        def self.s3_upload(source, bucket_name, bucket_path)
+            Blufin::Terminal::error("Source does not exist: #{source}", true) unless Blufin::Files::path_exists(source) || Blufin::Files::file_exists(source)
+            source  = File.expand_path(source)
+            command = "s3 cp #{source} s3://#{bucket_name}/#{bucket_path}"
+            execute_as_proc("Uploading Template to S3: #{Blufin::Terminal::format_highlight("s3://#{bucket_name}/#{bucket_path}")}", command, REGION_SKIP)
+        end
+
+        # Perform S3 sync.
+        # @return Array
+        def self.s3_sync(source, bucket_name, bucket_path, delete: false)
+
+            # TODO - This was written but is untested! Remove this comment once this method has been used successfully.
+
+            Blufin::Terminal::error("Source does not exist: #{source}", true) unless Blufin::Files::path_exists(source) || Blufin::Files::file_exists(source)
+            source  = File.expand_path(source)
+            command = "s3 sync #{source} s3://#{bucket_name}/#{bucket_path}#{delete ? ' --delete' : ''}"
+            execute(command, REGION_SKIP, json: false)
+        end
+
+        # Validate a CloudFormation Stack.
+        # @return Hash
+        def self.cloudformation_stack_validate(region, s3_url)
+            command = "cloudformation validate-template --template-url #{s3_url}"
+            execute_as_proc('Validating Template', command, region, json: true)
+        end
+
+        # Create a CloudFormation Stack.
+        # @return Hash
+        def self.cloudformation_stack_create(region, stack_name, s3_url, params: nil, tags: nil, capabilities: [])
+            params       = params.nil? ? '' : " --parameters '#{params.gsub("'", "\\'")}'"
+            tags         = tags.nil? ? '' : " --tags '#{tags.gsub("'", "\\'")}'"
+            capabilities = !capabilities.any? ? '' : " --capabilities #{capabilities.join(' ')}"
+            command      = "cloudformation create-stack --stack-name #{stack_name} --template-url #{s3_url}#{params}#{tags}#{capabilities}"
+            stack_send   = execute_as_proc("Sending CloudFormation Stack: #{Blufin::Terminal::format_highlight(stack_name)}", command, region, json: true)
+            begin
+                if stack_send.has_key?('StackId')
+                    Blufin::Terminal::success('Template was accepted by AWS.', "\x1B[38;5;240mStackId \xe2\x80\x94 \x1B[38;5;40m#{stack_send['StackId']}")
+                    system("/usr/bin/open -a '/Applications/Google Chrome.app' https://#{region}.console.aws.amazon.com/cloudformation/home?region=#{region}#/stack/detail?stackId=#{URI::encode(stack_send['StackId'])}")
+                else
+                    Blufin::Terminal::error("Key not found in response: #{Blufin::Terminal::format_invalid('StackId')}", stack_send.inspect, true)
+                end
+            rescue
+                Blufin::Terminal::error('Stack was not accepted by AWS.', App::AWSCli::format_cli_error(stack_send), true)
+            end
+            stack_complete = execute_as_proc("Creating CloudFormation Stack: #{Blufin::Terminal::format_highlight(stack_name)}", "cloudformation wait stack-create-complete --stack-name #{stack_name}", region, json: true)
+            if stack_complete.to_s.strip == ''
+                puts
+                puts "    \x1B[38;5;40mCREATE_COMPLETE\x1B[0m"
+                puts
+                stack_details = execute_as_proc("Getting CloudFormation Stack: #{Blufin::Terminal::format_highlight(stack_name)}", "cloudformation describe-stacks --stack-name #{stack_name}", region, json: true)
+                begin
+                    stack_json = JSON.parse(stack_details.to_json)
+                    raise RuntimeError, 'Not a Hash' unless stack_json.is_a?(Hash)
+                    puts
+                    Blufin::Terminal::code_highlight(stack_json.to_yaml, 'yml', 4)
+                rescue
+                    Blufin::Terminal::error('It seems you Stack was created (but then something went wrong).', stack_details.inspect, false)
+                end
+            else
+                Blufin::Terminal::error("Something went wrong. Go to: #{Blufin::Terminal::format_highlight('https://us-west-2.console.aws.amazon.com/cloudformation/home')} to see what happened.", format_cli_error(stack_complete.to_s), true)
+            end
+        end
+
+        # Use this when a common such as "aws do-something" returns an error (such as: Stack [cognito-public-pool-go-eat-local-albert] already exists).
+        # This removes the generic error prefix and preceding blank line.
+        # @return string
+        def self.format_cli_error(error_string)
+            error = ''
+            error_string.split("\n").each do |line|
+                if line.strip.length > 0
+                    error = "#{error}#{line.gsub(/(An error occurred \(.*\) when calling the [A-Za-z0-9]+ operation:)\s*/, '')}"
+                end
+            end
+            error
+        end
+
+        private
+
+        # Helper method to execute aws-cli commands.
+        # @return Object
+        def self.execute(command, region, json: true, verbose: true)
+            raise RuntimeError, 'Must provide region.' if region.nil? || region.strip == ''
+            raise RuntimeError, "Invalid region: #{region}" unless get_regions.include?(region) || region == REGION_SKIP
+            begin
+                region          = region == REGION_SKIP ? '' : " --region #{region}"
+                aws_credentials = App::AWSConfig.get_credentials(App::AWSConfig::AWS_PROFILE_ALBERT_CLI)
+                region          = aws_credentials.region if region.nil?
+                puts "\x1B[38;5;70m$ \x1B[38;5;240maws #{command}#{region}\x1B[0m" if verbose
+                if json
+                    result = `aws #{command}#{region} 2>/tmp/execute-output-aws`
+                    # If no JSON, simply return the output.
+                    return `cat /tmp/execute-output-aws` if result == ''
+                    begin
+                        return JSON.parse(result)
+                    rescue => e
+                        raise RuntimeError, "JSON Parsing Failed:\n\n#{e.message}"
+                    end
+                else
+                    result = system("aws #{command}#{region} &>/dev/null")
+                    raise RuntimeError, 'This command this not return a status code of 0 (Success).' unless result
+                    return result
+                end
+            rescue => e
+                Blufin::Terminal::error("Command Failed: #{Blufin::Terminal::format_command("aws #{command}#{region}")}", e.message, true)
+            end
+        end
+
+        # Used when running commands showing the spinner.
+        # Set JSON to TRUE if you expect JSON output back, otherwise return value will be boolean (TRUE if successful).
+        # Highly recommended to keep verbose set to FALSE.
+        # @return void
+        def self.execute_as_proc(title, command, region, json: false, verbose: false, catch_exception: false)
+            output  = nil
+            threads = []
+            threads << Thread.new {
+                output = execute(command, region, json: json, verbose: verbose)
+            }
+            sleep(0.1)
+            puts if verbose
+            Blufin::Terminal::execute_proc("AWS - #{title}", Proc.new { threads.each { |thread| thread.join } })
+            output
+        end
+
+    end
+
+end

data/lib/aws/aws_cloudformation.rb

@@ -0,0 +1,68 @@
+module App
+
+    class AWSCloudFormation
+
+        S3_BUCKET_CLOUDFORMATION        = 'blufin-cloudformation-templates'
+        S3_BUCKET_CLOUDFORMATION_REGION = 'us-west-2'
+        PATH_CLOUDFORMATION             = 'aws-cloudformation'
+        FILE_CLOUDFORMATION_DEFAULTS    = 'cloudformation.rb'
+
+        # Gets the path to the root of the cloudformation templates in blufin-secrets repo.
+        # @return string
+        def self.get_cloudformation_path(path = PATH_CLOUDFORMATION)
+            path = "#{App::Config.param(ConfigUnique::PATH_TO_REPO_SECRETS)}/#{path}"
+            Blufin::Terminal::error("CloudFormation path not found: #{Blufin::Terminal::format_directory(path)}", 'This probably means directories got renamed or code got changed.', true) unless Blufin::Files::path_exists(path)
+            path
+        end
+
+        # Uploads a cloudformation template to S3 (so we can create a stack from it).
+        # Returns the S3 URL.
+        # @return string
+        def self.upload_cloudformation_template(template_category, template_name, description)
+            source = "#{get_cloudformation_path}/#{template_category}/#{template_name}/template.yml"
+            raise RuntimeError, "File does not exist: #{source}" unless Blufin::Files::file_exists(source)
+            yml_data                = YAML.load_file(File.expand_path(source))
+            yml_data['Description'] = description
+            description_written     = false
+            new_yaml                = {}
+            yml_data.keys.each do |key|
+                if %w(AWSTemplateFormatVersion).include?(key)
+                    new_yaml[key] = yml_data[key]
+                else
+                    unless description_written
+                        description_written     = true
+                        new_yaml['Description'] = description
+                    end
+                    new_yaml[key] = yml_data[key] unless key == 'Description'
+                end
+            end
+            tmp_file = "/tmp/aws-cf-upload-#{template_category}-#{template_name}.yml"
+            Blufin::Files::write_file(tmp_file, convert_string_to_line_array(new_yaml.to_yaml))
+            App::AWSCli::s3_upload(tmp_file, S3_BUCKET_CLOUDFORMATION, get_template_filename(template_category, template_name))
+        end
+
+        # Gets the S3 bucket URL.
+        # @return string
+        def self.get_cloudformation_s3_bucket_url(template_category, template_name)
+            "https://#{S3_BUCKET_CLOUDFORMATION}.s3-#{S3_BUCKET_CLOUDFORMATION_REGION}.amazonaws.com/#{get_template_filename(template_category, template_name)}"
+        end
+
+        # Converts cognito/private-pool to -> cognito-private-pool.yml
+        # @return string
+        def self.get_template_filename(template_category, template_name)
+            "#{template_category}-#{template_name}.yml"
+        end
+
+        # Converts a string to an Array of lines to a string.
+        # @return String
+        # TODO - Must move Blufin::YmlCommon from blufin -> blufin-lib. Not sure what the damage will be... 07/08/2019.
+        def self.convert_string_to_line_array(string)
+            raise RuntimeError, "Expected String, instead got: #{string.class}" unless string.is_a?(String)
+            array_of_lines = []
+            string.split("\n").each { |line| array_of_lines << line.gsub("\n", '') }
+            array_of_lines
+        end
+
+    end
+
+end

data/lib/aws/aws_config.rb

@@ -0,0 +1,39 @@
+module App
+
+    class AWSConfig
+
+        BLANK = '[BLANK]'
+
+        AWS_PROFILE_ALBERT_CLI = 'albert-cli'
+
+        FILE_AWS_CONFIG      = File.expand_path('~/.aws/config')
+        FILE_AWS_CREDENTIALS = File.expand_path('~/.aws/credentials')
+
+        @@aws_credentials = BLANK
+
+        # Gets AWS credentials from ~/.aws directory for given profile.
+        # If credentials don't exist (or are missing information) -- nil is returned.
+        def self.get_credentials(profile = 'default')
+            if @@aws_credentials == BLANK
+                return nil unless Blufin::Files::file_exists(FILE_AWS_CONFIG)
+                return nil unless Blufin::Files::file_exists(FILE_AWS_CREDENTIALS)
+                config            = ParseConfig.new(FILE_AWS_CONFIG)
+                credentials       = ParseConfig.new(FILE_AWS_CREDENTIALS)
+                @@aws_credentials = nil
+                if !config.params[profile].nil? && !credentials.params[profile].nil?
+                    if !config.params[profile]['region'].nil? && !config.params[profile]['output'].nil? && !credentials.params[profile]['aws_access_key_id'].nil? && !credentials.params[profile]['aws_secret_access_key'].nil?
+                        aws_credentials            = App::AWSCredentials.new
+                        aws_credentials.region     = config.params[profile]['region']
+                        aws_credentials.output     = config.params[profile]['output']
+                        aws_credentials.aws_key    = config.params[profile]['aws_access_key_id']
+                        aws_credentials.aws_secret = config.params[profile]['aws_secret_access_key']
+                        @@aws_credentials          = aws_credentials
+                    end
+                end
+            end
+            @@aws_credentials
+        end
+
+    end
+
+end

data/lib/aws/aws_credentials.rb

@@ -0,0 +1,9 @@
+module App
+
+    class AWSCredentials
+
+        attr_accessor :region, :output, :aws_key, :aws_secret
+
+    end
+
+end

data/lib/aws/aws_outputter.rb

@@ -0,0 +1,247 @@
+require 'date'
+require 'columnist'
+
+module App
+
+    class AWSOutputter
+
+        EC2_INSTANCES       = 'ec2_instances'
+        EC2_VOLUMES         = 'ec2_volumes'
+        EC2_SECURITY_GROUPS = 'ec2_security_groups'
+        S3_BUCKETS          = 's3_buckets'
+        RDS_MYSQL_INSTANCES = 'rds_mysql_instances'
+        SQS_QUEUES          = 'sqs_queues'
+
+        HEADER_COLOR     = 255
+        DIVIDER_COLOR    = 240
+        DIM_COLOR        = 246
+        CONSTRAINT_COLOR = 67
+
+        REGION_WIDTH = 15
+
+        extend Columnist
+
+        # Outputs EC2 data to terminal.
+        # @return void
+        def self.display(resource_title, resource, column_data, output, total_width, opts, args)
+
+            output = [] if output.nil?
+
+            @terminal_width = Blufin::Terminal::get_terminal_width
+
+            wildcard_width = @terminal_width - total_width - 8 - (column_data.length)
+
+            puts "  \x1B[38;5;255m\x1B[48;5;54m #{output.length} \x1B[48;5;18m #{resource_title} \x1B[0m"
+            puts
+            table(:border => false) do
+
+                row do
+                    column('', :width => 2, :color => HEADER_COLOR)
+                    column_data.each do |title, data|
+                        column(title, :width => get_width(data[:width], wildcard_width), :color => HEADER_COLOR)
+                    end
+                    column('', :width => 2, :color => HEADER_COLOR)
+                end
+
+                row do
+                    column('')
+                    column_data.each do |title, data|
+                        column('-' * get_width(data[:width], wildcard_width), :color => DIVIDER_COLOR)
+                    end
+                    column('')
+                end
+
+                output.each do |item|
+                    row do
+                        column('')
+                        column_data.each do |title, data|
+                            color        = data[:color].nil? ? 'default' : data[:color]
+                            value        = get_value(data[:key], item)
+                            value, color = get_formatter(data[:formatter], resource: resource, color: color).call(value) unless data[:formatter].nil?
+                            column(value, :color => get_color(color))
+                        end
+                        column('')
+                    end
+                end
+
+            end
+            puts
+
+        end
+
+        # Displays CF parameters in a table (currently during the CF intro screen).
+        # @return void
+        def self.display_parameters(table_data)
+            raise RuntimeError, "Expected Array, instead got: #{table_data.class}" unless table_data.is_a?(Array)
+            return unless table_data.any?
+            # Must match widths below (minus remaining).
+            tw            = Blufin::Terminal::get_terminal_width
+            column_short  = 5
+            column_widths = [32, 15, 75, 25, column_short, column_short, column_short, column_short]
+            remaining     = tw - column_widths.inject(0) { |sum, x| sum + x } - 16
+            column_widths << remaining
+            table(:border => false) do
+                row do
+                    column('', :width => 2, :color => HEADER_COLOR)
+                    column('Parameter', :width => 32, :color => HEADER_COLOR)
+                    column('Type', :width => 15, :color => HEADER_COLOR)
+                    column('Description', :width => 75, :color => HEADER_COLOR)
+                    column('AllowedPattern', :width => 25, :color => HEADER_COLOR)
+                    column('Min-L', :width => column_short, :color => HEADER_COLOR)
+                    column('Max-L', :width => column_short, :color => HEADER_COLOR)
+                    column('Min-V', :width => column_short, :color => HEADER_COLOR)
+                    column('Max-V', :width => column_short, :color => HEADER_COLOR)
+                    column('Cached Value(s)', :width => remaining, :color => HEADER_COLOR)
+                    column('', :width => 2, :color => HEADER_COLOR)
+                end
+                row do
+                    column('')
+                    column_widths.each do |width|
+                        column('-' * width, :color => DIVIDER_COLOR)
+                    end
+                    column('')
+                end
+                table_data.each do |data|
+                    alp = data[:allowed_pattern]
+                    mil = data[:min_length]
+                    miv = data[:min_value]
+                    mal = data[:max_length]
+                    mav = data[:max_value]
+                    cop = 'light-green'
+                    cop = 'purple' if data[:type_internal] == :autocomplete
+                    cop = 'yellow' if data[:type_internal] == :system || [AppCommand::AWSCloudFormationCreate::OPTION_STACK_NAME, AppCommand::AWSCloudFormationCreate::OPTION_DESCRIPTION].include?(data[:parameter])
+                    # In case you want to change color in future, currently this is redundant.
+                    cod = data[:type_internal] == :system ? 'default' : 'default'
+                    cot = data[:type_internal] == :system ? 'default' : 'default'
+                    cot = data[:type] == AppCommand::AWSCloudFormationCreate::SPECIAL ? 'light-grey' : cot
+                    row do
+                        column('')
+                        column(data[:parameter], :color => get_color(cop))
+                        column(data[:type], :color => get_color(cot))
+                        column(data[:description], :color => get_color(cod))
+                        column(alp.nil? ? "\xe2\x80\x94" : alp, :color => alp.nil? ? get_color('default') : CONSTRAINT_COLOR)
+                        column(mil.nil? ? "\xe2\x80\x94".rjust(column_short, ' ') : mil.to_s.rjust(column_short, ' '), :color => mil.nil? ? get_color('default') : CONSTRAINT_COLOR)
+                        column(mal.nil? ? "\xe2\x80\x94".rjust(column_short, ' ') : mal.to_s.rjust(column_short, ' '), :color => mal.nil? ? get_color('default') : CONSTRAINT_COLOR)
+                        column(miv.nil? ? "\xe2\x80\x94".rjust(column_short, ' ') : miv.to_s.rjust(column_short, ' '), :color => miv.nil? ? get_color('default') : CONSTRAINT_COLOR)
+                        column(mav.nil? ? "\xe2\x80\x94".rjust(column_short, ' ') : mav.to_s.rjust(column_short, ' '), :color => mav.nil? ? get_color('default') : CONSTRAINT_COLOR)
+                        column(data[:cached_value], :color => get_color('green'))
+                        column('')
+                    end
+                end
+            end
+        end
+
+        private
+
+        # Recursively get nested keys. Does not handle Arrays.
+        # @return string
+        def self.get_value(key, item)
+            return '—' if item.nil? || !item.is_a?(Hash)
+            ks = key.split('.')
+            fk = ks[0]
+            ks.shift
+            if ks.length == 0
+                return '—' unless item.has_key?(key) # If key not found, return mdash.
+                item[fk]
+            else
+                get_value(ks.join('.'), item[fk])
+            end
+        end
+
+        # Define all custom formatters here.
+        # @return void
+        def self.get_formatter(key = nil, resource: nil, color: 'default')
+            formatters = {
+                'cloudfront-status'       => Proc.new { |n|
+                    case n
+                        when 'Deployed'
+                            color = 'green'
+                        else
+                            Blufin::Terminal::output("Add something to aws_outputter switch statement for: #{n}", Blufin::Terminal::MSG_TODO)
+                            color = 'default'
+                    end
+                    [n, color]
+                },
+                'ec2-security-groups'     => Proc.new { |n|
+                    security_groups = []
+                    if n.any?
+                        n.each do |security_group|
+                            group_name = security_group['GroupName']
+                            group_name = 'N/A' if group_name.strip == '' || group_name.nil?
+                            security_groups << group_name
+                        end
+                    end
+                    security_groups.sort!
+                    security_group = security_groups.include?('default') ? 'default' : security_groups[0]
+                    security_group = "#{security_group}+#{security_groups.length - 1}" if security_groups.length > 1
+                    [security_group, 'default']
+                },
+                'ec2-status'              => Proc.new { |n|
+                    case n
+                        when 'pending'
+                            color = 'orange'
+                        when 'running'
+                            color = 'green'
+                        when 'in-use'
+                            color = 'green'
+                        when 'stopped'
+                            color = 'dark-grey'
+                        when 'terminated'
+                            color = 'red'
+                        else
+                            Blufin::Terminal::output("Add something to aws_outputter switch statement for: #{n}", Blufin::Terminal::MSG_TODO)
+                            color = 'default'
+                    end
+                    [n, color]
+                },
+                'epoch-date'              => Proc.new { |n|
+                    [DateTime.strptime(n.to_s, '%s'), color]
+                },
+                'region'                  => Proc.new { |n|
+                    preferred_regions = resource.nil? ? [] : resource[App::AWSReports::KEY_REGIONS_PREFERRED]
+                    region_color      = preferred_regions.include?(n) ? 'brown' : 'red'
+                    region            = n.ljust(10, ' ')
+                    [region, region_color]
+                },
+                'route-53-hosted-zone-id' => Proc.new { |n|
+                    zone_color = color
+                    ns         = n.split('/')
+                    [ns[ns.length - 1], zone_color]
+                },
+            }
+            raise RuntimeError, "Key not found: #{key}" unless key.nil? || formatters.has_key?(key)
+            return formatters.keys if key.nil?
+            formatters[key]
+        end
+
+        # Define all custom colors here.
+        # @return void
+        def self.get_color(key = nil)
+            colors = {
+                'default'     => 240,
+                'red'         => 196,
+                'orange'      => 202,
+                'yellow'      => 220,
+                'green'       => 46,
+                'blue'        => 39,
+                'purple'      => 61,
+                'pink'        => 198,
+                'brown'       => 94,
+                'light-grey'  => 246,
+                'light-green' => 77,
+                'dark-grey'   => 240,
+            }
+            raise RuntimeError, "Key not found: #{key}" unless key.nil? || colors.has_key?(key)
+            return colors.keys if key.nil?
+            colors[key]
+        end
+
+        # Determines whether to get width or wildcard width.
+        # @return
+        def self.get_width(width, wildcard_width)
+            (width == '*') ? wildcard_width : width
+        end
+
+    end
+
+end