capistrano-srv_hosts 0.1.0

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'rspec'
+end
+
+gemspec

data/LICENSE.TXT

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Rally Software Development Corp
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# Capistrano::SrvHosts [![Build Status](https://travis-ci.org/RallySoftware/capistrano-srv_hosts.png)](https://travis-ci.org/RallySoftware/capistrano-srv_hosts)
+
+Capistrano extension to fetch deploy hosts via DNS SRV records.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-srv_hosts'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself:
+
+    $ gem install capistrano-srv_hosts
+
+## Usage
+
+Create appropriate DNS records, e.g.:
+
+    # service proto name ttl class type priority weight port target
+    _service._tcp.example.com 3600 IN SRV 10 1000 0 server01.example.com
+    _service._tcp.example.com 3600 IN SRV 20 1000 0 server02.example.com
+
+Configure your config/deploy.rb:
+
+At the top add:
+
+```ruby
+require 'capistrano/srv_hosts'
+```
+
+Then you can define roles like this:
+
+```ruby
+srv_role :app, '_service._tcp.example.com'
+srv_role :web, '_service._tcp.example.com', :primary => true
+```
+
+And like this:
+
+```ruby
+role :db, srv_hosts('_service._tcp.example.com').first, :primary => true
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+© Rally Software Development Corp. Released under MIT license, see
+[LICENSE](https://github.com/RallySoftware/capistrano-srv_hosts/blob/master/LICENSE.TXT)
+for details.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/capistrano-srv_hosts.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'capistrano/srv_hosts/version'
+
+Gem::Specification.new do |s|
+  s.name            = "capistrano-srv_hosts"
+  s.version         = Capistrano::SrvHosts::VERSION
+  s.platform        = Gem::Platform::RUBY
+  s.authors         = ["Tuomas Silen"]
+  s.email           = ["tsilen@rallydev.com"]
+  s.homepage        = ""
+  s.license         = "MIT"
+  s.summary         = %q{Capistrano extension to fetch deploy hosts via DNS}
+  s.description     = %q{Allows capistrano to configure deploy hosts and roles using DNS SRV records}
+
+  s.files           = `git ls-files`.split($/)
+  s.executables     = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files      = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths   = ["lib"]
+
+  s.add_dependency 'capistrano', '>= 2'
+  s.add_development_dependency 'bundler', '~> 1.3'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '~> 2.13'
+end

data/lib/capistrano-srv_hosts.rb

@@ -0,0 +1 @@
+require 'capistrano/srv_hosts'

data/lib/capistrano/srv_hosts.rb

@@ -0,0 +1,28 @@
+require 'capistrano'
+require 'resolv'
+
+module Capistrano::SrvHosts
+  module InstanceMethods
+    def srv_hosts(srv_record)
+      @srv_hosts ||= {}
+      @srv_hosts[srv_record] ||= Resolv::DNS.open do |dns|
+        dns.getresources(srv_record, Resolv::DNS::Resource::IN::SRV).sort_by{|rr| [rr.priority, rr.weight, rr.target.to_s]}.map{ |rr| rr.target.to_s}
+      end
+      @srv_hosts[srv_record].dup
+    end
+    
+    def srv_role(new_role, srv_record, *params)
+      role new_role, *srv_hosts(srv_record), *params
+    end
+  end
+
+  def self.load_into(configuration)
+    configuration.load do
+      extend InstanceMethods 
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  Capistrano::SrvHosts.load_into(Capistrano::Configuration.instance(:must_exist))
+end

data/lib/capistrano/srv_hosts/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module SrvHosts
+    VERSION = '0.1.0'
+  end
+end

data/spec/capistrano/srv_hosts_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'capistrano/srv_hosts'
+
+describe Capistrano::SrvHosts do
+  before(:all) do
+    @test_data = [
+      srv_record(15, 1000, 0, 'server04.example.com'),
+      srv_record(10, 1000, 0, 'server03.example.com'),
+      srv_record(10, 1000, 0, 'server02.example.com'),
+      srv_record(10, 1005, 0, 'server01.example.com')
+    ]
+  end
+
+  before(:each) do 
+    @configuration = Capistrano::Configuration.new
+    Capistrano::SrvHosts.load_into(@configuration)
+  end
+
+  it 'should load instance methods into Capistrano' do
+    @configuration.methods.should include(:srv_hosts)
+    @configuration.methods.should include(:srv_role)
+  end
+
+  describe '#srv_hosts' do
+    it 'should query DNS and cache results' do
+      Resolv::DNS.any_instance.should_receive(:getresources).with('_test._tcp.example.com', Resolv::DNS::Resource::IN::SRV).exactly(1).times.and_return(@test_data)
+      @configuration.srv_hosts('_test._tcp.example.com')
+      @configuration.srv_hosts('_test._tcp.example.com')
+    end
+
+    it 'should sort the results properly' do
+      Resolv::DNS.any_instance.should_receive(:getresources).with('_test._tcp.example.com', Resolv::DNS::Resource::IN::SRV).exactly(1).times.and_return(@test_data)
+      res = @configuration.srv_hosts('_test._tcp.example.com')
+      res.size.should eq(4)
+      res.should eq(['server02.example.com', 'server03.example.com', 'server01.example.com', 'server04.example.com'])
+    end
+  end
+
+  describe '#srv_role' do
+    it 'should define the role' do
+      @configuration.should_receive(:srv_hosts).and_return(['server01.example.com', 'server02.example.com'])
+      @configuration.srv_role :app, '_test._tcp.example.com'
+      @configuration.roles[:app].servers.size.should eq(2)
+      @configuration.roles[:app].servers.map(&:to_s).should eq(['server01.example.com', 'server02.example.com'])
+    end
+
+    it 'should handle role params' do
+      @configuration.should_receive(:srv_hosts).and_return(['server01.example.com'])
+      @configuration.srv_role :app, '_test._tcp.example.com', :primary => true
+      @configuration.roles[:app].servers.size.should eq(1)
+      @configuration.roles[:app].servers.first.options.should eq({:primary => true})
+    end
+  end
+
+  def srv_record(priority, weight, port, host)
+    Resolv::DNS::Resource::IN::SRV.new(priority, weight, port, host)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # 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'
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-srv_hosts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Tuomas Silen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+description: Allows capistrano to configure deploy hosts and roles using DNS SRV records
+email:
+- tsilen@rallydev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .travis.yml
+- Gemfile
+- LICENSE.TXT
+- README.md
+- Rakefile
+- capistrano-srv_hosts.gemspec
+- lib/capistrano-srv_hosts.rb
+- lib/capistrano/srv_hosts.rb
+- lib/capistrano/srv_hosts/version.rb
+- spec/capistrano/srv_hosts_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Capistrano extension to fetch deploy hosts via DNS
+test_files:
+- spec/capistrano/srv_hosts_spec.rb
+- spec/spec_helper.rb
+has_rdoc: