openvas-cli 0.1.0

data/spec/openvas-cli/openvas-cli_spec.rb

@@ -0,0 +1,45 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'nokogiri'
+
+
+describe "OpenvasCli" do
+  before(:all) do
+    @cli = OpenvasCli.new
+  end
+  
+  after(:all) do
+    @cli.close
+  end
+
+  it 'should create a valid instance with the provided credentials' do
+    #handled in the before(:all) block
+  end
+  
+  it 'should pull rule definitions', :slow => true do
+    defs = @cli.get_rule_defs
+    defs.count.should > 0
+    
+    defs.each { |d|
+      d.oid.should_not be nil
+      d.name.should_not be nil
+      d.name.length.should > 0
+    }
+    
+  end
+  
+  it 'should throw a command exception' do
+    bad_msg = Nokogiri::XML::Builder.new { |xml|
+      xml.foo
+    }
+    
+    lambda {@cli.send_receive(bad_msg.doc)}.should raise_error(VasExceptions::CommandException)
+  end
+  
+  it 'should throw a CommunicationException' do
+    bad_msg = Nokogiri::XML::Builder.new { |xml|
+      xml.get_schedules(:details => '1', :sort_field => 'next_time')
+    }
+    
+    lambda {@cli.send_receive(bad_msg.doc)}.should raise_error(VasExceptions::CommunicationException)
+  end
+end

data/spec/openvas-cli/vas_nvt_family_spec.rb

@@ -0,0 +1,9 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe VasNVTFamily do
+  it 'should pull all nvt families' do
+    fams = VasNVTFamily.get_all
+    fams.should_not be nil
+    fams.each{ |f| f.should be_valid }
+  end
+end

data/spec/openvas-cli/vas_nvt_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe VasNVT do
+  it 'should pull NVT`s', :slow => true do
+    rules = VasNVT.get_all
+    rules.should_not be nil
+    rules.count.should > 0
+    rules.each{ |r| r.should be_valid }
+  end
+  
+  it 'should pull an NVT by OID' do
+    rule = VasNVT.get_all(:oid => '1.3.6.1.4.1.25623.1.0.902230')
+    rule.should_not be nil
+    rule.count.should == 1
+    
+    rule[0].should be_valid
+  end
+  
+  it 'should pull an NVT by Family' do
+    fams = VasNVTFamily.get_all
+    
+    my_fam = fams[rand(fams.count)]
+    
+    rules = VasNVT.get_all(:family => my_fam.name)
+    rules.should_not be nil
+    rules.count.should == my_fam.nvt_count
+    rules.each { |r|
+      r.should be_valid
+      r.family.should == my_fam.name
+    }
+  end 
+end

data/spec/openvas-cli/vas_preference_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe VasPreference do
+  it 'should pull all preferences' do
+    preferences = VasPreference.get_all
+    preferences.should_not be nil
+    
+    preferences.each { |p|
+      p.should be_valid
+    }
+  end
+  
+  it 'should pull a single preference by name' do
+    all = VasPreference.get_all
+    
+    o_pref = all[rand(all.count)]
+    o_pref.should_not be nil
+    
+    n_pref = VasPreference.get_all(:name=>o_pref.name)[0]
+    n_pref.should_not be nil
+    
+    o_pref.name.should      == n_pref.name
+    o_pref.value.should     == n_pref.value
+    o_pref.config_id.should == n_pref.config_id
+  end
+end

data/spec/openvas-cli/vas_report_spec.rb

@@ -0,0 +1,75 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'nokogiri'
+
+describe "VasReport" do
+  it "should pull all available reports" do
+    repts = VasReport.get_all
+    
+    repts.should_not be nil
+    
+    repts.each { |r| r.should be_valid }
+  end
+  
+  it 'should pull a raw XML dump for a single report' do
+    rept = VasReport.get_all[0]
+    
+    xml = rept.to_xml
+    
+    xdoc = Nokogiri::XML(xml) #it should be a valid xml document
+    
+    xdoc.at_xpath("//report/@id").value.should == rept.report_id
+  end
+  
+  it 'should pull a specific report by id' do
+    all = VasReport.get_all
+    
+    o_rept = all[rand(all.count)]
+    o_rept.should_not be nil
+    n_rept = VasReport.get_all(:report_id => o_rept.report_id)[0]
+    n_rept.should_not be nil
+    
+    o_rept.report_id.should == n_rept.report_id
+  end
+  
+  it 'should report the associated results' do
+    all = VasReport.get_all
+    
+    all.each { |r|
+      r.result_count[:filtered].should == r.results.count
+    }
+  end
+  
+  it 'should filter the results' do
+    all = VasReport.get_all(:filter => [:high])
+    
+    all.each { |report|
+      report.results.each{ |result|
+        result.threat.should =~ /high/i
+      }
+    }
+    
+    all = VasReport.get_all(:filter => [:log])
+    
+    all.each { |report|
+      report.results.each{ |result|
+        result.threat.should =~ /log/i
+      }
+    }
+    
+    all = VasReport.get_all(:filter => [:medium, :debug, :low])
+    
+    all.each { |report|
+      report.results.each{ |result|
+        result.threat.should =~ /(medium)|(debug)|(low)/i
+      }
+    }
+  end
+  
+  it 'should return an empty set when passed a bad report_id' do
+    lambda {
+      r = VasReport.get_all(:report_id => '0000000000')
+      r.should_not be nil
+      r.should be_empty
+    }.should_not raise_error
+  end
+end

data/spec/openvas-cli/vas_result_spec.rb

@@ -0,0 +1,109 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe 'VasResult' do
+  it 'should pull all results' do
+    all_results = VasResult.get_all 
+    
+    all_results.should_not be nil
+    
+    all_results.count.should > 0
+    
+    all_results.each { |r| r.should be_valid }
+  end
+  
+  it 'should be able to paginate results', :slow=>true do
+    result_count = VasResult.get_all.count
+    
+    start = 0
+    num = 20
+    
+    while start < result_count do
+      results = VasResult.get_all(:start => start, :count => num)
+      
+      results.count.should <= 20
+      
+      start += results.count
+    end
+  end
+  
+  it 'should sort by threat by default' do
+    results = VasResult.get_all
+    
+    last_val = 9
+    results.each { |r|
+      r.threat_level.should <= last_val
+      last_val = r.threat_level
+    }
+  end
+  
+  it 'should sort the results by ID' do
+    results = VasResult.get_all(:sort_by => :result_id)
+    
+    last_id = ""
+    results.each { |r|
+      r.result_id.should >= last_id
+      last_id = r.result_id
+    }
+  end
+  
+  it 'should sort the results by host' do
+    results = VasResult.get_all(:sort_by => :host)
+    
+    last_host = ""
+    results.each { |r|
+      r.host.should >= last_host
+      last_host = r.host
+    }
+  end
+  
+  it 'should sort the results by rule_id' do
+    results = VasResult.get_all(:sort_by => :rule_id)
+    
+    last_val = ""
+    results.each { |r|
+      r.rule_id.should >= last_val
+      last_val = r.rule_id
+    }
+  end
+  
+  it 'should sort the results by subnet' do
+    results = VasResult.get_all(:sort_by => :subnet)
+    
+    last_val = ""
+    results.each { |r|
+      r.subnet.should >= last_val
+      last_val = r.subnet
+    }
+  end
+  
+  it 'should sort the results by threat' do
+    results = VasResult.get_all(:sort_by => :threat)
+    
+    last_val = 9
+    results.each { |r|
+      r.threat_level.should <= last_val
+      last_val = r.threat_level
+    }
+  end
+  
+  it 'shoudl pull results for a specified task' do
+    tasks = VasTask.get_all
+    
+    tasks.count.should > 0
+    task_id = tasks[0].task_id
+    results = VasResult.get_all(:task_id => task_id)
+    results.each { |r| r.task_id.should == task_id }
+    
+    all_tasks = VasResult.get_all
+    
+    all_tasks.count.should >= results.count
+  end
+  
+  it 'should filter based off of threat level' do
+    results = VasResult.get_all(:filter=>[:high, :medium])
+    threats = ["High", "Medium"]
+    results.each { |r|
+      threats.should include r.threat
+    }
+  end
+end

data/spec/openvas-cli/vas_schedule_spec.rb

