vagrant-test-subject 0.0.1

data/Changelog

@@ -0,0 +1,2 @@
+2013-04-17 0.0.1 Clinton Wolfe <clintoncwolfe at gmail dot com>
+   * Initial release

data/LICENSE

@@ -0,0 +1,29 @@
+Copyright (c) 2013, OmniTI Computer Consulting, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+    * Neither the name OmniTI Computer Consulting, Inc. nor the names
+      of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written
+      permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,33 @@
+vagrant-test-subject
+====================
+
+A wrapper around a Vagrant VM, to ease using it as a test subject from rspec and other ruby testing tools.
+
+# Synopsis
+
+    describe "TrafficServer Service" do
+      before(:all) do
+        @vm = VagrantTestSubject::VM.attach()
+      end
+      it "should appear as a healthy service" do    
+        @vm.should have_running_service("trafficserver")
+      end
+      it "should be listening on localhost:80" do
+        @vm.should be_listening_on_localhost(80)
+      end
+      it "should be listening on external_ip:80" do
+        @vm.should be_listening_on_external_ip(80)
+      end
+      it "should be the right process name on port 80" do
+        process = @vm.process_name_listening('127.0.0.1', 80)
+        process.should_not be_nil
+        process.should match(/\/opt\/ts\/bin\/traffic_manager/)
+      end
+      it "should respond with HTTP 200 to / on port 80" do
+        @vm.http_get('/').should be_http_ok
+      end
+    end
+    
+# Maturity
+
+Alpha.

data/lib/vagrant-test-subject.rb

