cuboid 0.0.0 → 0.0.3

data/lib/cuboid/rpc/server/output.rb

@@ -0,0 +1,92 @@
+module Cuboid
+module UI
+
+# RPC Output interface.
+#
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+module Output
+    include OutputInterface
+
+    def self.initialize
+        @@reroute_to_file = false
+        @@error_buffer    = []
+    end
+    initialize
+
+    # @param    [String]    str
+    def log_error( str = '' )
+        super( str )
+        @@error_buffer << str
+    end
+
+    def error_buffer
+        @@error_buffer
+    end
+
+    def print_error( str = '' )
+        log_error( str )
+        push_to_output_buffer( error: str )
+    end
+
+    def print_bad( str = '' )
+        push_to_output_buffer( bad: str )
+    end
+
+    def print_status( str = '' )
+        push_to_output_buffer( status: str )
+    end
+
+    def print_info( str = '' )
+        push_to_output_buffer( info: str )
+    end
+
+    def print_ok( str = '' )
+        push_to_output_buffer( ok: str )
+    end
+
+    def print_debug( str = '', level = 1 )
+        return if !debug?( level )
+        push_to_output_buffer( debug: str )
+    end
+
+    def print_verbose( str = '' )
+        push_to_output_buffer( verbose: str )
+    end
+
+    def print_line( str = '' )
+        push_to_output_buffer( line: str )
+    end
+
+    def reroute_to_file( file )
+        @@reroute_to_file = file
+    end
+
+    def reroute_to_file?
+        @@reroute_to_file
+    end
+
+    def output_provider_file
+        __FILE__
+    end
+
+    private
+
+    def push_to_output_buffer( msg )
+        return if !@@reroute_to_file
+
+        # This is stupid, keep a handle open and close it on exit like with the
+        # error log file.
+        File.open( @@reroute_to_file, 'a+' ) do |f|
+            type = msg.keys[0]
+            str  = msg.values[0]
+
+            f.write( "[#{Time.now.asctime}] [#{type}]  #{str}\n" )
+        end
+    end
+
+    extend self
+
+end
+
+end
+end

data/lib/cuboid/rpc/server/scheduler.rb

@@ -0,0 +1,482 @@
+module Cuboid
+
+lib = Options.paths.lib
+
+require lib + 'processes/manager'
+require lib + 'processes/instances'
+
+require lib + 'rpc/client/instance'
+require lib + 'rpc/client/dispatcher'
+
+require lib + 'rpc/server/base'
+require lib + 'rpc/server/output'
+
+module RPC
+class Server
+
+# RPC scheduler service which:
+#
+# * Maintains a priority queue of Instance jobs.
+# * {#push Accepts jobs.}
+# * Runs them once a slot is available -- determined by
+#   {System#utilization system utilization}.
+# * Monitors {#running} Instances, retrieves and
+#   {OptionGroups::Paths#reports stores} their {Report reports} and shuts down
+#   their {Instance} to free its slot.
+# * Makes available information on {#completed} and {#failed} Instances.
+#
+# In addition to the purely queue functionality, it also allows for running
+# Instances to be:
+#
+# * {#detach Detached} from the queue monitor and transfer the management
+#   responsibility to the client.
+# * {#attach Attached} to the queue monitor and transfer the management
+#   responsibility to the queue.
+#
+# If a {Dispatcher} has been provided, {Instance instances} will be
+# {Dispatcher#dispatch provided} by it.
+# If no {Dispatcher} has been given, {Instance instances} will be spawned on the
+# Scheduler machine.
+#
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+class Scheduler
+    include UI::Output
+    include Utilities
+
+    TICK_CONSUME = 0.1
+
+    def initialize
+        @options = Options.instance
+
+        @options.snapshot.path ||= @options.paths.snapshots
+        @options.report.path   ||= @options.paths.reports
+
+        @server = Base.new( @options.rpc.to_server_options )
+        @server.logger.level = @options.datastore.log_level if @options.datastore.log_level
+
+        Options.scheduler.url = @url = @server.url
+
+        prep_logging
+
+        @queue          = {}
+        @id_to_priority = {}
+        @by_priority    = {}
+
+        @running   = {}
+        @completed = {}
+        @failed    = {}
+
+        set_handlers( @server )
+        trap_interrupts { Thread.new { shutdown } }
+
+        monitor_instances
+        consume_queue
+
+        run
+    end
+
+    # @return   [Bool]
+    def empty?
+        self.size == 0
+    end
+
+    # @return   [Bool]
+    def any?
+        !empty?
+    end
+
+    # @return   [Integer]
+    def size
+        @queue.size
+    end
+
+    # @return   [Hash<Integer,Array>]
+    #   Queued Instances grouped and sorted by priority.
+    def list
+        @by_priority
+    end
+
+    # @return   [Hash]
+    #   {RPC::Client::Instance RPC connection information} on running Instances.
+    def running
+        @running.inject( {} ) do |h, (id, client)|
+            h.merge! id => { url: client.url, token: client.token, pid: client.pid }
+            h
+        end
+    end
+
+    # @return   [Hash]
+    #   Completed Instances and their report location.
+    def completed
+        @completed
+    end
+
+    # @return   [Hash]
+    #   Failed Instances and the associated error.
+    def failed
+        @failed
+    end
+
+    # @note Only returns info for queued Instances, once a Instance has passed through
+    #   the {#running} stage it's no longer part of the queue.
+    #
+    # @param    [String]    id
+    #   ID for a queued Instance.
+    #
+    # @return   [Hash, nil]
+    #   * Instance options and priority.
+    #   * `nil` if a Instance with the given ID could not be found.
+    def get( id )
+        return if !@queue.include? id
+
+        {
+            options:  @queue[id],
+            priority: @id_to_priority[id]
+        }
+    end
+
+    # @param    [Hash]  options
+    #   {Instance#run Instance options} with an extra `priority` option which
+    #   defaults to `0` (higher is more urgent).
+    #
+    # @return   [String]
+    #   Instance ID used to reference the Instance from then on.
+    def push( options, queue_options = {} )
+        priority = queue_options.delete('priority') || 0
+
+        if !Cuboid::Application.application.valid_options?( options )
+            fail ArgumentError, 'Invalid options!'
+        end
+
+        id = Utilities.generate_token
+
+        @queue[id]          = options
+        @id_to_priority[id] = priority
+
+        (@by_priority[priority] ||= []) << id
+        @by_priority = Hash[@by_priority.sort_by { |k, _| -k }]
+
+        id
+    end
+
+    # @note Only affects queued Instances, once a Instance has passed through
+    #   the {#running} stage it's no longer part of the queue.
+    #
+    # @param    [String]    id
+    #   Instance ID to remove from the queue.
+    def remove( id )
+        return false if !@queue.include? id
+
+        @queue.delete( id )
+        @by_priority[@id_to_priority.delete( id )].delete( id )
+
+        true
+    end
+
+    # @param    [String]    id
+    #   Running Instance to detach from the queue monitor.
+    #
+    #   Once a Instance is detached it becomes someone else's responsibility to
+    #   monitor, manage and shutdown to free its slot.
+    #
+    # @return   [Hash, nil]
+    #   * {RPC::Client::Instance RPC connection information} for the Instance.
+    #   * `nil` if no running Instance with that ID is found.
+    def detach( id, &block )
+        client = @running.delete( id )
+        return block.call if !client
+
+        client.options.set( scheduler: { url: nil } ) do
+            block.call( url: client.url, token: client.token, pid: client.pid )
+        end
+    end
+
+    # Attaches a running Instance to the queue monitor.
+    #
+    # @param    [String]    url
+    #   Instance URL for a running Instance.
+    # @param    [String]    token
+    #   Authentication token for the Instance.
+    #
+    # @return   [String, false, nil]
+    #   * Instance ID for further queue reference.
+    #   * `false` if the Instance is already attached to a Scheduler.
+    #   * `nil` if the Instance could not be reached.
+    def attach( url, token, &block )
+        client = connect_to_instance( url, token )
+        client.alive? do |bool|
+            if bool.rpc_exception?
+                block.call
+                next
+            end
+
+            client.scheduler_url do |scheduler_url|
+                if scheduler_url
+                    block.call false
+                    next
+                end
+
+                client.options.set( scheduler: { url: @options.scheduler.url } ) do
+                    @running[token] = client
+                    block.call token
+                end
+            end
+        end
+    end
+
+    # @note Only affects queued Instances, once a Instance has passed through the
+    #   {#running} stage it's no longer part of the queue.
+    #
+    # Empties the queue.
+    def clear
+        @queue.clear
+        @by_priority.clear
+        @id_to_priority.clear
+
+        nil
+    end
+
+    # Shuts down the service.
+    def shutdown
+        print_status 'Shutting down...'
+        reactor.delay 2 do
+            reactor.stop
+        end
+    end
+
+    # @param    [Integer]   starting_line
+    #   Sets the starting line for the range of errors to return.
+    #
+    # @return   [Array<String>]
+    def errors( starting_line = 0 )
+        return [] if self.error_buffer.empty?
+
+        error_strings = self.error_buffer
+
+        if starting_line != 0
+            error_strings = error_strings[starting_line..-1]
+        end
+
+        error_strings
+    end
+
+    # @return   [TrueClass]
+    def alive?
+        @server.alive?
+    end
+
+    protected
+
+    def pop
+        return if @queue.empty?
+
+        top_priority, q = @by_priority.first
+
+        id = q.pop
+        r = [id, @queue.delete( id )]
+
+        @by_priority.delete( top_priority ) if q.empty?
+
+        r
+    end
+
+    private
+
+    def consume_queue
+        spawning = false
+        reactor.at_interval( TICK_CONSUME ) do
+            next if self.empty? || spawning
+
+            spawning = true
+            spawn_instance do |client|
+                if client == :error
+                    spawning = false
+                    next
+                end
+
+                if !client
+                    print_debug 'Could not get Instance, all systems are at max utilization.'
+                    spawning = false
+                    next
+                end
+
+                id, options = self.pop
+
+                print_status "[#{id}] Got Instance: #{client.url}/#{client.token}"
+
+                client.run( options ) do
+                    spawning = false
+
+                    print_status "[#{id}] Instance started."
+                    @running[id] = client
+                end
+            end
+        end
+    end
+
+    def monitor_instances
+        checking = false
+        reactor.at_interval( Options.scheduler.ping_interval ) do
+            next if checking
+            print_debug 'Checking running Instances.'
+            checking = true
+
+            each  = proc { |(id, c), i| check_instance( id, c ) { i.next } }
+            after = proc { checking = false }
+            reactor.create_iterator( @running ).each( each, after )
+        end
+    end
+
+    def check_instance( id, client, &block )
+        print_debug "[#{id}] Checking status."
+
+        client.busy? do |busy|
+            if busy.rpc_exception?
+                handle_rpc_error( id, busy )
+                block.call
+            elsif busy
+                print_debug "[#{id}] Busy."
+                block.call
+            else
+                get_report_and_shutdown( id, client, &block )
+            end
+        end
+    end
+
+    def handle_rpc_error( id, error )
+        print_error "[#{id}] Failed: [#{error.class}] #{error.to_s}"
+
+        @failed[id] = {
+            error:       error.class.to_s,
+            description: error.to_s
+        }
+        c = @running.delete( id )
+        c.close if c
+    end
+
+    def get_report_and_shutdown( id, client, &block )
+        print_status "[#{id}] Grabbing report."
+
+        client.generate_report do |report|
+            if report.rpc_exception?
+                handle_rpc_error( id, report )
+                block.call
+                next
+            end
+
+            path = report.save( "#{Options.report.path}/#{id}.#{Report::EXTENSION}" )
+
+            print_status "[#{id}] Report saved at: #{path}"
+
+            client.shutdown do
+                print_status "[#{id}] Completed."
+
+                @running.delete( id ).close
+                @completed[id] = path
+
+                block.call
+            end
+        end
+    end
+
+    # Starts the dispatcher's server
+    def run
+        reactor.on_error do |_, e|
+            print_error "Reactor: #{e}"
+
+            e.backtrace.each do |l|
+                print_error "Reactor: #{l}"
+            end
+        end
+
+        print_status 'Ready'
+        @server.start
+    rescue => e
+        print_exception e
+
+        $stderr.puts "Could not start server, for details see: #{@logfile}"
+        exit 1
+    end
+
+    def reactor
+        Arachni::Reactor.global
+    end
+
+    def trap_interrupts( &block )
+        %w(QUIT INT).each do |signal|
+            trap( signal, &block || Proc.new{ } ) if Signal.list.has_key?( signal )
+        end
+    end
+
+    def prep_logging
+        # reroute all output to a logfile
+        @logfile ||= reroute_to_file(
+            @options.paths.logs + "/Scheduler - #{Process.pid}-#{@options.rpc.server_port}.log"
+        )
+    end
+
+    def dispatcher
+        return if !Options.dispatcher.url
+        @dispatcher ||= RPC::Client::Dispatcher.new( Options.dispatcher.url )
+    end
+
+    def spawn_instance( &block )
+        if dispatcher
+            options = {
+              owner:   self.class.to_s,
+              helpers: {
+                    owner: {
+                        url: @url
+                    }
+                }
+            }
+
+            dispatcher.dispatch options do |info|
+                if info.rpc_exception?
+                    print_error "Failed to contact Dispatcher at: #{dispatcher.url}"
+                    print_error "[#{info.class}] #{info.to_s}"
+                    block.call :error
+                    next
+                end
+
+                if info
+                    client = connect_to_instance( info['url'], info['token'] )
+                    client.options.set( scheduler: { url: @options.scheduler.url } ) do
+                        block.call( client )
+                    end
+
+                else
+                    block.call
+                end
+            end
+        else
+            return block.call if System.max_utilization?
+
+            Processes::Instances.spawn(
+                application: Options.paths.application,
+                port_range:  Options.scheduler.instance_port_range,
+                &block
+            )
+        end
+    end
+
+    def connect_to_instance( url, token )
+        RPC::Client::Instance.new( url, token )
+    end
+
+    # @param    [Base]  server
+    #   Prepares all the RPC handlers for the given `server`.
+    def set_handlers( server )
+        server.add_async_check do |method|
+            # methods that expect a block are async
+            method.parameters.flatten.include? :block
+        end
+
+        server.add_handler( 'scheduler', self )
+    end
+
+end
+
+end
+end
+end

data/lib/cuboid/ruby/array.rb

@@ -0,0 +1,17 @@
+class Array
+
+    # @param    [#to_s, Array<#to_s>]  tags
+    #
+    # @return [Bool]
+    #   `true` if `self` contains any of the `tags` when objects of both `self`
+    #   and `tags` are converted to `String`.
+    def includes_tags?( tags )
+        return false if !tags
+
+        tags = [tags].flatten.compact.map( &:to_s )
+        return false if tags.empty?
+
+        (self.flatten.compact.map( &:to_s ) & tags).any?
+    end
+
+end

data/lib/cuboid/ruby/hash.rb

@@ -0,0 +1,41 @@
+class Hash
+
+    if !method_defined?( :to_h )
+        alias :to_h :to_hash
+    end
+
+    # Converts the hash keys to strings.
+    #
+    # @param    [Boolean]    recursively
+    #   Go through the Hash recursively?
+    #
+    # @return [Hash]
+    #   Hash with +self+'s keys recursively converted to strings.
+    def my_stringify_keys( recursively = true )
+        stringified = {}
+        each do |k, v|
+            stringified[k.to_s] = (recursively && v.is_a?( Hash ) ?
+                v.my_stringify_keys : v)
+        end
+        stringified
+    end
+
+    # Converts the hash keys to symbols.
+    #
+    # @param    [Boolean]    recursively
+    #   Go through the Hash recursively?
+    #
+    # @return [Hash]
+    #   Hash with +self+'s keys recursively converted to symbols.
+    def my_symbolize_keys( recursively = true )
+        symbolize = {}
+        each do |k, v|
+            k = k.respond_to?(:to_sym) ? k.to_sym : k
+
+            symbolize[k] = (recursively && v.is_a?( Hash ) ?
+                v.my_symbolize_keys : v)
+        end
+        symbolize
+    end
+
+end

data/lib/cuboid/ruby/object.rb

@@ -0,0 +1,32 @@
+# Overloads the {Object} class providing a {#deep_clone} method.
+#
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+class Object
+
+    # Deep-clones self using a Marshal dump-load.
+    #
+    # @return   [Object]
+    #   Duplicate of self.
+    def deep_clone
+        Marshal.load( Marshal.dump( self ) )
+    end
+
+    def rpc_clone
+        if self.class.respond_to?( :from_rpc_data )
+            self.class.from_rpc_data(
+                Cuboid::RPC::Serializer.serializer.load(
+                    Cuboid::RPC::Serializer.serializer.dump( to_rpc_data )
+                )
+            )
+        else
+            Cuboid::RPC::Serializer.serializer.load(
+                Cuboid::RPC::Serializer.serializer.dump( self )
+            )
+        end
+    end
+
+    def to_rpc_data_or_self
+        respond_to?( :to_rpc_data ) ? to_rpc_data : self
+    end
+
+end

data/lib/cuboid/ruby.rb

@@ -0,0 +1,4 @@
+lib = Cuboid::Options.paths.lib
+require lib + 'ruby/object'
+require lib + 'ruby/hash'
+require lib + 'ruby/array'