@@ -0,0 +1,61 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe 'VasSchedule' do
+  it 'should pull all available schedules' do
+    schedules = VasSchedule.get_all
+    schedules.should_not be nil
+    schedules.count.should > 0
+    schedules.each{ |s| s.should be_valid }
+  end
+  
+  it 'should pull a schedule by ID' do  
+    all = VasSchedule.get_all
+    all.should_not be nil
+    all.count.should > 0
+    
+    schedule_id = all[rand(all.count)].schedule_id
+    schedules = VasSchedule.get_all(:schedule_id => schedule_id)
+    schedules.count.should == 1
+    schedules[0].schedule_id.should == schedule_id
+  end
+  
+  it 'default sort should be by name' do
+    all = VasSchedule.get_all
+    
+    old_val = ""
+    all.each { |s|
+      s.name.should >= old_val
+      old_val = s.name
+    }
+  end
+  
+  it 'should sort by schedule_id' do
+    all = VasSchedule.get_all(:sort_by=>:schedule_id)
+    
+    old_val = ""
+    all.each { |s|
+      s.schedule_id.should >= old_val
+      old_val = s.schedule_id
+    }
+  end
+  
+  it 'should sort_by first_time' do
+    all = VasSchedule.get_all(:sort_by=>:first_time)
+    
+    old_val = Time.at(0)
+    all.each { |s|
+      s.first_time.should >= old_val
+      old_val = s.first_time
+    }
+  end
+  
+  it 'should sort_by next_time' do
+    all = VasSchedule.get_all(:sort_by=>:next_time)
+    
+    old_val = Time.at(0)
+    all.each { |s|
+      s.next_time.should >= old_val
+      old_val = s.next_time
+    }
+  end
+end

data/spec/openvas-cli/vas_target_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe VasTarget do
+  it 'should get all available targets' do
+    targs = VasTarget.get_all
+    targs.count.should > 0
+    
+    targs.each { |t|
+      t.should be_valid
+    }
+  end
+  
+  it 'should require a non-empty vas_id' do
+    t = VasTarget.new
+    t.vas_id = ""
+    
+    t.should_not be_valid
+  end
+  
+  it 'should require a valid UUID format' do
+    t = VasTarget.new
+    t.vas_id = "This is not a valid UUID"
+    
+    t.should_not be_valid
+    t.should have(1).errors
+    
+    valid_chars = ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a',
+                   'b', 'c', 'd', 'e', 'f', 'A', 'B', 'C', 'D', 'E', 'F', '-']
+    
+    1.upto(10) {
+      uuid = ''
+      1.upto(rand(40) + 1) {
+        uuid += valid_chars[rand(valid_chars.length)]
+      }
+      t.vas_id = uuid
+      t.should be_valid
+    }
+  end
+end

data/spec/openvas-cli/vas_task_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe 'VasTask' do
+  it 'should pull all tasks' do
+    tasks = VasTask.get_all
+    
+    tasks.should_not be nil
+    
+    tasks.each { |t| t.should be_valid }
+  end
+  
+  it 'should pull a single task given the task_id' do
+    task = VasTask.get_all[0]
+    
+    new_task = VasTask.get_all(:task_id => task.task_id)[0]
+    
+    task.task_id.should == new_task.task_id
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'openvas-cli')))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'openvas-cli'
+require 'log4r'
+
+Dir["#{File.dirname(__FILE__)}/../lib/openvas-cli/vas_*.rb"].each {|f| require f}
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.filter_run_excluding :slow => true
+end
+
+
+# Set the client and logger up to meet your needs.  Be careful if you set the 
+# log level to Log4r::DEBUG.  This will cause A LOT of information to be dumped
+# to file.
+logger               = Log4r::Logger.new 'test_log'
+log_file             = File.expand_path(File.join(File.dirname(__FILE__), '..', 'log', 'test.log'))
+log_out              = Log4r::RollingFileOutputter.new('test_log' , 
+                              {:filename => log_file.to_s,
+                               :maxsize => 10485760})
+log_out.level        = Log4r::WARN
+logger.outputters    = log_out
+OpenvasCli.logger    = logger
+OpenvasCli.user      = "admin"
+OpenvasCli.password  = "Password"