arachni 0.4.2 → 0.4.3

data/spec/arachni/rpc/server/framework_simple_spec.rb

@@ -1,32 +1,16 @@
-require_relative '../../../spec_helper'
-
+require 'spec_helper'
 require 'json'
 
-require Arachni::Options.instance.dir['lib'] + 'rpc/client/instance'
-require Arachni::Options.instance.dir['lib'] + 'rpc/server/instance'
-
 describe Arachni::RPC::Server::Framework do
     before( :all ) do
         @opts = Arachni::Options.instance
-        @token = 'secret!'
-
-        @get_instance = proc do |opts|
-            opts ||= @opts
-            port = random_port
-            opts.rpc_port = port
-            fork_em { Arachni::RPC::Server::Instance.new( opts, @token ) }
-            sleep 1
-            Arachni::RPC::Client::Instance.new( opts,
-                "#{opts.rpc_address}:#{port}", @token
-            )
-        end
 
-        @instance = @get_instance.call
+        @instance  = instance_spawn
         @framework = @instance.framework
-        @modules = @instance.modules
-        @plugins = @instance.plugins
+        @modules   = @instance.modules
+        @plugins   = @instance.plugins
 
-        @instance_clean = @get_instance.call
+        @instance_clean  = instance_spawn
         @framework_clean = @instance_clean.framework
     end
 
@@ -56,7 +40,7 @@ describe Arachni::RPC::Server::Framework do
         end
         context 'when the scan is running' do
             it 'returns true' do
-                @instance.opts.url = server_url_for( :auditor ) + '/sleep'
+                @instance.opts.url = web_server_url_for( :auditor ) + '/sleep'
                 @modules.load( 'test' )
                 @framework.run.should be_true
                 @framework.busy?.should be_true
@@ -73,14 +57,9 @@ describe Arachni::RPC::Server::Framework do
             @framework_clean.revision.should == Arachni::Framework::REVISION
         end
     end
-    describe '#high_performance?' do
-        it 'returns false' do
-            @framework_clean.high_performance?.should be_false
-        end
-    end
     describe '#master?' do
         it 'returns false' do
-            @framework_clean.high_performance?.should be_false
+            @framework_clean.master?.should be_false
         end
     end
     describe '#slave?' do
@@ -131,23 +110,23 @@ describe Arachni::RPC::Server::Framework do
 
     describe '#list_modules' do
         it 'lists all available modules' do
-            @framework_clean.lsmod.should be_any
+            @framework_clean.list_modules.should be_any
         end
         it 'aliased to #lsmod' do
             @framework_clean.list_modules.should == @framework_clean.lsmod
         end
     end
-    describe '#output' do
-        it 'returns the instance\'s output messages' do
-            output = @framework_clean.output.first
-            output.keys.first.is_a?( Symbol ).should be_true
-            output.values.first.is_a?( String ).should be_true
+
+    describe '#list_platforms' do
+        it 'lists all available platforms' do
+            @framework_clean.list_platforms.should == Arachni::Framework.new.list_platforms
         end
     end
+
     describe '#run' do
         it 'performs a scan' do
             instance = @instance_clean
-            instance.opts.url = server_url_for( :framework_simple )
+            instance.opts.url = web_server_url_for( :framework_simple )
             instance.modules.load( 'test' )
             instance.framework.run.should be_true
             sleep( 1 ) while instance.framework.busy?
@@ -168,7 +147,7 @@ describe Arachni::RPC::Server::Framework do
     describe '#stats' do
         it 'returns a hash containing general runtime statistics' do
             instance = @instance_clean
-            instance.opts.url = server_url_for( :framework_simple )
+            instance.opts.url = web_server_url_for( :framework_simple )
             instance.modules.load( 'test' )
             instance.framework.run.should be_true
 
@@ -209,8 +188,8 @@ describe Arachni::RPC::Server::Framework do
     end
     describe '#status' do
         before( :all ) do
-            @inst = @get_instance.call
-            @inst.opts.url = server_url_for( :framework_simple ) + '/crawl'
+            @inst = instance_spawn
+            @inst.opts.url = web_server_url_for( :framework_simple ) + '/crawl'
             @inst.modules.load( 'test' )
         end
         context 'after initialization' do
@@ -237,10 +216,10 @@ describe Arachni::RPC::Server::Framework do
         context 'during audit' do
             it 'returns "audit"' do
                 mod_lib = @opts.dir['modules'].dup
-                @opts.dir['modules'] = spec_path + '/fixtures/wait_module/'
+                @opts.dir['modules'] = fixtures_path + '/wait_module/'
 
-                inst = @get_instance.call
-                inst.opts.url = server_url_for( :framework_simple )
+                inst = instance_spawn
+                inst.opts.url = web_server_url_for( :framework_simple )
                 inst.opts.audit_headers = true
                 inst.modules.load( 'wait' )
                 inst.framework.run
@@ -252,8 +231,8 @@ describe Arachni::RPC::Server::Framework do
         end
         context 'once the scan had completed' do
             it 'returns "done"' do
-                inst = @get_instance.call
-                inst.opts.url = server_url_for( :framework_simple )
+                inst = instance_spawn
+                inst.opts.url = web_server_url_for( :framework_simple )
                 inst.modules.load( 'test' )
                 inst.framework.run
                 sleep 2
@@ -263,8 +242,8 @@ describe Arachni::RPC::Server::Framework do
     end
     describe '#clean_up' do
         it 'sets the framework state to finished and wait for plugins to finish' do
-            instance = @get_instance.call
-            instance.opts.url = server_url_for( :framework_hpg )
+            instance = instance_spawn
+            instance.opts.url = web_server_url_for( :framework_hpg )
             instance.modules.load( 'test' )
             instance.plugins.load( { 'wait' => {} } )
             instance.framework.run.should be_true
@@ -398,7 +377,7 @@ describe Arachni::RPC::Server::Framework do
 
     describe '#token' do
         it 'returns the RPC token' do
-            @instance_clean.framework.token.should == @token
+            @instance_clean.framework.token.should == instance_token_for( @instance_clean )
         end
     end
 
@@ -408,29 +387,17 @@ describe Arachni::RPC::Server::Framework do
                 json = @instance_clean.framework.report_as( :json )
                 JSON.load( json )['issues'].size.should == @instance_clean.framework.auditstore.issues.size
             end
-        end
 
-        context 'when passed an valid report name which does not support the \'outfile\' option' do
-            it 'raises an exception' do
-                raised = false
-                begin
-                    @instance_clean.framework.report_as( :stdout )
-                rescue Exception
-                    raised = true
+            context 'which does not support the \'outfile\' option' do
+                it 'raises an exception' do
+                    expect { @instance_clean.framework.report_as( :stdout ) }.to raise_error
                 end
-                raised.should be_true
             end
         end
 
         context 'when passed an invalid report name' do
             it 'raises an exception' do
-                raised = false
-                begin
-                    @instance_clean.framework.report_as( :blah )
-                rescue Exception
-                    raised = true
-                end
-                raised.should be_true
+                expect { @instance_clean.framework.report_as( :blah ) }.to raise_error
             end
         end
     end
@@ -471,10 +438,10 @@ describe Arachni::RPC::Server::Framework do
     describe '#restrict_to_elements' do
         it 'restricts the audit to the provided element signatures' do
             mod_lib = @opts.dir['modules'].dup
-            @opts.dir['modules'] = spec_path + '/fixtures/taint_module/'
+            @opts.dir['modules'] = fixtures_path + '/taint_module/'
 
-            inst = @get_instance.call( @opts)
-            inst.opts.url = server_url_for( :framework_simple ) + '/restrict_to_elements'
+            inst = instance_spawn
+            inst.opts.url = web_server_url_for( :framework_simple ) + '/restrict_to_elements'
             inst.opts.audit_links = true
             inst.modules.load( 'taint' )
 
@@ -494,8 +461,8 @@ describe Arachni::RPC::Server::Framework do
     end
     describe '#update_page_queue' do
         it 'pushs the provided page objects to the page audit queue' do
-            url = server_url_for( :framework_simple )
-            inst = @get_instance.call
+            url = web_server_url_for( :framework_simple )
+            inst = instance_spawn
             inst.opts.url = url
             inst.opts.audit_links = true
             inst.modules.load( 'taint' )
@@ -513,14 +480,14 @@ describe Arachni::RPC::Server::Framework do
             inst.framework.issues.size.should == 2
         end
     end
-    describe '#register_issues' do
+    describe '#update_issues' do
         it 'registers an issue with the instance' do
-            url = server_url_for( :framework_simple )
-            inst = @get_instance.call
+            url = web_server_url_for( :framework_simple )
+            inst = instance_spawn
             inst.opts.url = url
 
             issue = Arachni::Issue.new( name: 'stuff', url: url, elem: 'link' )
-            inst.framework.register_issues( [issue] ).should be_true
+            inst.framework.update_issues( [issue] ).should be_true
 
             issues = inst.framework.issues
             issues.size.should == 1

data/spec/arachni/rpc/server/instance_spec.rb

@@ -1,63 +1,17 @@
-require_relative '../../../spec_helper'
+require 'spec_helper'
 
-require Arachni::Options.instance.dir['lib'] + 'rpc/server/dispatcher'
-require Arachni::Options.instance.dir['lib'] + 'rpc/client/instance'
-require Arachni::Options.instance.dir['lib'] + 'rpc/server/instance'
-
-describe Arachni::RPC::Server::Instance do
+describe 'Arachni::RPC::Server::Instance' do
     before( :all ) do
-        @opts = Arachni::Options.instance
-        @token = 'secret!'
-
-        @instances = []
-
-        @get_instance = proc do |opts|
-            opts ||= @opts
-
-            port = random_port
-            opts.rpc_port = port
-
-            fork_em { Arachni::RPC::Server::Instance.new( opts, @token ) }
-            sleep 1
-
-            @instances << Arachni::RPC::Client::Instance.new( opts,
-                "#{opts.rpc_address}:#{port}", @token
-            )
-
-            @instances.last
-        end
-
-        @utils = Arachni::Module::Utilities
-        @instance = @get_instance.call
-
-        @dispatchers = []
-
-        @opts.pool_size = 1
-        @get_grid_instance = proc do |opts|
-            opts ||= @opts
-            port = random_port
-            opts.rpc_port = port
-            exec_dispatcher( opts )
-
-            port2 =  random_port
-            opts.rpc_port = port2
-            opts.neighbour = "#{opts.rpc_address}:#{port}"
-            opts.pipe_id = 'blah'
-            exec_dispatcher( opts )
-
-            dispatcher = Arachni::RPC::Client::Dispatcher.new( opts,
-                                                               "#{opts.rpc_address}:#{port}" )
-            @dispatchers << dispatcher
-
-            inst_info = dispatcher.dispatch
-            @instances << Arachni::RPC::Client::Instance.new( opts,inst_info['url'], inst_info['token'] )
-            @instances.last
-        end
+        @opts     = Arachni::Options.instance
+        @utils    = Arachni::Module::Utilities
+        @instance = instance_spawn
     end
 
-    after( :all ) do
-        @instances.each { |i| i.service.shutdown rescue nil }
-        @dispatchers.each { |d| d.stats['consumed_pids'].each { |p| pids << p } }
+    it 'supports UNIX sockets' do
+        socket = '/tmp/arachni-instance'
+        instance = instance_spawn( socket: socket )
+        instance.framework.multi_self_url.should == socket
+        instance.service.alive?.should be_true
     end
 
     describe '#service' do
@@ -113,7 +67,7 @@ describe Arachni::RPC::Server::Instance do
             end
         end
 
-        [:list_modules, :list_plugins, :list_reports, :busy?, :report].each do |m|
+        [:list_platforms, :list_modules, :list_plugins, :list_reports, :busy?, :report].each do |m|
             describe "##{m}" do
                 it "delegates to Framework##{m}" do
                     @instance.service.send(m).should == @instance.framework.send(m)
@@ -161,19 +115,22 @@ describe Arachni::RPC::Server::Instance do
 
         describe '#scan' do
             it 'configures and starts a scan' do
-                instance = @get_instance.call
+                instance = instance_spawn
 
