NexposeRunner 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02276abd1b4120d897508fcb94c7feaa3fccf278
-  data.tar.gz: c46e6ce75664e562fd927c02001e5314413e2902
+  metadata.gz: 3fc954479b13a6d1ee5538438ef4e0e9d155acef
+  data.tar.gz: 92f8b3905afd4c71bc0f316c42b605d33b2cf2c6
 SHA512:
-  metadata.gz: c1a363a68c45979d152092fb147b061947476f8043e4b5ea957d86933607ba51fe221bea9b674d45b9e8ed570fd856169fb42d1f2c69d091292286e8b3a714ab
-  data.tar.gz: 11dd648fab97053056db276678cdf6dcd407b91266a3352e055bd81a90589040ab6296b30390c2f23db6fcb35af84155e8061412536671e5a7a39b8d9a9bed25
+  metadata.gz: faee2b9d52875bb8e2fe4b3112b96a49746953d1784ca29f8cd3b3c9beb00bc215eaf1440f7bfe459393474f564969175440b2a40446680bf1c61f71cafba9f6
+  data.tar.gz: 4bfb76dc4cf58c81f06c90d2c8ef071c472323b21861d831898c729ce23764e66d5cdc2373255459b21470233582539291f7177a7552f7ff090018b151328f78

data/bin/scan

@@ -3,4 +3,12 @@
 require 'nexpose-runner/scan'
 
 $stdout.sync = true
-NexposeRunner::Scan.start ARGV[0], ARGV[1], ARGV[2], ARGV[3], ARGV[4], ARGV[5], ARGV[6]
+NexposeRunner::Scan.start({
+  'connection_url' => ARGV[0], 
+  'username' => ARGV[1], 
+  'password' => ARGV[2], 
+  'port' => ARGV[3], 
+  'site_name' => ARGV[4], 
+  'ip_addresses' => ARGV[5], 
+  'scan_template' => ARGV[6]
+})

data/lib/NexposeRunner/version.rb

@@ -1,4 +1,4 @@
 module NexposeRunner
-    VERSION = '0.0.4'
-  end
+    VERSION = '0.0.5'
+end
 

data/lib/nexpose-runner/scan.rb

@@ -6,9 +6,9 @@ require 'nexpose-runner/scan_run_description'
 
 module NexposeRunner
   module Scan
-    def Scan.start(connection_url, username, password, port, site_name, ip_addresses, scan_template)
+    def Scan.start(options)
 
-      run_details = ScanRunDescription.new connection_url, username, password, port, site_name, ip_addresses, scan_template
+      run_details = ScanRunDescription.new(options)
       run_details.verify
 
       nsc = get_new_nexpose_connection(run_details)

data/lib/nexpose-runner/scan_run_description.rb

@@ -3,14 +3,14 @@ class ScanRunDescription
   @@port_value = ''
   @@ip_addresses = ''
 
-  def initialize(connection_url, username, password, port, site_name, ip_addresses, scan_template)
-    self.connection_url = connection_url
-    self.username = username
-    self.password = password
-    @@port_value = port
-    self.site_name = site_name
-    self.ip_addresses = ip_addresses
-    self.scan_template = scan_template
+  def initialize(options)
+    self.connection_url = options['connection_url']
+    self.username =  options['username']
+    self.password = options['password']
+    @@port_value = options['port']
+    self.site_name = options['site_name']
+    self.ip_addresses = options['ip_addresses']
+    self.scan_template = options['scan_template']
   end
 
   def verify

data/spec/scan_spec.rb

@@ -42,76 +42,115 @@ describe 'nexpose-runner' do
       @mock_nexpose_client = get_mock_nexpose_client
       @mock_nexpose_site = get_mock_nexpose_site
       @mock_report = get_mock_report
+
+      @options = {
+        'connection_url' => @expected_connection,
+        'username' => @expected_username,
+        'password' => @expected_password,
+        'port' => @expected_port,
+        'site_name' => @expected_site_name,
+        'ip_addresses' => @expected_ips,
+        'scan_template' => @expected_scan_template
+      }
+
     end
 
       it 'should create a session with the nexpose server' do
         expect(Nexpose::Connection).to receive(:new)
-                                    .with(@expected_connection, @expected_username, @expected_password, @expected_port)
+                                    .with(@options['connection_url'],
+                                          @options['username'], 
+                                          @options['password'], 
+                                          @options['port'])
                                     .and_return(@mock_nexpose_client)
 
         expect(@mock_nexpose_client).to receive(:login)
                                     .and_return(true)
 
-        NexposeRunner::Scan.start(@expected_connection, @expected_username, @expected_password, @expected_port, @expected_site_name, @expected_ips, @expected_scan_template)
+        NexposeRunner::Scan.start(@options)
       end
 
       it 'should throw an error if no connection url is passed' do
-        expect { NexposeRunner::Scan.start('', @expected_username, @expected_password, @expected_port, @expected_site_name, @expected_ips, @expected_scan_template) }.to raise_error(StandardError, 'OOPS! Looks like you forgot to give me the URL/IP address to your Nexpose Server')
-        expect { NexposeRunner::Scan.start(nil, @expected_port, @expected_username, @expected_password, @expected_site_name, @expected_ips, @expected_scan_template) }.to raise_error(StandardError, 'OOPS! Looks like you forgot to give me the URL/IP address to your Nexpose Server')
+        options = @options.clone
+        options['connection_url'] = nil
+        expect { 
+          NexposeRunner::Scan.start(options) 
+        }.to raise_error(StandardError, 'OOPS! Looks like you forgot to give me the URL/IP address to your Nexpose Server')
       end
 
       it 'should throw an error if no username is passed' do
-        expect { NexposeRunner::Scan.start(@expected_connection, '', @expected_password, @expected_port, @expected_site_name, @expected_ips, @expected_scan_template) }.to raise_error(StandardError, 'OOPS! Looks like you forgot to give me a username to login to Nexpose with')
-        expect { NexposeRunner::Scan.start(@expected_connection, nil, @expected_password, @expected_port, @expected_site_name, @expected_ips, @expected_scan_template) }.to raise_error(StandardError, 'OOPS! Looks like you forgot to give me a username to login to Nexpose with')
+        options = @options.clone
+        options['username'] = nil
+        expect { 
+          NexposeRunner::Scan.start(options) 
+        }.to raise_error(StandardError, 'OOPS! Looks like you forgot to give me a username to login to Nexpose with')
       end
 
       it 'should throw an error if no password is passed' do
-        expect { NexposeRunner::Scan.start(@expected_connection, @expected_username, '', @expected_port, @expected_site_name, @expected_ips, @expected_scan_template) }.to raise_error(StandardError, 'OOPS! Looks like you forgot to give me a password to login to Nexpose with')
-        expect { NexposeRunner::Scan.start(@expected_connection, @expected_username, nil, @expected_port, @expected_site_name, @expected_ips, @expected_scan_template) }.to raise_error(StandardError, 'OOPS! Looks like you forgot to give me a password to login to Nexpose with')
+        options = @options.clone
+        options['password'] = nil
+        expect { 
+          NexposeRunner::Scan.start(options) 
+        }.to raise_error(StandardError, 'OOPS! Looks like you forgot to give me a password to login to Nexpose with')
       end
 
       it 'should throw an error if no site name is passed' do
-        expect { NexposeRunner::Scan.start(@expected_connection, @expected_username, @expected_password, @expected_port, '', @expected_ips, @expected_scan_template) }.to raise_error(StandardError, 'OOPS! Looks like you forgot to give me a Nexpose Site Name')
-        expect { NexposeRunner::Scan.start(@expected_connection, @expected_username, @expected_password, @expected_port, nil, @expected_ips, @expected_scan_template) }.to raise_error(StandardError, 'OOPS! Looks like you forgot to give me a Nexpose Site Name')
+        options = @options.clone
+        options['site_name'] = nil
+        expect { 
+          NexposeRunner::Scan.start(options) 
+        }.to raise_error(StandardError, 'OOPS! Looks like you forgot to give me a Nexpose Site Name')
       end
 
       it 'should throw an error if no ip address is passed' do
-        expect { NexposeRunner::Scan.start(@expected_connection, @expected_username, @expected_password, @expected_port, @expected_site_name, '', @expected_scan_template) }.to raise_error(StandardError, 'OOPS! Looks like you forgot to give me an IP Address to scan')
+        options = @options.clone
+        options['ip_addresses'] = '';
+        expect { 
+          NexposeRunner::Scan.start(options) 
+        }.to raise_error(StandardError, 'OOPS! Looks like you forgot to give me an IP Address to scan')
       end
 
       it 'should throw an error if no scan template is passed' do
-        expect { NexposeRunner::Scan.start(@expected_connection, @expected_username, @expected_password, @expected_port, @expected_site_name, @expected_ips, '') }.to raise_error(StandardError, 'OOPS! Looks like you forgot to give me a Scan Template to use')
-        expect { NexposeRunner::Scan.start(@expected_connection, @expected_username, @expected_password, @expected_port, @expected_site_name, @expected_ips, nil) }.to raise_error(StandardError, 'OOPS! Looks like you forgot to give me a Scan Template to use')
+        options = @options.clone
+        options['scan_template'] = nil
+        expect { 
+          NexposeRunner::Scan.start(options) 
+        }.to raise_error(StandardError, 'OOPS! Looks like you forgot to give me a Scan Template to use')
       end
 
       it 'should use 3780 as default if port is empty string' do
         expect(Nexpose::Connection).to receive(:new)
-                                       .with(@expected_connection, @expected_username, @expected_password, '3780')
+                                       .with(@options['connection_url'], 
+                                             @options['username'], 
+                                             @options['password'], 
+                                             '3780')
                                        .and_return(@mock_nexpose_client)
 
-        NexposeRunner::Scan.start(@expected_connection, @expected_username, @expected_password, '', @expected_site_name, @expected_ips, @expected_scan_template)
+
+        run_options = @options.clone
+        run_options['port'] = ''
+        NexposeRunner::Scan.start(run_options)
       end
 
       it 'should create a new Nexpose site with the supplied site name and scan template' do
         expect(Nexpose::Site).to receive(:new)
-                                       .with(@expected_site_name, @expected_scan_template)
+                                       .with(@options['site_name'], @options['scan_template'])
                                        .and_return(@mock_nexpose_site)
 
-        NexposeRunner::Scan.start(@expected_connection, @expected_username, @expected_password, @expected_port, @expected_site_name, @expected_ips, @expected_scan_template)
+        NexposeRunner::Scan.start(@options)
       end
 
       it 'should add the supplied ip address to the newly created site' do
         @expected_ips.split(',').each { |ip|
           expect(@mock_nexpose_site).to receive(:add_ip).with(ip)
         }
-        NexposeRunner::Scan.start(@expected_connection, @expected_username, @expected_password, @expected_port, @expected_site_name, @expected_ips, @expected_scan_template)
+        NexposeRunner::Scan.start(@options)
       end
 
       it 'should save the new site configuration' do
         expect(@mock_nexpose_site).to receive(:save)
                                       .with(@mock_nexpose_client)
 
-        NexposeRunner::Scan.start(@expected_connection, @expected_username, @expected_password, @expected_port, @expected_site_name, @expected_ips, @expected_scan_template)
+        NexposeRunner::Scan.start(@options)
       end
 
       it 'should initiate a scan' do
@@ -119,14 +158,14 @@ describe 'nexpose-runner' do
                                       .with(@mock_nexpose_client)
                                       .and_return(@mock_scan)
 
-        NexposeRunner::Scan.start(@expected_connection, @expected_username, @expected_password, @expected_port, @expected_site_name, @expected_ips, @expected_scan_template)
+        NexposeRunner::Scan.start(@options)
       end
 
       describe 'wait for the Nexpose Scan to complete' do
         it 'should call to check the status of the scan' do
           expect(@mock_nexpose_client).to receive(:scan_status).with(@mock_scan_id)
   
-          NexposeRunner::Scan.start(@expected_connection, @expected_username, @expected_password, @expected_port, @expected_site_name, @expected_ips, @expected_scan_template)
+          NexposeRunner::Scan.start(@options)
         end
   
         it 'should call to check the status until it is not running' do
@@ -142,7 +181,7 @@ describe 'nexpose-runner' do
                                       .once
                                       .ordered
   
-          NexposeRunner::Scan.start(@expected_connection, @expected_username, @expected_password, @expected_port, @expected_site_name, @expected_ips, @expected_scan_template)
+          NexposeRunner::Scan.start(@options)
         end
   
         it 'should sleep for 3 seconds if the status is still running' do
@@ -160,7 +199,7 @@ describe 'nexpose-runner' do
 
           expect(NexposeRunner::Scan).to receive(:sleep).with(3).exactly(4).times
   
-          NexposeRunner::Scan.start(@expected_connection, @expected_username, @expected_password, @expected_port, @expected_site_name, @expected_ips, @expected_scan_template)
+          NexposeRunner::Scan.start(@options)
         end
       end
 
@@ -174,14 +213,18 @@ describe 'nexpose-runner' do
           expect_report_to_be_called_with(CONSTANTS::SOFTWARE_REPORT_NAME, CONSTANTS::SOFTWARE_REPORT_QUERY, @mock_software_report)
           expect_report_to_be_called_with(CONSTANTS::POLICY_REPORT_NAME, CONSTANTS::POLICY_REPORT_QUERY, @mock_policy_report)
 
-          expect { NexposeRunner::Scan.start(@expected_connection, @expected_username, @expected_password, @expected_port, @expected_site_name, @expected_ips, @expected_scan_template) }.to raise_error(StandardError, CONSTANTS::VULNERABILITY_FOUND_MESSAGE)
+          expect { 
+            NexposeRunner::Scan.start(@options) 
+          }.to raise_error(StandardError, CONSTANTS::VULNERABILITY_FOUND_MESSAGE)
       end
     end
 
       it 'should throw exception if vulnerability exists' do
       expect_report_to_be_called_with(CONSTANTS::VULNERABILITY_REPORT_NAME, CONSTANTS::VULNERABILITY_REPORT_QUERY, @mock_vuln_report)
 
-      expect { NexposeRunner::Scan.start(@expected_connection, @expected_username, @expected_password, @expected_port, @expected_site_name, @expected_ips, @expected_scan_template) }.to raise_error(StandardError, CONSTANTS::VULNERABILITY_FOUND_MESSAGE)
+      expect { 
+        NexposeRunner::Scan.start(@options) 
+      }.to raise_error(StandardError, CONSTANTS::VULNERABILITY_FOUND_MESSAGE)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: NexposeRunner
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Nathan Gibson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-26 00:00:00.000000000 Z
+date: 2015-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nexpose