test_server 0.0.11

data/lib/test_server/server_commands/puma.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+module TestServer
+  module ServerCommands
+    class Puma
+
+      private
+
+      attr_reader :environment, :pid_file, :config_file, :listen, :worker_count
+
+      public
+
+      def initialize(options = {})
+        @environment  = options.fetch(:environment, :development)
+        @pid_file     = options.fetch(:pid_file, TestServer.config.pid_file)
+        @config_file  = options.fetch(:config_file, ::File.expand_path('../../../../config.ru', __FILE__))
+        @listen       = options.fetch(:listen, 'tcp://127.0.0.1:8080')
+        @worker_count = options.fetch(:worker_count, nil)
+
+      rescue KeyError => e
+        raise ArgumentError, e.message
+      end
+
+      def to_s
+        cmd = []
+
+        cmd << 'puma'
+        cmd << "-e #{environment}" if environment
+        cmd << "--pidfile #{pid_file}" if pid_file
+        cmd << "-b #{listen}" if listen
+        cmd << "-w #{worker_count}" if worker_count
+        cmd << config_file if config_file
+
+        cmd.join(" ")
+      end
+    end
+  end
+end

data/lib/test_server/server_commands/rackup.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+module TestServer
+  module ServerCommands
+    class Rackup
+
+      private
+
+      attr_reader :environment, :pid_file, :config_file, :host, :port
+
+      public
+
+      def initialize(options = {})
+        @environment = options.fetch(:environment, :development)
+        @pid_file    = options.fetch(:pid_file, TestServer.config.pid_file)
+        @config_file = options.fetch(:config_file, ::File.expand_path('../../../../config.ru', __FILE__))
+        listen       = options.fetch(:listen, '127.0.0.1:8080')
+
+        begin
+          uri = Addressable::URI.heuristic_parse(listen)
+        rescue StandardError => e
+          fail Exceptions::ServerListenStatementInvalid, "I cannot parse the listen statement: #{listen}. It is invalid: #{e.message}"
+        end
+
+        @port        = uri.port
+        @host        = uri.host
+      rescue KeyError => e
+        raise ArgumentError, e.message
+      end
+
+      def to_s
+        cmd = []
+
+        cmd << 'rackup'
+        cmd << "-E #{environment}" if environment
+        cmd << "-P #{pid_file}" if pid_file
+        cmd << "-o #{host}" if host
+        cmd << "-p #{port}" if port
+        cmd << config_file if config_file
+
+        cmd.join(" ")
+      end
+    end
+  end
+end

data/lib/test_server/template_file.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+module TestServer
+  class TemplateFile
+
+    attr_reader :path
+
+    def initialize(path)
+      @path = ::File.expand_path(path)
+    end
+
+    def name
+      ::File.basename(path, '.*').to_sym
+    end
+
+    def read
+      ::File.read(path)
+    end
+  end
+end

data/lib/test_server/template_repository.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+module TestServer
+  class TemplateRepository
+    private
+
+    attr_reader :root_directory, :creator
+
+    public
+
+    def initialize(root_directory = ::File.expand_path('../../../files', __FILE__), creator = TemplateFile)
+      @root_directory = ::File.expand_path(root_directory)
+      @creator        = creator
+    end
+
+    def find(name)
+      path = ::File.join(root_directory, "#{name.to_s}.erb")
+      fail Exceptions::ErbTemplateIsUnknown, "Template \"#{name}\" could not be found!" unless ::File.exist? path
+
+      creator.new(path)
+    end
+  end
+end

data/lib/test_server/ui_logger.rb

@@ -0,0 +1,37 @@
+module TestServer
+  class UiLogger
+
+    private
+
+    attr_reader :logger
+
+    public
+
+    def initialize
+      @logger = ::Logger.new($stderr)
+    end
+
+    def level=(l)
+      logger.level = case l.to_s.to_sym
+                      when :unknown
+                        ::Logger::UNKNOWN
+                      when :fatal
+                        ::Logger::FATAL
+                      when :error
+                        ::Logger::ERROR
+                      when :warn
+                        ::Logger::WARN
+                      when :info
+                        ::Logger::INFO
+                      when :debug
+                        ::Logger::DEBUG
+                      else
+                        ::Logger::ERROR
+                      end
+    end
+
+    def method_missing(method, *args, &block)
+      logger.public_send method, *args
+    end
+  end
+end

data/lib/test_server/version.rb

@@ -0,0 +1,4 @@
+#main TestServer
+module TestServer
+  VERSION = '0.0.11'
+end

data/lib/test_server/web_helper.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+module TestServer
+  module WebHelper
+    def h(text)
+      Rack::Utils.escape_html(text)
+    end
+
+    def t(*args)
+      I18n.t(*args)
+    end
+
+    def generate_string(count, string = "Plain Data\n")
+      string * count
+    end
+  
+    def generate_random_string(count)
+      o = [('a'..'z'), ('A'..'Z'), (1..9), %w{° ^ ! " § $ % & / ( ) = ? * + ~ ` ´ ' # > < | @ ł € ¶ ŧ ← ↓ → ŋ đ ð ſ ð đ ŋ ħ “ „ ¢ « | » « ¢ „ “ ” µ · … – ĸ ¹ ² ³ ¼ ½ ¬ \{ [ ] \}}].map { |i| i.to_a }.flatten
+
+      (0...count).map { o[rand(o.length)] }.join
+    end
+
+    def generate_eicar
+      [ 'X', '5', 'O', '!', 'P', '%', '@', 'A', 'P', '[', '4', "\\", 'P',
+        'Z', 'X', '5', '4', '(', 'P', '^', ')', '7', 'C', 'C', ')', '7',
+        '}', '$', 'E', 'I', 'C', 'A', 'R', '-', 'S', 'T', 'A', 'N', 'D',
+        'A', 'R', 'D', '-', 'A', 'N', 'T', 'I', 'V', 'I', 'R', 'U', 'S',
+        '-', 'T', 'E', 'S', 'T', '-', 'F', 'I', 'L', 'E', '!', '$', 'H',
+        '+', 'H', '*' ]
+    end
+
+    def configure_caching(params)
+      options = []
+
+      if params.key? 'expires'
+        options << :must_revalidate
+        options << :no_cache
+        options << { max_age: params[:expires] }
+      else
+        options << :must_revalidate              if params.key? 'must_revalidate'
+        options << :no_cache                     if params.key? 'no_cache'
+        options << { max_age: params[:max_age] } if params.key? 'max_age'
+      end
+
+      cache_control(*options)
+    end
+
+    def encode(&block)
+      encoders = []
+      encoders << Encoders::Base64.new
+      encoders << Encoders::Base64Strict.new
+      encoders << Encoders::Gzip.new
+
+      encoders_to_run = params.keys.map(&:to_sym) & encoders.collect { |e| e.name }
+
+      if encoders_to_run.blank?
+        real_encoders = [Encoders::Null.new]
+      else
+        real_encoders = encoders_to_run.collect { |er| encoders.find { |e| e.name? er } }.compact
+      end
+
+      real_encoders.reduce(block.call) do |memo, e| 
+        e.encode(memo)
+      end
+    end
+  end
+end

data/lib/test_server.rb

@@ -0,0 +1,78 @@
+require 'psych'
+require 'sass'
+require 'haml'
+require 'i18n'
+require 'i18n/backend/fallbacks'
+require 'rack/contrib/locale'
+require 'rack/contrib/nested_params'
+require 'rack/contrib/post_body_content_type_parser'
+require 'sprockets-helpers'
+require 'sinatra'
+require 'sinatra/param'
+require 'sinatra/json'
+require 'sinatra/streaming'
+require 'json'
+require 'uglifier'
+require 'rack/protection'
+require 'thor'
+require 'base64'
+require 'zlib'
+require 'digest/sha1'
+
+require 'active_support/core_ext/kernel/reporting'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/array/access'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/string/inflections'
+
+require 'timeout'
+require 'logger'
+require 'pager'
+require 'psych'
+require 'addressable/uri'
+require 'securerandom'
+require 'erb'
+
+
+require 'test_server/access_logger'
+require 'test_server/null_access_logger'
+require 'test_server/ui_logger'
+
+require 'test_server/exceptions'
+require 'test_server/error_handler'
+require 'test_server/error_messages'
+
+require 'test_server/encoder'
+require 'test_server/encoders/base64_strict'
+require 'test_server/encoders/base64'
+require 'test_server/encoders/null'
+require 'test_server/encoders/gzip'
+
+require 'test_server/web_helper'
+require 'test_server/process_environment'
+require 'test_server/config'
+require 'test_server/version'
+require 'test_server/main'
+require 'test_server/data'
+require 'test_server/erb_generator'
+
+require 'test_server/actions/create_directory'
+require 'test_server/actions/create_file'
+require 'test_server/actions/create_output'
+require 'test_server/actions/handle_error'
+require 'test_server/actions/initialize_application'
+require 'test_server/actions/reload_configuration'
+require 'test_server/actions/send_signal'
+
+require 'test_server/server_commands/puma'
+require 'test_server/server_commands/rackup'
+require 'test_server/server'
+
+require 'test_server/cli/helper'
+require 'test_server/cli/reload'
+require 'test_server/cli/main'
+
+require 'test_server/template_file'
+require 'test_server/template_repository'
+
+module TestServer; end

data/share/archlinux/Makefile

@@ -0,0 +1,7 @@
+.PHONY: clean
+clean:
+	rm -f *.src.tar.gz
+	rm -f *.pkg.tar.xz
+	rm -f *.gem
+	rm -rf src
+	rm -rf pkg

data/share/archlinux/PKGBUILD.sh.erb

@@ -0,0 +1,110 @@
+# Maintainer: Dennis Guennewig dg1|vrnetze.de
+pkgname=test_server
+pkgver=<%= lookup('version') %>
+pkgrel=1
+pkgdesc="test server for proxy testing"
+arch=(i686 x86_64)
+url="https://github.com/dg-vrnetze/${pkgname}"
+license=('MIT')
+depends=('ruby' 'libatomic_ops')
+install=${pkgname}.install
+makedepends=(rubygems filegen phantomjs)
+#source=(http://gems.rubyforge.org/gems/$pkgname-$pkgver.gem)
+backup=etc/${pkgname}/config.yaml
+source=($pkgname-$pkgver.gem)
+noextract=($pkgname-$pkgver.gem)
+<%= lookup('sha') %>
+
+package() {
+  cd "$srcdir"
+
+  _library_dir=/usr/lib/${pkgname}
+  _share_dir="${_library_dir}/gems/${pkgname}-${pkgver}/share"
+  _systemd_dir=/usr/lib/systemd/system
+  _bin_dir=/usr/bin
+  _data_dir=/var/${pkgname}/data
+  _log_dir=/var/log/${pkgname}
+  _config_dir=/etc/${pkgname}
+  _examples_dir=/usr/share/${pkgname}/examples
+  _cache_dir=/var/cache/${pkgname}
+  _run_dir=/run/${pkgname}
+  _tmp_files_dir=/usr/lib/tmpfiles.d
+  _defaults_dir=/etc/default
+  _tmp_files_file=${_tmp_files_dir}/${pkgname}.conf
+  _config_file=${_config_dir}/config.yaml
+  _service_user=$pkgname
+  _service_group=$pkgname
+  _service_environment_file=${_defaults_dir}/${pkgname}
+  _access_log_file=${_log_dir}/access.log
+  _debug_mode=false
+  _log_level=warn
+  _environment=production
+  _listen_statement=tcp://127.0.0.1:8000
+  _reload_config_signal=USR1
+  _sass_cache_dir=$_cache_dir
+  _pid_file=${_run_dir}/pid
+  _executable_file=${pkgdir}${_bin_dir}/${pkgname}
+
+  install -d ${pkgdir}$_library_dir 
+  install -d ${pkgdir}$_bin_dir 
+  install -d ${pkgdir}$_systemd_dir 
+  install -d -m 770 ${pkgdir}$_data_dir
+  install -d ${pkgdir}$_log_dir
+  install -d ${pkgdir}$_config_dir
+  #install -d ${pkgdir}$_run_dir
+  install -d ${pkgdir}$_tmp_files_dir
+  install -d ${pkgdir}$_sass_cache_dir
+  install -d ${pkgdir}$_defaults_dir
+
+
+  msg "Starting download of gems. Don't get alert if the download takes a lot of time. Since rubygems 2.2.0 a new algorithm to resolve dependencies is used. Upgrade to > 2.2.0 via sudo /usr/bin/gem update --system to improve performance."
+
+  GEM_HOME="${pkgdir}${_library_dir}" GEM_ROOT="${pkgdir}${_library_dir}" GEM_PATH="${pkgdir}${_library_dir}" /usr/bin/gem install --env-shebang --wrappers --no-ri --no-rdoc --no-prerelease --install-dir ${pkgdir}${_library_dir} $pkgname-$pkgver.gem
+  GEM_HOME="${pkgdir}${_library_dir}" GEM_ROOT="${pkgdir}${_library_dir}" GEM_PATH="${pkgdir}${_library_dir}" /usr/bin/gem install --env-shebang --wrappers --no-ri --no-rdoc --no-prerelease --install-dir ${pkgdir}${_library_dir} puma
+
+  RUN_DIR=$_run_dir \
+    SERVICE_USER=$_service_user \
+    SERVICE_GROUP=$_service_group \
+    filegen  ${pkgdir}${_share_dir}/archlinux/tmpfiles.conf.erb > ${pkgdir}${_tmp_files_file}
+
+  COMMAND="${_executable_file} serve" \
+    DESCRIPTION='Server to proxy tests'
+    SERVICE_USER=$_service_user \
+    SERVICE_GROUP=$_service_group \
+    DEFAULTS_FILE=$_service_environment_file \
+    filegen  ${pkgdir}${_share_dir}/systemd/${pkgname}.service.erb > ${pkgdir}$_systemd_dir/${pkgname}.service
+
+  VARIABLES="HOME=/home/$_service_user" \
+    filegen  ${pkgdir}${_share_dir}/archlinux/defaults.sh.erb > ${pkgdir}${_service_environment_file}
+
+  chmod 644 ${pkgdir}${_tmp_files_file}
+
+  ACCESS_LOG=$_access_log_file \
+    CONFIG_FILE=$_config_file \
+    DEBUG_MODE=$_debug_mode \
+    ENVIRONMENT=$_environment \
+    LISTEN=$_listen_statement \
+    LOG_LEVEL=$_log_level \
+    PID_FILE=$_pid_file \
+    RELOAD_CONFIG_SIGNAL=$_reload_config_signal \
+    SASS_CACHE=$_sass_cache_dir \
+    filegen  ${pkgdir}${_share_dir}/archlinux/config.yaml.erb > ${pkgdir}${_config_file}
+
+  chmod 644 ${pkgdir}${_config_file}
+
+  SOFTWARE_BINARY=$_library_dir/gems/${pkgname}-${pkgver}/bin/${pkgname} \
+    SOFTWARE_LIB=/usr/lib/${pkgname} \
+    filegen  ${pkgdir}${_share_dir}/archlinux/startup.sh.erb > $_executable_file
+
+  chmod a+x ${pkgdir}/${_bin_dir}/${pkgname}
+
+  rm -rf ${pkgdir}/${_library_dir}/cache
+  rm -rf ${pkgdir}/${_library_dir}/{build_info,doc}
+
+  install -D -m644 ${pkgdir}/$_share_dir/systemd/${pkgname}.service ${pkgdir}/$_systemd_dir/${pkgname}.service
+  #install -D -m644 ${pkgdir}/$_share_dir/systemd/${pkgname}.socket ${pkgdir}/$_systemd_dir
+
+  install -D -m644 ${pkgdir}${_share_dir}/../LICENSE.md "${pkgdir}/usr/share/licenses/${pkgname}/LICENSE"
+}
+
+# vim:set ts=2 sw=2 et:

data/share/archlinux/config.yaml.erb

@@ -0,0 +1,10 @@
+---
+:access_log: <%= lookup('ACCESS_LOG') %>
+:config_file: <%= lookup('CONFIG_FILE') %>
+:debug_mode: <%= lookup('DEBUG_MODE') %>
+:environment: <%= lookup('ENVIRONMENT') %>
+:listen: <%= lookup('LISTEN') %>
+:log_level: <%= lookup('LOG_LEVEL') %>
+:pid_file: <%= lookup('PID_FILE') %>
+:reload_config_signal: <%= lookup('RELOAD_CONFIG_SIGNAL') %>
+:sass_cache: <%= lookup('SASS_CACHE') %>

data/share/archlinux/defaults.sh.erb

@@ -0,0 +1,3 @@
+<% lookup('VARIABLES').split(/ /).each do |v| -%>
+<%= v %>
+<% end -%>

data/share/archlinux/startup.sh.erb

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+export GEM_ROOT='<%= lookup('SOFTWARE_LIB') %>'
+export GEM_PATH='<%= lookup('SOFTWARE_LIB') %>'
+export GEM_HOME='<%= lookup('SOFTWARE_LIB') %>'
+
+export PATH="<%= lookup('SOFTWARE_LIB') %>/bin:$PATH"
+
+exec <%= lookup('SOFTWARE_BINARY') %> $*

data/share/archlinux/test_server.install

@@ -0,0 +1,65 @@
+pkgname=test_server
+
+_service_user=$pkgname
+_service_group=$pkgname
+_admin_group="${pkgname}_admin"
+
+_data_dir=/var/${pkgname}/data
+_log_dir=/var/log/${pkgname}
+_cache_dir=/var/cache/${pkgname}
+_sass_cache_directory=$_cache_dir
+
+post_install() {
+  if !getent group $_admin_group >/dev/null; then
+    groupadd $_admin_group
+  fi
+
+  if !getent passwd $_service_user >/dev/null; then
+    useradd -m $_service_user
+  fi
+
+  for path in $_log_dir $_sass_cache_directory; do
+    chown -R $_service_user:$_service_group $path
+  done
+
+  # Admins are allowed to write, service is allowd to read, others can do nothing
+  chown :$_admin_group $_data_dir 
+  setfacl -m g:$_service_group:rx $_data_dir
+
+  echo ""
+  echo "Please place a config file at one of the following places:"
+  echo ""
+  echo " * $HOME/.config/test_server/config.yaml"
+  echo " * $HOME/.test_server/config.yaml"
+  echo " * /etc/test_server/config.yaml"
+  echo ""
+  echo "The package contains a \"config.yaml\" which has been placed at /etc/test_server/config.yaml during package install. Feel free to modify it."
+  echo ""
+}
+
+post_upgrade() {
+  post_install
+}
+
+pre_remove() {
+  systemctl stop $pkgname
+  systemctl disable $pkgname
+}
+
+post_remove() {
+  echo ""
+  echo "Please remove the home directory of the service user ${_service_user} yourself."
+  echo ""
+
+  if !getent group $_admin_group >dev/null; then
+    groupdel $_admin_group
+  fi
+
+  if !getent group $_service_group >/dev/null; then
+    groupdel $_service_group
+  fi
+
+  if !getent passwd $_service_user >/dev/null; then
+    userdel $_service_user
+  fi
+}

data/share/archlinux/tmpfiles.conf.erb

@@ -0,0 +1,2 @@
+#Type Path        Mode UID  GID  Age Argument
+d    <%= lookup('RUN_DIR') %>   0755 <%= lookup('SERVICE_USER') %> <%= lookup('SERVICE_GROUP') %> - -

data/share/systemd/test_server.service

@@ -0,0 +1,9 @@
+[Unit]
+Description=Test server
+#Requires=test_server.socket
+
+[Service]
+ExecStart=/usr/bin/test_server serve
+
+[Install]
+WantedBy=multi-user.target

data/share/systemd/test_server.service.erb

@@ -0,0 +1,11 @@
+[Unit]
+Description=<%= lookup('DESCRIPTION') %>
+
+[Service]
+User=<%= lookup('SERVICE_USER') %>
+Group=<%= lookup('SERVICE_USER') %>
+ExecStart=<%= lookup('COMMAND') %>
+EnvironmentFile=<%= lookup('DEFAULTS_FILE') %>
+
+[Install]
+WantedBy=multi-user.target

data/share/systemd/test_server.socket

@@ -0,0 +1,10 @@
+[Unit]
+Description=Socket for test server
+
+[Socket]
+ListenStream=127.0.0.1:8000
+After=network.target
+Requires=network.target
+
+[Install]
+WantedBy=sockets.target

data/spec/encoder_spec.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Encoder do
+  class MyEncoder < Encoder; end
+
+  module MyModule
+    class MyEncoder < Encoder; end
+  end
+
+  context '#name' do
+    it 'returns name' do
+      expect(MyEncoder.new.name).to eq(:my_encoder)
+    end
+    
+    it 'returns demodularized name' do
+      expect(MyModule::MyEncoder.new.name).to eq(:my_encoder)
+    end
+  end
+
+  context '#name?' do
+    it 'checks name' do
+      expect(MyEncoder.new.name?(MyEncoder.new.name)).to be_true
+    end
+  end
+
+  context '#hash' do
+    it 'generates a hash for name' do
+      expect(MyEncoder.new.hash.to_s.size).to eq(40)
+    end
+  end
+
+  context '#eql?' do
+    it 'compares instances for hash' do
+      e1 = MyEncoder.new
+      e2 = MyEncoder.new
+      expect(e1.eql? e2).to be_true
+    end
+  end
+
+  context '#==' do
+    it 'understands equality' do
+      e1 = MyEncoder.new
+      e2 = MyEncoder.new
+      expect(e1 == e2).to be_true
+    end
+  end
+
+
+end

data/spec/encoders/base64_spec.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Encoders::Base64 do
+  context '#encode' do
+    it 'encodes string' do
+      encoder = Encoders::Base64.new
+      expect(encoder.encode('string')).to eq "c3RyaW5n\n"
+    end
+  end
+
+  context '#decode' do
+    it 'decodes string' do
+      encoder = Encoders::Base64.new
+      expect(encoder.decode( "c3RyaW5n\n")).to eq 'string'
+    end
+  end
+end

data/spec/encoders/base64_strict_spec.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Encoders::Base64Strict do
+  context '#encode' do
+    it 'encodes string' do
+      encoder = Encoders::Base64Strict.new
+      expect(encoder.encode('string')).to eq 'c3RyaW5n'
+    end
+  end
+
+  context '#decode' do
+    it 'decodes string' do
+      encoder = Encoders::Base64Strict.new
+      expect(encoder.decode( 'c3RyaW5n')).to eq 'string'
+    end
+  end
+end

data/spec/encoders/gzip_spec.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Encoders::Gzip do
+  context '#encode' do
+    it 'encodes string' do
+      encoder = Encoders::Gzip.new
+      expect(encoder.encode('string')).to eq "x\x9C+.)\xCA\xCCK\a\x00\tB\x02\x98".force_encoding('ASCII-8Bit')
+    end
+  end
+
+  context '#decode' do
+    it 'decodes string' do
+      encoder = Encoders::Gzip.new
+      expect(encoder.decode("x\x9C+.)\xCA\xCCK\a\x00\tB\x02\x98")).to eq 'string'
+    end
+  end
+end