-                slave = @get_instance.call
+                slave = instance_spawn
 
                 instance.service.busy?.should  == instance.framework.busy?
                 instance.service.status.should == instance.framework.status
 
                 instance.service.scan(
-                    url:         server_url_for( :framework_simple ),
+                    url:         web_server_url_for( :framework_simple ),
                     audit_links: true,
                     audit_forms: true,
                     modules:     :test,
-                    slaves:      [ { url: slave.url, token: @token } ]
+                    slaves:      [{
+                        url: slave.url,
+                        token: instance_token_for( slave )
+                    }]
                 )
 
                 # if a scan in already running it should just bail out early
@@ -193,20 +150,34 @@ describe Arachni::RPC::Server::Instance do
                 i_report['issues'].should be_any
             end
 
+            context 'with invalid :platforms' do
+                it 'raises ArgumentError' do
+                    expect {
+                        instance_spawn.service.scan(
+                            url:         web_server_url_for( :framework_simple ),
+                            platforms:   [ :stuff ]
+                        )
+                    }.to raise_error
+                end
+            end
+
             context 'when the options Hash uses Strings instead of Symbols' do
                 it 'makes no difference' do
-                    instance = @get_instance.call
-                    slave    = @get_instance.call
+                    instance = instance_spawn
+                    slave    = instance_spawn
 
                     instance.service.busy?.should  == instance.framework.busy?
                     instance.service.status.should == instance.framework.status
 
                     instance.service.scan(
-                        'url'         => server_url_for( :framework_simple ),
+                        'url'         => web_server_url_for( :framework_simple ),
                         'audit_links '=> true,
                         'audit_forms' => true,
                         'modules'     => 'test',
-                        'slaves'      => [ { 'url' => slave.url, 'token' => @token } ]
+                        slaves:      [{
+                            url: slave.url,
+                            token: instance_token_for( slave )
+                        }]
                     )
 
                     # if a scan in already running it should just bail out early
@@ -230,74 +201,133 @@ describe Arachni::RPC::Server::Instance do
 
             describe :spawns do
                 context 'when it has a Dispatcher' do
-                    it 'requests its slaves from it' do
-                        instance = @get_grid_instance.call
+                    context 'which is a Grid member' do
+                        context 'with grid_mode set to' do
+                            context :aggregate do
+                                it 'requests slaves from grid members with unique Pipe-IDs' do
+                                    instance = instance_grid_spawn
 
-                        instance.service.scan(
-                            url:         server_url_for( :framework_simple ),
-                            audit_links: true,
-                            audit_forms: true,
-                            modules:     :test,
-                            spawns:      4
-                        )
+                                    instance.service.scan(
+                                        url:         web_server_url_for( :framework_simple ),
+                                        audit_links: true,
+                                        audit_forms: true,
+                                        modules:     :test,
+                                        spawns:      4,
+                                        grid_mode:   :aggregate
+                                    )
 
-                        # if a scan in already running it should just bail out early
-                        instance.service.scan.should be_false
+                                    # if a scan in already running it should just bail out early
+                                    instance.service.scan.should be_false
 
-                        sleep 1 while instance.service.busy?
+                                    sleep 1 while instance.service.busy?
 
-                        instance.framework.progress_data['instances'].size.should == 5
+                                    # Since we've only got 3 Dispatchers in the Grid.
+                                    instance.framework.progress_data['instances'].size.should == 3
 
-                        instance.service.busy?.should  == instance.framework.busy?
-                        instance.service.status.should == instance.framework.status
+                                    instance.service.busy?.should  == instance.framework.busy?
+                                    instance.service.status.should == instance.framework.status
 
-                        i_report = instance.service.report
-                        f_report = instance.framework.report
+                                    i_report = instance.service.report
+                                    f_report = instance.framework.report
 
-                        i_report.should == f_report
-                        i_report['issues'].should be_any
-                    end
+                                    i_report.should == f_report
+                                    i_report['issues'].should be_any
+                                end
+                            end
+                            context :balance do
+                                it 'requests its slaves from it' do
+                                    instance = instance_grid_spawn
 
-                    context 'which is a Grid member' do
-                        it 'requests its slaves from it' do
-                            instance = @get_grid_instance.call
+                                    instance.service.scan(
+                                        url:         web_server_url_for( :framework_simple ),
+                                        audit_links: true,
+                                        audit_forms: true,
+                                        modules:     :test,
+                                        spawns:      4,
+                                        grid_mode:   :balance
+                                    )
 
-                            instance.service.scan(
-                                url:         server_url_for( :framework_simple ),
-                                audit_links: true,
-                                audit_forms: true,
-                                modules:     :test,
-                                spawns:      4,
-                                grid:        true
-                            )
+                                    # if a scan in already running it should just bail out early
+                                    instance.service.scan.should be_false
 
-                            # if a scan in already running it should just bail out early
-                            instance.service.scan.should be_false
+                                    sleep 1 while instance.service.busy?
 
-                            sleep 1 while instance.service.busy?
+                                    # No matter how many grid members with unique Pipe-IDs there are
+                                    # since we're in balance mode.
+                                    instance.framework.progress_data['instances'].size.should == 5
 
-                            # Since we've only got 2 Dispatchers in the Grid.
-                            instance.framework.progress_data['instances'].size.should == 2
+                                    instance.service.busy?.should  == instance.framework.busy?
+                                    instance.service.status.should == instance.framework.status
 
-                            instance.service.busy?.should  == instance.framework.busy?
-                            instance.service.status.should == instance.framework.status
+                                    i_report = instance.service.report
+                                    f_report = instance.framework.report
+
+                                    i_report.should == f_report
+                                    i_report['issues'].should be_any
+                                end
+                            end
 
-                            i_report = instance.service.report
-                            f_report = instance.framework.report
+                            context 'unknown option' do
+                                it 'raises an exception' do
+                                    expect {
+                                        instance_grid_spawn.service.scan(
+                                            url:         web_server_url_for( :framework_simple ),
+                                            audit_links: true,
+                                            audit_forms: true,
+                                            modules:     :test,
+                                            spawns:      4,
+                                            grid_mode:   :blahblah
+                                        )
+                                    }.to raise_error
+                                end
+                            end
 
-                            i_report.should == f_report
-                            i_report['issues'].should be_any
+                        end
+
+                        context 'with :grid set to' do
+                            context true do
+                                it 'it a shorthand for grid_mode: :balance' do
+                                    instance = instance_grid_spawn
+
+                                    instance.service.scan(
+                                        url:         web_server_url_for( :framework_simple ),
+                                        audit_links: true,
+                                        audit_forms: true,
+                                        modules:     :test,
+                                        spawns:      4,
+                                        grid:        true
+                                    )
+
+                                    # if a scan in already running it should just bail out early
+                                    instance.service.scan.should be_false
+
+                                    sleep 1 while instance.service.busy?
+
+                                    # No matter how many grid members with unique Pipe-IDs there are
+                                    # since we're in balance mode.
+                                    instance.framework.progress_data['instances'].size.should == 5
+
+                                    instance.service.busy?.should  == instance.framework.busy?
+                                    instance.service.status.should == instance.framework.status
+
+                                    i_report = instance.service.report
+                                    f_report = instance.framework.report
+
+                                    i_report.should == f_report
+                                    i_report['issues'].should be_any
+                                end
+                            end
                         end
 
                         context 'when it is less than 1' do
                             it 'raises an exception' do
-                                instance = @get_grid_instance.call
+                                instance = instance_grid_spawn
 
                                 raised = false
                                 begin
                                     instance.service.scan(
-                                        url:  server_url_for( :framework_simple ),
-                                        grid: true
+                                        url:        web_server_url_for( :framework_simple ),
+                                        grid_mode:  :balance
                                     )
                                 rescue => e
                                     raised = e.rpc_exception?
@@ -309,14 +339,14 @@ describe Arachni::RPC::Server::Instance do
 
                         context 'when Options#restrict_to_paths is set' do
                             it 'raises an exception' do
-                                instance = @get_grid_instance.call
-                                url      = server_url_for( :framework_simple )
+                                instance = instance_grid_spawn
+                                url      = web_server_url_for( :framework_simple )
 
                                 raised = false
                                 begin
                                     instance.service.scan(
                                         url:            url,
-                                        grid:           true,
+                                        grid_mode:      :balance,
                                         spawns:         4,
                                         restrict_paths: [url]
                                     )
@@ -332,20 +362,37 @@ describe Arachni::RPC::Server::Instance do
                 end
 
                 context 'when it does not have a Dispatcher' do
+                    it 'uses UNIX sockets to communicate with the slaves' do
+                        instance = instance_spawn
+                        instance.service.scan(
+                            url:         web_server_url_for( :framework_simple ),
+                            audit_links: true,
+                            audit_forms: true,
+                            modules:     :test,
+                            spawns:      4
+                        )
+                        sleep 1 while instance.service.busy?
+
+                        self_url = instance.framework.self_url
+
+                        instance.service.progress( with: :instances )['instances'].each do |progress|
+                            url = progress['url']
+                            next if url == self_url
+                            File.socket?( url ).should be_true
+                        end
+                    end
+
                     it 'spawns a number of slaves' do
-                        instance = @get_instance.call
+                        instance = instance_spawn
 
                         instance.service.scan(
-                            url:         server_url_for( :framework_simple ),
+                            url:         web_server_url_for( :framework_simple ),
                             audit_links: true,
                             audit_forms: true,
                             modules:     :test,
                             spawns:      4
                         )
 
-                        # if a scan in already running it should just bail out early
-                        instance.service.scan.should be_false
-
                         sleep 1 while instance.service.busy?
 
                         instance.framework.progress_data['instances'].size.should == 5
@@ -363,13 +410,13 @@ describe Arachni::RPC::Server::Instance do
 
                 context 'when link_count_limit has been set' do
                     it 'should be divided by the amount of spawns' do
-                        instance = @get_instance.call
+                        instance = instance_spawn
 
                         link_count_limit = 100
                         spawns           = 4
 
                         instance.service.scan(
-                            url:         server_url_for( :framework_simple ),
+                            url:         web_server_url_for( :framework_simple ),
                             audit_links: true,
                             audit_forms: true,
                             modules:     :test,
@@ -382,13 +429,13 @@ describe Arachni::RPC::Server::Instance do
                 end
                 context 'when http_req_limit has been set' do
                     it 'should be divided by the amount of spawns' do
-                        instance = @get_instance.call
+                        instance = instance_spawn
 
                         http_req_limit = 100
                         spawns         = 4
 
                         instance.service.scan(
-                            url:         server_url_for( :framework_simple ),
+                            url:         web_server_url_for( :framework_simple ),
                             audit_links: true,
                             audit_forms: true,
                             modules:     :test,
@@ -404,9 +451,9 @@ describe Arachni::RPC::Server::Instance do
 
         describe '#progress' do
             before( :all ) do
-                @progress_instance = @get_instance.call
+                @progress_instance = instance_spawn
                 @progress_instance.service.scan(
-                    url:         server_url_for( :framework_simple ),
+                    url:         web_server_url_for( :framework_simple ),
                     audit_links: true,
                     audit_forms: true,
                     modules:     :test,
@@ -499,9 +546,16 @@ describe Arachni::RPC::Server::Instance do
                 describe :instances do
                     it 'includes instances' do
                         instance = @progress_instance
-                        p = instance.service.progress( with: :instances )
-                        p['instances'].size.should == 2
-                        p['instances'].should == instance.framework.progress_data['instances']
+
+                        stats1 = instance.service.progress( with: :instances )['instances']
+                        stats2 = instance.framework.progress_data['instances']
+
+                        # Average req/s may differ.
+                        stats1.each { |h| h.delete 'avg' }
+                        stats2.each { |h| h.delete 'avg' }
+
+                        stats1.size.should == 2
+                        stats1.should == stats2
                     end
                 end
 
@@ -523,17 +577,11 @@ describe Arachni::RPC::Server::Instance do
 
         describe '#shutdown' do
             it 'shuts-down the instance' do
-                instance = @get_instance.call
+                instance = instance_spawn
                 instance.service.shutdown.should be_true
                 sleep 4
-                raised = false
-                begin
-                    instance.service.alive?
-                rescue Exception
-                    raised = true
-                end
 
-                raised.should be_true
+                expect { instance.service.alive? }.to raise_error
             end
         end
     end