cluster-discovery 0.1.0

data/spec/lib/cluster/discovery/consul_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+describe 'Cluster::Discovery::Consul' do
+  describe '.initialize' do
+    context 'configuration is correct' do
+      it 'has the default url' do
+        consul = Cluster::Discovery::Consul.new
+        config = consul.instance_variable_get(:@configuration)
+        expect(config.url).to eq('http://localhost:8500')
+      end
+
+      it 'has a custom url' do
+        consul = Cluster::Discovery::Consul.new(
+          consul_url: 'http://127.0.0.1:8500')
+        config = consul.instance_variable_get(:@configuration)
+        expect(config.url).to eq('http://127.0.0.1:8500')
+      end
+    end
+  end
+
+  describe '.build_extra_opts' do
+    before(:each) do
+      @consul = Cluster::Discovery::Consul.new
+    end
+    context 'opts are correct without tags' do
+      let(:noleader_notags) do
+        [:all]
+      end
+
+      let(:leader_notags) do
+        [:first]
+      end
+
+      it 'can return only leader without tags' do
+        expect(
+          @consul.build_extra_opts(leader: false, tags: [])
+        ).to eq(noleader_notags)
+      end
+
+      it 'can return only all nodes' do
+        expect(
+          @consul.build_extra_opts(leader: true, tags: [])
+        ).to eq(leader_notags)
+      end
+    end
+
+    context 'opts are correct with tags' do
+      let(:noleader_tags) do
+        [:all, { tag: ['master'] }]
+      end
+
+      let(:leader_tags) do
+        [:first, { tag: ['master'] }]
+      end
+
+      it 'can return only leader without tags' do
+        expect(
+          @consul.build_extra_opts(leader: false, tags: ['master'])
+        ).to eq(noleader_tags)
+      end
+
+      it 'can return only all nodes' do
+        expect(
+          @consul.build_extra_opts(leader: true, tags: ['master'])
+        ).to eq(leader_tags)
+      end
+    end
+  end
+
+  describe '.discover', vcr: true do
+    before(:each) do
+      @consul = Cluster::Discovery::Consul.new(
+        consul_url: "http://#{test_consul_host}:8500")
+    end
+
+    def map_resp(obj)
+      obj.map(&:Address)
+    end
+
+    let(:consul_notags_leader) do
+      map_resp(@consul.discover(consul_service: 'redis', leader: true))
+    end
+
+    let(:consul_notags_noleader) do
+      map_resp(@consul.discover(consul_service: 'redis'))
+    end
+
+    let(:consul_tags_leader) do
+      map_resp(@consul.discover(
+                 consul_service: 'redis',
+                 leader: true,
+                 tags: 'master'))
+    end
+
+    let(:consul_tags_noleader) do
+      map_resp(@consul.discover(consul_service: 'redis', tags: 'master'))
+    end
+
+    context 'can discover leader node' do
+      it 'can discover nodes without tags' do
+        expect(consul_notags_leader.first).to eq('192.168.10.10')
+      end
+
+      it 'can discover nodes with tags' do
+        expect(consul_tags_leader.first).to eq('192.168.10.10')
+      end
+    end
+
+    context 'can discover all nodes' do
+      it 'can discover nodes without tags' do
+        expect(consul_notags_noleader.first).to eq('192.168.10.10')
+      end
+
+      it 'can discover nodes with tags' do
+        expect(consul_tags_noleader.length).to eq(3)
+      end
+    end
+  end
+end

data/spec/lib/cluster/discovery/ec2/auto_scaling_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe 'Cluster::Discovery::EC2::AutoScaling' do
+  describe '.discover' do
+    context 'can reuse the tag provider', vcr: true do
+      before(:each) do
+        @discovery = Cluster::Discovery::EC2::AutoScaling.new(
+          aws_region: 'us-east-1'
+        )
+      end
+
+      it 'can find instances by aws_auto_scaling_group' do
+        instances = @discovery.discover(aws_asg: 'foo-prod-v000')
+        instances = instances.map(&:instance_id)
+        expect(instances.length).to eq(1)
+      end
+    end
+  end
+end

data/spec/lib/cluster/discovery/ec2/tag_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe 'Cluster::Discovery::EC2::Tag' do
+  describe '.discover' do
+    context 'not passing aws_region arg' do
+      let(:discovery) { Cluster::Discovery::EC2::Tag }
+      it 'requires aws_region' do
+        expect { discovery.new }.to(
+          raise_error(ArgumentError),
+          'missing keyword: aws_region'
+        )
+      end
+    end
+
+    context 'passing aws_region arg', vcr: true do
+      before(:each) do
+        @discovery = Cluster::Discovery::EC2::Tag.new(aws_region: 'us-east-1')
+      end
+
+      it 'has a discover method' do
+        expect(@discovery).to respond_to(:discover)
+      end
+
+      it 'tags cannot be empty' do
+        expect { @discovery.discover }.to(
+          raise_error(Cluster::Discovery::EmptyTagsError),
+          'Tags cannot be empty'
+        )
+      end
+
+      it 'can find instances by tag' do
+        instances = @discovery.discover(
+          aws_tags: [{ key: 'Service', value: 'router' }]
+        )
+        instances = instances.map(&:instance_id)
+        expect(instances.length).to eq(6)
+      end
+    end
+  end
+
+  describe '.build_tags', vcr: true do
+    before(:each) do
+      @discovery = Cluster::Discovery::EC2::Tag.new(aws_region: 'us-east-1')
+    end
+
+    let(:filters) do
+      [{ name: 'instance-state-name', values: ['running'] }]
+    end
+
+    context 'parse default tags' do
+      let(:tags) { @discovery.send(:build_tags) }
+
+      it 'can format tags correctly' do
+        expect(tags).to eq(filters)
+      end
+    end
+
+    context 'parse input tag' do
+      let(:tags) do
+        @discovery.send(:build_tags,
+                        [{ key: 'Service', value: 'router' }])
+      end
+
+      # TODO: add failing negative test for wrong key values
+      # Tags:
+      # { key: 'aws:autoscaling:groupName', values: ['foo-prod-v000'] }
+      # Resulting filters:
+      # { name: 'tag:aws:autoscaling:groupName', values: ['foo-prod-v000'] },
+      let(:filters) do
+        [
+          { name: 'tag:Service', values: ['router'] },
+          { name: 'instance-state-name', values: ['running'] }
+        ]
+      end
+
+      it 'can format tags correctly' do
+        expect(tags).to eq(filters)
+      end
+    end
+  end
+end

