cuboid 0.0.0 → 0.0.3

data/lib/cuboid/data.rb

@@ -0,0 +1,86 @@
+module Cuboid
+
+# Stores and provides access to the data of the system.
+#
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+class Data
+
+    # {Data} error namespace.
+    #
+    # All {Data} errors inherit from and live under it.
+    #
+    # @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+    class Error < Cuboid::Error
+    end
+
+    require_relative 'data/application'
+
+class <<self
+
+    # @return     [Framework]
+    attr_accessor :application
+
+    def reset
+        @application = Application.new
+    end
+
+    def statistics
+        stats = {}
+        each do |attribute|
+            stats[attribute] = send(attribute).statistics
+        end
+        stats
+    end
+
+    # @param    [String]    directory
+    #   Location of the dump directory.
+    # @return   [String]
+    #   Location of the dump directory.
+    def dump( directory )
+        FileUtils.mkdir_p( directory )
+
+        each do |name, state|
+            state.dump( "#{directory}/#{name}/" )
+        end
+
+        directory
+    end
+
+    # @param    [String]    directory
+    #   Location of the dump directory.
+    # @return   [Data]     `self`
+    def load( directory )
+        each do |name, state|
+            send( "#{name}=", state.class.load( "#{directory}/#{name}/" ) )
+        end
+
+        self
+    end
+
+    # Clears all data.
+    def clear
+        each { |_, state| state.clear }
+        self
+    end
+
+    private
+
+    def each( &block )
+        accessors.each do |attr|
+            block.call attr, send( attr )
+        end
+    end
+
+    def accessors
+        instance_variables.map do |ivar|
+            attribute = "#{ivar.to_s.gsub('@','')}"
+            next if !methods.include?( :"#{attribute}=" )
+            attribute.to_sym
+        end.compact
+    end
+
+end
+
+reset
+end
+end

data/lib/cuboid/error.rb

@@ -0,0 +1,9 @@
+module Cuboid
+
+# It provides a namespace for all system errors.
+#
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+class Error < StandardError
+end
+
+end

data/lib/cuboid/option_group.rb

@@ -0,0 +1,129 @@
+module Cuboid
+
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+class OptionGroup
+
+    # @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+    class Error < Options::Error
+    end
+
+    class <<self
+
+        # @return   [Hash]
+        #   Specified default values for attribute readers.
+        def defaults
+            @defaults ||= {}
+        end
+
+        # Sets default values for attribute readers, when an attribute reader
+        # returns `nil` the default values will be returned instead.
+        #
+        # @param    [Hash]  default_values
+        #   Default values for attributes.
+        def set_defaults( default_values )
+            defaults.merge! default_values
+
+            # Set the specified default values as overrides to the attribute
+            # readers.
+            defaults.each do |ivar, value|
+                define_method "#{ivar}=" do |v|
+                    instance_variable_set( "@#{ivar}".to_sym, v.nil? ? value : v)
+                end
+            end
+
+            defaults
+        end
+
+        def inherited( child )
+            Options.register_group child
+        end
+    end
+
+    def initialize
+        defaults.each do |k, v|
+            send "#{k}=", v
+        end
+    end
+
+    def to_rpc_data
+        to_h.my_stringify_keys(false)
+    end
+
+    # @return   [Hash]
+    #   Values for all attribute accessors which aren't the defaults.
+    def to_h
+        h = {}
+        instance_variables.each do |ivar|
+            method = normalize_ivar( ivar )
+            sym    = method.to_sym
+            value  = instance_variable_get( ivar )
+
+            next if !respond_to?( "#{method}=" )
+
+            h[sym] = value
+        end
+        h
+    end
+    def to_hash
+        to_h
+    end
+
+    # @return   [Hash]
+    #   Hash of errors with the name of the invalid options as the keys.
+    #
+    # @abstract
+    def validate
+        {}
+    end
+
+    def ==( other )
+        hash == other.hash
+    end
+
+    def hash
+        to_h.hash
+    end
+
+    # @param    [Hash]  options
+    #   Data to use to update the group's attributes.
+    #
+    # @return   [OptionGroup]
+    #   `self`
+    def update( options )
+        options.to_hash.each { |k, v| send( "#{k}=", v ) }
+        self
+    end
+
+    # @param    [OptionGroup]  other
+    #
+    # @return   [OptionGroup]
+    #   `self`
+    def merge( other )
+        update( other.to_h )
+    end
+
+    # @return   (see .defaults)
+    def defaults
+        self.class.defaults
+    end
+
+    def self.attr_accessor( *vars )
+        attributes.concat( vars )
+        super( *vars )
+    end
+
+    def self.attributes
+        @attributes ||= []
+    end
+
+    def attributes
+        self.class.attributes
+    end
+
+    private
+
+    def normalize_ivar( ivar )
+        ivar.to_s.gsub( '@', '' )
+    end
+end
+end

data/lib/cuboid/option_groups/datastore.rb

@@ -0,0 +1,23 @@
+require 'ostruct'
+
+module Cuboid::OptionGroups
+
+# Generic OpenStruct-based class for general purpose data storage.
+#
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+class Datastore < Cuboid::OptionGroup
+
+    def initialize
+        @source = OpenStruct.new
+    end
+
+    def method_missing( method, *args, &block )
+        @source.send( method, *args, &block )
+    end
+
+    def to_h
+        @source.marshal_dump
+    end
+
+end
+end

data/lib/cuboid/option_groups/dispatcher.rb

@@ -0,0 +1,38 @@
+module Cuboid::OptionGroups
+
+# Holds options for {RPC::Server::Dispatcher} servers.
+#
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+class Dispatcher < Cuboid::OptionGroup
+
+    # @return   [String]
+    #   URL of a {RPC::Server::Dispatcher}.
+    attr_accessor :url
+
+    # @return   [Array<Integer>]
+    #   Range of ports to use when spawning instances, first entry should be
+    #   the lowest port number, last the max port number.
+    attr_accessor :instance_port_range
+
+    # @return   [String]
+    #   The URL of a neighbouring {RPC::Server::Dispatcher}, applicable when
+    #   {RPC::Server::Dispatcher} are connected to each other to form a Grid.
+    #
+    # @see RPC::Server::Dispatcher::Node
+    attr_accessor :neighbour
+
+    # @return   [Float]
+    #   How regularly to check for neighbour statuses.
+    attr_accessor :ping_interval
+
+    # @return   [String]
+    #   Dispatcher name.
+    attr_accessor :name
+
+    set_defaults(
+        ping_interval:       5.0,
+        instance_port_range: [1025, 65535]
+    )
+
+end
+end

data/lib/cuboid/option_groups/output.rb

@@ -0,0 +1,14 @@
+module Cuboid::OptionGroups
+
+# {Cuboid::UI::Output} options.
+#
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+class Output < Cuboid::OptionGroup
+
+    # @return   [Bool]
+    #   `true` if the output of the RPC instances should be redirected to a
+    #   file, `false` otherwise.
+    attr_accessor :reroute_to_logfile
+
+end
+end

data/lib/cuboid/option_groups/paths.rb

@@ -0,0 +1,184 @@
+require 'fileutils'
+require 'tmpdir'
+
+module Cuboid::OptionGroups
+
+# Holds paths to the directories of various system components.
+#
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+class Paths < Cuboid::OptionGroup
+
+    TMPDIR_SUFFIX = 'Cuboid_'
+
+    [
+        :root,
+        :logs,
+        :reports,
+        :executables,
+        :services,
+        :lib,
+        :support,
+        :mixins,
+        :snapshots
+    ].each do |type|
+        attr_accessor type
+
+        define_method "#{type}=" do |path|
+            if !path
+                return instance_variable_set :"@#{type}", defaults[type]
+            end
+
+            path += '/' if !path.end_with? '/'
+
+            if !File.directory? path
+                raise ArgumentError,
+                      "#{type.to_s.capitalize} directory does not exist: #{path}"
+            end
+
+            instance_variable_set :"@#{type}", path
+        end
+    end
+
+    #   @return [String]
+    attr_accessor :application
+
+    # @!attribute root
+    #   @return [String]
+
+    # @!attribute lib
+    #   @return [String]
+
+    # @!attribute support
+    #   @return [String]
+
+    # @!attribute mixins
+    #   @return [String]
+
+    # @!attribute components
+    #   @return [String]
+
+    # @!attribute services
+    #   @return [String]
+
+    # @!attribute reports
+    #   @return [String]
+    #       Report storage.
+
+    # @!attribute snapshots
+    #   @return [String]
+    #       Snapshot storage.
+
+    # @!attribute executables
+    #   @return [String]
+    #       System processes (instance, dispatcher, browser, etc.).
+
+    def initialize
+        @root = self.root_path
+
+        @snapshots = self.config['snapshots'] || @root + 'snapshots/'
+        @reports   = self.config['reports']   || @root + 'reports/'
+
+        if ENV['CUBOID_LOGDIR'].to_s != ''
+            @logs = "#{ENV['CUBOID_LOGDIR']}/"
+        elsif self.config['logs']
+            @logs = self.config['logs']
+        else
+            @logs = "#{@root}logs/"
+        end
+
+        @lib         = @root    + 'lib/cuboid/'
+        @executables = @lib     + 'processes/executables/'
+        @support     = @lib     + 'support/'
+        @mixins      = @support + 'mixins/'
+
+        instance_variables.each do |iv|
+            defaults[iv.to_s.sub( '@', '' ).to_sym] = instance_variable_get( iv )
+        end
+
+        tmpdir
+    end
+
+    def root_path
+        self.class.root_path
+    end
+
+    # @return   [String]
+    #   Root path of the engine.
+    def self.root_path
+        File.expand_path( File.dirname( __FILE__ ) + '/../../..' ) + '/'
+    end
+
+    def os_tmpdir
+        return @os_tmpdir if @os_tmpdir
+
+        if config['tmpdir'].to_s.empty?
+            # On MS Windows Dir.tmpdir can return the path with a shortname,
+            # better avoid that as it can be insonsistent with other paths.
+            @os_tmpdir = Cuboid.get_long_win32_filename( Dir.tmpdir )
+        else
+            @os_tmpdir = Cuboid.get_long_win32_filename( config['tmpdir'] )
+        end
+    end
+
+    def tmpdir
+        return @tmpdir if @tmpdir
+
+        dir = tmp_dir_for( Process.pid )
+
+        FileUtils.mkdir_p dir
+        at_exit do
+            FileUtils.rm_rf dir
+        end
+
+        @tmpdir = dir
+    end
+
+    def tmp_dir_for( pid )
+        "#{os_tmpdir}/#{TMPDIR_SUFFIX}#{pid}"
+    end
+
+    def config
+        self.class.config
+    end
+
+    def self.paths_config_file
+        Cuboid.get_long_win32_filename "#{root_path}config/paths.yml"
+    end
+
+    def self.clear_config_cache
+        @config = nil
+    end
+
+    def self.config
+        return @config if @config
+
+        if !File.exist?( paths_config_file )
+            @config = {}
+        else
+            @config = YAML.load( IO.read( paths_config_file ) )
+        end
+
+        @config.dup.each do |category, dir|
+            if dir.to_s.empty?
+                @config.delete( category )
+                next
+            end
+
+            dir = Cuboid.get_long_win32_filename( dir )
+
+            if !Cuboid.windows?
+                dir.gsub!( '~', ENV['HOME'] )
+            end
+
+            dir << '/' if !dir.end_with?( '/' )
+
+            @config[category] = dir
+
+            FileUtils.mkdir_p dir
+        end
+
+        @config
+    end
+
+end
+end

data/lib/cuboid/option_groups/report.rb

@@ -0,0 +1,39 @@
+module Cuboid::OptionGroups
+
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+class Report < Cuboid::OptionGroup
+
+    # @return    [String]
+    #   Directory or file path where to store the scan report.
+    attr_accessor :path
+
+    def initialize
+        @default_path = self.path = default_path
+    end
+
+    def path=( path )
+        return @path = @default_path if !path
+
+        if path.end_with?( '/' ) && !File.exist?( path )
+            raise ArgumentError,
+                  "Snapshot location does not exist: #{path}"
+        end
+
+        path = File.expand_path( path )
+        if File.directory? path
+            path += '/' if !path.end_with? '/'
+        end
+
+        @path = path
+    end
+
+    def default_path
+        Paths.config['reports']
+    end
+
+    def defaults
+        { path: default_path }
+    end
+
+end
+end

data/lib/cuboid/option_groups/rpc.rb

@@ -0,0 +1,105 @@
+module Cuboid::OptionGroups
+
+# Holds {Engine::RPC::Client} and {Engine::RPC::Server} options.
+#
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+class RPC < Cuboid::OptionGroup
+
+    # @return   [String]
+    #   Path to the UNIX socket to use for RPC communication.
+    #
+    # @see RPC::Server::Base
+    attr_accessor :server_socket
+
+    # @return   [String]
+    #   Hostname or IP address for the RPC server.
+    #
+    # @see RPC::Server::Base
+    attr_accessor :server_address
+
+    # @return   [String]
+    #   External (hostname or IP) address for the RPC server to advertise.
+    attr_accessor :server_external_address
+
+    # @return   [Integer]
+    #   RPC server port.
+    #
+    # @see RPC::Server::Base
+    attr_accessor :server_port
+
+    # @return   [String]
+    #   Path to an SSL certificate authority file in PEM format.
+    #
+    # @see RPC::Server::Base
+    # @see RPC::Client::Base
+    attr_accessor :ssl_ca
+
+    # @return   [String]
+    #   Path to a server SSL private key in PEM format.
+    #
+    # @see RPC::Server::Base
+    attr_accessor :server_ssl_private_key
+
+    # @return   [String]
+    #   Path to server SSL certificate in PEM format.
+    #
+    # @see RPC::Server::Base
+    attr_accessor :server_ssl_certificate
+
+    # @return   [String]
+    #   Path to a client SSL private key in PEM format.
+    #
+    # @see RPC::Client::Base
+    attr_accessor :client_ssl_private_key
+
+    # @return   [String]
+    #   Path to client SSL certificate in PEM format.
+    #
+    # @see RPC::Client::Base
+    attr_accessor :client_ssl_certificate
+
+    # @return [Integer]
+    #   Maximum retries for failed RPC calls.
+    #
+    # @see RPC::Client::Base
+    attr_accessor :client_max_retries
+
+    # @note This should be permanently set to `1`, otherwise it will cause issues
+    #   with the scheduling of the workload distribution of multi-Instance scans.
+    #
+    # @return [Integer]
+    #   Amount of concurrently open connections for each RPC client.
+    #
+    # @see RPC::Client::Base
+    attr_accessor :connection_pool_size
+
+    set_defaults(
+        connection_pool_size: 1,
+        server_address:       '127.0.0.1',
+        server_port:          7331
+    )
+
+    def to_client_options
+        {
+            connection_pool_size: connection_pool_size,
+            max_retries:          client_max_retries,
+            ssl_ca:               ssl_ca,
+            ssl_pkey:             client_ssl_private_key,
+            ssl_cert:             client_ssl_certificate
+        }
+    end
+
+    def to_server_options
+        {
+            host:             server_address,
+            external_address: server_external_address,
+            port:             server_port,
+            socket:           server_socket,
+            ssl_ca:           ssl_ca,
+            ssl_pkey:         server_ssl_private_key,
+            ssl_cert:         server_ssl_certificate
+        }
+    end
+
+end
+end

data/lib/cuboid/option_groups/scheduler.rb

@@ -0,0 +1,27 @@
+module Cuboid::OptionGroups
+
+# Holds options for {RPC::Server::Scheduler} servers.
+#
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+class Scheduler < Cuboid::OptionGroup
+
+    # @return   [String]
+    #   URL of a {RPC::Server::Scheduler}.
+    attr_accessor :url
+
+    # @return   [Array<Integer>]
+    #   Range of ports to use when spawning instances, first entry should be
+    #   the lowest port number, last the max port number.
+    attr_accessor :instance_port_range
+
+    # @return   [Float]
+    #   How regularly to check for scan statuses.
+    attr_accessor :ping_interval
+
+    set_defaults(
+        ping_interval:       5.0,
+        instance_port_range: [1025, 65535]
+    )
+
+end
+end

data/lib/cuboid/option_groups/snapshot.rb

@@ -0,0 +1,13 @@
+require_relative 'report'
+
+module Cuboid::OptionGroups
+
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+class Snapshot < Report
+
+    def default_path
+        Paths.config['snapshots']
+    end
+
+end
+end

data/lib/cuboid/option_groups/system.rb

@@ -0,0 +1,10 @@
+module Cuboid::OptionGroups
+
+# @author Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
+class System < Cuboid::OptionGroup
+
+    # @return    [Integer]
+    attr_accessor :max_slots
+
+end
+end

data/lib/cuboid/option_groups.rb

@@ -0,0 +1,8 @@
+require_relative 'option_group'
+
+# We need this to be available prior to loading the rest of the groups.
+require_relative 'option_groups/paths'
+
+Dir.glob( "#{File.dirname(__FILE__)}/option_groups/*.rb" ).each do |group|
+    require group
+end