geoengineer 0.1.0

data/spec/spec_helper.rb

@@ -0,0 +1,71 @@
+require 'rspec'
+require_relative '../lib/geoengineer'
+require 'pry'
+
+# https://ruby.awsblog.com/post/Tx2SU6TYJWQQLC3/Stubbing-AWS-Responses
+AwsClients.stub!
+
+# Common Resource Class Tests
+# rubocop:disable Metrics/AbcSize
+def init_test(clazz_name)
+  it "should initialize and error" do
+    env = GeoEngineer::Environment.new("name")
+    res = env.resource(clazz_name, 'id') {
+      some_value 10
+      sub_resource {
+        another_value 20
+      }
+    }
+    expect(res.some_value).to eq 10
+    expect(res.sub_resource.another_value).to eq 20
+    expect(res.errors.length).to_not eq 0
+  end
+end
+
+def mapping_tests(clazz, clazz_name)
+  it 'should be identified from #get_resource_class_from_type' do
+    gen_clazz = GeoEngineer::Environment.get_resource_class_from_type(clazz_name)
+    expect(gen_clazz).to eq clazz
+  end
+
+  it 'should derive its type from its class with #type_from_class_name' do
+    clazz_name = clazz.type_from_class_name
+    expect(clazz_name).to eq clazz_name
+  end
+end
+
+def fetch_empty_should_work(clazz)
+  it 'should work with emtpy response' do
+    remote_resources = clazz._fetch_remote_resources
+    expect(remote_resources.length).to eq 0
+  end
+end
+
+def common_resource_tests(clazz, clazz_name)
+  describe 'init test' do
+    init_test(clazz_name)
+  end
+
+  describe "class mapping" do
+    mapping_tests(clazz, clazz_name)
+  end
+
+  describe "#_fetch_remote_resources" do
+    fetch_empty_should_work(clazz)
+  end
+end
+
+def name_tag_geo_id_tests(clazz)
+  describe "_terraform_id and _geo_id" do
+    it 'should get terraform_id from remote by matching geo_ids' do
+      clazz.clear_remote_resource_cache
+      remote_resources = [{ _geo_id: 'geo_id', _terraform_id: 't_id' }]
+      allow(clazz).to(receive(:_fetch_remote_resources).and_return(remote_resources))
+      res = clazz.new('type', 'id') {
+        tags { Name 'geo_id' }
+      }
+      expect(res._geo_id).to eq 'geo_id'
+      expect(res.remote_resource._terraform_id).to eq 't_id'
+    end
+  end
+end

data/spec/sub_resource_spec.rb

@@ -0,0 +1,20 @@
+require_relative './spec_helper'
+
+describe("GeoEngineer::SubResource") do
+  it 'should work' do
+    sr = GeoEngineer::SubResource.new(nil, 'tags') {
+      x 10
+    }
+    expect(sr.x).to eq 10
+  end
+
+  describe '#to_terraform_json' do
+    it 'should return a list, with key[0] value[1]' do
+      sr = GeoEngineer::SubResource.new(nil, 'tags') {
+        x 10
+      }
+      expect(sr.to_terraform_json[0]).to eq 'tags'
+      expect(sr.to_terraform_json[1]['x']).to eq 10
+    end
+  end
+end

data/spec/template_spec.rb

@@ -0,0 +1,39 @@
+require_relative './spec_helper'
+
+describe("GeoEngineer::Template") do
+  class CustomTemplate < GeoEngineer::Template
+    attr_reader :res1, :res2
+
+    def initialize(name, project, parameters)
+      super(name, project, parameters)
+
+      res1 = resource('type', '1') {
+        name "Resource1"
+        param parameters[:res1]
+      }
+
+      res2 = resource('type', '2') {
+        name "Resource2"
+        rel  res1
+      }
+
+      @res1 = res1
+      @res2 = res2
+    end
+
+    def template_resources
+      [@res1, @res2]
+    end
+  end
+
+  it 'should be extendable' do
+    project = NullObject.new
+    template = CustomTemplate.new("custom_template", project, { res1: "Res1" })
+
+    expect(template.res1.name).to eq "Resource1"
+    expect(template.res1.param).to eq "Res1"
+
+    expect(template.res2.name).to eq "Resource2"
+    expect(template.res2.rel).to eq template.res1
+  end
+end