data/spec/lib/cluster/discovery_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe 'Cluster::Discovery' do
+  let(:discovery) { Cluster::Discovery }
+
+  describe '.discover' do
+    context 'has a discover method' do
+      it { expect(discovery).to respond_to(:discover) }
+    end
+
+    context 'can discover nodes', vcr: true do
+      it 'discovery with consul' do
+        consul = Cluster::Discovery.discover(
+          'consul',
+          consul_url: "http://#{test_consul_host}:8500",
+          consul_service: 'redis',
+          leader: true,
+          tags: 'master')
+        expect(consul.first.Address).to eq('192.168.10.10')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,111 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require_relative '../lib/cluster/discovery'
+require 'vcr'
+
+def test_consul_host
+  ENV['TEST_CONSUL_HOST'] || '172.28.128.104'
+end
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+  c.allow_http_connections_when_no_cassette = true
+end
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: cluster-discovery
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Thompson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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: diplomat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+description: 'This is a library that provides a generic interface to multiple cluster
+  providers.  Cluster providers include: EC2 Tags, EC2 AutoScaling Groups, and Consul'
+email:
+- Andrew_Thompson@rapid7.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- Thorfile
+- cluster-discovery.gemspec
+- lib/cluster/discovery.rb
+- lib/cluster/discovery/consul.rb
+- lib/cluster/discovery/ec2/auto_scaling.rb
+- lib/cluster/discovery/ec2/tag.rb
+- lib/cluster/discovery/errors.rb
+- lib/cluster/discovery/version.rb
+- spec/cassettes/Cluster_Discovery/_discover/can_discover_nodes/discovery_with_consul.yml
+- spec/cassettes/Cluster_Discovery_Consul/_discover/can_discover_all_nodes/can_discover_nodes_with_tags.yml
+- spec/cassettes/Cluster_Discovery_Consul/_discover/can_discover_all_nodes/can_discover_nodes_without_tags.yml
+- spec/cassettes/Cluster_Discovery_Consul/_discover/can_discover_leader_node/can_discover_nodes_with_tags.yml
+- spec/cassettes/Cluster_Discovery_Consul/_discover/can_discover_leader_node/can_discover_nodes_without_tags.yml
+- spec/cassettes/Cluster_Discovery_EC2_AutoScaling/_discover/can_reuse_the_tag_provider/can_find_instances_by_aws_auto_scaling_group.yml
+- spec/cassettes/Cluster_Discovery_EC2_Tag/_discover/passing_aws_region_arg/can_find_instances_by_tag.yml
+- spec/lib/cluster/discovery/consul_spec.rb
+- spec/lib/cluster/discovery/ec2/auto_scaling_spec.rb
+- spec/lib/cluster/discovery/ec2/tag_spec.rb
+- spec/lib/cluster/discovery_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.4
+signing_key: 
+specification_version: 4
+summary: Cluster Discovery Library
+test_files:
+- spec/cassettes/Cluster_Discovery/_discover/can_discover_nodes/discovery_with_consul.yml
+- spec/cassettes/Cluster_Discovery_Consul/_discover/can_discover_all_nodes/can_discover_nodes_with_tags.yml
+- spec/cassettes/Cluster_Discovery_Consul/_discover/can_discover_all_nodes/can_discover_nodes_without_tags.yml
+- spec/cassettes/Cluster_Discovery_Consul/_discover/can_discover_leader_node/can_discover_nodes_with_tags.yml
+- spec/cassettes/Cluster_Discovery_Consul/_discover/can_discover_leader_node/can_discover_nodes_without_tags.yml
+- spec/cassettes/Cluster_Discovery_EC2_AutoScaling/_discover/can_reuse_the_tag_provider/can_find_instances_by_aws_auto_scaling_group.yml
+- spec/cassettes/Cluster_Discovery_EC2_Tag/_discover/passing_aws_region_arg/can_find_instances_by_tag.yml
+- spec/lib/cluster/discovery/consul_spec.rb
+- spec/lib/cluster/discovery/ec2/auto_scaling_spec.rb
+- spec/lib/cluster/discovery/ec2/tag_spec.rb
+- spec/lib/cluster/discovery_spec.rb
+- spec/spec_helper.rb
+has_rdoc: