aws-rds 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7be12a77884fd789c875e11b795c0a8f8dccb339169894ca2f984fb294dac3cc
-  data.tar.gz: 744ab0dfa092e5a89125653963452cb7b62d4d491f0c424c2d494b76ae56ee98
+  metadata.gz: 16ecd0d223d71b7e91fa20b144a22313bda81df011baecc40bac52e8bc926920
+  data.tar.gz: 37586608aebb1ea689da67b972df6820b1ce7d86d4821ac99b555509273bd0a1
 SHA512:
-  metadata.gz: d1cadeebb9fc5d7ff6bfafe7b1dbea9f6738b6ac94ef9249057105ee033cf0573d3f4abf2fab07d993a79a6f8af185b79456e79cdc6b097626ae673f8b4481ff
-  data.tar.gz: 31b60445cbe763eef13070a782075615166223747821e75ca6e6f9dd6800fb0ac9db0c93dc840d54a99275650f267d3b7e591d227bb6466c620bf3d8d89a6fa8
+  metadata.gz: 795d2625a798788841763c2389dae931e7bfd940138c62f94f065d05094df43157af003025577d2645aacd521fd8ec05db324ad33f948dd225a9b2dd762be25c
+  data.tar.gz: df2ae5fcef01b1fdb012c06303a99b8b95085be3d30948f6ca9ebad4e0586daa260d312f7b8409098a5ea9265f95124350c810c51b417ecd87c34d88b696c3e8

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.2.0]
+- allow erb usage in profiles, can reference config values
+- rework profile and params to classes. profile no longer merged
+
 ## [0.1.2]
 - remove require byebug
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    aws-rds (0.0.1)
+    aws-rds (0.1.2)
       activesupport
       aws-sdk-ec2
       aws-sdk-rds
@@ -17,7 +17,7 @@ GEM
       i18n (~> 0.7)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    aws-partitions (1.55.0)
+    aws-partitions (1.57.0)
     aws-sdk-core (3.14.0)
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.0)
@@ -29,78 +29,40 @@ GEM
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
     aws-sigv4 (1.0.2)
-    byebug (9.1.0)
-    celluloid (0.16.0)
-      timers (~> 4.0.0)
-    codeclimate-test-reporter (0.4.4)
-      simplecov (>= 0.7.1, < 1.0.0)
-    coderay (1.1.0)
+    byebug (10.0.0)
+    codeclimate-test-reporter (1.0.8)
+      simplecov (<= 0.13)
     colorize (0.8.1)
     concurrent-ruby (1.0.5)
-    diff-lcs (1.2.5)
+    diff-lcs (1.3)
     docile (1.1.5)
-    ffi (1.9.6)
-    formatador (0.2.5)
-    guard (2.10.5)
-      formatador (>= 0.2.4)
-      listen (~> 2.7)
-      lumberjack (~> 1.0)
-      nenv (~> 0.1)
-      pry (>= 0.9.12)
-      thor (>= 0.18.1)
-    guard-bundler (2.1.0)
-      bundler (~> 1.0)
-      guard (~> 2.2)
-      guard-compat (~> 1.1)
-    guard-compat (1.2.0)
-    guard-rspec (4.5.0)
-      guard (~> 2.1)
-      guard-compat (~> 1.1)
-      rspec (>= 2.99.0, < 4.0)
     hashie (3.5.7)
-    hitimes (1.2.2)
-    i18n (0.9.1)
+    i18n (0.9.3)
       concurrent-ruby (~> 1.0)
     jmespath (1.3.1)
-    listen (2.8.4)
-      celluloid (>= 0.15.2)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9)
-    lumberjack (1.0.9)
-    method_source (0.8.2)
-    minitest (5.11.1)
-    multi_json (1.10.1)
-    nenv (0.1.1)
-    pry (0.10.1)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rake (10.4.2)
-    rb-fsevent (0.9.4)
-    rb-inotify (0.9.5)
-      ffi (>= 0.5.0)
-    rspec (3.1.0)
-      rspec-core (~> 3.1.0)
-      rspec-expectations (~> 3.1.0)
-      rspec-mocks (~> 3.1.0)
-    rspec-core (3.1.7)
-      rspec-support (~> 3.1.0)
-    rspec-expectations (3.1.2)
+    json (2.1.0)
+    minitest (5.11.3)
+    rake (12.3.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.1.0)
-    rspec-mocks (3.1.3)
-      rspec-support (~> 3.1.0)
-    rspec-support (3.1.2)
-    simplecov (0.9.1)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    simplecov (0.13.0)
       docile (~> 1.1.0)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