data/spec/utils/has_attributes_spec.rb

@@ -0,0 +1,118 @@
+require_relative '../spec_helper'
+
+describe("HasAttributes") do
+  class WithAttributes
+    include HasAttributes
+    attr_reader :block_handled
+    def assign_block(name, *args, &block)
+      @block_handled = name
+    end
+  end
+
+  describe('#[]') do
+    it 'should return array of arrays' do
+      x = WithAttributes.new
+      x[:id] = "1"
+      expect(x[:id]).to eq "1"
+    end
+  end
+
+  describe('#terraform_attributes') do
+    it 'should return a hash of attributes' do
+      x = WithAttributes.new
+      x.id = "1"
+      expect(x.terraform_attributes.length).to eq 1
+      expect(x.terraform_attributes["id"]).to eq "1"
+    end
+
+    it 'should remove attribute _terraform_id' do
+      x = WithAttributes.new
+      x._terraform_id = "1"
+      x.id = "1"
+      expect(x.terraform_attributes.length).to eq 1
+    end
+
+    it 'should remove attributes starting with _' do
+      x = WithAttributes.new
+      x._private_id = "1"
+      x.id = "1"
+      expect(x.terraform_attributes.length).to eq 1
+    end
+
+    it 'should remove attributes where values are nil' do
+      x = WithAttributes.new
+      x.id = nil
+      expect(x.terraform_attributes.length).to eq 0
+    end
+
+    it 'should convert resources values to references (including in arrays)' do
+      x = WithAttributes.new
+      x.reference = GeoEngineer::Resource.new("type", "idd")
+      expect(x.terraform_attributes["reference"]).to eq "${type.idd.id}"
+    end
+  end
+
+  describe('bad attributes') do
+    it 'timeout attribute should work' do
+      x = WithAttributes.new
+      x.timeout = 10
+      expect(x.timeout).to eq 10
+    end
+  end
+
+  describe('#method_missing') do
+    it 'should call assign_block if a block is passed' do
+      x = WithAttributes.new
+      expect(x.block_handled).to eq nil
+      x.block {
+        block true
+      }
+      expect(x.block_handled).to eq 'block'
+    end
+
+    it 'should assign an attribute (with and without equals)' do
+      x = WithAttributes.new
+      x.attribute = "asd"
+      x.other_attribute "sdf"
+      expect(x.attribute).to eq "asd"
+      expect(x.other_attribute).to eq "sdf"
+    end
+
+    it 'should assign multiple attributes as an array' do
+      x = WithAttributes.new
+      x.attribute = 1, 2, 3
+      x.other_attribute 3, 4, 5
+      expect(x.attribute).to eq [1, 2, 3]
+      expect(x.other_attribute).to eq [3, 4, 5]
+    end
+
+    it 'should assign a Proc and lazy evaluate and cache the value' do
+      x = WithAttributes.new
+      called_count = 0
+      x.attribute = -> {
+        called_count += 1
+        "awesome"
+      }
+      expect(called_count).to eq 0
+      expect(x.attribute).to eq "awesome"
+      expect(called_count).to eq 1
+      expect(x.attribute).to eq "awesome"
+      expect(called_count).to eq 1
+    end
+
+    it 'should delete an attribute' do
+      x = WithAttributes.new
+      x.attribute = "asd"
+      expect(x.attribute).to eq "asd"
+      x.delete(:attribute)
+      expect(x.attribute).to eq nil
+    end
+
+    it 'should be usable with []' do
+      x = WithAttributes.new
+      x.attribute = "asd"
+      expect(x["attribute"]).to eq "asd"
+      expect(x[:attribute]).to eq "asd"
+    end
+  end
+end

data/spec/utils/has_lifecycle_spec.rb

@@ -0,0 +1,24 @@
+require_relative '../spec_helper'
+
+describe("HasLifecycle") do
+  it "should work" do
+    class Life
+      include HasLifecycle
+      attr_reader :called_count
+      after :initialize, -> { @called_count += 1 }
+      def initialize
+        @called_count = 0
+        execute_lifecycle(:after, :initialize)
+      end
+    end
+
+    class AfterLife < Life
+      after :initialize, -> { @called_count += 10 }
+    end
+
+    life       = Life.new()
+    after_life = AfterLife.new()
+    expect(life.called_count).to eq 1
+    expect(after_life.called_count).to eq 11
+  end
+end

data/spec/utils/has_resources_spec.rb

@@ -0,0 +1,68 @@
+require_relative '../spec_helper'
+
+describe("HasResources") do
+  class WithResources
+    include HasResources
+  end
+
+  class GeoEngineer::Resources::AwesomeResource < GeoEngineer::Resource
+  end
+
+  describe '#resources_grouped_by' do
+    it 'should return a hash of grouped resource' do
+      x = WithResources.new()
+      x.create_resource("type", "id") {
+        blue true
+      }
+      x.create_resource("type", "id") {
+        blue true
+      }
+      x.create_resource("type", "id") {
+        blue false
+      }
+      group = x.resources_grouped_by(&:blue)
+      expect(group[true].length).to eq 2
+      expect(group[false].length).to eq 1
+    end
+  end
+
+  describe('#get_resource_class_from_type') do
+    it 'should default to GeoEngineer::Resource' do
+      expect(WithResources.get_resource_class_from_type("asd")).to eq GeoEngineer::Resource
+    end
+
+    it 'should find a defined class' do
+      clazz = WithResources.get_resource_class_from_type("awesome_resource")
+      expect(clazz).to eq GeoEngineer::Resources::AwesomeResource
+    end
+  end
+
+  describe('#find_resource_by_ref') do
+    it 'should find a resource given terraform ref' do
+      x = WithResources.new()
+      x.create_resource("type", "id") {
+        value 10
+      }
+      expect(x.find_resource_by_ref('${type.id.param}').value).to eq 10
+    end
+  end
+
+  describe('#create_resource') do
+    it 'should add resources with a block' do
+      x = WithResources.new()
+      resource = x.create_resource("type", "id") {
+        value 20
+      }
+
+      expect(resource.value).to eq 20
+    end
+
+    it 'should look up the class for the resources' do
+      x = WithResources.new()
+      resource = x.create_resource("awesome_resource", "id") {
+        value 30
+      }
+      expect(resource.class).to eq GeoEngineer::Resources::AwesomeResource
+    end
+  end
+end

data/spec/utils/has_subresources_spec.rb

@@ -0,0 +1,29 @@
+require_relative '../spec_helper'
+
+describe("HasSubResources") do
+  it 'should add subresources with a block' do
+    class WithSubResources
+      include HasAttributes
+      include HasSubResources
+    end
+
+    x = WithSubResources.new()
+    x.one_sr {
+      value 10
+    }
+
+    expect(x.one_sr.value).to eq 10
+    expect(x.no_one_value).to eq nil
+
+    x.multi_sr {
+      value 20
+    }
+
+    x.multi_sr {
+      value 40
+    }
+
+    expect(x.all_multi_sr[0].value).to eq 20
+    expect(x.all_multi_sr[1].value).to eq 40
+  end
+end

data/spec/utils/has_validations_spec.rb

@@ -0,0 +1,35 @@
+require_relative '../spec_helper'
+
+describe("HasValidations") do
+  it "should work" do
+    class InValid
+      include HasValidations
+      validate -> { "ERROR MESSAGE" }
+    end
+
+    class Valid
+      include HasValidations
+      validate -> { nil }
+    end
+
+    valid   = Valid.new().errors
+    invalid = InValid.new().errors
+    expect(valid.length).to eq 0
+    expect(invalid.length).to eq 1
+  end
+
+  it "should include suberclass validations" do
+    class Super
+      include HasValidations
+      validate -> { "super" }
+    end
+
+    class Sub < Super
+      validate -> { "sub" }
+    end
+
+    errs = Sub.new().errors
+    expect(errs).to include('sub')
+    expect(errs).to include('super')
+  end
+end

data/spec/utils/null_object_spec.rb

@@ -0,0 +1,18 @@
+require_relative '../spec_helper'
+
+describe("NullObject") do
+  it "should not error on methods" do
+    no = NullObject.new()
+    expect(no.not_a_method).to eq nil
+  end
+end
+
+describe("NullObject.maybe") do
+  it "should create a NullObject or not" do
+    a = NullObject.maybe(nil)
+    expect(a.not_a_method).to eq nil
+
+    b = NullObject.maybe("b")
+    expect(b.to_s).to eq "b"
+  end
+end

metadata

