openvas-cli 0.2.10 → 0.2.11

data/VERSION

@@ -1 +1 @@
-0.2.10
+0.2.11

data/lib/openvas-cli/vas_config.rb

@@ -81,12 +81,15 @@ module OpenvasCli
       ret
     end
     
-    def self.copy_config(id, name)
+    def self.copy_config(id, name, comment = nil)
       begin
         req = Nokogiri::XML::Builder.new { |xml|
           xml.create_config {
             xml.copy { xml.text(id) }
             xml.name { xml.text(name) }
+            if comment && !comment.empty?
+              xml.comment { xml.text(comment) }
+            end
           }
         }
         

data/lib/openvas-cli/vas_task.rb

@@ -83,8 +83,9 @@ module OpenvasCli
         schedule_id = schedule.id
       end
       
-      if config.changed?
+      if config && config.changed?
         return unless config.save
+        config_id = config.id
       end
        
       req = Nokogiri::XML::Builder.new { |xml|
@@ -92,7 +93,7 @@ module OpenvasCli
           xml.modify_task(:id => @id) {
             xml.name    { xml.text(@name) }    if name_changed?
             xml.comment { xml.text(@comment) } if comment_changed?
-            xml.schedule(:id => @schedule_id)  if schedule_id && schedule_id_changed?
+            xml.schedule(:id => @schedule_id)  if schedule_id && !schedule_id.blank? && schedule_id_changed?
           }
         else
           xml.create_task {
@@ -100,7 +101,7 @@ module OpenvasCli
             xml.comment { xml.text(@comment) } if @comment
             xml.config(:id => @config_id)
             xml.target(:id => @target_id)
-            xml.schedule(:id => @schedule_id)  if @schedule_id
+            xml.schedule(:id => @schedule_id)  if @schedule_id && !@schedule_id.blank?
           }
         end
       }
@@ -159,7 +160,7 @@ module OpenvasCli
         
         task = VasTask.connection.send_receive(req.doc)
       
-       @progress = VasTaskStatus.from_xml_node task.at_xpath('/get_tasks_response/task/progress')
+        @progress = VasTaskProgress.from_xml_node task.at_xpath('/get_tasks_response/task/progress')
       end
       @progress
     end

data/lib/openvas-cli/vas_task_progress.rb

@@ -5,10 +5,12 @@ module OpenvasCli
   class VasTaskProgress
     include XmlAddin
     
-    attr_accessor :overall
+    def overall
+      @overall ||= 0
+    end
     
-    def initialize(params={})
-      @overall = 0
+    def overall=(val)
+      @overall = val
     end
     
     def ip_stats
@@ -17,8 +19,8 @@ module OpenvasCli
     
     def self.from_xml_node(node)
       ret = VasTaskProgress.new