@@ -0,0 +1,148 @@
+
+# Std lib
+require 'tempfile'
+require 'json'
+require 'net/http'
+require 'socket'
+require 'timeout'
+
+# Gemfiles
+require 'net/ssh'
+require 'rspec/http'
+
+# Our precious self
+require 'vagrant-test-subject/monkey-patches/rspec-http'
+require 'vagrant-test-subject/ssh'
+require 'vagrant-test-subject/os/redhat'
+require 'vagrant-test-subject/os/omnios'
+
+module VagrantTestSubject
+
+  class VM
+    attr_reader :ssh, :vbox_guid, :external_ip
+
+    # Factory method, reads VM type and then instantiates 
+    def self.attach(vm_name = 'default')
+      os_type = VM.read_vbox_os_type(vm_name)
+
+      # Yecch
+      vbox_os_to_class = {
+        'RedHat_64' => VagrantTestSubject::VM::RedHat,
+        'Red Hat (64 bit)' => VagrantTestSubject::VM::RedHat,
+        'OpenSolaris_64' => VagrantTestSubject::VM::OmniOS,
+      }
+
+      klass = vbox_os_to_class[os_type]
+      klass.new(vm_name)
+    end
+
+    def initialize(vm_name = 'default')
+      @vm_name = vm_name
+      @vbox_guid = VM.read_vbox_guid(vm_name)
+      @vm_info = `VBoxManage showvminfo #{@vbox_guid} --machinereadable`.split("\n")
+      init_port_map()
+      @ssh = VagrantTestSubject::SSH.new(vm_name)
+    end
+
+
+    #================================================#
+    #         VM Info Methods
+    #================================================#
+    def list_internal_ports 
+      return @port_map.keys.sort
+    end
+
+    def map_port(internal) 
+      return @port_map[internal.to_i]
+    end
+
+    #================================================#
+    #         Testing Helpers
+    #================================================#
+
+    # Returns a Net::HTTP::Response 
+    def http_get (local_absolute_url)
+      uri = URI('http://localhost:' + self.map_port(80).to_s + local_absolute_url)
+      response = Net::HTTP.get_response(uri)
+    end
+    def https_get (local_absolute_url, opts={})
+      # TODO - set OpenSSL::SSL::VERIFY_PEER based on opts ?
+      uri = URI('http://localhost:' + self.map_port(443).to_s + local_absolute_url)
+      response = Net::HTTP.get_response(uri)
+    end
+    
+    #================================================#
+    # Testing Predicates
+    #================================================#
+    def has_running_service? (service_name)
+      raise "pure virtual"
+    end
+
+    def listening_on_localhost? (vm_port)
+      vm_port = vm_port.to_i
+      self.listening_ports.find{|lp| ['127.0.0.1', '0.0.0.0', '*'].include?(lp[:ip]) && lp[:port] == vm_port }
+    end
+
+    def listening_on_external_ip? (vm_port)
+      vm_port = vm_port.to_i
+      self.listening_ports.find{|lp| [@external_ip, '0.0.0.0', '*'].include?(lp[:ip]) && lp[:port] == vm_port }
+    end
+
+    def has_matching_process_listening? (ip, vm_port, process_regex)
+      raise "pure virtual"
+    end
+
+    def listening_on_portmap?(vm_port)
+      host_port = map_port(vm_port)
+      
+      # This doesn't work - always connects, even to a port that isn't listening.
+      return false
+
+      begin
+        #Timeout::timeout(1) do
+          begin
+            puts "Trying VM host port " + host_port.to_s
+            binding.pry
+            s = TCPSocket.new('127.0.0.1', host_port )
+            s.close
+            return true
+          rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+            return false
+          end
+        #end
+      #rescue Timeout::Error
+      end
+      return false
+    end
+
+    #================================================#
+    #         Guts
+    #================================================#
+    protected
+    def self.read_vbox_guid(vm_name)
+      (JSON.parse(IO.read(".vagrant")))['active'][vm_name]
+    end
+    
+    def self.read_vbox_os_type(vm_name)
+      vbox_guid = read_vbox_guid(vm_name)
+      output = `VBoxManage showvminfo #{vbox_guid} --machinereadable | grep ostype`
+      output[/".+"/].gsub('"','')
+    end
+
+    def init_port_map
+      @port_map = {}
+      @vm_info.grep(/Forwarding/) do |rule|
+        # Forwarding(0)="2g-183o,tcp,,41080,,80"
+        if /Forwarding\(\d+\)="[\w\-]+,(?<proto>\w+),,(?<ext>\d+),,(?<int>\d+)"/ =~ rule then
+          @port_map[int.to_i()] = ext.to_i()
+        end
+      end
+    end
+
+    def init_iface_list
+      # TODO - populate @external_ip 
+      @external_ip = '10.0.2.15'
+    end
+
+  end
+end

data/lib/vagrant-test-subject/monkey-patches/rspec-http.rb

@@ -0,0 +1,27 @@
+# What is wrong with you people
+module RSpec
+  module Http
+    class ResponseCodeMatcher
+      # Override, this stupidly doesn't work with the stdlib net/http
+      def matches?(target)
+        @target = target
+        if @target.respond_to? :status then
+          return @target.status.to_s == @expected_code.to_s
+        elsif @target.respond_to? :code then
+          # Net::HTTPResponse
+          return @target.code.to_s == @expected_code.to_s
+        end
+      end
+
+      def common_message
+        status_code = (@target.respond_to? :status) ? @target.status : @target.code
+        message = "have a response code of #{@expected_code}, but got #{status_code}"
+        if status_code == 302 || status_code == 201
+          message += " with a location of #{@target['Location'] || @target['location']}" 
+        end
+        message
+      end
+
+    end
+  end
+end

data/lib/vagrant-test-subject/os/omnios.rb

@@ -0,0 +1,12 @@
+module VagrantTestSubject
+  class VM
+    class OmniOS < VM
+
+      # This is one big TODO
+
+      def initialize(*args)
+        super
+      end
+    end
+  end
+end

data/lib/vagrant-test-subject/os/redhat.rb

@@ -0,0 +1,56 @@
+module VagrantTestSubject
+  class VM
+    class RedHat < VM
+      @@SERVICE_NAMES = {
+        'trafficserver' => 'trafficserver'
+      }
+
+      def initialize(*args)
+        super
+      end
+
+      def self.register_service_alias(human_name, os_specific_name)
+        @@SERVICE_NAMES[human_name] = os_specific_name
+      end
+
+      def has_running_service? (human_service_name)
+        redhat_service_name = @@SERVICE_NAMES[human_service_name] || human_service_name
+        output = self.ssh.exec!("/sbin/service #{redhat_service_name} status; echo exit_code:$?")
+        /exit_code:(?<exit_code>\d+)/ =~ output
+        return exit_code.to_i == 0 
+      end
+
+      def listening_ports
+        cmd = "netstat -ln --inet | tail -n +3 | awk '{print $4}'"
+        open_ports = []
+        self.ssh.exec!(cmd).split("\n").each do |line|
+          ip, port = line.split(':')
+          next unless ip
+          open_ports << { :ip => ip, :port => port.to_i }
+        end
+        open_ports
+      end
+
+      def process_name_listening (ip, vm_port)
+        # Note the trailing space after port - prevents 127.0.0.1:80 from matching 127.0.0.1:8084
+        cmd = "sudo netstat -lnp --inet | grep '#{ip}:#{vm_port} ' | awk '{print $7}'"
+        output = self.ssh.exec!(cmd)
+        if output.nil? then
+          cmd = "sudo netstat -lnp --inet | grep '0.0.0.0:#{vm_port} ' | awk '{print $7}'"
+          output = self.ssh.exec!(cmd)
+        end       
+        return nil if output.nil?
+        output.chomp!
+
+        pid, truncated_process = output.split('/');
+        unless pid =~ /^\d+$/ then
+          raise "Not sure what this means, when running netstat -nlp:\n#{output}"
+        end
+
+        cmd = "ps -fp #{pid} | tail -n +2 | awk '{print $8}'"
+        process_string = self.ssh.exec!(cmd).chomp()
+        return process_string
+      end
+    end
+  end
+end

data/lib/vagrant-test-subject/ssh.rb

@@ -0,0 +1,41 @@
+module VagrantTestSubject
+
+  # Encapsulates an SSH channel into a VM
+  class SSH
+    def initialize(vm_name = 'default')
+      # Grab ssh config
+      config = `vagrant ssh-config`
+      
+      # Write most of it to a file, grabbing the username and host
+      config_file = Tempfile.new("vagrant-ssh-conf")
+
+      host, username = nil, nil
+      config.split(/\n/).each do |line|
+        case line
+        when /^\s+User\s+(\w+)/
+          username = $1
+        when /^\s+HostName\s+(\S+)/
+          host = $1
+        when /^\s*Host\s+#{vm_name}/
+          # Ignore 
+        else
+          config_file << line + "\n"
+        end
+      end
+      config_file.flush
+
+      # make a Net::SSH Session
+      # and delegate everything to it
+      @session = Net::SSH.start(host, username, :config => config_file.path)
+
+      config_file.close
+      
+    end
+
+    def method_missing(*args, &block)
+      method_name = args.shift
+      @session.send method_name, *args, &block
+    end
+
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-test-subject
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Clinton Wolfe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-http
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Wrapper class for a Vagrant VM, providing access to testing predicates,
+  such as port map information, process data, ssh connections, and more.
+email: clinton@NOSPAM.omniti.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Changelog
+- LICENSE
+- README.md
+- lib/vagrant-test-subject.rb
+- lib/vagrant-test-subject/ssh.rb
+- lib/vagrant-test-subject/monkey-patches/rspec-http.rb
+- lib/vagrant-test-subject/os/redhat.rb
+- lib/vagrant-test-subject/os/omnios.rb
+homepage: https://github.com/clintoncwolfe/vagrant-test-subject
+licenses: []
+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.24
+signing_key: 
+specification_version: 3
+summary: Wrapper class for a Vagrant VM, providing access to testing predicates
+test_files: []