test_server 0.0.11 → 0.1.0

data/README.md

@@ -1,9 +1,31 @@
-# TestServer
+# TestServer - the endpoint for your proxy server tests
 
-TODO: Write a gem description
+[![Build Status](https://travis-ci.org/dg-vrnetze/test_server.png?branch=master)](https://travis-ci.org/dg-vrnetze/test_server)
+[![Code Climate](https://codeclimate.com/github/dg-vrnetze/test_server.png)](https://codeclimate.com/github/dg-vrnetze/test_server)
+[![Coverage Status](https://coveralls.io/repos/dg-vrnetze/test_server/badge.png?branch=master)](https://coveralls.io/r/dg-vrnetze/test_server?branch=master)
+[![Gem Version](https://badge.fury.io/rb/test_server.png)](http://badge.fury.io/rb/test_server)
+
+
+`test_server` *serves two main purposes:*
+
+* end point for your proxy tests.
+* load generator via simple website driven by javascript
+
+*Behind the scenes it mainly uses ...*
+
+* [jquery](http://jquery.com/)
+* [sinatra](http://www.sinatrarb.com)
+* and other wonderfull gems 
+
+*Possible use cases:*
+
+* Provide static data via web application to make your tests reliable 
+* Generate load via browsers typically used by your users
 
 ## Installation
 
+### Rubygems
+
 Add this line to your application's Gemfile:
 
     gem 'test_server'
@@ -16,9 +38,81 @@ Or install it yourself as:
 
     $ gem install test_server
 
+### Archlinux
+
+```bash
+# Install via yaourt
+yaourt -S test_server
+
+# Install via cower + makepkg
+cower -d test_server
+cd <dir>
+makepkg -is
+```
+
+### Firewall rules
+
+Following you can find an example configuration for iptables to secure your server. It
+opens ports only for your proxy servers to access `test_server`.
+
+```bash
+# default policies
+iptables -P INPUT -j DROP
+iptables -P FORWARD -j DROP
+iptables -P OUTPUT -j ACCEPT
+
+# user defined chains
+iptables -N TCP
+iptables -N UDP
+
+# rules
+iptables -A INPUT -m conntrack --ctstate RELATED,ESTABLISHED -j ACCEPT
+iptables -A INPUT -i lo -j ACCEPT
+iptables -A INPUT -m conntrack --ctstate INVALID -j DROP
+iptables -A INPUT -p icmp -m icmp --icmp-type 8 -m conntrack --ctstate NEW -j ACCEPT
+iptables -A INPUT -p udp -m conntrack --ctstate NEW -j UDP
+iptables -A INPUT -p tcp -m conntrack --ctstate NEW -j TCP
+iptables -A INPUT -p tcp -m recent --set --name TCP-PORTSCAN --mask 255.255.255.255 --rsource -j REJECT --reject-with tcp-reset
+iptables -A INPUT -p udp -m recent --set --name UDP-PORTSCAN --mask 255.255.255.255 --rsource -j REJECT --reject-with icmp-port-unreachable
+iptables -A INPUT -j REJECT --reject-with icmp-proto-unreachable
+iptables -A TCP -p tcp -m recent --update --seconds 60 --name TCP-PORTSCAN --mask 255.255.255.255 --rsource -j REJECT --reject-with tcp-reset
+iptables -A TCP -s <public ips proxies> -p tcp -m tcp --dport 8000 -j ACCEPT
+iptables -A UDP -p udp -m recent --update --seconds 60 --name UDP-PORTSCAN --mask 255.255.255.255 --rsource -j REJECT --reject-with icmp-port-unreachable
+COMMIT
+```
+
+## Screenshots
+
+To be defined...
+
 ## Usage
 
-TODO: Write usage instructions here
+*Starting Web Application*
+
+```
+% test_server serve
+```
+
+*Load testing*
+
+Point your browser to `http://<your-domain.org>/v1/test/javascript/xhr/string`.
+Fill out the form and run test.
+
+*Testing your proxies*
+
+* Write tests using `capybara` + `rspec`.
+
+or
+
+* Use [`proxy_tester`](https://github.com/dg-vrnetze/proxy_tester) for a fully
+  featured solution for writing proxy tests (**RECOMMENDED**). `proxy_tester` uses
+  `capybara` and `rspec`, but provides lots of helpers for writing proxy tests
+  to reduce the work on your site.
+
+## List of test end points
+
+To be defined. Hopefully I can provide a `controller` which handles this within
+the application.
 
 ## Contributing
 

data/Rakefile

@@ -68,7 +68,7 @@ end
 namespace :package do
   desc 'build arch linux package'
   task :archlinux => [gem_file, archlinux_build_directory] do
-    FileUtils.mv ::File.join(pkg_directory, "#{software}-#{version}.gem"), archlinux_build_directory
+    #FileUtils.mv ::File.join(pkg_directory, "#{software}-#{version}.gem"), archlinux_build_directory
 
     generator = Filegen::Rubygen.new
     template = File.read(File.expand_path('../share/archlinux/PKGBUILD.sh.erb', __FILE__))

data/app/assets/javascripts/application.js

@@ -1,14 +1,6 @@
 //= require jquery
 //= require bootstrap-sass/dist/js/bootstrap
 
-//$(document).ready(function(){
-//  $(".lp_show_fields").click(function(e){
-//    e.preventDefault()
-//    $(".lp_fields_close, .lp_fields_open").toggle();
-//    $(".lp_button_show_fields_close, .lp_button_show_fields_open").toggle();
-//  });
-//});
-
 function escapeHTML(s) {
   return String(s).replace(/&(?!\w+;)/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;');
 }
@@ -24,13 +16,15 @@ function result(url, timeout, start_time, result) {
   }
 
   $('#result').toggle(true);
-  $('#result tr:last').after('<tr class="ts-result-row ' + result_klass + '"><td>' + url + '</td><td>' + timeout + '</td><td>' + run_time + '</td><td>' + result + '</td></tr>');
+  $('#result_table_header').after('<tr class="ts-result-row ' + result_klass + '"><td>' + url + '</td><td>' + timeout + '</td><td>' + run_time + '</td><td>' + result + '</td></tr>');
+  
 }
 
 $(document).ready(function(){
   $("#reset").click(function () {
     $('#form')[0].reset();
     $('.ts-result-row').remove();
+    $('#result').toggle(false);
   });
 });
 
@@ -38,28 +32,53 @@ $(document).ready(function(){
   $("#submit").click(function (e) {
     e.preventDefault();
 
-    var url     = escapeHTML($('#url').val())
-    var timeout = escapeHTML($('#timeout').val() * 1000)
-    var count   = escapeHTML($('#count').val())
+    var url     = escapeHTML($('#url').val());
+    var timeout = escapeHTML($('#timeout').val() * 1000);
+    var count   = escapeHTML($('#count').val());
 
-    for (var i = 0, limit = count ; i < limit; i++) {
+    repeat_requests(url, count, timeout);
+  });
+});
 
-      var start_time = new Date().getTime();
+function repeat_requests(url, count, timeout) {
+  var repeat  = $('#repeat').is(":checked");
+  var requests = [];
 
-      $.ajax({
-        url: url,
-        timeout: timeout,
-        cache: false, 
-        success: function() {
-          result(url, timeout, start_time, 'ok');
-        },
-        error: function(){
-          result(url, timeout, start_time, 'fail');
-        }
-      });
+  var success_callback = function() {
+    $('#request-spinner').toggle(false);
+
+    if (repeat == true) {
+      setTimeout(repeat_requests(url, count, timeout), 1000);
     }
+  };
 
-  });
-});
+  var failure_callback = function() {
+    $('#request-spinner').toggle(false);
+  };
+
+  $('#request-spinner').toggle(true);
 
-$('#notification').modal('hide');
+  for(i = 0; i < count; i++) {
+    requests.push(sendAjax(url, timeout));
+  }
+
+  $.when.apply(undefined, requests).then(function(results){success_callback()}, function(results){failure_callback()});
+}
+
+function sendAjax(url, timeout)  {
+  var start_time = new Date().getTime();
+
+  return $.ajax(
+      {
+        url: url,
+         timeout: timeout,
+         cache: false, 
+         success: function() {
+           result(url, timeout, start_time, 'ok');
+         },
+         error: function(){
+           result(url, timeout, start_time, 'fail');
+         }
+      }
+  );
+}

data/app/assets/stylesheets/application.scss

@@ -110,6 +110,10 @@ a:focus {
   display: inline-block;
 }
 
+.ts-field-repeat {
+  @extend .checkbox;
+}
+
 .ts-field-count {
   @extend .form-control;
   display: inline-block;
@@ -148,3 +152,12 @@ a:focus {
 .ts-result-failed-request {
   color: red;
 }
+
+#request-spinner {
+  margin: 20px;
+  display: none;
+}
+
+.ts-inline {
+  display: inline;
+}

data/app/controllers/javascript_controller.rb

@@ -2,6 +2,12 @@
 module TestServer
   module App
     class JavascriptController < ApplicationController
+      use Rack::Cors do 
+        allow do
+          origins '*'
+          resource '*', :headers => :any, :methods => [:get, :post]
+        end
+      end
 
       before do
         param :no_cache, Boolean, default: false
@@ -11,18 +17,17 @@ module TestServer
 
         configure_caching(params)
       end
-      get '/xhr/string' do
+
+      get '/xhr/url/?' do
         param :count, Integer, default: 10
         param :timeout, Integer, default: 10
         param :url, String
+        param :repeat, Boolean, default: false
 
         @count   = params[:count]
         @url     = params[:url]
         @timeout = params[:timeout]
-
-        #@data = encode do
-        #  generate_string(params[:count])
-        #end
+        @repeat  = params[:repeat]
 
         haml :'xhr/show', layout: :application
       end

data/app/views/xhr/show.haml

@@ -10,29 +10,22 @@
   .ts-form-group
     %label{ for: :url}
       = t('views.javascript.xhr.fields.url')
-    %input#url.ts-field-url{ type: :url, name: :url, value: @url }
-  %button#submit.ts-button-submit{type: 'submit', value: t('views.application.buttons.submit'), 'data-toggle' => 'modal', 'data-target' => '#notification'}
+    %input#url.ts-field-url{ type: :url, name: :url, value: @url, placeholder: 'http://www.example.org' }
+    .ts-field-repeat
+      %label
+        %input#repeat{ type: :checkbox, value: @repeat }
+          = t('views.javascript.xhr.fields.repeat')
+  %button#submit.ts-button-submit{type: 'submit', name: 'submit', value: t('views.application.buttons.submit'), 'data-toggle' => 'modal', 'data-target' => '#notification'}
     = t('views.application.buttons.submit')
-  %a#reset.ts-button-reset{href: '#'}
+  %a#reset.ts-button-reset{href: '#', name: 'reset'}
     = t('views.application.buttons.reset')
+  %span.ts-inline#request-spinner
+    %img{ src: '/assets/ajax-loader.gif', alt: t('views.javascript.xhr.spinner.text') }
+    = t('views.javascript.xhr.spinner.text')
 
 %table#result.ts-result-table
-  %th= t('views.javascript.xhr.result_table.url') 
-  %th= t('views.javascript.xhr.result_table.timeout') 
-  %th= t('views.javascript.xhr.result_table.runtime') 
-  %th= t('views.javascript.xhr.result_table.status') 
-
-.modal#notification{ role: 'dialog' , tabindex: '-1'}
-  .modal-dialog
-    .modal-content
-      .modal-header
-        %button.ts-button-close-headline{ type: 'button', 'data-dismiss' => 'modal', 'aria-hidden' => 'true'} 
-          ×
-        %h4 
-          = t('views.dialogs.notification.title')
-      .modal-body
-        %p.ts-text-centered 
-          = t('views.javascript.xhr.notification.text')
-      .modal-footer
-        %button.ts-button-close{ type: 'button', 'data-dismiss' => 'modal' }
-          = t('views.application.buttons.close')
+  %tr#result_table_header
+    %th= t('views.javascript.xhr.result_table.url') 
+    %th= t('views.javascript.xhr.result_table.timeout') 
+    %th= t('views.javascript.xhr.result_table.runtime') 
+    %th= t('views.javascript.xhr.result_table.status') 

data/lib/test_server/locales/en.yml

@@ -62,11 +62,12 @@ en:
           url: URL
           count: Count
           timeout: Timeout (s)
+          repeat: Repeat Requests
         result_table:
           url: URL
           runtime: Runtime (ms)
           timeout: Timeout (ms)
           status: Status
-        notification: 
-          text: You asked me to send out requests.
+        spinner: 
+          text: Requests were sent. Waiting for results.
 

data/lib/test_server/version.rb

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

data/lib/test_server/web_helper.rb

@@ -1,6 +1,14 @@
 # encoding: utf-8
 module TestServer
   module WebHelper
+    def base_url
+      mutex = Mutex.new
+
+      mutex.synchronize do
+        @base_url ||= "#{request.env['rack.url_scheme']}://#{request.env['HTTP_HOST']}"
+      end
+    end
+
     def h(text)
       Rack::Utils.escape_html(text)
     end

data/lib/test_server.rb

@@ -14,6 +14,7 @@ require 'sinatra/streaming'
 require 'json'
 require 'uglifier'
 require 'rack/protection'
+require 'rack/cors'
 require 'thor'
 require 'base64'
 require 'zlib'

data/script/acceptance_test

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+bundle exec cucumber
+bundle exec rspec spec/features

data/script/bootstrap

@@ -0,0 +1,63 @@
+#!/bin/sh
+
+function puts() {
+  echo -e $1 >&2
+}
+
+function install_package() {
+if which pacman > /dev/null; then
+  if [ -z "$(pacman -Ss "^$1\$" | grep installed)" ]; then
+    puts "Installing $1"
+    sudo pacman -S --noconfirm $1
+  fi
+else
+  puts "Please install $1 from your operating system repository."
+fi
+}
+
+function install_gem() {
+if which gem > /dev/null; then
+  if [ -z "$(gem list -l "^$1\$")" ]; then
+    puts "Installing $1"
+    gem install --no-ri --no-rdoc $1
+  fi
+else
+  puts "Please install $1 via rubygems."
+fi
+}
+
+function install_node() {
+if which npm > /dev/null; then
+  if [ -z "$(npm list -g $1 | grep bower)" ]; then
+    puts "Installing $1"
+    npm install -g $1 
+  fi
+else
+  puts "Please install $1 via npm"
+fi
+}
+
+function file_exist() {
+if [ -f $1 ]; then
+  puts "$2"
+  return 0
+else
+  puts "Warning file \"$1\" does not exist. Maybe this can cause problems during bootstrapping"
+  return 1
+fi
+}
+
+echo "Bootstrapping development environment for application.." >&2
+
+install_package ruby
+install_package nodejs
+install_package phantomjs
+
+install_gem bundler
+bundle install
+
+file_exist "$HOME/.npmrc" "I found a .npmrc. Please make sure your npm configuration works with global install for users. If not please add something like \"prefix = /home/user/.local/share/npm\" to your .bashrc/.zshrc + export PATH=/home/user/.local/share/npm/bin:\$PATH"
+
+install_node bower
+
+bower install

data/script/ci

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+bundle exec script/test_web &
+
+bundle exec rake test:coveralls
+
+pkill -P $$   

data/script/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << ::File.expand_path('../../lib', __FILE__)
+
+# Pull in all of the gems including those in the `test` group
+require 'bundler'
+Bundler.require :default, :test, :development
+
+require 'irb'
+require 'irb/completion'
+require 'test_server'
+
+ARGV.clear
+IRB.start

data/script/release

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+bundle exec rake gem:release

data/script/test_web

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require 'sinatra/base'
+
+class Webserver < Sinatra::Base
+  set :logging, :true
+
+  post '/rspec/:test' do
+    case params[:test]
+    when 'send'
+      return params[:data]
+    else
+      not_found
+    end
+  end
+
+  get '/rspec/:test' do
+    params[:test]
+  end
+end
+
+Webserver.set :bind,'127.0.0.1'
+Webserver.run!

data/script/unit_test

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+bundle exec script/test_web &
+
+bundle exec rspec
+
+pkill -P $$   

data/share/archlinux/PKGBUILD.sh.erb

@@ -9,9 +9,9 @@ license=('MIT')
 depends=('ruby' 'libatomic_ops')
 install=${pkgname}.install
 makedepends=(rubygems filegen phantomjs)
-#source=(http://gems.rubyforge.org/gems/$pkgname-$pkgver.gem)
+source=(http://gems.rubyforge.org/gems/$pkgname-$pkgver.gem)
 backup=etc/${pkgname}/config.yaml
-source=($pkgname-$pkgver.gem)
+#source=($pkgname-$pkgver.gem)
 noextract=($pkgname-$pkgver.gem)
 <%= lookup('sha') %>
 

data/spec/features/fetch_data_via_javascript_spec.rb

@@ -2,17 +2,56 @@
 require 'spec_helper'
 
 describe 'Fetch data via javascript', :js do
-  context '/xhr/string/' do
-    it 'submits requests to url' do
+  before :each do
+    config = Class.new do
+      include FeduxOrg::Stdlib::Filesystem
+
+      def root_directory
+        ::File.expand_path('../../../', __FILE__)
+      end
+
+      def log_level
+       :unknown
+      end
+
+      def access_log 
+        File.join(working_directory, 'access.log')
+      end
+
+      def reload_config_signal
+        'USR1'
+      end
+    end.new
+
+    TestServer.config = config
 
-      visit '/xhr/string/'
+    Capybara.app = Rack::Builder.new do
+      map '/' do
+        run TestServer::App::JavascriptController
+      end
+
+      map '/assets' do
+        run TestServer::App::AssetsController.assets
+      end
+    end
+  end
+
+  context '/xhr/url/' do
+    it 'submits requests to url' do
+      url = '/v1/test/javascript/xhr/url'
+      visit '/xhr/url/'
 
       within '#form' do
-        fill_in 'url', :with => '§ASDF$$'
+        fill_in 'url', :with => url
+        fill_in 'count', :with => 1
       end
 
-      click_button '#submit'
-      click_on('Search')
+
+      click_button('submit')
+
+      first '.ts-result-row'
+
+      expect(page).to have_content(url)
     end
 
   end

data/spec/support/capybara.rb

@@ -8,9 +8,9 @@ end
 
 RSpec.configure do |c|
   c.include TestServer::SpecHelper::Capybara
-  c.beforc(:all) do
-    Capybara.default_engine = :rack_test
-    Capybara.javascript_engine = :poltergeist
+  c.before(:all) do
+    Capybara.default_driver    = :rack_test
+    Capybara.javascript_driver = :poltergeist
   end
 end
 

data/test_server.gemspec

@@ -36,5 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'pager'
   spec.add_runtime_dependency 'sinatra-param'
   spec.add_runtime_dependency 'sinatra-contrib'
+  spec.add_runtime_dependency 'sinatra-advanced-routes'
+  spec.add_runtime_dependency 'rack-cors'
   spec.add_runtime_dependency 'thor'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: test_server
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-03 00:00:00.000000000 Z
+date: 2014-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -299,6 +299,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra-advanced-routes
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-cors
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -334,6 +366,7 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- app/assets/images/ajax-loader.gif
 - app/assets/javascripts/application.js
 - app/assets/stylesheets/application.scss
 - app/controllers/application_controller.rb
@@ -383,6 +416,13 @@ files:
 - lib/test_server/ui_logger.rb
 - lib/test_server/version.rb
 - lib/test_server/web_helper.rb
+- script/acceptance_test
+- script/bootstrap
+- script/ci
+- script/console
+- script/release
+- script/test_web
+- script/unit_test
 - share/archlinux/Makefile
 - share/archlinux/PKGBUILD.sh.erb
 - share/archlinux/config.yaml.erb