squall 1.0.2 → 1.1.0

data/lib/squall.rb

@@ -1,40 +1,51 @@
 require 'httparty'
 
-require 'squall/version'
-require 'squall/exception'
+require 'squall/support/version'
+require 'squall/support/exception'
+require 'squall/support/yaml'
 
 module Squall
-  autoload :Params,         'squall/params'
+  # Support
+  autoload :Params,         'squall/support/params'
+  autoload :Config,         'squall/support/config'
+  autoload :Base,           'squall/support/base'
+  # Api
   autoload :Hypervisor,     'squall/hypervisor'
-  autoload :Config,         'squall/config'
-  autoload :Base,           'squall/base'
   autoload :User,           'squall/user'
   autoload :Role,           'squall/role'
   autoload :Network,        'squall/network'
   autoload :IpAddress,      'squall/ip_address'
+  autoload :IpAddressJoin,  'squall/ip_address_join'
   autoload :Template,       'squall/template'
   autoload :VirtualMachine, 'squall/virtual_machine'
   autoload :Statistic,      'squall/statistic'
   autoload :Transaction,    'squall/transaction'
+  autoload :Payment,        'squall/payment'
+  autoload :UserGroup,      'squall/user_group'
+  autoload :Whitelist,      'squall/whitelist'
+  autoload :FirewallRule,   'squall/firewall_rule'
+  autoload :DataStoreZone,  'squall/data_store_zone'
+  autoload :NetworkZone,    'squall/network_zone'
+  autoload :HypervisorZone, 'squall/hypervisor_zone'
 
   extend self
 
   # Config
   attr_accessor :configuration
 
-  # Config 
+  # Config
   attr_accessor :configuration_file
 
-  # The path to your squall.yml
   self.configuration ||= Squall::Config.new
 
   # Specificy the config via block
-  # 
+  #
   # ==== Attributes
   #
   # * +base_uri+ - URL of your OnApp instance
   # * +username+ - API username
   # * +password+ - API Password
+  # * +debug+ - Toggle debug mode to log HTTParty
   #
   # ==== Example
   #
@@ -67,11 +78,9 @@ module Squall
     else
       raise ArgumentError, "Config file doesn't exist '#{file}'"
     end
+    settings = YAML::load_file(file)
     config do |c|
-      conf = YAML::load_file(file)
-      c.base_uri  conf['base_uri']
-      c.username  conf['username']
-      c.password  conf['password']
+      settings.each { |k, v| c.send(k, v) }
     end
   end
 

data/spec/spec_helper.rb

@@ -6,32 +6,37 @@ require 'squall'
 VCR.config do |c|
   c.cassette_library_dir = 'spec/vcr_cassettes'
   c.stub_with :fakeweb
-  c.default_cassette_options = {:record => :new_episodes}
+  if ENV['RERECORD']
+    c.default_cassette_options = {:record => :all}
+  else
+    c.default_cassette_options = {:record => :none}
+  end
+  c.filter_sensitive_data("Basic <REDACTED>") { |i| [i.request.headers['authorization']].flatten.first }
+  c.filter_sensitive_data("<REDACTED>") { |i| [i.response.headers['set-cookie']].flatten.first }
+  c.filter_sensitive_data("<URL>") { URI.parse(Squall.config[:base_uri]).host }
+  c.filter_sensitive_data("<USER>") { Squall.config[:username] }
+  c.filter_sensitive_data("<PASS>") { Squall.config[:password] }
 end
 
 RSpec.configure do |c|
   c.extend VCR::RSpec::Macros
+  c.before(:each) do
+    configure_for_tests
+  end
   c.after(:each) do
     Squall.reset_config
   end
 end
 
-def default_config
-  yaml = File.join(ENV['HOME'], '.squall.yml')
-  if ENV['SQUALL_LIVE'] && File.exists?(yaml)
-    config = YAML::load_file(yaml)
-    uri  = config['base_uri']
-    user = config['username']
-    pass = config['password']
+def configure_for_tests
+  if ENV['RERECORD']
+    Squall.config_file 	
   else
-    uri  = 'http://www.example.com'
-    user = 'user'
-    pass = 'pass'
-  end
-  Squall.config do |c|
-    c.base_uri uri
-    c.username user
-    c.password pass
+    Squall.config do |c|
+      c.username "test"
+      c.password "test"
+      c.base_uri "http://example.com"
+    end
   end
 end
 

data/spec/squall/data_store_zone_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+describe Squall::DataStoreZone do
+  before(:each) do
+    @data_store_zone = Squall::DataStoreZone.new
+    @valid = {:label => "My zone"}
+  end
+
+  describe "#list" do
+    use_vcr_cassette "data_store_zone/list"
+    
+    it "returns all data store zones" do
+      data_store_zones = @data_store_zone.list
+      data_store_zones.should be_an(Array)
+    end
+
+    it "contains the data store zone data" do
+      data_store_zones = @data_store_zone.list
+      data_store_zones.all? {|w| w.is_a?(Hash) }.should be_true
+    end
+  end
+  
+  describe "#show" do
+    use_vcr_cassette "data_store_zone/show"
+    it "requires an id" do
+      expect { @data_store_zone.show }.to raise_error(ArgumentError)
+    end
+
+    it "returns not found for invalid data store zone id" do
+      expect { @data_store_zone.show(404) }.to raise_error(Squall::NotFound)
+    end
+
+    it "returns a data store zone" do
+      data_store_zone = @data_store_zone.show(1)
+      data_store_zone.should be_a(Hash)
+    end
+  end
+  
+  describe "#create" do
+    use_vcr_cassette "data_store_zone/create"
+    it "requires label" do
+      invalid = @valid.reject{|k,v| k == :label }
+      requires_attr(:label) { @data_store_zone.create(invalid) }
+    end
+    
+    it "raises error on unknown params" do
+      expect { @data_store_zone.create(@valid.merge(:what => 'what')) }.to raise_error(ArgumentError, 'Unknown params: what')
+    end
+
+    it "creates a data store zone" do
+      @data_store_zone.create(@valid)
+      @data_store_zone.success.should be_true
+    end
+  end
+  
+  describe "#edit" do
+    use_vcr_cassette "data_store_zone/edit"
+    
+    it "allows select params" do
+      optional = [:label]
+      @data_store_zone.should_receive(:request).exactly(optional.size).times.and_return Hash.new()
+      optional.each do |param|
+        @data_store_zone.edit(1, param => "test")
+      end
+    end
+    
+    it "raises error on unknown params" do
+      expect { @data_store_zone.edit(1, @valid.merge(:what => 'what')) }.to raise_error(ArgumentError, 'Unknown params: what')
+    end
+
+    it "edits a data store zone" do
+      @data_store_zone.edit(1, :label => "Updated zone")
+      @data_store_zone.success.should be_true
+    end
+    
+    it "raises an error for an invalid data store zone id" do
+      expect { @data_store_zone.edit(404, @valid) }.to raise_error(Squall::NotFound)
+    end
+  end
+  
+  describe "#delete" do
+    use_vcr_cassette "data_store_zone/delete"
+    it "requires an id" do
+      expect { @data_store_zone.delete }.to raise_error(ArgumentError)
+    end
+
+    it "deletes a data store zone" do
+      @data_store_zone.delete(1)
+      @data_store_zone.success.should be_true
+    end
+
+    it "returns NotFound for invalid data store zone id" do
+      expect { @data_store_zone.delete(404) }.to raise_error(Squall::NotFound)
+    end
+  end
+
+end

