ruby-nmap 0.6.0 → 0.7.0

data/spec/scanner_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'nmap/scanner'
+
+describe Scanner do
+  describe "#to_s" do
+    let(:name)    { 'nmap' }
+    let(:version) { '6.01' }
+    let(:args)    { 'nmap -v -sS -sU -A -O -oX spec/scan.xml scanme.nmap.org' }
+    let(:start_time) { Time.new('Sat Jul 20 23:55:27 2013') }
+
+    subject do
+      described_class.new(
+        name,
+        version,
+        args,
+        start_time
+      )
+    end
+
+    it "should return the scanner command" do
+      subject.to_s.should == "#{name} #{args}"
+    end
+  end
+end

data/spec/scripts_examples.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+
+shared_examples_for "#scripts" do
+  describe "#scripts" do
+    subject { super().scripts }
+
+    it { should be_kind_of(Hash) }
+    it { should_not be_empty     }
+  end
+end

data/spec/sequence_examples.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+shared_examples_for "Sequence" do
+  describe "#values" do
+    subject { super().values }
+
+    it { should have(6).items }
+    it { should all_be_between(0,0xFFFFFFFF) }
+  end
+end

data/spec/service_spec.rb

@@ -1,40 +1,77 @@
 require 'spec_helper'
-require 'helpers/xml'
+require 'cpe_examples'
 
 require 'nmap/xml'
 require 'nmap/service'
 
 describe Service do
-  include Helpers
+  subject { @xml.hosts.first.ports.first.service }
 
-  before(:all) do
-    @xml = XML.new(Helpers::SCAN_FILE)
-    @nse_xml = XML.new(Helpers::NSE_FILE)
+  describe "#name" do
+    it "should parse the name" do
+      subject.name.should == 'ssh'
+    end
   end
 
-  subject { @xml.hosts.first.ports.first.service }
+  describe "#ssl?" do
+    it "should check the tunnel attribute" do
+      pending "need a service that uses SSL"
+    end
+  end
 
-  it "should have a name" do
-    subject.name.should == 'ftp'
+  describe "#protocol" do
+    it "should parse the proto attribute" do
+      pending "need a service with the proto attribute"
+    end
   end
 
-  it "should have a fingerprint method" do
-    subject.fingerprint_method.should == :table
+  describe "#product" do
+    it "should parse the product name attribute" do
+      subject.product.should == 'OpenSSH'
+    end
   end
 
-  it "should have a confidence" do
-    subject.confidence.should == 3
+  describe "#version" do
+    it "should parse the version attribute" do
+      subject.version.should == '5.3p1 Debian 3ubuntu7'
+    end
   end
 
-  context "with improved detection" do
-    subject { @nse_xml.hosts.first.ports.first.service }
+  describe "#extra_info" do
+    it "should parse the extrainfo attribute" do
+      subject.extra_info.should == 'protocol 2.0'
+    end
+  end
 
-    it "should have a product name" do
-      subject.product.should == 'OpenSSH'
+  describe "#hostname" do
+    it "should parse the hostname attribute" do
+      pending "need a service with the hostname attribute"
     end
+  end
+
+  describe "#os_type" do
+    it "should parse the ostype attribute" do
+      subject.os_type.should == 'Linux'
+    end
+  end
 
-    it "should have a version" do
-      subject.version.should == '5.1p1 Debian 6ubuntu2'
+  describe "#device_type" do
+    it "should parse the devicetype attribute" do
+      pending "need a service with the devicetype attribute"
     end
   end
+
+  describe "#fingerprint_method" do
+    it "should parse the method attribute" do
+      subject.fingerprint_method.should == :probed
+    end
+  end
+
+  describe "#confidence" do
+    it "should parse the conf attribute" do
+      subject.confidence.should be_between(0,10)
+    end
+  end
+
+  it_should_behave_like "CPE"
 end

data/spec/spec_helper.rb

@@ -1,12 +1,39 @@
-gem 'rspec', '~> 2.4'
 require 'rspec'
+require 'simplecov'
+SimpleCov.start
 
 require 'nmap/version'
 require 'nmap/xml'
 include Nmap
 
-require 'helpers/xml'
+RSpec::Matchers.define :be_between do |min,max|
+  match do |value|
+    (value >= min) && (value <= max)
+  end
+end
+
+RSpec::Matchers.define :all_be_between do |min,max|
+  match do |values|
+    values.all? { |value| (value >= min) && (value <= max) }
+  end
+end
+
+RSpec::Matchers.define :be_one_of do |*values|
+  match do |value|
+    values.include?(value)
+  end
+
+  description { "be one of: #{expected.join(', ')}" }
+end
+
+RSpec::Matchers.define :all_be_kind_of do |base_class|
+  match do |values|
+    values.all? { |value| value.kind_of?(base_class) }
+  end
+end
 
 RSpec.configure do |spec|
-  spec.include Helpers
+  spec.before(:all) do
+    @xml = XML.new('spec/scan.xml')
+  end
 end

data/spec/status_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require 'nmap/status'
+
+describe Status do
+  describe "#to_s" do
+    let(:state)  { :up }
+    let(:reason) { 'syn-ack' }
+
+    subject { described_class.new(state,reason) }
+
+    it "should return the state" do
+      subject.to_s.should == state.to_s
+    end
+  end
+end

data/spec/tcp_sequence_spec.rb

@@ -1,31 +1,44 @@
 require 'spec_helper'
+require 'sequence_examples'
+
 require 'nmap/tcp_sequence'
 
 describe TcpSequence do
-  let(:xml) { XML.new(Helpers::SCAN_FILE) }
-
-  subject { xml.hosts.first.tcp_sequence }
+  subject { @xml.hosts.first.tcp_sequence }
 
-  it "should be accessible from host objects" do
-    subject.should be_kind_of(TcpSequence)
+  describe "#index" do
+    it "should parse the index" do
+      subject.index.should be > 0
+    end
   end
 
-  it "should parse the index" do
-    subject.index.should == 25
+  describe "#description" do
+    it "should parse the difficulty description" do
+      subject.difficulty.should == "Good luck!"
+    end
   end
 
-  it "should parse the difficulty description" do
-    subject.difficulty.should == "Good luck!"
-  end
+  describe "#to_s" do
+    let(:index_regexp) do
+      /\d+/
+    end
+
+    let(:difficulty_regexp) do
+      /"(Good luck!)"/
+    end
 
-  it "should parse the values" do
-    subject.values.should == [
-      0xAF1B39BD,
-      0xAF1C33BD,
-      0xAF1F21BD,
-      0xAF201BBD,
-      0xAF2115BD,
-      0xAF220FBD
-    ]
+    let(:values_regexp) do
+      /\[\d+(, \d+){5}\]/
+    end
+
+    let(:regexp) do
+      /^index=#{index_regexp} difficulty=#{difficulty_regexp} values=#{values_regexp}$/
+    end
+
+    it "should contain the description and values" do
+      subject.to_s.should =~ regexp
+    end
   end
+
+  it_should_behave_like "Sequence"
 end

data/spec/tcp_ts_sequence_spec.rb

@@ -1,20 +1,34 @@
 require 'spec_helper'
+require 'sequence_examples'
+
 require 'nmap/tcp_ts_sequence'
 
 describe TcpTsSequence do
-  let(:xml) { XML.new(Helpers::SCAN_FILE) }
-
-  subject { xml.hosts.first.tcp_ts_sequence }
+  subject { @xml.hosts.first.tcp_ts_sequence }
 
-  it "should be accessible from host objects" do
-    subject.should be_kind_of(TcpTsSequence)
+  describe "#description" do
+    it "should parse the description" do
+      subject.description.should == "1000HZ"
+    end
   end
 
-  it "should parse the description" do
-    subject.description.should == "2HZ"
-  end
+  describe "#to_s" do
+    let(:description_regexp) do
+      /"[^"]+"/
+    end
 
-  it "should parse the values" do
-    subject.values.should == [0x1858, 0x1858, 0x1859, 0x1859, 0x1859, 0x1859]
+    let(:values_regexp) do
+      /\[\d+(, \d+){5}\]/
+    end
+
+    let(:regexp) do
+      /^description=#{description_regexp} values=#{values_regexp}$/
+    end
+
+    it "should contain the description and values" do
+      subject.to_s.should =~ regexp
+    end
   end
+
+  it_should_behave_like "Sequence"
 end

data/spec/traceroute_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'nmap/traceroute'
+
+describe Traceroute do
+  subject { @xml.hosts.first.traceroute }
+
+  describe "#port" do
+    subject { super().port }
+
+    it { should be_kind_of(Integer) }
+    it { should be > 0 }
+    it { should be < 65535 }
+  end
+
+  describe "#protocol" do
+    subject { super().protocol }
+
+    it { should be_kind_of(Symbol) }
+    it { should be_one_of(:tcp, :udp) }
+  end
+
+  describe "#each" do
+    subject { super().each.first }
+
+    it { should be_kind_of(Hop) }
+
+    its(:addr) { should be_kind_of(String)  }
+    its(:ttl)  { should be_kind_of(String)  }
+    its(:rtt)  { should be_kind_of(String)  }
+  end
+end

data/spec/uptime_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require 'nmap/uptime'
+
+describe Uptime do
+  describe "#to_s" do
+    let(:seconds)   { 920430 }
+    let(:last_boot) { Time.parse("2013-07-10 08:34:03 -0700") }
+
+    subject { described_class.new(seconds,last_boot) }
+
+    it "should convert the uptipe to a String" do
+      subject.to_s.should == "uptime: #{seconds} (#{last_boot})"
+    end
+  end
+end

data/spec/xml_spec.rb

@@ -2,34 +2,88 @@ require 'spec_helper'
 require 'nmap/xml'
 
 describe XML do
-  subject { XML.new(Helpers::SCAN_FILE) }
+  let(:path) { File.expand_path('spec/scan.xml') }
 
-  it "should have a version" do
-    subject.version.should == '1.02'
+  subject { described_class.new(path) }
+
+  describe "#initialize" do
+    context "when given a Nokogiri::XML::Document" do
+      let(:document) { Nokogiri::XML(File.read(path)) }
+
+      it "should use the document" do
+        described_class.new(document).version.should == subject.version
+      end
+    end
+
+    context "when given an IO object" do
+      let(:io) { File.new(path) }
+
+      it "should parse the IO object" do
+        described_class.new(io).version.should == subject.version
+      end
+    end
+
+    context "when given a String" do
+      it "should parse the file at the path" do
+        described_class.new(path).version.should == subject.version
+      end
+    end
   end
 
-  it "should parse the scanner version" do
-    subject.scanner.version == '4.68'
+  describe "load" do
+    it "should parse the given text" do
+      subject.version.should == described_class.load(File.read(path)).version
+    end
   end
 
-  it "should parse the scanner name" do
-    subject.scanner.name.should == 'nmap'
+  describe "open" do
+    it "should parse the given file" do
+      subject.version.should == described_class.open(path).version
+    end
+
+    it "should set the path" do
+      subject.path.should == path
+    end
   end
 
-  it "should parse the scanner arguments" do
-    subject.scanner.arguments.should == 'nmap -v -oX samples/backspace.xml -O -P0 -sS 192.168.5.*'
+  describe "#version" do
+    it "should have a version" do
+      subject.version.should == '1.04'
+    end
   end
 
-  it "should parse the scanner start time" do
-    subject.scanner.start_time.should == Time.at(1218934249)
+  describe "#scanner" do
+    it "should parse the scanner version" do
+      subject.scanner.version == '4.68'
+    end
+
+    it "should parse the scanner name" do
+      subject.scanner.name.should == 'nmap'
+    end
+
+    it "should parse the scanner arguments" do
+      subject.scanner.arguments.should == 'nmap -v -sS -sU -A -O -oX spec/scan.xml scanme.nmap.org'
+    end
+
+    it "should parse the scanner start time" do
+      subject.scanner.start_time.should be_kind_of(Time)
+    end
   end
 
-  it "should parse the scan information" do
-    scan_info = subject.scan_info
+  describe "#scan_info" do
+    subject { super().scan_info.first }
+
+    it "should parse the type" do
+      subject.type.should == :syn
+    end
 
-    scan_info.length.should == 1
-    scan_info.first.type.should == :syn
-    scan_info.first.protocol.should == :tcp
+    it "should parse the protocol" do
+      subject.protocol.should == :tcp
+    end
+
+    it "should parse the services" do
+      subject.services.should_not be_empty
+    end
   end
 
   it "should parse the verbose level" do
@@ -40,31 +94,118 @@ describe XML do
     subject.debugging.should == 0
   end
 
-  it "should parse the scan tasks" do
-    tasks = subject.tasks
+  describe "#each_run_stat" do
+    subject { super().each_run_stat.first }
 
-    tasks.should_not be_empty
+    it "should yield RunStat objects" do
+      subject.should be_kind_of(RunStat)
+    end
 
-    tasks.each do |task|
-      task.name.should_not be_nil
-      task.name.should_not be_empty
+    it "should parse the end time" do
+      subject.end_time.should be_kind_of(Time)
+    end
+
+    it "should parse the time elapsed" do
+      subject.elapsed.should_not be_nil
+    end
 
-      task.start_time.should > Time.at(0)
+    it "should parse the summary" do
+      subject.summary.should_not be_empty
+    end
 
-      task.end_time.should > Time.at(0)
-      task.end_time.should >= task.start_time
+    it "should parse the exit status" do
+      subject.exit_status.should be_one_of('success', 'failure')
     end
   end
 
-  it "should parse the hosts" do
-    subject.hosts.length.should == 10
+  describe "#run_stats" do
+    subject { super().run_stats }
+
+    it { should_not be_empty }
+    it { should all_be_kind_of(RunStat) }
   end
 
-  it "should iterate over each up host" do
-    subject.each.all? { |host| host.status.state == :up }.should == true
+  describe "#each_task" do
+    subject { super().each_task.first }
+
+    it "should parse task name" do
+      subject.name.should == 'Ping Scan'
+    end
+
+    it "should parse the start time" do
+      subject.start_time.should be_kind_of(Time)
+    end
+
+    it "should parse the end time" do
+      subject.end_time.should be_kind_of(Time)
+      subject.end_time.should > subject.start_time
+    end
+
+    it "should parse the extrainfo" do
+      subject.extrainfo.should_not be_empty
+    end
   end
 
-  it "should convert to a String" do
-    subject.to_s.should == Helpers::SCAN_FILE
+  describe "#tasks" do
+    subject { super().tasks }
+
+    it { should_not be_empty }
+    it { should all_be_kind_of(ScanTask) }
+  end
+
+  describe "#each_host" do
+    subject { super().each_host.first }
+
+    it "should yield Host objects" do
+      subject.should be_kind_of(Host)
+    end
+  end
+
+  describe "#hosts" do
+    subject { super().hosts }
+
+    it { should_not be_empty }
+    it { subject.should all_be_kind_of(Host) }
+  end
+
+  describe "#each_up_host" do
+    subject { super().each_up_host.first }
+
+    it "should yield Host objects" do
+      subject.should be_kind_of(Host)
+    end
+
+    it "should be up" do
+      subject.status.state.should be == :up
+    end
+  end
+
+  describe "#up_hosts" do
+    subject { super().up_hosts }
+
+    it { should_not be_empty }
+    it { should all_be_kind_of(Host) }
+
+    it "should contain only up hosts" do
+      subject.all? { |host| host.status.state == :up }.should be_true
+    end
+  end
+
+  describe "#each" do
+    it "should iterate over each up host" do
+      subject.each.all? { |host| host.status.state == :up }.should == true
+    end
+  end
+
+  describe "#to_s" do
+    it "should convert to a String" do
+      subject.to_s.should == path
+    end
+  end
+
+  describe "#inspect" do
+    it "should include the class and path" do
+      subject.inspect.should == "#<#{described_class}: #{path}>"
+    end
   end
 end