@@ -0,0 +1,303 @@
+--- !ruby/object:Gem::Specification
+name: geoengineer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- coinbase
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.42'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.42'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: netaddr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: |2
+      GeoEngineer provides a Ruby DSL and command line tool (geo)
+      to codeify then plan and execute changes to cloud resources using Hashicorp Terraform.
+email:
+- graham.jenson@coinbase.com
+executables:
+- geo
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/geo
+- lib/geoengineer.rb
+- lib/geoengineer/cli/geo_cli.rb
+- lib/geoengineer/cli/status_command.rb
+- lib/geoengineer/cli/terraform_commands.rb
+- lib/geoengineer/environment.rb
+- lib/geoengineer/output.rb
+- lib/geoengineer/project.rb
+- lib/geoengineer/resource.rb
+- lib/geoengineer/resources/aws_db_instance.rb
+- lib/geoengineer/resources/aws_db_parameter_group.rb
+- lib/geoengineer/resources/aws_elasticache_cluster.rb
+- lib/geoengineer/resources/aws_elasticache_parameter_group.rb
+- lib/geoengineer/resources/aws_elasticache_replication_group.rb
+- lib/geoengineer/resources/aws_elasticache_subnet_group.rb
+- lib/geoengineer/resources/aws_elasticsearch_domain.rb
+- lib/geoengineer/resources/aws_elb.rb
+- lib/geoengineer/resources/aws_iam_policy.rb
+- lib/geoengineer/resources/aws_iam_user.rb
+- lib/geoengineer/resources/aws_instance.rb
+- lib/geoengineer/resources/aws_proxy_protocol_policy.rb
+- lib/geoengineer/resources/aws_redshift_cluster.rb
+- lib/geoengineer/resources/aws_route53_record.rb
+- lib/geoengineer/resources/aws_route53_zone.rb
+- lib/geoengineer/resources/aws_s3_bucket.rb
+- lib/geoengineer/resources/aws_security_group.rb
+- lib/geoengineer/resources/aws_ses_receipt_rule.rb
+- lib/geoengineer/resources/aws_ses_receipt_rule_set.rb
+- lib/geoengineer/resources/aws_sns_topic.rb
+- lib/geoengineer/resources/aws_sns_topic_subscription.rb
+- lib/geoengineer/resources/aws_sqs_queue.rb
+- lib/geoengineer/resources/iam/statement.rb
+- lib/geoengineer/sub_resource.rb
+- lib/geoengineer/template.rb
+- lib/geoengineer/utils/aws_clients.rb
+- lib/geoengineer/utils/has_attributes.rb
+- lib/geoengineer/utils/has_lifecycle.rb
+- lib/geoengineer/utils/has_resources.rb
+- lib/geoengineer/utils/has_sub_resources.rb
+- lib/geoengineer/utils/has_validations.rb
+- lib/geoengineer/utils/null_object.rb
+- lib/geoengineer/version.rb
+- spec/environment_spec.rb
+- spec/output_spec.rb
+- spec/project_spec.rb
+- spec/resource_spec.rb
+- spec/resources/aws_db_instance_spec.rb
+- spec/resources/aws_db_parameter_group_spec.rb
+- spec/resources/aws_elasticache_replication_group_spec.rb
+- spec/resources/aws_elasticache_subnet_group_spec.rb
+- spec/resources/aws_elasticcache_cluster_spec.rb
+- spec/resources/aws_elasticcache_parameter_group_spec.rb
+- spec/resources/aws_elasticsearch_domain_spec.rb
+- spec/resources/aws_elb_spec.rb
+- spec/resources/aws_iam_policy.rb
+- spec/resources/aws_iam_user.rb
+- spec/resources/aws_instance_spec.rb
+- spec/resources/aws_proxy_protocol_policy_spec.rb
+- spec/resources/aws_redshift_cluster_spec.rb
+- spec/resources/aws_route53_record_spec.rb
+- spec/resources/aws_route53_zone_spec.rb
+- spec/resources/aws_s3_bucket_spec.rb
+- spec/resources/aws_security_group_spec.rb
+- spec/resources/aws_ses_receipt_rule.rb
+- spec/resources/aws_ses_receipt_rule_set.rb
+- spec/resources/aws_sns_topic_spec.rb
+- spec/resources/aws_sns_topic_subscription.rb
+- spec/resources/aws_sqs_queue_spec.rb
+- spec/rubocop_spec.rb
+- spec/spec_helper.rb
+- spec/sub_resource_spec.rb
+- spec/template_spec.rb
+- spec/utils/has_attributes_spec.rb
+- spec/utils/has_lifecycle_spec.rb
+- spec/utils/has_resources_spec.rb
+- spec/utils/has_subresources_spec.rb
+- spec/utils/has_validations_spec.rb
+- spec/utils/null_object_spec.rb
+homepage: https://coinbase.github.io/geoengineer
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.5
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: GeoEngineer can codeify, plan and execute changes to cloud resources.
+test_files:
+- spec/environment_spec.rb
+- spec/output_spec.rb
+- spec/project_spec.rb
+- spec/resource_spec.rb
+- spec/resources/aws_db_instance_spec.rb
+- spec/resources/aws_db_parameter_group_spec.rb
+- spec/resources/aws_elasticache_replication_group_spec.rb
+- spec/resources/aws_elasticache_subnet_group_spec.rb
+- spec/resources/aws_elasticcache_cluster_spec.rb
+- spec/resources/aws_elasticcache_parameter_group_spec.rb
+- spec/resources/aws_elasticsearch_domain_spec.rb
+- spec/resources/aws_elb_spec.rb
+- spec/resources/aws_iam_policy.rb
+- spec/resources/aws_iam_user.rb
+- spec/resources/aws_instance_spec.rb
+- spec/resources/aws_proxy_protocol_policy_spec.rb
+- spec/resources/aws_redshift_cluster_spec.rb
+- spec/resources/aws_route53_record_spec.rb
+- spec/resources/aws_route53_zone_spec.rb
+- spec/resources/aws_s3_bucket_spec.rb
+- spec/resources/aws_security_group_spec.rb
+- spec/resources/aws_ses_receipt_rule.rb
+- spec/resources/aws_ses_receipt_rule_set.rb
+- spec/resources/aws_sns_topic_spec.rb
+- spec/resources/aws_sns_topic_subscription.rb
+- spec/resources/aws_sqs_queue_spec.rb
+- spec/rubocop_spec.rb
+- spec/spec_helper.rb
+- spec/sub_resource_spec.rb
+- spec/template_spec.rb
+- spec/utils/has_attributes_spec.rb
+- spec/utils/has_lifecycle_spec.rb
+- spec/utils/has_resources_spec.rb
+- spec/utils/has_subresources_spec.rb
+- spec/utils/has_validations_spec.rb
+- spec/utils/null_object_spec.rb