-      ret.overall = extract_value_from("progress", node)
-      node.xpath("progress/host_progress").each { |p_node|
+      ret.overall = extract_value_from(".", node).to_i
+      node.xpath("./host_progress").each { |p_node|
         prg = extract_value_from(".", p_node).to_i
         hst = extract_value_from("host", p_node)
         ret.ip_stats[hst] = prg

data/openvas-cli.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{openvas-cli}
-  s.version = "0.2.10"
+  s.version = "0.2.11"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Reed Swenson"]
-  s.date = %q{2011-04-14}
+  s.date = %q{2011-04-22}
   s.description = %q{A full ruby implementation of the OpenVAS OMP (version 2.0) protocol.}
   s.email = %q{fleureed@gmail.com}
   s.extra_rdoc_files = [
@@ -61,14 +61,16 @@ Gem::Specification.new do |s|
     "spec/openvas-cli/vas_result_spec.rb",
     "spec/openvas-cli/vas_schedule_spec.rb",
     "spec/openvas-cli/vas_target_spec.rb",
+    "spec/openvas-cli/vas_task_progress_spec.rb",
     "spec/openvas-cli/vas_task_spec.rb",
+    "spec/openvas-cli/xml_addin_spec.rb",
     "spec/spec_helper.rb",
     "vas_test.rb"
   ]
   s.homepage = %q{http://reedswenson.github.com/openvas-cli/}
   s.licenses = ["GPL v2 or greater"]
   s.require_paths = ["lib", "lib/openvas-cli"]
-  s.rubygems_version = %q{1.5.3}
+  s.rubygems_version = %q{1.6.0}
   s.summary = %q{A full ruby implementation of the OpenVAS OMP (version 2.0) protocol.}
   s.test_files = [
     "spec/openvas-cli/vas_administrator_spec.rb",
@@ -82,7 +84,9 @@ Gem::Specification.new do |s|
     "spec/openvas-cli/vas_result_spec.rb",
     "spec/openvas-cli/vas_schedule_spec.rb",
     "spec/openvas-cli/vas_target_spec.rb",
+    "spec/openvas-cli/vas_task_progress_spec.rb",
     "spec/openvas-cli/vas_task_spec.rb",
+    "spec/openvas-cli/xml_addin_spec.rb",
     "spec/spec_helper.rb"
   ]
 

data/spec/openvas-cli/vas_config_spec.rb

@@ -36,13 +36,30 @@ module OpenvasCli
     end
     
     it 'be able to copy a configuration' do
-      cfg = VasConfig.get_all[0]
-      
-      new_cfg = VasConfig.copy_config(cfg.id, "Test_#{Time.now.strftime('%Y-%m-%d_%H:%M:%S')}")
+      cfg = VasConfig.get_all.first
+
+      new_name = "Test_#{Time.now.strftime('%Y-%m-%d_%H:%M:%S')}"
+      new_cfg = VasConfig.copy_config(cfg.id, new_name)      
       
       new_cfg.should_not be nil
       new_cfg.id.should_not be cfg.id
+      new_cfg.name.should == new_name
+            
+      new_cfg.destroy!
+    end
+    
+    it 'be able to copy a configuration with a description' do
+      cfg = VasConfig.get_all.first
+      
+      new_name = "Test_#{Time.now.strftime('%Y-%m-%d_%H:%M:%S')}"
+      new_comment = "Test Configuration Named #{new_name}"
+      new_cfg = VasConfig.copy_config(cfg.id, new_name, new_comment)
       
+      new_cfg.should_not be nil
+      new_cfg.id.should_not be cfg.id
+      new_cfg.name.should == new_name
+      new_cfg.comment.should == new_comment
+
       new_cfg.destroy!
     end
     

data/spec/openvas-cli/vas_target_spec.rb

@@ -176,5 +176,9 @@ module OpenvasCli
         new_hosts.include?(h).should be true
       }
     end
+    
+    it 'should report the progress of a task appropriately' do
+      
+    end
   end
 end

data/spec/openvas-cli/vas_task_progress_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'nokogiri'
+
+module OpenvasCli
+  describe VasTaskProgress do
+    it 'should pull the progress correctly' do
+      task_xml = '<?xml version="1.0" encoding="UTF-8"?>
+<get_tasks_response status="200" status_text="OK">
+  <task_count>1</task_count>
+  <sort>
+    <field>name<order>ascending</order></field>
+  </sort>
+  <apply_overrides>0</apply_overrides>
+  <task id="f4cb1a0a-f2d5-47f4-b4a3-a16e31319ca8">
+    <name>Test_Task_Runner_2011-04-22_09:17:24</name>
+    <comment>Going to run this one.</comment>
+    <config id="698f691e-7489-11df-9d8c-002264764cea">
+      <name>Full and fast ultimate</name>
+    </config>
+    <escalator id="">
+      <name/>
+    </escalator>
+    <target id="6bd29de5-f4e4-471a-9831-b1cdc14cd6bf">
+      <name>Target_Test_Gateway_2011-04-22_09:17:24</name>
+    </target>
+    <slave id="">
+      <name/>
+    </slave>
+    <status>Running</status>
+    <progress><host_progress><host>10.55.128.254</host>98</host_progress>98</progress>
+    <report_count>1<finished>0</finished></report_count>
+    <trend/>
+    <schedule id="">
+      <name/>
+      <next_time>over</next_time>
+    </schedule>
+  </task>
+</get_tasks_response>'
+      x = Nokogiri::XML(task_xml)
+      
+      prg = VasTaskProgress.from_xml_node(x.at_xpath("/get_tasks_response/task/progress"))
+      prg.overall.should == 98
+      prg.should have(1).ip_stats
+      prg.ip_stats["10.55.128.254"].should == 98
+    end
+  end
+end

data/spec/openvas-cli/vas_task_spec.rb

@@ -10,9 +10,13 @@ module OpenvasCli
       all.each { |t| t.destroy! if t.name =~ /Target_Test_.*/i }
     end
     
+    def time_stamp
+      Time.now.strftime('%Y-%m-%d_%H:%M:%S')
+    end
+    
     def valid_params
       {
-        :name => "Test_#{Time.now.strftime('%Y-%m-%d_%H:%M:%S')}",
+        :name => "Test_#{time_stamp}",
         :config_id => get_config_id, 
         :target_id => get_target_id, 
         :schedule => VasSchedule.new(schedule_params)
@@ -21,7 +25,7 @@ module OpenvasCli
     
     def schedule_params
       {
-        :name => "Test_#{Time.now.strftime('%Y-%m-%d_%H:%M:%S')}", 
+        :name => "Test_#{time_stamp}", 
         :comment => "Test Schedule [Automatically Generated]", 
         :first_time => Time.now + 86400,
         :period => VasPeriod.new(:number => 1, :period => :day)
@@ -45,11 +49,17 @@ module OpenvasCli
     
     def valid_target_params
       {
-        :name  => "Test_Target_#{Time.now.strftime('%Y-%m-%d_%H:%M:%S')}",
+        :name  => "Test_Target_#{time_stamp}",
         :hosts => VasTarget.get_local_subnets
       }
     end
     
+    def get_gateway
+      `route -n`.split("\n").each { |rline|
+        return rline.split(/\s+/)[1] if rline =~ /\A\s*0\.0\.0\.0/
+      }
+    end
+    
     it 'should create a valid task' do
       t = VasTask.new(valid_params)
       t.should be_valid
@@ -95,9 +105,137 @@ module OpenvasCli
       end
     end
     
-    it 'should start a new task and run it to the end'
-    it 'should stop a task completely'
-    it 'should pause a task and restart it'
-    it 'should report the progress of a task'
+    it 'should start a new task and run it to the end', :slow => true do
+      config = nil
+      VasConfig.get_all.each { |cfg|
+        config = cfg if cfg.name =~ /full and fast/i
+      }
+      config.should_not be nil
+      
+      target = VasTarget.new(
+        :name  => "Target_Test_Gateway_#{time_stamp}",
+        :hosts => [get_gateway]
+      )
+      target.save!
+      
+      task = VasTask.new(
+        :name      => "Test_Task_Runner_#{time_stamp}",
+        :comment   => "Going to run this one.",
+        :config_id => config.id,
+        :target_id => target.id
+      )
+      task.save!
+      
+      task.start
+      
+      
+      tsk = VasTask.get_by_id(task.id)
+      count = 0
+      while tsk.status =~ /requested/i && count < 360
+        sleep 1
+        tsk = VasTask.get_by_id(task.id)
+        count += 1
+      end
+      
+      count.should be < 360
+            
+      tsk.status.should =~ /running/i
+      
+      overall = 0
+      max = -99999
+      while tsk.status =~ /running/i do
+        sleep 3 
+        
+        tsk = VasTask.get_by_id(task.id)
+        tsk.progress.overall.should >= overall unless tsk.progress.overall == -1
+        overall = tsk.progress.overall
+        max = overall if overall > max
+      end
+      
+      max.should > 0
+    end
+    
+    it 'should stop a task completely', :slow => true do
+      config = nil
+      VasConfig.get_all.each { |cfg|
+        config = cfg if cfg.name = "Full and fast"
+      }
+      config.should_not be nil
+      
+      target = VasTarget.new(
+        :name  => "Target_Test_Gateway_#{time_stamp}",
+        :hosts => [get_gateway]
+      )
+      target.save!
+      
+      task = VasTask.new(
+        :name      => "Test_Task_Runner_#{time_stamp}",
+        :comment   => "Going to run this one.",
+        :config_id => config.id,
+        :target_id => target.id
+      )
+      task.save!
+      
+      task.start
+      
+      
+      tsk = VasTask.get_by_id(task.id)
+      count = 0
+      while tsk.status =~ /requested/i && count < 360
+        sleep 1
+        tsk = VasTask.get_by_id(task.id)
+        count += 1
+      end
+      
+      count.should be < 360
+            
+      tsk.status.should =~ /running/i
+      
+      sleep 30
+      tsk.stop
+      sleep 60
+      tsk = VasTask.get_by_id(task.id)
+      tsk.status.should =~ /stopped/i
+            
+    end
+    
+    it 'should pause a task and restart it' do 
+      config = nil
+      VasConfig.get_all.each { |cfg|
+        config = cfg if cfg.name = "Full and fast"
+      }
+      config.should_not be nil
+      
+      target = VasTarget.new(
+        :name  => "Target_Test_Gateway_#{time_stamp}",
+        :hosts => [get_gateway]
+      )
+      target.save!
+      
+      task = VasTask.new(
+        :name      => "Test_Task_Runner_#{time_stamp}",
+        :comment   => "Going to run this one.",
+        :config_id => config.id,
+        :target_id => target.id
+      )
+      task.save!
+      
+      task.start
+      
+      
+      tsk = VasTask.get_by_id(task.id)
+      count = 0
+      while tsk.status =~ /requested/i && count < 360
+        sleep 1
+        tsk = VasTask.get_by_id(task.id)
+        count += 1
+      end
+      
+      count.should be < 360
+            
+      tsk.status.should =~ /running/i
+      
+      sleep 30
+    end
   end
 end

data/spec/openvas-cli/xml_addin_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'nokogiri'
+
+module OpenvasCli
+  describe XmlAddin do
+    class DummyClass
+      include XmlAddin
+    end
+    
+    it 'should have the extract_value_from method' do
+      DummyClass.public_methods.should include "extract_value_from"
+    end
+    
+    it 'should extract the correct value from a node with only text decendants' do
+      bldr = Nokogiri::XML::Builder.new { |x|
+        x.base_node { x.text("Test Value") }
+      }
+      
+      DummyClass.extract_value_from("/base_node", bldr.doc).should == "Test Value"
+    end
+    
+    it 'should extract the correct value from a node with a single attribute' do
+      bldr = Nokogiri::XML::Builder.new { |x|
+        x.base_node({:t_attr => "Test Value"})
+      }
+      
+      DummyClass.extract_value_from("/base_node/@t_attr", bldr.doc).should == "Test Value"
+    end
+    
+    it 'should extract the text value from a node even if it has children' do
+      bldr = Nokogiri::XML::Builder.new { |x|
+        x.base_node {
+          x.child_node_one { x.text "Child 1 Value" }
+          x.child_node_two({:ch_one_attr => "Child 2 Value"})
+          x.text("Test Value")
+        }
+      }
+      
+      DummyClass.extract_value_from("/base_node", bldr.doc).should == "Test Value"
+    end
+    
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: openvas-cli
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: 
   segments: 
   - 0
   - 2
-  - 10
-  version: 0.2.10
+  - 11
+  version: 0.2.11
 platform: ruby
 authors: 
 - Reed Swenson
@@ -15,12 +15,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-14 00:00:00 -05:00
+date: 2011-04-22 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activesupport
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -31,12 +31,12 @@ dependencies:
         - 0
         - 5
         version: 3.0.5
+  version_requirements: *id001
+  name: activesupport
   prerelease: false
-  type: :runtime
-  requirement: *id001
 - !ruby/object:Gem::Dependency 
-  name: activerecord
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -47,12 +47,12 @@ dependencies:
         - 0
         - 5
         version: 3.0.5
+  version_requirements: *id002
+  name: activerecord
   prerelease: false
-  type: :runtime
-  requirement: *id002
 - !ruby/object:Gem::Dependency 
-  name: rails
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  type: :runtime
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -63,12 +63,12 @@ dependencies:
         - 0
         - 5
         version: 3.0.5
+  version_requirements: *id003
+  name: rails
   prerelease: false
-  type: :runtime
-  requirement: *id003
 - !ruby/object:Gem::Dependency 
-  name: nokogiri
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  type: :runtime
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -79,12 +79,12 @@ dependencies:
         - 4
         - 4
         version: 1.4.4
+  version_requirements: *id004
+  name: nokogiri
   prerelease: false
-  type: :runtime
-  requirement: *id004
 - !ruby/object:Gem::Dependency 
-  name: ipaddress
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  type: :runtime
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -95,12 +95,12 @@ dependencies:
         - 7
         - 0
         version: 0.7.0
+  version_requirements: *id005
+  name: ipaddress
   prerelease: false
-  type: :runtime
-  requirement: *id005
 - !ruby/object:Gem::Dependency 
-  name: rspec
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -111,12 +111,12 @@ dependencies:
         - 3
         - 0
         version: 2.3.0
+  version_requirements: *id006
+  name: rspec
   prerelease: false
-  type: :development
-  requirement: *id006
 - !ruby/object:Gem::Dependency 
-  name: bundler
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -127,12 +127,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
+  version_requirements: *id007
+  name: bundler
   prerelease: false
-  type: :development
-  requirement: *id007
 - !ruby/object:Gem::Dependency 
-  name: jeweler
-  version_requirements: &id008 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -143,12 +143,12 @@ dependencies:
         - 5
         - 2
         version: 1.5.2
+  version_requirements: *id008
+  name: jeweler
   prerelease: false
-  type: :development
-  requirement: *id008
 - !ruby/object:Gem::Dependency 
-  name: rcov
-  version_requirements: &id009 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -157,12 +157,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  version_requirements: *id009
+  name: rcov
   prerelease: false
-  type: :development
-  requirement: *id009
 - !ruby/object:Gem::Dependency 
-  name: ZenTest
-  version_requirements: &id010 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -171,12 +171,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  version_requirements: *id010
+  name: ZenTest
   prerelease: false
-  type: :development
-  requirement: *id010
 - !ruby/object:Gem::Dependency 
-  name: log4r
-  version_requirements: &id011 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -185,9 +185,9 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  version_requirements: *id011
+  name: log4r
   prerelease: false
-  type: :development
-  requirement: *id011
 description: A full ruby implementation of the OpenVAS OMP (version 2.0) protocol.
 email: fleureed@gmail.com
 executables: []
@@ -242,7 +242,9 @@ files:
 - spec/openvas-cli/vas_result_spec.rb
 - spec/openvas-cli/vas_schedule_spec.rb
 - spec/openvas-cli/vas_target_spec.rb
+- spec/openvas-cli/vas_task_progress_spec.rb
 - spec/openvas-cli/vas_task_spec.rb
+- spec/openvas-cli/xml_addin_spec.rb
 - spec/spec_helper.rb
 - vas_test.rb
 has_rdoc: true
@@ -276,7 +278,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.3
+rubygems_version: 1.6.0
 signing_key: 
 specification_version: 3
 summary: A full ruby implementation of the OpenVAS OMP (version 2.0) protocol.
@@ -292,5 +294,7 @@ test_files:
 - spec/openvas-cli/vas_result_spec.rb
 - spec/openvas-cli/vas_schedule_spec.rb
 - spec/openvas-cli/vas_target_spec.rb
+- spec/openvas-cli/vas_task_progress_spec.rb
 - spec/openvas-cli/vas_task_spec.rb
+- spec/openvas-cli/xml_addin_spec.rb
 - spec/spec_helper.rb