data/spec/squall/firewall_rule_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+
+describe Squall::FirewallRule do
+  before(:each) do
+    @firewall_rule = Squall::FirewallRule.new
+    @valid = {:command => "DROP", :protocol => "TCP", :network_interface_id => 1}
+  end
+
+  describe "#list" do
+    use_vcr_cassette "firewall_rule/list"
+    
+    it "requires vm id" do
+      expect { @firewall_rule.list }.to raise_error(ArgumentError)
+    end
+    
+    it "returns a list of firewall rules for a vm" do
+      firewall_rules = @firewall_rule.list(1)
+      firewall_rules.should be_an(Array)
+    end
+
+    it "contains first firewall_rule's data" do
+      firewall_rules = @firewall_rule.list(1)
+      firewall_rules.all?.should be_true
+    end
+  end
+  
+  describe "#create" do
+    use_vcr_cassette "firewall_rule/create"
+    it "requires command" do
+      invalid = @valid.reject{|k,v| k == :command }
+      requires_attr(:command) { @firewall_rule.create(1, invalid) }
+    end
+    
+    it "requires protocol" do
+      invalid = @valid.reject{|k,v| k == :protocol }
+      requires_attr(:protocol) { @firewall_rule.create(1, invalid) }
+    end
+    
+    it "requires network_interface_id" do
+      invalid = @valid.reject{|k,v| k == :network_interface_id }
+      requires_attr(:network_interface_id) { @firewall_rule.create(1, invalid) }
+    end
+    
+    it "allows all optional params" do
+      optional = [:network_interface_id, :address, :port]
+      @firewall_rule.should_receive(:request).exactly(optional.size).times.and_return Hash.new("firewall_rule" => {})
+      optional.each do |param|
+        @firewall_rule.create(1, @valid.merge(param => "test"))
+      end
+    end
+    
+    it "raises error on unknown params" do
+      expect { @firewall_rule.create(1, @valid.merge(:what => 'what')) }.to raise_error(ArgumentError, 'Unknown params: what')
+    end
+    
+    it "raises an error for an invalid vm id" do
+      expect { @firewall_rule.create(404, @valid) }.to raise_error(Squall::NotFound)
+    end
+
+    it "creates a firewall rule for a virtual machine" do
+      @firewall_rule.create(1, @valid)
+      @firewall_rule.success.should be_true
+    end
+  end
+  
+  describe "#edit" do
+    use_vcr_cassette "firewall_rule/edit"
+    
+    it "allows select params" do
+      optional = [:command, :protocol, :network_interface_id, :address, :port]
+      @firewall_rule.should_receive(:request).exactly(optional.size).times.and_return Hash.new()
+      optional.each do |param|
+        @firewall_rule.edit(1, 1, param => "test")
+      end
+    end
+    
+    it "raises error on unknown params" do
+      expect { @firewall_rule.edit(1, 1, :what => 'what') }.to raise_error(ArgumentError, 'Unknown params: what')
+    end
+
+    it "edits a firewall rule" do
+      pending "broken in OnApp: returning invalid JSON" do
+        @firewall_rule.edit(1, 1, :port => 1000)
+        @firewall_rule.success.should be_true
+      end
+    end
+    
+    it "raises an error for an invalid firewall rule id" do
+      expect { @firewall_rule.edit(1, 404, @valid) }.to raise_error(Squall::NotFound)
+    end
+  end
+  
+  describe "#delete" do
+    use_vcr_cassette "firewall_rule/delete"
+    
+    it "requires an id" do
+      expect { @firewall_rule.delete }.to raise_error(ArgumentError)
+    end
+
+    it "deletes a firewall rule" do
+      pending "broken in OnApp: returning invalid JSON" do
+        @firewall_rule.delete(1, 1)
+        @firewall_rule.success.should be_true
+      end
+    end
+
+    it "returns NotFound for missing virtual machine" do
+      expect { @firewall_rule.delete(1, 404) }.to raise_error(Squall::NotFound)
+    end
+  end
+
+end

data/spec/squall/hypervisor_spec.rb

@@ -2,24 +2,23 @@ require 'spec_helper'
 
 describe Squall::Hypervisor do
   before(:each) do
-    default_config
     @hv = Squall::Hypervisor.new
+    @valid = {:label => 'A new hypervisor', :ip_address => '127.126.126.126', :hypervisor_type => 'xen'}
   end
 
   describe "#list" do
     use_vcr_cassette 'hypervisor/list'
+
     it "returns hypervisors" do
       hvs = @hv.list
-      hvs.size.should be(2)
-
-      keys = ["label", "called_in_at", "spare", "created_at", "hypervisor_type",
-              "updated_at", "xen_info", "id", "hypervisor_group_id", "enabled", "health",
-              "failure_count", "memory_overhead", "online", "locked", "ip_address"]
-      first = hvs.first
-      first.keys.should include(*keys)
-      first['label'].should == 'Testing'
-      first['hypervisor_type'].should == 'xen'
+      hvs.should be_an(Array)
+    end
+    
+    it "contains hypervisor data" do
+      hvs = @hv.list
+      hvs.all?.should be_true
     end
+    
   end
 
   describe "#show" do
@@ -29,55 +28,38 @@ describe Squall::Hypervisor do
     end
 
     it "returns not found for invalid hvs" do
-      expect { @hv.show(5) }.to raise_error(Squall::NotFound)
+      expect { @hv.show(404) }.to raise_error(Squall::NotFound)
     end
 
     it "returns a hv" do
-      hv = @hv.show(1)
-      hv['label'].should == 'Testing'
+      @hv.show(1)
+      @hv.success.should be_true
     end
   end
 
   describe "#create" do
     use_vcr_cassette "hypervisor/create"
     it "requires label" do
-      requires_attr(:label) { @hv.create }
+      invalid = @valid.reject{|k,v| k == :label }
+      requires_attr(:label) { @hv.create(invalid) }
       @hv.success.should be_false
     end
 
     it "requires ip_address" do
-      requires_attr(:ip_address) { @hv.create(:label => 'Brand New') }
+      invalid = @valid.reject{|k,v| k == :ip_address }
+      requires_attr(:ip_address) { @hv.create(invalid) }
       @hv.success.should be_false
     end
 
     it "requires hypervisor_type" do
