test_server 0.0.11

data/lib/test_server/cli/reload.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+module TestServer
+  module Cli
+    class Reload < Thor
+      no_commands {
+        include TestServer::Cli::Helper
+      }
+
+      desc 'configuration', 'Reload configuration'
+      def configuration
+        TestServer.config = TestServer::Config.new(options[:config_file]) if options[:config_file]
+        TestServer.config.log_level = options[:log_level] if options[:log_level]
+        TestServer.config.debug_mode = options[:debug_mode] if options[:debug_mode]
+        TestServer.config.pid_file = options[:pid_file] if options[:pid_file] 
+        TestServer.config.lock
+
+        TestServer.ui_logger.level = TestServer.config.log_level
+        TestServer.enable_debug_mode if TestServer.config.debug_mode
+
+        TestServer.ui_logger.info "Ask web application (PID: #{pid(TestServer.config)}) to reload configuration"
+        Actions::SendSignal.new(TestServer.config.reload_config_signal).run
+      end
+
+      desc 'local_storage', 'Reload local_storage'
+      def local_storage
+        TestServer.config = TestServer::Config.new(options[:config_file]) if options[:config_file]
+        TestServer.config.log_level = options[:log_level] if options[:log_level]
+        TestServer.config.debug_mode = options[:debug_mode] if options[:debug_mode]
+        TestServer.config.pid_file = options[:pid_file] if options[:pid_file] 
+        TestServer.config.lock
+
+        TestServer.ui_logger.level = TestServer.config.log_level
+        TestServer.enable_debug_mode if TestServer.config.debug_mode
+
+        TestServer.ui_logger.info "Ask web application (PID: #{pid(TestServer.config)}) to reload storage"
+        Actions::SendSignal.new(TestServer.config.reload_storage_signal).run
+      end
+    end
+  end
+end

data/lib/test_server/config.rb

@@ -0,0 +1,107 @@
+# encoding: utf-8
+module TestServer
+  class Config
+
+    private
+
+    attr_reader :config
+
+    @options = Set.new
+    @process_environment = ProcessEnvironment.new
+
+    class << self
+
+      public
+
+      attr_reader :options, :process_environment
+
+      def option_reader(option, default_value)
+        define_method option.to_sym do
+          config.fetch(option.to_sym, default_value)
+        end
+
+        @options << option
+      end
+
+      def option_writer(option)
+        define_method "#{option}=".to_sym do |value|
+          begin
+            config[option.to_sym] = value
+          rescue RuntimeError
+            raise Exceptions::ConfigLocked
+          end
+        end
+
+        @options << option
+      end
+
+      def option(option, default_value)
+        option_reader(option, default_value)
+        option_writer(option)
+      end
+    end
+
+    public
+
+    def initialize(file = available_config_file, config_engine = Psych)
+      config_mutex = Mutex.new
+      config_mutex.synchronize do
+        yaml = Psych.load_file(file)
+
+        if yaml.respond_to? :[]
+          @config = yaml.symbolize_keys
+        else
+          @config = {}
+        end
+      end
+    rescue StandardError => e
+      fail Exceptions::ConfigFileNotReadable, JSON.dump(message: e.message, file: file)
+    end
+
+    def lock
+      config.freeze
+    end
+
+    def to_s
+      result = []
+      result << sprintf("%20s | %s", 'option', 'value')
+      result << sprintf("%s + %s", '-' * 20, '-' * 80)
+
+      Config.options.each do |o|
+        result << sprintf("%20s | %s", o, Array(public_send(o)).join(', '))
+      end
+
+      result.join("\n")
+    end
+
+    def allowed_config_file_paths
+      [
+        ::File.expand_path(::File.join(self.class.process_environment.fetch('HOME'), '.config', 'test_server', 'config.yaml')),
+        ::File.expand_path(::File.join(self.class.process_environment.fetch('HOME'), '.test_server', 'config.yaml')),
+        ::File.expand_path(::File.join('/etc', 'test_server', 'config.yaml')),
+        ::File.expand_path('../../../files/config.yaml', __FILE__),
+      ]
+    end
+
+    option :access_log, ::File.expand_path(::File.join(process_environment.fetch('HOME'), '.local', 'share', 'test_server', 'log', 'access.log'))
+    option :config_file, ::File.expand_path(::File.join(process_environment.fetch('HOME'), '.config', 'test_server', 'config.yaml'))
+    option :debug_mode, false
+    option :environment, 'development'
+    option :executable, ::File.expand_path(::File.expand_path('../../../bin/test_server', __FILE__))
+    option :gem_path, Gem.path.collect {|p|::File.expand_path(p) }
+    option :listen, 'tcp://127.0.0.1:8000'
+    option :log_level, :info
+    option :pid_file, ::File.expand_path(::File.join(process_environment.fetch('HOME'), '.local', 'share', 'test_server', 'run', 'pid'))
+    option :reload_config_signal, :USR1
+    option :reload_storage_signal, :USR2
+    option :sass_cache, ::File.expand_path(::File.join(process_environment.fetch('HOME'), '.local', 'share', 'test_server', 'cache'))
+    option :worker_count, 10
+
+    private
+
+    def available_config_file
+      allowed_config_file_paths.find { |f| ::File.exists? f }
+    end
+
+  end
+end

data/lib/test_server/data.rb

@@ -0,0 +1,23 @@
+module TestServer
+  class Data
+    private
+
+    attr_reader :config
+
+    public
+
+    def initialize(config = TestServer.config)
+      @config = config
+    end
+
+    def instance_binding
+      binding
+    end
+
+    def lookup(variable)
+      config.public_send variable.to_sym
+    rescue NoMethodError
+      fail "Variable \"#{variable}\" not found."
+    end
+  end
+end

data/lib/test_server/encoder.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+module TestServer
+  class Encoder
+    include Comparable
+
+    def name
+      self.class.to_s.demodulize.underscore.to_sym
+    end
+
+    def encode(string)
+      fail NotImplementedError, JSON.dump(method: 'encode')
+    end
+
+    def decode(string)
+      fail NotImplementedError, JSON.dump(method: 'decode')
+    end
+
+    def name?(n)
+      name == n
+    end
+
+    def eql?(other)
+      name? other.name
+    end
+
+    def hash
+      Digest::SHA1.hexdigest name.to_s
+    end
+
+    def <=>(other)
+      name <=> other.name
+    end
+
+    def find_by_name(name)
+    rescue NameError
+      raise 
+    end
+  end
+end

data/lib/test_server/encoders/base64.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+module TestServer
+  module Encoders
+    class Base64 < Encoder
+      def encode(string)
+        ::Base64.encode64(string)
+      end
+
+      def decode(string)
+        ::Base64.decode64(string)
+      end
+    end
+  end
+end

data/lib/test_server/encoders/base64_strict.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+module TestServer
+  module Encoders
+    class Base64Strict < Encoder
+      def encode(string)
+        ::Base64.strict_encode64(string)
+      end
+
+      def decode(string)
+        ::Base64.strict_decode64(string)
+      end
+    end
+  end
+end

data/lib/test_server/encoders/gzip.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+module TestServer
+  module Encoders
+    class Gzip < Encoder
+      def encode(string)
+        Zlib::Deflate.deflate(string)
+      end
+
+      def decode(string)
+        Zlib::Inflate.inflate(string)
+      end
+    end
+  end
+end

data/lib/test_server/encoders/null.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+module TestServer
+  module Encoders
+    class Null < Encoder
+      def encode(string)
+        string
+      end
+
+      def decode(string)
+        string
+      end
+    end
+  end
+end

data/lib/test_server/erb_generator.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+module TestServer
+  # Used to generate the template
+  class ErbGenerator
+
+    private
+
+    attr_reader :data
+
+    public
+
+    # Create erb generator
+    #
+    # @param [Data] data
+    # The data class to be used within the template
+    def initialize(data)
+      @data = data
+    end
+
+    # Compile the template
+    #
+    # @param [IO] source
+    # The source template to be used
+    # @param [IO] destination
+    # The output io handle
+    def compile(source, destination)
+      erb = ERB.new(source.read, nil, '-')
+      begin
+        destination.puts erb.result(data.instance_binding)
+      rescue SyntaxError => e
+        raise Exceptions::ErbTemplateHasSyntaxErrors, e.message
+      end
+    end
+  end
+end

data/lib/test_server/error_handler.rb

@@ -0,0 +1,109 @@
+# encoding: utf-8
+module TestServer
+  class ErrorHandler
+
+    @handlers = []
+    @mutex    = Mutex.new
+
+    class << self
+      attr_reader :handlers, :mutex
+    end
+
+    private
+
+    attr_reader :details_i18n, :summary_i18n, :exit_code
+
+    public
+
+    attr_reader :exception
+    attr_accessor :original_message
+    attr_accessor :backtrace
+
+    def initialize(options = {})
+      @exception    = options.fetch(:exception)
+      @details_i18n = options.fetch(:details)
+      @summary_i18n = options.fetch(:summary)
+      @exit_code    = options.fetch(:exit_code)
+    rescue KeyError => e
+      raise ArgumentError, e.message
+    end
+
+    class << self
+      def create(options = {}, &block)
+        handler = new(options, &block)
+        handlers << handler
+
+        handler
+      end
+
+      def find(exception)
+        handlers.find(proc { default_handler }) { |h| h.exception == exception }
+      end
+
+      private
+
+      def default_handler
+        mutex.synchronize do
+          @default_handler ||= new(
+            exception: StandardError,
+            details: 'errors.default.details',
+            summary: 'errors.default.summary',
+            exit_code: 99,
+          )
+        end
+      end
+    end
+
+    def details(format = :plain)
+      case format
+      when :plain
+        @details
+      when :html
+        Rack::Utils.escape_html(@details)
+      else
+        @details
+      end
+    end
+
+    def summary(format = :plain)
+      case format
+      when :plain
+        @summary
+      when :html
+        Rack::Utils.escape_html(@summary)
+      else
+        @summary
+      end
+    end
+
+    def use(data)
+      data = JSON.parse(data) if data.kind_of? String
+      data = data.symbolize_keys 
+
+      @details ||= I18n.t(details_i18n, data)
+      @summary ||= I18n.t(summary_i18n, data)
+    end
+
+    def execute(data = {})
+      use(data)
+
+      TestServer.ui_logger.fatal details
+      TestServer.ui_logger.debug original_message if original_message
+      TestServer.ui_logger.debug "Original Backtrace follows\n" + backtrace.join("\n") if backtrace
+      Kernel.exit exit_code
+    end
+
+    def to_json
+      ErrorHandler.mutex.synchronize do
+        @details ||= I18n.t(details_i18n)
+        @summary ||= I18n.t(summary_i18n)
+      end
+
+      JSON.dump(
+          error_summary: summary,
+          error_details: details,
+          result: :failure,
+      )
+    end
+  end
+end

data/lib/test_server/error_messages.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+module TestServer
+  module ErrorMessages
+    ErrorHandler.create(
+      exception: StandardError,
+      summary: 'errors.default.summary',
+      details: 'errors.default.details',
+      exit_code: 99,
+    )
+
+    ErrorHandler.create(
+      exception: Exceptions::InternalError,
+      details: 'errors.internal_error.details',
+      summary: 'errors.internal_error.summary',
+      exit_code: 1,
+    )
+    
+    ErrorHandler.create(
+      exception: Exceptions::ConfigFileNotReadable,
+      details: 'errors.unreadable_config_file.details',
+      summary: 'errors.unreadable_config_file.summary',
+      exit_code: 2,
+    )
+
+    ErrorHandler.create(
+      exception: Exceptions::UserError,
+      details: 'errors.user_error.details',
+      summary: 'errors.user_error.summary',
+      exit_code: 3,
+    )
+
+    ErrorHandler.create(
+      exception: Sinatra::Param::InvalidParameterError,
+      details: 'errors.invalid_parameter.details',
+      summary: 'errors.invalid_parameter.summary',
+      exit_code: 4,
+    )
+
+    ErrorHandler.create(
+      exception: Exceptions::PidFileDoesNotExist,
+      details: 'errors.invalid_proxy_pac.details',
+      summary: 'errors.invalid_proxy_pac.summary',
+      exit_code: 5,
+    )
+
+    ErrorHandler.create(
+      exception: Exceptions::GivenUrlInvalid,
+      details: 'errors.invalid_url.details',
+      summary: 'errors.invalid_url.summary',
+      exit_code: 6,
+    )
+    
+    ErrorHandler.create(
+      exception: Exceptions::ServerListenStatementInvalid,
+      details: 'errors.invalid_listen_statement.details',
+      summary: 'errors.invalid_listen_statement.summary',
+      exit_code: 8,
+    )
+
+    ErrorHandler.create(
+      exception: Exceptions::AccessLogPathInvalid,
+      details: 'errors.invalid_access_log_path.details',
+      summary: 'errors.invalid_access_log_path.summary',
+      exit_code: 9,
+    )
+  end
+end

data/lib/test_server/exceptions.rb

@@ -0,0 +1,39 @@
+module TestServer
+  module Exceptions
+    # user error
+    class UserError < StandardError; end
+
+    # internal error
+    class InternalError < StandardError; end
+
+    # raised if config file does not exist
+    class ConfigFileNotReadable < UserError; end
+
+    # file in repository not found
+    class LocalFileIsUnknown < UserError; end
+
+    # invalid path to access log
+    class AccessLogPathInvalid < UserError; end
+
+    # reload of configuration failed
+    class ReloadOfConfigurationFailed < InternalError; end
+
+    # raised if pid file does not exist
+    class PidFileDoesNotExist < UserError; end
+
+    # raise if there are template syntax errrors
+    class ErbTemplateHasSyntaxErrors < InternalError; end
+
+    # raised if Template does not exist
+    class ErbTemplateIsUnknown < InternalError; end
+
+    # raised if listen statement is invalid
+    class ServerListenStatementInvalid < UserError; end
+
+    # raised if request is invalid
+    class GivenUrlInvalid < UserError; end
+
+    # raised if variable cannot be looked up
+    class VariableUnknown < InternalError; end
+  end
+end

data/lib/test_server/locales/en.yml

@@ -0,0 +1,72 @@
+---
+en:
+  errors:
+    default: 
+      summary: Unexpected Error...
+      details: Sorry, but I cannot fullfill your request. An unexpected error occured. Please ask your administrator for support.
+    internal_error: 
+      summary: Internal error...
+      details: 'Sorry, but I cannot fullfill your request. An internal error occured: "%{message}". Please notify the author of the software about the problem.'
+    user_error: 
+      summary: User Error...
+      details: Sorry, but I cannot fullfill your request. An error occured. There should be a better error message displayed here. Please notify the author of the software about the problem.
+    unreadable_config_file: 
+      summary: Unreadable config file...
+      details: 'Sorry, but I cannot fullfill your request. The config file "%{file}" given could not be read: "%{message}".'
+    sigint: 
+      summary: Program Execution Interrupted...
+      details: You've chosen to interrupt the program execution.
+    sigterm: 
+      summary: Program Execution Aborted...
+      details: I received a SIGTERM. Aborting program execution.
+    unknown_local_file: 
+      summary: Local File Unknown
+      details: Sorry, but I cannot fullfill your request. The requested file "%{file}" cannot be found in the local file repository.
+    invalid_url: 
+      summary: Invalid URL...
+      details: Sorry, but your request is invalid. The URL "%{url}" is not a correct one. Allowed are URLs like "http://www.example.org" or "www.example.org".
+    invalid_access_log_path: 
+      summary: Invalid Path to Access Log...
+      details: Sorry, but I cannot start the server. The path "%{file}" to the access log is invalid. Maybe the directory "%{directory}" where the access log should be stored, does not exist.
+    invalid_parameter: 
+      summary: Invalid Parameter...
+      details: Sorry, but your request is invalid. The parameter "%{parameter}" is unknown or the format given cannot be accepted.
+    unreadable_config_file: 
+      summary: Unreadable config file...
+      details: 'Sorry, but I cannot fullfill your request. The config file "%{file}" given could not be read: "%{message}".'
+    invalid_pac_result: 
+      summary: Invalid result from pac file...
+      details: 'Sorry, but I cannot fullfill your request. The result "%{result}" of proxy.pac "%{file}" is invalid. Please fix the proxy.pac and try again.'
+    compress_pac_file_failed: 
+      summary: Pac file cannot be compressed...
+      details: 'Sorry, but an error occurred while I tried to compress the proxy.pac-file "%{file}": %{message}. Please fix the proxy.pac and try again.'
+  views:
+    application:
+      title: Test Server
+      buttons:
+        submit: 'Start'
+        reset: 'Reset'
+        close: 'Close'
+    dialogs:
+      notification:
+        title: Notification
+    root:
+      link: Home
+    test:
+      link: Tests
+    javascript:
+      xhr:
+        link: XHR
+        title: 'Javascript Tests'
+        fields: &fields
+          url: URL
+          count: Count
+          timeout: Timeout (s)
+        result_table:
+          url: URL
+          runtime: Runtime (ms)
+          timeout: Timeout (ms)
+          status: Status
+        notification: 
+          text: You asked me to send out requests.
+

data/lib/test_server/main.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+module TestServer
+  @config      = TestServer::Config.new
+  @ui_logger   = TestServer::UiLogger.new
+
+  class << self
+    attr_accessor :environment, :config, :ui_logger
+
+    def root_path
+      ::File.expand_path('../../..', __FILE__)
+    end
+
+    def enable_debug_mode
+      TestServer.ui_logger.info "Activating debug mode."
+
+      require 'pry'
+      require 'debugger'
+    rescue LoadError
+      TestServer.ui_logger.error "You tried to enable debug-mode, but either 'pry'- or 'debugger'-gem are not installed. Please fix that before using the debug-switch again."
+    end
+
+    def configure_i18n
+      I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)
+      I18n.load_path = Dir[::File.join(TestServer.root_path, 'lib', 'test_server', 'locales', '*.yml')]
+      I18n.backend.load_translations
+      I18n.enforce_available_locales = true
+    end
+  end
+end
+
+TestServer.configure_i18n

data/lib/test_server/null_access_logger.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+module TestServer
+  class NullAccessLogger
+    def write(*args, &block); end
+  end
+end

data/lib/test_server/process_environment.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+module TestServer
+  class ProcessEnvironment
+    private
+
+    attr_reader :environment
+
+    public
+
+    def initialize(environment = ENV)
+      @environment = environment
+      
+    end
+
+    def fetch(key, default_value = nil)
+      environment.to_hash.symbolize_keys.fetch(key.to_sym, default_value).to_s
+    end
+
+    def write(key, value)
+      environment[key.to_s] = value
+    end
+  end
+end

data/lib/test_server/server.rb

@@ -0,0 +1,19 @@
+# encoding:utf-8
+module TestServer
+  class Server
+
+    private
+
+    attr_reader :command
+
+    public
+
+    def initialize(command = ServerCommands::Rackup.new)
+      @command = command
+    end
+
+    def start
+      exec command.to_s
+    end
+  end
+end