-    slop (3.6.0)
-    thor (0.19.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thor (0.20.0)
     thread_safe (0.3.6)
-    timers (4.0.1)
-      hitimes
     tzinfo (1.2.4)
       thread_safe (~> 0.1)
 
@@ -112,10 +74,8 @@ DEPENDENCIES
   bundler
   byebug
   codeclimate-test-reporter
-  guard
-  guard-bundler
-  guard-rspec
   rake
+  rspec
 
 BUNDLED WITH
    1.16.1

data/README.md

@@ -4,8 +4,8 @@ Simple tool to create AWS RDS db instances consistently with pre-configured sett
 
 For example, say you have:
 
-* profiles/default.yml: default settings.  Takes the lowest precedence.
-* profiles/mydb.yml: mydb settings get combined with the default settings
+* profiles/default.yml: default settings, when no profile is specified.
+* profiles/mydb.yml: mydb settings.
 
 ## Usage
 
@@ -16,11 +16,11 @@ aws-rds create mydb --profile mydb --db-name mydbname
 * mydb will be the RDS database identifier show on the AWS console
 * mydbname is the database name that contains the tables
 
-In a nutshell, the profile parameters are passed to the ruby aws-sdk [AWS::RDS::Client#create_db_instance](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/Client.html#create_db_instance-instance_method) method.  So you can specify any parameter you wish that is available there.  To check out what a profile looks like look at the [example default](example/profiles/default.yml)
+In a nutshell, the profile parameters are passed to the ruby aws-sdk [AWS::RDS::Client#create_db_instance](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/Client.html#create_db_instance-instance_method) method.  So you can specify any parameter you wish that is available in the aws-sdk.  To check out what a profile looks like view the [example default](example/profiles/default.yml)
 
 ## config
 
-This is where you put common global settings. The required settings are listed below.  Example:
+You can configure common global settings. The required settings are listed below.  Example:
 
 `config/development.yml`
 
@@ -31,15 +31,15 @@ db_subnet_group_name: private-subnet-group-name # fallback db_subnet_group_name
 
 ## Security Group Creation
 
-The tool automatically creates a security group and associates it with the newly created db. This is done so that you can use it to control access to the database in finely tune manner. Otherwise, the default security group is associated with the db.
+The tool automatically creates a security group and associates it with the newly created db. Normally the default security group is associated with the db. A new security group allows you to control access to the database in finely tune manner without affecting the default security group.
 
 ## Convention
 
-By convention, the security-group and profile will match the db identifier.  So if the db identifier matches the commands the be simplified.  Examples:
+By convention, the security-group name is the same as the db identifier.  So if the db identifier matches the commands the be simplified.  Examples:
 
 ```
-aws-rds create mydb --security-group-name mydb --profile mydb
-aws-rds create mydb # same as above
+aws-rds create mydb --profile myprofile --security-group-name mydb
+aws-rds create mydb --profile myprofile # same as above
 ```
 
 ## More Help

data/lib/aws-rds.rb

@@ -1,11 +1,14 @@
 $:.unshift(File.expand_path("../", __FILE__))
 require "aws_rds/version"
+require "colorize"
 
 module AwsRds
   autoload :Help, "aws_rds/help"
   autoload :Command, "aws_rds/command"
   autoload :CLI, "aws_rds/cli"
   autoload :AwsServices, "aws_rds/aws_services"
+  autoload :Profile, "aws_rds/profile"
+  autoload :TemplateHelper, "aws_rds/template_helper"
   autoload :Create, "aws_rds/create"
   autoload :SecurityGroup, "aws_rds/security_group"
   autoload :Config, "aws_rds/config"

data/lib/aws_rds/command.rb

@@ -1,5 +1,18 @@
 require "thor"
 
+# Override thor's long_desc identation behavior
+# https://github.com/erikhuda/thor/issues/398
+class Thor
+  module Shell
+    class Basic
+      def print_wrapped(message, options = {})
+        message = "\n#{message}" unless message[0] == "\n"
+        stdout.puts message
+      end
+    end
+  end
+end
+
 module AwsRds
   class Command < Thor
     class << self

data/lib/aws_rds/create.rb

@@ -3,6 +3,8 @@ require 'active_support/core_ext/hash'
 
 module AwsRds
   class Create
+    autoload :Params, "aws_rds/create/params"
+
     include AwsServices
 
     def initialize(options)
@@ -22,80 +24,8 @@ module AwsRds
       puts "Visit https://console.aws.amazon.com/rds/home?#dbinstances to check on the status"
     end
 
-    # params are taken from the profile file
     def params
-      params = load_profiles(profile_name)
-      params = use_database_cli_options(params)
-      params = set_security_groups(params)
-      params = set_db_subnet_group(params)
-      params.symbolize_keys
-    end
-
-    def set_db_subnet_group(params)
-      params["db_subnet_group_name"] ||= AwsRds.config["db_subnet_group_name"]
-      params
-    end
-
-    def set_security_groups(params)
-      return params unless @options[:security_group]
-      return params if @options[:noop]
-
-      security_group_name = @options[:security_group_name] || @options[:name]
-      sg = SecurityGroup.find_or_create(security_group_name)
-      params['vpc_security_group_ids'] ||= [sg.group_id]
-      params
-    end
-
-    # Be able to set the common database options with the CLI options.
-    # Other options can be set with the profile files.
-    def use_database_cli_options(params)
-      params['db_instance_identifier'] = @options[:name] # required
-      params['db_name'] = @options[:db_name] if @options[:db_name]
-      params['master_username'] = @options[:db_user] if @options[:db_user]
-      params['master_user_password'] = @options[:db_password] if @options[:db_password]
-      params
-    end
-
-    def load_profiles(profile_name)
-      profile_file = "#{root}/profiles/#{profile_name}.yml"
-      base_path = File.dirname(profile_file)
-      default_file = "#{base_path}/default.yml"
-
-      params_exit_check!(profile_file, default_file)
-
-      defaults = load_profile(default_file)
-      params = load_profile(profile_file)
-      params = defaults.merge(params)
-    end
-
-    def params_exit_check!(profile_file, default_file)
-      return if File.exist?(profile_file) or File.exist?(default_file)
-
-      puts "Unable to find a #{profile_file} or #{default_file} profile file."
-      puts "Please double check."
-      exit # EXIT HERE
-    end
-
-    def load_profile(file)
-      return {} unless File.exist?(file)
-
-      puts "Using profile: #{file}"
-      data = YAML.load_file(file)
-      data ? data : {} # in case the file is empty
-    end
-
-    def profile_name
-      # allow user to specify the path also
-      if @options[:profile] && File.exist?(@options[:profile])
-        profile = File.basename(@options[:profile], '.yml')
-      end
-
-      # conventional profile is the name of the ec2 instance
-      profile || @options[:profile] || @options[:name]
-    end
-
-    def root
-      ENV['AWS_RDS_ROOT'] || '.'
+      @params ||= Params.new(@options).generate
     end
 
     def pretty_display(data)

data/lib/aws_rds/create/params.rb

@@ -0,0 +1,40 @@
+class AwsRds::Create
+  class Params
+    def initialize(options)
+      @options = options
+    end
+
+    def generate
+      params = AwsRds::Profile.new(@options).load
+      params = use_database_cli_options(params)
+      params = set_security_groups(params)
+      params = set_db_subnet_group(params)
+      params.symbolize_keys
+    end
+
+    # Be able to set the common database options with the CLI options.
+    # Other options can be set with the profile files.
+    def use_database_cli_options(params)
+      params['db_instance_identifier'] = @options[:name] # required
+      params['db_name'] = @options[:db_name] if @options[:db_name]
+      params['master_username'] = @options[:db_user] if @options[:db_user]
+      params['master_user_password'] = @options[:db_password] if @options[:db_password]
+      params
+    end
+
+    def set_security_groups(params)
+      return params unless @options[:security_group]
+      return params if @options[:noop]
+
+      security_group_name = @options[:security_group_name] || @options[:name]
+      sg = AwsRds::SecurityGroup.find_or_create(security_group_name)
+      params['vpc_security_group_ids'] ||= [sg.group_id]
+      params
+    end
+
+    def set_db_subnet_group(params)
+      params["db_subnet_group_name"] ||= AwsRds.config["db_subnet_group_name"]
+      params
+    end
+  end
+end

data/lib/aws_rds/help/create.md

@@ -1,24 +1,13 @@
-The create command creates an RDS database with a profile file with some pre-configured parameters in the profiles folder.  If a profile does not exist, it will only use the `profiles/default.yml` parameters.  If a profile exists then it will merged specified profile with the default profile.
-
-For example, say you have:
-
-* profiles/default.yml
-* profiles/my-db.yml
-
-Then `my-db.yml` gets combined with `default.yml` profile.  The `default.yml` takes the lowest precedence.
+The create command creates an RDS database with a profile file with some pre-configured settings.   The profile file is in the profiles folder.  If a profile is not specified, it will only use the `profiles/default.yml` profile.
 
 Examples:
 
-$ aws-rds create my-db --profile my-db
-
-By convention, the profile is name of the db.  So the command above can be shortened to:
-
-$ aws-rds create my-db
+  aws-rds create my-db --profile my-db
 
 Security Groups:
 
 By default, instead of using the default security group, a new security group is created and associated with the database.
 
-This security group is named the same as the database name by convention.  This can be overridden at with `--security-group-name`.  If the security group already exists, it will use the existing security group that matches the name.
+This security group's name is the same as database name by convention.  This can be overridden at with `--security-group-name`.  If the security group already exists, it will use the existing security group that matches the name.
 
 If you do not want to specify the security group name every time, you can configure the security group id in the profile file by setting vpc_security_group_ids.

data/lib/aws_rds/profile.rb

@@ -0,0 +1,48 @@
+module AwsRds
+  class Profile
+    include TemplateHelper
+
+    def initialize(options)
+      @options = options
+    end
+
+    def load
+      return @profile_params if @profile_params
+
+      check!
+
+      @profile_params = load_profile(profile_file)
+    end
+
+    def check!
+      return if File.exist?(profile_file)
+
+      puts "Unable to find a #{profile_file.colorize(:green)} profile file."
+      puts "Please double check that it exists or that you specified the right profile."
+      exit # EXIT HERE
+    end
+
+    def load_profile(file)
+      return {} unless File.exist?(file)
+
+      puts "Using profile: #{file}"
+      data = YAML.load(erb_result(file))
+      data ? data : {} # in case the file is empty
+      data.has_key?("create_db_instance") ? data["create_db_instance"] : data
+    end
+
+    def profile_file
+      "#{AwsRds.root}/profiles/#{profile_name}.yml"
+    end
+
+    def profile_name
+      # allow user to specify the path also
+      if @options[:profile] && File.exist?(@options[:profile])
+        profile = File.basename(@options[:profile], '.yml')
+      end
+
+      # conventional profile is the name of the ec2 instance
+      profile || @options[:profile] || "default"
+    end
+  end
+end

data/lib/aws_rds/template_helper.rb

@@ -0,0 +1,61 @@
+require "erb"
+
+module AwsRds::TemplateHelper
+  def config
+    AwsRds.config
+  end
+
+  private
+  def load_custom_helpers
+    Dir.glob("#{AwsRds.root}/app/helpers/**/*_helper.rb").each do |path|
+      filename = path.sub(%r{.*/},'').sub('.rb','')
+      module_name = filename.classify
+
+      require path
+      self.class.send :include, module_name.constantize
+    end
+
+  end
+
+  def erb_result(path)
+    load_custom_helpers
+    template = IO.read(path)
+
+    # Allow a way to bypass the custom ERB error handling in case
+    # the error is in the lambdagem code.
+    if ENV['DEBUG']
+      return ERB.new(template, nil, "-").result(binding)
+    end
+
+    begin
+      ERB.new(template, nil, "-").result(binding)
+    rescue Exception => e
+      puts e
+
+      # how to know where ERB stopped? - https://www.ruby-forum.com/topic/182051
+      # syntax errors have the (erb):xxx info in e.message
+      # undefined variables have (erb):xxx info in e.backtrac
+      error_info = e.message.split("\n").grep(/\(erb\)/)[0]
+      error_info ||= e.backtrace.grep(/\(erb\)/)[0]
+      raise unless error_info # unable to find the (erb):xxx: error line
+      line = error_info.split(':')[1].to_i
+      puts "Error evaluating ERB template on line #{line.to_s.colorize(:red)} of: #{path.sub(/^\.\//, '')}"
+
+      template_lines = template.split("\n")
+      context = 5 # lines of context
+      top, bottom = [line-context-1, 0].max, line+context-1
+      spacing = template_lines.size.to_s.size
+      template_lines[top..bottom].each_with_index do |line_content, index|
+        line_number = top+index+1
+        if line_number == line
+          printf("%#{spacing}d %s\n".colorize(:red), line_number, line_content)
+        else
+          printf("%#{spacing}d %s\n", line_number, line_content)
+        end
+      end
+
+      puts "\nIf the this error does not make sense and the error is not in the ERB template. Run the command again with DEBUG=1 to show the full lambdagem backtrace"
+      exit 1 unless ENV['TEST']
+    end
+  end
+end

data/lib/aws_rds/version.rb

@@ -1,3 +1,3 @@
 module AwsRds
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/spec/fixtures/demo_project/profiles/default.yml

@@ -0,0 +1,10 @@
+---
+allocated_storage: 20
+db_instance_class: db.t2.micro
+master_user_password: aws-rds
+master_username: aws-rds
+engine: postgres
+
+# db_name: mydb # can be overridden at the cli
+# vpc_security_group_ids: # automatically created for you if not set
+# db_instance_identifier: not respected here. always set from the cli

data/spec/lib/cli_spec.rb

@@ -7,13 +7,13 @@ require "spec_helper"
 #   $ rake clean:vcr ; time rake
 describe AwsRds::CLI do
   before(:all) do
-    @args = "--from Tung"
+    @args = "--noop"
   end
 
   describe "aws-rds" do
-    it "should hello world" do
-      out = execute("exe/aws-rds hello world #{@args}")
-      expect(out).to include("from: Tung\nHello world")
+    it "create" do
+      out = execute("exe/aws-rds create mydb #{@args}")
+      expect(out).to include("Creating")
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,7 +1,8 @@
 ENV["TEST"] = "1"
-
-# require "simplecov"
-# SimpleCov.start
+ENV["AWS_RDS_ENV"] = "test"
+ENV["AWS_RDS_ROOT"] = "spec/fixtures/demo_project"
+# Ensures aws api never called. Fixture home folder does not contain ~/.aws/credentails
+ENV['HOME'] = "spec/fixtures/home"
 
 require "pp"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-rds
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-19 00:00:00.000000000 Z
+date: 2018-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -181,11 +181,15 @@ files:
 - lib/aws_rds/config.rb
 - lib/aws_rds/core.rb
 - lib/aws_rds/create.rb
+- lib/aws_rds/create/params.rb
 - lib/aws_rds/default.yml
 - lib/aws_rds/help.rb
 - lib/aws_rds/help/create.md
+- lib/aws_rds/profile.rb
 - lib/aws_rds/security_group.rb
+- lib/aws_rds/template_helper.rb
 - lib/aws_rds/version.rb
+- spec/fixtures/demo_project/profiles/default.yml
 - spec/lib/cli_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/tongueroo/aws-rds
@@ -213,5 +217,6 @@ signing_key:
 specification_version: 4
 summary: RDS DB creation tool
 test_files:
+- spec/fixtures/demo_project/profiles/default.yml
 - spec/lib/cli_spec.rb
 - spec/spec_helper.rb