-      requires_attr(:hypervisor_type) { @hv.create(:label => 'Brand New', :ip_address => '222.222.222.222') }
-      @hv.success.should be_false
-    end
-
-    # The API allows you to commit this value but subsequent
-    # saves do not work because of this missing value.
-    it "requires memory_overhead" do
-      pending "Broken in OnApp"
-      requires_attr(:memory_overhead) { @hv.create(:label => 'Brand New', :ip_address => '222.222.222.222', :hypervisor_type => 'xen') }
-    end
-
-    it "raises error on duplicate account" do
-      expect {
-        @hv.create(:label => 'Testing', :ip_address => '123.123.123.123', :hypervisor_type => 'xen')
-      }.to raise_error(Squall::RequestError)
-      @hv.errors['label'].should include("has already been taken")
-      @hv.errors['ip_address'].should include("has already been taken")
+      invalid = @valid.reject{|k,v| k == :hypervisor_type }
+      requires_attr(:hypervisor_type) { @hv.create(invalid) }
       @hv.success.should be_false
     end
 
     it "creates a hypervisor" do
-      create = @hv.create(:label => 'Brand new', :ip_address => '126.126.126.126', :hypervisor_type => 'xen')
+      @hv.create(@valid)
       @hv.success.should be_true
-
-      create['label'].should == 'Brand new'
-      create['ip_address'].should == '126.126.126.126'
-      create['hypervisor_type'].should == 'xen'
     end
   end
 
@@ -89,17 +71,12 @@ describe Squall::Hypervisor do
     end
 
     it "raises an error with unknown param " do
-      expect { @hv.edit(3, :blah => 1)}.to raise_error(ArgumentError)
+      expect { @hv.edit(1, :blah => 1)}.to raise_error(ArgumentError)
       @hv.success.should be_false
     end
 
-    it "edits the label" do
-      edit = @hv.edit(3, :label => 'Old Gregg')
-      @hv.success.should be_true
-    end
-
-    it "edits the ip_address" do
-      edit = @hv.edit(3, :ip_address => '120.120.120.120')
+    it "edits the hypervisor" do
+      edit = @hv.edit(1, :label => 'A new label')
       @hv.success.should be_true
     end
   end
@@ -119,8 +96,6 @@ describe Squall::Hypervisor do
     it "reboots the hypervisor" do
       reboot = @hv.reboot(1)
       @hv.success.should be_true
-
-      reboot['label'].should == 'Testing'
     end
   end
 
@@ -136,8 +111,86 @@ describe Squall::Hypervisor do
     end
 
     it "returns a hv" do
-      @hv.delete(3)
+      @hv.delete(1)
+      @hv.success.should be_true
+    end
+  end
+  
+  describe "#data_store_joins" do
+    use_vcr_cassette "hypervisor/data_store_joins"
+    
+    it "returns a list of data store joins" do
+      joins = @hv.data_store_joins(1)
+      joins.should be_an(Array)
+    end
+    
+    it "contains the data store join data" do
+      joins = @hv.data_store_joins(1)
+      joins.all? {|w| w.is_a?(Hash) }.should be_true
+    end
+    
+  end
+  
+  describe "#add_data_store_join" do
+    use_vcr_cassette "hypervisor/add_data_store_join"
+    
+    it "adds the data store to the hypervisor zone" do
+      @hv.add_data_store_join(1, 1)
+      @hv.success.should be_true
+    end
+    
+  end
+  
+  describe "#remove_data_store_join" do
+    use_vcr_cassette "hypervisor/remove_data_store_join"
+    
+    it "removes the data store from the hypervisor zone" do
+      @hv.remove_data_store_join(1, 1)
+      @hv.success.should be_true
+    end
+    
+  end
+  
+  describe "#network_joins" do
+    use_vcr_cassette "hypervisor/network_joins"
+    
+    it "returns a list of network joins" do
+      joins = @hv.network_joins(1)
+      joins.should be_an(Array)
+    end
+    
+    it "contains the network join data" do
+      joins = @hv.network_joins(1)
+      joins.all? {|w| w.is_a?(Hash) }.should be_true
+    end
+    
+  end
+  
+  describe "#add_network_join" do
+    use_vcr_cassette "hypervisor/add_network_join"
+    
+    it "requires network id" do
+      requires_attr(:network_id) { @hv.add_network_join(1, :interface => "interface") }
+    end
+    
+    it "requires interface" do
+      requires_attr(:interface) { @hv.add_network_join(1, :network_id => 1) }
+    end
+    
+    it "adds the network to the hypervisor zone" do
+      @hv.add_network_join(1, :network_id => 1, :interface => "interface")
+      @hv.success.should be_true
+    end
+    
+  end
+  
+  describe "#remove_network_join" do
+    use_vcr_cassette "hypervisor/remove_network_join"
+    
+    it "removes the network from the hypervisor zone" do
+      @hv.remove_network_join(1, 1)
       @hv.success.should be_true
     end
+    
   end
 end